eventespresso / event-espresso-core

core/request_stack/EE_Request_Stack.core.php

Indentation +21 added lines, -21 removed lines

@@ -13,25 +13,25 @@
 {
 
 
-    /**
-     * @deprecated  4.9.53
-     * @param    EEI_Request_Decorator $application
-     * @param    array                 $middlewares
-     */
-    public function __construct(EEI_Request_Decorator $application, $middlewares = array())
-    {
-        EE_Error::doing_it_wrong(
-            __METHOD__,
-            sprintf(
-                esc_html__(
-                    'This class is deprecated. Please use %1$s instead. All Event Espresso request stack classes have been moved to %2$s and are now under the %3$s namespace',
-                    'event_espresso'
-                ),
-                'EventEspresso\core\services\request\RequestStack',
-                '\core\services\request',
-                'EventEspresso\core\services\request'
-            ),
-            '4.9.53'
-        );
-    }
+	/**
+	 * @deprecated  4.9.53
+	 * @param    EEI_Request_Decorator $application
+	 * @param    array                 $middlewares
+	 */
+	public function __construct(EEI_Request_Decorator $application, $middlewares = array())
+	{
+		EE_Error::doing_it_wrong(
+			__METHOD__,
+			sprintf(
+				esc_html__(
+					'This class is deprecated. Please use %1$s instead. All Event Espresso request stack classes have been moved to %2$s and are now under the %3$s namespace',
+					'event_espresso'
+				),
+				'EventEspresso\core\services\request\RequestStack',
+				'\core\services\request',
+				'EventEspresso\core\services\request'
+			),
+			'4.9.53'
+		);
+	}
 }

core/EES_Shortcode.shortcode.php

Indentation +180 added lines, -180 removed lines

@@ -12,184 +12,184 @@
 abstract class EES_Shortcode extends EE_Base
 {
 
-    /**
-     * @protected   public
-     * @var     array $_attributes
-     */
-    protected $_attributes = array();
-
-
-
-    /**
-     * class constructor - should ONLY be instantiated by EE_Front_Controller
-     */
-    final public function __construct()
-    {
-        $shortcode = LegacyShortcodesManager::generateShortcodeTagFromClassName(get_class($this));
-        // assign shortcode to the preferred callback, which overwrites the "fallback shortcode processor" assigned earlier
-        add_shortcode($shortcode, array($this, 'process_shortcode'));
-        // make sure system knows this is an EE page
-        EE_Registry::instance()->REQ->set_espresso_page(true);
-    }
-
-
-
-    /**
-     * run - initial shortcode module setup called during "parse_request" hook by
-     * \EE_Front_Controller::_initialize_shortcodes() IF this shortcode is going to execute during this request !
-     * It may also get called by \EES_Shortcode::fallback_shortcode_processor() if the shortcode is being implemented
-     * by a theme or plugin in a non-standard way.
-     * Basically this method is primarily used for loading resources and assets like CSS or JS
-     * that will be required by the shortcode when it is actually processed.
-     * Please note that assets may not load if the fallback_shortcode_processor() is being used.
-     *
-     * @access    public
-     * @param WP $WP
-     * @return    void
-     */
-    abstract public function run(WP $WP);
-
-
-
-    /**
-     *  process_shortcode
-     *  this method is the callback function for the actual shortcode, and is what runs when WP encounters the shortcode within the_content
-     *
-     *  @access     public
-     *  @param      array   $attributes
-     *  @return     mixed
-     */
-    abstract public function process_shortcode($attributes = array());
-
-
-
-    /**
-     *    instance - returns instance of child class object
-     *
-     * @access  public
-     * @param   string $shortcode_class
-     * @return  \EES_Shortcode
-     */
-    final public static function instance($shortcode_class = null)
-    {
-        $shortcode_class = ! empty($shortcode_class) ? $shortcode_class : get_called_class();
-        if ($shortcode_class === 'EES_Shortcode' || empty($shortcode_class)) {
-            return null;
-        }
-        $shortcode = str_replace('EES_', '', strtoupper($shortcode_class));
-        $shortcode_obj = isset(EE_Registry::instance()->shortcodes->{$shortcode})
-            ? EE_Registry::instance()->shortcodes->{$shortcode}
-            : null;
-        return $shortcode_obj instanceof $shortcode_class || $shortcode_class === 'self'
-            ? $shortcode_obj
-            : new $shortcode_class();
-    }
-
-
-
-
-    /**
-     *    fallback_shortcode_processor - create instance and call process_shortcode
-     *    NOTE: shortcode may not function perfectly dues to missing assets, but it's better than not having things work at all
-     *
-     * @access  public
-     * @param   $attributes
-     * @return  mixed
-     */
-    final public static function fallback_shortcode_processor($attributes)
-    {
-        if (EE_Maintenance_Mode::disable_frontend_for_maintenance()) {
-            return null;
-        }
-        // what shortcode was actually parsed ?
-        $shortcode_class = get_called_class();
-        // notify rest of system that fallback processor was triggered
-        add_filter('FHEE__fallback_shortcode_processor__' . $shortcode_class, '__return_true');
-        // get instance of actual shortcode
-        $shortcode_obj = self::instance($shortcode_class);
-        // verify class
-        if ($shortcode_obj instanceof EES_Shortcode) {
-            global $wp;
-            $shortcode_obj->run($wp);
-            // set attributes and run the shortcode
-            $shortcode_obj->_attributes = (array) $attributes;
-            return $shortcode_obj->process_shortcode($shortcode_obj->_attributes);
-        } else {
-            return null;
-        }
-    }
-
-
-
-
-    /**
-     *    invalid_shortcode_processor -  used in cases where we know the shortcode is invalid, most likely due to a deactivated addon, and simply returns an empty string
-     *
-     * @access  public
-     * @param   $attributes
-     * @return  string
-     */
-    final public static function invalid_shortcode_processor($attributes)
-    {
-        return '';
-    }
-
-
-
-
-
-    /**
-     * Performs basic sanitization on shortcode attributes
-     * Since incoming attributes from the shortcode usage in the WP editor will all be strings,
-     * most attributes will by default be sanitized using the sanitize_text_field() function.
-     * This can be overridden by supplying an array for the $custom_sanitization param,
-     * where keys match keys in your attributes array,
-     * and values represent the sanitization function you wish to be applied to that attribute.
-     * So for example, if you had an integer attribute named "event_id"
-     * that you wanted to be sanitized using absint(),
-     * then you would pass the following for your $custom_sanitization array:
-     *      array('event_id' => 'absint')
-     * all other attributes would be sanitized using the defaults in the switch statement below
-     *
-     * @param array $attributes
-     * @param array $custom_sanitization
-     * @return array
-     */
-    public static function sanitize_attributes(array $attributes, $custom_sanitization = array())
-    {
-        foreach ($attributes as $key => $value) {
-            // is a custom sanitization callback specified ?
-            if (isset($custom_sanitization[ $key ])) {
-                $callback = $custom_sanitization[ $key ];
-                if ($callback === 'skip_sanitization') {
-                    $attributes[ $key ] = $value;
-                    continue;
-                } elseif (function_exists($callback)) {
-                    $attributes[ $key ] = $callback($value);
-                    continue;
-                }
-            }
-            switch (true) {
-                case $value === null:
-                case is_int($value):
-                case is_float($value):
-                    // typical booleans
-                case in_array($value, array(true, 'true', '1', 'on', 'yes', false, 'false', '0', 'off', 'no'), true):
-                    $attributes[ $key ] = $value;
-                    break;
-                case is_string($value):
-                    $attributes[ $key ] = sanitize_text_field($value);
-                    break;
-                case is_array($value):
-                    $attributes[ $key ] = \EES_Shortcode::sanitize_attributes($value);
-                    break;
-                default:
-                    // only remaining data types are Object and Resource
-                    // which are not allowed as shortcode attributes
-                    $attributes[ $key ] = null;
-                    break;
-            }
-        }
-        return $attributes;
-    }
+	/**
+	 * @protected   public
+	 * @var     array $_attributes
+	 */
+	protected $_attributes = array();
+
+
+
+	/**
+	 * class constructor - should ONLY be instantiated by EE_Front_Controller
+	 */
+	final public function __construct()
+	{
+		$shortcode = LegacyShortcodesManager::generateShortcodeTagFromClassName(get_class($this));
+		// assign shortcode to the preferred callback, which overwrites the "fallback shortcode processor" assigned earlier
+		add_shortcode($shortcode, array($this, 'process_shortcode'));
+		// make sure system knows this is an EE page
+		EE_Registry::instance()->REQ->set_espresso_page(true);
+	}
+
+
+
+	/**
+	 * run - initial shortcode module setup called during "parse_request" hook by
+	 * \EE_Front_Controller::_initialize_shortcodes() IF this shortcode is going to execute during this request !
+	 * It may also get called by \EES_Shortcode::fallback_shortcode_processor() if the shortcode is being implemented
+	 * by a theme or plugin in a non-standard way.
+	 * Basically this method is primarily used for loading resources and assets like CSS or JS
+	 * that will be required by the shortcode when it is actually processed.
+	 * Please note that assets may not load if the fallback_shortcode_processor() is being used.
+	 *
+	 * @access    public
+	 * @param WP $WP
+	 * @return    void
+	 */
+	abstract public function run(WP $WP);
+
+
+
+	/**
+	 *  process_shortcode
+	 *  this method is the callback function for the actual shortcode, and is what runs when WP encounters the shortcode within the_content
+	 *
+	 *  @access     public
+	 *  @param      array   $attributes
+	 *  @return     mixed
+	 */
+	abstract public function process_shortcode($attributes = array());
+
+
+
+	/**
+	 *    instance - returns instance of child class object
+	 *
+	 * @access  public
+	 * @param   string $shortcode_class
+	 * @return  \EES_Shortcode
+	 */
+	final public static function instance($shortcode_class = null)
+	{
+		$shortcode_class = ! empty($shortcode_class) ? $shortcode_class : get_called_class();
+		if ($shortcode_class === 'EES_Shortcode' || empty($shortcode_class)) {
+			return null;
+		}
+		$shortcode = str_replace('EES_', '', strtoupper($shortcode_class));
+		$shortcode_obj = isset(EE_Registry::instance()->shortcodes->{$shortcode})
+			? EE_Registry::instance()->shortcodes->{$shortcode}
+			: null;
+		return $shortcode_obj instanceof $shortcode_class || $shortcode_class === 'self'
+			? $shortcode_obj
+			: new $shortcode_class();
+	}
+
+
+
+
+	/**
+	 *    fallback_shortcode_processor - create instance and call process_shortcode
+	 *    NOTE: shortcode may not function perfectly dues to missing assets, but it's better than not having things work at all
+	 *
+	 * @access  public
+	 * @param   $attributes
+	 * @return  mixed
+	 */
+	final public static function fallback_shortcode_processor($attributes)
+	{
+		if (EE_Maintenance_Mode::disable_frontend_for_maintenance()) {
+			return null;
+		}
+		// what shortcode was actually parsed ?
+		$shortcode_class = get_called_class();
+		// notify rest of system that fallback processor was triggered
+		add_filter('FHEE__fallback_shortcode_processor__' . $shortcode_class, '__return_true');
+		// get instance of actual shortcode
+		$shortcode_obj = self::instance($shortcode_class);
+		// verify class
+		if ($shortcode_obj instanceof EES_Shortcode) {
+			global $wp;
+			$shortcode_obj->run($wp);
+			// set attributes and run the shortcode
+			$shortcode_obj->_attributes = (array) $attributes;
+			return $shortcode_obj->process_shortcode($shortcode_obj->_attributes);
+		} else {
+			return null;
+		}
+	}
+
+
+
+
+	/**
+	 *    invalid_shortcode_processor -  used in cases where we know the shortcode is invalid, most likely due to a deactivated addon, and simply returns an empty string
+	 *
+	 * @access  public
+	 * @param   $attributes
+	 * @return  string
+	 */
+	final public static function invalid_shortcode_processor($attributes)
+	{
+		return '';
+	}
+
+
+
+
+
+	/**
+	 * Performs basic sanitization on shortcode attributes
+	 * Since incoming attributes from the shortcode usage in the WP editor will all be strings,
+	 * most attributes will by default be sanitized using the sanitize_text_field() function.
+	 * This can be overridden by supplying an array for the $custom_sanitization param,
+	 * where keys match keys in your attributes array,
+	 * and values represent the sanitization function you wish to be applied to that attribute.
+	 * So for example, if you had an integer attribute named "event_id"
+	 * that you wanted to be sanitized using absint(),
+	 * then you would pass the following for your $custom_sanitization array:
+	 *      array('event_id' => 'absint')
+	 * all other attributes would be sanitized using the defaults in the switch statement below
+	 *
+	 * @param array $attributes
+	 * @param array $custom_sanitization
+	 * @return array
+	 */
+	public static function sanitize_attributes(array $attributes, $custom_sanitization = array())
+	{
+		foreach ($attributes as $key => $value) {
+			// is a custom sanitization callback specified ?
+			if (isset($custom_sanitization[ $key ])) {
+				$callback = $custom_sanitization[ $key ];
+				if ($callback === 'skip_sanitization') {
+					$attributes[ $key ] = $value;
+					continue;
+				} elseif (function_exists($callback)) {
+					$attributes[ $key ] = $callback($value);
+					continue;
+				}
+			}
+			switch (true) {
+				case $value === null:
+				case is_int($value):
+				case is_float($value):
+					// typical booleans
+				case in_array($value, array(true, 'true', '1', 'on', 'yes', false, 'false', '0', 'off', 'no'), true):
+					$attributes[ $key ] = $value;
+					break;
+				case is_string($value):
+					$attributes[ $key ] = sanitize_text_field($value);
+					break;
+				case is_array($value):
+					$attributes[ $key ] = \EES_Shortcode::sanitize_attributes($value);
+					break;
+				default:
+					// only remaining data types are Object and Resource
+					// which are not allowed as shortcode attributes
+					$attributes[ $key ] = null;
+					break;
+			}
+		}
+		return $attributes;
+	}
 }

Spacing +9 added lines, -9 removed lines

@@ -104,7 +104,7 @@ 
         // what shortcode was actually parsed ?
         $shortcode_class = get_called_class();
         // notify rest of system that fallback processor was triggered
-        add_filter('FHEE__fallback_shortcode_processor__' . $shortcode_class, '__return_true');
+        add_filter('FHEE__fallback_shortcode_processor__'.$shortcode_class, '__return_true');
         // get instance of actual shortcode
         $shortcode_obj = self::instance($shortcode_class);
         // verify class
@@ -159,13 +159,13 @@ 
     {
         foreach ($attributes as $key => $value) {
             // is a custom sanitization callback specified ?
-            if (isset($custom_sanitization[ $key ])) {
-                $callback = $custom_sanitization[ $key ];
+            if (isset($custom_sanitization[$key])) {
+                $callback = $custom_sanitization[$key];
                 if ($callback === 'skip_sanitization') {
-                    $attributes[ $key ] = $value;
+                    $attributes[$key] = $value;
                     continue;
                 } elseif (function_exists($callback)) {
-                    $attributes[ $key ] = $callback($value);
+                    $attributes[$key] = $callback($value);
                     continue;
                 }
             }
@@ -175,18 +175,18 @@ 
                 case is_float($value):
                     // typical booleans
                 case in_array($value, array(true, 'true', '1', 'on', 'yes', false, 'false', '0', 'off', 'no'), true):
-                    $attributes[ $key ] = $value;
+                    $attributes[$key] = $value;
                     break;
                 case is_string($value):
-                    $attributes[ $key ] = sanitize_text_field($value);
+                    $attributes[$key] = sanitize_text_field($value);
                     break;
                 case is_array($value):
-                    $attributes[ $key ] = \EES_Shortcode::sanitize_attributes($value);
+                    $attributes[$key] = \EES_Shortcode::sanitize_attributes($value);
                     break;
                 default:
                     // only remaining data types are Object and Resource
                     // which are not allowed as shortcode attributes
-                    $attributes[ $key ] = null;
+                    $attributes[$key] = null;
                     break;
             }
         }

core/EE_Base_Class_Repository.core.php

Indentation +94 added lines, -94 removed lines

@@ -16,108 +16,108 @@
 abstract class EE_Base_Class_Repository extends EE_Object_Repository implements EEI_Deletable
 {
 
-    /**
-     * EE_Base_Class_Repository constructor.
-     */
-    public function __construct()
-    {
-        $this->persist_method = 'save';
-    }
+	/**
+	 * EE_Base_Class_Repository constructor.
+	 */
+	public function __construct()
+	{
+		$this->persist_method = 'save';
+	}
 
 
-    /**
-     * save
-     *
-     * calls EE_Base_Class::save() on the current object
-     * an array of arguments can also be supplied that will be passed along to EE_Base_Class::save(),
-     * where each element of the $arguments array corresponds to a parameter for the callback method
-     * PLZ NOTE: if the first argument of the callback requires an array, for example array( 'key' => 'value' )
-     * then $arguments needs to be a DOUBLE array ie: array( array( 'key' => 'value' ) )
-     *
-     * @access public
-     * @param array $arguments arrays of arguments that will be passed to the object's save method
-     * @return bool | int
-     */
-    public function save($arguments = array())
-    {
-        return $this->persist('save', $arguments);
-    }
+	/**
+	 * save
+	 *
+	 * calls EE_Base_Class::save() on the current object
+	 * an array of arguments can also be supplied that will be passed along to EE_Base_Class::save(),
+	 * where each element of the $arguments array corresponds to a parameter for the callback method
+	 * PLZ NOTE: if the first argument of the callback requires an array, for example array( 'key' => 'value' )
+	 * then $arguments needs to be a DOUBLE array ie: array( array( 'key' => 'value' ) )
+	 *
+	 * @access public
+	 * @param array $arguments arrays of arguments that will be passed to the object's save method
+	 * @return bool | int
+	 */
+	public function save($arguments = array())
+	{
+		return $this->persist('save', $arguments);
+	}
 
 
-    /**
-     * save_all
-     *
-     * calls EE_Base_Class::save() on ALL objects in the repository
-     *
-     * @access public
-     * @return bool | int
-     */
-    public function save_all()
-    {
-        return $this->persist_all('save');
-    }
+	/**
+	 * save_all
+	 *
+	 * calls EE_Base_Class::save() on ALL objects in the repository
+	 *
+	 * @access public
+	 * @return bool | int
+	 */
+	public function save_all()
+	{
+		return $this->persist_all('save');
+	}
 
 
-    /**
-     * Calls EE_Base_Class::delete() on the current object
-     * Keep in mind that this always detaches the object from the collection
-     * regardless of whether the delete was successful for the db.  This is because
-     * its possible that the object ONLY existed in the collection.
-     *
-     * @access public
-     * @return bool
-     */
-    public function delete()
-    {
-        $success = $this->_call_user_func_array_on_current('delete');
-        $this->remove($this->current());
-        return $success;
-    }
+	/**
+	 * Calls EE_Base_Class::delete() on the current object
+	 * Keep in mind that this always detaches the object from the collection
+	 * regardless of whether the delete was successful for the db.  This is because
+	 * its possible that the object ONLY existed in the collection.
+	 *
+	 * @access public
+	 * @return bool
+	 */
+	public function delete()
+	{
+		$success = $this->_call_user_func_array_on_current('delete');
+		$this->remove($this->current());
+		return $success;
+	}
 
 
-    /**
-     * delete_all
-     *
-     * calls EE_Base_Class::delete() on ALL objects in the repository
-     *
-     * @access public
-     * @return bool
-     */
-    public function delete_all()
-    {
-        $success = true;
-        $this->rewind();
-        while ($this->valid()) {
-            // any db error will result in false being returned
-            $success = $this->_call_user_func_array_on_current('delete') !== false ? $success : false;
-            // can't remove current object because valid() requires it
-            // so just capture current object temporarily
-            $object = $this->current();
-            // advance the pointer
-            $this->next();
-            // THEN remove the object from the repository
-            $this->remove($object);
-        }
-        return $success;
-    }
+	/**
+	 * delete_all
+	 *
+	 * calls EE_Base_Class::delete() on ALL objects in the repository
+	 *
+	 * @access public
+	 * @return bool
+	 */
+	public function delete_all()
+	{
+		$success = true;
+		$this->rewind();
+		while ($this->valid()) {
+			// any db error will result in false being returned
+			$success = $this->_call_user_func_array_on_current('delete') !== false ? $success : false;
+			// can't remove current object because valid() requires it
+			// so just capture current object temporarily
+			$object = $this->current();
+			// advance the pointer
+			$this->next();
+			// THEN remove the object from the repository
+			$this->remove($object);
+		}
+		return $success;
+	}
 
 
-    /**
-     * update_extra_meta
-     *
-     * calls EE_Base_Class::update_extra_meta() on the current object using the supplied values
-     *
-     * @access public
-     * @param string $meta_key
-     * @param string $meta_value
-     * @param string $previous_value
-     * @return bool | int
-     */
-    public function update_extra_meta($meta_key, $meta_value, $previous_value = null)
-    {
-        return $this->_call_user_func_array_on_current(
-            'update_extra_meta',
-            array($meta_key, $meta_value, $previous_value)
-        );
-    }
+	/**
+	 * update_extra_meta
+	 *
+	 * calls EE_Base_Class::update_extra_meta() on the current object using the supplied values
+	 *
+	 * @access public
+	 * @param string $meta_key
+	 * @param string $meta_value
+	 * @param string $previous_value
+	 * @return bool | int
+	 */
+	public function update_extra_meta($meta_key, $meta_value, $previous_value = null)
+	{
+		return $this->_call_user_func_array_on_current(
+			'update_extra_meta',
+			array($meta_key, $meta_value, $previous_value)
+		);
+	}
 }

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

Spacing +2 added lines, -2 removed lines

@@ -59,11 +59,11 @@
         );
         $this->_model_relations = array();
         foreach ($models_this_can_attach_to as $model) {
-            $this->_model_relations[ $model ] = new EE_Belongs_To_Relation();
+            $this->_model_relations[$model] = new EE_Belongs_To_Relation();
         }
         $this->_wp_core_model = true;
         foreach ($this->cap_contexts_to_cap_action_map() as $cap_context => $action) {
-            $this->_cap_restriction_generators[ $cap_context ] = new EE_Restriction_Generator_Meta(
+            $this->_cap_restriction_generators[$cap_context] = new EE_Restriction_Generator_Meta(
                 'meta_key',
                 'meta_value'
             );

Indentation +49 added lines, -49 removed lines

@@ -18,56 +18,56 @@
 class EEM_Post_Meta extends EEM_Base
 {
 
-    // private instance of the EE_Post_Meta object
-    protected static $_instance;
+	// private instance of the EE_Post_Meta object
+	protected static $_instance;
 
 
 
-    protected function __construct(string $timezone = '')
-    {
-        $this->singular_item = esc_html__('Post Meta', 'event_espresso');
-        $this->plural_item = esc_html__('Post Metas', 'event_espresso');
-        $this->_tables = array(
-            'Post_Meta' => new EE_Primary_Table('postmeta', 'meta_id'),
-        );
-        $models_this_can_attach_to = array_keys(EE_Registry::instance()->cpt_models());
-        $this->_fields = array(
-            'Post_Meta' => array(
-                'meta_id'    => new EE_Primary_Key_Int_Field(
-                    'meta_id',
-                    esc_html__("Meta ID", "event_espresso")
-                ),
-                'post_id'    => new EE_Foreign_Key_Int_Field(
-                    'post_id',
-                    esc_html__("Primary Key of Post", "event_espresso"),
-                    false,
-                    0,
-                    $models_this_can_attach_to
-                ),
-                'meta_key'   => new EE_Plain_Text_Field(
-                    'meta_key',
-                    esc_html__("Meta Key", "event_espresso"),
-                    false,
-                    ''
-                ),
-                'meta_value' => new EE_Maybe_Serialized_Text_Field(
-                    'meta_value',
-                    esc_html__("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_Relation();
-        }
-        $this->_wp_core_model = true;
-        foreach ($this->cap_contexts_to_cap_action_map() as $cap_context => $action) {
-            $this->_cap_restriction_generators[ $cap_context ] = new EE_Restriction_Generator_Meta(
-                'meta_key',
-                'meta_value'
-            );
-        }
-        parent::__construct($timezone);
-    }
+	protected function __construct(string $timezone = '')
+	{
+		$this->singular_item = esc_html__('Post Meta', 'event_espresso');
+		$this->plural_item = esc_html__('Post Metas', 'event_espresso');
+		$this->_tables = array(
+			'Post_Meta' => new EE_Primary_Table('postmeta', 'meta_id'),
+		);
+		$models_this_can_attach_to = array_keys(EE_Registry::instance()->cpt_models());
+		$this->_fields = array(
+			'Post_Meta' => array(
+				'meta_id'    => new EE_Primary_Key_Int_Field(
+					'meta_id',
+					esc_html__("Meta ID", "event_espresso")
+				),
+				'post_id'    => new EE_Foreign_Key_Int_Field(
+					'post_id',
+					esc_html__("Primary Key of Post", "event_espresso"),
+					false,
+					0,
+					$models_this_can_attach_to
+				),
+				'meta_key'   => new EE_Plain_Text_Field(
+					'meta_key',
+					esc_html__("Meta Key", "event_espresso"),
+					false,
+					''
+				),
+				'meta_value' => new EE_Maybe_Serialized_Text_Field(
+					'meta_value',
+					esc_html__("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_Relation();
+		}
+		$this->_wp_core_model = true;
+		foreach ($this->cap_contexts_to_cap_action_map() as $cap_context => $action) {
+			$this->_cap_restriction_generators[ $cap_context ] = new EE_Restriction_Generator_Meta(
+				'meta_key',
+				'meta_value'
+			);
+		}
+		parent::__construct($timezone);
+	}
 }

core/db_models/fields/EE_Float_Field.php

Indentation +62 added lines, -62 removed lines

@@ -7,77 +7,77 @@
 class EE_Float_Field extends EE_Model_Field_Base
 {
 
-    /**
-     * @param string $table_column
-     * @param string $nicename
-     * @param bool   $nullable
-     * @param null   $default_value
-     */
-    public function __construct($table_column, $nicename, $nullable, $default_value = null)
-    {
-        parent::__construct($table_column, $nicename, $nullable, $default_value);
-        $this->setSchemaType('number');
-    }
+	/**
+	 * @param string $table_column
+	 * @param string $nicename
+	 * @param bool   $nullable
+	 * @param null   $default_value
+	 */
+	public function __construct($table_column, $nicename, $nullable, $default_value = null)
+	{
+		parent::__construct($table_column, $nicename, $nullable, $default_value);
+		$this->setSchemaType('number');
+	}
 
 
-    /**
-     * If provided a string, strips out number-related formatting, like commas, periods, spaces, other junk, etc.
-     * However, treats commas and periods as thousand-separators ro decimal marks, as indicate by the config's currency.
-     * So if you want to pass in a string that NEEDS to interpret periods as decimal marks, call floatval() on it first.
-     * Returns a float
-     *
-     * @param type $value_inputted_for_field_on_model_object
-     * @return float
-     */
-    public function prepare_for_set($value_inputted_for_field_on_model_object)
-    {
+	/**
+	 * If provided a string, strips out number-related formatting, like commas, periods, spaces, other junk, etc.
+	 * However, treats commas and periods as thousand-separators ro decimal marks, as indicate by the config's currency.
+	 * So if you want to pass in a string that NEEDS to interpret periods as decimal marks, call floatval() on it first.
+	 * Returns a float
+	 *
+	 * @param type $value_inputted_for_field_on_model_object
+	 * @return float
+	 */
+	public function prepare_for_set($value_inputted_for_field_on_model_object)
+	{
 //      echo __LINE__."$value_inputted_for_field_on_model_object<br>";
-        // remove whitespaces and thousands separators
-        if (is_string($value_inputted_for_field_on_model_object)) {
-            $value_inputted_for_field_on_model_object = str_replace(
-                array(" ", EE_Config::instance()->currency->thsnds),
-                "",
-                $value_inputted_for_field_on_model_object
-            );
+		// remove whitespaces and thousands separators
+		if (is_string($value_inputted_for_field_on_model_object)) {
+			$value_inputted_for_field_on_model_object = str_replace(
+				array(" ", EE_Config::instance()->currency->thsnds),
+				"",
+				$value_inputted_for_field_on_model_object
+			);
 // echo __LINE__."$value_inputted_for_field_on_model_object<br>";
 // normalize it so periods are decimal marks (we don't care where you're from: we're talking PHP now)
-            $value_inputted_for_field_on_model_object = str_replace(
-                EE_Config::instance()->currency->dec_mrk,
-                ".",
-                $value_inputted_for_field_on_model_object
-            );
+			$value_inputted_for_field_on_model_object = str_replace(
+				EE_Config::instance()->currency->dec_mrk,
+				".",
+				$value_inputted_for_field_on_model_object
+			);
 // echo __LINE__."$value_inputted_for_field_on_model_object<br>";
 // double-check there's absolutely nothing left on this string besides numbers
-            $value_inputted_for_field_on_model_object = preg_replace(
-                "/[^0-9,.]/",
-                "",
-                $value_inputted_for_field_on_model_object
-            );
-        }
+			$value_inputted_for_field_on_model_object = preg_replace(
+				"/[^0-9,.]/",
+				"",
+				$value_inputted_for_field_on_model_object
+			);
+		}
 //      echo __LINE__."$value_inputted_for_field_on_model_object<br>";
-        return floatval($value_inputted_for_field_on_model_object);
-    }
+		return floatval($value_inputted_for_field_on_model_object);
+	}
 
-    /**
-     * Returns the number formatted according to local custom (set by the country of the blog).
-     *
-     * @param float $value_on_field_to_be_outputted
-     * @return string
-     */
-    public function prepare_for_pretty_echoing($value_on_field_to_be_outputted, $schema = null)
-    {
-        $EE = EE_Registry::instance();
-        return number_format(
-            $value_on_field_to_be_outputted,
-            $EE->CFG->currency->dec_plc,
-            $EE->CFG->currency->dec_mrk,
-            $EE->CFG->currency->thsnds
-        );
-    }
+	/**
+	 * Returns the number formatted according to local custom (set by the country of the blog).
+	 *
+	 * @param float $value_on_field_to_be_outputted
+	 * @return string
+	 */
+	public function prepare_for_pretty_echoing($value_on_field_to_be_outputted, $schema = null)
+	{
+		$EE = EE_Registry::instance();
+		return number_format(
+			$value_on_field_to_be_outputted,
+			$EE->CFG->currency->dec_plc,
+			$EE->CFG->currency->dec_mrk,
+			$EE->CFG->currency->thsnds
+		);
+	}
 
-    public function prepare_for_set_from_db($value_found_in_db_for_model_object)
-    {
+	public function prepare_for_set_from_db($value_found_in_db_for_model_object)
+	{
 //      echo "prepare for set from db of ";d($value_found_in_db_for_model_object);
-        return floatval($value_found_in_db_for_model_object);
-    }
+		return floatval($value_found_in_db_for_model_object);
+	}
 }

core/db_models/fields/EE_Text_Field_Base.php

Indentation +43 added lines, -43 removed lines

@@ -7,49 +7,49 @@
 abstract class EE_Text_Field_Base extends EE_Model_Field_Base
 {
 
-    /**
-     * Gets the value in the format expected when being set.
-     * For display on the front-end, usually you would use prepare_for_pretty_echoing() instead.
-     * @param mixed $value_of_field_on_model_object
-     * @return mixed|string
-     */
-    public function prepare_for_get($value_of_field_on_model_object)
-    {
-        return $value_of_field_on_model_object;
-    }
+	/**
+	 * Gets the value in the format expected when being set.
+	 * For display on the front-end, usually you would use prepare_for_pretty_echoing() instead.
+	 * @param mixed $value_of_field_on_model_object
+	 * @return mixed|string
+	 */
+	public function prepare_for_get($value_of_field_on_model_object)
+	{
+		return $value_of_field_on_model_object;
+	}
 
-    /**
-     * Accepts schema of 'form_input' which formats the string for echoing in form input's value.
-     *
-     * @param string $value_on_field_to_be_outputted
-     * @param string $schema
-     * @return string
-     */
-    public function prepare_for_pretty_echoing($value_on_field_to_be_outputted, $schema = null)
-    {
-        if ($schema === 'form_input') {
-            $value_on_field_to_be_outputted = (string) htmlentities(
-                $value_on_field_to_be_outputted,
-                ENT_QUOTES,
-                'UTF-8'
-            );
-        }
-        return parent::prepare_for_pretty_echoing($value_on_field_to_be_outputted);
-    }
+	/**
+	 * Accepts schema of 'form_input' which formats the string for echoing in form input's value.
+	 *
+	 * @param string $value_on_field_to_be_outputted
+	 * @param string $schema
+	 * @return string
+	 */
+	public function prepare_for_pretty_echoing($value_on_field_to_be_outputted, $schema = null)
+	{
+		if ($schema === 'form_input') {
+			$value_on_field_to_be_outputted = (string) htmlentities(
+				$value_on_field_to_be_outputted,
+				ENT_QUOTES,
+				'UTF-8'
+			);
+		}
+		return parent::prepare_for_pretty_echoing($value_on_field_to_be_outputted);
+	}
 
-    /**
-     * Data received from the user should be exactly as they hope to save it in the DB, with the exception that
-     * quotes need to have slashes added to it. This method takes care of removing the slashes added by WP
-     * in magic-quotes fashion. We used to call html_entity_decode on the value here,
-     * because we called htmlentities when in EE_Text_Field_Base::prepare_for_pretty_echoing, but that's not necessary
-     * because web browsers always decode HTML entities in element attributes, like a form element's value attribute.
-     * So if we do it again here, we'll be removing HTML entities the user intended to have.)
-     *
-     * @param string $value_inputted_for_field_on_model_object
-     * @return string
-     */
-    public function prepare_for_set($value_inputted_for_field_on_model_object)
-    {
-        return stripslashes(parent::prepare_for_set($value_inputted_for_field_on_model_object));
-    }
+	/**
+	 * Data received from the user should be exactly as they hope to save it in the DB, with the exception that
+	 * quotes need to have slashes added to it. This method takes care of removing the slashes added by WP
+	 * in magic-quotes fashion. We used to call html_entity_decode on the value here,
+	 * because we called htmlentities when in EE_Text_Field_Base::prepare_for_pretty_echoing, but that's not necessary
+	 * because web browsers always decode HTML entities in element attributes, like a form element's value attribute.
+	 * So if we do it again here, we'll be removing HTML entities the user intended to have.)
+	 *
+	 * @param string $value_inputted_for_field_on_model_object
+	 * @return string
+	 */
+	public function prepare_for_set($value_inputted_for_field_on_model_object)
+	{
+		return stripslashes(parent::prepare_for_set($value_inputted_for_field_on_model_object));
+	}
 }

core/db_models/fields/EE_Slug_Field.php

Indentation +11 added lines, -11 removed lines

@@ -2,15 +2,15 @@
 
 class EE_Slug_Field extends EE_Text_Field_Base
 {
-    /**
-     * ensures string is usable in URLs
-     *
-     * @param string $value_inputted_for_field_on_model_object
-     * @return string
-     */
-    public function prepare_for_set($value_inputted_for_field_on_model_object)
-    {
-        // reminder: function prepares for use in URLs, not making human-readable.
-        return sanitize_title($value_inputted_for_field_on_model_object);
-    }
+	/**
+	 * ensures string is usable in URLs
+	 *
+	 * @param string $value_inputted_for_field_on_model_object
+	 * @return string
+	 */
+	public function prepare_for_set($value_inputted_for_field_on_model_object)
+	{
+		// reminder: function prepares for use in URLs, not making human-readable.
+		return sanitize_title($value_inputted_for_field_on_model_object);
+	}
 }

core/db_models/fields/EE_Primary_Key_Int_Field.php

Indentation +20 added lines, -20 removed lines

@@ -3,27 +3,27 @@
 class EE_Primary_Key_Int_Field extends EE_Primary_Key_Field_Base
 {
 
-    public function __construct($table_column, $nicename)
-    {
-        parent::__construct($table_column, $nicename, 0);
-        $this->setSchemaType('integer');
-    }
+	public function __construct($table_column, $nicename)
+	{
+		parent::__construct($table_column, $nicename, 0);
+		$this->setSchemaType('integer');
+	}
 
-    public function prepare_for_set($value_inputted_for_field_on_model_object)
-    {
-        if ($this->is_model_obj_of_type_pointed_to($value_inputted_for_field_on_model_object)) {
-            $value_inputted_for_field_on_model_object = $value_inputted_for_field_on_model_object->ID();
-        }
-        return absint($value_inputted_for_field_on_model_object);
-    }
+	public function prepare_for_set($value_inputted_for_field_on_model_object)
+	{
+		if ($this->is_model_obj_of_type_pointed_to($value_inputted_for_field_on_model_object)) {
+			$value_inputted_for_field_on_model_object = $value_inputted_for_field_on_model_object->ID();
+		}
+		return absint($value_inputted_for_field_on_model_object);
+	}
 
-    public function prepare_for_set_from_db($value_found_in_db_for_model_object)
-    {
-        return intval($value_found_in_db_for_model_object);
-    }
+	public function prepare_for_set_from_db($value_found_in_db_for_model_object)
+	{
+		return intval($value_found_in_db_for_model_object);
+	}
 
-    public function is_auto_increment()
-    {
-        return true;
-    }
+	public function is_auto_increment()
+	{
+		return true;
+	}
 }