eventespresso / event-espresso-core

core/EE_Configurable.core.php

Indentation +139 added lines, -139 removed lines

@@ -10,143 +10,143 @@
 abstract class EE_Configurable extends EE_Base
 {
 
-    /**
-     * @var $_config
-     * @type EE_Config_Base
-     */
-    protected $_config;
-
-    /**
-     * @var $_config_section
-     * @type string
-     */
-    protected $_config_section = '';
-
-    /**
-     * @var $_config_class
-     * @type string
-     */
-    protected $_config_class = '';
-
-    /**
-     * @var $_config_name
-     * @type string
-     */
-    protected $_config_name = '';
-
-
-    /**
-     * @param string $config_section
-     */
-    public function set_config_section($config_section = '')
-    {
-        $this->_config_section = ! empty($config_section) ? $config_section : 'modules';
-    }
-
-
-    /**
-     * @return mixed
-     */
-    public function config_section()
-    {
-        return $this->_config_section;
-    }
-
-
-    /**
-     * @param string $config_class
-     */
-    public function set_config_class($config_class = '')
-    {
-        $this->_config_class = $config_class;
-    }
-
-
-    /**
-     * @return mixed
-     */
-    public function config_class()
-    {
-        return $this->_config_class;
-    }
-
-
-    /**
-     * @param mixed $config_name
-     */
-    public function set_config_name($config_name)
-    {
-        $this->_config_name = ! empty($config_name) ? $config_name : get_called_class();
-    }
-
-
-    /**
-     * @return mixed
-     */
-    public function config_name()
-    {
-        return $this->_config_name;
-    }
-
-
-    /**
-     *    set_config
-     *    this method integrates directly with EE_Config to set up the config object for this class
-     *
-     * @access    protected
-     * @param    EE_Config_Base $config_obj
-     * @return    mixed    EE_Config_Base | NULL
-     */
-    protected function _set_config(EE_Config_Base $config_obj = null)
-    {
-        return EE_Config::instance()->set_config(
-            $this->config_section(),
-            $this->config_name(),
-            $this->config_class(),
-            $config_obj
-        );
-    }
-
-
-    /**
-     *    _update_config
-     *    this method integrates directly with EE_Config to update an existing config object for this class
-     *
-     * @access    protected
-     * @param    EE_Config_Base $config_obj
-     * @throws \EE_Error
-     * @return    mixed    EE_Config_Base | NULL
-     */
-    public function _update_config(EE_Config_Base $config_obj = null)
-    {
-        $config_class = $this->config_class();
-        if (! $config_obj instanceof $config_class) {
-            throw new EE_Error(
-                sprintf(
-                    __('The "%1$s" class is not an instance of %2$s.', 'event_espresso'),
-                    print_r($config_obj, true),
-                    $config_class
-                )
-            );
-        }
-        return EE_Config::instance()->update_config($this->config_section(), $this->config_name(), $config_obj);
-    }
-
-
-    /**
-     * gets the class's config object
-     *
-     * @return EE_Config_Base
-     */
-    public function config()
-    {
-        if (empty($this->_config)) {
-            $this->_config = EE_Config::instance()->get_config(
-                $this->config_section(),
-                $this->config_name(),
-                $this->config_class()
-            );
-        }
-        return $this->_config;
-    }
+	/**
+	 * @var $_config
+	 * @type EE_Config_Base
+	 */
+	protected $_config;
+
+	/**
+	 * @var $_config_section
+	 * @type string
+	 */
+	protected $_config_section = '';
+
+	/**
+	 * @var $_config_class
+	 * @type string
+	 */
+	protected $_config_class = '';
+
+	/**
+	 * @var $_config_name
+	 * @type string
+	 */
+	protected $_config_name = '';
+
+
+	/**
+	 * @param string $config_section
+	 */
+	public function set_config_section($config_section = '')
+	{
+		$this->_config_section = ! empty($config_section) ? $config_section : 'modules';
+	}
+
+
+	/**
+	 * @return mixed
+	 */
+	public function config_section()
+	{
+		return $this->_config_section;
+	}
+
+
+	/**
+	 * @param string $config_class
+	 */
+	public function set_config_class($config_class = '')
+	{
+		$this->_config_class = $config_class;
+	}
+
+
+	/**
+	 * @return mixed
+	 */
+	public function config_class()
+	{
+		return $this->_config_class;
+	}
+
+
+	/**
+	 * @param mixed $config_name
+	 */
+	public function set_config_name($config_name)
+	{
+		$this->_config_name = ! empty($config_name) ? $config_name : get_called_class();
+	}
+
+
+	/**
+	 * @return mixed
+	 */
+	public function config_name()
+	{
+		return $this->_config_name;
+	}
+
+
+	/**
+	 *    set_config
+	 *    this method integrates directly with EE_Config to set up the config object for this class
+	 *
+	 * @access    protected
+	 * @param    EE_Config_Base $config_obj
+	 * @return    mixed    EE_Config_Base | NULL
+	 */
+	protected function _set_config(EE_Config_Base $config_obj = null)
+	{
+		return EE_Config::instance()->set_config(
+			$this->config_section(),
+			$this->config_name(),
+			$this->config_class(),
+			$config_obj
+		);
+	}
+
+
+	/**
+	 *    _update_config
+	 *    this method integrates directly with EE_Config to update an existing config object for this class
+	 *
+	 * @access    protected
+	 * @param    EE_Config_Base $config_obj
+	 * @throws \EE_Error
+	 * @return    mixed    EE_Config_Base | NULL
+	 */
+	public function _update_config(EE_Config_Base $config_obj = null)
+	{
+		$config_class = $this->config_class();
+		if (! $config_obj instanceof $config_class) {
+			throw new EE_Error(
+				sprintf(
+					__('The "%1$s" class is not an instance of %2$s.', 'event_espresso'),
+					print_r($config_obj, true),
+					$config_class
+				)
+			);
+		}
+		return EE_Config::instance()->update_config($this->config_section(), $this->config_name(), $config_obj);
+	}
+
+
+	/**
+	 * gets the class's config object
+	 *
+	 * @return EE_Config_Base
+	 */
+	public function config()
+	{
+		if (empty($this->_config)) {
+			$this->_config = EE_Config::instance()->get_config(
+				$this->config_section(),
+				$this->config_name(),
+				$this->config_class()
+			);
+		}
+		return $this->_config;
+	}
 }

Spacing +1 added lines, -1 removed lines

@@ -120,7 +120,7 @@
     public function _update_config(EE_Config_Base $config_obj = null)
     {
         $config_class = $this->config_class();
-        if (! $config_obj instanceof $config_class) {
+        if ( ! $config_obj instanceof $config_class) {
             throw new EE_Error(
                 sprintf(
                     __('The "%1$s" class is not an instance of %2$s.', 'event_espresso'),

core/db_models/EEM_Term_Taxonomy.model.php

Indentation +116 added lines, -116 removed lines

@@ -10,128 +10,128 @@
 class EEM_Term_Taxonomy extends EEM_Base
 {
 
-    // private instance of the Attendee object
-    protected static $_instance = null;
+	// private instance of the Attendee object
+	protected static $_instance = null;
 
 
 
-    protected function __construct($timezone = null)
-    {
-        $this->singular_item = __('Term Taxonomy', 'event_espresso');
-        $this->plural_item = __('Term Taxonomy', 'event_espresso');
-        $this->_tables = array(
-            'Term_Taxonomy' => new EE_Primary_Table('term_taxonomy', 'term_taxonomy_id'),
-        );
-        $this->_fields = array(
-            'Term_Taxonomy' => array(
-                'term_taxonomy_id' => new EE_Primary_Key_Int_Field(
-                    'term_taxonomy_id',
-                    __('Term-Taxonomy ID', 'event_espresso')
-                ),
-                'term_id'          => new EE_Foreign_Key_Int_Field(
-                    'term_id',
-                    __("Term Id", "event_espresso"),
-                    false,
-                    0,
-                    'Term'
-                ),
-                'taxonomy'         => new EE_Plain_Text_Field(
-                    'taxonomy',
-                    __('Taxonomy Name', 'event_espresso'),
-                    false,
-                    'category'
-                ),
-                'description'      => new EE_Post_Content_Field(
-                    'description',
-                    __("Description of Term", "event_espresso"),
-                    false,
-                    ''
-                ),
-                'parent'           => new EE_Integer_Field('parent', __("Parent Term ID", "event_espresso"), false, 0),
-                'term_count'       => new EE_Integer_Field(
-                    'count',
-                    __("Count of Objects attached", 'event_espresso'),
-                    false,
-                    0
-                ),
-            ),
-        );
-        $this->_model_relations = array(
-            'Term_Relationship' => new EE_Has_Many_Relation(),
-            'Term'              => new EE_Belongs_To_Relation(),
-        );
-        $cpt_models = array_keys(EE_Registry::instance()->cpt_models());
-        foreach ($cpt_models as $model_name) {
-            $this->_model_relations[ $model_name ] = new EE_HABTM_Relation('Term_Relationship');
-        }
-        $this->_wp_core_model = true;
-        $this->_indexes = array(
-            'term_id_taxonomy' => new EE_Unique_Index(array('term_id', 'taxonomy')),
-        );
-        $path_to_tax_model = '';
-        $this->_cap_restriction_generators[ EEM_Base::caps_read ] = new EE_Restriction_Generator_Public();
-        $this->_cap_restriction_generators[ EEM_Base::caps_read_admin ] = new EE_Restriction_Generator_Taxonomy_Protected(
-            $path_to_tax_model
-        );
-        $this->_cap_restriction_generators[ EEM_Base::caps_edit ] = false;
-        $this->_cap_restriction_generators[ EEM_Base::caps_delete ] = false;
-        // add cap restrictions for editing relating to the "ee_edit_*"
-        $this->_cap_restrictions[ EEM_Base::caps_edit ]['ee_edit_event_category'] = new EE_Default_Where_Conditions(
-            array(
-                $path_to_tax_model . 'taxonomy*ee_edit_event_category' => array('!=', 'espresso_event_categories'),
-            )
-        );
-        $this->_cap_restrictions[ EEM_Base::caps_edit ]['ee_edit_venue_category'] = new EE_Default_Where_Conditions(
-            array(
-                $path_to_tax_model . 'taxonomy*ee_edit_venue_category' => array('!=', 'espresso_venue_categories'),
-            )
-        );
-        $this->_cap_restrictions[ EEM_Base::caps_edit ]['ee_edit_event_type'] = new EE_Default_Where_Conditions(
-            array(
-                $path_to_tax_model . 'taxonomy*ee_edit_event_type' => array('!=', 'espresso_event_type'),
-            )
-        );
-        // add cap restrictions for deleting relating to the "ee_deleting_*"
-        $this->_cap_restrictions[ EEM_Base::caps_delete ]['ee_delete_event_category'] = new EE_Default_Where_Conditions(
-            array(
-                $path_to_tax_model . 'taxonomy*ee_delete_event_category' => array('!=', 'espresso_event_categories'),
-            )
-        );
-        $this->_cap_restrictions[ EEM_Base::caps_delete ]['ee_delete_venue_category'] = new EE_Default_Where_Conditions(
-            array(
-                $path_to_tax_model . 'taxonomy*ee_delete_venue_category' => array('!=', 'espresso_venue_categories'),
-            )
-        );
-        $this->_cap_restrictions[ EEM_Base::caps_delete ]['ee_delete_event_type'] = new EE_Default_Where_Conditions(
-            array(
-                $path_to_tax_model . 'taxonomy*ee_delete_event_type' => array('!=', 'espresso_event_type'),
-            )
-        );
-        parent::__construct($timezone);
-        add_filter('FHEE__Read__create_model_query_params', array('EEM_Term_Taxonomy', 'rest_api_query_params'), 10, 3);
-    }
+	protected function __construct($timezone = null)
+	{
+		$this->singular_item = __('Term Taxonomy', 'event_espresso');
+		$this->plural_item = __('Term Taxonomy', 'event_espresso');
+		$this->_tables = array(
+			'Term_Taxonomy' => new EE_Primary_Table('term_taxonomy', 'term_taxonomy_id'),
+		);
+		$this->_fields = array(
+			'Term_Taxonomy' => array(
+				'term_taxonomy_id' => new EE_Primary_Key_Int_Field(
+					'term_taxonomy_id',
+					__('Term-Taxonomy ID', 'event_espresso')
+				),
+				'term_id'          => new EE_Foreign_Key_Int_Field(
+					'term_id',
+					__("Term Id", "event_espresso"),
+					false,
+					0,
+					'Term'
+				),
+				'taxonomy'         => new EE_Plain_Text_Field(
+					'taxonomy',
+					__('Taxonomy Name', 'event_espresso'),
+					false,
+					'category'
+				),
+				'description'      => new EE_Post_Content_Field(
+					'description',
+					__("Description of Term", "event_espresso"),
+					false,
+					''
+				),
+				'parent'           => new EE_Integer_Field('parent', __("Parent Term ID", "event_espresso"), false, 0),
+				'term_count'       => new EE_Integer_Field(
+					'count',
+					__("Count of Objects attached", 'event_espresso'),
+					false,
+					0
+				),
+			),
+		);
+		$this->_model_relations = array(
+			'Term_Relationship' => new EE_Has_Many_Relation(),
+			'Term'              => new EE_Belongs_To_Relation(),
+		);
+		$cpt_models = array_keys(EE_Registry::instance()->cpt_models());
+		foreach ($cpt_models as $model_name) {
+			$this->_model_relations[ $model_name ] = new EE_HABTM_Relation('Term_Relationship');
+		}
+		$this->_wp_core_model = true;
+		$this->_indexes = array(
+			'term_id_taxonomy' => new EE_Unique_Index(array('term_id', 'taxonomy')),
+		);
+		$path_to_tax_model = '';
+		$this->_cap_restriction_generators[ EEM_Base::caps_read ] = new EE_Restriction_Generator_Public();
+		$this->_cap_restriction_generators[ EEM_Base::caps_read_admin ] = new EE_Restriction_Generator_Taxonomy_Protected(
+			$path_to_tax_model
+		);
+		$this->_cap_restriction_generators[ EEM_Base::caps_edit ] = false;
+		$this->_cap_restriction_generators[ EEM_Base::caps_delete ] = false;
+		// add cap restrictions for editing relating to the "ee_edit_*"
+		$this->_cap_restrictions[ EEM_Base::caps_edit ]['ee_edit_event_category'] = new EE_Default_Where_Conditions(
+			array(
+				$path_to_tax_model . 'taxonomy*ee_edit_event_category' => array('!=', 'espresso_event_categories'),
+			)
+		);
+		$this->_cap_restrictions[ EEM_Base::caps_edit ]['ee_edit_venue_category'] = new EE_Default_Where_Conditions(
+			array(
+				$path_to_tax_model . 'taxonomy*ee_edit_venue_category' => array('!=', 'espresso_venue_categories'),
+			)
+		);
+		$this->_cap_restrictions[ EEM_Base::caps_edit ]['ee_edit_event_type'] = new EE_Default_Where_Conditions(
+			array(
+				$path_to_tax_model . 'taxonomy*ee_edit_event_type' => array('!=', 'espresso_event_type'),
+			)
+		);
+		// add cap restrictions for deleting relating to the "ee_deleting_*"
+		$this->_cap_restrictions[ EEM_Base::caps_delete ]['ee_delete_event_category'] = new EE_Default_Where_Conditions(
+			array(
+				$path_to_tax_model . 'taxonomy*ee_delete_event_category' => array('!=', 'espresso_event_categories'),
+			)
+		);
+		$this->_cap_restrictions[ EEM_Base::caps_delete ]['ee_delete_venue_category'] = new EE_Default_Where_Conditions(
+			array(
+				$path_to_tax_model . 'taxonomy*ee_delete_venue_category' => array('!=', 'espresso_venue_categories'),
+			)
+		);
+		$this->_cap_restrictions[ EEM_Base::caps_delete ]['ee_delete_event_type'] = new EE_Default_Where_Conditions(
+			array(
+				$path_to_tax_model . 'taxonomy*ee_delete_event_type' => array('!=', 'espresso_event_type'),
+			)
+		);
+		parent::__construct($timezone);
+		add_filter('FHEE__Read__create_model_query_params', array('EEM_Term_Taxonomy', 'rest_api_query_params'), 10, 3);
+	}
 
 
 
-    /**
-     * Makes sure that during REST API queries, we only return term-taxonomies
-     * for term taxonomies which should be shown in the rest api
-     *
-     * @param array    $model_query_params
-     * @param array    $querystring_query_params
-     * @param EEM_Base $model
-     * @return array
-     */
-    public static function rest_api_query_params($model_query_params, $querystring_query_params, $model)
-    {
-        if ($model === EEM_Term_Taxonomy::instance()) {
-            $taxonomies = get_taxonomies(array('show_in_rest' => true));
-            if (! empty($taxonomies)) {
-                $model_query_params[0]['taxonomy'] = array('IN', $taxonomies);
-            }
-        }
-        return $model_query_params;
-    }
+	/**
+	 * Makes sure that during REST API queries, we only return term-taxonomies
+	 * for term taxonomies which should be shown in the rest api
+	 *
+	 * @param array    $model_query_params
+	 * @param array    $querystring_query_params
+	 * @param EEM_Base $model
+	 * @return array
+	 */
+	public static function rest_api_query_params($model_query_params, $querystring_query_params, $model)
+	{
+		if ($model === EEM_Term_Taxonomy::instance()) {
+			$taxonomies = get_taxonomies(array('show_in_rest' => true));
+			if (! empty($taxonomies)) {
+				$model_query_params[0]['taxonomy'] = array('IN', $taxonomies);
+			}
+		}
+		return $model_query_params;
+	}
 }
 // End of file EEM_Term_Taxonomy.model.php
 // Location: /includes/models/EEM_Term_Taxonomy.model.php

Spacing +18 added lines, -18 removed lines

@@ -62,49 +62,49 @@ 
         );
         $cpt_models = array_keys(EE_Registry::instance()->cpt_models());
         foreach ($cpt_models as $model_name) {
-            $this->_model_relations[ $model_name ] = new EE_HABTM_Relation('Term_Relationship');
+            $this->_model_relations[$model_name] = new EE_HABTM_Relation('Term_Relationship');
         }
         $this->_wp_core_model = true;
         $this->_indexes = array(
             'term_id_taxonomy' => new EE_Unique_Index(array('term_id', 'taxonomy')),
         );
         $path_to_tax_model = '';
-        $this->_cap_restriction_generators[ EEM_Base::caps_read ] = new EE_Restriction_Generator_Public();
-        $this->_cap_restriction_generators[ EEM_Base::caps_read_admin ] = new EE_Restriction_Generator_Taxonomy_Protected(
+        $this->_cap_restriction_generators[EEM_Base::caps_read] = new EE_Restriction_Generator_Public();
+        $this->_cap_restriction_generators[EEM_Base::caps_read_admin] = new EE_Restriction_Generator_Taxonomy_Protected(
             $path_to_tax_model
         );
-        $this->_cap_restriction_generators[ EEM_Base::caps_edit ] = false;
-        $this->_cap_restriction_generators[ EEM_Base::caps_delete ] = false;
+        $this->_cap_restriction_generators[EEM_Base::caps_edit] = false;
+        $this->_cap_restriction_generators[EEM_Base::caps_delete] = false;
         // add cap restrictions for editing relating to the "ee_edit_*"
-        $this->_cap_restrictions[ EEM_Base::caps_edit ]['ee_edit_event_category'] = new EE_Default_Where_Conditions(
+        $this->_cap_restrictions[EEM_Base::caps_edit]['ee_edit_event_category'] = new EE_Default_Where_Conditions(
             array(
-                $path_to_tax_model . 'taxonomy*ee_edit_event_category' => array('!=', 'espresso_event_categories'),
+                $path_to_tax_model.'taxonomy*ee_edit_event_category' => array('!=', 'espresso_event_categories'),
             )
         );
-        $this->_cap_restrictions[ EEM_Base::caps_edit ]['ee_edit_venue_category'] = new EE_Default_Where_Conditions(
+        $this->_cap_restrictions[EEM_Base::caps_edit]['ee_edit_venue_category'] = new EE_Default_Where_Conditions(
             array(
-                $path_to_tax_model . 'taxonomy*ee_edit_venue_category' => array('!=', 'espresso_venue_categories'),
+                $path_to_tax_model.'taxonomy*ee_edit_venue_category' => array('!=', 'espresso_venue_categories'),
             )
         );
-        $this->_cap_restrictions[ EEM_Base::caps_edit ]['ee_edit_event_type'] = new EE_Default_Where_Conditions(
+        $this->_cap_restrictions[EEM_Base::caps_edit]['ee_edit_event_type'] = new EE_Default_Where_Conditions(
             array(
-                $path_to_tax_model . 'taxonomy*ee_edit_event_type' => array('!=', 'espresso_event_type'),
+                $path_to_tax_model.'taxonomy*ee_edit_event_type' => array('!=', 'espresso_event_type'),
             )
         );
         // add cap restrictions for deleting relating to the "ee_deleting_*"
-        $this->_cap_restrictions[ EEM_Base::caps_delete ]['ee_delete_event_category'] = new EE_Default_Where_Conditions(
+        $this->_cap_restrictions[EEM_Base::caps_delete]['ee_delete_event_category'] = new EE_Default_Where_Conditions(
             array(
-                $path_to_tax_model . 'taxonomy*ee_delete_event_category' => array('!=', 'espresso_event_categories'),
+                $path_to_tax_model.'taxonomy*ee_delete_event_category' => array('!=', 'espresso_event_categories'),
             )
         );
-        $this->_cap_restrictions[ EEM_Base::caps_delete ]['ee_delete_venue_category'] = new EE_Default_Where_Conditions(
+        $this->_cap_restrictions[EEM_Base::caps_delete]['ee_delete_venue_category'] = new EE_Default_Where_Conditions(
             array(
-                $path_to_tax_model . 'taxonomy*ee_delete_venue_category' => array('!=', 'espresso_venue_categories'),
+                $path_to_tax_model.'taxonomy*ee_delete_venue_category' => array('!=', 'espresso_venue_categories'),
             )
         );
-        $this->_cap_restrictions[ EEM_Base::caps_delete ]['ee_delete_event_type'] = new EE_Default_Where_Conditions(
+        $this->_cap_restrictions[EEM_Base::caps_delete]['ee_delete_event_type'] = new EE_Default_Where_Conditions(
             array(
-                $path_to_tax_model . 'taxonomy*ee_delete_event_type' => array('!=', 'espresso_event_type'),
+                $path_to_tax_model.'taxonomy*ee_delete_event_type' => array('!=', 'espresso_event_type'),
             )
         );
         parent::__construct($timezone);
@@ -126,7 +126,7 @@ 
     {
         if ($model === EEM_Term_Taxonomy::instance()) {
             $taxonomies = get_taxonomies(array('show_in_rest' => true));
-            if (! empty($taxonomies)) {
+            if ( ! empty($taxonomies)) {
                 $model_query_params[0]['taxonomy'] = array('IN', $taxonomies);
             }
         }

core/db_models/EEM_Currency.model.php

Spacing +4 added lines, -4 removed lines

@@ -34,7 +34,7 @@ 
             'Payment_Method'=>new EE_HABTM_Relation('Currency_Payment_Method'),
         );
         // 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();
 
         parent::__construct($timezone);
     }
@@ -48,8 +48,8 @@ 
     public function get_all_active($query_params = array())
     {
         $query_params[0]['CUR_active'] = true;
-        if (! isset($query_params['order_by'])) {
-            $query_params['order_by'] = array('CUR_code'=>'ASC','CUR_single'=>'ASC');
+        if ( ! isset($query_params['order_by'])) {
+            $query_params['order_by'] = array('CUR_code'=>'ASC', 'CUR_single'=>'ASC');
         }
         return $this->get_all($query_params);
     }
@@ -69,7 +69,7 @@ 
         if ($currencies_supported == EE_Gateway::all_currencies_supported || empty($currencies_supported)) {
             $currencies = $this->get_all_active();
         } else {
-            $currencies = $this->get_all_active(array(array('CUR_code'=>array('IN',$currencies_supported))));
+            $currencies = $this->get_all_active(array(array('CUR_code'=>array('IN', $currencies_supported))));
         }
         return $currencies;
     }

Indentation +59 added lines, -59 removed lines

@@ -11,66 +11,66 @@
  */
 class EEM_Currency extends EEM_Base
 {
-        // private instance of the Attendee object
-    protected static $_instance = null;
+		// private instance of the Attendee object
+	protected static $_instance = null;
 
-    protected function __construct($timezone = null)
-    {
-        $this->singular_item = __('Currency', 'event_espresso');
-        $this->plural_item = __('Currencies', 'event_espresso');
-        $this->_tables = array(
-            'Currency'=> new EE_Primary_Table('esp_currency', 'CUR_code')
-        );
-        $this->_fields = array(
-            'Currency'=>array(
-                'CUR_code'=> new EE_Primary_Key_String_Field('CUR_code', __('Currency Code', 'event_espresso')),
-                'CUR_single' => new EE_Plain_Text_Field('CUR_single', __('Currency Name Singular', 'event_espresso'), false),
-                'CUR_plural' => new EE_Plain_Text_Field('CUR_plural', __('Currency Name Plural', 'event_espresso'), false),
-                'CUR_sign' => new EE_Plain_Text_Field('CUR_sign', __('Currency Sign', 'event_espresso'), false),
-                'CUR_dec_plc' => new EE_Integer_Field('CUR_dec_plc', __('Currency Decimal Places', 'event_espresso'), false, 2),
-                'CUR_active'=>new EE_Boolean_Field('CUR_active', __('Active?', 'event_espresso'), false, true),
-            ));
-        $this->_model_relations = array(
-            'Payment_Method'=>new EE_HABTM_Relation('Currency_Payment_Method'),
-        );
-        // this model is generally available for reading
-        $this->_cap_restriction_generators[ EEM_Base::caps_read ] = new EE_Restriction_Generator_Public();
+	protected function __construct($timezone = null)
+	{
+		$this->singular_item = __('Currency', 'event_espresso');
+		$this->plural_item = __('Currencies', 'event_espresso');
+		$this->_tables = array(
+			'Currency'=> new EE_Primary_Table('esp_currency', 'CUR_code')
+		);
+		$this->_fields = array(
+			'Currency'=>array(
+				'CUR_code'=> new EE_Primary_Key_String_Field('CUR_code', __('Currency Code', 'event_espresso')),
+				'CUR_single' => new EE_Plain_Text_Field('CUR_single', __('Currency Name Singular', 'event_espresso'), false),
+				'CUR_plural' => new EE_Plain_Text_Field('CUR_plural', __('Currency Name Plural', 'event_espresso'), false),
+				'CUR_sign' => new EE_Plain_Text_Field('CUR_sign', __('Currency Sign', 'event_espresso'), false),
+				'CUR_dec_plc' => new EE_Integer_Field('CUR_dec_plc', __('Currency Decimal Places', 'event_espresso'), false, 2),
+				'CUR_active'=>new EE_Boolean_Field('CUR_active', __('Active?', 'event_espresso'), false, true),
+			));
+		$this->_model_relations = array(
+			'Payment_Method'=>new EE_HABTM_Relation('Currency_Payment_Method'),
+		);
+		// this model is generally available for reading
+		$this->_cap_restriction_generators[ EEM_Base::caps_read ] = new EE_Restriction_Generator_Public();
 
-        parent::__construct($timezone);
-    }
+		parent::__construct($timezone);
+	}
 
-    /**
-     * Gets all thea ctive currencies, and orders them by their singular name, and then their code
-     * (may be overridden)
-     * @param array $query_params @see https://github.com/eventespresso/event-espresso-core/tree/master/docs/G--Model-System/model-query-params.md
-     * @return EE_Currency[]
-     */
-    public function get_all_active($query_params = array())
-    {
-        $query_params[0]['CUR_active'] = true;
-        if (! isset($query_params['order_by'])) {
-            $query_params['order_by'] = array('CUR_code'=>'ASC','CUR_single'=>'ASC');
-        }
-        return $this->get_all($query_params);
-    }
-    /**
-     * Gets all the currencies which can be used by that payment method type
-     * @param EE_PMT_Base $payment_method_type
-     * @return EE_Currency[]
-     */
-    public function get_all_currencies_usable_by($payment_method_type)
-    {
-        if ($payment_method_type instanceof EE_PMT_Base &&
-                $payment_method_type->get_gateway()) {
-            $currencies_supported = $payment_method_type->get_gateway()->currencies_supported();
-        } else {
-            $currencies_supported = EE_Gateway::all_currencies_supported;
-        }
-        if ($currencies_supported == EE_Gateway::all_currencies_supported || empty($currencies_supported)) {
-            $currencies = $this->get_all_active();
-        } else {
-            $currencies = $this->get_all_active(array(array('CUR_code'=>array('IN',$currencies_supported))));
-        }
-        return $currencies;
-    }
+	/**
+	 * Gets all thea ctive currencies, and orders them by their singular name, and then their code
+	 * (may be overridden)
+	 * @param array $query_params @see https://github.com/eventespresso/event-espresso-core/tree/master/docs/G--Model-System/model-query-params.md
+	 * @return EE_Currency[]
+	 */
+	public function get_all_active($query_params = array())
+	{
+		$query_params[0]['CUR_active'] = true;
+		if (! isset($query_params['order_by'])) {
+			$query_params['order_by'] = array('CUR_code'=>'ASC','CUR_single'=>'ASC');
+		}
+		return $this->get_all($query_params);
+	}
+	/**
+	 * Gets all the currencies which can be used by that payment method type
+	 * @param EE_PMT_Base $payment_method_type
+	 * @return EE_Currency[]
+	 */
+	public function get_all_currencies_usable_by($payment_method_type)
+	{
+		if ($payment_method_type instanceof EE_PMT_Base &&
+				$payment_method_type->get_gateway()) {
+			$currencies_supported = $payment_method_type->get_gateway()->currencies_supported();
+		} else {
+			$currencies_supported = EE_Gateway::all_currencies_supported;
+		}
+		if ($currencies_supported == EE_Gateway::all_currencies_supported || empty($currencies_supported)) {
+			$currencies = $this->get_all_active();
+		} else {
+			$currencies = $this->get_all_active(array(array('CUR_code'=>array('IN',$currencies_supported))));
+		}
+		return $currencies;
+	}
 }

core/db_models/EEM_Currency_Payment_Method.model.php

Indentation +25 added lines, -25 removed lines

@@ -11,31 +11,31 @@
  */
 class EEM_Currency_Payment_Method extends EEM_Base
 {
-    // private instance of the Attendee object
-    protected static $_instance = null;
+	// private instance of the Attendee object
+	protected static $_instance = null;
 
 
-    protected function __construct($timezone = null)
-    {
-        $this->singular_item = __('Currency Usable by Payment Method', 'event_espresso');
-        $this->plural_item = __('Currencies Usable by Payment Methods', 'event_espresso');
-        $this->_tables = array(
-            'Currency_Payment_Method'=>new EE_Primary_Table('esp_currency_payment_method', 'CPM_ID')
-        );
-        $this->_fields = array(
-            'Currency_Payment_Method'=>array(
-                'CPM_ID'=>new EE_Primary_Key_Int_Field('CPM_ID', __('Currency to Payment Method LInk ID', 'event_espresso')),
-                'CUR_code'=>new EE_Foreign_Key_String_Field('CUR_code', __('Currency Code', 'event_espresso'), false, '', 'Currency'),
-                'PMD_ID'=>new EE_Foreign_Key_Int_Field('PMD_ID', __('Paymetn Method ID', 'event_espresso'), false, 0, 'Payment_Method')
-            )
-        );
-        $this->_model_relations = array(
-            'Currency'=>new EE_Belongs_To_Relation(),
-            'Payment_Method'=>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->_caps_slug = 'payment_methods';
-        parent::__construct($timezone);
-    }
+	protected function __construct($timezone = null)
+	{
+		$this->singular_item = __('Currency Usable by Payment Method', 'event_espresso');
+		$this->plural_item = __('Currencies Usable by Payment Methods', 'event_espresso');
+		$this->_tables = array(
+			'Currency_Payment_Method'=>new EE_Primary_Table('esp_currency_payment_method', 'CPM_ID')
+		);
+		$this->_fields = array(
+			'Currency_Payment_Method'=>array(
+				'CPM_ID'=>new EE_Primary_Key_Int_Field('CPM_ID', __('Currency to Payment Method LInk ID', 'event_espresso')),
+				'CUR_code'=>new EE_Foreign_Key_String_Field('CUR_code', __('Currency Code', 'event_espresso'), false, '', 'Currency'),
+				'PMD_ID'=>new EE_Foreign_Key_Int_Field('PMD_ID', __('Paymetn Method ID', 'event_espresso'), false, 0, 'Payment_Method')
+			)
+		);
+		$this->_model_relations = array(
+			'Currency'=>new EE_Belongs_To_Relation(),
+			'Payment_Method'=>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->_caps_slug = 'payment_methods';
+		parent::__construct($timezone);
+	}
 }

Spacing +1 added lines, -1 removed lines

@@ -34,7 +34,7 @@
             'Payment_Method'=>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();
         $this->_caps_slug = 'payment_methods';
         parent::__construct($timezone);
     }

core/db_models/EEM_Price.model.php

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_Change_Log.model.php

Spacing +7 added lines, -7 removed lines

@@ -113,17 +113,17 @@ 
                 ),
             ),
         );
-        $this->_model_relations    = array();
+        $this->_model_relations = array();
         foreach ($models_this_can_attach_to as $model) {
             if ($model != 'Change_Log') {
-                $this->_model_relations[ $model ] = new EE_Belongs_To_Any_Relation();
+                $this->_model_relations[$model] = new EE_Belongs_To_Any_Relation();
             }
         }
         // use completely custom caps for this
         $this->_cap_restriction_generators = false;
         // caps-wise this is all-or-nothing: if you have the default role you can access anything, otherwise nothing
         foreach ($this->_cap_contexts_to_cap_action_map as $cap_context => $action) {
-            $this->_cap_restrictions[ $cap_context ][ EE_Restriction_Generator_Base::get_default_restrictions_cap() ]
+            $this->_cap_restrictions[$cap_context][EE_Restriction_Generator_Base::get_default_restrictions_cap()]
                 = new EE_Return_None_Where_Conditions();
         }
         parent::__construct($timezone);
@@ -168,7 +168,7 @@ 
      */
     public function gateway_log($message, $related_obj_id, $related_obj_type)
     {
-        if (! EE_Registry::instance()->is_model_name($related_obj_type)) {
+        if ( ! EE_Registry::instance()->is_model_name($related_obj_type)) {
             throw new EE_Error(
                 sprintf(
                     esc_html__(
@@ -217,7 +217,7 @@ 
         global $wpdb;
         return $wpdb->query(
             $wpdb->prepare(
-                'DELETE FROM ' . $this->table() . ' WHERE LOG_type = %s AND LOG_time < %s',
+                'DELETE FROM '.$this->table().' WHERE LOG_type = %s AND LOG_time < %s',
                 EEM_Change_Log::type_gateway,
                 $datetime->format(EE_Datetime_Field::mysql_timestamp_format)
             )
@@ -256,8 +256,8 @@ 
     {
         $type_identifier_map = self::get_pretty_label_map_for_registered_types();
         // we fallback to the incoming type identifier if there is no localized label for it.
-        return isset($type_identifier_map[ $type_identifier ])
-            ? $type_identifier_map[ $type_identifier ]
+        return isset($type_identifier_map[$type_identifier])
+            ? $type_identifier_map[$type_identifier]
             : $type_identifier;
     }
 }

Indentation +227 added lines, -227 removed lines

@@ -11,93 +11,93 @@ 
 class EEM_Change_Log extends EEM_Base
 {
 
-    /**
-     * the related object was created log type
-     */
-    const type_create = 'create';
-    /**
-     * the related object was updated (changed, or soft-deleted)
-     */
-    const type_update = 'update';
-    /**
-     * the related object was deleted permanently
-     */
-    const type_delete = 'delete';
-    /**
-     * the related item had something worth noting happen on it, but
-     * only for the purposes of debugging problems
-     */
-    const type_debug = 'debug';
-    /**
-     * the related item had an error occur on it
-     */
-    const type_error = 'error';
-    /**
-     * the related item is regarding some gateway interaction, like an IPN
-     * or request to process a payment
-     */
-    const type_gateway = 'gateway';
+	/**
+	 * the related object was created log type
+	 */
+	const type_create = 'create';
+	/**
+	 * the related object was updated (changed, or soft-deleted)
+	 */
+	const type_update = 'update';
+	/**
+	 * the related object was deleted permanently
+	 */
+	const type_delete = 'delete';
+	/**
+	 * the related item had something worth noting happen on it, but
+	 * only for the purposes of debugging problems
+	 */
+	const type_debug = 'debug';
+	/**
+	 * the related item had an error occur on it
+	 */
+	const type_error = 'error';
+	/**
+	 * the related item is regarding some gateway interaction, like an IPN
+	 * or request to process a payment
+	 */
+	const type_gateway = 'gateway';
 
-    /**
-     * private instance of the EEM_Change_Log object
-     *
-     * @access private
-     * @var EEM_Change_Log $_instance
-     */
-    protected static $_instance = null;
+	/**
+	 * private instance of the EEM_Change_Log object
+	 *
+	 * @access private
+	 * @var EEM_Change_Log $_instance
+	 */
+	protected static $_instance = null;
 
 
-    /**
-     * constructor
-     *
-     * @access protected
-     * @param null $timezone
-     * @throws EE_Error
-     */
-    protected function __construct($timezone = null)
-    {
-        global $current_user;
-        $this->singular_item       = esc_html__('Log', 'event_espresso');
-        $this->plural_item         = esc_html__('Logs', 'event_espresso');
-        $this->_tables             = array(
-            'Log' => new EE_Primary_Table('esp_log', 'LOG_ID'),
-        );
-        $models_this_can_attach_to = array_keys(EE_Registry::instance()->non_abstract_db_models);
-        $this->_fields             = array(
-            'Log' => array(
-                'LOG_ID'      => new EE_Primary_Key_Int_Field('LOG_ID', esc_html__('Log ID', 'event_espresso')),
-                'LOG_time'    => new EE_Datetime_Field(
-                    'LOG_time',
-                    esc_html__("Log Time", 'event_espresso'),
-                    false,
-                    EE_Datetime_Field::now
-                ),
-                'OBJ_ID'      => new EE_Foreign_Key_String_Field(
-                    'OBJ_ID',
-                    esc_html__("Object ID (int or string)", 'event_espresso'),
-                    true,
-                    null,
-                    $models_this_can_attach_to
-                ),
-                'OBJ_type'    => new EE_Any_Foreign_Model_Name_Field(
-                    'OBJ_type',
-                    esc_html__("Object Type", 'event_espresso'),
-                    true,
-                    null,
-                    $models_this_can_attach_to
-                ),
-                'LOG_type'    => new EE_Plain_Text_Field(
-                    'LOG_type',
-                    esc_html__("Type of log entry", "event_espresso"),
-                    false,
-                    self::type_debug
-                ),
-                'LOG_message' => new EE_Maybe_Serialized_Text_Field(
-                    'LOG_message',
-                    esc_html__("Log Message (body)", 'event_espresso'),
-                    true
-                ),
-                /*
+	/**
+	 * constructor
+	 *
+	 * @access protected
+	 * @param null $timezone
+	 * @throws EE_Error
+	 */
+	protected function __construct($timezone = null)
+	{
+		global $current_user;
+		$this->singular_item       = esc_html__('Log', 'event_espresso');
+		$this->plural_item         = esc_html__('Logs', 'event_espresso');
+		$this->_tables             = array(
+			'Log' => new EE_Primary_Table('esp_log', 'LOG_ID'),
+		);
+		$models_this_can_attach_to = array_keys(EE_Registry::instance()->non_abstract_db_models);
+		$this->_fields             = array(
+			'Log' => array(
+				'LOG_ID'      => new EE_Primary_Key_Int_Field('LOG_ID', esc_html__('Log ID', 'event_espresso')),
+				'LOG_time'    => new EE_Datetime_Field(
+					'LOG_time',
+					esc_html__("Log Time", 'event_espresso'),
+					false,
+					EE_Datetime_Field::now
+				),
+				'OBJ_ID'      => new EE_Foreign_Key_String_Field(
+					'OBJ_ID',
+					esc_html__("Object ID (int or string)", 'event_espresso'),
+					true,
+					null,
+					$models_this_can_attach_to
+				),
+				'OBJ_type'    => new EE_Any_Foreign_Model_Name_Field(
+					'OBJ_type',
+					esc_html__("Object Type", 'event_espresso'),
+					true,
+					null,
+					$models_this_can_attach_to
+				),
+				'LOG_type'    => new EE_Plain_Text_Field(
+					'LOG_type',
+					esc_html__("Type of log entry", "event_espresso"),
+					false,
+					self::type_debug
+				),
+				'LOG_message' => new EE_Maybe_Serialized_Text_Field(
+					'LOG_message',
+					esc_html__("Log Message (body)", 'event_espresso'),
+					true
+				),
+				/*
                  * Note: when querying for a change log's user, the OBJ_ID and OBJ_type fields are used,
                  * not the LOG_wp_user field. E.g.,
                  * `EEM_Change_Log::instance()->get_all(array(array('WP_User.ID'=>1)))` will actually return
@@ -106,158 +106,158 @@ 
                  *  If you want the latter, you can't use the model's magic joining. E.g, you would need to do
                  * `EEM_Change_Log::instance()->get_all(array(array('LOG_wp_user' => 1)))`.
                  */
-                'LOG_wp_user' => new EE_WP_User_Field(
-                    'LOG_wp_user',
-                    esc_html__("User who was logged in while this occurred", 'event_espresso'),
-                    true
-                ),
-            ),
-        );
-        $this->_model_relations    = array();
-        foreach ($models_this_can_attach_to as $model) {
-            if ($model != 'Change_Log') {
-                $this->_model_relations[ $model ] = new EE_Belongs_To_Any_Relation();
-            }
-        }
-        // use completely custom caps for this
-        $this->_cap_restriction_generators = false;
-        // caps-wise this is all-or-nothing: if you have the default role you can access anything, otherwise nothing
-        foreach ($this->_cap_contexts_to_cap_action_map as $cap_context => $action) {
-            $this->_cap_restrictions[ $cap_context ][ EE_Restriction_Generator_Base::get_default_restrictions_cap() ]
-                = new EE_Return_None_Where_Conditions();
-        }
-        parent::__construct($timezone);
-    }
+				'LOG_wp_user' => new EE_WP_User_Field(
+					'LOG_wp_user',
+					esc_html__("User who was logged in while this occurred", 'event_espresso'),
+					true
+				),
+			),
+		);
+		$this->_model_relations    = array();
+		foreach ($models_this_can_attach_to as $model) {
+			if ($model != 'Change_Log') {
+				$this->_model_relations[ $model ] = new EE_Belongs_To_Any_Relation();
+			}
+		}
+		// use completely custom caps for this
+		$this->_cap_restriction_generators = false;
+		// caps-wise this is all-or-nothing: if you have the default role you can access anything, otherwise nothing
+		foreach ($this->_cap_contexts_to_cap_action_map as $cap_context => $action) {
+			$this->_cap_restrictions[ $cap_context ][ EE_Restriction_Generator_Base::get_default_restrictions_cap() ]
+				= new EE_Return_None_Where_Conditions();
+		}
+		parent::__construct($timezone);
+	}
 
-    /**
-     * @param string        $log_type !see the acceptable values of LOG_type in EEM__Change_Log::__construct
-     * @param mixed         $message  array|string of the message you want to record
-     * @param EE_Base_Class $related_model_obj
-     * @return EE_Change_Log
-     * @throws EE_Error
-     */
-    public function log($log_type, $message, $related_model_obj)
-    {
-        if ($related_model_obj instanceof EE_Base_Class) {
-            $obj_id   = $related_model_obj->ID();
-            $obj_type = $related_model_obj->get_model()->get_this_model_name();
-        } else {
-            $obj_id   = null;
-            $obj_type = null;
-        }
-        /** @var EE_Change_Log $log */
-        $log = EE_Change_Log::new_instance(array(
-            'LOG_type'    => $log_type,
-            'LOG_message' => $message,
-            'OBJ_ID'      => $obj_id,
-            'OBJ_type'    => $obj_type,
-        ));
-        $log->save();
-        return $log;
-    }
+	/**
+	 * @param string        $log_type !see the acceptable values of LOG_type in EEM__Change_Log::__construct
+	 * @param mixed         $message  array|string of the message you want to record
+	 * @param EE_Base_Class $related_model_obj
+	 * @return EE_Change_Log
+	 * @throws EE_Error
+	 */
+	public function log($log_type, $message, $related_model_obj)
+	{
+		if ($related_model_obj instanceof EE_Base_Class) {
+			$obj_id   = $related_model_obj->ID();
+			$obj_type = $related_model_obj->get_model()->get_this_model_name();
+		} else {
+			$obj_id   = null;
+			$obj_type = null;
+		}
+		/** @var EE_Change_Log $log */
+		$log = EE_Change_Log::new_instance(array(
+			'LOG_type'    => $log_type,
+			'LOG_message' => $message,
+			'OBJ_ID'      => $obj_id,
+			'OBJ_type'    => $obj_type,
+		));
+		$log->save();
+		return $log;
+	}
 
 
-    /**
-     * Adds a gateway log for the specified object, given its ID and type
-     *
-     * @param string $message
-     * @param mixed  $related_obj_id
-     * @param string $related_obj_type
-     * @throws EE_Error
-     * @return EE_Change_Log
-     */
-    public function gateway_log($message, $related_obj_id, $related_obj_type)
-    {
-        if (! EE_Registry::instance()->is_model_name($related_obj_type)) {
-            throw new EE_Error(
-                sprintf(
-                    esc_html__(
-                        "'%s' is not a model name. A model name must be provided when making a gateway log. Eg, 'Payment', 'Payment_Method', etc",
-                        "event_espresso"
-                    ),
-                    $related_obj_type
-                )
-            );
-        }
-        /** @var EE_Change_Log $log */
-        $log = EE_Change_Log::new_instance(array(
-            'LOG_type'    => EEM_Change_Log::type_gateway,
-            'LOG_message' => $message,
-            'OBJ_ID'      => $related_obj_id,
-            'OBJ_type'    => $related_obj_type,
-        ));
-        $log->save();
-        return $log;
-    }
+	/**
+	 * Adds a gateway log for the specified object, given its ID and type
+	 *
+	 * @param string $message
+	 * @param mixed  $related_obj_id
+	 * @param string $related_obj_type
+	 * @throws EE_Error
+	 * @return EE_Change_Log
+	 */
+	public function gateway_log($message, $related_obj_id, $related_obj_type)
+	{
+		if (! EE_Registry::instance()->is_model_name($related_obj_type)) {
+			throw new EE_Error(
+				sprintf(
+					esc_html__(
+						"'%s' is not a model name. A model name must be provided when making a gateway log. Eg, 'Payment', 'Payment_Method', etc",
+						"event_espresso"
+					),
+					$related_obj_type
+				)
+			);
+		}
+		/** @var EE_Change_Log $log */
+		$log = EE_Change_Log::new_instance(array(
+			'LOG_type'    => EEM_Change_Log::type_gateway,
+			'LOG_message' => $message,
+			'OBJ_ID'      => $related_obj_id,
+			'OBJ_type'    => $related_obj_type,
+		));
+		$log->save();
+		return $log;
+	}
 
 
-    /**
-     * Just gets the bare-bones wpdb results as an array in cases where efficiency is essential
-     *
-     * @param array $query_params @see https://github.com/eventespresso/event-espresso-core/tree/master/docs/G--Model-System/model-query-params.md
-     * @return array of arrays
-     * @throws EE_Error
-     */
-    public function get_all_efficiently($query_params)
-    {
-        return $this->_get_all_wpdb_results($query_params);
-    }
+	/**
+	 * Just gets the bare-bones wpdb results as an array in cases where efficiency is essential
+	 *
+	 * @param array $query_params @see https://github.com/eventespresso/event-espresso-core/tree/master/docs/G--Model-System/model-query-params.md
+	 * @return array of arrays
+	 * @throws EE_Error
+	 */
+	public function get_all_efficiently($query_params)
+	{
+		return $this->_get_all_wpdb_results($query_params);
+	}
 
 
-    /**
-     * Executes a database query to delete gateway logs. Does not affect model objects, so if you attempt to use
-     * models after this, they may be out-of-sync with the database
-     *
-     * @param DateTime $datetime
-     * @return false|int
-     * @throws EE_Error
-     */
-    public function delete_gateway_logs_older_than(DateTime $datetime)
-    {
-        global $wpdb;
-        return $wpdb->query(
-            $wpdb->prepare(
-                'DELETE FROM ' . $this->table() . ' WHERE LOG_type = %s AND LOG_time < %s',
-                EEM_Change_Log::type_gateway,
-                $datetime->format(EE_Datetime_Field::mysql_timestamp_format)
-            )
-        );
-    }
+	/**
+	 * Executes a database query to delete gateway logs. Does not affect model objects, so if you attempt to use
+	 * models after this, they may be out-of-sync with the database
+	 *
+	 * @param DateTime $datetime
+	 * @return false|int
+	 * @throws EE_Error
+	 */
+	public function delete_gateway_logs_older_than(DateTime $datetime)
+	{
+		global $wpdb;
+		return $wpdb->query(
+			$wpdb->prepare(
+				'DELETE FROM ' . $this->table() . ' WHERE LOG_type = %s AND LOG_time < %s',
+				EEM_Change_Log::type_gateway,
+				$datetime->format(EE_Datetime_Field::mysql_timestamp_format)
+			)
+		);
+	}
 
 
-    /**
-     * Returns the map of type to pretty label for identifiers used for `LOG_type`.  Client code can register their own
-     * map vai the given filter.
-     *
-     * @return array
-     */
-    public static function get_pretty_label_map_for_registered_types()
-    {
-        return apply_filters(
-            'FHEE__EEM_Change_Log__get_pretty_label_map_for_registered_types',
-            array(
-                self::type_create=>  esc_html__("Create", "event_espresso"),
-                self::type_update=>  esc_html__("Update", "event_espresso"),
-                self::type_delete => esc_html__("Delete", "event_espresso"),
-                self::type_debug=>  esc_html__("Debug", "event_espresso"),
-                self::type_error=>  esc_html__("Error", "event_espresso"),
-                self::type_gateway=> esc_html__("Gateway Interaction (IPN or Direct Payment)", 'event_espresso')
-            )
-        );
-    }
+	/**
+	 * Returns the map of type to pretty label for identifiers used for `LOG_type`.  Client code can register their own
+	 * map vai the given filter.
+	 *
+	 * @return array
+	 */
+	public static function get_pretty_label_map_for_registered_types()
+	{
+		return apply_filters(
+			'FHEE__EEM_Change_Log__get_pretty_label_map_for_registered_types',
+			array(
+				self::type_create=>  esc_html__("Create", "event_espresso"),
+				self::type_update=>  esc_html__("Update", "event_espresso"),
+				self::type_delete => esc_html__("Delete", "event_espresso"),
+				self::type_debug=>  esc_html__("Debug", "event_espresso"),
+				self::type_error=>  esc_html__("Error", "event_espresso"),
+				self::type_gateway=> esc_html__("Gateway Interaction (IPN or Direct Payment)", 'event_espresso')
+			)
+		);
+	}
 
 
-    /**
-     * Return the pretty (localized) label for the given log type identifier.
-     * @param string $type_identifier
-     * @return string
-     */
-    public static function get_pretty_label_for_type($type_identifier)
-    {
-        $type_identifier_map = self::get_pretty_label_map_for_registered_types();
-        // we fallback to the incoming type identifier if there is no localized label for it.
-        return isset($type_identifier_map[ $type_identifier ])
-            ? $type_identifier_map[ $type_identifier ]
-            : $type_identifier;
-    }
+	/**
+	 * Return the pretty (localized) label for the given log type identifier.
+	 * @param string $type_identifier
+	 * @return string
+	 */
+	public static function get_pretty_label_for_type($type_identifier)
+	{
+		$type_identifier_map = self::get_pretty_label_map_for_registered_types();
+		// we fallback to the incoming type identifier if there is no localized label for it.
+		return isset($type_identifier_map[ $type_identifier ])
+			? $type_identifier_map[ $type_identifier ]
+			: $type_identifier;
+	}
 }

core/db_models/EEM_Soft_Delete_Base.model.php

Spacing +4 added lines, -4 removed lines

@@ -31,7 +31,7 @@ 
      */
     protected function __construct($timezone = null)
     {
-        if (! $this->_default_where_conditions_strategy instanceof EE_Default_Where_Conditions) {
+        if ( ! $this->_default_where_conditions_strategy instanceof EE_Default_Where_Conditions) {
             $this->_default_where_conditions_strategy = new EE_Soft_Delete_Where_Conditions();
         }
         parent::__construct($timezone);
@@ -132,7 +132,7 @@ 
     protected function _alter_query_params_so_only_trashed_items_included($query_params)
     {
         $deletedFlagFieldName = $this->deleted_field_name();
-        $query_params[0][ $deletedFlagFieldName ] = true;
+        $query_params[0][$deletedFlagFieldName] = true;
         return $query_params;
     }
 
@@ -172,7 +172,7 @@ 
      */
     protected function _alter_query_params_so_deleted_and_undeleted_items_included($query_params)
     {
-        if (! isset($query_params['default_where_conditions'])) {
+        if ( ! isset($query_params['default_where_conditions'])) {
             $query_params['default_where_conditions'] = 'minimum';
         }
         return $query_params;
@@ -300,7 +300,7 @@ 
      */
     public function delete_or_restore_by_ID($delete = true, $ID = false)
     {
-        if (! $ID) {
+        if ( ! $ID) {
             return false;
         }
         if ($this->delete_or_restore(

Indentation +359 added lines, -359 removed lines

@@ -26,363 +26,363 @@
 abstract class EEM_Soft_Delete_Base extends EEM_Base
 {
 
-    /**
-     * @param null $timezone
-     */
-    protected function __construct($timezone = null)
-    {
-        if (! $this->_default_where_conditions_strategy instanceof EE_Default_Where_Conditions) {
-            $this->_default_where_conditions_strategy = new EE_Soft_Delete_Where_Conditions();
-        }
-        parent::__construct($timezone);
-    }
-
-
-
-    /**
-     * Searches for field on this model of type 'deleted_flag'. if it is found,
-     * returns it's name.
-     *
-     * @return string
-     * @throws EE_Error
-     */
-    public function deleted_field_name()
-    {
-        $field = $this->get_a_field_of_type('EE_Trashed_Flag_Field');
-        if ($field) {
-            return $field->get_name();
-        } else {
-            throw new EE_Error(sprintf(__(
-                'We are trying to find the deleted flag field on %s, but none was found. Are you sure there is a field of type EE_Trashed_Flag_Field in %s constructor?',
-                'event_espresso'
-            ), get_class($this), get_class($this)));
-        }
-    }
-
-
-
-    /**
-     * Gets one item that's been deleted, according to $query_params
-     *
-     * @param array $query_params @see https://github.com/eventespresso/event-espresso-core/tree/master/docs/G--Model-System/model-query-params.md
-     * @return EE_Soft_Delete_Base_Class
-     */
-    public function get_one_deleted($query_params = array())
-    {
-        $query_params = $this->_alter_query_params_so_only_trashed_items_included($query_params);
-        return parent::get_one($query_params);
-    }
-
-
-
-    /**
-     * Gets one item from the DB, regardless of whether it's been soft-deleted or not
-     *
-     * @param array $query_params like EEM_base::get_all's $query_params
-     * @return EE_Soft_Delete_Base_Class
-     */
-    public function get_one_deleted_or_undeleted($query_params = array())
-    {
-        $query_params = $this->_alter_query_params_so_deleted_and_undeleted_items_included($query_params);
-        return parent::get_one($query_params);
-    }
-
-
-
-    /**
-     * Gets the item indicated by its ID. But if it's soft-deleted, pretends it doesn't exist.
-     *
-     * @param int|string $id
-     * @return EE_Soft_Delete_Base_Class
-     */
-    public function get_one_by_ID_but_ignore_deleted($id)
-    {
-        return $this->get_one(
-            $this->alter_query_params_to_restrict_by_ID(
-                $id,
-                array('default_where_conditions' => 'default')
-            )
-        );
-    }
-
-
-
-    /**
-     * Counts all the deleted/trashed items
-     *
-     * @param array  $query_params @see https://github.com/eventespresso/event-espresso-core/tree/master/docs/G--Model-System/model-query-params.md
-     * @param string $field_to_count
-     * @param bool   $distinct     if we want to only count the distinct values for the column then you can trigger that by the setting $distinct to TRUE;
-     * @return int
-     */
-    public function count_deleted($query_params = null, $field_to_count = null, $distinct = false)
-    {
-        $query_params = $this->_alter_query_params_so_only_trashed_items_included($query_params);
-        return parent::count($query_params, $field_to_count, $distinct);
-    }
-
-
-
-    /**
-     * Alters the query params so that only trashed/soft-deleted items are considered
-     *
-     * @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
-     */
-    protected function _alter_query_params_so_only_trashed_items_included($query_params)
-    {
-        $deletedFlagFieldName = $this->deleted_field_name();
-        $query_params[0][ $deletedFlagFieldName ] = true;
-        return $query_params;
-    }
-
-
-
-    /**
-     * Alters the query params so that only trashed/soft-deleted items are considered
-     *
-     * @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
-     */
-    public function alter_query_params_so_only_trashed_items_included($query_params)
-    {
-        return $this->_alter_query_params_so_only_trashed_items_included($query_params);
-    }
-
-
-
-    /**
-     * Alters the query params so each item's deleted status is ignored.
-     *
-     * @param array $query_params
-     * @return array
-     */
-    public function alter_query_params_so_deleted_and_undeleted_items_included($query_params = array())
-    {
-        return $this->_alter_query_params_so_deleted_and_undeleted_items_included($query_params);
-    }
-
-
-
-    /**
-     * Alters the query params so each item's deleted status is ignored.
-     *
-     * @param array $query_params
-     * @return array
-     */
-    protected function _alter_query_params_so_deleted_and_undeleted_items_included($query_params)
-    {
-        if (! isset($query_params['default_where_conditions'])) {
-            $query_params['default_where_conditions'] = 'minimum';
-        }
-        return $query_params;
-    }
-
-
-
-    /**
-     * Counts all deleted and undeleted items
-     *
-     * @param array  $query_params @see https://github.com/eventespresso/event-espresso-core/tree/master/docs/G--Model-System/model-query-params.md
-     * @param string $field_to_count
-     * @param bool   $distinct     if we want to only count the distinct values for the column then you can trigger that by the setting $distinct to TRUE;
-     * @return int
-     */
-    public function count_deleted_and_undeleted($query_params = null, $field_to_count = null, $distinct = false)
-    {
-        $query_params = $this->_alter_query_params_so_deleted_and_undeleted_items_included($query_params);
-        return parent::count($query_params, $field_to_count, $distinct);
-    }
-
-
-
-    /**
-     * Sum all the deleted items.
-     *
-     * @param array  $query_params @see https://github.com/eventespresso/event-espresso-core/tree/master/docs/G--Model-System/model-query-params.md
-     * @param string $field_to_sum
-     * @return int
-     */
-    public function sum_deleted($query_params = null, $field_to_sum = null)
-    {
-        $query_params = $this->_alter_query_params_so_only_trashed_items_included($query_params);
-        return parent::sum($query_params, $field_to_sum);
-    }
-
-
-
-    /**
-     * Sums all the deleted and undeleted items.
-     *
-     * @param array  $query_params @see https://github.com/eventespresso/event-espresso-core/tree/master/docs/G--Model-System/model-query-params.md
-     * @param string $field_to_sum
-     * @return int
-     */
-    public function sum_deleted_and_undeleted($query_params = null, $field_to_sum = null)
-    {
-        $query_params = $this->_alter_query_params_so_deleted_and_undeleted_items_included($query_params);
-        parent::sum($query_params, $field_to_sum);
-    }
-
-
-
-    /**
-     * Gets all deleted and undeleted mode objects from the db that meet the criteria, regardless of
-     * whether they've been soft-deleted or not
-     *
-     * @param array $query_params @see https://github.com/eventespresso/event-espresso-core/tree/master/docs/G--Model-System/model-query-params.md
-     * @return EE_Soft_Delete_Base_Class[]
-     */
-    public function get_all_deleted_and_undeleted($query_params = array())
-    {
-        $query_params = $this->_alter_query_params_so_deleted_and_undeleted_items_included($query_params);
-        return parent::get_all($query_params);
-    }
-
-
-
-    /**
-     * For 'soft deletable' models, gets all which ARE deleted, according to conditions specified in $query_params.
-     *
-     * @param array $query_params @see https://github.com/eventespresso/event-espresso-core/tree/master/docs/G--Model-System/model-query-params.md
-     * @return EE_Soft_Delete_Base_Class[]
-     */
-    public function get_all_deleted($query_params = array())
-    {
-        $query_params = $this->_alter_query_params_so_only_trashed_items_included($query_params);
-        return parent::get_all($query_params);
-    }
-
-
-
-    /**
-     * Permanently deletes the selected rows. When selecting rows for deletion, ignores
-     * whether they've been soft-deleted or not. (ie, you don't have to soft-delete objects
-     * before you can permanently delete them).
-     * Because this will cause a real deletion, related models may block this deletion (ie, add an error
-     * and abort the delete)
-     *
-     * @param array   $query_params   @see https://github.com/eventespresso/event-espresso-core/tree/master/docs/G--Model-System/model-query-params.md
-     * @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
-     * @return boolean success
-     */
-    public function delete_permanently($query_params = array(), $allow_blocking = true)
-    {
-        $query_params = $this->_alter_query_params_so_deleted_and_undeleted_items_included($query_params);
-        return parent::delete_permanently($query_params, $allow_blocking);
-    }
-
-
-
-    /**
-     * Restores a particular item by its ID (primary key). Ignores the fact whether the item
-     * has been soft-deleted or not.
-     *
-     * @param mixed $ID int if primary key is an int, string otherwise
-     * @return boolean success
-     */
-    public function restore_by_ID($ID = false)
-    {
-        return $this->delete_or_restore_by_ID(false, $ID);
-    }
-
-
-
-    /**
-     * For deleting or restoring a particular item. Note that this model is a SOFT-DELETABLE model! However,
-     * this function will ignore whether the items have been soft-deleted or not.
-     *
-     * @param boolean $delete true for delete, false for restore
-     * @param mixed   $ID     int if primary key is an int, string otherwise
-     * @return boolean
-     */
-    public function delete_or_restore_by_ID($delete = true, $ID = false)
-    {
-        if (! $ID) {
-            return false;
-        }
-        if ($this->delete_or_restore(
-            $delete,
-            $this->alter_query_params_to_restrict_by_ID($ID)
-        )
-        ) {
-            return true;
-        } else {
-            return false;
-        }
-    }
-
-
-
-    /**
-     * Overrides parent's 'delete' method to instead do a soft delete on all rows that
-     * meet the criteria in $where_col_n_values. This particular function ignores whether the items have been soft-deleted or not.
-     * Note: because this item will be soft-deleted only,
-     * doesn't block because of model dependencies
-     *
-     * @param array $query_params @see https://github.com/eventespresso/event-espresso-core/tree/master/docs/G--Model-System/model-query-params.md
-     * @param bool  $block_deletes
-     * @return boolean
-     */
-    public function delete($query_params = array(), $block_deletes = false)
-    {
-        // no matter what, we WON'T block soft deletes.
-        return $this->delete_or_restore(true, $query_params);
-    }
-
-
-
-    /**
-     * 'Un-deletes' the chosen items. Note that this model is a SOFT-DELETABLE model! That means that, by default, trashed/soft-deleted
-     * items are ignored in queries. However, this particular function ignores whether the items have been soft-deleted or not.
-     *
-     * @param array $query_params @see https://github.com/eventespresso/event-espresso-core/tree/master/docs/G--Model-System/model-query-params.md
-     * @return boolean
-     */
-    public function restore($query_params = array())
-    {
-        return $this->delete_or_restore(false, $query_params);
-    }
-
-
-
-    /**
-     * Performs deletes or restores on items. Both soft-deleted and non-soft-deleted items considered.
-     *
-     * @param boolean $delete       true to indicate deletion, false to indicate restoration
-     * @param array   $query_params @see https://github.com/eventespresso/event-espresso-core/tree/master/docs/G--Model-System/model-query-params.md
-     * @return boolean
-     */
-    public function delete_or_restore($delete = true, $query_params = array())
-    {
-        $deletedFlagFieldName = $this->deleted_field_name();
-        $query_params = $this->_alter_query_params_so_deleted_and_undeleted_items_included($query_params);
-        if ($this->update(array($deletedFlagFieldName => $delete), $query_params)) {
-            return true;
-        } else {
-            return false;
-        }
-    }
-
-
-
-    /**
-     * Updates all the items of this model which match the $query params, regardless of whether
-     * they've been soft-deleted or not
-     *
-     * @param array   $fields_n_values         like EEM_Base::update's $fields_n_value
-     * @param array   $query_params            like EEM_base::get_all's $query_params
-     * @param boolean $keep_model_objs_in_sync if TRUE, makes sure we ALSO update model objects
-     *                                         in this model's entity map according to $fields_n_values that match $query_params. This
-     *                                         obviously has some overhead, so you can disable it by setting this to FALSE, but
-     *                                         be aware that model objects being used could get out-of-sync with the database
-     * @return int number of items updated
-     */
-    public function update_deleted_and_undeleted($fields_n_values, $query_params, $keep_model_objs_in_sync = true)
-    {
-        $query_params = $this->_alter_query_params_so_deleted_and_undeleted_items_included($query_params);
-        return $this->update($fields_n_values, $query_params, $keep_model_objs_in_sync);
-    }
+	/**
+	 * @param null $timezone
+	 */
+	protected function __construct($timezone = null)
+	{
+		if (! $this->_default_where_conditions_strategy instanceof EE_Default_Where_Conditions) {
+			$this->_default_where_conditions_strategy = new EE_Soft_Delete_Where_Conditions();
+		}
+		parent::__construct($timezone);
+	}
+
+
+
+	/**
+	 * Searches for field on this model of type 'deleted_flag'. if it is found,
+	 * returns it's name.
+	 *
+	 * @return string
+	 * @throws EE_Error
+	 */
+	public function deleted_field_name()
+	{
+		$field = $this->get_a_field_of_type('EE_Trashed_Flag_Field');
+		if ($field) {
+			return $field->get_name();
+		} else {
+			throw new EE_Error(sprintf(__(
+				'We are trying to find the deleted flag field on %s, but none was found. Are you sure there is a field of type EE_Trashed_Flag_Field in %s constructor?',
+				'event_espresso'
+			), get_class($this), get_class($this)));
+		}
+	}
+
+
+
+	/**
+	 * Gets one item that's been deleted, according to $query_params
+	 *
+	 * @param array $query_params @see https://github.com/eventespresso/event-espresso-core/tree/master/docs/G--Model-System/model-query-params.md
+	 * @return EE_Soft_Delete_Base_Class
+	 */
+	public function get_one_deleted($query_params = array())
+	{
+		$query_params = $this->_alter_query_params_so_only_trashed_items_included($query_params);
+		return parent::get_one($query_params);
+	}
+
+
+
+	/**
+	 * Gets one item from the DB, regardless of whether it's been soft-deleted or not
+	 *
+	 * @param array $query_params like EEM_base::get_all's $query_params
+	 * @return EE_Soft_Delete_Base_Class
+	 */
+	public function get_one_deleted_or_undeleted($query_params = array())
+	{
+		$query_params = $this->_alter_query_params_so_deleted_and_undeleted_items_included($query_params);
+		return parent::get_one($query_params);
+	}
+
+
+
+	/**
+	 * Gets the item indicated by its ID. But if it's soft-deleted, pretends it doesn't exist.
+	 *
+	 * @param int|string $id
+	 * @return EE_Soft_Delete_Base_Class
+	 */
+	public function get_one_by_ID_but_ignore_deleted($id)
+	{
+		return $this->get_one(
+			$this->alter_query_params_to_restrict_by_ID(
+				$id,
+				array('default_where_conditions' => 'default')
+			)
+		);
+	}
+
+
+
+	/**
+	 * Counts all the deleted/trashed items
+	 *
+	 * @param array  $query_params @see https://github.com/eventespresso/event-espresso-core/tree/master/docs/G--Model-System/model-query-params.md
+	 * @param string $field_to_count
+	 * @param bool   $distinct     if we want to only count the distinct values for the column then you can trigger that by the setting $distinct to TRUE;
+	 * @return int
+	 */
+	public function count_deleted($query_params = null, $field_to_count = null, $distinct = false)
+	{
+		$query_params = $this->_alter_query_params_so_only_trashed_items_included($query_params);
+		return parent::count($query_params, $field_to_count, $distinct);
+	}
+
+
+
+	/**
+	 * Alters the query params so that only trashed/soft-deleted items are considered
+	 *
+	 * @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
+	 */
+	protected function _alter_query_params_so_only_trashed_items_included($query_params)
+	{
+		$deletedFlagFieldName = $this->deleted_field_name();
+		$query_params[0][ $deletedFlagFieldName ] = true;
+		return $query_params;
+	}
+
+
+
+	/**
+	 * Alters the query params so that only trashed/soft-deleted items are considered
+	 *
+	 * @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
+	 */
+	public function alter_query_params_so_only_trashed_items_included($query_params)
+	{
+		return $this->_alter_query_params_so_only_trashed_items_included($query_params);
+	}
+
+
+
+	/**
+	 * Alters the query params so each item's deleted status is ignored.
+	 *
+	 * @param array $query_params
+	 * @return array
+	 */
+	public function alter_query_params_so_deleted_and_undeleted_items_included($query_params = array())
+	{
+		return $this->_alter_query_params_so_deleted_and_undeleted_items_included($query_params);
+	}
+
+
+
+	/**
+	 * Alters the query params so each item's deleted status is ignored.
+	 *
+	 * @param array $query_params
+	 * @return array
+	 */
+	protected function _alter_query_params_so_deleted_and_undeleted_items_included($query_params)
+	{
+		if (! isset($query_params['default_where_conditions'])) {
+			$query_params['default_where_conditions'] = 'minimum';
+		}
+		return $query_params;
+	}
+
+
+
+	/**
+	 * Counts all deleted and undeleted items
+	 *
+	 * @param array  $query_params @see https://github.com/eventespresso/event-espresso-core/tree/master/docs/G--Model-System/model-query-params.md
+	 * @param string $field_to_count
+	 * @param bool   $distinct     if we want to only count the distinct values for the column then you can trigger that by the setting $distinct to TRUE;
+	 * @return int
+	 */
+	public function count_deleted_and_undeleted($query_params = null, $field_to_count = null, $distinct = false)
+	{
+		$query_params = $this->_alter_query_params_so_deleted_and_undeleted_items_included($query_params);
+		return parent::count($query_params, $field_to_count, $distinct);
+	}
+
+
+
+	/**
+	 * Sum all the deleted items.
+	 *
+	 * @param array  $query_params @see https://github.com/eventespresso/event-espresso-core/tree/master/docs/G--Model-System/model-query-params.md
+	 * @param string $field_to_sum
+	 * @return int
+	 */
+	public function sum_deleted($query_params = null, $field_to_sum = null)
+	{
+		$query_params = $this->_alter_query_params_so_only_trashed_items_included($query_params);
+		return parent::sum($query_params, $field_to_sum);
+	}
+
+
+
+	/**
+	 * Sums all the deleted and undeleted items.
+	 *
+	 * @param array  $query_params @see https://github.com/eventespresso/event-espresso-core/tree/master/docs/G--Model-System/model-query-params.md
+	 * @param string $field_to_sum
+	 * @return int
+	 */
+	public function sum_deleted_and_undeleted($query_params = null, $field_to_sum = null)
+	{
+		$query_params = $this->_alter_query_params_so_deleted_and_undeleted_items_included($query_params);
+		parent::sum($query_params, $field_to_sum);
+	}
+
+
+
+	/**
+	 * Gets all deleted and undeleted mode objects from the db that meet the criteria, regardless of
+	 * whether they've been soft-deleted or not
+	 *
+	 * @param array $query_params @see https://github.com/eventespresso/event-espresso-core/tree/master/docs/G--Model-System/model-query-params.md
+	 * @return EE_Soft_Delete_Base_Class[]
+	 */
+	public function get_all_deleted_and_undeleted($query_params = array())
+	{
+		$query_params = $this->_alter_query_params_so_deleted_and_undeleted_items_included($query_params);
+		return parent::get_all($query_params);
+	}
+
+
+
+	/**
+	 * For 'soft deletable' models, gets all which ARE deleted, according to conditions specified in $query_params.
+	 *
+	 * @param array $query_params @see https://github.com/eventespresso/event-espresso-core/tree/master/docs/G--Model-System/model-query-params.md
+	 * @return EE_Soft_Delete_Base_Class[]
+	 */
+	public function get_all_deleted($query_params = array())
+	{
+		$query_params = $this->_alter_query_params_so_only_trashed_items_included($query_params);
+		return parent::get_all($query_params);
+	}
+
+
+
+	/**
+	 * Permanently deletes the selected rows. When selecting rows for deletion, ignores
+	 * whether they've been soft-deleted or not. (ie, you don't have to soft-delete objects
+	 * before you can permanently delete them).
+	 * Because this will cause a real deletion, related models may block this deletion (ie, add an error
+	 * and abort the delete)
+	 *
+	 * @param array   $query_params   @see https://github.com/eventespresso/event-espresso-core/tree/master/docs/G--Model-System/model-query-params.md
+	 * @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
+	 * @return boolean success
+	 */
+	public function delete_permanently($query_params = array(), $allow_blocking = true)
+	{
+		$query_params = $this->_alter_query_params_so_deleted_and_undeleted_items_included($query_params);
+		return parent::delete_permanently($query_params, $allow_blocking);
+	}
+
+
+
+	/**
+	 * Restores a particular item by its ID (primary key). Ignores the fact whether the item
+	 * has been soft-deleted or not.
+	 *
+	 * @param mixed $ID int if primary key is an int, string otherwise
+	 * @return boolean success
+	 */
+	public function restore_by_ID($ID = false)
+	{
+		return $this->delete_or_restore_by_ID(false, $ID);
+	}
+
+
+
+	/**
+	 * For deleting or restoring a particular item. Note that this model is a SOFT-DELETABLE model! However,
+	 * this function will ignore whether the items have been soft-deleted or not.
+	 *
+	 * @param boolean $delete true for delete, false for restore
+	 * @param mixed   $ID     int if primary key is an int, string otherwise
+	 * @return boolean
+	 */
+	public function delete_or_restore_by_ID($delete = true, $ID = false)
+	{
+		if (! $ID) {
+			return false;
+		}
+		if ($this->delete_or_restore(
+			$delete,
+			$this->alter_query_params_to_restrict_by_ID($ID)
+		)
+		) {
+			return true;
+		} else {
+			return false;
+		}
+	}
+
+
+
+	/**
+	 * Overrides parent's 'delete' method to instead do a soft delete on all rows that
+	 * meet the criteria in $where_col_n_values. This particular function ignores whether the items have been soft-deleted or not.
+	 * Note: because this item will be soft-deleted only,
+	 * doesn't block because of model dependencies
+	 *
+	 * @param array $query_params @see https://github.com/eventespresso/event-espresso-core/tree/master/docs/G--Model-System/model-query-params.md
+	 * @param bool  $block_deletes
+	 * @return boolean
+	 */
+	public function delete($query_params = array(), $block_deletes = false)
+	{
+		// no matter what, we WON'T block soft deletes.
+		return $this->delete_or_restore(true, $query_params);
+	}
+
+
+
+	/**
+	 * 'Un-deletes' the chosen items. Note that this model is a SOFT-DELETABLE model! That means that, by default, trashed/soft-deleted
+	 * items are ignored in queries. However, this particular function ignores whether the items have been soft-deleted or not.
+	 *
+	 * @param array $query_params @see https://github.com/eventespresso/event-espresso-core/tree/master/docs/G--Model-System/model-query-params.md
+	 * @return boolean
+	 */
+	public function restore($query_params = array())
+	{
+		return $this->delete_or_restore(false, $query_params);
+	}
+
+
+
+	/**
+	 * Performs deletes or restores on items. Both soft-deleted and non-soft-deleted items considered.
+	 *
+	 * @param boolean $delete       true to indicate deletion, false to indicate restoration
+	 * @param array   $query_params @see https://github.com/eventespresso/event-espresso-core/tree/master/docs/G--Model-System/model-query-params.md
+	 * @return boolean
+	 */
+	public function delete_or_restore($delete = true, $query_params = array())
+	{
+		$deletedFlagFieldName = $this->deleted_field_name();
+		$query_params = $this->_alter_query_params_so_deleted_and_undeleted_items_included($query_params);
+		if ($this->update(array($deletedFlagFieldName => $delete), $query_params)) {
+			return true;
+		} else {
+			return false;
+		}
+	}
+
+
+
+	/**
+	 * Updates all the items of this model which match the $query params, regardless of whether
+	 * they've been soft-deleted or not
+	 *
+	 * @param array   $fields_n_values         like EEM_Base::update's $fields_n_value
+	 * @param array   $query_params            like EEM_base::get_all's $query_params
+	 * @param boolean $keep_model_objs_in_sync if TRUE, makes sure we ALSO update model objects
+	 *                                         in this model's entity map according to $fields_n_values that match $query_params. This
+	 *                                         obviously has some overhead, so you can disable it by setting this to FALSE, but
+	 *                                         be aware that model objects being used could get out-of-sync with the database
+	 * @return int number of items updated
+	 */
+	public function update_deleted_and_undeleted($fields_n_values, $query_params, $keep_model_objs_in_sync = true)
+	{
+		$query_params = $this->_alter_query_params_so_deleted_and_undeleted_items_included($query_params);
+		return $this->update($fields_n_values, $query_params, $keep_model_objs_in_sync);
+	}
 }

core/db_models/EEM_Extra_Meta.model.php

Indentation +27 added lines, -27 removed lines

@@ -16,33 +16,33 @@
 class EEM_Extra_Meta extends EEM_Base
 {
 
-    // private instance of the Attendee object
-    protected static $_instance = null;
+	// private instance of the Attendee object
+	protected static $_instance = null;
 
-    protected function __construct($timezone = null)
-    {
-        $this->singular_item = __('Extra Meta', 'event_espresso');
-        $this->plural_item = __('Extra Metas', 'event_espresso');
-        $this->_tables = array(
-            'Extra_Meta'=> new EE_Primary_Table('esp_extra_meta', 'EXM_ID')
-        );
-        $models_this_can_attach_to = array_keys(EE_Registry::instance()->non_abstract_db_models);
-        $this->_fields = array(
-            'Extra_Meta'=>array(
-                'EXM_ID'=>new EE_Primary_Key_Int_Field('EXM_ID', __("Extra Meta ID", "event_espresso")),
-                'OBJ_ID'=>new EE_Foreign_Key_Int_Field('OBJ_ID', __("Primary Key of Attached Thing", "event_espresso"), false, 0, $models_this_can_attach_to),
-                'EXM_type'=>new EE_Any_Foreign_Model_Name_Field('EXM_type', __("Model of Attached Thing", "event_espresso"), false, 'Transaction', $models_this_can_attach_to),
-                'EXM_key'=>new EE_Plain_Text_Field('EXM_key', __("Meta Key", "event_espresso"), false, ''),
-                'EXM_value'=>new EE_Maybe_Serialized_Text_Field('EXM_value', __("Meta Value", "event_espresso"), true)
+	protected function __construct($timezone = null)
+	{
+		$this->singular_item = __('Extra Meta', 'event_espresso');
+		$this->plural_item = __('Extra Metas', 'event_espresso');
+		$this->_tables = array(
+			'Extra_Meta'=> new EE_Primary_Table('esp_extra_meta', 'EXM_ID')
+		);
+		$models_this_can_attach_to = array_keys(EE_Registry::instance()->non_abstract_db_models);
+		$this->_fields = array(
+			'Extra_Meta'=>array(
+				'EXM_ID'=>new EE_Primary_Key_Int_Field('EXM_ID', __("Extra Meta ID", "event_espresso")),
+				'OBJ_ID'=>new EE_Foreign_Key_Int_Field('OBJ_ID', __("Primary Key of Attached Thing", "event_espresso"), false, 0, $models_this_can_attach_to),
+				'EXM_type'=>new EE_Any_Foreign_Model_Name_Field('EXM_type', __("Model of Attached Thing", "event_espresso"), false, 'Transaction', $models_this_can_attach_to),
+				'EXM_key'=>new EE_Plain_Text_Field('EXM_key', __("Meta Key", "event_espresso"), false, ''),
+				'EXM_value'=>new EE_Maybe_Serialized_Text_Field('EXM_value', __("Meta Value", "event_espresso"), true)
 
-            ));
-        $this->_model_relations = array();
-        foreach ($models_this_can_attach_to as $model) {
-            $this->_model_relations[ $model ] = new EE_Belongs_To_Any_Relation();
-        }
-        foreach ($this->cap_contexts_to_cap_action_map() as $cap_context => $action) {
-            $this->_cap_restriction_generators[ $cap_context ] = new EE_Restriction_Generator_Meta('EXM_key', 'EXM_value');
-        }
-        parent::__construct($timezone);
-    }
+			));
+		$this->_model_relations = array();
+		foreach ($models_this_can_attach_to as $model) {
+			$this->_model_relations[ $model ] = new EE_Belongs_To_Any_Relation();
+		}
+		foreach ($this->cap_contexts_to_cap_action_map() as $cap_context => $action) {
+			$this->_cap_restriction_generators[ $cap_context ] = new EE_Restriction_Generator_Meta('EXM_key', 'EXM_value');
+		}
+		parent::__construct($timezone);
+	}
 }

Spacing +2 added lines, -2 removed lines

@@ -38,10 +38,10 @@
             ));
         $this->_model_relations = array();
         foreach ($models_this_can_attach_to as $model) {
-            $this->_model_relations[ $model ] = new EE_Belongs_To_Any_Relation();
+            $this->_model_relations[$model] = new EE_Belongs_To_Any_Relation();
         }
         foreach ($this->cap_contexts_to_cap_action_map() as $cap_context => $action) {
-            $this->_cap_restriction_generators[ $cap_context ] = new EE_Restriction_Generator_Meta('EXM_key', 'EXM_value');
+            $this->_cap_restriction_generators[$cap_context] = new EE_Restriction_Generator_Meta('EXM_key', 'EXM_value');
         }
         parent::__construct($timezone);
     }

core/db_models/EEM_Question_Group.model.php

Indentation +51 added lines, -51 removed lines

@@ -10,58 +10,58 @@
  */
 class EEM_Question_Group extends EEM_Soft_Delete_Base
 {
-    const system_personal = 1;
-    const system_address = 2;
-    // private instance of the Attendee object
-    protected static $_instance = null;
+	const system_personal = 1;
+	const system_address = 2;
+	// private instance of the Attendee object
+	protected static $_instance = null;
         
         
-    protected function __construct($timezone = null)
-    {
-        $this->singular_item = __('Question Group', 'event_espresso');
-        $this->plural_item = __('Question Groups', 'event_espresso');
+	protected function __construct($timezone = null)
+	{
+		$this->singular_item = __('Question Group', 'event_espresso');
+		$this->plural_item = __('Question Groups', 'event_espresso');
 
-        $this->_tables = array(
-            'Question_Group'=>new EE_Primary_Table('esp_question_group', 'QSG_ID')
-        );
-        $this->_fields = array(
-            'Question_Group'=>array(
-                'QSG_ID'=>new EE_Primary_Key_Int_Field('QSG_ID', __('Question Group ID', 'event_espresso')),
-                'QSG_name'=>new EE_Plain_Text_Field('QSG_name', __('Question Group Name', 'event_espresso'), false, ''),
-                'QSG_identifier'=>new EE_Plain_Text_Field('QSG_identifier', __('Text ID for question Group', 'event_espresso'), false, ''),
-                'QSG_desc'=>new EE_Post_Content_Field('QSG_desc', __('Description of Question Group', 'event_espresso'), true, ''),
-                'QSG_order'=>new EE_Integer_Field('QSG_order', __('Order in which to show the question group', 'event_espresso'), true, 0),
-                'QSG_show_group_name'=>new EE_Boolean_Field('QSG_show_group_name', __('Flag indicating whether to show the group\'s name on the registration page', 'event_espresso'), false, true),
-                'QSG_show_group_desc'=>new EE_Boolean_Field('QSG_show_group_desc', __('Flag indicating whether to show the group\s description on the registration page', 'event_espresso'), false, false),
-                'QSG_wp_user' => new EE_WP_User_Field('QSG_wp_user', __('Question Group Creator ID', 'event_espresso'), false),
-                'QSG_system'=>new EE_Integer_Field('QSG_system', __('Indicate IF this is a system group and if it is what system group it corresponds to.', 'event_espresso'), false, 0),
-                'QSG_deleted'=>new EE_Trashed_Flag_Field('QSG_deleted', __('Flag indicating this question group was deleted', 'event_espresso'), false, false)
-            )
-        );
-        $this->_model_relations = array(
-            'Question'=>new EE_HABTM_Relation('Question_Group_Question'),
-            'Event'=>new EE_HABTM_Relation('Event_Question_Group'),
-            'Event_Question_Group'=>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();
-        $this->_cap_restriction_generators[ EEM_Base::caps_read_admin ] = new EE_Restriction_Generator_Reg_Form('QSG_system');
-        $this->_cap_restriction_generators[ EEM_Base::caps_edit ] = new EE_Restriction_Generator_Reg_Form('QSG_system');
-        $this->_cap_restriction_generators[ EEM_Base::caps_delete ] = new EE_Restriction_Generator_Reg_Form('QSG_system');
-        parent::__construct($timezone);
-    }
-    /**
-     * searches the db for the question group with the latest question order and returns that value.
-     * @access public
-     * @return int
-     */
-    public function get_latest_question_group_order()
-    {
-        $columns_to_select = array(
-            'max_order' => array("MAX(QSG_order)","%d")
-            );
-        $max = $this->_get_all_wpdb_results(array(), ARRAY_A, $columns_to_select);
-        return $max[0]['max_order'];
-    }
+		$this->_tables = array(
+			'Question_Group'=>new EE_Primary_Table('esp_question_group', 'QSG_ID')
+		);
+		$this->_fields = array(
+			'Question_Group'=>array(
+				'QSG_ID'=>new EE_Primary_Key_Int_Field('QSG_ID', __('Question Group ID', 'event_espresso')),
+				'QSG_name'=>new EE_Plain_Text_Field('QSG_name', __('Question Group Name', 'event_espresso'), false, ''),
+				'QSG_identifier'=>new EE_Plain_Text_Field('QSG_identifier', __('Text ID for question Group', 'event_espresso'), false, ''),
+				'QSG_desc'=>new EE_Post_Content_Field('QSG_desc', __('Description of Question Group', 'event_espresso'), true, ''),
+				'QSG_order'=>new EE_Integer_Field('QSG_order', __('Order in which to show the question group', 'event_espresso'), true, 0),
+				'QSG_show_group_name'=>new EE_Boolean_Field('QSG_show_group_name', __('Flag indicating whether to show the group\'s name on the registration page', 'event_espresso'), false, true),
+				'QSG_show_group_desc'=>new EE_Boolean_Field('QSG_show_group_desc', __('Flag indicating whether to show the group\s description on the registration page', 'event_espresso'), false, false),
+				'QSG_wp_user' => new EE_WP_User_Field('QSG_wp_user', __('Question Group Creator ID', 'event_espresso'), false),
+				'QSG_system'=>new EE_Integer_Field('QSG_system', __('Indicate IF this is a system group and if it is what system group it corresponds to.', 'event_espresso'), false, 0),
+				'QSG_deleted'=>new EE_Trashed_Flag_Field('QSG_deleted', __('Flag indicating this question group was deleted', 'event_espresso'), false, false)
+			)
+		);
+		$this->_model_relations = array(
+			'Question'=>new EE_HABTM_Relation('Question_Group_Question'),
+			'Event'=>new EE_HABTM_Relation('Event_Question_Group'),
+			'Event_Question_Group'=>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();
+		$this->_cap_restriction_generators[ EEM_Base::caps_read_admin ] = new EE_Restriction_Generator_Reg_Form('QSG_system');
+		$this->_cap_restriction_generators[ EEM_Base::caps_edit ] = new EE_Restriction_Generator_Reg_Form('QSG_system');
+		$this->_cap_restriction_generators[ EEM_Base::caps_delete ] = new EE_Restriction_Generator_Reg_Form('QSG_system');
+		parent::__construct($timezone);
+	}
+	/**
+	 * searches the db for the question group with the latest question order and returns that value.
+	 * @access public
+	 * @return int
+	 */
+	public function get_latest_question_group_order()
+	{
+		$columns_to_select = array(
+			'max_order' => array("MAX(QSG_order)","%d")
+			);
+		$max = $this->_get_all_wpdb_results(array(), ARRAY_A, $columns_to_select);
+		return $max[0]['max_order'];
+	}
 }

Spacing +5 added lines, -5 removed lines

@@ -45,10 +45,10 @@ 
             '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_admin ] = new EE_Restriction_Generator_Reg_Form('QSG_system');
-        $this->_cap_restriction_generators[ EEM_Base::caps_edit ] = new EE_Restriction_Generator_Reg_Form('QSG_system');
-        $this->_cap_restriction_generators[ EEM_Base::caps_delete ] = new EE_Restriction_Generator_Reg_Form('QSG_system');
+        $this->_cap_restriction_generators[EEM_Base::caps_read] = new EE_Restriction_Generator_Public();
+        $this->_cap_restriction_generators[EEM_Base::caps_read_admin] = new EE_Restriction_Generator_Reg_Form('QSG_system');
+        $this->_cap_restriction_generators[EEM_Base::caps_edit] = new EE_Restriction_Generator_Reg_Form('QSG_system');
+        $this->_cap_restriction_generators[EEM_Base::caps_delete] = new EE_Restriction_Generator_Reg_Form('QSG_system');
         parent::__construct($timezone);
     }
     /**
@@ -59,7 +59,7 @@ 
     public function get_latest_question_group_order()
     {
         $columns_to_select = array(
-            'max_order' => array("MAX(QSG_order)","%d")
+            'max_order' => array("MAX(QSG_order)", "%d")
             );
         $max = $this->_get_all_wpdb_results(array(), ARRAY_A, $columns_to_select);
         return $max[0]['max_order'];