eventespresso / event-espresso-core

core/data_migration_scripts/4_1_0_stages/EE_DMS_4_1_0_venues.dmsstage.php

Doc Comments +1 added lines, -1 removed lines

@@ -205,7 +205,7 @@
 
     /**
      * Inserts into the venue_meta table
-     * @param type $cpt_id
+     * @param integer $cpt_id
      * @param type $old_venue
      * @return int
      */

Indentation +202 added lines, -202 removed lines

@@ -63,210 +63,210 @@
  */
 class EE_DMS_4_1_0_venues extends EE_Data_Migration_Script_Stage
 {
-    private $_old_table;
-    private $_new_table;
-    private $_new_meta_table;
-    public function _migration_step($num_items = 50)
-    {
-        global $wpdb;
-        $start_at_record = $this->count_records_migrated();
-        $rows = $wpdb->get_results($wpdb->prepare("SELECT * FROM ".$this->_old_table." LIMIT %d,%d", $start_at_record, $num_items), ARRAY_A);
-        $items_actually_migrated = 0;
-        foreach ($rows as $old_venue) {
-            if (! $new_id = $this->_insert_into_posts($old_venue)) {
-                $items_actually_migrated++;
-                continue;
-            }
-            $this->get_migration_script()->set_mapping($this->_old_table, $old_venue['id'], $this->_new_table, $new_id);
-            if (! $new_meta_id = $this->_insert_into_meta_table($new_id, $old_venue)) {
-                $items_actually_migrated++;
-                continue;
-            }
-            $this->get_migration_script()->set_mapping($this->_old_table, $old_venue['id'], $this->_new_meta_table, $new_meta_id);
-            // lastly, save the 'contact' as post meta, because it doesn't exist anywhere else but someone may still want it
-            $venue_meta = maybe_unserialize($old_venue['meta']);
-            if (isset($venue_meta['contact']) && $venue_meta['contact']) {
-                add_post_meta($new_id, 'contact', $venue_meta['contact']);
-            }
-            // is there an image on this venue?
-            $guid = isset($venue_meta['image']) && $venue_meta['image'] ? $venue_meta['image'] : null;
-            if ($guid) {
-                $this->get_migration_script()->convert_image_url_to_attachment_and_attach_to_post($guid, $new_id, $this);
-            }
-            $items_actually_migrated++;
-            if ($guid) {
-                // if there was an image, we may have had to download it etc and it may have taken
-                // longer, then let's not bother migrating anymore on this step
-                break;
-            }
-        }
-        if ($this->count_records_migrated() + $items_actually_migrated >= $this->count_records_to_migrate()) {
-            $this->set_completed();
-        }
-        return $items_actually_migrated;
-    }
-    public function _count_records_to_migrate()
-    {
-        global $wpdb;
-        $count = $wpdb->get_var("SELECT COUNT(id) FROM ".$this->_old_table);
-        return $count;
-    }
-    public function __construct()
-    {
-        $this->_pretty_name = __("Venues", "event_espresso");
-        global $wpdb;
-        $this->_old_table = $wpdb->prefix."events_venue";
-        $this->_new_table = $wpdb->posts;
-        $this->_new_meta_table = $wpdb->prefix."esp_venue_meta";
-        parent::__construct();
-    }
+	private $_old_table;
+	private $_new_table;
+	private $_new_meta_table;
+	public function _migration_step($num_items = 50)
+	{
+		global $wpdb;
+		$start_at_record = $this->count_records_migrated();
+		$rows = $wpdb->get_results($wpdb->prepare("SELECT * FROM ".$this->_old_table." LIMIT %d,%d", $start_at_record, $num_items), ARRAY_A);
+		$items_actually_migrated = 0;
+		foreach ($rows as $old_venue) {
+			if (! $new_id = $this->_insert_into_posts($old_venue)) {
+				$items_actually_migrated++;
+				continue;
+			}
+			$this->get_migration_script()->set_mapping($this->_old_table, $old_venue['id'], $this->_new_table, $new_id);
+			if (! $new_meta_id = $this->_insert_into_meta_table($new_id, $old_venue)) {
+				$items_actually_migrated++;
+				continue;
+			}
+			$this->get_migration_script()->set_mapping($this->_old_table, $old_venue['id'], $this->_new_meta_table, $new_meta_id);
+			// lastly, save the 'contact' as post meta, because it doesn't exist anywhere else but someone may still want it
+			$venue_meta = maybe_unserialize($old_venue['meta']);
+			if (isset($venue_meta['contact']) && $venue_meta['contact']) {
+				add_post_meta($new_id, 'contact', $venue_meta['contact']);
+			}
+			// is there an image on this venue?
+			$guid = isset($venue_meta['image']) && $venue_meta['image'] ? $venue_meta['image'] : null;
+			if ($guid) {
+				$this->get_migration_script()->convert_image_url_to_attachment_and_attach_to_post($guid, $new_id, $this);
+			}
+			$items_actually_migrated++;
+			if ($guid) {
+				// if there was an image, we may have had to download it etc and it may have taken
+				// longer, then let's not bother migrating anymore on this step
+				break;
+			}
+		}
+		if ($this->count_records_migrated() + $items_actually_migrated >= $this->count_records_to_migrate()) {
+			$this->set_completed();
+		}
+		return $items_actually_migrated;
+	}
+	public function _count_records_to_migrate()
+	{
+		global $wpdb;
+		$count = $wpdb->get_var("SELECT COUNT(id) FROM ".$this->_old_table);
+		return $count;
+	}
+	public function __construct()
+	{
+		$this->_pretty_name = __("Venues", "event_espresso");
+		global $wpdb;
+		$this->_old_table = $wpdb->prefix."events_venue";
+		$this->_new_table = $wpdb->posts;
+		$this->_new_meta_table = $wpdb->prefix."esp_venue_meta";
+		parent::__construct();
+	}
 
-    /**
-     * Inserts the CPT
-     * @param array $old_venue keys are cols, values are col values
-     * @return int
-     */
-    private function _insert_into_posts($old_venue)
-    {
-        global $wpdb;
-        $meta = maybe_unserialize($old_venue['meta']);
-        $slug = $this->_find_unique_slug($old_venue['name'], $old_venue['identifier']);
-        $insertion_array = array(
-                    'post_title'=>stripslashes($old_venue['name']),// VNU_name
-                    'post_content'=>isset($meta['description']) ? stripslashes(strip_tags($meta['description'])) : '',// VNU_desc
-                    'post_name'=> $slug,// VNU_identifier
-                    'post_date'=>current_time('mysql'),// VNU_created
-                    'post_date_gmt'=>  current_time('mysql', true),
-                    'post_excerpt'=>'',// wp_trim_words($meta['description'] ? $meta['description'] : '',50),//VNU_short_desc arbitraty only 50 characters
-                    'post_modified'=>current_time('mysql'),// VNU_modified
-                    'post_modified_gmt'=>current_time('mysql', true),
-                    'post_author'=>$old_venue['wp_user'],// VNU_wp_user
-                    'post_parent'=>0,// parent
-                    'menu_order'=>0,// VNU_order
-                    'post_type'=>'espresso_venues'// post_type
-                );
-        $datatypes_array = array(
-                    '%s',// VNU_name
-                    '%s',// VNU_desc
-                    '%s',// VNU_identifier
-                    '%s',// VNU_created
-                    '%s',
-                    '%s',// VNU_short_desc
-                    '%s',// VNU_modified
-                    '%s',
-                    '%d',// VNU_wp_user
-                    '%d',// parent
-                    '%d',// VNU_order
-                    '%s',// post_type
-                );
-        $success = $wpdb->insert(
-            $this->_new_table,
-            $insertion_array,
-            $datatypes_array
-        );
-        if (! $success) {
-            $this->add_error($this->get_migration_script()->_create_error_message_for_db_insertion($this->_old_table, $old_venue, $this->_new_table, $insertion_array, $datatypes_array));
-            return 0;
-        }
-        return $wpdb->insert_id;
-    }
+	/**
+	 * Inserts the CPT
+	 * @param array $old_venue keys are cols, values are col values
+	 * @return int
+	 */
+	private function _insert_into_posts($old_venue)
+	{
+		global $wpdb;
+		$meta = maybe_unserialize($old_venue['meta']);
+		$slug = $this->_find_unique_slug($old_venue['name'], $old_venue['identifier']);
+		$insertion_array = array(
+					'post_title'=>stripslashes($old_venue['name']),// VNU_name
+					'post_content'=>isset($meta['description']) ? stripslashes(strip_tags($meta['description'])) : '',// VNU_desc
+					'post_name'=> $slug,// VNU_identifier
+					'post_date'=>current_time('mysql'),// VNU_created
+					'post_date_gmt'=>  current_time('mysql', true),
+					'post_excerpt'=>'',// wp_trim_words($meta['description'] ? $meta['description'] : '',50),//VNU_short_desc arbitraty only 50 characters
+					'post_modified'=>current_time('mysql'),// VNU_modified
+					'post_modified_gmt'=>current_time('mysql', true),
+					'post_author'=>$old_venue['wp_user'],// VNU_wp_user
+					'post_parent'=>0,// parent
+					'menu_order'=>0,// VNU_order
+					'post_type'=>'espresso_venues'// post_type
+				);
+		$datatypes_array = array(
+					'%s',// VNU_name
+					'%s',// VNU_desc
+					'%s',// VNU_identifier
+					'%s',// VNU_created
+					'%s',
+					'%s',// VNU_short_desc
+					'%s',// VNU_modified
+					'%s',
+					'%d',// VNU_wp_user
+					'%d',// parent
+					'%d',// VNU_order
+					'%s',// post_type
+				);
+		$success = $wpdb->insert(
+			$this->_new_table,
+			$insertion_array,
+			$datatypes_array
+		);
+		if (! $success) {
+			$this->add_error($this->get_migration_script()->_create_error_message_for_db_insertion($this->_old_table, $old_venue, $this->_new_table, $insertion_array, $datatypes_array));
+			return 0;
+		}
+		return $wpdb->insert_id;
+	}
 
-    /**
-     * Finds a unique slug for this venue, given its name (we could have simply used
-     * the old unique_identifier column, but it added a long string of seemingly random characters onto the end
-     * and really wasn't that pretty for a slug, so we decided we'd make our own slug again)
-     * @param string $post_name
-     * @return string
-     */
-    private function _find_unique_slug($post_name, $old_identifier = '')
-    {
-        $count = 0;
-        $original_name = $post_name ? sanitize_title($post_name) : $old_identifier;
-        $event_slug = $original_name;
-        while ($this->_other_post_exists_with_that_slug($event_slug) && $count<50) {
-            $event_slug = sanitize_title($original_name."-".++$count);
-        }
-        return $event_slug;
-    }
+	/**
+	 * Finds a unique slug for this venue, given its name (we could have simply used
+	 * the old unique_identifier column, but it added a long string of seemingly random characters onto the end
+	 * and really wasn't that pretty for a slug, so we decided we'd make our own slug again)
+	 * @param string $post_name
+	 * @return string
+	 */
+	private function _find_unique_slug($post_name, $old_identifier = '')
+	{
+		$count = 0;
+		$original_name = $post_name ? sanitize_title($post_name) : $old_identifier;
+		$event_slug = $original_name;
+		while ($this->_other_post_exists_with_that_slug($event_slug) && $count<50) {
+			$event_slug = sanitize_title($original_name."-".++$count);
+		}
+		return $event_slug;
+	}
 
-    /**
-     * returns whether or not there is a post that has this same slug (post_title)
-     * @global type $wpdb
-     * @param type $slug
-     * @return boolean
-     */
-    private function _other_post_exists_with_that_slug($slug)
-    {
-        global $wpdb;
-        $query = $wpdb->prepare("SELECT COUNT(ID) FROM ".$this->_new_table." WHERE post_name = %s", $slug);
-        $count = $wpdb->get_var($query);
-        return (boolean) intval($count);
-    }
+	/**
+	 * returns whether or not there is a post that has this same slug (post_title)
+	 * @global type $wpdb
+	 * @param type $slug
+	 * @return boolean
+	 */
+	private function _other_post_exists_with_that_slug($slug)
+	{
+		global $wpdb;
+		$query = $wpdb->prepare("SELECT COUNT(ID) FROM ".$this->_new_table." WHERE post_name = %s", $slug);
+		$count = $wpdb->get_var($query);
+		return (boolean) intval($count);
+	}
 
-    /**
-     * Inserts into the venue_meta table
-     * @param type $cpt_id
-     * @param type $old_venue
-     * @return int
-     */
-    private function _insert_into_meta_table($cpt_id, $old_venue)
-    {
-        global $wpdb;
-        // get a country with the same name, or insert one
-        try {
-            $country = $this->get_migration_script()->get_or_create_country(stripslashes($old_venue['country']));
-            $country_iso = $country['CNT_ISO'];
-        } catch (EE_Error $e) {
-            $this->add_error(sprintf(__("%s for venue %s", "event_espresso"), $e->getMessage(), $this->_json_encode($old_venue)));
-            $country_iso = null;
-        }
-        // get a state with the same name, if possible
-        try {
-            $state = $this->get_migration_script()->get_or_create_state(stripslashes($old_venue['state']), isset($country['CNT_name']) ? $country['CNT_name'] : strip_tags($old_venue['country']));
-            $state_id = $state['STA_ID'];
-        } catch (EE_Error $e) {
-            $this->add_error(sprintf(__("%s for venue %s", "event_espresso"), $e->getMessage(), $this->_json_encode($old_venue)));
-            $state_id = 0;
-        }
-        $meta = maybe_unserialize($old_venue['meta']);
-        // now insert into meta table
-        $insertion_array = array(
-            'VNU_ID'=>$cpt_id,// VNU_ID_fk
-            'VNU_address'=>stripslashes($old_venue['address']),// VNU_address
-            'VNU_address2'=>stripslashes($old_venue['address2']),// VNU_address2
-            'VNU_city'=>stripslashes($old_venue['city']),// VNU_city
-            'STA_ID'=>$state_id,// STA_ID
-            'CNT_ISO'=>$country_iso,// CNT_ISO
-            'VNU_zip'=>stripslashes($old_venue['zip']),// VNU_zip
-            'VNU_phone'=>isset($meta['phone']) ? stripslashes($meta['phone']) : '',// VNU_phone
-            'VNU_capacity'=>-1,// VNU_capacity
-            'VNU_url'=>isset($meta['website']) ? stripslashes($meta['website']) : '',// VNU_url
-            'VNU_virtual_phone'=>'',// VNU_virtual_phone
-            'VNU_virtual_url'=>'',// VNU_virtual_url
-            'VNU_google_map_link'=>'',// VNU_google_map_link
-            'VNU_enable_for_gmap'=>true // VNU_enable_for_gmap
-        );
-        $datatypes = array(
-            '%d',// VNU_ID_fk
-            '%s',// VNU_address
-            '%s',// VNU_address2
-            '%s',// VNU_city
-            '%d',// STA_ID
-            '%s',// CNT_ISO
-            '%s',// VNU_zip
-            '%s',// VNU_phone
-            '%d',// VNU_capacity
-            '%s',// VNU_url
-            '%s',// VNU_virtual_phone
-            '%s',// VNU_virtual_url
-            '%s',// VNU_google_map_link
-            '%d',// VNU_enable_for_gmap
-        );
-        $success = $wpdb->insert($this->_new_meta_table, $insertion_array, $datatypes);
-        if (! $success) {
-            $this->add_error($this->get_migration_script()->_create_error_message_for_db_insertion($this->_old_table, $old_venue, $this->_new_meta_table, $insertion_array, $datatypes));
-            return 0;
-        }
-        return $wpdb->insert_id;
-    }
+	/**
+	 * Inserts into the venue_meta table
+	 * @param type $cpt_id
+	 * @param type $old_venue
+	 * @return int
+	 */
+	private function _insert_into_meta_table($cpt_id, $old_venue)
+	{
+		global $wpdb;
+		// get a country with the same name, or insert one
+		try {
+			$country = $this->get_migration_script()->get_or_create_country(stripslashes($old_venue['country']));
+			$country_iso = $country['CNT_ISO'];
+		} catch (EE_Error $e) {
+			$this->add_error(sprintf(__("%s for venue %s", "event_espresso"), $e->getMessage(), $this->_json_encode($old_venue)));
+			$country_iso = null;
+		}
+		// get a state with the same name, if possible
+		try {
+			$state = $this->get_migration_script()->get_or_create_state(stripslashes($old_venue['state']), isset($country['CNT_name']) ? $country['CNT_name'] : strip_tags($old_venue['country']));
+			$state_id = $state['STA_ID'];
+		} catch (EE_Error $e) {
+			$this->add_error(sprintf(__("%s for venue %s", "event_espresso"), $e->getMessage(), $this->_json_encode($old_venue)));
+			$state_id = 0;
+		}
+		$meta = maybe_unserialize($old_venue['meta']);
+		// now insert into meta table
+		$insertion_array = array(
+			'VNU_ID'=>$cpt_id,// VNU_ID_fk
+			'VNU_address'=>stripslashes($old_venue['address']),// VNU_address
+			'VNU_address2'=>stripslashes($old_venue['address2']),// VNU_address2
+			'VNU_city'=>stripslashes($old_venue['city']),// VNU_city
+			'STA_ID'=>$state_id,// STA_ID
+			'CNT_ISO'=>$country_iso,// CNT_ISO
+			'VNU_zip'=>stripslashes($old_venue['zip']),// VNU_zip
+			'VNU_phone'=>isset($meta['phone']) ? stripslashes($meta['phone']) : '',// VNU_phone
+			'VNU_capacity'=>-1,// VNU_capacity
+			'VNU_url'=>isset($meta['website']) ? stripslashes($meta['website']) : '',// VNU_url
+			'VNU_virtual_phone'=>'',// VNU_virtual_phone
+			'VNU_virtual_url'=>'',// VNU_virtual_url
+			'VNU_google_map_link'=>'',// VNU_google_map_link
+			'VNU_enable_for_gmap'=>true // VNU_enable_for_gmap
+		);
+		$datatypes = array(
+			'%d',// VNU_ID_fk
+			'%s',// VNU_address
+			'%s',// VNU_address2
+			'%s',// VNU_city
+			'%d',// STA_ID
+			'%s',// CNT_ISO
+			'%s',// VNU_zip
+			'%s',// VNU_phone
+			'%d',// VNU_capacity
+			'%s',// VNU_url
+			'%s',// VNU_virtual_phone
+			'%s',// VNU_virtual_url
+			'%s',// VNU_google_map_link
+			'%d',// VNU_enable_for_gmap
+		);
+		$success = $wpdb->insert($this->_new_meta_table, $insertion_array, $datatypes);
+		if (! $success) {
+			$this->add_error($this->get_migration_script()->_create_error_message_for_db_insertion($this->_old_table, $old_venue, $this->_new_meta_table, $insertion_array, $datatypes));
+			return 0;
+		}
+		return $wpdb->insert_id;
+	}
 }

Spacing +51 added lines, -51 removed lines

@@ -73,12 +73,12 @@ 
         $rows = $wpdb->get_results($wpdb->prepare("SELECT * FROM ".$this->_old_table." LIMIT %d,%d", $start_at_record, $num_items), ARRAY_A);
         $items_actually_migrated = 0;
         foreach ($rows as $old_venue) {
-            if (! $new_id = $this->_insert_into_posts($old_venue)) {
+            if ( ! $new_id = $this->_insert_into_posts($old_venue)) {
                 $items_actually_migrated++;
                 continue;
             }
             $this->get_migration_script()->set_mapping($this->_old_table, $old_venue['id'], $this->_new_table, $new_id);
-            if (! $new_meta_id = $this->_insert_into_meta_table($new_id, $old_venue)) {
+            if ( ! $new_meta_id = $this->_insert_into_meta_table($new_id, $old_venue)) {
                 $items_actually_migrated++;
                 continue;
             }
@@ -132,39 +132,39 @@ 
         $meta = maybe_unserialize($old_venue['meta']);
         $slug = $this->_find_unique_slug($old_venue['name'], $old_venue['identifier']);
         $insertion_array = array(
-                    'post_title'=>stripslashes($old_venue['name']),// VNU_name
-                    'post_content'=>isset($meta['description']) ? stripslashes(strip_tags($meta['description'])) : '',// VNU_desc
-                    'post_name'=> $slug,// VNU_identifier
-                    'post_date'=>current_time('mysql'),// VNU_created
+                    'post_title'=>stripslashes($old_venue['name']), // VNU_name
+                    'post_content'=>isset($meta['description']) ? stripslashes(strip_tags($meta['description'])) : '', // VNU_desc
+                    'post_name'=> $slug, // VNU_identifier
+                    'post_date'=>current_time('mysql'), // VNU_created
                     'post_date_gmt'=>  current_time('mysql', true),
-                    'post_excerpt'=>'',// wp_trim_words($meta['description'] ? $meta['description'] : '',50),//VNU_short_desc arbitraty only 50 characters
-                    'post_modified'=>current_time('mysql'),// VNU_modified
+                    'post_excerpt'=>'', // wp_trim_words($meta['description'] ? $meta['description'] : '',50),//VNU_short_desc arbitraty only 50 characters
+                    'post_modified'=>current_time('mysql'), // VNU_modified
                     'post_modified_gmt'=>current_time('mysql', true),
-                    'post_author'=>$old_venue['wp_user'],// VNU_wp_user
-                    'post_parent'=>0,// parent
-                    'menu_order'=>0,// VNU_order
+                    'post_author'=>$old_venue['wp_user'], // VNU_wp_user
+                    'post_parent'=>0, // parent
+                    'menu_order'=>0, // VNU_order
                     'post_type'=>'espresso_venues'// post_type
                 );
         $datatypes_array = array(
-                    '%s',// VNU_name
-                    '%s',// VNU_desc
-                    '%s',// VNU_identifier
-                    '%s',// VNU_created
+                    '%s', // VNU_name
+                    '%s', // VNU_desc
+                    '%s', // VNU_identifier
+                    '%s', // VNU_created
                     '%s',
-                    '%s',// VNU_short_desc
-                    '%s',// VNU_modified
+                    '%s', // VNU_short_desc
+                    '%s', // VNU_modified
                     '%s',
-                    '%d',// VNU_wp_user
-                    '%d',// parent
-                    '%d',// VNU_order
-                    '%s',// post_type
+                    '%d', // VNU_wp_user
+                    '%d', // parent
+                    '%d', // VNU_order
+                    '%s', // post_type
                 );
         $success = $wpdb->insert(
             $this->_new_table,
             $insertion_array,
             $datatypes_array
         );
-        if (! $success) {
+        if ( ! $success) {
             $this->add_error($this->get_migration_script()->_create_error_message_for_db_insertion($this->_old_table, $old_venue, $this->_new_table, $insertion_array, $datatypes_array));
             return 0;
         }
@@ -183,7 +183,7 @@ 
         $count = 0;
         $original_name = $post_name ? sanitize_title($post_name) : $old_identifier;
         $event_slug = $original_name;
-        while ($this->_other_post_exists_with_that_slug($event_slug) && $count<50) {
+        while ($this->_other_post_exists_with_that_slug($event_slug) && $count < 50) {
             $event_slug = sanitize_title($original_name."-".++$count);
         }
         return $event_slug;
@@ -231,39 +231,39 @@ 
         $meta = maybe_unserialize($old_venue['meta']);
         // now insert into meta table
         $insertion_array = array(
-            'VNU_ID'=>$cpt_id,// VNU_ID_fk
-            'VNU_address'=>stripslashes($old_venue['address']),// VNU_address
-            'VNU_address2'=>stripslashes($old_venue['address2']),// VNU_address2
-            'VNU_city'=>stripslashes($old_venue['city']),// VNU_city
-            'STA_ID'=>$state_id,// STA_ID
-            'CNT_ISO'=>$country_iso,// CNT_ISO
-            'VNU_zip'=>stripslashes($old_venue['zip']),// VNU_zip
-            'VNU_phone'=>isset($meta['phone']) ? stripslashes($meta['phone']) : '',// VNU_phone
-            'VNU_capacity'=>-1,// VNU_capacity
-            'VNU_url'=>isset($meta['website']) ? stripslashes($meta['website']) : '',// VNU_url
-            'VNU_virtual_phone'=>'',// VNU_virtual_phone
-            'VNU_virtual_url'=>'',// VNU_virtual_url
-            'VNU_google_map_link'=>'',// VNU_google_map_link
+            'VNU_ID'=>$cpt_id, // VNU_ID_fk
+            'VNU_address'=>stripslashes($old_venue['address']), // VNU_address
+            'VNU_address2'=>stripslashes($old_venue['address2']), // VNU_address2
+            'VNU_city'=>stripslashes($old_venue['city']), // VNU_city
+            'STA_ID'=>$state_id, // STA_ID
+            'CNT_ISO'=>$country_iso, // CNT_ISO
+            'VNU_zip'=>stripslashes($old_venue['zip']), // VNU_zip
+            'VNU_phone'=>isset($meta['phone']) ? stripslashes($meta['phone']) : '', // VNU_phone
+            'VNU_capacity'=>-1, // VNU_capacity
+            'VNU_url'=>isset($meta['website']) ? stripslashes($meta['website']) : '', // VNU_url
+            'VNU_virtual_phone'=>'', // VNU_virtual_phone
+            'VNU_virtual_url'=>'', // VNU_virtual_url
+            'VNU_google_map_link'=>'', // VNU_google_map_link
             'VNU_enable_for_gmap'=>true // VNU_enable_for_gmap
         );
         $datatypes = array(
-            '%d',// VNU_ID_fk
-            '%s',// VNU_address
-            '%s',// VNU_address2
-            '%s',// VNU_city
-            '%d',// STA_ID
-            '%s',// CNT_ISO
-            '%s',// VNU_zip
-            '%s',// VNU_phone
-            '%d',// VNU_capacity
-            '%s',// VNU_url
-            '%s',// VNU_virtual_phone
-            '%s',// VNU_virtual_url
-            '%s',// VNU_google_map_link
-            '%d',// VNU_enable_for_gmap
+            '%d', // VNU_ID_fk
+            '%s', // VNU_address
+            '%s', // VNU_address2
+            '%s', // VNU_city
+            '%d', // STA_ID
+            '%s', // CNT_ISO
+            '%s', // VNU_zip
+            '%s', // VNU_phone
+            '%d', // VNU_capacity
+            '%s', // VNU_url
+            '%s', // VNU_virtual_phone
+            '%s', // VNU_virtual_url
+            '%s', // VNU_google_map_link
+            '%d', // VNU_enable_for_gmap
         );
         $success = $wpdb->insert($this->_new_meta_table, $insertion_array, $datatypes);
-        if (! $success) {
+        if ( ! $success) {
             $this->add_error($this->get_migration_script()->_create_error_message_for_db_insertion($this->_old_table, $old_venue, $this->_new_meta_table, $insertion_array, $datatypes));
             return 0;
         }

core/data_migration_scripts/4_6_0_stages/EE_DMS_4_6_0_payment_method_currencies.dmsstage.php

Doc Comments +3 added lines, -2 removed lines

@@ -128,6 +128,9 @@ 
         return $items_actually_migrated;
     }
 
+    /**
+     * @param integer $num_items_to_migrate
+     */
     private function _gather_relations_to_add($num_items_to_migrate)
     {
         $relations_to_add_this_step = array();
@@ -160,8 +163,6 @@ 
 
     /**
      * Adds teh relation between the payment method and the currencies it can be used for
-     * @param int $id
-     * @param string $gateway_slug
      */
     private function _add_currency_relations($pm_id, $currency_code)
     {

Indentation +164 added lines, -164 removed lines

@@ -12,174 +12,174 @@
  */
 class EE_DMS_4_6_0_payment_method_currencies extends EE_Data_Migration_Script_Stage
 {
-    protected $_currency_table_name;
-    protected $_currency_payment_method_table_name;
-    protected $_payment_method_table_name;
-    /**
-     * each key is the name of a 4.1-style gateway we know how to migrate to 4.6
-     * @var array
-     */
-    protected $_gateway_currencies = array(
-        'Aim' => array(
-            'AUD',
-            'USD',
-            'CAD',
-            'EUR',
-            'GBP',
-            'NZD',
-        ),
-        'Bank' => 'all',
-        'Check' => 'all',
-        'Invoice' => 'all',
-        'Mijireh' => 'all',
-        'Paypal_Pro' => array(
-            'USD',
-            'GBP',
-            'CAD',
-            'AUD',
-            'BRL',
-            'CHF',
-            'CZK',
-            'DKK',
-            'EUR',
-            'HKD',
-            'HUF',
-            'ILS',
-            'JPY',
-            'MXN',
-            'MYR',
-            'NOK',
-            'NZD',
-            'PHP',
-            'PLN',
-            'SEK',
-            'SGD',
-            'THB',
-            'TRY',
-            'TWD',
-        ),
-        'Paypal_Standard' => array(
-            'USD',
-            'GBP',
-            'CAD',
-            'AUD',
-            'BRL',
-            'CHF',
-            'CZK',
-            'DKK',
-            'EUR',
-            'HKD',
-            'HUF',
-            'ILS',
-            'JPY',
-            'MXN',
-            'MYR',
-            'NOK',
-            'NZD',
-            'PHP',
-            'PLN',
-            'SEK',
-            'SGD',
-            'THB',
-            'TRY',
-            'TWD'
-        )
-    );
-    public function __construct()
-    {
-        global $wpdb;
-        $this->_pretty_name = __('Payment Method Currencies', 'event_espresso');
-        $this->_payment_method_table_name = $wpdb->prefix.'esp_payment_method';
-        $this->_currency_payment_method_table_name = $wpdb->prefix.'esp_currency_payment_method';
-        $this->_currency_table_name = $wpdb->prefix.'esp_currency';
-        parent::__construct();
-    }
+	protected $_currency_table_name;
+	protected $_currency_payment_method_table_name;
+	protected $_payment_method_table_name;
+	/**
+	 * each key is the name of a 4.1-style gateway we know how to migrate to 4.6
+	 * @var array
+	 */
+	protected $_gateway_currencies = array(
+		'Aim' => array(
+			'AUD',
+			'USD',
+			'CAD',
+			'EUR',
+			'GBP',
+			'NZD',
+		),
+		'Bank' => 'all',
+		'Check' => 'all',
+		'Invoice' => 'all',
+		'Mijireh' => 'all',
+		'Paypal_Pro' => array(
+			'USD',
+			'GBP',
+			'CAD',
+			'AUD',
+			'BRL',
+			'CHF',
+			'CZK',
+			'DKK',
+			'EUR',
+			'HKD',
+			'HUF',
+			'ILS',
+			'JPY',
+			'MXN',
+			'MYR',
+			'NOK',
+			'NZD',
+			'PHP',
+			'PLN',
+			'SEK',
+			'SGD',
+			'THB',
+			'TRY',
+			'TWD',
+		),
+		'Paypal_Standard' => array(
+			'USD',
+			'GBP',
+			'CAD',
+			'AUD',
+			'BRL',
+			'CHF',
+			'CZK',
+			'DKK',
+			'EUR',
+			'HKD',
+			'HUF',
+			'ILS',
+			'JPY',
+			'MXN',
+			'MYR',
+			'NOK',
+			'NZD',
+			'PHP',
+			'PLN',
+			'SEK',
+			'SGD',
+			'THB',
+			'TRY',
+			'TWD'
+		)
+	);
+	public function __construct()
+	{
+		global $wpdb;
+		$this->_pretty_name = __('Payment Method Currencies', 'event_espresso');
+		$this->_payment_method_table_name = $wpdb->prefix.'esp_payment_method';
+		$this->_currency_payment_method_table_name = $wpdb->prefix.'esp_currency_payment_method';
+		$this->_currency_table_name = $wpdb->prefix.'esp_currency';
+		parent::__construct();
+	}
 
-    protected function _count_records_to_migrate()
-    {
-        $count = 0;
-        foreach ($this->_gateway_currencies as $currencies) {
-            if ($currencies == 'all') {
-                $currencies = $this->_get_all_currencies();
-            }
-            $count += count($currencies);
-        }
-        return $count;
-    }
+	protected function _count_records_to_migrate()
+	{
+		$count = 0;
+		foreach ($this->_gateway_currencies as $currencies) {
+			if ($currencies == 'all') {
+				$currencies = $this->_get_all_currencies();
+			}
+			$count += count($currencies);
+		}
+		return $count;
+	}
 
 
 
-    protected function _migration_step($num_items_to_migrate = 50)
-    {
-        $items_actually_migrated = 0;
-        $relations_to_add_this_step = $this->_gather_relations_to_add($num_items_to_migrate);
-        foreach ($relations_to_add_this_step as $pm_slug => $currencies) {
-            $id = $this->get_migration_script()->get_mapping_new_pk('EE_Gateway_Config', $pm_slug, $this->_payment_method_table_name);
-            foreach ($currencies as $currency) {
-                if ($id) {
-                    $this->_add_currency_relations($id, $currency);
-                }
-                $items_actually_migrated++;
-            }
-        }
-        if ($this->count_records_migrated() + $items_actually_migrated >= $this->count_records_to_migrate()) {
-            $this->set_completed();
-        }
-        return $items_actually_migrated;
-    }
+	protected function _migration_step($num_items_to_migrate = 50)
+	{
+		$items_actually_migrated = 0;
+		$relations_to_add_this_step = $this->_gather_relations_to_add($num_items_to_migrate);
+		foreach ($relations_to_add_this_step as $pm_slug => $currencies) {
+			$id = $this->get_migration_script()->get_mapping_new_pk('EE_Gateway_Config', $pm_slug, $this->_payment_method_table_name);
+			foreach ($currencies as $currency) {
+				if ($id) {
+					$this->_add_currency_relations($id, $currency);
+				}
+				$items_actually_migrated++;
+			}
+		}
+		if ($this->count_records_migrated() + $items_actually_migrated >= $this->count_records_to_migrate()) {
+			$this->set_completed();
+		}
+		return $items_actually_migrated;
+	}
 
-    private function _gather_relations_to_add($num_items_to_migrate)
-    {
-        $relations_to_add_this_step = array();
-        $migrate_up_to_count = $this->count_records_migrated() + $num_items_to_migrate;
-        $iterator = 0;
-        foreach ($this->_gateway_currencies as $pm_slug => $currencies) {
-            if ($currencies == 'all') {
-                $currencies = $this->_get_all_currencies();
-            }
-            foreach ($currencies as $currency_code) {
-                if ($this->count_records_migrated() <= $iterator &&
-                        $iterator < $migrate_up_to_count ) {
-                    $relations_to_add_this_step[ $pm_slug ] [] = $currency_code;
-                }
-                $iterator++;
-            }
-        }
-        return $relations_to_add_this_step;
-    }
-    /**
-     * Gets all the currency codes in the database
-     * @return array
-     */
-    private function _get_all_currencies()
-    {
-        global $wpdb;
-        $currencies = $wpdb->get_col("SELECT CUR_code FROM {$this->_currency_table_name}");
-        return $currencies;
-    }
+	private function _gather_relations_to_add($num_items_to_migrate)
+	{
+		$relations_to_add_this_step = array();
+		$migrate_up_to_count = $this->count_records_migrated() + $num_items_to_migrate;
+		$iterator = 0;
+		foreach ($this->_gateway_currencies as $pm_slug => $currencies) {
+			if ($currencies == 'all') {
+				$currencies = $this->_get_all_currencies();
+			}
+			foreach ($currencies as $currency_code) {
+				if ($this->count_records_migrated() <= $iterator &&
+						$iterator < $migrate_up_to_count ) {
+					$relations_to_add_this_step[ $pm_slug ] [] = $currency_code;
+				}
+				$iterator++;
+			}
+		}
+		return $relations_to_add_this_step;
+	}
+	/**
+	 * Gets all the currency codes in the database
+	 * @return array
+	 */
+	private function _get_all_currencies()
+	{
+		global $wpdb;
+		$currencies = $wpdb->get_col("SELECT CUR_code FROM {$this->_currency_table_name}");
+		return $currencies;
+	}
 
-    /**
-     * Adds teh relation between the payment method and the currencies it can be used for
-     * @param int $id
-     * @param string $gateway_slug
-     */
-    private function _add_currency_relations($pm_id, $currency_code)
-    {
-        global $wpdb;
-        $cur_pm_relation = array(
-                    'CUR_code'=>$currency_code,
-                    'PMD_ID'=>$pm_id,
-                );
-        $success = $wpdb->insert(
-            $this->_currency_payment_method_table_name,
-            $cur_pm_relation,
-            array(
-                    '%s',// CUR_code
-                    '%d',// PMD_ID
-                )
-        );
-        if (! $success) {
-            $this->add_error(sprintf(__('Could not add currency relation %s because %s', "event_espresso"), wp_json_encode($cur_pm_relation), $wpdb->last_error));
-        }
-    }
+	/**
+	 * Adds teh relation between the payment method and the currencies it can be used for
+	 * @param int $id
+	 * @param string $gateway_slug
+	 */
+	private function _add_currency_relations($pm_id, $currency_code)
+	{
+		global $wpdb;
+		$cur_pm_relation = array(
+					'CUR_code'=>$currency_code,
+					'PMD_ID'=>$pm_id,
+				);
+		$success = $wpdb->insert(
+			$this->_currency_payment_method_table_name,
+			$cur_pm_relation,
+			array(
+					'%s',// CUR_code
+					'%d',// PMD_ID
+				)
+		);
+		if (! $success) {
+			$this->add_error(sprintf(__('Could not add currency relation %s because %s', "event_espresso"), wp_json_encode($cur_pm_relation), $wpdb->last_error));
+		}
+	}
 }

Spacing +5 added lines, -5 removed lines

@@ -139,8 +139,8 @@ 
             }
             foreach ($currencies as $currency_code) {
                 if ($this->count_records_migrated() <= $iterator &&
-                        $iterator < $migrate_up_to_count ) {
-                    $relations_to_add_this_step[ $pm_slug ] [] = $currency_code;
+                        $iterator < $migrate_up_to_count) {
+                    $relations_to_add_this_step[$pm_slug] [] = $currency_code;
                 }
                 $iterator++;
             }
@@ -174,11 +174,11 @@ 
             $this->_currency_payment_method_table_name,
             $cur_pm_relation,
             array(
-                    '%s',// CUR_code
-                    '%d',// PMD_ID
+                    '%s', // CUR_code
+                    '%d', // PMD_ID
                 )
         );
-        if (! $success) {
+        if ( ! $success) {
             $this->add_error(sprintf(__('Could not add currency relation %s because %s', "event_espresso"), wp_json_encode($cur_pm_relation), $wpdb->last_error));
         }
     }

core/data_migration_scripts/4_6_0_stages/EE_DMS_4_6_0_payments.dmsstage.php

Doc Comments -1 removed lines

@@ -58,7 +58,6 @@
             'IV'=>  __("Invoice", 'event_espresso'),
             'MO'=>  __("Money Order", 'event_espresso'),
      * @global type $wpdb
-     * @param int $id
      * @return string
      */
     protected function _get_payment_method_id_by_gateway_name($gateway_name, $old_pay_method_column)

Indentation +78 added lines, -78 removed lines

@@ -11,44 +11,44 @@ 
  */
 class EE_DMS_4_6_0_payments extends EE_Data_Migration_Script_Stage_Table
 {
-    protected $_payment_method_table;
-    public function __construct()
-    {
-        global $wpdb;
-        $this->_old_table = $wpdb->prefix . 'esp_payment';
-        $this->_payment_method_table = $wpdb->prefix . 'esp_payment_method';
-        $this->_pretty_name = __('Payment-Payment Method Relations', 'event_espresso');
-        parent::__construct();
-    }
-    protected function _migrate_old_row($payment_row)
-    {
-        global $wpdb;
-        // get the payment method's ID
-        $PMD_ID = apply_filters('FHEE__EE_DMS_4_6_0_payments__migrate_old_row__PMD_ID', $this->_get_payment_method_id_by_gateway_name($payment_row['PAY_gateway'], $payment_row['PAY_method']));
-        if (! $PMD_ID) {
-            $this->add_error(sprintf(__('Could not find payment method with PMD_type = \'%1$s\' when migrating payment row %2$s so just assigned it an unknown payment method', 'event_espresso'), $payment_row['PAY_gateway'], $this->_json_encode($payment_row)));
-            $PMD_ID = 0;
-        }
-        $new_values = array(
-            'PMD_ID' => $PMD_ID,
-            'PAY_source' => ( $payment_row['PAY_via_admin'] ? 'ADMIN' : 'CART' ) );
-        $wheres = array( 'PAY_ID' => $payment_row['PAY_ID'] );
-        $new_value_datatypes = array( '%d', '%s' );
-        $where_datatypes = array( '%d' );
-        $success = $wpdb->update(
-            $this->_old_table,
-            $new_values,
-            $wheres,
-            $new_value_datatypes,
-            $where_datatypes
-        );
-        if (! $success) {
-            $this->add_error(sprintf(__('Couldnt set %1$s row in table %2$s where %3$s', 'event_espresso'), $this->_json_encode($new_values), $this->_old_table, $this->_json_encode($wheres)));
-        }
-    }
-    /**
-     *
-     *  array(
+	protected $_payment_method_table;
+	public function __construct()
+	{
+		global $wpdb;
+		$this->_old_table = $wpdb->prefix . 'esp_payment';
+		$this->_payment_method_table = $wpdb->prefix . 'esp_payment_method';
+		$this->_pretty_name = __('Payment-Payment Method Relations', 'event_espresso');
+		parent::__construct();
+	}
+	protected function _migrate_old_row($payment_row)
+	{
+		global $wpdb;
+		// get the payment method's ID
+		$PMD_ID = apply_filters('FHEE__EE_DMS_4_6_0_payments__migrate_old_row__PMD_ID', $this->_get_payment_method_id_by_gateway_name($payment_row['PAY_gateway'], $payment_row['PAY_method']));
+		if (! $PMD_ID) {
+			$this->add_error(sprintf(__('Could not find payment method with PMD_type = \'%1$s\' when migrating payment row %2$s so just assigned it an unknown payment method', 'event_espresso'), $payment_row['PAY_gateway'], $this->_json_encode($payment_row)));
+			$PMD_ID = 0;
+		}
+		$new_values = array(
+			'PMD_ID' => $PMD_ID,
+			'PAY_source' => ( $payment_row['PAY_via_admin'] ? 'ADMIN' : 'CART' ) );
+		$wheres = array( 'PAY_ID' => $payment_row['PAY_ID'] );
+		$new_value_datatypes = array( '%d', '%s' );
+		$where_datatypes = array( '%d' );
+		$success = $wpdb->update(
+			$this->_old_table,
+			$new_values,
+			$wheres,
+			$new_value_datatypes,
+			$where_datatypes
+		);
+		if (! $success) {
+			$this->add_error(sprintf(__('Couldnt set %1$s row in table %2$s where %3$s', 'event_espresso'), $this->_json_encode($new_values), $this->_old_table, $this->_json_encode($wheres)));
+		}
+	}
+	/**
+	 *
+	 *  array(
             'PP' => __( 'PayPal', 'event_espresso' ),
             'CC' => __( 'Credit Card', 'event_espresso' ),
             'DB'=>  __("Debit Card", 'event_espresso'),
@@ -57,44 +57,44 @@ 
             'BK'=>  __("Bank", 'event_espresso'),
             'IV'=>  __("Invoice", 'event_espresso'),
             'MO'=>  __("Money Order", 'event_espresso'),
-     * @global type $wpdb
-     * @param int $id
-     * @return string
-     */
-    protected function _get_payment_method_id_by_gateway_name($gateway_name, $old_pay_method_column)
-    {
-        global $wpdb;
-        // convert from old known PAY_method values to their corresponding
-        // PMD_type or default PMD_name
-        switch ($old_pay_method_column) {
-            case 'PP':
-                $pmd_type = 'Paypal_Standard';
-                break;
-            case 'CC':
-                $pmd_type = 'Credit_Card';
-                break;
-            case 'DB':
-                $pmd_type = 'Debit_Card';
-                break;
-            case 'CHQ':
-                $pmd_type = 'Check';
-                break;
-            case 'CSH':
-                $pmd_type = 'Cash';
-                break;
-            case 'BK':
-                $pmd_type = 'Bank';
-                break;
-            case 'IV':
-                $pmd_type = 'Invoice';
-                break;
-            case 'MO':
-                $pmd_type = 'Money_Order';
-                break;
-            default:
-                $pmd_type = $gateway_name;
-        }
-        $pmd_name = str_replace("_", " ", $pmd_type);
-        return $wpdb->get_var($wpdb->prepare("SELECT PMD_ID FROM " . $wpdb->prefix . "esp_payment_method WHERE PMD_type = %s OR PMD_name = %s", $pmd_type, $pmd_name));
-    }
+	 * @global type $wpdb
+	 * @param int $id
+	 * @return string
+	 */
+	protected function _get_payment_method_id_by_gateway_name($gateway_name, $old_pay_method_column)
+	{
+		global $wpdb;
+		// convert from old known PAY_method values to their corresponding
+		// PMD_type or default PMD_name
+		switch ($old_pay_method_column) {
+			case 'PP':
+				$pmd_type = 'Paypal_Standard';
+				break;
+			case 'CC':
+				$pmd_type = 'Credit_Card';
+				break;
+			case 'DB':
+				$pmd_type = 'Debit_Card';
+				break;
+			case 'CHQ':
+				$pmd_type = 'Check';
+				break;
+			case 'CSH':
+				$pmd_type = 'Cash';
+				break;
+			case 'BK':
+				$pmd_type = 'Bank';
+				break;
+			case 'IV':
+				$pmd_type = 'Invoice';
+				break;
+			case 'MO':
+				$pmd_type = 'Money_Order';
+				break;
+			default:
+				$pmd_type = $gateway_name;
+		}
+		$pmd_name = str_replace("_", " ", $pmd_type);
+		return $wpdb->get_var($wpdb->prepare("SELECT PMD_ID FROM " . $wpdb->prefix . "esp_payment_method WHERE PMD_type = %s OR PMD_name = %s", $pmd_type, $pmd_name));
+	}
 }

Spacing +9 added lines, -9 removed lines

@@ -15,8 +15,8 @@ 
     public function __construct()
     {
         global $wpdb;
-        $this->_old_table = $wpdb->prefix . 'esp_payment';
-        $this->_payment_method_table = $wpdb->prefix . 'esp_payment_method';
+        $this->_old_table = $wpdb->prefix.'esp_payment';
+        $this->_payment_method_table = $wpdb->prefix.'esp_payment_method';
         $this->_pretty_name = __('Payment-Payment Method Relations', 'event_espresso');
         parent::__construct();
     }
@@ -25,16 +25,16 @@ 
         global $wpdb;
         // get the payment method's ID
         $PMD_ID = apply_filters('FHEE__EE_DMS_4_6_0_payments__migrate_old_row__PMD_ID', $this->_get_payment_method_id_by_gateway_name($payment_row['PAY_gateway'], $payment_row['PAY_method']));
-        if (! $PMD_ID) {
+        if ( ! $PMD_ID) {
             $this->add_error(sprintf(__('Could not find payment method with PMD_type = \'%1$s\' when migrating payment row %2$s so just assigned it an unknown payment method', 'event_espresso'), $payment_row['PAY_gateway'], $this->_json_encode($payment_row)));
             $PMD_ID = 0;
         }
         $new_values = array(
             'PMD_ID' => $PMD_ID,
-            'PAY_source' => ( $payment_row['PAY_via_admin'] ? 'ADMIN' : 'CART' ) );
-        $wheres = array( 'PAY_ID' => $payment_row['PAY_ID'] );
-        $new_value_datatypes = array( '%d', '%s' );
-        $where_datatypes = array( '%d' );
+            'PAY_source' => ($payment_row['PAY_via_admin'] ? 'ADMIN' : 'CART') );
+        $wheres = array('PAY_ID' => $payment_row['PAY_ID']);
+        $new_value_datatypes = array('%d', '%s');
+        $where_datatypes = array('%d');
         $success = $wpdb->update(
             $this->_old_table,
             $new_values,
@@ -42,7 +42,7 @@ 
             $new_value_datatypes,
             $where_datatypes
         );
-        if (! $success) {
+        if ( ! $success) {
             $this->add_error(sprintf(__('Couldnt set %1$s row in table %2$s where %3$s', 'event_espresso'), $this->_json_encode($new_values), $this->_old_table, $this->_json_encode($wheres)));
         }
     }
@@ -95,6 +95,6 @@ 
                 $pmd_type = $gateway_name;
         }
         $pmd_name = str_replace("_", " ", $pmd_type);
-        return $wpdb->get_var($wpdb->prepare("SELECT PMD_ID FROM " . $wpdb->prefix . "esp_payment_method WHERE PMD_type = %s OR PMD_name = %s", $pmd_type, $pmd_name));
+        return $wpdb->get_var($wpdb->prepare("SELECT PMD_ID FROM ".$wpdb->prefix."esp_payment_method WHERE PMD_type = %s OR PMD_name = %s", $pmd_type, $pmd_name));
     }
 }

core/data_migration_scripts/4_6_0_stages/EE_DMS_4_6_0_transactions.dmsstage.php

Doc Comments -1 removed lines

@@ -50,7 +50,6 @@
     /**
      *
      * @global type $wpdb
-     * @param int $id
      * @return string
      */
     protected function _get_payment_method_id_by_gateway_name($gateway_name)

Indentation +47 added lines, -47 removed lines

@@ -11,51 +11,51 @@
  */
 class EE_DMS_4_6_0_transactions extends EE_Data_Migration_Script_Stage_Table
 {
-    protected $_transaction_table;
-    protected $_payment_method_table;
-    public function __construct()
-    {
-        global $wpdb;
-        $this->_old_table = $wpdb->prefix . 'esp_extra_meta';
-        $this->_transaction_table = $wpdb->prefix . 'esp_transaction';
-        $this->_payment_method_table = $wpdb->prefix . 'esp_payment_method';
-        $this->_pretty_name = __('Transaction Payment Method Relations', 'event_espresso');
-        $this->_extra_where_sql = "WHERE EXM_key = 'gateway' AND EXM_type = 'Transaction'";
-        parent::__construct();
-    }
-    protected function _migrate_old_row($extra_meta_row)
-    {
-        global $wpdb;
-        // get the payment method's ID
-        $PMD_ID = $this->_get_payment_method_id_by_gateway_name($extra_meta_row['EXM_value']);
-        if (! $PMD_ID) {
-            $this->add_error(sprintf(__('Could not find payment method with PMD_type = \'%1$s\' when migrating extra meta row %2$s', 'event_espresso'), $extra_meta_row['EXM_value'], $this->_json_encode($extra_meta_row)));
-            return;
-        }
-        $new_values = array( 'PMD_ID' => $PMD_ID );
-        $wheres = array( 'TXN_ID' => $extra_meta_row['OBJ_ID'] );
-        $new_value_datatypes = array( '%d' );
-        $where_datatypes = array( '%d' );
-        $success = $wpdb->update(
-            $this->_transaction_table,
-            $new_values,
-            $wheres,
-            $new_value_datatypes,
-            $where_datatypes
-        );
-        if (! $success) {
-            $this->add_error(sprintf(__('Couldnt set %1$s row in table %2$s where %3$s', 'event_espresso'), $this->_json_encode($new_values), $this->_transaction_table, $this->_json_encode($wheres)));
-        }
-    }
-    /**
-     *
-     * @global type $wpdb
-     * @param int $id
-     * @return string
-     */
-    protected function _get_payment_method_id_by_gateway_name($gateway_name)
-    {
-        global $wpdb;
-        return $wpdb->get_var($wpdb->prepare("SELECT PMD_ID FROM " . $wpdb->prefix . "esp_payment_method WHERE PMD_type = %s", $gateway_name));
-    }
+	protected $_transaction_table;
+	protected $_payment_method_table;
+	public function __construct()
+	{
+		global $wpdb;
+		$this->_old_table = $wpdb->prefix . 'esp_extra_meta';
+		$this->_transaction_table = $wpdb->prefix . 'esp_transaction';
+		$this->_payment_method_table = $wpdb->prefix . 'esp_payment_method';
+		$this->_pretty_name = __('Transaction Payment Method Relations', 'event_espresso');
+		$this->_extra_where_sql = "WHERE EXM_key = 'gateway' AND EXM_type = 'Transaction'";
+		parent::__construct();
+	}
+	protected function _migrate_old_row($extra_meta_row)
+	{
+		global $wpdb;
+		// get the payment method's ID
+		$PMD_ID = $this->_get_payment_method_id_by_gateway_name($extra_meta_row['EXM_value']);
+		if (! $PMD_ID) {
+			$this->add_error(sprintf(__('Could not find payment method with PMD_type = \'%1$s\' when migrating extra meta row %2$s', 'event_espresso'), $extra_meta_row['EXM_value'], $this->_json_encode($extra_meta_row)));
+			return;
+		}
+		$new_values = array( 'PMD_ID' => $PMD_ID );
+		$wheres = array( 'TXN_ID' => $extra_meta_row['OBJ_ID'] );
+		$new_value_datatypes = array( '%d' );
+		$where_datatypes = array( '%d' );
+		$success = $wpdb->update(
+			$this->_transaction_table,
+			$new_values,
+			$wheres,
+			$new_value_datatypes,
+			$where_datatypes
+		);
+		if (! $success) {
+			$this->add_error(sprintf(__('Couldnt set %1$s row in table %2$s where %3$s', 'event_espresso'), $this->_json_encode($new_values), $this->_transaction_table, $this->_json_encode($wheres)));
+		}
+	}
+	/**
+	 *
+	 * @global type $wpdb
+	 * @param int $id
+	 * @return string
+	 */
+	protected function _get_payment_method_id_by_gateway_name($gateway_name)
+	{
+		global $wpdb;
+		return $wpdb->get_var($wpdb->prepare("SELECT PMD_ID FROM " . $wpdb->prefix . "esp_payment_method WHERE PMD_type = %s", $gateway_name));
+	}
 }

Spacing +10 added lines, -10 removed lines

@@ -16,9 +16,9 @@ 
     public function __construct()
     {
         global $wpdb;
-        $this->_old_table = $wpdb->prefix . 'esp_extra_meta';
-        $this->_transaction_table = $wpdb->prefix . 'esp_transaction';
-        $this->_payment_method_table = $wpdb->prefix . 'esp_payment_method';
+        $this->_old_table = $wpdb->prefix.'esp_extra_meta';
+        $this->_transaction_table = $wpdb->prefix.'esp_transaction';
+        $this->_payment_method_table = $wpdb->prefix.'esp_payment_method';
         $this->_pretty_name = __('Transaction Payment Method Relations', 'event_espresso');
         $this->_extra_where_sql = "WHERE EXM_key = 'gateway' AND EXM_type = 'Transaction'";
         parent::__construct();
@@ -28,14 +28,14 @@ 
         global $wpdb;
         // get the payment method's ID
         $PMD_ID = $this->_get_payment_method_id_by_gateway_name($extra_meta_row['EXM_value']);
-        if (! $PMD_ID) {
+        if ( ! $PMD_ID) {
             $this->add_error(sprintf(__('Could not find payment method with PMD_type = \'%1$s\' when migrating extra meta row %2$s', 'event_espresso'), $extra_meta_row['EXM_value'], $this->_json_encode($extra_meta_row)));
             return;
         }
-        $new_values = array( 'PMD_ID' => $PMD_ID );
-        $wheres = array( 'TXN_ID' => $extra_meta_row['OBJ_ID'] );
-        $new_value_datatypes = array( '%d' );
-        $where_datatypes = array( '%d' );
+        $new_values = array('PMD_ID' => $PMD_ID);
+        $wheres = array('TXN_ID' => $extra_meta_row['OBJ_ID']);
+        $new_value_datatypes = array('%d');
+        $where_datatypes = array('%d');
         $success = $wpdb->update(
             $this->_transaction_table,
             $new_values,
@@ -43,7 +43,7 @@ 
             $new_value_datatypes,
             $where_datatypes
         );
-        if (! $success) {
+        if ( ! $success) {
             $this->add_error(sprintf(__('Couldnt set %1$s row in table %2$s where %3$s', 'event_espresso'), $this->_json_encode($new_values), $this->_transaction_table, $this->_json_encode($wheres)));
         }
     }
@@ -56,6 +56,6 @@ 
     protected function _get_payment_method_id_by_gateway_name($gateway_name)
     {
         global $wpdb;
-        return $wpdb->get_var($wpdb->prepare("SELECT PMD_ID FROM " . $wpdb->prefix . "esp_payment_method WHERE PMD_type = %s", $gateway_name));
+        return $wpdb->get_var($wpdb->prepare("SELECT PMD_ID FROM ".$wpdb->prefix."esp_payment_method WHERE PMD_type = %s", $gateway_name));
     }
 }

core/data_migration_scripts/EE_Data_Migration_Class_Base.core.php

Doc Comments +1 added lines, -1 removed lines

@@ -325,7 +325,7 @@
      * @param array  $old_row_as_array
      * @param string $new_table
      * @param array  $new_row_as_array columns=>values like used in wpdb->insert
-     * @param array  $data_types       numerically indexed
+     * @param string[]  $data_types       numerically indexed
      * @return string
      */
     protected function _create_error_message_for_db_insertion(

Spacing +4 added lines, -4 removed lines

@@ -185,7 +185,7 @@ 
      */
     public function add_error($error, $force = false)
     {
-        if (! defined('EE_DMS_ERROR_LIMIT')) {
+        if ( ! defined('EE_DMS_ERROR_LIMIT')) {
             $limit = 50;
         } else {
             $limit = EE_DMS_ERROR_LIMIT;
@@ -201,7 +201,7 @@ 
                 $this->_errors[] = "Limit reached; removed first half of errors to save space";
                 $this->_errors[] = $error;
             } else {
-                $this->_errors[ $limit ] = 'More, but limit reached...';
+                $this->_errors[$limit] = 'More, but limit reached...';
             }
         } else {
             $this->_errors[] = $error;
@@ -343,7 +343,7 @@ 
         $new_columns_and_values_for_string = array();
         $count = 0;
         foreach ($new_row_as_array as $column => $value) {
-            $new_columns_and_values_for_string[] = " $column => $value (" . $data_types[ $count++ ] . ")";
+            $new_columns_and_values_for_string[] = " $column => $value (".$data_types[$count++].")";
         }
         return sprintf(
             __(
@@ -374,7 +374,7 @@ 
         foreach ($array_of_data as $name => $value) {
             $unserialized_data = @unserialize($value);
             if ($unserialized_data === false) {
-                $fields_to_include[ $name ] = $value;
+                $fields_to_include[$name] = $value;
             }
         }
         return wp_json_encode($fields_to_include);

Indentation +404 added lines, -404 removed lines

@@ -17,408 +17,408 @@
 abstract class EE_Data_Migration_Class_Base
 {
 
-    /**
-     * @var $records_to_migrate int count of all that have been migrated
-     */
-    protected $_records_to_migrate = 0;
-
-    /**
-     *
-     * @var $records_migrated int
-     */
-    protected $_records_migrated = 0;
-
-    /**
-     * Whether this migration script is done or not. This COULD be deduced by
-     * _records_to_migrate and _records_migrated, but that might nto be accurate
-     *
-     * @var string one of EE_Data_migration_Manager::status_* constants
-     */
-    protected $_status = null;
-
-    /**
-     * internationalized name of this class. Convention is to NOT restate that
-     * this class if a migration script or a migration script stage
-     *
-     * @var string (i18ned)
-     */
-    protected $_pretty_name = null;
-
-    /**
-     * @var array
-     */
-    protected $_errors = array();
-
-    /**
-     * @var \EventEspresso\core\services\database\TableManager $table_manager
-     */
-    protected $_table_manager;
-
-    /**
-     * @var \EventEspresso\core\services\database\TableAnalysis $table_analysis
-     */
-    protected $_table_analysis;
-
-
-    /**
-     * Just initializes the status of the migration
-     *
-     * @param TableManager  $table_manager
-     * @param TableAnalysis $table_analysis
-     */
-    public function __construct(TableManager $table_manager = null, TableAnalysis $table_analysis = null)
-    {
-        $this->_table_manager = $table_manager;
-        $this->_table_analysis = $table_analysis;
-        $this->set_status(EE_Data_Migration_Manager::status_continue);
-    }
-
-
-    /**
-     * Just gets the pretty name for this migration script or stage
-     *
-     * @throws EE_Error
-     * @return string
-     */
-    public function pretty_name()
-    {
-        if ($this->_pretty_name === null) {
-            throw new EE_Error(
-                sprintf(
-                    __(
-                        "Please give a pretty name to the migration script stage %s by assigning the property _pretty_name in the constructor",
-                        "event_espresso"
-                    ),
-                    get_class($this)
-                )
-            );
-        }
-        return $this->_pretty_name;
-    }
-
-    /**
-     *
-     * @return int
-     */
-    public function count_records_to_migrate()
-    {
-        if ($this->_records_to_migrate == null) {
-            $this->_records_to_migrate = $this->_count_records_to_migrate();
-        }
-        return $this->_records_to_migrate;
-    }
-
-    /**
-     * Counts records already migrated. This should only be implemented by EE_Data_Migration_Script_base and
-     * EE_Data_migration_Script_Stage
-     *
-     * @return int
-     */
-    abstract public function count_records_migrated();
-
-    /**
-     * Counts the records to migrate; the public version may cache it
-     *
-     * @return int
-     */
-    abstract protected function _count_records_to_migrate();
-
-    /**
-     * Returns a string indicating the migration script's status.
-     *
-     * @return string one of EE_Data_Migration_Manager::status_* constants
-     * @throws EE_Error
-     */
-    public function get_status()
-    {
-        if ($this->_status === null) {
-            throw new EE_Error(
-                sprintf(
-                    __(
-                        "Trying to get status of Migration class %s, but it has not been initialized yet. It should be set in the constructor.",
-                        "event_espresso"
-                    ),
-                    get_class($this)
-                )
-            );
-        }
-        return $this->_status;
-    }
-
-    /**
-     *
-     * @param string $status
-     * @return void
-     */
-    protected function set_status($status)
-    {
-        $this->_status = $status;
-    }
-
-    /**
-     * @return array of strings
-     */
-    abstract public function get_errors();
-
-    /**
-     * Returns the last error that occurred. If none occurred, returns null
-     *
-     * @return string
-     */
-    public function get_last_error()
-    {
-        $errors = $this->get_errors();
-        if ($errors) {
-            return end($errors);
-        } else {
-            return null;
-        }
-    }
-
-    /**
-     * Adds an error to the array of errors on this class.
-     *
-     * @param string  $error a string describing the error that will be useful for debugging. Consider including all
-     *                       the data that led to the error, and a stack trace etc.
-     * @param boolean $force force the error to be added (because otherwise we have a limit). If forcing and errors are
-     *                       already at their limit, we will purposefully forget the first half
-     */
-    public function add_error($error, $force = false)
-    {
-        if (! defined('EE_DMS_ERROR_LIMIT')) {
-            $limit = 50;
-        } else {
-            $limit = EE_DMS_ERROR_LIMIT;
-        }
-        // make sure errors is an array, see ticket #8261
-        if (is_string($this->_errors)) {
-            $this->_errors = array($this->_errors);
-        }
-        if (count($this->_errors) >= $limit) {
-            if ($force) {
-                // get rid of the first half of the errors and any above the limit
-                $this->_errors = array_slice($this->_errors, $limit / 2, $limit / 2);
-                $this->_errors[] = "Limit reached; removed first half of errors to save space";
-                $this->_errors[] = $error;
-            } else {
-                $this->_errors[ $limit ] = 'More, but limit reached...';
-            }
-        } else {
-            $this->_errors[] = $error;
-        }
-    }
-
-    /**
-     * Indicates there was a fatal error and the migration cannot possibly continue
-     *
-     * @return boolean
-     */
-    public function is_broken()
-    {
-        return $this->get_status() == EE_Data_Migration_Manager::status_fatal_error;
-    }
-
-    /**
-     * @deprecated since 4.6.12
-     */
-    public function is_borked()
-    {
-        EE_Error::doing_it_wrong(
-            'is_borked',
-            __(
-                'The cheeky "is_borked" method had been replaced with the more proper "is_broken"',
-                'event_espresso'
-            ),
-            '4.6.12'
-        );
-        return $this->is_broken();
-    }
-
-    /**
-     * Sets the status to as having a fatal error
-     */
-    public function set_broken()
-    {
-        $this->_status = EE_Data_Migration_Manager::status_fatal_error;
-    }
-
-    /**
-     *
-     * @deprecated since 4.6.12
-     */
-    public function set_borked()
-    {
-        EE_Error::doing_it_wrong(
-            'is_borked',
-            __(
-                'The cheeky "is_borked" method had been replaced with the more proper "is_broken"',
-                'event_espresso'
-            ),
-            '4.6.12'
-        );
-        return $this->set_broken();
-    }
-
-    /**
-     * Checks if this thing believes it is completed
-     *
-     * @return boolean
-     */
-    public function is_completed()
-    {
-        return $this->get_status() == EE_Data_Migration_Manager::status_completed;
-    }
-
-    /**
-     * Checks if the current script has more to do or not (ie, if it's status is CONTINUE)
-     *
-     * @return boolean
-     */
-    public function has_more_to_do()
-    {
-        return $this->get_status() == EE_Data_Migration_Manager::status_continue;
-    }
-
-    /**
-     * Marks that we believe this migration thing is completed
-     */
-    public function set_completed()
-    {
-        $this->_status = EE_Data_Migration_Manager::status_completed;
-    }
-
-    /**
-     * Marks that we think this migration class can continue to migrate
-     */
-    public function reattempt()
-    {
-        $this->_status = EE_Data_Migration_Manager::status_continue;
-        $this->add_error(__('Reattempt migration', 'event_espresso'), true);
-    }
-
-    /**
-     * A lot like "__sleep()" magic method in purpose, this is meant for persisting this class'
-     * properties to the DB. However, we don't want to use __sleep() because its quite
-     * possible that this class is defined when it goes to sleep, but NOT available when it
-     * awakes (eg, this class is part of an addon that is deactivated at some point).
-     */
-    public function properties_as_array()
-    {
-        $properties = get_object_vars($this);
-        $properties['class'] = get_class($this);
-        unset($properties['_migration_script']);
-        unset($properties['_table_manager']);
-        unset($properties['_table_analysis']);
-        return $properties;
-    }
-
-    /**
-     * Sets all of the properties of this script stage to match what's in the array, which is assumed
-     * to have been made from the properties_as_array() function.
-     *
-     * @param array $array_of_properties like what's produced from properties_as_array() method
-     */
-    abstract public function instantiate_from_array_of_properties($array_of_properties);
-
-    /**
-     * Convenience method for showing a database insertion error
-     *
-     * @param string $old_table
-     * @param array  $old_row_as_array
-     * @param string $new_table
-     * @param array  $new_row_as_array columns=>values like used in wpdb->insert
-     * @param array  $data_types       numerically indexed
-     * @return string
-     */
-    protected function _create_error_message_for_db_insertion(
-        $old_table,
-        $old_row_as_array,
-        $new_table,
-        $new_row_as_array,
-        $data_types
-    ) {
-        global $wpdb;
-        $old_columns_and_values_for_string = array();
-        foreach ($old_row_as_array as $column => $value) {
-            $old_columns_and_values_for_string[] = "$column => $value";
-        }
-        $new_columns_and_values_for_string = array();
-        $count = 0;
-        foreach ($new_row_as_array as $column => $value) {
-            $new_columns_and_values_for_string[] = " $column => $value (" . $data_types[ $count++ ] . ")";
-        }
-        return sprintf(
-            __(
-                'Received error "%6$s" inserting row %5$s %1$s %5$s into table %2$s.%5$s Data used was %5$s %3$s %5$s from table %4$s.',
-                'event_espresso'
-            ),
-            implode(", ", $new_columns_and_values_for_string),
-            $new_table,
-            implode(", ", $old_columns_and_values_for_string),
-            $old_table,
-            '<br/>',
-            $wpdb->last_error
-        );
-    }
-
-
-    /**
-     * Same as json_encode, just avoids putting
-     * serialized arrays into the http build query, as that would
-     *
-     * @param array $array_of_data
-     * @return string
-     */
-    protected function _json_encode($array_of_data)
-    {
-        // we'd rather NOT serialize the transaction details
-        $fields_to_include = array();
-        foreach ($array_of_data as $name => $value) {
-            $unserialized_data = @unserialize($value);
-            if ($unserialized_data === false) {
-                $fields_to_include[ $name ] = $value;
-            }
-        }
-        return wp_json_encode($fields_to_include);
-    }
-
-    /**
-     * Gets the table manager (or throws an exception if it cannot be retrieved)
-     *
-     * @return TableManager
-     * @throws EE_Error
-     */
-    protected function _get_table_manager()
-    {
-        if ($this->_table_manager instanceof TableManager) {
-            return $this->_table_manager;
-        } else {
-            throw new EE_Error(
-                sprintf(
-                    __('Table manager on migration class %1$s is not set properly.', 'event_espresso'),
-                    get_class($this)
-                )
-            );
-        }
-    }
-
-    /**
-     * Gets the injected table analyzer, or throws an exception
-     *
-     * @return TableAnalysis
-     * @throws EE_Error
-     */
-    protected function _get_table_analysis()
-    {
-        if ($this->_table_analysis instanceof TableAnalysis) {
-            return $this->_table_analysis;
-        } else {
-            throw new EE_Error(
-                sprintf(
-                    __('Table analysis class on migration class %1$s is not set properly.', 'event_espresso'),
-                    get_class($this)
-                )
-            );
-        }
-    }
+	/**
+	 * @var $records_to_migrate int count of all that have been migrated
+	 */
+	protected $_records_to_migrate = 0;
+
+	/**
+	 *
+	 * @var $records_migrated int
+	 */
+	protected $_records_migrated = 0;
+
+	/**
+	 * Whether this migration script is done or not. This COULD be deduced by
+	 * _records_to_migrate and _records_migrated, but that might nto be accurate
+	 *
+	 * @var string one of EE_Data_migration_Manager::status_* constants
+	 */
+	protected $_status = null;
+
+	/**
+	 * internationalized name of this class. Convention is to NOT restate that
+	 * this class if a migration script or a migration script stage
+	 *
+	 * @var string (i18ned)
+	 */
+	protected $_pretty_name = null;
+
+	/**
+	 * @var array
+	 */
+	protected $_errors = array();
+
+	/**
+	 * @var \EventEspresso\core\services\database\TableManager $table_manager
+	 */
+	protected $_table_manager;
+
+	/**
+	 * @var \EventEspresso\core\services\database\TableAnalysis $table_analysis
+	 */
+	protected $_table_analysis;
+
+
+	/**
+	 * Just initializes the status of the migration
+	 *
+	 * @param TableManager  $table_manager
+	 * @param TableAnalysis $table_analysis
+	 */
+	public function __construct(TableManager $table_manager = null, TableAnalysis $table_analysis = null)
+	{
+		$this->_table_manager = $table_manager;
+		$this->_table_analysis = $table_analysis;
+		$this->set_status(EE_Data_Migration_Manager::status_continue);
+	}
+
+
+	/**
+	 * Just gets the pretty name for this migration script or stage
+	 *
+	 * @throws EE_Error
+	 * @return string
+	 */
+	public function pretty_name()
+	{
+		if ($this->_pretty_name === null) {
+			throw new EE_Error(
+				sprintf(
+					__(
+						"Please give a pretty name to the migration script stage %s by assigning the property _pretty_name in the constructor",
+						"event_espresso"
+					),
+					get_class($this)
+				)
+			);
+		}
+		return $this->_pretty_name;
+	}
+
+	/**
+	 *
+	 * @return int
+	 */
+	public function count_records_to_migrate()
+	{
+		if ($this->_records_to_migrate == null) {
+			$this->_records_to_migrate = $this->_count_records_to_migrate();
+		}
+		return $this->_records_to_migrate;
+	}
+
+	/**
+	 * Counts records already migrated. This should only be implemented by EE_Data_Migration_Script_base and
+	 * EE_Data_migration_Script_Stage
+	 *
+	 * @return int
+	 */
+	abstract public function count_records_migrated();
+
+	/**
+	 * Counts the records to migrate; the public version may cache it
+	 *
+	 * @return int
+	 */
+	abstract protected function _count_records_to_migrate();
+
+	/**
+	 * Returns a string indicating the migration script's status.
+	 *
+	 * @return string one of EE_Data_Migration_Manager::status_* constants
+	 * @throws EE_Error
+	 */
+	public function get_status()
+	{
+		if ($this->_status === null) {
+			throw new EE_Error(
+				sprintf(
+					__(
+						"Trying to get status of Migration class %s, but it has not been initialized yet. It should be set in the constructor.",
+						"event_espresso"
+					),
+					get_class($this)
+				)
+			);
+		}
+		return $this->_status;
+	}
+
+	/**
+	 *
+	 * @param string $status
+	 * @return void
+	 */
+	protected function set_status($status)
+	{
+		$this->_status = $status;
+	}
+
+	/**
+	 * @return array of strings
+	 */
+	abstract public function get_errors();
+
+	/**
+	 * Returns the last error that occurred. If none occurred, returns null
+	 *
+	 * @return string
+	 */
+	public function get_last_error()
+	{
+		$errors = $this->get_errors();
+		if ($errors) {
+			return end($errors);
+		} else {
+			return null;
+		}
+	}
+
+	/**
+	 * Adds an error to the array of errors on this class.
+	 *
+	 * @param string  $error a string describing the error that will be useful for debugging. Consider including all
+	 *                       the data that led to the error, and a stack trace etc.
+	 * @param boolean $force force the error to be added (because otherwise we have a limit). If forcing and errors are
+	 *                       already at their limit, we will purposefully forget the first half
+	 */
+	public function add_error($error, $force = false)
+	{
+		if (! defined('EE_DMS_ERROR_LIMIT')) {
+			$limit = 50;
+		} else {
+			$limit = EE_DMS_ERROR_LIMIT;
+		}
+		// make sure errors is an array, see ticket #8261
+		if (is_string($this->_errors)) {
+			$this->_errors = array($this->_errors);
+		}
+		if (count($this->_errors) >= $limit) {
+			if ($force) {
+				// get rid of the first half of the errors and any above the limit
+				$this->_errors = array_slice($this->_errors, $limit / 2, $limit / 2);
+				$this->_errors[] = "Limit reached; removed first half of errors to save space";
+				$this->_errors[] = $error;
+			} else {
+				$this->_errors[ $limit ] = 'More, but limit reached...';
+			}
+		} else {
+			$this->_errors[] = $error;
+		}
+	}
+
+	/**
+	 * Indicates there was a fatal error and the migration cannot possibly continue
+	 *
+	 * @return boolean
+	 */
+	public function is_broken()
+	{
+		return $this->get_status() == EE_Data_Migration_Manager::status_fatal_error;
+	}
+
+	/**
+	 * @deprecated since 4.6.12
+	 */
+	public function is_borked()
+	{
+		EE_Error::doing_it_wrong(
+			'is_borked',
+			__(
+				'The cheeky "is_borked" method had been replaced with the more proper "is_broken"',
+				'event_espresso'
+			),
+			'4.6.12'
+		);
+		return $this->is_broken();
+	}
+
+	/**
+	 * Sets the status to as having a fatal error
+	 */
+	public function set_broken()
+	{
+		$this->_status = EE_Data_Migration_Manager::status_fatal_error;
+	}
+
+	/**
+	 *
+	 * @deprecated since 4.6.12
+	 */
+	public function set_borked()
+	{
+		EE_Error::doing_it_wrong(
+			'is_borked',
+			__(
+				'The cheeky "is_borked" method had been replaced with the more proper "is_broken"',
+				'event_espresso'
+			),
+			'4.6.12'
+		);
+		return $this->set_broken();
+	}
+
+	/**
+	 * Checks if this thing believes it is completed
+	 *
+	 * @return boolean
+	 */
+	public function is_completed()
+	{
+		return $this->get_status() == EE_Data_Migration_Manager::status_completed;
+	}
+
+	/**
+	 * Checks if the current script has more to do or not (ie, if it's status is CONTINUE)
+	 *
+	 * @return boolean
+	 */
+	public function has_more_to_do()
+	{
+		return $this->get_status() == EE_Data_Migration_Manager::status_continue;
+	}
+
+	/**
+	 * Marks that we believe this migration thing is completed
+	 */
+	public function set_completed()
+	{
+		$this->_status = EE_Data_Migration_Manager::status_completed;
+	}
+
+	/**
+	 * Marks that we think this migration class can continue to migrate
+	 */
+	public function reattempt()
+	{
+		$this->_status = EE_Data_Migration_Manager::status_continue;
+		$this->add_error(__('Reattempt migration', 'event_espresso'), true);
+	}
+
+	/**
+	 * A lot like "__sleep()" magic method in purpose, this is meant for persisting this class'
+	 * properties to the DB. However, we don't want to use __sleep() because its quite
+	 * possible that this class is defined when it goes to sleep, but NOT available when it
+	 * awakes (eg, this class is part of an addon that is deactivated at some point).
+	 */
+	public function properties_as_array()
+	{
+		$properties = get_object_vars($this);
+		$properties['class'] = get_class($this);
+		unset($properties['_migration_script']);
+		unset($properties['_table_manager']);
+		unset($properties['_table_analysis']);
+		return $properties;
+	}
+
+	/**
+	 * Sets all of the properties of this script stage to match what's in the array, which is assumed
+	 * to have been made from the properties_as_array() function.
+	 *
+	 * @param array $array_of_properties like what's produced from properties_as_array() method
+	 */
+	abstract public function instantiate_from_array_of_properties($array_of_properties);
+
+	/**
+	 * Convenience method for showing a database insertion error
+	 *
+	 * @param string $old_table
+	 * @param array  $old_row_as_array
+	 * @param string $new_table
+	 * @param array  $new_row_as_array columns=>values like used in wpdb->insert
+	 * @param array  $data_types       numerically indexed
+	 * @return string
+	 */
+	protected function _create_error_message_for_db_insertion(
+		$old_table,
+		$old_row_as_array,
+		$new_table,
+		$new_row_as_array,
+		$data_types
+	) {
+		global $wpdb;
+		$old_columns_and_values_for_string = array();
+		foreach ($old_row_as_array as $column => $value) {
+			$old_columns_and_values_for_string[] = "$column => $value";
+		}
+		$new_columns_and_values_for_string = array();
+		$count = 0;
+		foreach ($new_row_as_array as $column => $value) {
+			$new_columns_and_values_for_string[] = " $column => $value (" . $data_types[ $count++ ] . ")";
+		}
+		return sprintf(
+			__(
+				'Received error "%6$s" inserting row %5$s %1$s %5$s into table %2$s.%5$s Data used was %5$s %3$s %5$s from table %4$s.',
+				'event_espresso'
+			),
+			implode(", ", $new_columns_and_values_for_string),
+			$new_table,
+			implode(", ", $old_columns_and_values_for_string),
+			$old_table,
+			'<br/>',
+			$wpdb->last_error
+		);
+	}
+
+
+	/**
+	 * Same as json_encode, just avoids putting
+	 * serialized arrays into the http build query, as that would
+	 *
+	 * @param array $array_of_data
+	 * @return string
+	 */
+	protected function _json_encode($array_of_data)
+	{
+		// we'd rather NOT serialize the transaction details
+		$fields_to_include = array();
+		foreach ($array_of_data as $name => $value) {
+			$unserialized_data = @unserialize($value);
+			if ($unserialized_data === false) {
+				$fields_to_include[ $name ] = $value;
+			}
+		}
+		return wp_json_encode($fields_to_include);
+	}
+
+	/**
+	 * Gets the table manager (or throws an exception if it cannot be retrieved)
+	 *
+	 * @return TableManager
+	 * @throws EE_Error
+	 */
+	protected function _get_table_manager()
+	{
+		if ($this->_table_manager instanceof TableManager) {
+			return $this->_table_manager;
+		} else {
+			throw new EE_Error(
+				sprintf(
+					__('Table manager on migration class %1$s is not set properly.', 'event_espresso'),
+					get_class($this)
+				)
+			);
+		}
+	}
+
+	/**
+	 * Gets the injected table analyzer, or throws an exception
+	 *
+	 * @return TableAnalysis
+	 * @throws EE_Error
+	 */
+	protected function _get_table_analysis()
+	{
+		if ($this->_table_analysis instanceof TableAnalysis) {
+			return $this->_table_analysis;
+		} else {
+			throw new EE_Error(
+				sprintf(
+					__('Table analysis class on migration class %1$s is not set properly.', 'event_espresso'),
+					get_class($this)
+				)
+			);
+		}
+	}
 }

core/db_models/EEM_Message_Template_Group.model.php

Doc Comments +2 added lines, -2 removed lines

@@ -84,7 +84,7 @@ 
      * @param        $messenger
      * @param string $orderby
      * @param string $order
-     * @return array all (including trashed or inactive) message template group objects for the given messenger
+     * @return EE_Base_Class[] all (including trashed or inactive) message template group objects for the given messenger
      */
     public function get_all_message_templates_by_messenger($messenger, $orderby = 'GRP_ID', $order = 'ASC')
     {
@@ -341,7 +341,7 @@ 
     /**
      * This sends things to the validator for the given messenger and message type.
      *
-     * @param  array $fields the incoming fields to check.
+     * @param  string $fields the incoming fields to check.
      *                       Note this array is in the formatted fields from the form fields setup.
      *                       So we need to reformat this into an array of expected field refs by the validator.
      *                       Note also that this is not only the fields for the Message Template Group

Spacing +23 added lines, -23 removed lines

@@ -44,7 +44,7 @@ 
             'WP_User' => new EE_Belongs_To_Relation()
         );
         foreach ($this->_cap_contexts_to_cap_action_map as $context => $action) {
-            $this->_cap_restriction_generators[ $context ] = new EE_Restriction_Generator_Global('MTP_is_global');
+            $this->_cap_restriction_generators[$context] = new EE_Restriction_Generator_Global('MTP_is_global');
         }
         $this->_caps_slug = 'messages';
 
@@ -71,7 +71,7 @@ 
         $limit = null,
         $count = false
     ) {
-        $query_params = array( array('Event.EVT_ID' => $EVT_ID), 'order_by' => array($orderby => $order), 'limit' => $limit );
+        $query_params = array(array('Event.EVT_ID' => $EVT_ID), 'order_by' => array($orderby => $order), 'limit' => $limit);
         return $count ? $this->count_deleted($query_params, 'GRP_ID', true) : $this->get_all_deleted($query_params);
     }
 
@@ -89,7 +89,7 @@ 
     public function get_all_message_templates_by_messenger($messenger, $orderby = 'GRP_ID', $order = 'ASC')
     {
         return $this->get_all_deleted_and_undeleted(
-            array( array( 'MTP_messenger' => $messenger ), 'order_by' => array( $orderby => $order ) )
+            array(array('MTP_messenger' => $messenger), 'order_by' => array($orderby => $order))
         );
     }
 
@@ -107,7 +107,7 @@ 
             && $_REQUEST['ee_messenger_filter_by'] != 'none_selected'
             && $_REQUEST['ee_messenger_filter_by'] != 'all'
         ) {
-            $_where['MTP_messenger'] =  $_REQUEST['ee_messenger_filter_by'] ;
+            $_where['MTP_messenger'] = $_REQUEST['ee_messenger_filter_by'];
         }
 
         if (isset($_REQUEST['ee_message_type_filter_by'])
@@ -141,7 +141,7 @@ 
         $global = true,
         $user_check = false
     ) {
-        $_where = $global ? array('MTP_is_global' => true ) : array('MTP_is_global' => false );
+        $_where = $global ? array('MTP_is_global' => true) : array('MTP_is_global' => false);
         $_where['MTP_is_active'] = true;
         $_where = $this->_maybe_mtp_filters($_where);
 
@@ -155,7 +155,7 @@ 
             $_where['MTP_user_id'] = get_current_user_id();
         }
 
-        $query_params = array( $_where, 'order_by' => array($orderby => $order), 'limit' => $limit );
+        $query_params = array($_where, 'order_by' => array($orderby => $order), 'limit' => $limit);
 
         return $count ? $this->count($query_params, 'GRP_ID', true) : $this->get_all($query_params);
     }
@@ -176,7 +176,7 @@ 
     {
         $_where = $this->_maybe_mtp_filters();
 
-        $query_params = array( $_where, 'order_by' => array($orderby => $order), 'limit' => $limit );
+        $query_params = array($_where, 'order_by' => array($orderby => $order), 'limit' => $limit);
 
         $r_templates = $count
             ? $this->count_deleted_and_undeleted($query_params, 'GRP_ID', true)
@@ -196,9 +196,9 @@ 
      */
     public function get_all_custom_templates_by_event($EVT_ID, $query_params = array())
     {
-        $where = array_merge($query_params, array( 'Event.EVT_ID' => $EVT_ID ));
+        $where = array_merge($query_params, array('Event.EVT_ID' => $EVT_ID));
         return $this->get_all(
-            array( $where )
+            array($where)
         );
     }
 
@@ -223,11 +223,11 @@ 
         $count = false,
         $global = true
     ) {
-        $_where = $global ? array('MTP_is_global' => true ) : array('MTP_is_global' => false );
+        $_where = $global ? array('MTP_is_global' => true) : array('MTP_is_global' => false);
         $_where['MTP_is_active'] = true;
         $_where = $this->_maybe_mtp_filters($_where);
 
-        $query_params = array( $_where, 'order_by' => array($orderby => $order), 'limit' => $limit );
+        $query_params = array($_where, 'order_by' => array($orderby => $order), 'limit' => $limit);
 
         return $count ? $this->count_deleted($query_params, 'GRP_ID', true) : $this->get_all_deleted($query_params);
     }
@@ -265,7 +265,7 @@ 
             'MTP_is_active' => $active
         );
 
-        $query_params = array( $_where, 'order_by' => array($orderby=>$order), 'limit' => $limit );
+        $query_params = array($_where, 'order_by' => array($orderby=>$order), 'limit' => $limit);
 
         return $count ? $this->count($query_params, 'GRP_ID', true) : $this->get_all($query_params);
     }
@@ -305,7 +305,7 @@ 
             $_where['MTP_is_active'] = $active;
         }
 
-        $query_params = array( $_where, 'order_by' => array( $orderby => $order ), 'limit' => $limit );
+        $query_params = array($_where, 'order_by' => array($orderby => $order), 'limit' => $limit);
 
         return $count ? $this->count($query_params, 'GRP_ID', true) : $this->get_all($query_params);
     }
@@ -363,19 +363,19 @@ 
             // first let's figure out if the value['content'] in the current index is an array.
             //  If it is then this is special fields that are used in parsing special shortcodes (i.e. 'attendee_list').
             if (is_array($value['content'])) {
-                $assembled_fields[ $value['name'] ] = $value['content']['main'];
+                $assembled_fields[$value['name']] = $value['content']['main'];
                 // loop through the content and get the other fields.
                 foreach ($value['content'] as $name => $val) {
                     if ($name == 'main') {
                         continue;
                     }
-                    $assembled_fields[ $name ] = $val;
+                    $assembled_fields[$name] = $val;
                 }
                 continue;
             }
 
             // okay if we're here then this is just a straight field=>$value arrangement
-            $assembled_fields[ $value['name'] ] = $value['content'];
+            $assembled_fields[$value['name']] = $value['content'];
         }
 
         // now we've got the assembled_fields.
@@ -385,9 +385,9 @@ 
         $mt_ref = ucwords(str_replace('_', ' ', $message_type));
         $mt_ref = str_replace(' ', '_', $mt_ref);
 
-        $classname = 'EE_Messages_' . $m_ref . '_' . $mt_ref . '_Validator';
+        $classname = 'EE_Messages_'.$m_ref.'_'.$mt_ref.'_Validator';
 
-        if (!class_exists($classname)) {
+        if ( ! class_exists($classname)) {
             $msg[] = __('The Validator class was unable to load', 'event_espresso');
             $msg[] = sprintf(
                 __(
@@ -425,12 +425,12 @@ 
         if (empty($messenger_names) && empty($message_type_names)) {
             return 0;
         }
-        if (! empty($messenger_names)) {
-            $query_args[0]['MTP_messenger'] = array( 'IN', (array) $messenger_names );
+        if ( ! empty($messenger_names)) {
+            $query_args[0]['MTP_messenger'] = array('IN', (array) $messenger_names);
         }
-        if (! empty($message_type_names)) {
-            $query_args[0]['MTP_message_type'] = array( 'IN', (array) $message_type_names );
+        if ( ! empty($message_type_names)) {
+            $query_args[0]['MTP_message_type'] = array('IN', (array) $message_type_names);
         }
-        return $this->update(array( 'MTP_is_active' => false ), $query_args);
+        return $this->update(array('MTP_is_active' => false), $query_args);
     }
 }

Indentation +422 added lines, -422 removed lines

@@ -11,426 +11,426 @@
 class EEM_Message_Template_Group extends EEM_Soft_Delete_Base
 {
 
-    // private instance of the EEM_Message_Template_Group object
-    protected static $_instance = null;
-
-
-
-    protected function __construct($timezone = null)
-    {
-        $this->singular_item = __('Message Template Group', 'event_espresso');
-        $this->plural_item = __('Message Template Groups', 'event_espresso');
-        $this->_tables = array(
-            'Message_Template_Group' => new EE_Primary_Table('esp_message_template_group', 'GRP_ID')
-        );
-        $this->_fields = array(
-            'Message_Template_Group' => array(
-                'GRP_ID' => new EE_Primary_Key_Int_Field('GRP_ID', __('Message Template Group ID', 'event_espresso')),
-                'MTP_name' => new EE_Plain_Text_Field('MTP_name', __('The name of the template group', 'event_espresso'), false, ''),
-                'MTP_description' => new EE_Simple_HTML_Field('MTP_description', __('A brief description about this template.', 'event_espresso'), false, ''),
-                'MTP_user_id'=> new EE_WP_User_Field('MTP_user_id', __('Template Creator ID', 'event_espresso'), false, get_current_user_id()),
-                'MTP_messenger'=>new EE_Plain_Text_Field('MTP_messenger', __('Messenger Used for Template', 'event_espresso'), false, 'email'),
-                'MTP_message_type'=>new EE_Plain_Text_Field('MTP_message_type', __('Message Type', 'event_espresso'), false, 'registration'),
-                'MTP_is_global'=>new EE_Boolean_Field('MTP_is_global', __('Flag indicating if Template Group is Global', 'event_espresso'), false, true),
-                'MTP_is_override'=>new EE_Boolean_Field('MTP_is_override', __('Flag indicating if Template Group overrides any other Templates for the messenger/messagetype combination', 'event_espresso'), false, false),
-                'MTP_deleted'=>new EE_Trashed_Flag_Field('MTP_deleted', __('Flag indicating whether this has been trashed', 'event_espresso'), false, false),
-                'MTP_is_active'=>new EE_Boolean_Field('MTP_is_active', __('Flag indicating whether template group is active', 'event_espresso'), false, true)
-            )
-        );
-        $this->_model_relations = array(
-            'Message_Template' => new EE_Has_Many_Relation(),
-            'Message' => new EE_Has_Many_Relation(),
-            'Event' => new EE_HABTM_Relation('Event_Message_Template'),
-            'WP_User' => new EE_Belongs_To_Relation()
-        );
-        foreach ($this->_cap_contexts_to_cap_action_map as $context => $action) {
-            $this->_cap_restriction_generators[ $context ] = new EE_Restriction_Generator_Global('MTP_is_global');
-        }
-        $this->_caps_slug = 'messages';
-
-        parent::__construct($timezone);
-    }
-
-
-
-    /**
-     * get_all_trashed_message_templates_by_event
-     *
-     * @access public
-     * @param int    $EVT_ID specific event id
-     * @param string $orderby
-     * @param string $order
-     * @param null   $limit
-     * @param bool   $count
-     * @return array message template objects that are attached to a specific event.
-     */
-    public function get_all_trashed_message_templates_by_event(
-        $EVT_ID,
-        $orderby = 'GRP_ID',
-        $order = 'ASC',
-        $limit = null,
-        $count = false
-    ) {
-        $query_params = array( array('Event.EVT_ID' => $EVT_ID), 'order_by' => array($orderby => $order), 'limit' => $limit );
-        return $count ? $this->count_deleted($query_params, 'GRP_ID', true) : $this->get_all_deleted($query_params);
-    }
-
-
-
-    /**
-     * get_all_message_templates_by_messenger
-     *
-     * @access public
-     * @param        $messenger
-     * @param string $orderby
-     * @param string $order
-     * @return array all (including trashed or inactive) message template group objects for the given messenger
-     */
-    public function get_all_message_templates_by_messenger($messenger, $orderby = 'GRP_ID', $order = 'ASC')
-    {
-        return $this->get_all_deleted_and_undeleted(
-            array( array( 'MTP_messenger' => $messenger ), 'order_by' => array( $orderby => $order ) )
-        );
-    }
-
-
-
-    /**
-     * This simply adds on any messenger/message type filters that may be present in the $_POST global
-     * @param  array  $_where any existing where conditions to append these to.
-     * @return array          original where conditions or original with additional filters.
-     */
-    protected function _maybe_mtp_filters($_where = array())
-    {
-        // account for messenger or message type filters
-        if (isset($_REQUEST['ee_messenger_filter_by'])
-            && $_REQUEST['ee_messenger_filter_by'] != 'none_selected'
-            && $_REQUEST['ee_messenger_filter_by'] != 'all'
-        ) {
-            $_where['MTP_messenger'] =  $_REQUEST['ee_messenger_filter_by'] ;
-        }
-
-        if (isset($_REQUEST['ee_message_type_filter_by'])
-            && $_REQUEST['ee_message_type_filter_by'] != 'none_selected'
-        ) {
-            $_where['MTP_message_type'] = $_REQUEST['ee_message_type_filter_by'];
-        }
-
-        return $_where;
-    }
-
-
-
-    /**
-     * get_all_active_message_templates groups
-     *
-     * @access public
-     * @param string $orderby
-     * @param string $order
-     * @param null   $limit
-     * @param bool   $count
-     * @param bool   $global
-     * @param bool   $user_check
-     * @return array all active (non_trashed, active) message template objects
-     */
-    public function get_all_active_message_templates(
-        $orderby = 'GRP_ID',
-        $order = 'ASC',
-        $limit = null,
-        $count = false,
-        $global = true,
-        $user_check = false
-    ) {
-        $_where = $global ? array('MTP_is_global' => true ) : array('MTP_is_global' => false );
-        $_where['MTP_is_active'] = true;
-        $_where = $this->_maybe_mtp_filters($_where);
-
-        if ($user_check
-            && ! $global
-            && ! EE_Registry::instance()->CAP->current_user_can(
-                'ee_read_others_messages',
-                'get_all_active_message_templates'
-            )
-        ) {
-            $_where['MTP_user_id'] = get_current_user_id();
-        }
-
-        $query_params = array( $_where, 'order_by' => array($orderby => $order), 'limit' => $limit );
-
-        return $count ? $this->count($query_params, 'GRP_ID', true) : $this->get_all($query_params);
-    }
-
-
-
-    /**
-     *    retrieve ALL message_template groups from db regardless of wht
-     *
-     * @access    public
-     * @param string $orderby
-     * @param string $order
-     * @param null   $limit
-     * @param bool   $count
-     * @return mixed array on success, FALSE on fail
-     */
-    public function get_all_message_templates($orderby = 'GRP_ID', $order = 'ASC', $limit = null, $count = false)
-    {
-        $_where = $this->_maybe_mtp_filters();
-
-        $query_params = array( $_where, 'order_by' => array($orderby => $order), 'limit' => $limit );
-
-        $r_templates = $count
-            ? $this->count_deleted_and_undeleted($query_params, 'GRP_ID', true)
-            : $this->get_all_deleted_and_undeleted($query_params);
-
-        return $r_templates;
-    }
-
-
-
-
-    /**
-     * This gets all the custom templates attached to a specific event
-     * @param  int      $EVT_ID         event id
-     * @param  array  $query_params @see https://github.com/eventespresso/event-espresso-core/tree/master/docs/G--Model-System/model-query-params.md
-     * @return  EE_Message_Template_Group[]
-     */
-    public function get_all_custom_templates_by_event($EVT_ID, $query_params = array())
-    {
-        $where = array_merge($query_params, array( 'Event.EVT_ID' => $EVT_ID ));
-        return $this->get_all(
-            array( $where )
-        );
-    }
-
-
-
-    /**
-     * get_all_trashed_grouped_message_templates
-     * this returns ONLY the template groups where ALL contexts are trashed and none of the group are non-trashed
-     *
-     * @access public
-     * @param string $orderby
-     * @param string $order
-     * @param null   $limit
-     * @param bool   $count
-     * @param bool   $global
-     * @return \EE_Message_Template_Group[] message template groups.
-     */
-    public function get_all_trashed_grouped_message_templates(
-        $orderby = 'GRP_ID',
-        $order = 'ASC',
-        $limit = null,
-        $count = false,
-        $global = true
-    ) {
-        $_where = $global ? array('MTP_is_global' => true ) : array('MTP_is_global' => false );
-        $_where['MTP_is_active'] = true;
-        $_where = $this->_maybe_mtp_filters($_where);
-
-        $query_params = array( $_where, 'order_by' => array($orderby => $order), 'limit' => $limit );
-
-        return $count ? $this->count_deleted($query_params, 'GRP_ID', true) : $this->get_all_deleted($query_params);
-    }
-
-
-
-    /**
-     * this returns the message template group(s) for a given event, messenger, and message template
-     *
-     * @param  string             $messenger
-     * @param  string             $message_type
-     * @param                     $evt_id
-     * @param  string             $orderby pointless at this point but still included
-     * @param  string             $order
-     * @param  mixed (array|null) $limit   array($offset, $num)
-     * @param  bool               $count   true = just return count, false = objects
-     * @param  bool               $active  ignore "active" or not. (default only return active)
-     * @return \mixed[]) depending on $count.
-     */
-    public function get_event_message_templates_by_m_and_mt_and_evt(
-        $messenger,
-        $message_type,
-        $evt_id,
-        $orderby = 'GRP_ID',
-        $order = 'ASC',
-        $limit = null,
-        $count = false,
-        $active = true
-    ) {
-        $_where = array(
-            'MTP_messenger' => $messenger,
-            'MTP_message_type' => $message_type,
-            'Event.EVT_ID' => $evt_id,
-            'MTP_is_global' => true,
-            'MTP_is_active' => $active
-        );
-
-        $query_params = array( $_where, 'order_by' => array($orderby=>$order), 'limit' => $limit );
-
-        return $count ? $this->count($query_params, 'GRP_ID', true) : $this->get_all($query_params);
-    }
-
-
-
-
-    /**
-     * get all GLOBAL message template groups for the given messenger and message type
-     *
-     * @param  string $messenger    slug for messenger
-     * @param  string $message_type slug for message type
-     * @param  string $orderby      what column to orderby
-     * @param  string $order        ASC or DESC
-     * @param  mixed (array|null) $limit array($offset, $num)
-     * @param  bool   $count        true = just return count, false = objects
-     * @param  bool   $active       ignore "active" or not. (default only return active) -
-     *                              'all' means return both inactive AND inactive.
-     * @return array               message template objects that are global (i.e. non-event)
-     */
-    public function get_global_message_template_by_m_and_mt(
-        $messenger,
-        $message_type,
-        $orderby = 'GRP_ID',
-        $order = 'ASC',
-        $limit = null,
-        $count = false,
-        $active = true
-    ) {
-        $_where = array(
-            'MTP_messenger' => $messenger,
-            'MTP_message_type' => $message_type,
-            'MTP_is_global' => true,
-        );
-
-        if ($active != 'all') {
-            $_where['MTP_is_active'] = $active;
-        }
-
-        $query_params = array( $_where, 'order_by' => array( $orderby => $order ), 'limit' => $limit );
-
-        return $count ? $this->count($query_params, 'GRP_ID', true) : $this->get_all($query_params);
-    }
-
-
-
-
-    /**
-     * get all custom message template groups for the given messenger and message type
-     * @param  string $messenger    messenger
-     * @param  string $message_type messagetype
-     * @param  array  $query_params same as EEM_Base->get_all()
-     * @return EE_Message_Template_Group[]
-     */
-    public function get_custom_message_template_by_m_and_mt($messenger, $message_type, $query_params = array())
-    {
-        return $this->get_all(
-            array_merge(
-                $query_params,
-                array(
-                    array(
-                        'MTP_is_global'    => false,
-                        'MTP_messenger'    => $messenger,
-                        'MTP_message_type' => $message_type
-                    )
-                )
-            )
-        );
-    }
-
-
-
-    /**
-     * This sends things to the validator for the given messenger and message type.
-     *
-     * @param  array $fields the incoming fields to check.
-     *                       Note this array is in the formatted fields from the form fields setup.
-     *                       So we need to reformat this into an array of expected field refs by the validator.
-     *                       Note also that this is not only the fields for the Message Template Group
-     *                       but ALSO for Message Template.
-     * @param string $context      The context the fields were obtained from.
-     * @param string $messenger    The messenger we are validating
-     * @param string $message_type The message type we are validating.
-     * @return mixed If the fields all check out then we return true otherwise error messages are returned
-     *                       (indexed by field name);
-     * @throws \EE_Error
-     */
-    public function validate($fields, $context, $messenger, $message_type)
-    {
-
-        $assembled_fields = array();
-
-        // let's loop through all the fields and set them up in the right format
-        foreach ($fields as $index => $value) {
-            // first let's figure out if the value['content'] in the current index is an array.
-            //  If it is then this is special fields that are used in parsing special shortcodes (i.e. 'attendee_list').
-            if (is_array($value['content'])) {
-                $assembled_fields[ $value['name'] ] = $value['content']['main'];
-                // loop through the content and get the other fields.
-                foreach ($value['content'] as $name => $val) {
-                    if ($name == 'main') {
-                        continue;
-                    }
-                    $assembled_fields[ $name ] = $val;
-                }
-                continue;
-            }
-
-            // okay if we're here then this is just a straight field=>$value arrangement
-            $assembled_fields[ $value['name'] ] = $value['content'];
-        }
-
-        // now we've got the assembled_fields.
-        // We need to setup the string for the appropriate validator class and call that.
-        $m_ref = ucwords(str_replace('_', ' ', $messenger));
-        $m_ref = str_replace(' ', '_', $m_ref);
-        $mt_ref = ucwords(str_replace('_', ' ', $message_type));
-        $mt_ref = str_replace(' ', '_', $mt_ref);
-
-        $classname = 'EE_Messages_' . $m_ref . '_' . $mt_ref . '_Validator';
-
-        if (!class_exists($classname)) {
-            $msg[] = __('The Validator class was unable to load', 'event_espresso');
-            $msg[] = sprintf(
-                __(
-                    'The class name compiled was %s. Please check and make sure the spelling and case is correct for the class name and that there is an autoloader in place for this class',
-                    'event_espresso'
-                ),
-                $classname
-            );
-            throw new EE_Error(implode('||', $msg));
-        }
-
-        $a = new ReflectionClass($classname);
-        $_VLD = $a->newInstance($assembled_fields, $context);
-        $result = $_VLD->validate();
-        return $result;
-    }
-
-
-
-    /**
-     * Updates all message template groups matching the incoming arguments to inactive status.
-     *
-     * @param array $messenger_names    The messenger slugs.
-     *                              If empty then all templates matching the message types are marked inactive.
-     *                              Otherwise only templates matching the messengers and message types.
-     * @param array $message_type_names     The message type slugs.
-     *                              If empty then all templates matching the messengers are marked inactive.
-     *                              Otherwise only templates matching the messengers and message types.
-     *
-     * @return int  count of updated records.
-     */
-    public function deactivate_message_template_groups_for($messenger_names = array(), $message_type_names = array())
-    {
-        $query_args = array();
-        if (empty($messenger_names) && empty($message_type_names)) {
-            return 0;
-        }
-        if (! empty($messenger_names)) {
-            $query_args[0]['MTP_messenger'] = array( 'IN', (array) $messenger_names );
-        }
-        if (! empty($message_type_names)) {
-            $query_args[0]['MTP_message_type'] = array( 'IN', (array) $message_type_names );
-        }
-        return $this->update(array( 'MTP_is_active' => false ), $query_args);
-    }
+	// private instance of the EEM_Message_Template_Group object
+	protected static $_instance = null;
+
+
+
+	protected function __construct($timezone = null)
+	{
+		$this->singular_item = __('Message Template Group', 'event_espresso');
+		$this->plural_item = __('Message Template Groups', 'event_espresso');
+		$this->_tables = array(
+			'Message_Template_Group' => new EE_Primary_Table('esp_message_template_group', 'GRP_ID')
+		);
+		$this->_fields = array(
+			'Message_Template_Group' => array(
+				'GRP_ID' => new EE_Primary_Key_Int_Field('GRP_ID', __('Message Template Group ID', 'event_espresso')),
+				'MTP_name' => new EE_Plain_Text_Field('MTP_name', __('The name of the template group', 'event_espresso'), false, ''),
+				'MTP_description' => new EE_Simple_HTML_Field('MTP_description', __('A brief description about this template.', 'event_espresso'), false, ''),
+				'MTP_user_id'=> new EE_WP_User_Field('MTP_user_id', __('Template Creator ID', 'event_espresso'), false, get_current_user_id()),
+				'MTP_messenger'=>new EE_Plain_Text_Field('MTP_messenger', __('Messenger Used for Template', 'event_espresso'), false, 'email'),
+				'MTP_message_type'=>new EE_Plain_Text_Field('MTP_message_type', __('Message Type', 'event_espresso'), false, 'registration'),
+				'MTP_is_global'=>new EE_Boolean_Field('MTP_is_global', __('Flag indicating if Template Group is Global', 'event_espresso'), false, true),
+				'MTP_is_override'=>new EE_Boolean_Field('MTP_is_override', __('Flag indicating if Template Group overrides any other Templates for the messenger/messagetype combination', 'event_espresso'), false, false),
+				'MTP_deleted'=>new EE_Trashed_Flag_Field('MTP_deleted', __('Flag indicating whether this has been trashed', 'event_espresso'), false, false),
+				'MTP_is_active'=>new EE_Boolean_Field('MTP_is_active', __('Flag indicating whether template group is active', 'event_espresso'), false, true)
+			)
+		);
+		$this->_model_relations = array(
+			'Message_Template' => new EE_Has_Many_Relation(),
+			'Message' => new EE_Has_Many_Relation(),
+			'Event' => new EE_HABTM_Relation('Event_Message_Template'),
+			'WP_User' => new EE_Belongs_To_Relation()
+		);
+		foreach ($this->_cap_contexts_to_cap_action_map as $context => $action) {
+			$this->_cap_restriction_generators[ $context ] = new EE_Restriction_Generator_Global('MTP_is_global');
+		}
+		$this->_caps_slug = 'messages';
+
+		parent::__construct($timezone);
+	}
+
+
+
+	/**
+	 * get_all_trashed_message_templates_by_event
+	 *
+	 * @access public
+	 * @param int    $EVT_ID specific event id
+	 * @param string $orderby
+	 * @param string $order
+	 * @param null   $limit
+	 * @param bool   $count
+	 * @return array message template objects that are attached to a specific event.
+	 */
+	public function get_all_trashed_message_templates_by_event(
+		$EVT_ID,
+		$orderby = 'GRP_ID',
+		$order = 'ASC',
+		$limit = null,
+		$count = false
+	) {
+		$query_params = array( array('Event.EVT_ID' => $EVT_ID), 'order_by' => array($orderby => $order), 'limit' => $limit );
+		return $count ? $this->count_deleted($query_params, 'GRP_ID', true) : $this->get_all_deleted($query_params);
+	}
+
+
+
+	/**
+	 * get_all_message_templates_by_messenger
+	 *
+	 * @access public
+	 * @param        $messenger
+	 * @param string $orderby
+	 * @param string $order
+	 * @return array all (including trashed or inactive) message template group objects for the given messenger
+	 */
+	public function get_all_message_templates_by_messenger($messenger, $orderby = 'GRP_ID', $order = 'ASC')
+	{
+		return $this->get_all_deleted_and_undeleted(
+			array( array( 'MTP_messenger' => $messenger ), 'order_by' => array( $orderby => $order ) )
+		);
+	}
+
+
+
+	/**
+	 * This simply adds on any messenger/message type filters that may be present in the $_POST global
+	 * @param  array  $_where any existing where conditions to append these to.
+	 * @return array          original where conditions or original with additional filters.
+	 */
+	protected function _maybe_mtp_filters($_where = array())
+	{
+		// account for messenger or message type filters
+		if (isset($_REQUEST['ee_messenger_filter_by'])
+			&& $_REQUEST['ee_messenger_filter_by'] != 'none_selected'
+			&& $_REQUEST['ee_messenger_filter_by'] != 'all'
+		) {
+			$_where['MTP_messenger'] =  $_REQUEST['ee_messenger_filter_by'] ;
+		}
+
+		if (isset($_REQUEST['ee_message_type_filter_by'])
+			&& $_REQUEST['ee_message_type_filter_by'] != 'none_selected'
+		) {
+			$_where['MTP_message_type'] = $_REQUEST['ee_message_type_filter_by'];
+		}
+
+		return $_where;
+	}
+
+
+
+	/**
+	 * get_all_active_message_templates groups
+	 *
+	 * @access public
+	 * @param string $orderby
+	 * @param string $order
+	 * @param null   $limit
+	 * @param bool   $count
+	 * @param bool   $global
+	 * @param bool   $user_check
+	 * @return array all active (non_trashed, active) message template objects
+	 */
+	public function get_all_active_message_templates(
+		$orderby = 'GRP_ID',
+		$order = 'ASC',
+		$limit = null,
+		$count = false,
+		$global = true,
+		$user_check = false
+	) {
+		$_where = $global ? array('MTP_is_global' => true ) : array('MTP_is_global' => false );
+		$_where['MTP_is_active'] = true;
+		$_where = $this->_maybe_mtp_filters($_where);
+
+		if ($user_check
+			&& ! $global
+			&& ! EE_Registry::instance()->CAP->current_user_can(
+				'ee_read_others_messages',
+				'get_all_active_message_templates'
+			)
+		) {
+			$_where['MTP_user_id'] = get_current_user_id();
+		}
+
+		$query_params = array( $_where, 'order_by' => array($orderby => $order), 'limit' => $limit );
+
+		return $count ? $this->count($query_params, 'GRP_ID', true) : $this->get_all($query_params);
+	}
+
+
+
+	/**
+	 *    retrieve ALL message_template groups from db regardless of wht
+	 *
+	 * @access    public
+	 * @param string $orderby
+	 * @param string $order
+	 * @param null   $limit
+	 * @param bool   $count
+	 * @return mixed array on success, FALSE on fail
+	 */
+	public function get_all_message_templates($orderby = 'GRP_ID', $order = 'ASC', $limit = null, $count = false)
+	{
+		$_where = $this->_maybe_mtp_filters();
+
+		$query_params = array( $_where, 'order_by' => array($orderby => $order), 'limit' => $limit );
+
+		$r_templates = $count
+			? $this->count_deleted_and_undeleted($query_params, 'GRP_ID', true)
+			: $this->get_all_deleted_and_undeleted($query_params);
+
+		return $r_templates;
+	}
+
+
+
+
+	/**
+	 * This gets all the custom templates attached to a specific event
+	 * @param  int      $EVT_ID         event id
+	 * @param  array  $query_params @see https://github.com/eventespresso/event-espresso-core/tree/master/docs/G--Model-System/model-query-params.md
+	 * @return  EE_Message_Template_Group[]
+	 */
+	public function get_all_custom_templates_by_event($EVT_ID, $query_params = array())
+	{
+		$where = array_merge($query_params, array( 'Event.EVT_ID' => $EVT_ID ));
+		return $this->get_all(
+			array( $where )
+		);
+	}
+
+
+
+	/**
+	 * get_all_trashed_grouped_message_templates
+	 * this returns ONLY the template groups where ALL contexts are trashed and none of the group are non-trashed
+	 *
+	 * @access public
+	 * @param string $orderby
+	 * @param string $order
+	 * @param null   $limit
+	 * @param bool   $count
+	 * @param bool   $global
+	 * @return \EE_Message_Template_Group[] message template groups.
+	 */
+	public function get_all_trashed_grouped_message_templates(
+		$orderby = 'GRP_ID',
+		$order = 'ASC',
+		$limit = null,
+		$count = false,
+		$global = true
+	) {
+		$_where = $global ? array('MTP_is_global' => true ) : array('MTP_is_global' => false );
+		$_where['MTP_is_active'] = true;
+		$_where = $this->_maybe_mtp_filters($_where);
+
+		$query_params = array( $_where, 'order_by' => array($orderby => $order), 'limit' => $limit );
+
+		return $count ? $this->count_deleted($query_params, 'GRP_ID', true) : $this->get_all_deleted($query_params);
+	}
+
+
+
+	/**
+	 * this returns the message template group(s) for a given event, messenger, and message template
+	 *
+	 * @param  string             $messenger
+	 * @param  string             $message_type
+	 * @param                     $evt_id
+	 * @param  string             $orderby pointless at this point but still included
+	 * @param  string             $order
+	 * @param  mixed (array|null) $limit   array($offset, $num)
+	 * @param  bool               $count   true = just return count, false = objects
+	 * @param  bool               $active  ignore "active" or not. (default only return active)
+	 * @return \mixed[]) depending on $count.
+	 */
+	public function get_event_message_templates_by_m_and_mt_and_evt(
+		$messenger,
+		$message_type,
+		$evt_id,
+		$orderby = 'GRP_ID',
+		$order = 'ASC',
+		$limit = null,
+		$count = false,
+		$active = true
+	) {
+		$_where = array(
+			'MTP_messenger' => $messenger,
+			'MTP_message_type' => $message_type,
+			'Event.EVT_ID' => $evt_id,
+			'MTP_is_global' => true,
+			'MTP_is_active' => $active
+		);
+
+		$query_params = array( $_where, 'order_by' => array($orderby=>$order), 'limit' => $limit );
+
+		return $count ? $this->count($query_params, 'GRP_ID', true) : $this->get_all($query_params);
+	}
+
+
+
+
+	/**
+	 * get all GLOBAL message template groups for the given messenger and message type
+	 *
+	 * @param  string $messenger    slug for messenger
+	 * @param  string $message_type slug for message type
+	 * @param  string $orderby      what column to orderby
+	 * @param  string $order        ASC or DESC
+	 * @param  mixed (array|null) $limit array($offset, $num)
+	 * @param  bool   $count        true = just return count, false = objects
+	 * @param  bool   $active       ignore "active" or not. (default only return active) -
+	 *                              'all' means return both inactive AND inactive.
+	 * @return array               message template objects that are global (i.e. non-event)
+	 */
+	public function get_global_message_template_by_m_and_mt(
+		$messenger,
+		$message_type,
+		$orderby = 'GRP_ID',
+		$order = 'ASC',
+		$limit = null,
+		$count = false,
+		$active = true
+	) {
+		$_where = array(
+			'MTP_messenger' => $messenger,
+			'MTP_message_type' => $message_type,
+			'MTP_is_global' => true,
+		);
+
+		if ($active != 'all') {
+			$_where['MTP_is_active'] = $active;
+		}
+
+		$query_params = array( $_where, 'order_by' => array( $orderby => $order ), 'limit' => $limit );
+
+		return $count ? $this->count($query_params, 'GRP_ID', true) : $this->get_all($query_params);
+	}
+
+
+
+
+	/**
+	 * get all custom message template groups for the given messenger and message type
+	 * @param  string $messenger    messenger
+	 * @param  string $message_type messagetype
+	 * @param  array  $query_params same as EEM_Base->get_all()
+	 * @return EE_Message_Template_Group[]
+	 */
+	public function get_custom_message_template_by_m_and_mt($messenger, $message_type, $query_params = array())
+	{
+		return $this->get_all(
+			array_merge(
+				$query_params,
+				array(
+					array(
+						'MTP_is_global'    => false,
+						'MTP_messenger'    => $messenger,
+						'MTP_message_type' => $message_type
+					)
+				)
+			)
+		);
+	}
+
+
+
+	/**
+	 * This sends things to the validator for the given messenger and message type.
+	 *
+	 * @param  array $fields the incoming fields to check.
+	 *                       Note this array is in the formatted fields from the form fields setup.
+	 *                       So we need to reformat this into an array of expected field refs by the validator.
+	 *                       Note also that this is not only the fields for the Message Template Group
+	 *                       but ALSO for Message Template.
+	 * @param string $context      The context the fields were obtained from.
+	 * @param string $messenger    The messenger we are validating
+	 * @param string $message_type The message type we are validating.
+	 * @return mixed If the fields all check out then we return true otherwise error messages are returned
+	 *                       (indexed by field name);
+	 * @throws \EE_Error
+	 */
+	public function validate($fields, $context, $messenger, $message_type)
+	{
+
+		$assembled_fields = array();
+
+		// let's loop through all the fields and set them up in the right format
+		foreach ($fields as $index => $value) {
+			// first let's figure out if the value['content'] in the current index is an array.
+			//  If it is then this is special fields that are used in parsing special shortcodes (i.e. 'attendee_list').
+			if (is_array($value['content'])) {
+				$assembled_fields[ $value['name'] ] = $value['content']['main'];
+				// loop through the content and get the other fields.
+				foreach ($value['content'] as $name => $val) {
+					if ($name == 'main') {
+						continue;
+					}
+					$assembled_fields[ $name ] = $val;
+				}
+				continue;
+			}
+
+			// okay if we're here then this is just a straight field=>$value arrangement
+			$assembled_fields[ $value['name'] ] = $value['content'];
+		}
+
+		// now we've got the assembled_fields.
+		// We need to setup the string for the appropriate validator class and call that.
+		$m_ref = ucwords(str_replace('_', ' ', $messenger));
+		$m_ref = str_replace(' ', '_', $m_ref);
+		$mt_ref = ucwords(str_replace('_', ' ', $message_type));
+		$mt_ref = str_replace(' ', '_', $mt_ref);
+
+		$classname = 'EE_Messages_' . $m_ref . '_' . $mt_ref . '_Validator';
+
+		if (!class_exists($classname)) {
+			$msg[] = __('The Validator class was unable to load', 'event_espresso');
+			$msg[] = sprintf(
+				__(
+					'The class name compiled was %s. Please check and make sure the spelling and case is correct for the class name and that there is an autoloader in place for this class',
+					'event_espresso'
+				),
+				$classname
+			);
+			throw new EE_Error(implode('||', $msg));
+		}
+
+		$a = new ReflectionClass($classname);
+		$_VLD = $a->newInstance($assembled_fields, $context);
+		$result = $_VLD->validate();
+		return $result;
+	}
+
+
+
+	/**
+	 * Updates all message template groups matching the incoming arguments to inactive status.
+	 *
+	 * @param array $messenger_names    The messenger slugs.
+	 *                              If empty then all templates matching the message types are marked inactive.
+	 *                              Otherwise only templates matching the messengers and message types.
+	 * @param array $message_type_names     The message type slugs.
+	 *                              If empty then all templates matching the messengers are marked inactive.
+	 *                              Otherwise only templates matching the messengers and message types.
+	 *
+	 * @return int  count of updated records.
+	 */
+	public function deactivate_message_template_groups_for($messenger_names = array(), $message_type_names = array())
+	{
+		$query_args = array();
+		if (empty($messenger_names) && empty($message_type_names)) {
+			return 0;
+		}
+		if (! empty($messenger_names)) {
+			$query_args[0]['MTP_messenger'] = array( 'IN', (array) $messenger_names );
+		}
+		if (! empty($message_type_names)) {
+			$query_args[0]['MTP_message_type'] = array( 'IN', (array) $message_type_names );
+		}
+		return $this->update(array( 'MTP_is_active' => false ), $query_args);
+	}
 }

core/db_models/EEM_Payment_Method.model.php

Doc Comments +3 added lines, -3 removed lines

@@ -214,7 +214,7 @@ 
     /**
      * Overrides parent ot also check by the slug
      * @see EEM_Base::ensure_is_obj()
-     * @param string|int|EE_Payment_Method $base_class_obj_or_id
+     * @param EE_Payment_Method $base_class_obj_or_id
      * @param boolean                      $ensure_is_in_db
      * @return EE_Payment_Method
      * @throws EE_Error
@@ -382,8 +382,8 @@ 
      * Note: if an offline payment method was selected on the related transaction then this will have no payment methods returned.
      * It will ONLY return a payment method for a PAYMENT recorded against the registration.
      *
-     * @param EE_Registration|int $registration_or_reg_id  Either the EE_Registration object or the id for the registration.
-     * @return EE_Payment|null
+     * @param EE_Registration $registration_or_reg_id  Either the EE_Registration object or the id for the registration.
+     * @return null|EE_Base_Class
      */
     public function get_last_used_for_registration($registration_or_reg_id)
     {

Spacing +14 added lines, -14 removed lines

@@ -44,7 +44,7 @@ 
     {
         $this->singlular_item = __('Payment Method', 'event_espresso');
         $this->plural_item = __('Payment Methods', 'event_espresso');
-        $this->_tables = array( 'Payment_Method' => new EE_Primary_Table('esp_payment_method', 'PMD_ID') );
+        $this->_tables = array('Payment_Method' => new EE_Primary_Table('esp_payment_method', 'PMD_ID'));
         $this->_fields = array(
             'Payment_Method' => array(
                 'PMD_ID' => new EE_Primary_Key_Int_Field('PMD_ID', __("ID", 'event_espresso')),
@@ -78,7 +78,7 @@ 
      */
     public function get_one_by_slug($slug)
     {
-        return $this->get_one(array( array( 'PMD_slug' => $slug ) ));
+        return $this->get_one(array(array('PMD_slug' => $slug)));
     }
 
 
@@ -109,7 +109,7 @@ 
     public function is_valid_scope($scope)
     {
         $scopes = $this->scopes();
-        if (isset($scopes[ $scope ])) {
+        if (isset($scopes[$scope])) {
             return true;
         } else {
             return false;
@@ -127,8 +127,8 @@ 
      */
     public function get_all_active($scope = null, $query_params = array())
     {
-        if (! isset($query_params['order_by']) && ! isset($query_params['order'])) {
-            $query_params['order_by'] = array( 'PMD_order' => 'ASC', 'PMD_ID' => 'ASC' );
+        if ( ! isset($query_params['order_by']) && ! isset($query_params['order'])) {
+            $query_params['order_by'] = array('PMD_order' => 'ASC', 'PMD_ID' => 'ASC');
         }
         return $this->get_all($this->_get_query_params_for_all_active($scope, $query_params));
     }
@@ -156,7 +156,7 @@ 
     {
         if ($scope) {
             if ($this->is_valid_scope($scope)) {
-                return array_replace_recursive(array( array( 'PMD_scope' => array( 'LIKE', "%$scope%" ) ) ), $query_params);
+                return array_replace_recursive(array(array('PMD_scope' => array('LIKE', "%$scope%"))), $query_params);
             } else {
                 throw new EE_Error(sprintf(__("'%s' is not a valid scope for a payment method", "event_espresso"), $scope));
             }
@@ -165,9 +165,9 @@ 
             $count = 0;
             foreach ($this->scopes() as $scope_name => $desc) {
                 $count++;
-                $acceptable_scopes[ 'PMD_scope*' . $count ] = array( 'LIKE', '%' . $scope_name . '%' );
+                $acceptable_scopes['PMD_scope*'.$count] = array('LIKE', '%'.$scope_name.'%');
             }
-            return array_replace_recursive(array( array( 'OR*active_scope' => $acceptable_scopes ) ), $query_params);
+            return array_replace_recursive(array(array('OR*active_scope' => $acceptable_scopes)), $query_params);
         }
     }
 
@@ -205,7 +205,7 @@ 
      */
     public function get_one_of_type($type)
     {
-        return $this->get_one(array( array( 'PMD_type' => $type ) ));
+        return $this->get_one(array(array('PMD_type' => $type)));
     }
 
 
@@ -298,7 +298,7 @@ 
         $usable_payment_methods = array();
         foreach ($payment_methods as $key => $payment_method) {
             if (EE_Payment_Method_Manager::instance()->payment_method_type_exists($payment_method->type())) {
-                $usable_payment_methods[ $key ] = $payment_method;
+                $usable_payment_methods[$key] = $payment_method;
                 // some payment methods enqueue their scripts in EE_PMT_*::__construct
                 // which is kinda a no-no (just because it's being constructed doesn't mean we need to enqueue
                 // its scripts). but for backwards-compat we should continue to do that
@@ -312,7 +312,7 @@ 
                     $payment_method
                 );
                 new PersistentAdminNotice(
-                    'auto-deactivated-' . $payment_method->type(),
+                    'auto-deactivated-'.$payment_method->type(),
                     sprintf(
                         __(
                             'The payment method %1$s was automatically deactivated because it appears its associated Event Espresso Addon was recently deactivated.%2$sIt can be reactivated on the %3$sPlugins admin page%4$s, then you can reactivate the payment method.',
@@ -320,7 +320,7 @@ 
                         ),
                         $payment_method->admin_name(),
                         '<br />',
-                        '<a href="' . admin_url('plugins.php') . '">',
+                        '<a href="'.admin_url('plugins.php').'">',
                         '</a>'
                     ),
                     true
@@ -345,7 +345,7 @@ 
         // give addons a chance to override what payment methods are chosen based on the transaction
         return apply_filters(
             'FHEE__EEM_Payment_Method__get_all_for_transaction__payment_methods',
-            $this->get_all_active($scope, array( 'group_by' => 'PMD_type' )),
+            $this->get_all_active($scope, array('group_by' => 'PMD_type')),
             $transaction,
             $scope
         );
@@ -369,7 +369,7 @@ 
             0 => array(
                 'Payment.Registration.REG_ID' => $registration_id,
             ),
-            'order_by' => array( 'Payment.PAY_ID' => 'DESC' )
+            'order_by' => array('Payment.PAY_ID' => 'DESC')
         );
         return $this->get_one($query_params);
     }

Indentation +359 added lines, -359 removed lines

@@ -20,363 +20,363 @@
 class EEM_Payment_Method extends EEM_Base
 {
 
-    const scope_cart = 'CART';
-
-    const scope_admin = 'ADMIN';
-
-    const scope_api = 'API';
-
-    /**
-     *
-     * @type EEM_Payment_Method
-     */
-    protected static $_instance = null;
-
-
-
-    /**
-     * private constructor to prevent direct creation
-     * @Constructor
-     * @access   protected
-     * @return EEM_Payment_Method
-     */
-    protected function __construct($timezone = null)
-    {
-        $this->singlular_item = __('Payment Method', 'event_espresso');
-        $this->plural_item = __('Payment Methods', 'event_espresso');
-        $this->_tables = array( 'Payment_Method' => new EE_Primary_Table('esp_payment_method', 'PMD_ID') );
-        $this->_fields = array(
-            'Payment_Method' => array(
-                'PMD_ID' => new EE_Primary_Key_Int_Field('PMD_ID', __("ID", 'event_espresso')),
-                'PMD_type' => new EE_Plain_Text_Field('PMD_type', __("Payment Method Type", 'event_espresso'), false, 'Admin_Only'),
-                'PMD_name' => new EE_Plain_Text_Field('PMD_name', __("Name", 'event_espresso'), false),
-                'PMD_desc' => new EE_Post_Content_Field('PMD_desc', __("Description", 'event_espresso'), false, ''),
-                'PMD_admin_name' => new EE_Plain_Text_Field('PMD_admin_name', __("Admin-Only Name", 'event_espresso'), true),
-                'PMD_admin_desc' => new EE_Post_Content_Field('PMD_admin_desc', __("Admin-Only Description", 'event_espresso'), true),
-                'PMD_slug' => new EE_Slug_Field('PMD_slug', __("Slug", 'event_espresso'), false),
-                'PMD_order' => new EE_Integer_Field('PMD_order', __("Order", 'event_espresso'), false, 0),
-                'PMD_debug_mode' => new EE_Boolean_Field('PMD_debug_mode', __("Debug Mode On?", 'event_espresso'), false, false),
-                'PMD_wp_user' => new EE_WP_User_Field('PMD_wp_user', __("Payment Method Creator ID", 'event_espresso'), false),
-                'PMD_open_by_default' => new EE_Boolean_Field('PMD_open_by_default', __("Open by Default?", 'event_espresso'), false, false), 'PMD_button_url' => new EE_Plain_Text_Field('PMD_button_url', __("Button URL", 'event_espresso'), true, ''),
-                'PMD_scope' => new EE_Serialized_Text_Field('PMD_scope', __("Usable From?", 'event_espresso'), false, array()), // possible values currently are 'CART','ADMIN','API'
-        ) );
-        $this->_model_relations = array(
-            'Payment' => new EE_Has_Many_Relation(),
-            'Currency' => new EE_HABTM_Relation('Currency_Payment_Method'),
-            'Transaction' => new EE_Has_Many_Relation(),
-            'WP_User' => new EE_Belongs_To_Relation(),
-        );
-        parent::__construct($timezone);
-    }
-
-
-
-    /**
-     * Gets one by the slug provided
-     * @param string $slug
-     * @return EE_Payment_Method
-     */
-    public function get_one_by_slug($slug)
-    {
-        return $this->get_one(array( array( 'PMD_slug' => $slug ) ));
-    }
-
-
-
-    /**
-     * Gets all the acceptable scopes for payment methods.
-     * Keys are their names as store din the DB, and values are nice names for displaying them
-     * @return array
-     */
-    public function scopes()
-    {
-        return apply_filters(
-            'FHEE__EEM_Payment_Method__scopes',
-            array(
-                self::scope_cart        => __("Front-end Registration Page", 'event_espresso'),
-                self::scope_admin   => __("Admin Registration Page (no online processing)", 'event_espresso')
-            )
-        );
-    }
-
-
-
-    /**
-     * Determines if this is an valid scope
-     * @param string $scope like one of EEM_Payment_Method::instance()->scopes()
-     * @return boolean
-     */
-    public function is_valid_scope($scope)
-    {
-        $scopes = $this->scopes();
-        if (isset($scopes[ $scope ])) {
-            return true;
-        } else {
-            return false;
-        }
-    }
-
-
-
-    /**
-     * Gets all active payment methods
-     * @param string $scope one of
-     * @param array  $query_params
-     * @throws EE_Error
-     * @return EE_Payment_Method[]
-     */
-    public function get_all_active($scope = null, $query_params = array())
-    {
-        if (! isset($query_params['order_by']) && ! isset($query_params['order'])) {
-            $query_params['order_by'] = array( 'PMD_order' => 'ASC', 'PMD_ID' => 'ASC' );
-        }
-        return $this->get_all($this->_get_query_params_for_all_active($scope, $query_params));
-    }
-
-    /**
-     * Counts all active gateways in the specified scope
-     * @param string $scope one of EEM_Payment_Method::scope_*
-     * @param array $query_params
-     * @return int
-     */
-    public function count_active($scope = null, $query_params = array())
-    {
-        return $this->count($this->_get_query_params_for_all_active($scope, $query_params));
-    }
-
-    /**
-     * Creates the $query_params that can be passed into any EEM_Payment_Method as their $query_params
-     * argument to get all active for a given scope
-     * @param string $scope one of the constants EEM_Payment_Method::scope_*
-     * @param array $query_params @see https://github.com/eventespresso/event-espresso-core/tree/master/docs/G--Model-System/model-query-params.md
-     * @return array @see https://github.com/eventespresso/event-espresso-core/tree/master/docs/G--Model-System/model-query-params.md
-     * @throws EE_Error
-     */
-    protected function _get_query_params_for_all_active($scope = null, $query_params = array())
-    {
-        if ($scope) {
-            if ($this->is_valid_scope($scope)) {
-                return array_replace_recursive(array( array( 'PMD_scope' => array( 'LIKE', "%$scope%" ) ) ), $query_params);
-            } else {
-                throw new EE_Error(sprintf(__("'%s' is not a valid scope for a payment method", "event_espresso"), $scope));
-            }
-        } else {
-            $acceptable_scopes = array();
-            $count = 0;
-            foreach ($this->scopes() as $scope_name => $desc) {
-                $count++;
-                $acceptable_scopes[ 'PMD_scope*' . $count ] = array( 'LIKE', '%' . $scope_name . '%' );
-            }
-            return array_replace_recursive(array( array( 'OR*active_scope' => $acceptable_scopes ) ), $query_params);
-        }
-    }
-
-    /**
-     * Creates the $query_params that can be passed into any EEM_Payment_Method as their $query_params
-     * argument to get all active for a given scope
-     * @param string $scope one of the constants EEM_Payment_Method::scope_*
-     * @param array $query_params @see https://github.com/eventespresso/event-espresso-core/tree/master/docs/G--Model-System/model-query-params.md
-     * @return array @see https://github.com/eventespresso/event-espresso-core/tree/master/docs/G--Model-System/model-query-params.md
-     * @throws EE_Error
-     */
-    public function get_query_params_for_all_active($scope = null, $query_params = array())
-    {
-        return $this->_get_query_params_for_all_active($scope, $query_params);
-    }
-
-
-    /**
-     * Gets one active payment method. see @get_all_active for documentation
-     * @param string $scope
-     * @param array  $query_params
-     * @return EE_Payment_Method
-     */
-    public function get_one_active($scope = null, $query_params = array())
-    {
-        return $this->get_one($this->_get_query_params_for_all_active($scope, $query_params));
-    }
-
-
-
-    /**
-     * Gets one payment method of that type, regardless of whether its active or not
-     * @param string $type
-     * @return EE_Payment_Method
-     */
-    public function get_one_of_type($type)
-    {
-        return $this->get_one(array( array( 'PMD_type' => $type ) ));
-    }
-
-
-
-    /**
-     * Overrides parent ot also check by the slug
-     * @see EEM_Base::ensure_is_obj()
-     * @param string|int|EE_Payment_Method $base_class_obj_or_id
-     * @param boolean                      $ensure_is_in_db
-     * @return EE_Payment_Method
-     * @throws EE_Error
-     */
-    public function ensure_is_obj($base_class_obj_or_id, $ensure_is_in_db = false)
-    {
-        // first: check if it's a slug
-        if (is_string($base_class_obj_or_id)) {
-            $obj = $this->get_one_by_slug($base_class_obj_or_id);
-            if ($obj) {
-                return $obj;
-            }
-        }
-        // ok so it wasn't a slug we were passed. try the usual then (ie, it's an object or an ID)
-        try {
-            return parent::ensure_is_obj($base_class_obj_or_id, $ensure_is_in_db);
-        } catch (EE_Error $e) {
-            // handle it outside the catch
-        }
-        throw new EE_Error(sprintf(__("'%s' is neither a Payment Method ID, slug, nor object.", "event_espresso"), $base_class_obj_or_id));
-    }
-
-
-
-    /**
-     * Gets the ID of this object, or if its a string finds the object's id
-     * associated with that slug
-     * @param mixed $base_obj_or_id_or_slug
-     * @return int
-     */
-    public function ensure_is_ID($base_obj_or_id_or_slug)
-    {
-        if (is_string($base_obj_or_id_or_slug)) {
-            // assume it's a slug
-            $base_obj_or_id_or_slug = $this->get_one_by_slug($base_obj_or_id_or_slug);
-        }
-        return parent::ensure_is_ID($base_obj_or_id_or_slug);
-    }
-
-
-
-    /**
-     * Verifies the button urls on all the passed payment methods have a valid button url. If not, resets them to their default.
-     * @param EE_Payment_Method[] $payment_methods. If NULL is provided defaults to all payment methods active in the cart
-     */
-    public function verify_button_urls($payment_methods = null)
-    {
-        $payment_methods = is_array($payment_methods) ? $payment_methods : $this->get_all_active(EEM_Payment_Method::scope_cart);
-        foreach ($payment_methods as $payment_method) {
-            try {
-                // If there is really no button URL at all, or if the button URLs still point to decaf folder even
-                // though this is a caffeinated install, reset it to the default.
-                $current_button_url = $payment_method->button_url();
-                if (empty($current_button_url)
-                || (
-                        strpos($current_button_url, 'decaf') !== false
-                        && strpos($payment_method->type_obj()->default_button_url(), 'decaf') === false
-                    )
-                ) {
-                    $payment_method->save(
-                        [
-                            'PMD_button_url' => $payment_method->type_obj()->default_button_url()
-                        ]
-                    );
-                }
-            } catch (EE_Error $e) {
-                $payment_method->set_active(false);
-            }
-        }
-    }
-
-
-
-    /**
-     * Overrides parent to not only turn wpdb results into EE_Payment_Method objects,
-     * but also verifies the payment method type of each is a usable object. If not,
-     * deactivate it, sets a notification, and deactivates it
-     *
-     * @param array $rows
-     * @return EE_Payment_Method[]
-     * @throws InvalidDataTypeException
-     */
-    protected function _create_objects($rows = array())
-    {
-        EE_Registry::instance()->load_lib('Payment_Method_Manager');
-        $payment_methods = parent::_create_objects($rows);
-        /* @var $payment_methods EE_Payment_Method[] */
-        $usable_payment_methods = array();
-        foreach ($payment_methods as $key => $payment_method) {
-            if (EE_Payment_Method_Manager::instance()->payment_method_type_exists($payment_method->type())) {
-                $usable_payment_methods[ $key ] = $payment_method;
-                // some payment methods enqueue their scripts in EE_PMT_*::__construct
-                // which is kinda a no-no (just because it's being constructed doesn't mean we need to enqueue
-                // its scripts). but for backwards-compat we should continue to do that
-                $payment_method->type_obj();
-            } elseif ($payment_method->active()) {
-                // only deactivate and notify the admin if the payment is active somewhere
-                $payment_method->deactivate();
-                $payment_method->save();
-                do_action(
-                    'AHEE__EEM_Payment_Method___create_objects_auto_deactivated_payment_method',
-                    $payment_method
-                );
-                new PersistentAdminNotice(
-                    'auto-deactivated-' . $payment_method->type(),
-                    sprintf(
-                        __(
-                            'The payment method %1$s was automatically deactivated because it appears its associated Event Espresso Addon was recently deactivated.%2$sIt can be reactivated on the %3$sPlugins admin page%4$s, then you can reactivate the payment method.',
-                            'event_espresso'
-                        ),
-                        $payment_method->admin_name(),
-                        '<br />',
-                        '<a href="' . admin_url('plugins.php') . '">',
-                        '</a>'
-                    ),
-                    true
-                );
-            }
-        }
-        return $usable_payment_methods;
-    }
-
-
-
-    /**
-     * Gets all the payment methods which can be used for transaction
-     * (according to the relations between payment methods and events, and
-     * the currencies used for the transaction and their relation to payment methods)
-     * @param EE_Transaction $transaction
-     * @param string    $scope @see EEM_Payment_Method::get_all_for_events
-     * @return EE_Payment_Method[]
-     */
-    public function get_all_for_transaction($transaction, $scope)
-    {
-        // give addons a chance to override what payment methods are chosen based on the transaction
-        return apply_filters(
-            'FHEE__EEM_Payment_Method__get_all_for_transaction__payment_methods',
-            $this->get_all_active($scope, array( 'group_by' => 'PMD_type' )),
-            $transaction,
-            $scope
-        );
-    }
-
-
-    /**
-     * Returns the payment method used for the last payment made for a registration.
-     *
-     * Note: if an offline payment method was selected on the related transaction then this will have no payment methods returned.
-     * It will ONLY return a payment method for a PAYMENT recorded against the registration.
-     *
-     * @param EE_Registration|int $registration_or_reg_id  Either the EE_Registration object or the id for the registration.
-     * @return EE_Payment|null
-     */
-    public function get_last_used_for_registration($registration_or_reg_id)
-    {
-        $registration_id = EEM_Registration::instance()->ensure_is_ID($registration_or_reg_id);
-
-        $query_params = array(
-            0 => array(
-                'Payment.Registration.REG_ID' => $registration_id,
-            ),
-            'order_by' => array( 'Payment.PAY_ID' => 'DESC' )
-        );
-        return $this->get_one($query_params);
-    }
+	const scope_cart = 'CART';
+
+	const scope_admin = 'ADMIN';
+
+	const scope_api = 'API';
+
+	/**
+	 *
+	 * @type EEM_Payment_Method
+	 */
+	protected static $_instance = null;
+
+
+
+	/**
+	 * private constructor to prevent direct creation
+	 * @Constructor
+	 * @access   protected
+	 * @return EEM_Payment_Method
+	 */
+	protected function __construct($timezone = null)
+	{
+		$this->singlular_item = __('Payment Method', 'event_espresso');
+		$this->plural_item = __('Payment Methods', 'event_espresso');
+		$this->_tables = array( 'Payment_Method' => new EE_Primary_Table('esp_payment_method', 'PMD_ID') );
+		$this->_fields = array(
+			'Payment_Method' => array(
+				'PMD_ID' => new EE_Primary_Key_Int_Field('PMD_ID', __("ID", 'event_espresso')),
+				'PMD_type' => new EE_Plain_Text_Field('PMD_type', __("Payment Method Type", 'event_espresso'), false, 'Admin_Only'),
+				'PMD_name' => new EE_Plain_Text_Field('PMD_name', __("Name", 'event_espresso'), false),
+				'PMD_desc' => new EE_Post_Content_Field('PMD_desc', __("Description", 'event_espresso'), false, ''),
+				'PMD_admin_name' => new EE_Plain_Text_Field('PMD_admin_name', __("Admin-Only Name", 'event_espresso'), true),
+				'PMD_admin_desc' => new EE_Post_Content_Field('PMD_admin_desc', __("Admin-Only Description", 'event_espresso'), true),
+				'PMD_slug' => new EE_Slug_Field('PMD_slug', __("Slug", 'event_espresso'), false),
+				'PMD_order' => new EE_Integer_Field('PMD_order', __("Order", 'event_espresso'), false, 0),
+				'PMD_debug_mode' => new EE_Boolean_Field('PMD_debug_mode', __("Debug Mode On?", 'event_espresso'), false, false),
+				'PMD_wp_user' => new EE_WP_User_Field('PMD_wp_user', __("Payment Method Creator ID", 'event_espresso'), false),
+				'PMD_open_by_default' => new EE_Boolean_Field('PMD_open_by_default', __("Open by Default?", 'event_espresso'), false, false), 'PMD_button_url' => new EE_Plain_Text_Field('PMD_button_url', __("Button URL", 'event_espresso'), true, ''),
+				'PMD_scope' => new EE_Serialized_Text_Field('PMD_scope', __("Usable From?", 'event_espresso'), false, array()), // possible values currently are 'CART','ADMIN','API'
+		) );
+		$this->_model_relations = array(
+			'Payment' => new EE_Has_Many_Relation(),
+			'Currency' => new EE_HABTM_Relation('Currency_Payment_Method'),
+			'Transaction' => new EE_Has_Many_Relation(),
+			'WP_User' => new EE_Belongs_To_Relation(),
+		);
+		parent::__construct($timezone);
+	}
+
+
+
+	/**
+	 * Gets one by the slug provided
+	 * @param string $slug
+	 * @return EE_Payment_Method
+	 */
+	public function get_one_by_slug($slug)
+	{
+		return $this->get_one(array( array( 'PMD_slug' => $slug ) ));
+	}
+
+
+
+	/**
+	 * Gets all the acceptable scopes for payment methods.
+	 * Keys are their names as store din the DB, and values are nice names for displaying them
+	 * @return array
+	 */
+	public function scopes()
+	{
+		return apply_filters(
+			'FHEE__EEM_Payment_Method__scopes',
+			array(
+				self::scope_cart        => __("Front-end Registration Page", 'event_espresso'),
+				self::scope_admin   => __("Admin Registration Page (no online processing)", 'event_espresso')
+			)
+		);
+	}
+
+
+
+	/**
+	 * Determines if this is an valid scope
+	 * @param string $scope like one of EEM_Payment_Method::instance()->scopes()
+	 * @return boolean
+	 */
+	public function is_valid_scope($scope)
+	{
+		$scopes = $this->scopes();
+		if (isset($scopes[ $scope ])) {
+			return true;
+		} else {
+			return false;
+		}
+	}
+
+
+
+	/**
+	 * Gets all active payment methods
+	 * @param string $scope one of
+	 * @param array  $query_params
+	 * @throws EE_Error
+	 * @return EE_Payment_Method[]
+	 */
+	public function get_all_active($scope = null, $query_params = array())
+	{
+		if (! isset($query_params['order_by']) && ! isset($query_params['order'])) {
+			$query_params['order_by'] = array( 'PMD_order' => 'ASC', 'PMD_ID' => 'ASC' );
+		}
+		return $this->get_all($this->_get_query_params_for_all_active($scope, $query_params));
+	}
+
+	/**
+	 * Counts all active gateways in the specified scope
+	 * @param string $scope one of EEM_Payment_Method::scope_*
+	 * @param array $query_params
+	 * @return int
+	 */
+	public function count_active($scope = null, $query_params = array())
+	{
+		return $this->count($this->_get_query_params_for_all_active($scope, $query_params));
+	}
+
+	/**
+	 * Creates the $query_params that can be passed into any EEM_Payment_Method as their $query_params
+	 * argument to get all active for a given scope
+	 * @param string $scope one of the constants EEM_Payment_Method::scope_*
+	 * @param array $query_params @see https://github.com/eventespresso/event-espresso-core/tree/master/docs/G--Model-System/model-query-params.md
+	 * @return array @see https://github.com/eventespresso/event-espresso-core/tree/master/docs/G--Model-System/model-query-params.md
+	 * @throws EE_Error
+	 */
+	protected function _get_query_params_for_all_active($scope = null, $query_params = array())
+	{
+		if ($scope) {
+			if ($this->is_valid_scope($scope)) {
+				return array_replace_recursive(array( array( 'PMD_scope' => array( 'LIKE', "%$scope%" ) ) ), $query_params);
+			} else {
+				throw new EE_Error(sprintf(__("'%s' is not a valid scope for a payment method", "event_espresso"), $scope));
+			}
+		} else {
+			$acceptable_scopes = array();
+			$count = 0;
+			foreach ($this->scopes() as $scope_name => $desc) {
+				$count++;
+				$acceptable_scopes[ 'PMD_scope*' . $count ] = array( 'LIKE', '%' . $scope_name . '%' );
+			}
+			return array_replace_recursive(array( array( 'OR*active_scope' => $acceptable_scopes ) ), $query_params);
+		}
+	}
+
+	/**
+	 * Creates the $query_params that can be passed into any EEM_Payment_Method as their $query_params
+	 * argument to get all active for a given scope
+	 * @param string $scope one of the constants EEM_Payment_Method::scope_*
+	 * @param array $query_params @see https://github.com/eventespresso/event-espresso-core/tree/master/docs/G--Model-System/model-query-params.md
+	 * @return array @see https://github.com/eventespresso/event-espresso-core/tree/master/docs/G--Model-System/model-query-params.md
+	 * @throws EE_Error
+	 */
+	public function get_query_params_for_all_active($scope = null, $query_params = array())
+	{
+		return $this->_get_query_params_for_all_active($scope, $query_params);
+	}
+
+
+	/**
+	 * Gets one active payment method. see @get_all_active for documentation
+	 * @param string $scope
+	 * @param array  $query_params
+	 * @return EE_Payment_Method
+	 */
+	public function get_one_active($scope = null, $query_params = array())
+	{
+		return $this->get_one($this->_get_query_params_for_all_active($scope, $query_params));
+	}
+
+
+
+	/**
+	 * Gets one payment method of that type, regardless of whether its active or not
+	 * @param string $type
+	 * @return EE_Payment_Method
+	 */
+	public function get_one_of_type($type)
+	{
+		return $this->get_one(array( array( 'PMD_type' => $type ) ));
+	}
+
+
+
+	/**
+	 * Overrides parent ot also check by the slug
+	 * @see EEM_Base::ensure_is_obj()
+	 * @param string|int|EE_Payment_Method $base_class_obj_or_id
+	 * @param boolean                      $ensure_is_in_db
+	 * @return EE_Payment_Method
+	 * @throws EE_Error
+	 */
+	public function ensure_is_obj($base_class_obj_or_id, $ensure_is_in_db = false)
+	{
+		// first: check if it's a slug
+		if (is_string($base_class_obj_or_id)) {
+			$obj = $this->get_one_by_slug($base_class_obj_or_id);
+			if ($obj) {
+				return $obj;
+			}
+		}
+		// ok so it wasn't a slug we were passed. try the usual then (ie, it's an object or an ID)
+		try {
+			return parent::ensure_is_obj($base_class_obj_or_id, $ensure_is_in_db);
+		} catch (EE_Error $e) {
+			// handle it outside the catch
+		}
+		throw new EE_Error(sprintf(__("'%s' is neither a Payment Method ID, slug, nor object.", "event_espresso"), $base_class_obj_or_id));
+	}
+
+
+
+	/**
+	 * Gets the ID of this object, or if its a string finds the object's id
+	 * associated with that slug
+	 * @param mixed $base_obj_or_id_or_slug
+	 * @return int
+	 */
+	public function ensure_is_ID($base_obj_or_id_or_slug)
+	{
+		if (is_string($base_obj_or_id_or_slug)) {
+			// assume it's a slug
+			$base_obj_or_id_or_slug = $this->get_one_by_slug($base_obj_or_id_or_slug);
+		}
+		return parent::ensure_is_ID($base_obj_or_id_or_slug);
+	}
+
+
+
+	/**
+	 * Verifies the button urls on all the passed payment methods have a valid button url. If not, resets them to their default.
+	 * @param EE_Payment_Method[] $payment_methods. If NULL is provided defaults to all payment methods active in the cart
+	 */
+	public function verify_button_urls($payment_methods = null)
+	{
+		$payment_methods = is_array($payment_methods) ? $payment_methods : $this->get_all_active(EEM_Payment_Method::scope_cart);
+		foreach ($payment_methods as $payment_method) {
+			try {
+				// If there is really no button URL at all, or if the button URLs still point to decaf folder even
+				// though this is a caffeinated install, reset it to the default.
+				$current_button_url = $payment_method->button_url();
+				if (empty($current_button_url)
+				|| (
+						strpos($current_button_url, 'decaf') !== false
+						&& strpos($payment_method->type_obj()->default_button_url(), 'decaf') === false
+					)
+				) {
+					$payment_method->save(
+						[
+							'PMD_button_url' => $payment_method->type_obj()->default_button_url()
+						]
+					);
+				}
+			} catch (EE_Error $e) {
+				$payment_method->set_active(false);
+			}
+		}
+	}
+
+
+
+	/**
+	 * Overrides parent to not only turn wpdb results into EE_Payment_Method objects,
+	 * but also verifies the payment method type of each is a usable object. If not,
+	 * deactivate it, sets a notification, and deactivates it
+	 *
+	 * @param array $rows
+	 * @return EE_Payment_Method[]
+	 * @throws InvalidDataTypeException
+	 */
+	protected function _create_objects($rows = array())
+	{
+		EE_Registry::instance()->load_lib('Payment_Method_Manager');
+		$payment_methods = parent::_create_objects($rows);
+		/* @var $payment_methods EE_Payment_Method[] */
+		$usable_payment_methods = array();
+		foreach ($payment_methods as $key => $payment_method) {
+			if (EE_Payment_Method_Manager::instance()->payment_method_type_exists($payment_method->type())) {
+				$usable_payment_methods[ $key ] = $payment_method;
+				// some payment methods enqueue their scripts in EE_PMT_*::__construct
+				// which is kinda a no-no (just because it's being constructed doesn't mean we need to enqueue
+				// its scripts). but for backwards-compat we should continue to do that
+				$payment_method->type_obj();
+			} elseif ($payment_method->active()) {
+				// only deactivate and notify the admin if the payment is active somewhere
+				$payment_method->deactivate();
+				$payment_method->save();
+				do_action(
+					'AHEE__EEM_Payment_Method___create_objects_auto_deactivated_payment_method',
+					$payment_method
+				);
+				new PersistentAdminNotice(
+					'auto-deactivated-' . $payment_method->type(),
+					sprintf(
+						__(
+							'The payment method %1$s was automatically deactivated because it appears its associated Event Espresso Addon was recently deactivated.%2$sIt can be reactivated on the %3$sPlugins admin page%4$s, then you can reactivate the payment method.',
+							'event_espresso'
+						),
+						$payment_method->admin_name(),
+						'<br />',
+						'<a href="' . admin_url('plugins.php') . '">',
+						'</a>'
+					),
+					true
+				);
+			}
+		}
+		return $usable_payment_methods;
+	}
+
+
+
+	/**
+	 * Gets all the payment methods which can be used for transaction
+	 * (according to the relations between payment methods and events, and
+	 * the currencies used for the transaction and their relation to payment methods)
+	 * @param EE_Transaction $transaction
+	 * @param string    $scope @see EEM_Payment_Method::get_all_for_events
+	 * @return EE_Payment_Method[]
+	 */
+	public function get_all_for_transaction($transaction, $scope)
+	{
+		// give addons a chance to override what payment methods are chosen based on the transaction
+		return apply_filters(
+			'FHEE__EEM_Payment_Method__get_all_for_transaction__payment_methods',
+			$this->get_all_active($scope, array( 'group_by' => 'PMD_type' )),
+			$transaction,
+			$scope
+		);
+	}
+
+
+	/**
+	 * Returns the payment method used for the last payment made for a registration.
+	 *
+	 * Note: if an offline payment method was selected on the related transaction then this will have no payment methods returned.
+	 * It will ONLY return a payment method for a PAYMENT recorded against the registration.
+	 *
+	 * @param EE_Registration|int $registration_or_reg_id  Either the EE_Registration object or the id for the registration.
+	 * @return EE_Payment|null
+	 */
+	public function get_last_used_for_registration($registration_or_reg_id)
+	{
+		$registration_id = EEM_Registration::instance()->ensure_is_ID($registration_or_reg_id);
+
+		$query_params = array(
+			0 => array(
+				'Payment.Registration.REG_ID' => $registration_id,
+			),
+			'order_by' => array( 'Payment.PAY_ID' => 'DESC' )
+		);
+		return $this->get_one($query_params);
+	}
 }

core/db_models/EEM_Price.model.php

Doc Comments +5 added lines, -5 removed lines

@@ -66,7 +66,7 @@ 
      *      instantiate a new price object with blank/empty properties
      *
      *      @access     public
-     *      @return     mixed       array on success, FALSE on fail
+     *      @return     EE_Base_Class|null       array on success, FALSE on fail
      */
     public function get_new_price()
     {
@@ -96,7 +96,7 @@ 
      *
      * @access        public
      * @param int $EVT_ID
-     * @return array on success
+     * @return EE_Base_Class[] on success
      */
     public function get_all_event_prices($EVT_ID = 0)
     {
@@ -223,7 +223,7 @@ 
      * @access public
      * @param \EE_Price $price_a
      * @param \EE_Price $price_b
-     * @return bool false on fail
+     * @return integer false on fail
      */
     public function _sort_event_prices_by_type(EE_Price $price_a, EE_Price $price_b)
     {
@@ -241,7 +241,7 @@ 
      * @access public
      * @param \EE_Price $price_a
      * @param \EE_Price $price_b
-     * @return bool false on fail
+     * @return integer false on fail
      */
     public function _sort_event_prices_by_order(EE_Price $price_a, EE_Price $price_b)
     {
@@ -258,7 +258,7 @@ 
      *
      *      @access     public
      *      @param      int                 $type - PRT_ID
-     *      @return         boolean     false on fail
+     *      @return         EE_Base_Class[]     false on fail
      */
     public function get_all_prices_that_are_type($type = 0)
     {

Indentation +275 added lines, -275 removed lines

@@ -10,279 +10,279 @@
 class EEM_Price extends EEM_Soft_Delete_Base
 {
 
-    // private instance of the EEM_Price object
-    protected static $_instance = null;
-
-
-
-    /**
-     *      private constructor to prevent direct creation
-     *      @Constructor
-     *      @access protected
-     *      @param string $timezone string representing the timezone we want to set for returned Date Time Strings (and any incoming timezone data that gets saved).  Note this just sends the timezone info to the date time model field objects.  Default is NULL (and will be assumed using the set timezone in the 'timezone_string' wp option)
-     *      @return EEM_Price
-     */
-    protected function __construct($timezone)
-    {
-        require_once(EE_MODELS . 'EEM_Price_Type.model.php');
-        $this->singular_item = __('Price', 'event_espresso');
-        $this->plural_item = __('Prices', 'event_espresso');
-
-        $this->_tables = array(
-            'Price'=>new EE_Primary_Table('esp_price', 'PRC_ID')
-        );
-        $this->_fields = array(
-            'Price'=> array(
-                'PRC_ID'=>new EE_Primary_Key_Int_Field('PRC_ID', 'Price ID'),
-                'PRT_ID'=>new EE_Foreign_Key_Int_Field('PRT_ID', 'Price type Id', false, null, 'Price_Type'),
-                'PRC_amount'=>new EE_Money_Field('PRC_amount', 'Price Amount', false, 0),
-                'PRC_name'=>new EE_Plain_Text_Field('PRC_name', 'Name of Price', false, ''),
-                'PRC_desc'=>new EE_Post_Content_Field('PRC_desc', 'Price Description', false, ''),
-                'PRC_is_default'=>new EE_Boolean_Field('PRC_is_default', 'Flag indicating whether price is a default price', false, false),
-                'PRC_overrides'=>new EE_Integer_Field('PRC_overrides', 'Price ID for a global Price that will be overridden by this Price  ( for replacing default prices )', true, 0),
-                'PRC_order'=>new EE_Integer_Field('PRC_order', 'Order of Application of Price (lower numbers apply first?)', false, 1),
-                'PRC_deleted'=>new EE_Trashed_Flag_Field('PRC_deleted', 'Flag Indicating if this has been deleted or not', false, false),
-                'PRC_parent' => new EE_Integer_Field('PRC_parent', __('Indicates what PRC_ID is the parent of this PRC_ID', 'event_espresso'), true, 0),
-                'PRC_wp_user' => new EE_WP_User_Field('PRC_wp_user', __('Price Creator ID', 'event_espresso'), false),
-            )
-        );
-        $this->_model_relations = array(
-            'Ticket'=>new EE_HABTM_Relation('Ticket_Price'),
-            'Price_Type'=>new EE_Belongs_To_Relation(),
-            'WP_User' => new EE_Belongs_To_Relation(),
-        );
-        // this model is generally available for reading
-        $this->_cap_restriction_generators[ EEM_Base::caps_read ] = new EE_Restriction_Generator_Default_Public('PRC_is_default', 'Ticket.Datetime.Event');
-        // account for default tickets in the caps
-        $this->_cap_restriction_generators[ EEM_Base::caps_read_admin ] = new EE_Restriction_Generator_Default_Protected('PRC_is_default', 'Ticket.Datetime.Event');
-        $this->_cap_restriction_generators[ EEM_Base::caps_edit ] = new EE_Restriction_Generator_Default_Protected('PRC_is_default', 'Ticket.Datetime.Event');
-        $this->_cap_restriction_generators[ EEM_Base::caps_delete ] = new EE_Restriction_Generator_Default_Protected('PRC_is_default', 'Ticket.Datetime.Event');
-        parent::__construct($timezone);
-    }
-
-
-
-    /**
-     *      instantiate a new price object with blank/empty properties
-     *
-     *      @access     public
-     *      @return     mixed       array on success, FALSE on fail
-     */
-    public function get_new_price()
-    {
-        return $this->create_default_object();
-    }
-
-
-
-
-
-    /**
-     *      retrieve  ALL prices from db
-     *
-     *      @access     public
-     *      @return     EE_PRice[]
-     */
-    public function get_all_prices()
-    {
-        // retrieve all prices
-        return $this->get_all(array('order_by'=>array('PRC_amount'=>'ASC')));
-    }
-
-
-
-    /**
-     *        retrieve all active prices for a particular event
-     *
-     * @access        public
-     * @param int $EVT_ID
-     * @return array on success
-     */
-    public function get_all_event_prices($EVT_ID = 0)
-    {
-        return $this->get_all(array(
-            array(
-                'EVT_ID'=>$EVT_ID,
-                'Price_Type.PBT_ID'=>array('!=',  EEM_Price_Type::base_type_tax)
-            ),
-            'order_by'=>$this->_order_by_array_for_get_all_method()
-        ));
-    }
-
-
-    /**
-     *      retrieve all active global prices (that are not taxes (PBT_ID=4)) for a particular event
-     *
-     *      @access     public
-     *      @param      boolean         $count  return count
-     *      @return         array           on success
-     *      @return         boolean     false on fail
-     */
-    public function get_all_default_prices($count = false)
-    {
-        $_where = array(
-            'Price_Type.PBT_ID'=>array('!=',4),
-            'PRC_deleted' => 0,
-            'PRC_is_default' => 1
-        );
-        $_query_params = array(
-            $_where,
-            'order_by'=>$this->_order_by_array_for_get_all_method()
-        );
-        return $count ? $this->count(array($_where)) : $this->get_all($_query_params);
-    }
-
-
-
-
-
-
-
-
-
-
-    /**
-     *      retrieve all prices that are taxes
-     *
-     *      @access     public
-     *      @return         array               on success
-     *      @return         array top-level keys are the price's order and their values are an array,
-     *                      next-level keys are the price's ID, and their values are EE_Price objects
-     */
-    public function get_all_prices_that_are_taxes()
-    {
-        $taxes = array();
-        $all_taxes = $this->get_all(array(
-            array( 'Price_Type.PBT_ID'=>  EEM_Price_Type::base_type_tax ),
-            'order_by' => array( 'Price_Type.PRT_order' => 'ASC', 'PRC_order' => 'ASC' )
-        ));
-        foreach ($all_taxes as $tax) {
-            if ($tax instanceof EE_Price) {
-                $taxes[ $tax->order() ][ $tax->ID() ] = $tax;
-            }
-        }
-        return $taxes;
-    }
-
-
-
-
-
-    /**
-     *      retrieve all prices for an ticket plus default global prices, but not taxes
-     *
-     *      @access     public
-     *      @param int $TKT_ID          the id of the event.  If not included then we assume that this is a new ticket.
-     *      @return         boolean         false on fail
-     */
-    public function get_all_ticket_prices_for_admin($TKT_ID = 0)
-    {
-        $array_of_price_objects = array();
-        if (empty($TKT_ID)) {
-            // if there is no tkt, get prices with no tkt ID, are global, are not a tax, and are active
-            // return that list
-            $default_prices = $this->get_all_default_prices();
-
-            if ($default_prices) {
-                foreach ($default_prices as $price) {
-                    if ($price instanceof EE_Price) {
-                        $array_of_price_objects[ $price->type() ][] = $price;
-                    }
-                }
-                return $array_of_price_objects;
-            } else {
-                return array();
-            }
-        } else {
-            $ticket_prices = $this->get_all(array(
-                array(
-                    'TKT_ID'=>$TKT_ID,
-                    'PRC_deleted' => 0
-                    ),
-                'order_by'=> array('PRC_order' => 'ASC')
-            ));
-        }
-
-        if (!empty($ticket_prices)) {
-            foreach ($ticket_prices as $price) {
-                if ($price instanceof EE_Price) {
-                    $array_of_price_objects[ $price->type() ][] = $price;
-                }
-            }
-            return $array_of_price_objects;
-        } else {
-            return false;
-        }
-    }
-
-
-
-    /**
-     *        _sort_event_prices_by_type
-     *
-     * @access public
-     * @param \EE_Price $price_a
-     * @param \EE_Price $price_b
-     * @return bool false on fail
-     */
-    public function _sort_event_prices_by_type(EE_Price $price_a, EE_Price $price_b)
-    {
-        if ($price_a->type_obj()->order() == $price_b->type_obj()->order()) {
-            return $this->_sort_event_prices_by_order($price_a, $price_b);
-        }
-        return $price_a->type_obj()->order() < $price_b->type_obj()->order() ? -1 : 1;
-    }
-
-
-
-    /**
-     *        _sort_event_prices_by_order
-     *
-     * @access public
-     * @param \EE_Price $price_a
-     * @param \EE_Price $price_b
-     * @return bool false on fail
-     */
-    public function _sort_event_prices_by_order(EE_Price $price_a, EE_Price $price_b)
-    {
-        if ($price_a->order() == $price_b->order()) {
-            return 0;
-        }
-        return $price_a->order() < $price_b->order() ? -1 : 1;
-    }
-
-
-
-    /**
-     *      get all prices of a specific type
-     *
-     *      @access     public
-     *      @param      int                 $type - PRT_ID
-     *      @return         boolean     false on fail
-     */
-    public function get_all_prices_that_are_type($type = 0)
-    {
-        return $this->get_all(array(
-            array(
-                'PRT_ID'=>$type
-            ),
-            'order_by'=>$this->_order_by_array_for_get_all_method()
-        ));
-    }
-
-
-
-    /**
-     * Returns an array of the normal 'order_by' query parameter provided to the get_all query.
-     * Of course you don't have to use it, but this is the order we usually want to sort prices by
-     * @return array which can be used like so: $this->get_all(array(array(...where stuff...),'order_by'=>$this->_order_by_array_for_get_all_method()));
-     */
-    public function _order_by_array_for_get_all_method()
-    {
-        return array(
-                'PRC_order'=>'ASC',
-                'Price_Type.PRT_order'=>'ASC',
-                'PRC_ID'=>'ASC'
-        );
-    }
+	// private instance of the EEM_Price object
+	protected static $_instance = null;
+
+
+
+	/**
+	 *      private constructor to prevent direct creation
+	 *      @Constructor
+	 *      @access protected
+	 *      @param string $timezone string representing the timezone we want to set for returned Date Time Strings (and any incoming timezone data that gets saved).  Note this just sends the timezone info to the date time model field objects.  Default is NULL (and will be assumed using the set timezone in the 'timezone_string' wp option)
+	 *      @return EEM_Price
+	 */
+	protected function __construct($timezone)
+	{
+		require_once(EE_MODELS . 'EEM_Price_Type.model.php');
+		$this->singular_item = __('Price', 'event_espresso');
+		$this->plural_item = __('Prices', 'event_espresso');
+
+		$this->_tables = array(
+			'Price'=>new EE_Primary_Table('esp_price', 'PRC_ID')
+		);
+		$this->_fields = array(
+			'Price'=> array(
+				'PRC_ID'=>new EE_Primary_Key_Int_Field('PRC_ID', 'Price ID'),
+				'PRT_ID'=>new EE_Foreign_Key_Int_Field('PRT_ID', 'Price type Id', false, null, 'Price_Type'),
+				'PRC_amount'=>new EE_Money_Field('PRC_amount', 'Price Amount', false, 0),
+				'PRC_name'=>new EE_Plain_Text_Field('PRC_name', 'Name of Price', false, ''),
+				'PRC_desc'=>new EE_Post_Content_Field('PRC_desc', 'Price Description', false, ''),
+				'PRC_is_default'=>new EE_Boolean_Field('PRC_is_default', 'Flag indicating whether price is a default price', false, false),
+				'PRC_overrides'=>new EE_Integer_Field('PRC_overrides', 'Price ID for a global Price that will be overridden by this Price  ( for replacing default prices )', true, 0),
+				'PRC_order'=>new EE_Integer_Field('PRC_order', 'Order of Application of Price (lower numbers apply first?)', false, 1),
+				'PRC_deleted'=>new EE_Trashed_Flag_Field('PRC_deleted', 'Flag Indicating if this has been deleted or not', false, false),
+				'PRC_parent' => new EE_Integer_Field('PRC_parent', __('Indicates what PRC_ID is the parent of this PRC_ID', 'event_espresso'), true, 0),
+				'PRC_wp_user' => new EE_WP_User_Field('PRC_wp_user', __('Price Creator ID', 'event_espresso'), false),
+			)
+		);
+		$this->_model_relations = array(
+			'Ticket'=>new EE_HABTM_Relation('Ticket_Price'),
+			'Price_Type'=>new EE_Belongs_To_Relation(),
+			'WP_User' => new EE_Belongs_To_Relation(),
+		);
+		// this model is generally available for reading
+		$this->_cap_restriction_generators[ EEM_Base::caps_read ] = new EE_Restriction_Generator_Default_Public('PRC_is_default', 'Ticket.Datetime.Event');
+		// account for default tickets in the caps
+		$this->_cap_restriction_generators[ EEM_Base::caps_read_admin ] = new EE_Restriction_Generator_Default_Protected('PRC_is_default', 'Ticket.Datetime.Event');
+		$this->_cap_restriction_generators[ EEM_Base::caps_edit ] = new EE_Restriction_Generator_Default_Protected('PRC_is_default', 'Ticket.Datetime.Event');
+		$this->_cap_restriction_generators[ EEM_Base::caps_delete ] = new EE_Restriction_Generator_Default_Protected('PRC_is_default', 'Ticket.Datetime.Event');
+		parent::__construct($timezone);
+	}
+
+
+
+	/**
+	 *      instantiate a new price object with blank/empty properties
+	 *
+	 *      @access     public
+	 *      @return     mixed       array on success, FALSE on fail
+	 */
+	public function get_new_price()
+	{
+		return $this->create_default_object();
+	}
+
+
+
+
+
+	/**
+	 *      retrieve  ALL prices from db
+	 *
+	 *      @access     public
+	 *      @return     EE_PRice[]
+	 */
+	public function get_all_prices()
+	{
+		// retrieve all prices
+		return $this->get_all(array('order_by'=>array('PRC_amount'=>'ASC')));
+	}
+
+
+
+	/**
+	 *        retrieve all active prices for a particular event
+	 *
+	 * @access        public
+	 * @param int $EVT_ID
+	 * @return array on success
+	 */
+	public function get_all_event_prices($EVT_ID = 0)
+	{
+		return $this->get_all(array(
+			array(
+				'EVT_ID'=>$EVT_ID,
+				'Price_Type.PBT_ID'=>array('!=',  EEM_Price_Type::base_type_tax)
+			),
+			'order_by'=>$this->_order_by_array_for_get_all_method()
+		));
+	}
+
+
+	/**
+	 *      retrieve all active global prices (that are not taxes (PBT_ID=4)) for a particular event
+	 *
+	 *      @access     public
+	 *      @param      boolean         $count  return count
+	 *      @return         array           on success
+	 *      @return         boolean     false on fail
+	 */
+	public function get_all_default_prices($count = false)
+	{
+		$_where = array(
+			'Price_Type.PBT_ID'=>array('!=',4),
+			'PRC_deleted' => 0,
+			'PRC_is_default' => 1
+		);
+		$_query_params = array(
+			$_where,
+			'order_by'=>$this->_order_by_array_for_get_all_method()
+		);
+		return $count ? $this->count(array($_where)) : $this->get_all($_query_params);
+	}
+
+
+
+
+
+
+
+
+
+
+	/**
+	 *      retrieve all prices that are taxes
+	 *
+	 *      @access     public
+	 *      @return         array               on success
+	 *      @return         array top-level keys are the price's order and their values are an array,
+	 *                      next-level keys are the price's ID, and their values are EE_Price objects
+	 */
+	public function get_all_prices_that_are_taxes()
+	{
+		$taxes = array();
+		$all_taxes = $this->get_all(array(
+			array( 'Price_Type.PBT_ID'=>  EEM_Price_Type::base_type_tax ),
+			'order_by' => array( 'Price_Type.PRT_order' => 'ASC', 'PRC_order' => 'ASC' )
+		));
+		foreach ($all_taxes as $tax) {
+			if ($tax instanceof EE_Price) {
+				$taxes[ $tax->order() ][ $tax->ID() ] = $tax;
+			}
+		}
+		return $taxes;
+	}
+
+
+
+
+
+	/**
+	 *      retrieve all prices for an ticket plus default global prices, but not taxes
+	 *
+	 *      @access     public
+	 *      @param int $TKT_ID          the id of the event.  If not included then we assume that this is a new ticket.
+	 *      @return         boolean         false on fail
+	 */
+	public function get_all_ticket_prices_for_admin($TKT_ID = 0)
+	{
+		$array_of_price_objects = array();
+		if (empty($TKT_ID)) {
+			// if there is no tkt, get prices with no tkt ID, are global, are not a tax, and are active
+			// return that list
+			$default_prices = $this->get_all_default_prices();
+
+			if ($default_prices) {
+				foreach ($default_prices as $price) {
+					if ($price instanceof EE_Price) {
+						$array_of_price_objects[ $price->type() ][] = $price;
+					}
+				}
+				return $array_of_price_objects;
+			} else {
+				return array();
+			}
+		} else {
+			$ticket_prices = $this->get_all(array(
+				array(
+					'TKT_ID'=>$TKT_ID,
+					'PRC_deleted' => 0
+					),
+				'order_by'=> array('PRC_order' => 'ASC')
+			));
+		}
+
+		if (!empty($ticket_prices)) {
+			foreach ($ticket_prices as $price) {
+				if ($price instanceof EE_Price) {
+					$array_of_price_objects[ $price->type() ][] = $price;
+				}
+			}
+			return $array_of_price_objects;
+		} else {
+			return false;
+		}
+	}
+
+
+
+	/**
+	 *        _sort_event_prices_by_type
+	 *
+	 * @access public
+	 * @param \EE_Price $price_a
+	 * @param \EE_Price $price_b
+	 * @return bool false on fail
+	 */
+	public function _sort_event_prices_by_type(EE_Price $price_a, EE_Price $price_b)
+	{
+		if ($price_a->type_obj()->order() == $price_b->type_obj()->order()) {
+			return $this->_sort_event_prices_by_order($price_a, $price_b);
+		}
+		return $price_a->type_obj()->order() < $price_b->type_obj()->order() ? -1 : 1;
+	}
+
+
+
+	/**
+	 *        _sort_event_prices_by_order
+	 *
+	 * @access public
+	 * @param \EE_Price $price_a
+	 * @param \EE_Price $price_b
+	 * @return bool false on fail
+	 */
+	public function _sort_event_prices_by_order(EE_Price $price_a, EE_Price $price_b)
+	{
+		if ($price_a->order() == $price_b->order()) {
+			return 0;
+		}
+		return $price_a->order() < $price_b->order() ? -1 : 1;
+	}
+
+
+
+	/**
+	 *      get all prices of a specific type
+	 *
+	 *      @access     public
+	 *      @param      int                 $type - PRT_ID
+	 *      @return         boolean     false on fail
+	 */
+	public function get_all_prices_that_are_type($type = 0)
+	{
+		return $this->get_all(array(
+			array(
+				'PRT_ID'=>$type
+			),
+			'order_by'=>$this->_order_by_array_for_get_all_method()
+		));
+	}
+
+
+
+	/**
+	 * Returns an array of the normal 'order_by' query parameter provided to the get_all query.
+	 * Of course you don't have to use it, but this is the order we usually want to sort prices by
+	 * @return array which can be used like so: $this->get_all(array(array(...where stuff...),'order_by'=>$this->_order_by_array_for_get_all_method()));
+	 */
+	public function _order_by_array_for_get_all_method()
+	{
+		return array(
+				'PRC_order'=>'ASC',
+				'Price_Type.PRT_order'=>'ASC',
+				'PRC_ID'=>'ASC'
+		);
+	}
 }

Spacing +13 added lines, -13 removed lines

@@ -24,7 +24,7 @@ 
      */
     protected function __construct($timezone)
     {
-        require_once(EE_MODELS . 'EEM_Price_Type.model.php');
+        require_once(EE_MODELS.'EEM_Price_Type.model.php');
         $this->singular_item = __('Price', 'event_espresso');
         $this->plural_item = __('Prices', 'event_espresso');
 
@@ -52,11 +52,11 @@ 
             'WP_User' => new EE_Belongs_To_Relation(),
         );
         // this model is generally available for reading
-        $this->_cap_restriction_generators[ EEM_Base::caps_read ] = new EE_Restriction_Generator_Default_Public('PRC_is_default', 'Ticket.Datetime.Event');
+        $this->_cap_restriction_generators[EEM_Base::caps_read] = new EE_Restriction_Generator_Default_Public('PRC_is_default', 'Ticket.Datetime.Event');
         // account for default tickets in the caps
-        $this->_cap_restriction_generators[ EEM_Base::caps_read_admin ] = new EE_Restriction_Generator_Default_Protected('PRC_is_default', 'Ticket.Datetime.Event');
-        $this->_cap_restriction_generators[ EEM_Base::caps_edit ] = new EE_Restriction_Generator_Default_Protected('PRC_is_default', 'Ticket.Datetime.Event');
-        $this->_cap_restriction_generators[ EEM_Base::caps_delete ] = new EE_Restriction_Generator_Default_Protected('PRC_is_default', 'Ticket.Datetime.Event');
+        $this->_cap_restriction_generators[EEM_Base::caps_read_admin] = new EE_Restriction_Generator_Default_Protected('PRC_is_default', 'Ticket.Datetime.Event');
+        $this->_cap_restriction_generators[EEM_Base::caps_edit] = new EE_Restriction_Generator_Default_Protected('PRC_is_default', 'Ticket.Datetime.Event');
+        $this->_cap_restriction_generators[EEM_Base::caps_delete] = new EE_Restriction_Generator_Default_Protected('PRC_is_default', 'Ticket.Datetime.Event');
         parent::__construct($timezone);
     }
 
@@ -103,7 +103,7 @@ 
         return $this->get_all(array(
             array(
                 'EVT_ID'=>$EVT_ID,
-                'Price_Type.PBT_ID'=>array('!=',  EEM_Price_Type::base_type_tax)
+                'Price_Type.PBT_ID'=>array('!=', EEM_Price_Type::base_type_tax)
             ),
             'order_by'=>$this->_order_by_array_for_get_all_method()
         ));
@@ -121,7 +121,7 @@ 
     public function get_all_default_prices($count = false)
     {
         $_where = array(
-            'Price_Type.PBT_ID'=>array('!=',4),
+            'Price_Type.PBT_ID'=>array('!=', 4),
             'PRC_deleted' => 0,
             'PRC_is_default' => 1
         );
@@ -153,12 +153,12 @@ 
     {
         $taxes = array();
         $all_taxes = $this->get_all(array(
-            array( 'Price_Type.PBT_ID'=>  EEM_Price_Type::base_type_tax ),
-            'order_by' => array( 'Price_Type.PRT_order' => 'ASC', 'PRC_order' => 'ASC' )
+            array('Price_Type.PBT_ID'=>  EEM_Price_Type::base_type_tax),
+            'order_by' => array('Price_Type.PRT_order' => 'ASC', 'PRC_order' => 'ASC')
         ));
         foreach ($all_taxes as $tax) {
             if ($tax instanceof EE_Price) {
-                $taxes[ $tax->order() ][ $tax->ID() ] = $tax;
+                $taxes[$tax->order()][$tax->ID()] = $tax;
             }
         }
         return $taxes;
@@ -186,7 +186,7 @@ 
             if ($default_prices) {
                 foreach ($default_prices as $price) {
                     if ($price instanceof EE_Price) {
-                        $array_of_price_objects[ $price->type() ][] = $price;
+                        $array_of_price_objects[$price->type()][] = $price;
                     }
                 }
                 return $array_of_price_objects;
@@ -203,10 +203,10 @@ 
             ));
         }
 
-        if (!empty($ticket_prices)) {
+        if ( ! empty($ticket_prices)) {
             foreach ($ticket_prices as $price) {
                 if ($price instanceof EE_Price) {
-                    $array_of_price_objects[ $price->type() ][] = $price;
+                    $array_of_price_objects[$price->type()][] = $price;
                 }
             }
             return $array_of_price_objects;

core/db_models/EEM_Price_Type.model.php

Doc Comments +2 added lines, -2 removed lines

@@ -27,7 +27,7 @@ 
     /**
      * return an array of Base types. Keys are INTs which are used in the database,
      * values are text-representations of the base type.
-     * @return array
+     * @return integer
      */
     public function get_base_types()
     {
@@ -107,7 +107,7 @@ 
      *      instantiate a new price type object with blank/empty properties
      *
      *      @access     public
-     *      @return     mixed       array on success, FALSE on fail
+     *      @return     EE_Price_Type       array on success, FALSE on fail
      */
     public function get_new_price_type()
     {

Indentation +123 added lines, -123 removed lines

@@ -11,108 +11,108 @@ 
 class EEM_Price_Type extends EEM_Soft_Delete_Base
 {
 
-    // private instance of the Price Type object
-    protected static $_instance = null;
-    // An array of the price type objects
-    public $type = null;
-
-    /**
-    *   Price Base types
-    *
-    *   @access private
-    *   @var int
-    */
-    public $base_types = null;
-
-    /**
-     * return an array of Base types. Keys are INTs which are used in the database,
-     * values are text-representations of the base type.
-     * @return array
-     */
-    public function get_base_types()
-    {
-        return $this->base_types;
-    }
-
-    /**
-     * Gets the name of the base
-     * @param type $base_type_int
-     * @return type
-     */
-    public function get_base_type_name($base_type_int)
-    {
-        return $this->base_types[ $base_type_int ];
-    }
-
-    /**
-     * constants for price base types. In the DB, we decided to store the price base type
-     * as an integer. So, to avoid just having magic numbers everwhere (eg, querying for
-     * all price types with PBT_ID = 2), we define these constants, to make code more understandable.
-     * So, as an example, to query for all price types that are a tax, we'd do
-     * EEM_PRice_Type::instance()->get_all(array(array('PBT_ID'=>EEM_Price_Type::base_type_tax)))
-     * instead of
-     * EEM_Price_Type::instance()->get_all(array(array('PBT_ID'=>2)))
-     * Although the 2nd is shorter, it's much less obvious what it's doing. Also, should these magic IDs ever
-     * change, we can continue to use the constant, by simply change its value.
-     */
-    const base_type_base_price = 1;
-    const base_type_discount = 2;
-    const base_type_surcharge = 3;
-    const base_type_tax = 4;
-    /**
-     *      private constructor to prevent direct creation
-     *      @Constructor
-     *      @access protected
-     *      @return void
-     */
-    protected function __construct($timezone = null)
-    {
-        $this->base_types = array(
-            EEM_Price_Type::base_type_base_price => __('Price', 'event_espresso'),
-            EEM_Price_Type::base_type_discount => __('Discount', 'event_espresso'),
-            EEM_Price_Type::base_type_surcharge => __('Surcharge', 'event_espresso'),
-            EEM_Price_Type::base_type_tax => __('Tax', 'event_espresso') );
-        $this->singular_item = __('Price Type', 'event_espresso');
-        $this->plural_item = __('Price Types', 'event_espresso');
-
-        $this->_tables = array(
-            'Price_Type'=>new EE_Primary_Table('esp_price_type', 'PRT_ID')
-        );
-        $this->_fields = array(
-            'Price_Type'=>array(
-                'PRT_ID'=>new EE_Primary_Key_Int_Field('PRT_ID', __('Price Type ID', 'event_espresso')),
-                'PRT_name'=>new EE_Plain_Text_Field('PRT_name', __('Price Type Name', 'event_espresso'), false, ''),
-                'PBT_ID'=>new EE_Enum_Integer_Field('PBT_ID', __('Price Base type ID, 1 = Price , 2 = Discount , 3 = Surcharge , 4 = Tax', 'event_espresso'), false, EEM_Price_Type::base_type_base_price, $this->base_types),
-                'PRT_is_percent'=>new EE_Boolean_Field('PRT_is_percent', __('Flag indicating price is a percentage', 'event_espresso'), false, false),
-                'PRT_order'=>new EE_Integer_Field('PRT_order', __('Order in which price should be applied. ', 'event_espresso'), false, 0),
-                'PRT_deleted'=>new EE_Trashed_Flag_Field('PRT_deleted', __('Flag indicating price type has been trashed', 'event_espresso'), false, false),
-                'PRT_wp_user' => new EE_WP_User_Field('PRT_wp_user', __('Price Type Creator ID', 'event_espresso'), false),
-            )
-        );
-        $this->_model_relations = array(
-            'Price'=>new EE_Has_Many_Relation(),
-            'WP_User' => new EE_Belongs_To_Relation(),
-        );
-        // this model is generally available for reading
-        $this->_cap_restriction_generators[ EEM_Base::caps_read ] = new EE_Restriction_Generator_Public();
-        // all price types are "default" in terms of capability names
-        $this->_caps_slug = 'default_price_types';
-        parent::__construct($timezone);
-    }
-
-
-
-
-    /**
-     *      instantiate a new price type object with blank/empty properties
-     *
-     *      @access     public
-     *      @return     mixed       array on success, FALSE on fail
-     */
-    public function get_new_price_type()
-    {
-        return EE_Price_Type::new_instance();
-    }
+	// private instance of the Price Type object
+	protected static $_instance = null;
+	// An array of the price type objects
+	public $type = null;
+
+	/**
+	 *   Price Base types
+	 *
+	 *   @access private
+	 *   @var int
+	 */
+	public $base_types = null;
+
+	/**
+	 * return an array of Base types. Keys are INTs which are used in the database,
+	 * values are text-representations of the base type.
+	 * @return array
+	 */
+	public function get_base_types()
+	{
+		return $this->base_types;
+	}
+
+	/**
+	 * Gets the name of the base
+	 * @param type $base_type_int
+	 * @return type
+	 */
+	public function get_base_type_name($base_type_int)
+	{
+		return $this->base_types[ $base_type_int ];
+	}
+
+	/**
+	 * constants for price base types. In the DB, we decided to store the price base type
+	 * as an integer. So, to avoid just having magic numbers everwhere (eg, querying for
+	 * all price types with PBT_ID = 2), we define these constants, to make code more understandable.
+	 * So, as an example, to query for all price types that are a tax, we'd do
+	 * EEM_PRice_Type::instance()->get_all(array(array('PBT_ID'=>EEM_Price_Type::base_type_tax)))
+	 * instead of
+	 * EEM_Price_Type::instance()->get_all(array(array('PBT_ID'=>2)))
+	 * Although the 2nd is shorter, it's much less obvious what it's doing. Also, should these magic IDs ever
+	 * change, we can continue to use the constant, by simply change its value.
+	 */
+	const base_type_base_price = 1;
+	const base_type_discount = 2;
+	const base_type_surcharge = 3;
+	const base_type_tax = 4;
+	/**
+	 *      private constructor to prevent direct creation
+	 *      @Constructor
+	 *      @access protected
+	 *      @return void
+	 */
+	protected function __construct($timezone = null)
+	{
+		$this->base_types = array(
+			EEM_Price_Type::base_type_base_price => __('Price', 'event_espresso'),
+			EEM_Price_Type::base_type_discount => __('Discount', 'event_espresso'),
+			EEM_Price_Type::base_type_surcharge => __('Surcharge', 'event_espresso'),
+			EEM_Price_Type::base_type_tax => __('Tax', 'event_espresso') );
+		$this->singular_item = __('Price Type', 'event_espresso');
+		$this->plural_item = __('Price Types', 'event_espresso');
+
+		$this->_tables = array(
+			'Price_Type'=>new EE_Primary_Table('esp_price_type', 'PRT_ID')
+		);
+		$this->_fields = array(
+			'Price_Type'=>array(
+				'PRT_ID'=>new EE_Primary_Key_Int_Field('PRT_ID', __('Price Type ID', 'event_espresso')),
+				'PRT_name'=>new EE_Plain_Text_Field('PRT_name', __('Price Type Name', 'event_espresso'), false, ''),
+				'PBT_ID'=>new EE_Enum_Integer_Field('PBT_ID', __('Price Base type ID, 1 = Price , 2 = Discount , 3 = Surcharge , 4 = Tax', 'event_espresso'), false, EEM_Price_Type::base_type_base_price, $this->base_types),
+				'PRT_is_percent'=>new EE_Boolean_Field('PRT_is_percent', __('Flag indicating price is a percentage', 'event_espresso'), false, false),
+				'PRT_order'=>new EE_Integer_Field('PRT_order', __('Order in which price should be applied. ', 'event_espresso'), false, 0),
+				'PRT_deleted'=>new EE_Trashed_Flag_Field('PRT_deleted', __('Flag indicating price type has been trashed', 'event_espresso'), false, false),
+				'PRT_wp_user' => new EE_WP_User_Field('PRT_wp_user', __('Price Type Creator ID', 'event_espresso'), false),
+			)
+		);
+		$this->_model_relations = array(
+			'Price'=>new EE_Has_Many_Relation(),
+			'WP_User' => new EE_Belongs_To_Relation(),
+		);
+		// this model is generally available for reading
+		$this->_cap_restriction_generators[ EEM_Base::caps_read ] = new EE_Restriction_Generator_Public();
+		// all price types are "default" in terms of capability names
+		$this->_caps_slug = 'default_price_types';
+		parent::__construct($timezone);
+	}
+
+
+
+
+	/**
+	 *      instantiate a new price type object with blank/empty properties
+	 *
+	 *      @access     public
+	 *      @return     mixed       array on success, FALSE on fail
+	 */
+	public function get_new_price_type()
+	{
+		return EE_Price_Type::new_instance();
+	}
 
 
 
@@ -131,33 +131,33 @@ 
  *
  * @param type $query_params
  * @param boolean $allow_blocking if TRUE, matched objects will only be deleted if there is no related model info
-     * that blocks it (ie, there' sno other data that depends on this data); if false, deletes regardless of other objects
-     * which may depend on it. Its generally advisable to always leave this as TRUE, otherwise you could easily corrupt your DB
+ * that blocks it (ie, there' sno other data that depends on this data); if false, deletes regardless of other objects
+ * which may depend on it. Its generally advisable to always leave this as TRUE, otherwise you could easily corrupt your DB
  * @return boolean
  */
-    public function delete_permanently($query_params = array(), $allow_blocking = true)
-    {
+	public function delete_permanently($query_params = array(), $allow_blocking = true)
+	{
 
-        $would_be_deleted_price_types = $this->get_all_deleted_and_undeleted($query_params);
-        $would_be_deleted_price_type_ids = array_keys($would_be_deleted_price_types);
+		$would_be_deleted_price_types = $this->get_all_deleted_and_undeleted($query_params);
+		$would_be_deleted_price_type_ids = array_keys($would_be_deleted_price_types);
 
-        $ID = $query_params[0][ $this->get_primary_key_field()->get_name() ];
+		$ID = $query_params[0][ $this->get_primary_key_field()->get_name() ];
 
-        // check if any prices use this price type
-        $prc_query_params = array(array('PRT_ID'=>array('IN',$would_be_deleted_price_type_ids)));
-        if ($prices = $this->get_all_related($ID, 'Price', $prc_query_params)) {
-            $prices_names_and_ids = array();
-            foreach ($prices as $price) {
-                /* @var $price EE_Price */
-                $prices_names_and_ids[] = $price->name()."(".$price->ID().")";
-            }
-            $msg = sprintf(__('The Price Type(s) could not be deleted because there are existing Prices that currently use this Price Type.  If you still wish to delete this Price Type, then either delete those Prices or change them to use other Price Types.The prices are: %s', 'event_espresso'), implode(",", $prices_names_and_ids));
-            EE_Error::add_error($msg, __FILE__, __FUNCTION__, __LINE__);
-            return false;
-        }
+		// check if any prices use this price type
+		$prc_query_params = array(array('PRT_ID'=>array('IN',$would_be_deleted_price_type_ids)));
+		if ($prices = $this->get_all_related($ID, 'Price', $prc_query_params)) {
+			$prices_names_and_ids = array();
+			foreach ($prices as $price) {
+				/* @var $price EE_Price */
+				$prices_names_and_ids[] = $price->name()."(".$price->ID().")";
+			}
+			$msg = sprintf(__('The Price Type(s) could not be deleted because there are existing Prices that currently use this Price Type.  If you still wish to delete this Price Type, then either delete those Prices or change them to use other Price Types.The prices are: %s', 'event_espresso'), implode(",", $prices_names_and_ids));
+			EE_Error::add_error($msg, __FILE__, __FUNCTION__, __LINE__);
+			return false;
+		}
 
 
 
-        return parent::delete_permanently($query_params);
-    }
+		return parent::delete_permanently($query_params);
+	}
 }

Spacing +4 added lines, -4 removed lines

@@ -41,7 +41,7 @@ 
      */
     public function get_base_type_name($base_type_int)
     {
-        return $this->base_types[ $base_type_int ];
+        return $this->base_types[$base_type_int];
     }
 
     /**
@@ -94,7 +94,7 @@ 
             'WP_User' => new EE_Belongs_To_Relation(),
         );
         // this model is generally available for reading
-        $this->_cap_restriction_generators[ EEM_Base::caps_read ] = new EE_Restriction_Generator_Public();
+        $this->_cap_restriction_generators[EEM_Base::caps_read] = new EE_Restriction_Generator_Public();
         // all price types are "default" in terms of capability names
         $this->_caps_slug = 'default_price_types';
         parent::__construct($timezone);
@@ -141,10 +141,10 @@ 
         $would_be_deleted_price_types = $this->get_all_deleted_and_undeleted($query_params);
         $would_be_deleted_price_type_ids = array_keys($would_be_deleted_price_types);
 
-        $ID = $query_params[0][ $this->get_primary_key_field()->get_name() ];
+        $ID = $query_params[0][$this->get_primary_key_field()->get_name()];
 
         // check if any prices use this price type
-        $prc_query_params = array(array('PRT_ID'=>array('IN',$would_be_deleted_price_type_ids)));
+        $prc_query_params = array(array('PRT_ID'=>array('IN', $would_be_deleted_price_type_ids)));
         if ($prices = $this->get_all_related($ID, 'Price', $prc_query_params)) {
             $prices_names_and_ids = array();
             foreach ($prices as $price) {