eventespresso / event-espresso-core

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;
+	}
 }

core/db_models/fields/EE_WP_Post_Type_Field.php.php

Indentation +8 added lines, -8 removed lines

@@ -5,12 +5,12 @@
  */
 class EE_WP_Post_Type_Field extends EE_DB_Only_Text_Field
 {
-    /**
-     * @param string $post_type the exact string to be used for the post type
-     *                          of all these post type model objects/rows
-     */
-    public function __construct($post_type)
-    {
-        parent::__construct('post_type', __("Post Type", 'event_espresso'), false, $post_type);
-    }
+	/**
+	 * @param string $post_type the exact string to be used for the post type
+	 *                          of all these post type model objects/rows
+	 */
+	public function __construct($post_type)
+	{
+		parent::__construct('post_type', __("Post Type", 'event_espresso'), false, $post_type);
+	}
 }

core/db_models/fields/EE_Model_Field_Base.php

Indentation +646 added lines, -647 removed lines

@@ -19,651 +19,650 @@
  */
 abstract class EE_Model_Field_Base implements HasSchemaInterface
 {
-    /**
-     * The alias for the table the column belongs to.
-     * @var string
-     */
-    protected $_table_alias;
-
-    /**
-     * The actual db column name for the table
-     * @var string
-     */
-    protected $_table_column;
-
-
-    /**
-     * The authoritative name for the table column (used by client code to reference the field).
-     * @var string
-     */
-    protected $_name;
-
-
-    /**
-     * A description for the field.
-     * @var string
-     */
-    protected $_nicename;
-
-
-    /**
-     * Whether the field is nullable or not
-     * @var bool
-     */
-    protected $_nullable;
-
-
-    /**
-     * What the default value for the field should be.
-     * @var mixed
-     */
-    protected $_default_value;
-
-
-    /**
-     * Other configuration for the field
-     * @var mixed
-     */
-    protected $_other_config;
-
-
-    /**
-     * The name of the model this field is instantiated for.
-     * @var string
-     */
-    protected $_model_name;
-
-
-    /**
-     * This should be a json-schema valid data type for the field.
-     * @link http://json-schema.org/latest/json-schema-core.html#rfc.section.4.2
-     * @var string
-     */
-    private $_schema_type = 'string';
-
-
-    /**
-     * If the schema has a defined format then it should be defined via this property.
-     * @link http://json-schema.org/latest/json-schema-validation.html#rfc.section.7
-     * @var string
-     */
-    private $_schema_format = '';
-
-
-    /**
-     * Indicates that the value of the field is managed exclusively by the server/model and not something
-     * settable by client code.
-     * @link http://json-schema.org/latest/json-schema-hypermedia.html#rfc.section.4.4
-     * @var bool
-     */
-    private $_schema_readonly = false;
-
-
-    /**
-     * @param string $table_column
-     * @param string $nicename
-     * @param bool   $nullable
-     * @param null   $default_value
-     */
-    public function __construct($table_column, $nicename, $nullable, $default_value = null)
-    {
-        $this->_table_column  = $table_column;
-        $this->_nicename      = $nicename;
-        $this->_nullable      = $nullable;
-        $this->_default_value = $default_value;
-    }
-
-
-    /**
-     * @param $table_alias
-     * @param $name
-     * @param $model_name
-     */
-    public function _construct_finalize($table_alias, $name, $model_name)
-    {
-        $this->_table_alias = $table_alias;
-        $this->_name        = $name;
-        $this->_model_name  = $model_name;
-        /**
-         * allow for changing the defaults
-         */
-        $this->_nicename      = apply_filters(
-            'FHEE__EE_Model_Field_Base___construct_finalize___nicename',
-            $this->_nicename,
-            $this
-        );
-        $this->_default_value = apply_filters(
-            'FHEE__EE_Model_Field_Base___construct_finalize___default_value',
-            $this->_default_value,
-            $this
-        );
-    }
-
-    public function get_table_alias()
-    {
-        return $this->_table_alias;
-    }
-
-    public function get_table_column()
-    {
-        return $this->_table_column;
-    }
-
-    /**
-     * Returns the name of the model this field is on. Eg 'Event' or 'Ticket_Datetime'
-     *
-     * @return string
-     */
-    public function get_model_name()
-    {
-        return $this->_model_name;
-    }
-
-    /**
-     * @throws \EE_Error
-     * @return string
-     */
-    public function get_name()
-    {
-        if ($this->_name) {
-            return $this->_name;
-        } else {
-            throw new EE_Error(sprintf(__(
-                "Model field '%s' has no name set. Did you make a model and forget to call the parent model constructor?",
-                "event_espresso"
-            ), get_class($this)));
-        }
-    }
-
-    public function get_nicename()
-    {
-        return $this->_nicename;
-    }
-
-    public function is_nullable()
-    {
-        return $this->_nullable;
-    }
-
-    /**
-     * returns whether this field is an auto-increment field or not. If it is, then
-     * on insertion it can be null. However, on updates it must be present.
-     *
-     * @return boolean
-     */
-    public function is_auto_increment()
-    {
-        return false;
-    }
-
-    /**
-     * The default value in the model object's value domain. See lengthy comment about
-     * value domains at the top of EEM_Base
-     *
-     * @return mixed
-     */
-    public function get_default_value()
-    {
-        return $this->_default_value;
-    }
-
-    /**
-     * Returns the table alias joined to the table column, however this isn't the right
-     * table alias if the aliased table is being joined to. In that case, you can use
-     * EE_Model_Parser::extract_table_alias_model_relation_chain_prefix() to find the table's current alias
-     * in the current query
-     *
-     * @return string
-     */
-    public function get_qualified_column()
-    {
-        return $this->get_table_alias() . "." . $this->get_table_column();
-    }
-
-    /**
-     * When get() is called on a model object (eg EE_Event), before returning its value,
-     * call this function on it, allowing us to customize the returned value based on
-     * the field's type. Eg, we may want to unserialize it, strip tags, etc. By default,
-     * we simply return it.
-     *
-     * @param mixed $value_of_field_on_model_object
-     * @return mixed
-     */
-    public function prepare_for_get($value_of_field_on_model_object)
-    {
-        return $value_of_field_on_model_object;
-    }
-
-    /**
-     * When inserting or updating a field on a model object, run this function on each
-     * value to prepare it for insertion into the db. Generally this converts
-     * the validated input on the model object into the format used in the DB.
-     *
-     * @param mixed $value_of_field_on_model_object
-     * @return mixed
-     */
-    public function prepare_for_use_in_db($value_of_field_on_model_object)
-    {
-        return $value_of_field_on_model_object;
-    }
-
-    /**
-     * When creating a brand-new model object, or setting a particular value for one of its fields, this function
-     * is called before setting it on the model object. We may want to strip slashes, unserialize the value, etc.
-     * By default, we do nothing.
-     *
-     * If the model field is going to perform any validation on the input, this is where it should be done
-     * (once the value is on the model object, it may be used in other ways besides putting it into the DB
-     * so it's best to validate it right away).
-     *
-     * @param mixed $value_inputted_for_field_on_model_object
-     * @return mixed
-     */
-    public function prepare_for_set($value_inputted_for_field_on_model_object)
-    {
-        return $value_inputted_for_field_on_model_object;
-    }
-
-
-    /**
-     * When instantiating a model object from DB results, this function is called before setting each field.
-     * We may want to serialize the value, etc. By default, we return the value using prepare_for_set() method as that
-     * is the one child classes will most often define.
-     *
-     * @param mixed $value_found_in_db_for_model_object
-     * @return mixed
-     */
-    public function prepare_for_set_from_db($value_found_in_db_for_model_object)
-    {
-        return $this->prepare_for_set($value_found_in_db_for_model_object);
-    }
-
-    /**
-     * When echoing a field's value on a model object, this function is run to prepare the value for presentation in a
-     * webpage. For example, we may want to output floats with 2 decimal places by default, dates as "Monday Jan 12,
-     * 2013, at 3:23pm" instead of
-     * "8765678632", or any other modifications to how the value should be displayed, but not modified itself.
-     *
-     * @param mixed $value_on_field_to_be_outputted
-     * @return mixed
-     */
-    public function prepare_for_pretty_echoing($value_on_field_to_be_outputted)
-    {
-        return $value_on_field_to_be_outputted;
-    }
-
-
-    /**
-     * Returns whatever is set as the nicename for the object.
-     * @return string
-     */
-    public function getSchemaDescription()
-    {
-        return $this->get_nicename();
-    }
-
-
-    /**
-     * Returns whatever is set as the $_schema_type property for the object.
-     * Note: this will automatically add 'null' to the schema if the object is_nullable()
-     * @return string|array
-     */
-    public function getSchemaType()
-    {
-        if ($this->is_nullable()) {
-            $this->_schema_type = (array) $this->_schema_type;
-            if (! in_array('null', $this->_schema_type)) {
-                $this->_schema_type[] = 'null';
-            };
-        }
-        return $this->_schema_type;
-    }
-
-
-    /**
-     * Sets the _schema_type property.  Child classes should call this in their constructors to override the default state
-     * for this property.
-     * @param string|array $type
-     * @throws InvalidArgumentException
-     */
-    protected function setSchemaType($type)
-    {
-        $this->validateSchemaType($type);
-        $this->_schema_type = $type;
-    }
-
-
-    /**
-     * This is usually present when the $_schema_type property is 'object'.  Any child classes will need to override
-     * this method and return the properties for the schema.
-     *
-     * The reason this is not a property on the class is because there may be filters set on the values for the property
-     * that won't be exposed on construct.  For example enum type schemas may have the enum values filtered.
-     *
-     * @return array
-     */
-    public function getSchemaProperties()
-    {
-        return array();
-    }
-
-
-
-    /**
-     * By default this returns the scalar default value that was sent in on the class prepped according to the class type
-     * as the default.  However, when there are schema properties, then the default property is setup to mirror the
-     * property keys and correctly prepare the default according to that expected property value.
-     * The getSchema method validates whether the schema for default is setup correctly or not according to the schema type
-     *
-     * @return mixed
-     */
-    public function getSchemaDefault()
-    {
-        $default_value = $this->prepare_for_use_in_db($this->prepare_for_set($this->get_default_value()));
-        $schema_properties = $this->getSchemaProperties();
-
-        // if this schema has properties than shape the default value to match the properties shape.
-        if ($schema_properties) {
-            $value_to_return = array();
-            foreach ($schema_properties as $property_key => $property_schema) {
-                switch ($property_key) {
-                    case 'pretty':
-                    case 'rendered':
-                        $value_to_return[ $property_key ] = $this->prepare_for_pretty_echoing($this->prepare_for_set($default_value));
-                        break;
-                    default:
-                        $value_to_return[ $property_key ] = $default_value;
-                        break;
-                }
-            }
-            $default_value = $value_to_return;
-        }
-        return $default_value;
-    }
-
-
-
-
-    /**
-     * If a child class has enum values, they should override this method and provide a simple array
-     * of the enum values.
-
-     * The reason this is not a property on the class is because there may be filterable enum values that
-     * are set on the instantiated object that could be filtered after construct.
-     *
-     * @return array
-     */
-    public function getSchemaEnum()
-    {
-        return array();
-    }
-
-
-    /**
-     * This returns the value of the $_schema_format property on the object.
-     * @return string
-     */
-    public function getSchemaFormat()
-    {
-        return $this->_schema_format;
-    }
-
-
-    /**
-     * Sets the schema format property.
-     * @throws InvalidArgumentException
-     * @param string $format
-     */
-    protected function setSchemaFormat($format)
-    {
-        $this->validateSchemaFormat($format);
-        $this->_schema_format = $format;
-    }
-
-
-    /**
-     * This returns the value of the $_schema_readonly property on the object.
-     * @return bool
-     */
-    public function getSchemaReadonly()
-    {
-        return $this->_schema_readonly;
-    }
-
-
-    /**
-     * This sets the value for the $_schema_readonly property.
-     * @param bool $readonly  (only explicit boolean values are accepted)
-     */
-    protected function setSchemaReadOnly($readonly)
-    {
-        if (! is_bool($readonly)) {
-            throw new InvalidArgumentException(
-                sprintf(
-                    esc_html__('The incoming argument (%s) must be a boolean.', 'event_espresso'),
-                    print_r($readonly, true)
-                )
-            );
-        }
-
-        $this->_schema_readonly = $readonly;
-    }
-
-
-
-
-    /**
-     * Return `%d`, `%s` or `%f` to indicate the data type for the field.
-     * @uses _get_wpdb_data_type()
-     *
-     * @return string
-     */
-    public function get_wpdb_data_type()
-    {
-        return $this->_get_wpdb_data_type();
-    }
-
-
-    /**
-     * Return `%d`, `%s` or `%f` to indicate the data type for the field that should be indicated in wpdb queries.
-     * @param string $type  Included if a specific type is requested.
-     * @uses get_schema_type()
-     * @return string
-     */
-    protected function _get_wpdb_data_type($type = '')
-    {
-        $type = empty($type) ? $this->getSchemaType() : $type;
-
-        // if type is an array, then different parsing is required.
-        if (is_array($type)) {
-            return $this->_get_wpdb_data_type_for_type_array($type);
-        }
-
-        $wpdb_type = '%s';
-        switch ($type) {
-            case 'number':
-                $wpdb_type = '%f';
-                break;
-            case 'integer':
-            case 'boolean':
-                $wpdb_type = '%d';
-                break;
-            case 'object':
-                $properties = $this->getSchemaProperties();
-                if (isset($properties['raw'], $properties['raw']['type'])) {
-                    $wpdb_type = $this->_get_wpdb_data_type($properties['raw']['type']);
-                }
-                break; // leave at default
-        }
-        return $wpdb_type;
-    }
-
-
-
-    protected function _get_wpdb_data_type_for_type_array($type)
-    {
-        $type = (array) $type;
-        // first let's flip because then we can do a faster key check
-        $type = array_flip($type);
-
-        // check for things that mean '%s'
-        if (isset($type['string'], $type['object'], $type['array'])) {
-            return '%s';
-        }
-
-        // if makes it past the above condition and there's float in the array
-        // then the type is %f
-        if (isset($type['number'])) {
-            return '%f';
-        }
-
-        // if it makes it above the above conditions and there is an integer in the array
-        // then the type is %d
-        if (isset($type['integer'])) {
-            return '%d';
-        }
-
-        // anything else is a string
-        return '%s';
-    }
-
-
-    /**
-     * This returns elements used to represent this field in the json schema.
-     *
-     * @link http://json-schema.org/
-     * @return array
-     */
-    public function getSchema()
-    {
-        $schema = array(
-            'description' => $this->getSchemaDescription(),
-            'type' => $this->getSchemaType(),
-            'readonly' => $this->getSchemaReadonly(),
-            'default' => $this->getSchemaDefault()
-        );
-
-        // optional properties of the schema
-        $enum = $this->getSchemaEnum();
-        $properties = $this->getSchemaProperties();
-        $format = $this->getSchemaFormat();
-        if ($enum) {
-            $schema['enum'] = $enum;
-        }
-
-        if ($properties) {
-            $schema['properties'] = $properties;
-        }
-
-        if ($format) {
-            $schema['format'] = $format;
-        }
-        return $schema;
-    }
-
-    /**
-     * Some fields are in the database-only, (ie, used in queries etc), but shouldn't necessarily be part
-     * of the model objects (ie, client code shouldn't care to ever see their value... if client code does
-     * want to see their value, then they shouldn't be db-only fields!)
-     * Eg, when doing events as custom post types, querying the post_type is essential, but
-     * post_type is irrelevant for EE_Event objects (because they will ALL be of post_type 'esp_event').
-     * By default, all fields aren't db-only.
-     *
-     * @return boolean
-     */
-    public function is_db_only_field()
-    {
-        return false;
-    }
-
-
-    /**
-     * Validates the incoming string|array to ensure its an allowable type.
-     * @throws InvalidArgumentException
-     * @param string|array $type
-     */
-    private function validateSchemaType($type)
-    {
-        if (! (is_string($type) || is_array($type))) {
-            throw new InvalidArgumentException(
-                sprintf(
-                    esc_html__('The incoming argument (%s) must be a string or an array.', 'event_espresso'),
-                    print_r($type, true)
-                )
-            );
-        }
-
-        // validate allowable types.
-        // @link http://json-schema.org/latest/json-schema-core.html#rfc.section.4.2
-        $allowable_types = array_flip(
-            array(
-                'string',
-                'number',
-                'null',
-                'object',
-                'array',
-                'boolean',
-                'integer'
-            )
-        );
-
-        if (is_array($type)) {
-            foreach ($type as $item_in_type) {
-                $this->validateSchemaType($item_in_type);
-            }
-            return;
-        }
-
-        if (! isset($allowable_types[ $type ])) {
-            throw new InvalidArgumentException(
-                sprintf(
-                    esc_html__('The incoming argument (%1$s) must be one of the allowable types: %2$s', 'event_espresso'),
-                    $type,
-                    implode(',', array_flip($allowable_types))
-                )
-            );
-        }
-    }
-
-
-    /**
-     * Validates that the incoming format is an allowable string to use for the _schema_format property
-     * @throws InvalidArgumentException
-     * @param $format
-     */
-    private function validateSchemaFormat($format)
-    {
-        if (! is_string($format)) {
-            throw new InvalidArgumentException(
-                sprintf(
-                    esc_html__('The incoming argument (%s) must be a string.', 'event_espresso'),
-                    print_r($format, true)
-                )
-            );
-        }
-
-        // validate allowable format values
-        // @link http://json-schema.org/latest/json-schema-validation.html#rfc.section.7
-        $allowable_formats = array_flip(
-            array(
-                'date-time',
-                'email',
-                'hostname',
-                'ipv4',
-                'ipv6',
-                'uri',
-                'uriref'
-            )
-        );
-
-        if (! isset($allowable_formats[ $format ])) {
-            throw new InvalidArgumentException(
-                sprintf(
-                    esc_html__('The incoming argument (%1$s) must be one of the allowable formats: %2$s', 'event_espresso'),
-                    $format,
-                    implode(',', array_flip($allowable_formats))
-                )
-            );
-        }
-    }
+	/**
+	 * The alias for the table the column belongs to.
+	 * @var string
+	 */
+	protected $_table_alias;
+
+	/**
+	 * The actual db column name for the table
+	 * @var string
+	 */
+	protected $_table_column;
+
+
+	/**
+	 * The authoritative name for the table column (used by client code to reference the field).
+	 * @var string
+	 */
+	protected $_name;
+
+
+	/**
+	 * A description for the field.
+	 * @var string
+	 */
+	protected $_nicename;
+
+
+	/**
+	 * Whether the field is nullable or not
+	 * @var bool
+	 */
+	protected $_nullable;
+
+
+	/**
+	 * What the default value for the field should be.
+	 * @var mixed
+	 */
+	protected $_default_value;
+
+
+	/**
+	 * Other configuration for the field
+	 * @var mixed
+	 */
+	protected $_other_config;
+
+
+	/**
+	 * The name of the model this field is instantiated for.
+	 * @var string
+	 */
+	protected $_model_name;
+
+
+	/**
+	 * This should be a json-schema valid data type for the field.
+	 * @link http://json-schema.org/latest/json-schema-core.html#rfc.section.4.2
+	 * @var string
+	 */
+	private $_schema_type = 'string';
+
+
+	/**
+	 * If the schema has a defined format then it should be defined via this property.
+	 * @link http://json-schema.org/latest/json-schema-validation.html#rfc.section.7
+	 * @var string
+	 */
+	private $_schema_format = '';
+
+
+	/**
+	 * Indicates that the value of the field is managed exclusively by the server/model and not something
+	 * settable by client code.
+	 * @link http://json-schema.org/latest/json-schema-hypermedia.html#rfc.section.4.4
+	 * @var bool
+	 */
+	private $_schema_readonly = false;
+
+
+	/**
+	 * @param string $table_column
+	 * @param string $nicename
+	 * @param bool   $nullable
+	 * @param null   $default_value
+	 */
+	public function __construct($table_column, $nicename, $nullable, $default_value = null)
+	{
+		$this->_table_column  = $table_column;
+		$this->_nicename      = $nicename;
+		$this->_nullable      = $nullable;
+		$this->_default_value = $default_value;
+	}
+
+
+	/**
+	 * @param $table_alias
+	 * @param $name
+	 * @param $model_name
+	 */
+	public function _construct_finalize($table_alias, $name, $model_name)
+	{
+		$this->_table_alias = $table_alias;
+		$this->_name        = $name;
+		$this->_model_name  = $model_name;
+		/**
+		 * allow for changing the defaults
+		 */
+		$this->_nicename      = apply_filters(
+			'FHEE__EE_Model_Field_Base___construct_finalize___nicename',
+			$this->_nicename,
+			$this
+		);
+		$this->_default_value = apply_filters(
+			'FHEE__EE_Model_Field_Base___construct_finalize___default_value',
+			$this->_default_value,
+			$this
+		);
+	}
+
+	public function get_table_alias()
+	{
+		return $this->_table_alias;
+	}
+
+	public function get_table_column()
+	{
+		return $this->_table_column;
+	}
+
+	/**
+	 * Returns the name of the model this field is on. Eg 'Event' or 'Ticket_Datetime'
+	 *
+	 * @return string
+	 */
+	public function get_model_name()
+	{
+		return $this->_model_name;
+	}
+
+	/**
+	 * @throws \EE_Error
+	 * @return string
+	 */
+	public function get_name()
+	{
+		if ($this->_name) {
+			return $this->_name;
+		} else {
+			throw new EE_Error(sprintf(__(
+				"Model field '%s' has no name set. Did you make a model and forget to call the parent model constructor?",
+				"event_espresso"
+			), get_class($this)));
+		}
+	}
+
+	public function get_nicename()
+	{
+		return $this->_nicename;
+	}
+
+	public function is_nullable()
+	{
+		return $this->_nullable;
+	}
+
+	/**
+	 * returns whether this field is an auto-increment field or not. If it is, then
+	 * on insertion it can be null. However, on updates it must be present.
+	 *
+	 * @return boolean
+	 */
+	public function is_auto_increment()
+	{
+		return false;
+	}
+
+	/**
+	 * The default value in the model object's value domain. See lengthy comment about
+	 * value domains at the top of EEM_Base
+	 *
+	 * @return mixed
+	 */
+	public function get_default_value()
+	{
+		return $this->_default_value;
+	}
+
+	/**
+	 * Returns the table alias joined to the table column, however this isn't the right
+	 * table alias if the aliased table is being joined to. In that case, you can use
+	 * EE_Model_Parser::extract_table_alias_model_relation_chain_prefix() to find the table's current alias
+	 * in the current query
+	 *
+	 * @return string
+	 */
+	public function get_qualified_column()
+	{
+		return $this->get_table_alias() . "." . $this->get_table_column();
+	}
+
+	/**
+	 * When get() is called on a model object (eg EE_Event), before returning its value,
+	 * call this function on it, allowing us to customize the returned value based on
+	 * the field's type. Eg, we may want to unserialize it, strip tags, etc. By default,
+	 * we simply return it.
+	 *
+	 * @param mixed $value_of_field_on_model_object
+	 * @return mixed
+	 */
+	public function prepare_for_get($value_of_field_on_model_object)
+	{
+		return $value_of_field_on_model_object;
+	}
+
+	/**
+	 * When inserting or updating a field on a model object, run this function on each
+	 * value to prepare it for insertion into the db. Generally this converts
+	 * the validated input on the model object into the format used in the DB.
+	 *
+	 * @param mixed $value_of_field_on_model_object
+	 * @return mixed
+	 */
+	public function prepare_for_use_in_db($value_of_field_on_model_object)
+	{
+		return $value_of_field_on_model_object;
+	}
+
+	/**
+	 * When creating a brand-new model object, or setting a particular value for one of its fields, this function
+	 * is called before setting it on the model object. We may want to strip slashes, unserialize the value, etc.
+	 * By default, we do nothing.
+	 *
+	 * If the model field is going to perform any validation on the input, this is where it should be done
+	 * (once the value is on the model object, it may be used in other ways besides putting it into the DB
+	 * so it's best to validate it right away).
+	 *
+	 * @param mixed $value_inputted_for_field_on_model_object
+	 * @return mixed
+	 */
+	public function prepare_for_set($value_inputted_for_field_on_model_object)
+	{
+		return $value_inputted_for_field_on_model_object;
+	}
+
+
+	/**
+	 * When instantiating a model object from DB results, this function is called before setting each field.
+	 * We may want to serialize the value, etc. By default, we return the value using prepare_for_set() method as that
+	 * is the one child classes will most often define.
+	 *
+	 * @param mixed $value_found_in_db_for_model_object
+	 * @return mixed
+	 */
+	public function prepare_for_set_from_db($value_found_in_db_for_model_object)
+	{
+		return $this->prepare_for_set($value_found_in_db_for_model_object);
+	}
+
+	/**
+	 * When echoing a field's value on a model object, this function is run to prepare the value for presentation in a
+	 * webpage. For example, we may want to output floats with 2 decimal places by default, dates as "Monday Jan 12,
+	 * 2013, at 3:23pm" instead of
+	 * "8765678632", or any other modifications to how the value should be displayed, but not modified itself.
+	 *
+	 * @param mixed $value_on_field_to_be_outputted
+	 * @return mixed
+	 */
+	public function prepare_for_pretty_echoing($value_on_field_to_be_outputted)
+	{
+		return $value_on_field_to_be_outputted;
+	}
+
+
+	/**
+	 * Returns whatever is set as the nicename for the object.
+	 * @return string
+	 */
+	public function getSchemaDescription()
+	{
+		return $this->get_nicename();
+	}
+
+
+	/**
+	 * Returns whatever is set as the $_schema_type property for the object.
+	 * Note: this will automatically add 'null' to the schema if the object is_nullable()
+	 * @return string|array
+	 */
+	public function getSchemaType()
+	{
+		if ($this->is_nullable()) {
+			$this->_schema_type = (array) $this->_schema_type;
+			if (! in_array('null', $this->_schema_type)) {
+				$this->_schema_type[] = 'null';
+			};
+		}
+		return $this->_schema_type;
+	}
+
+
+	/**
+	 * Sets the _schema_type property.  Child classes should call this in their constructors to override the default state
+	 * for this property.
+	 * @param string|array $type
+	 * @throws InvalidArgumentException
+	 */
+	protected function setSchemaType($type)
+	{
+		$this->validateSchemaType($type);
+		$this->_schema_type = $type;
+	}
+
+
+	/**
+	 * This is usually present when the $_schema_type property is 'object'.  Any child classes will need to override
+	 * this method and return the properties for the schema.
+	 *
+	 * The reason this is not a property on the class is because there may be filters set on the values for the property
+	 * that won't be exposed on construct.  For example enum type schemas may have the enum values filtered.
+	 *
+	 * @return array
+	 */
+	public function getSchemaProperties()
+	{
+		return array();
+	}
+
+
+
+	/**
+	 * By default this returns the scalar default value that was sent in on the class prepped according to the class type
+	 * as the default.  However, when there are schema properties, then the default property is setup to mirror the
+	 * property keys and correctly prepare the default according to that expected property value.
+	 * The getSchema method validates whether the schema for default is setup correctly or not according to the schema type
+	 *
+	 * @return mixed
+	 */
+	public function getSchemaDefault()
+	{
+		$default_value = $this->prepare_for_use_in_db($this->prepare_for_set($this->get_default_value()));
+		$schema_properties = $this->getSchemaProperties();
+
+		// if this schema has properties than shape the default value to match the properties shape.
+		if ($schema_properties) {
+			$value_to_return = array();
+			foreach ($schema_properties as $property_key => $property_schema) {
+				switch ($property_key) {
+					case 'pretty':
+					case 'rendered':
+						$value_to_return[ $property_key ] = $this->prepare_for_pretty_echoing($this->prepare_for_set($default_value));
+						break;
+					default:
+						$value_to_return[ $property_key ] = $default_value;
+						break;
+				}
+			}
+			$default_value = $value_to_return;
+		}
+		return $default_value;
+	}
+
+
+
+
+	/**
+	 * If a child class has enum values, they should override this method and provide a simple array
+	 * of the enum values.
+	 * The reason this is not a property on the class is because there may be filterable enum values that
+	 * are set on the instantiated object that could be filtered after construct.
+	 *
+	 * @return array
+	 */
+	public function getSchemaEnum()
+	{
+		return array();
+	}
+
+
+	/**
+	 * This returns the value of the $_schema_format property on the object.
+	 * @return string
+	 */
+	public function getSchemaFormat()
+	{
+		return $this->_schema_format;
+	}
+
+
+	/**
+	 * Sets the schema format property.
+	 * @throws InvalidArgumentException
+	 * @param string $format
+	 */
+	protected function setSchemaFormat($format)
+	{
+		$this->validateSchemaFormat($format);
+		$this->_schema_format = $format;
+	}
+
+
+	/**
+	 * This returns the value of the $_schema_readonly property on the object.
+	 * @return bool
+	 */
+	public function getSchemaReadonly()
+	{
+		return $this->_schema_readonly;
+	}
+
+
+	/**
+	 * This sets the value for the $_schema_readonly property.
+	 * @param bool $readonly  (only explicit boolean values are accepted)
+	 */
+	protected function setSchemaReadOnly($readonly)
+	{
+		if (! is_bool($readonly)) {
+			throw new InvalidArgumentException(
+				sprintf(
+					esc_html__('The incoming argument (%s) must be a boolean.', 'event_espresso'),
+					print_r($readonly, true)
+				)
+			);
+		}
+
+		$this->_schema_readonly = $readonly;
+	}
+
+
+
+
+	/**
+	 * Return `%d`, `%s` or `%f` to indicate the data type for the field.
+	 * @uses _get_wpdb_data_type()
+	 *
+	 * @return string
+	 */
+	public function get_wpdb_data_type()
+	{
+		return $this->_get_wpdb_data_type();
+	}
+
+
+	/**
+	 * Return `%d`, `%s` or `%f` to indicate the data type for the field that should be indicated in wpdb queries.
+	 * @param string $type  Included if a specific type is requested.
+	 * @uses get_schema_type()
+	 * @return string
+	 */
+	protected function _get_wpdb_data_type($type = '')
+	{
+		$type = empty($type) ? $this->getSchemaType() : $type;
+
+		// if type is an array, then different parsing is required.
+		if (is_array($type)) {
+			return $this->_get_wpdb_data_type_for_type_array($type);
+		}
+
+		$wpdb_type = '%s';
+		switch ($type) {
+			case 'number':
+				$wpdb_type = '%f';
+				break;
+			case 'integer':
+			case 'boolean':
+				$wpdb_type = '%d';
+				break;
+			case 'object':
+				$properties = $this->getSchemaProperties();
+				if (isset($properties['raw'], $properties['raw']['type'])) {
+					$wpdb_type = $this->_get_wpdb_data_type($properties['raw']['type']);
+				}
+				break; // leave at default
+		}
+		return $wpdb_type;
+	}
+
+
+
+	protected function _get_wpdb_data_type_for_type_array($type)
+	{
+		$type = (array) $type;
+		// first let's flip because then we can do a faster key check
+		$type = array_flip($type);
+
+		// check for things that mean '%s'
+		if (isset($type['string'], $type['object'], $type['array'])) {
+			return '%s';
+		}
+
+		// if makes it past the above condition and there's float in the array
+		// then the type is %f
+		if (isset($type['number'])) {
+			return '%f';
+		}
+
+		// if it makes it above the above conditions and there is an integer in the array
+		// then the type is %d
+		if (isset($type['integer'])) {
+			return '%d';
+		}
+
+		// anything else is a string
+		return '%s';
+	}
+
+
+	/**
+	 * This returns elements used to represent this field in the json schema.
+	 *
+	 * @link http://json-schema.org/
+	 * @return array
+	 */
+	public function getSchema()
+	{
+		$schema = array(
+			'description' => $this->getSchemaDescription(),
+			'type' => $this->getSchemaType(),
+			'readonly' => $this->getSchemaReadonly(),
+			'default' => $this->getSchemaDefault()
+		);
+
+		// optional properties of the schema
+		$enum = $this->getSchemaEnum();
+		$properties = $this->getSchemaProperties();
+		$format = $this->getSchemaFormat();
+		if ($enum) {
+			$schema['enum'] = $enum;
+		}
+
+		if ($properties) {
+			$schema['properties'] = $properties;
+		}
+
+		if ($format) {
+			$schema['format'] = $format;
+		}
+		return $schema;
+	}
+
+	/**
+	 * Some fields are in the database-only, (ie, used in queries etc), but shouldn't necessarily be part
+	 * of the model objects (ie, client code shouldn't care to ever see their value... if client code does
+	 * want to see their value, then they shouldn't be db-only fields!)
+	 * Eg, when doing events as custom post types, querying the post_type is essential, but
+	 * post_type is irrelevant for EE_Event objects (because they will ALL be of post_type 'esp_event').
+	 * By default, all fields aren't db-only.
+	 *
+	 * @return boolean
+	 */
+	public function is_db_only_field()
+	{
+		return false;
+	}
+
+
+	/**
+	 * Validates the incoming string|array to ensure its an allowable type.
+	 * @throws InvalidArgumentException
+	 * @param string|array $type
+	 */
+	private function validateSchemaType($type)
+	{
+		if (! (is_string($type) || is_array($type))) {
+			throw new InvalidArgumentException(
+				sprintf(
+					esc_html__('The incoming argument (%s) must be a string or an array.', 'event_espresso'),
+					print_r($type, true)
+				)
+			);
+		}
+
+		// validate allowable types.
+		// @link http://json-schema.org/latest/json-schema-core.html#rfc.section.4.2
+		$allowable_types = array_flip(
+			array(
+				'string',
+				'number',
+				'null',
+				'object',
+				'array',
+				'boolean',
+				'integer'
+			)
+		);
+
+		if (is_array($type)) {
+			foreach ($type as $item_in_type) {
+				$this->validateSchemaType($item_in_type);
+			}
+			return;
+		}
+
+		if (! isset($allowable_types[ $type ])) {
+			throw new InvalidArgumentException(
+				sprintf(
+					esc_html__('The incoming argument (%1$s) must be one of the allowable types: %2$s', 'event_espresso'),
+					$type,
+					implode(',', array_flip($allowable_types))
+				)
+			);
+		}
+	}
+
+
+	/**
+	 * Validates that the incoming format is an allowable string to use for the _schema_format property
+	 * @throws InvalidArgumentException
+	 * @param $format
+	 */
+	private function validateSchemaFormat($format)
+	{
+		if (! is_string($format)) {
+			throw new InvalidArgumentException(
+				sprintf(
+					esc_html__('The incoming argument (%s) must be a string.', 'event_espresso'),
+					print_r($format, true)
+				)
+			);
+		}
+
+		// validate allowable format values
+		// @link http://json-schema.org/latest/json-schema-validation.html#rfc.section.7
+		$allowable_formats = array_flip(
+			array(
+				'date-time',
+				'email',
+				'hostname',
+				'ipv4',
+				'ipv6',
+				'uri',
+				'uriref'
+			)
+		);
+
+		if (! isset($allowable_formats[ $format ])) {
+			throw new InvalidArgumentException(
+				sprintf(
+					esc_html__('The incoming argument (%1$s) must be one of the allowable formats: %2$s', 'event_espresso'),
+					$format,
+					implode(',', array_flip($allowable_formats))
+				)
+			);
+		}
+	}
 }

Spacing +10 added lines, -10 removed lines

@@ -127,7 +127,7 @@ 
         /**
          * allow for changing the defaults
          */
-        $this->_nicename      = apply_filters(
+        $this->_nicename = apply_filters(
             'FHEE__EE_Model_Field_Base___construct_finalize___nicename',
             $this->_nicename,
             $this
@@ -217,7 +217,7 @@ 
      */
     public function get_qualified_column()
     {
-        return $this->get_table_alias() . "." . $this->get_table_column();
+        return $this->get_table_alias().".".$this->get_table_column();
     }
 
     /**
@@ -312,7 +312,7 @@ 
     {
         if ($this->is_nullable()) {
             $this->_schema_type = (array) $this->_schema_type;
-            if (! in_array('null', $this->_schema_type)) {
+            if ( ! in_array('null', $this->_schema_type)) {
                 $this->_schema_type[] = 'null';
             };
         }
@@ -369,10 +369,10 @@ 
                 switch ($property_key) {
                     case 'pretty':
                     case 'rendered':
-                        $value_to_return[ $property_key ] = $this->prepare_for_pretty_echoing($this->prepare_for_set($default_value));
+                        $value_to_return[$property_key] = $this->prepare_for_pretty_echoing($this->prepare_for_set($default_value));
                         break;
                     default:
-                        $value_to_return[ $property_key ] = $default_value;
+                        $value_to_return[$property_key] = $default_value;
                         break;
                 }
             }
@@ -437,7 +437,7 @@ 
      */
     protected function setSchemaReadOnly($readonly)
     {
-        if (! is_bool($readonly)) {
+        if ( ! is_bool($readonly)) {
             throw new InvalidArgumentException(
                 sprintf(
                     esc_html__('The incoming argument (%s) must be a boolean.', 'event_espresso'),
@@ -584,7 +584,7 @@ 
      */
     private function validateSchemaType($type)
     {
-        if (! (is_string($type) || is_array($type))) {
+        if ( ! (is_string($type) || is_array($type))) {
             throw new InvalidArgumentException(
                 sprintf(
                     esc_html__('The incoming argument (%s) must be a string or an array.', 'event_espresso'),
@@ -614,7 +614,7 @@ 
             return;
         }
 
-        if (! isset($allowable_types[ $type ])) {
+        if ( ! isset($allowable_types[$type])) {
             throw new InvalidArgumentException(
                 sprintf(
                     esc_html__('The incoming argument (%1$s) must be one of the allowable types: %2$s', 'event_espresso'),
@@ -633,7 +633,7 @@ 
      */
     private function validateSchemaFormat($format)
     {
-        if (! is_string($format)) {
+        if ( ! is_string($format)) {
             throw new InvalidArgumentException(
                 sprintf(
                     esc_html__('The incoming argument (%s) must be a string.', 'event_espresso'),
@@ -656,7 +656,7 @@ 
             )
         );
 
-        if (! isset($allowable_formats[ $format ])) {
+        if ( ! isset($allowable_formats[$format])) {
             throw new InvalidArgumentException(
                 sprintf(
                     esc_html__('The incoming argument (%1$s) must be one of the allowable formats: %2$s', 'event_espresso'),

core/db_models/fields/EE_Plain_Text_Field.php

Indentation +10 added lines, -10 removed lines

@@ -2,14 +2,14 @@
 
 class EE_Plain_Text_Field extends EE_Text_Field_Base
 {
-    /**
-     * removes all tags when setting
-     *
-     * @param string $value_inputted_for_field_on_model_object
-     * @return string
-     */
-    public function prepare_for_set($value_inputted_for_field_on_model_object)
-    {
-        return wp_strip_all_tags(parent::prepare_for_set($value_inputted_for_field_on_model_object));
-    }
+	/**
+	 * removes all tags when setting
+	 *
+	 * @param string $value_inputted_for_field_on_model_object
+	 * @return string
+	 */
+	public function prepare_for_set($value_inputted_for_field_on_model_object)
+	{
+		return wp_strip_all_tags(parent::prepare_for_set($value_inputted_for_field_on_model_object));
+	}
 }

core/db_models/fields/EE_WP_Post_Status_Field.php

Indentation +97 added lines, -97 removed lines

@@ -3,114 +3,114 @@
 class EE_WP_Post_Status_Field extends EE_Enum_Text_Field
 {
 
-    protected $_wp_post_stati;
+	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
-     */
-    public 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);
-    }
+	/**
+	 * 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
+	 */
+	public 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)
-    {
+	/**
+	 * 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);
-        }
-    }
+		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;
+	/**
+	 * 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;
-        }
-    }
+		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);
-    }
+	/**
+	 * 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.
+	// 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;
-    }
+	/**
+	 * 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;
+	}
 }

Spacing +2 added lines, -2 removed lines

@@ -80,7 +80,7 @@ 
         $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;
+            $this->_allowed_enum_values[$post_status] = $args_object->label;
         }
     }
 
@@ -111,6 +111,6 @@ 
      */
     public function get_status_object($status)
     {
-        return isset($this->_wp_post_stati[ $status ]) ? $this->_wp_post_stati[ $status ] : false;
+        return isset($this->_wp_post_stati[$status]) ? $this->_wp_post_stati[$status] : false;
     }
 }

core/db_models/fields/EE_Trashed_Flag_Field.php

Indentation +2 added lines, -2 removed lines

@@ -2,6 +2,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
 }

core/db_models/fields/EE_Integer_Field.php

Indentation +19 added lines, -19 removed lines

@@ -6,26 +6,26 @@
  */
 class EE_Integer_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('integer');
-    }
+	/**
+	 * @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('integer');
+	}
 
 
-    public function prepare_for_set($value_inputted_for_field_on_model_object)
-    {
-        return intval($value_inputted_for_field_on_model_object);
-    }
+	public function prepare_for_set($value_inputted_for_field_on_model_object)
+	{
+		return intval($value_inputted_for_field_on_model_object);
+	}
 
-    public function prepare_for_set_from_db($value_inputted_for_field_on_model_object)
-    {
-        return intval($value_inputted_for_field_on_model_object);
-    }
+	public function prepare_for_set_from_db($value_inputted_for_field_on_model_object)
+	{
+		return intval($value_inputted_for_field_on_model_object);
+	}
 }

core/db_models/fields/EE_Primary_Key_Field_Base.php

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
-     */
-    public 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
+	 */
+	public function _construct_finalize($table_alias, $name, $model_name)
+	{
+		$this->_model_name_pointed_to = $model_name;
+		parent::_construct_finalize($table_alias, $name, $model_name);
+	}
 }