Coding standard fixes

assets/js/src/mp2migrator.js

@@ -1,17 +1,16 @@
-(function( $ ) {
+(function ($) {
   'use strict';
 
   var that;
 
   var mailpoet_import = {
-	    
     fatal_error: '',
     is_logging: false,
     
     /**
      * Start the logger
      */
-	    start_logger: function() {
+    start_logger: function () {
       that.is_logging = true;
       clearTimeout(that.display_logs_timeout);
       clearTimeout(that.update_progressbar_timeout);
@@ -22,15 +21,14 @@
     /**
      * Stop the logger
      */
-	    stop_logger: function() {
+    stop_logger: function () {
       that.is_logging = false;
     },
     
-	    
     /**
      * Update the display
      */
-	    update_display: function() {
+    update_display: function () {
       that.display_logs();
       that.update_progressbar();
     },
@@ -38,19 +36,19 @@
     /**
      * Display the logs
      */
-	    display_logs: function() {
+    display_logs: function () {
       $.ajax({
         url: objectPlugin.log_file_url,
         cache: false
-            }).done(function(result) {
+      }).done(function (result) {
         $('#action_message').html(''); // Clear the action message
         $("#logger").html('');
-          result.split("\n").forEach(function(row) {
+        result.split("\n").forEach(function (row) {
-              if ( row.substr(0, 7) === '[ERROR]' || row.substr(0, 9) === '[WARNING]' || row === 'IMPORT STOPPED BY USER') {
+          if(row.substr(0, 7) === '[ERROR]' || row.substr(0, 9) === '[WARNING]' || row === 'IMPORT STOPPED BY USER') {
             row = '<span class="error_msg">' + row + '</span>'; // Mark the errors in red
           }
           // Test if the import is complete
-              else if ( row === 'IMPORT COMPLETE' ) {
+          else if(row === 'IMPORT COMPLETE') {
             row = '<span class="complete_msg">' + row + '</span>'; // Mark the complete message in green
             $('#action_message').html(MailPoet.I18n.t('import_complete'))
                     .removeClass('failure').addClass('success');
@@ -59,8 +57,8 @@
 
         });
         $("#logger").append('<span class="error_msg">' + that.fatal_error + '</span>' + "<br />\n");
-            }).always(function() {
+      }).always(function () {
-              if ( that.is_logging ) {
+        if(that.is_logging) {
           that.display_logs_timeout = setTimeout(that.display_logs, 1000);
         }
       });
@@ -69,17 +67,17 @@
     /**
      * Update the progressbar
      */
-	    update_progressbar: function() {
+    update_progressbar: function () {
       $.ajax({
         url: objectPlugin.progress_url,
         cache: false,
         dataType: 'json'
-        }).always(function(result) {
+      }).always(function (result) {
         // Move the progress bar
         var progress = Number(result.current) / Number(result.total) * 100;
         $('#progressbar').progressbar('option', 'value', progress);
         $('#progresslabel').html(progress + '%');
-            if ( that.is_logging ) {
+        if(that.is_logging) {
           that.update_progressbar_timeout = setTimeout(that.update_progressbar, 1000);
         }
       });
@@ -90,7 +88,7 @@
      *
      * @returns {Boolean}
      */
-	    start_import: function() {
+    start_import: function () {
       that.fatal_error = '';
       // Start displaying the logs
       that.start_logger();
@@ -109,19 +107,21 @@
         action: 'import',
         data: {
         }
-        }).always(function() {
+      }).always(function () {
         that.stop_logger();
         that.update_display(); // Get the latest information after the import was stopped
         that.reactivate_import_button();
-        }).done(function(response) {
+      }).done(function (response) {
-          if (response) {
+        if(response) {
           that.fatal_error = response.data;
         }
-        }).fail(function(response) {
+      }).fail(function (response) {
-          if (response.errors.length > 0) {
+        if(response.errors.length > 0) {
           MailPoet.Notice.error(
-              response.errors.map(function(error) { return error.message; }),
+                  response.errors.map(function (error) {
-              { scroll: true }
+                    return error.message;
+                  }),
+                  {scroll: true}
           );
         }
       });
@@ -132,7 +132,7 @@
      * Reactivate the import button
      *
      */
-	    reactivate_import_button: function() {
+    reactivate_import_button: function () {
       $('#import').val(that.import_button_label).removeAttr('disabled');
       $('#stop-import').hide();
     },
@@ -142,7 +142,7 @@
      *
      * @returns {Boolean}
      */
-	    stop_import: function() {
+    stop_import: function () {
       $('#stop-import').attr('disabled', 'disabled');
       // Stop the import
       MailPoet.Ajax.post({
@@ -150,24 +150,24 @@
         action: 'stopImport',
         data: {
         }
-        }).always(function() {
+      }).always(function () {
         $('#stop-import').removeAttr('disabled'); // Enable the button
         that.reactivate_import_button();
         that.update_display(); // Get the latest information after the import was stopped
       });
       that.stop_logger();
       return false;
-	    },
+    }
 
   };
 
   /**
    * Actions to run when the DOM is ready
    */
-	$(function() {
+  $(function () {
     that = mailpoet_import;
 
-	    $('#progressbar').progressbar({value : 0});
+    $('#progressbar').progressbar({value: 0});
 
     // Import button
     $('#import').click(that.start_import);
@@ -176,12 +176,4 @@
     $('#stop-import').click(that.stop_import);
   });
 
-	/**
+})(jQuery);
-	 * Actions to run when the window is loaded
-	 */
-	$( window ).load(function() {
-	    
-	});
-
-})( jQuery );
-

lib/API/Endpoints/MP2MigratorAPI.php

@@ -35,7 +35,7 @@ class MP2MigratorAPI extends APIEndpoint {
    */
   public function stopImport($data) {
     try {
-      $process = $this->MP2Migrator->stop_import();
+      $process = $this->MP2Migrator->stopImport();
       return $this->successResponse($process);
     } catch(\Exception $e) {
       return $this->errorResponse(array(

lib/Config/MP2Migrator.php

@@ -1,4 +1,5 @@
 <?php
+
 namespace MailPoet\Config;
 
 use MailPoet\Util\ProgressBar;
@@ -25,14 +26,14 @@ class MP2Migrator {
    * @return boolean
    */
   public function proposeMigration() {
-    if ( isset($_REQUEST['nomigrate']) ) {
+    if(isset($_REQUEST['nomigrate'])) {
       // Store the user's choice if he doesn't want to migrate from MP2
       update_option('mailpoet_migration_complete', true);
     }
-    if ( get_option('mailpoet_migration_complete') ) {
+    if(get_option('mailpoet_migration_complete')) {
       return false;
     } else {
-      return $this->table_exists('wysija_campaign'); // Check if the MailPoet 2 tables exist
+      return $this->tableExists('wysija_campaign'); // Check if the MailPoet 2 tables exist
     }
   }
 
@@ -42,14 +43,16 @@ class MP2Migrator {
    * @param string $table Table name
    * @return boolean
    */
-  public function table_exists($table) {
+  private function tableExists($table) {
     global $wpdb;
 
     try {
       $sql = "SHOW TABLES LIKE '{$wpdb->prefix}{$table}'";
       $result = $wpdb->query($sql);
       return !empty($result);
-    } catch ( Exception $e ) {}
+    } catch (Exception $e) {
+      // Do nothing
+    }
 
     return false;
   }
@@ -59,7 +62,7 @@ class MP2Migrator {
    * 
    */
   public function init() {
-    $this->enqueue_scripts();
+    $this->enqueueScripts();
     $this->log('INIT');
   }
 
@@ -67,7 +70,7 @@ class MP2Migrator {
    * Register the JavaScript for the admin area.
    *
    */
-  private function enqueue_scripts() {
+  private function enqueueScripts() {
     wp_enqueue_script('jquery-ui-progressbar');
   }
 
@@ -76,7 +79,7 @@ class MP2Migrator {
    * 
    * @param string $message
    */
-  public function log($message) {
+  private function log($message) {
     file_put_contents($this->log_file, "$message\n", FILE_APPEND);
   }
 
@@ -87,15 +90,14 @@ class MP2Migrator {
    */
   public function import() {
     $this->log('START IMPORT');
-		update_option('mailpoet_stop_import', false, false); // Reset the stop import action
+    update_option('mailpoet_stopImport', false, false); // Reset the stop import action
-    
     // TODO to remove, for testing only
-    $this->progressbar->set_total_count(0);
+    $this->progressbar->setTotalCount(0);
-    $this->progressbar->set_total_count(10);
+    $this->progressbar->setTotalCount(10);
-    for ( $i = 0; $i < 10; $i++ ) {
+    for($i = 0; $i < 10; $i++) {
-      $this->progressbar->increment_current_count(1);
+      $this->progressbar->incrementCurrentCount(1);
       usleep(300000);
-      if ( $this->import_stopped() ) {
+      if($this->importStopped()) {
         return;
       }
     }
@@ -107,8 +109,8 @@ class MP2Migrator {
    * Stop the import
    * 
    */
-  public function stop_import() {
+  public function stopImport() {
-    update_option('mailpoet_stop_import', true);
+    update_option('mailpoet_stopImport', true);
     $this->log('IMPORT STOPPED BY USER');
   }
 
@@ -117,8 +119,8 @@ class MP2Migrator {
    * 
    * @return boolean Import must stop or not
    */
-  public function import_stopped() {
+  private function importStopped() {
-    return get_option('mailpoet_stop_import');
+    return get_option('mailpoet_stopImport');
   }
 
 }

lib/Config/Menu.php

@@ -272,7 +272,7 @@ class Menu {
     }
 
     $mp2Migrator = new MP2Migrator();
-    if ($mp2Migrator->proposeMigration()) {
+    if($mp2Migrator->proposeMigration()) {
       $mp2Migrator->init();
       $data = array(
         'log_file_url' => $mp2Migrator->log_file_url,

lib/Util/ProgressBar.php

@@ -1,11 +1,12 @@
 <?php
+
 namespace MailPoet\Util;
 
 use MailPoet\Config\Env;
 
 if(!defined('ABSPATH')) exit;
 
-if ( !class_exists('ProgressBar', false) ) {
+if(!class_exists('ProgressBar', false)) {
 
   /**
    * The Progress Bar class
@@ -27,11 +28,11 @@ if ( !class_exists('ProgressBar', false) ) {
       $filename = Env::$plugin_name . '-' . $progress_bar_id . '-progress.json';
       $this->filename = $upload_dir['basedir'] . '/' . $filename;
       $this->url = $upload_dir['baseurl'] . '/' . $filename;
-			$counters = $this->read_progress();
+      $counters = $this->readProgress();
-			if ( isset($counters->total) ) {
+      if(isset($counters->total)) {
         $this->total_count = $counters->total;
       }
-			if ( isset($counters->current) ) {
+      if(isset($counters->current)) {
         $this->current_count = $counters->current;
       }
     }
@@ -41,7 +42,7 @@ if ( !class_exists('ProgressBar', false) ) {
      * 
      * @return string Progress file URL
      */
-		public function get_url() {
+    public function getUrl() {
       return $this->url;
     }
 
@@ -50,8 +51,8 @@ if ( !class_exists('ProgressBar', false) ) {
      * 
      * @return array|false Array of counters
      */
-		private function read_progress() {
+    private function readProgress() {
-			if ( file_exists($this->filename) ) {
+      if(file_exists($this->filename)) {
         $json_content = file_get_contents($this->filename);
         return json_decode($json_content);
       } else {
@@ -64,11 +65,11 @@ if ( !class_exists('ProgressBar', false) ) {
      * 
      * @param int $count Count
      */
-		public function set_total_count($count) {
+    public function setTotalCount($count) {
-			if ( $count != $this->total_count ) {
+      if($count != $this->total_count) {
         $this->total_count = $count;
         $this->current_count = 0;
-				$this->save_progress();
+        $this->saveProgress();
       }
     }
 
@@ -77,21 +78,22 @@ if ( !class_exists('ProgressBar', false) ) {
      * 
      * @param int $count Count
      */
-		public function increment_current_count($count) {
+    public function incrementCurrentCount($count) {
       $this->current_count += $count;
-			$this->save_progress();
+      $this->saveProgress();
     }
 
     /**
      * Save the progress counters
      * 
      */
-		private function save_progress() {
+    private function saveProgress() {
       file_put_contents($this->filename, json_encode(array(
         'total' => $this->total_count,
         'current' => $this->current_count,
       )));
+    }
 
   }
-	}
+
 }