eventespresso / event-espresso-core

core/db_models/fields/EE_Primary_Key_Field_Base.php

Doc Comments +1 added lines

@@ -7,6 +7,7 @@
      *
      * @param string $table_column
      * @param string $nicename
+     * @param integer|null $default
      */
     public function __construct($table_column, $nicename, $default)
     {

Indentation +19 added lines, -19 removed lines

@@ -2,24 +2,24 @@
 
 abstract class EE_Primary_Key_Field_Base extends EE_Field_With_Model_Name
 {
-    /**
-     * Overrides parent so it doesn't need to provide so many non-applicable fields
-     *
-     * @param string $table_column
-     * @param string $nicename
-     */
-    public function __construct($table_column, $nicename, $default)
-    {
-        parent::__construct($table_column, $nicename, false, $default, null);
-    }
+	/**
+	 * Overrides parent so it doesn't need to provide so many non-applicable fields
+	 *
+	 * @param string $table_column
+	 * @param string $nicename
+	 */
+	public function __construct($table_column, $nicename, $default)
+	{
+		parent::__construct($table_column, $nicename, false, $default, null);
+	}
 
-    /**
-     * @param $table_alias
-     * @param $name
-     */
-    function _construct_finalize($table_alias, $name, $model_name)
-    {
-        $this->_model_name_pointed_to = $model_name;
-        parent::_construct_finalize($table_alias, $name, $model_name);
-    }
+	/**
+	 * @param $table_alias
+	 * @param $name
+	 */
+	function _construct_finalize($table_alias, $name, $model_name)
+	{
+		$this->_model_name_pointed_to = $model_name;
+		parent::_construct_finalize($table_alias, $name, $model_name);
+	}
 }

core/db_models/fields/EE_WP_Post_Status_Field.php

Doc Comments -2 removed lines

@@ -33,8 +33,6 @@
      *                                    )
      *                                    )
      * @link http://codex.wordpress.org/Function_Reference/register_post_status for more info
-     * @param boolean $store_in_db_as_int By default, enums are stored as STRINGS in the DB. However, if this var is
-     *                                    set to true, it will be stored as an INT
      */
     function __construct($table_column, $nicename, $nullable, $default_value, $new_stati = array())
     {

Indentation +112 added lines, -112 removed lines

@@ -4,116 +4,116 @@
 class EE_WP_Post_Status_Field extends EE_Enum_Text_Field
 {
 
-    protected $_wp_post_stati;
-
-
-    /**
-     * constructor
-     *
-     * @param string  $table_column       column on table
-     * @param string  $nicename           nice name for column(field)
-     * @param bool    $nullable           is this field nullable
-     * @param string  $default_value      default status
-     * @param array   $new_stati          If additional stati are to be used other than the default WP statuses then
-     *                                    they can be registered via this property.  The format of the array should be
-     *                                    as follows: array(
-     *                                    'status_reference' => array(
-     *                                    'label' => __('Status Reference Label', 'event_espresso')
-     *                                    'public' => true, //'Whether posts of this status should be shown on the
-     *                                    frontend of the site'
-     *                                    'exclude_from_search' => false, //'Whether posts of this status should be
-     *                                    excluded from wp searches'
-     *                                    'show_in_admin_all_list' => true, //whether posts of this status are included
-     *                                    in queries for the admin "all" view in list table views.
-     *                                    'show_in_admin_status_list' => true, //Show in the list of statuses with post
-     *                                    counts at the top of the admin list tables (i.e. Status Reference(2) )
-     *                                    'label_count' => _n_noop( 'Status Reference <span class="count">(%s)</span>',
-     *                                    'Status References <span class="count">(%s)</span>' ), //the text to display
-     *                                    on the admin screen( or you won't see your status count ).
-     *                                    )
-     *                                    )
-     * @link http://codex.wordpress.org/Function_Reference/register_post_status for more info
-     * @param boolean $store_in_db_as_int By default, enums are stored as STRINGS in the DB. However, if this var is
-     *                                    set to true, it will be stored as an INT
-     */
-    function __construct($table_column, $nicename, $nullable, $default_value, $new_stati = array())
-    {
-        $this->_register_new_stati($new_stati);
-        $this->_set_allowed_enum_values();
-        parent::__construct($table_column, $nicename, $nullable, $default_value, $this->_allowed_enum_values);
-    }
-
-
-    /**
-     * This registers any new statuses sent via the $new_stati array on construct
-     *
-     * @access protected
-     * @param  array $new_stati statuses
-     * @return void
-     */
-    protected function _register_new_stati($new_stati)
-    {
-
-        foreach ((array)$new_stati as $status_key => $status_args) {
-            $args = array(
-                'label'                     => isset($status_args['label']) ? $status_args['label'] : $status_key,
-                'public'                    => isset($status_args['public']) && is_bool($status_args['public']) ? $status_args['public'] : true,
-                'exclude_from_search'       => isset($status_args['exclude_from_search']) && is_bool($status_args['exclude_from_search']) ? $status_args['exclude_from_search'] : false,
-                'show_in_admin_all_list'    => isset($status_args['show_in_admin_all_list']) && is_bool($status_args['show_in_admin_all_list']) ? $status_args['show_in_admin_all_list'] : false,
-                'show_in_admin_status_list' => isset($status_args['show_in_admin_status_list']) && is_bool($status_args['show_in_admin_status_list']) ? $status_args['show_in_admin_status_list'] : true,
-                'label_count'               => isset($status_args['label_count']) ? $status_args['label_count'] : '',
-            );
-            register_post_status($status_key, $status_args);
-        }
-
-    }
-
-
-    /**
-     * This sets the _allowed_enum_values property using the $wp_post_stati array
-     *
-     * @access protected
-     * @regurn void
-     */
-    protected function _set_allowed_enum_values()
-    {
-        //first let's get the post_statuses
-        global $wp_post_statuses;
-        $this->_wp_post_stati = $wp_post_statuses;
-
-        foreach ($this->_wp_post_stati as $post_status => $args_object) {
-            $this->_allowed_enum_values[$post_status] = $args_object->label;
-        }
-
-    }
-
-    /**
-     * Before calling parent, first double-checks our list of acceptable post
-     * types is up-to-date
-     *
-     * @param string $value_inputted_for_field_on_model_object
-     * @return string
-     */
-    public function prepare_for_set($value_inputted_for_field_on_model_object)
-    {
-        $this->_set_allowed_enum_values();
-        return parent::prepare_for_set($value_inputted_for_field_on_model_object);
-    }
-
-
-
-    //helper methods for getting various $wp_post_statuses stuff.
-
-    /**
-     * This just returns the status object for the given status
-     *
-     * @access public
-     * @see    wp_register_post_status in wp-includes/post.php for a list of properties of the status object
-     * @param  string $status What status object you want
-     * @return std_object         the status object or FALSE if it doesn't exist.
-     */
-    public function get_status_object($status)
-    {
-        return isset($this->_wp_post_stati[$status]) ? $this->_wp_post_stati[$status] : false;
-    }
+	protected $_wp_post_stati;
+
+
+	/**
+	 * constructor
+	 *
+	 * @param string  $table_column       column on table
+	 * @param string  $nicename           nice name for column(field)
+	 * @param bool    $nullable           is this field nullable
+	 * @param string  $default_value      default status
+	 * @param array   $new_stati          If additional stati are to be used other than the default WP statuses then
+	 *                                    they can be registered via this property.  The format of the array should be
+	 *                                    as follows: array(
+	 *                                    'status_reference' => array(
+	 *                                    'label' => __('Status Reference Label', 'event_espresso')
+	 *                                    'public' => true, //'Whether posts of this status should be shown on the
+	 *                                    frontend of the site'
+	 *                                    'exclude_from_search' => false, //'Whether posts of this status should be
+	 *                                    excluded from wp searches'
+	 *                                    'show_in_admin_all_list' => true, //whether posts of this status are included
+	 *                                    in queries for the admin "all" view in list table views.
+	 *                                    'show_in_admin_status_list' => true, //Show in the list of statuses with post
+	 *                                    counts at the top of the admin list tables (i.e. Status Reference(2) )
+	 *                                    'label_count' => _n_noop( 'Status Reference <span class="count">(%s)</span>',
+	 *                                    'Status References <span class="count">(%s)</span>' ), //the text to display
+	 *                                    on the admin screen( or you won't see your status count ).
+	 *                                    )
+	 *                                    )
+	 * @link http://codex.wordpress.org/Function_Reference/register_post_status for more info
+	 * @param boolean $store_in_db_as_int By default, enums are stored as STRINGS in the DB. However, if this var is
+	 *                                    set to true, it will be stored as an INT
+	 */
+	function __construct($table_column, $nicename, $nullable, $default_value, $new_stati = array())
+	{
+		$this->_register_new_stati($new_stati);
+		$this->_set_allowed_enum_values();
+		parent::__construct($table_column, $nicename, $nullable, $default_value, $this->_allowed_enum_values);
+	}
+
+
+	/**
+	 * This registers any new statuses sent via the $new_stati array on construct
+	 *
+	 * @access protected
+	 * @param  array $new_stati statuses
+	 * @return void
+	 */
+	protected function _register_new_stati($new_stati)
+	{
+
+		foreach ((array)$new_stati as $status_key => $status_args) {
+			$args = array(
+				'label'                     => isset($status_args['label']) ? $status_args['label'] : $status_key,
+				'public'                    => isset($status_args['public']) && is_bool($status_args['public']) ? $status_args['public'] : true,
+				'exclude_from_search'       => isset($status_args['exclude_from_search']) && is_bool($status_args['exclude_from_search']) ? $status_args['exclude_from_search'] : false,
+				'show_in_admin_all_list'    => isset($status_args['show_in_admin_all_list']) && is_bool($status_args['show_in_admin_all_list']) ? $status_args['show_in_admin_all_list'] : false,
+				'show_in_admin_status_list' => isset($status_args['show_in_admin_status_list']) && is_bool($status_args['show_in_admin_status_list']) ? $status_args['show_in_admin_status_list'] : true,
+				'label_count'               => isset($status_args['label_count']) ? $status_args['label_count'] : '',
+			);
+			register_post_status($status_key, $status_args);
+		}
+
+	}
+
+
+	/**
+	 * This sets the _allowed_enum_values property using the $wp_post_stati array
+	 *
+	 * @access protected
+	 * @regurn void
+	 */
+	protected function _set_allowed_enum_values()
+	{
+		//first let's get the post_statuses
+		global $wp_post_statuses;
+		$this->_wp_post_stati = $wp_post_statuses;
+
+		foreach ($this->_wp_post_stati as $post_status => $args_object) {
+			$this->_allowed_enum_values[$post_status] = $args_object->label;
+		}
+
+	}
+
+	/**
+	 * Before calling parent, first double-checks our list of acceptable post
+	 * types is up-to-date
+	 *
+	 * @param string $value_inputted_for_field_on_model_object
+	 * @return string
+	 */
+	public function prepare_for_set($value_inputted_for_field_on_model_object)
+	{
+		$this->_set_allowed_enum_values();
+		return parent::prepare_for_set($value_inputted_for_field_on_model_object);
+	}
+
+
+
+	//helper methods for getting various $wp_post_statuses stuff.
+
+	/**
+	 * This just returns the status object for the given status
+	 *
+	 * @access public
+	 * @see    wp_register_post_status in wp-includes/post.php for a list of properties of the status object
+	 * @param  string $status What status object you want
+	 * @return std_object         the status object or FALSE if it doesn't exist.
+	 */
+	public function get_status_object($status)
+	{
+		return isset($this->_wp_post_stati[$status]) ? $this->_wp_post_stati[$status] : false;
+	}
 }
\ No newline at end of file

Spacing +2 added lines, -2 removed lines

@@ -1,5 +1,5 @@ 
 <?php
-require_once(EE_MODELS . 'fields/EE_Enum_Text_Field.php');
+require_once(EE_MODELS.'fields/EE_Enum_Text_Field.php');
 
 class EE_WP_Post_Status_Field extends EE_Enum_Text_Field
 {
@@ -54,7 +54,7 @@ 
     protected function _register_new_stati($new_stati)
     {
 
-        foreach ((array)$new_stati as $status_key => $status_args) {
+        foreach ((array) $new_stati as $status_key => $status_args) {
             $args = array(
                 'label'                     => isset($status_args['label']) ? $status_args['label'] : $status_key,
                 'public'                    => isset($status_args['public']) && is_bool($status_args['public']) ? $status_args['public'] : true,

core/db_models/fields/EE_Foreign_Key_String_Field.php

Spacing +1 added lines, -1 removed lines

@@ -1,5 +1,5 @@
 <?php
-require_once(EE_MODELS . 'fields/EE_Foreign_Key_Field_Base.php');
+require_once(EE_MODELS.'fields/EE_Foreign_Key_Field_Base.php');
 
 class EE_Foreign_Key_String_Field extends EE_Foreign_Key_Field_Base
 {

Indentation +13 added lines, -13 removed lines

@@ -4,17 +4,17 @@
 class EE_Foreign_Key_String_Field extends EE_Foreign_Key_Field_Base
 {
 
-    /**
-     * removes all tags when setting
-     *
-     * @param string $value_inputted_for_field_on_model_object
-     * @return string
-     */
-    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 strtoupper(wp_strip_all_tags($value_inputted_for_field_on_model_object));
-    }
+	/**
+	 * removes all tags when setting
+	 *
+	 * @param string $value_inputted_for_field_on_model_object
+	 * @return string
+	 */
+	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 strtoupper(wp_strip_all_tags($value_inputted_for_field_on_model_object));
+	}
 }
\ No newline at end of file

core/db_models/fields/EE_Trashed_Flag_Field.php

Indentation +2 added lines, -2 removed lines

@@ -3,6 +3,6 @@
 
 class EE_Trashed_Flag_Field extends EE_Boolean_Field
 {
-    //note: some client code simply checks if a field IS an EE_Trashed_Flag_Field
-    //...otherwise, these fields are mostly the same as boolean fields
+	//note: some client code simply checks if a field IS an EE_Trashed_Flag_Field
+	//...otherwise, these fields are mostly the same as boolean fields
 }

Spacing +1 added lines, -1 removed lines

@@ -1,5 +1,5 @@
 <?php
-require_once(EE_MODELS . 'fields/EE_Boolean_Field.php');
+require_once(EE_MODELS.'fields/EE_Boolean_Field.php');
 
 class EE_Trashed_Flag_Field extends EE_Boolean_Field
 {

core/db_models/fields/EE_Any_Foreign_Model_Name_Field.php

Spacing +1 added lines, -1 removed lines

@@ -1,5 +1,5 @@
 <?php
-require_once(EE_MODELS . 'fields/EE_DB_Only_Field_Base.php');
+require_once(EE_MODELS.'fields/EE_DB_Only_Field_Base.php');
 
 /**
  * Used by EE_Belongs_To_Any_Relations and EE_Has_Many_Any_Relations to identify the model the foreign key points to.

core/db_models/fields/EE_WP_User_Field.php

Indentation +30 added lines, -30 removed lines

@@ -1,5 +1,5 @@ 
 <?php if (! defined('EVENT_ESPRESSO_VERSION')) {
-    exit('No direct script access allowed');
+	exit('No direct script access allowed');
 }
 
 /**
@@ -24,34 +24,34 @@ 
  */
 class EE_WP_User_Field extends EE_Foreign_Key_Int_Field
 {
-    /**
-     * No need to provide a default or the model pointed to- the default is
-     * always get_current_user_id() and the model pointed to is always WP_User
-     *
-     * @param string  $table_column name fo column for field
-     * @param string  $nicename     should eb internationalized with __('blah','event_espresso')
-     * @param boolean $nullable
-     */
-    function __construct($table_column, $nicename, $nullable)
-    {
-        parent::__construct($table_column, $nicename, $nullable, null, 'WP_User');
-    }
+	/**
+	 * No need to provide a default or the model pointed to- the default is
+	 * always get_current_user_id() and the model pointed to is always WP_User
+	 *
+	 * @param string  $table_column name fo column for field
+	 * @param string  $nicename     should eb internationalized with __('blah','event_espresso')
+	 * @param boolean $nullable
+	 */
+	function __construct($table_column, $nicename, $nullable)
+	{
+		parent::__construct($table_column, $nicename, $nullable, null, 'WP_User');
+	}
 
-    /**
-     * Gets the default which is always the current user. This can't be set when initially
-     * constructing the model field because that's done before $current_user is set
-     *
-     * @return mixed
-     */
-    function get_default_value()
-    {
-        if (did_action('init')) {
-            return get_current_user_id();
-        } else {
-            EE_Error::doing_it_wrong('EE_WP_User_Field::get_default_value',
-                __('You cant get a default value for a wp_User_Field because the "init" action is called, because current_user global hasnt yet been setup. Consider doing your business logic on the "init" hook or later.',
-                    'event_espresso'), '4.6.20');
-            return 1;
-        }
-    }
+	/**
+	 * Gets the default which is always the current user. This can't be set when initially
+	 * constructing the model field because that's done before $current_user is set
+	 *
+	 * @return mixed
+	 */
+	function get_default_value()
+	{
+		if (did_action('init')) {
+			return get_current_user_id();
+		} else {
+			EE_Error::doing_it_wrong('EE_WP_User_Field::get_default_value',
+				__('You cant get a default value for a wp_User_Field because the "init" action is called, because current_user global hasnt yet been setup. Consider doing your business logic on the "init" hook or later.',
+					'event_espresso'), '4.6.20');
+			return 1;
+		}
+	}
 }
\ No newline at end of file

Spacing +1 added lines, -1 removed lines

@@ -1,4 +1,4 @@
-<?php if (! defined('EVENT_ESPRESSO_VERSION')) {
+<?php if ( ! defined('EVENT_ESPRESSO_VERSION')) {
     exit('No direct script access allowed');
 }
 

core/db_models/fields/EE_Maybe_Serialized_Simple_HTML_Field.php

Indentation +49 added lines, -49 removed lines

@@ -1,5 +1,5 @@ 
 <?php if (! defined('EVENT_ESPRESSO_VERSION')) {
-    exit('No direct script access allowed');
+	exit('No direct script access allowed');
 }
 
 /**
@@ -14,56 +14,56 @@ 
  */
 class EE_Maybe_Serialized_Simple_HTML_Field extends EE_Maybe_Serialized_Text_Field
 {
-    /**
-     * removes all non-basic tags when setting
-     *
-     * @param string $value_inputted_for_field_on_model_object
-     * @return string
-     */
-    function prepare_for_set($value_inputted_for_field_on_model_object)
-    {
-        return parent::prepare_for_set($this->_remove_tags($value_inputted_for_field_on_model_object));
-    }
+	/**
+	 * removes all non-basic tags when setting
+	 *
+	 * @param string $value_inputted_for_field_on_model_object
+	 * @return string
+	 */
+	function prepare_for_set($value_inputted_for_field_on_model_object)
+	{
+		return parent::prepare_for_set($this->_remove_tags($value_inputted_for_field_on_model_object));
+	}
 
-    /**
-     * Remove any non-"simple" html tags. @see EE_Simple_HTML_Field
-     *
-     * @param array|string $value
-     * @return array|string
-     */
-    protected function _remove_tags($value)
-    {
-        if (is_array($value)) {
-            foreach ($value as $key => $v) {
-                $value[$key] = $this->_remove_tags($v);
-            }
-        } elseif (is_string($value)) {
-            $value = wp_kses("$value", $this->_get_allowed_tags());
-        }
-        return $value;
-    }
+	/**
+	 * Remove any non-"simple" html tags. @see EE_Simple_HTML_Field
+	 *
+	 * @param array|string $value
+	 * @return array|string
+	 */
+	protected function _remove_tags($value)
+	{
+		if (is_array($value)) {
+			foreach ($value as $key => $v) {
+				$value[$key] = $this->_remove_tags($v);
+			}
+		} elseif (is_string($value)) {
+			$value = wp_kses("$value", $this->_get_allowed_tags());
+		}
+		return $value;
+	}
 
-    /**
-     * In case unsafe data somehow got inserted into the database, we want to remove tags again
-     *
-     * @param array|string $value_found_in_db_for_model_object
-     * @return array|string
-     */
-    function prepare_for_set_from_db($value_found_in_db_for_model_object)
-    {
-        return $this->_remove_tags(parent::prepare_for_set_from_db($value_found_in_db_for_model_object));
-    }
+	/**
+	 * In case unsafe data somehow got inserted into the database, we want to remove tags again
+	 *
+	 * @param array|string $value_found_in_db_for_model_object
+	 * @return array|string
+	 */
+	function prepare_for_set_from_db($value_found_in_db_for_model_object)
+	{
+		return $this->_remove_tags(parent::prepare_for_set_from_db($value_found_in_db_for_model_object));
+	}
 
 
-    /**
-     * Determines what tags to allow in this model field
-     *
-     * @global array $allowedtags
-     * @return array
-     */
-    function _get_allowed_tags()
-    {
-        return apply_filters('FHEE__EE_Maybe_Serialized_Simple_HTML_Field___get_allowed_tags',
-            EEH_HTML::get_simple_tags(), $this);
-    }
+	/**
+	 * Determines what tags to allow in this model field
+	 *
+	 * @global array $allowedtags
+	 * @return array
+	 */
+	function _get_allowed_tags()
+	{
+		return apply_filters('FHEE__EE_Maybe_Serialized_Simple_HTML_Field___get_allowed_tags',
+			EEH_HTML::get_simple_tags(), $this);
+	}
 }

Spacing +1 added lines, -1 removed lines

@@ -1,4 +1,4 @@
-<?php if (! defined('EVENT_ESPRESSO_VERSION')) {
+<?php if ( ! defined('EVENT_ESPRESSO_VERSION')) {
     exit('No direct script access allowed');
 }
 

core/db_models/fields/EE_Simple_HTML_Field.php

Spacing +1 added lines, -1 removed lines

@@ -1,5 +1,5 @@
 <?php
-require_once(EE_MODELS . 'fields/EE_Text_Field_Base.php');
+require_once(EE_MODELS.'fields/EE_Text_Field_Base.php');
 
 /**
  * Only allows a select, small number of html tags:

Indentation +10 added lines, -10 removed lines

@@ -11,14 +11,14 @@
 
 
 
-    /**
-     * removes all tags which a WP Post wouldn't allow in its content normally
-     *
-     * @param string $value
-     * @return string
-     */
-    public function prepare_for_set($value)
-    {
-        return parent::prepare_for_set(wp_kses("$value", EEH_HTML::get_simple_tags()));
-    }
+	/**
+	 * removes all tags which a WP Post wouldn't allow in its content normally
+	 *
+	 * @param string $value
+	 * @return string
+	 */
+	public function prepare_for_set($value)
+	{
+		return parent::prepare_for_set(wp_kses("$value", EEH_HTML::get_simple_tags()));
+	}
 }

core/db_models/fields/EE_Slug_Field.php

Indentation +11 added lines, -11 removed lines

@@ -3,15 +3,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
-     */
-    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
+	 */
+	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);
+	}
 }
\ No newline at end of file

Spacing +1 added lines, -1 removed lines

@@ -1,5 +1,5 @@
 <?php
-require_once(EE_MODELS . 'fields/EE_Text_Field_Base.php');
+require_once(EE_MODELS.'fields/EE_Text_Field_Base.php');
 
 class EE_Slug_Field extends EE_Text_Field_Base
 {