eventespresso / event-espresso-core

core/db_models/fields/EE_Full_HTML_Field.php

Doc Comments +1 added lines, -1 removed lines

@@ -19,7 +19,7 @@
      * @param string $table_column
      * @param string $nicename
      * @param bool   $nullable
-     * @param null   $default_value
+     * @param string   $default_value
      */
     public function __construct($table_column, $nicename, $nullable, $default_value = null)
     {

Indentation +48 added lines, -48 removed lines

@@ -15,57 +15,57 @@
 class EE_Full_HTML_Field extends EE_Text_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('object');
-    }
+	/**
+	 * @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('object');
+	}
 
 
-    /**
-     * Does shortcodes and auto-paragraphs the content (unless schema is 'no_wpautop')
-     *
-     * @param type $value_on_field_to_be_outputted
-     * @param type $schema
-     * @return string
-     */
-    function prepare_for_pretty_echoing($value_on_field_to_be_outputted, $schema = null)
-    {
-        if ($schema == 'form_input') {
-            return parent::prepare_for_pretty_echoing($value_on_field_to_be_outputted, $schema);
-        } elseif ($schema == 'no_wpautop') {
-            return do_shortcode(parent::prepare_for_pretty_echoing($value_on_field_to_be_outputted, $schema));
-        } else {
-            return wpautop(do_shortcode(parent::prepare_for_pretty_echoing($value_on_field_to_be_outputted, $schema)));
-        }
-    }
+	/**
+	 * Does shortcodes and auto-paragraphs the content (unless schema is 'no_wpautop')
+	 *
+	 * @param type $value_on_field_to_be_outputted
+	 * @param type $schema
+	 * @return string
+	 */
+	function prepare_for_pretty_echoing($value_on_field_to_be_outputted, $schema = null)
+	{
+		if ($schema == 'form_input') {
+			return parent::prepare_for_pretty_echoing($value_on_field_to_be_outputted, $schema);
+		} elseif ($schema == 'no_wpautop') {
+			return do_shortcode(parent::prepare_for_pretty_echoing($value_on_field_to_be_outputted, $schema));
+		} else {
+			return wpautop(do_shortcode(parent::prepare_for_pretty_echoing($value_on_field_to_be_outputted, $schema)));
+		}
+	}
 
 
 
-    public function getSchemaProperties()
-    {
-        return array(
-            'raw' => array(
-                'description' =>  sprintf(
-                    __('%s - the value in the database.', 'event_espresso'),
-                    $this->get_nicename()
-                ),
-                'type' => 'string'
-            ),
-            'rendered' => array(
-                'description' =>  sprintf(
-                    __('%s - transformed for display.', 'event_espresso'),
-                    $this->get_nicename()
-                ),
-                'type' => 'string',
-                'readonly' => true
-            )
-        );
-    }
+	public function getSchemaProperties()
+	{
+		return array(
+			'raw' => array(
+				'description' =>  sprintf(
+					__('%s - the value in the database.', 'event_espresso'),
+					$this->get_nicename()
+				),
+				'type' => 'string'
+			),
+			'rendered' => array(
+				'description' =>  sprintf(
+					__('%s - transformed for display.', 'event_espresso'),
+					$this->get_nicename()
+				),
+				'type' => 'string',
+				'readonly' => true
+			)
+		);
+	}
 }
\ No newline at end of file

core/db_models/fields/EE_Integer_Field.php

Doc Comments +1 added lines, -1 removed lines

@@ -11,7 +11,7 @@
      * @param string $table_column
      * @param string $nicename
      * @param bool   $nullable
-     * @param null   $default_value
+     * @param integer|null   $default_value
      */
     public function __construct($table_column, $nicename, $nullable, $default_value = null)
     {

Indentation +19 added lines, -19 removed lines

@@ -7,26 +7,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');
+	}
 
 
-    function prepare_for_set($value_inputted_for_field_on_model_object)
-    {
-        return intval($value_inputted_for_field_on_model_object);
-    }
+	function prepare_for_set($value_inputted_for_field_on_model_object)
+	{
+		return intval($value_inputted_for_field_on_model_object);
+	}
 
-    function prepare_for_set_from_db($value_inputted_for_field_on_model_object)
-    {
-        return intval($value_inputted_for_field_on_model_object);
-    }
+	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_Model_Field_Base.php

Doc Comments +1 added lines, -1 removed lines

@@ -582,7 +582,7 @@
     /**
      * Validates that the incoming format is an allowable string to use for the _schema_format property
      * @throws InvalidArgumentException
-     * @param $format
+     * @param string $format
      */
     private function validateSchemaFormat($format)
     {

Indentation +597 added lines, -598 removed lines

@@ -21,602 +21,601 @@
  */
 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 ot serialize 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. We may want to add slashes, serialize it, etc.
-     * By default, we do nothing.
-     *
-     * @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.
-     *
-     * @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();
-    }
-
-
-    /**
-     * 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(),
-        );
-
-        //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 ot serialize 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. We may want to add slashes, serialize it, etc.
+	 * By default, we do nothing.
+	 *
+	 * @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.
+	 *
+	 * @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();
+	}
+
+
+	/**
+	 * 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(),
+		);
+
+		//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))
+				)
+			);
+		}
+	}
 }
\ No newline at end of file

Spacing +9 added lines, -9 removed lines

@@ -211,7 +211,7 @@ 
      */
     public function get_qualified_column()
     {
-        return $this->get_table_alias() . "." . $this->get_table_column();
+        return $this->get_table_alias().".".$this->get_table_column();
     }
 
     /**
@@ -302,7 +302,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';
             };
         }
@@ -391,7 +391,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'),
@@ -424,7 +424,7 @@ 
      * @uses get_schema_type()
      * @return string
      */
-    protected function _get_wpdb_data_type($type='')
+    protected function _get_wpdb_data_type($type = '')
     {
         $type = empty($type) ? $this->getSchemaType() : $type;
 
@@ -461,7 +461,7 @@ 
         $type = array_flip($type);
 
         //check for things that mean '%s'
-        if (isset($type['string'],$type['object'],$type['array'])) {
+        if (isset($type['string'], $type['object'], $type['array'])) {
             return '%s';
         }
 
@@ -537,7 +537,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'),
@@ -567,7 +567,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'),
@@ -586,7 +586,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'),
@@ -609,7 +609,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_Money_Field.php

Doc Comments +1 added lines, -1 removed lines

@@ -12,7 +12,7 @@
      * @param string $table_column
      * @param string $nicename
      * @param bool   $nullable
-     * @param null   $default_value
+     * @param integer   $default_value
      */
     public function __construct($table_column, $nicename, $nullable, $default_value = null)
     {

Indentation +77 added lines, -77 removed lines

@@ -8,91 +8,91 @@
 class EE_Money_Field extends EE_Float_Field
 {
 
-    /**
-     * @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('object');
-    }
+	/**
+	 * @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('object');
+	}
 
 
-    /**
-     * Schemas:
-     *    'localized_float': "3,023.00"
-     *    'no_currency_code': "$3,023.00"
-     *    null: "$3,023.00<span>USD</span>"
-     *
-     * @param string $value_on_field_to_be_outputted
-     * @param string $schema
-     * @return string
-     */
-    function prepare_for_pretty_echoing($value_on_field_to_be_outputted, $schema = null)
-    {
-        $pretty_float = parent::prepare_for_pretty_echoing($value_on_field_to_be_outputted);
+	/**
+	 * Schemas:
+	 *    'localized_float': "3,023.00"
+	 *    'no_currency_code': "$3,023.00"
+	 *    null: "$3,023.00<span>USD</span>"
+	 *
+	 * @param string $value_on_field_to_be_outputted
+	 * @param string $schema
+	 * @return string
+	 */
+	function prepare_for_pretty_echoing($value_on_field_to_be_outputted, $schema = null)
+	{
+		$pretty_float = parent::prepare_for_pretty_echoing($value_on_field_to_be_outputted);
 
-        if ($schema == 'localized_float') {
-            return $pretty_float;
-        }
-        if ($schema == 'no_currency_code') {
+		if ($schema == 'localized_float') {
+			return $pretty_float;
+		}
+		if ($schema == 'no_currency_code') {
 //			echo "schema no currency!";
-            $display_code = false;
-        } else {
-            $display_code = true;
-        }
-        //we don't use the $pretty_float because format_currency will take care of it.
-        return EEH_Template::format_currency($value_on_field_to_be_outputted, false, $display_code);
-    }
+			$display_code = false;
+		} else {
+			$display_code = true;
+		}
+		//we don't use the $pretty_float because format_currency will take care of it.
+		return EEH_Template::format_currency($value_on_field_to_be_outputted, false, $display_code);
+	}
 
-    /**
-     * If provided with a string, strips out money-related formatting to turn it into a proper float.
-     * Rounds the float to the correct number of decimal places for this country's currency.
-     * Also, interprets periods and commas according to the country's currency settings.
-     * So if you want to pass in a string that NEEDS to interpret periods as decimal marks, call floatval() on it first.
-     *
-     * @param string $value_inputted_for_field_on_model_object
-     * @return float
-     */
-    function prepare_for_set($value_inputted_for_field_on_model_object)
-    {
-        //remove any currencies etc.
+	/**
+	 * If provided with a string, strips out money-related formatting to turn it into a proper float.
+	 * Rounds the float to the correct number of decimal places for this country's currency.
+	 * Also, interprets periods and commas according to the country's currency settings.
+	 * So if you want to pass in a string that NEEDS to interpret periods as decimal marks, call floatval() on it first.
+	 *
+	 * @param string $value_inputted_for_field_on_model_object
+	 * @return float
+	 */
+	function prepare_for_set($value_inputted_for_field_on_model_object)
+	{
+		//remove any currencies etc.
 //		if(is_string($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);
 //		}
-        //now it's a float-style string or number
-        $float_val = parent::prepare_for_set($value_inputted_for_field_on_model_object);
-        //round to the correctly number of decimal places for this  currency
-        $rounded_value = round($float_val, EE_Registry::instance()->CFG->currency->dec_plc);
-        return $rounded_value;
-    }
+		//now it's a float-style string or number
+		$float_val = parent::prepare_for_set($value_inputted_for_field_on_model_object);
+		//round to the correctly number of decimal places for this  currency
+		$rounded_value = round($float_val, EE_Registry::instance()->CFG->currency->dec_plc);
+		return $rounded_value;
+	}
 
-    function prepare_for_get($value_of_field_on_model_object)
-    {
-        $c = EE_Registry::instance()->CFG->currency;
-        return round(parent::prepare_for_get($value_of_field_on_model_object), $c->dec_plc);
-    }
+	function prepare_for_get($value_of_field_on_model_object)
+	{
+		$c = EE_Registry::instance()->CFG->currency;
+		return round(parent::prepare_for_get($value_of_field_on_model_object), $c->dec_plc);
+	}
 
-    public function getSchemaProperties()
-    {
-        return array(
-            'raw' => array(
-                'description' =>  sprintf(
-                    __('%s - the raw value as it exists in the database as a simple float.', 'event_espresso'),
-                    $this->get_nicename()
-                ),
-                'type' => 'number'
-            ),
-            'pretty' => array(
-                'description' =>  sprintf(
-                    __('%s - formatted for display in the set currency and decimal places.', 'event_espresso'),
-                    $this->get_nicename()
-                ),
-                'type' => 'string'
-            )
-        );
-    }
+	public function getSchemaProperties()
+	{
+		return array(
+			'raw' => array(
+				'description' =>  sprintf(
+					__('%s - the raw value as it exists in the database as a simple float.', 'event_espresso'),
+					$this->get_nicename()
+				),
+				'type' => 'number'
+			),
+			'pretty' => array(
+				'description' =>  sprintf(
+					__('%s - formatted for display in the set currency and decimal places.', 'event_espresso'),
+					$this->get_nicename()
+				),
+				'type' => 'string'
+			)
+		);
+	}
 }
\ No newline at end of file

core/libraries/rest_api/Model_Version_Info.php

Indentation +10 added lines, -10 removed lines

@@ -89,12 +89,12 @@ 
 
 
 
-    /**
-     * Model_Version_Info constructor.
-     *
-     * @param string $requested_version
-     */
-    public function __construct( $requested_version ) {
+	/**
+	 * Model_Version_Info constructor.
+	 *
+	 * @param string $requested_version
+	 */
+	public function __construct( $requested_version ) {
 		$this->_requested_version = $requested_version;
 		$this->_model_changes = array(
 			'4.8.29' => array(
@@ -209,10 +209,10 @@ 
 				}
 			}
 			$this->_cached_models_for_requested_version = apply_filters(
-			    'FHEE__EventEspresso_core_libraries_rest_api__models_for_requested_version',
-                $all_models_in_current_version,
-                $this
-            );
+				'FHEE__EventEspresso_core_libraries_rest_api__models_for_requested_version',
+				$all_models_in_current_version,
+				$this
+			);
 		}
 		return $this->_cached_models_for_requested_version;
 	}

core/db_models/fields/EE_DB_Only_Int_Field.php

Indentation +11 added lines, -11 removed lines

@@ -3,15 +3,15 @@
 
 class EE_DB_Only_Int_Field extends EE_DB_Only_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');
+	}
 }
\ No newline at end of file

core/db_models/fields/EE_Infinite_Integer_Field.php

Indentation +68 added lines, -68 removed lines

@@ -11,77 +11,77 @@
 class EE_Infinite_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(array('integer', 'null'));
-    }
+	/**
+	 * @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(array('integer', 'null'));
+	}
 
 
-    function prepare_for_use_in_db($value_of_field_on_model_object)
-    {
-        if ($value_of_field_on_model_object === EE_INF) {
-            return EE_INF_IN_DB;
-        } else {
-            return intval($value_of_field_on_model_object);
-        }
-    }
+	function prepare_for_use_in_db($value_of_field_on_model_object)
+	{
+		if ($value_of_field_on_model_object === EE_INF) {
+			return EE_INF_IN_DB;
+		} else {
+			return intval($value_of_field_on_model_object);
+		}
+	}
 
-    function prepare_for_set($value_inputted_for_field_on_model_object)
-    {
-        if ($value_inputted_for_field_on_model_object === EE_INF_IN_DB ||
-            $value_inputted_for_field_on_model_object === EE_INF ||
-            $value_inputted_for_field_on_model_object === "EE_INF" ||
-            $value_inputted_for_field_on_model_object === ""
-        ) {
-            return EE_INF;
-        } else {
-            return intval($value_inputted_for_field_on_model_object);
-        }
-    }
+	function prepare_for_set($value_inputted_for_field_on_model_object)
+	{
+		if ($value_inputted_for_field_on_model_object === EE_INF_IN_DB ||
+			$value_inputted_for_field_on_model_object === EE_INF ||
+			$value_inputted_for_field_on_model_object === "EE_INF" ||
+			$value_inputted_for_field_on_model_object === ""
+		) {
+			return EE_INF;
+		} else {
+			return intval($value_inputted_for_field_on_model_object);
+		}
+	}
 
-    function prepare_for_set_from_db($value_inputted_for_field_on_model_object)
-    {
-        $intval = intval($value_inputted_for_field_on_model_object);
-        if ($intval == EE_INF_IN_DB) {
-            return EE_INF;
-        } else {
-            return $intval;
-        }
-    }
+	function prepare_for_set_from_db($value_inputted_for_field_on_model_object)
+	{
+		$intval = intval($value_inputted_for_field_on_model_object);
+		if ($intval == EE_INF_IN_DB) {
+			return EE_INF;
+		} else {
+			return $intval;
+		}
+	}
 
-    /**
-     * For outputting this field's value. If you want to output it into an input or something,
-     * use $schema=='input', as it will replace EE_INF with ''. If you want a readable version, use $schema=='text'
-     * as it will replace EE_INF with i18n Infinite
-     *
-     * @param type   $value_on_field_to_be_outputted
-     * @param string $schema input, symbol, text; or any string you want to show if the value equals EE_INF
-     * @return string
-     */
-    function prepare_for_pretty_echoing($value_on_field_to_be_outputted, $schema = null)
-    {
-        if ($value_on_field_to_be_outputted === EE_INF) {
-            switch ($schema) {
-                case 'input':
-                case 'form_input':
-                    return '';
-                case 'symbol':
-                    return "∞";
-                case 'text':
-                case null:
-                    return __("Unlimited", "event_espresso");
-                default:
-                    return $schema;
-            }
-        } else {
-            return $value_on_field_to_be_outputted;
-        }
-    }
+	/**
+	 * For outputting this field's value. If you want to output it into an input or something,
+	 * use $schema=='input', as it will replace EE_INF with ''. If you want a readable version, use $schema=='text'
+	 * as it will replace EE_INF with i18n Infinite
+	 *
+	 * @param type   $value_on_field_to_be_outputted
+	 * @param string $schema input, symbol, text; or any string you want to show if the value equals EE_INF
+	 * @return string
+	 */
+	function prepare_for_pretty_echoing($value_on_field_to_be_outputted, $schema = null)
+	{
+		if ($value_on_field_to_be_outputted === EE_INF) {
+			switch ($schema) {
+				case 'input':
+				case 'form_input':
+					return '';
+				case 'symbol':
+					return "∞";
+				case 'text':
+				case null:
+					return __("Unlimited", "event_espresso");
+				default:
+					return $schema;
+			}
+		} else {
+			return $value_on_field_to_be_outputted;
+		}
+	}
 }

core/db_models/fields/EE_Serialized_Text_Field.php

Indentation +63 added lines, -63 removed lines

@@ -10,72 +10,72 @@
 class EE_Serialized_Text_Field extends EE_Text_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(array('object','string'));
-    }
+	/**
+	 * @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(array('object','string'));
+	}
 
 
-    /**
-     * Value SHOULD be an array, and we want to now convert it to a serialized string
-     *
-     * @param array $value_of_field_on_model_object
-     * @return string
-     */
-    function prepare_for_use_in_db($value_of_field_on_model_object)
-    {
-        return maybe_serialize($value_of_field_on_model_object);
-    }
+	/**
+	 * Value SHOULD be an array, and we want to now convert it to a serialized string
+	 *
+	 * @param array $value_of_field_on_model_object
+	 * @return string
+	 */
+	function prepare_for_use_in_db($value_of_field_on_model_object)
+	{
+		return maybe_serialize($value_of_field_on_model_object);
+	}
 
-    function prepare_for_set($value_inputted_for_field_on_model_object)
-    {
-        $value_inputted_for_field_on_model_object = EEH_Array::maybe_unserialize($value_inputted_for_field_on_model_object);
-        if (is_string($value_inputted_for_field_on_model_object)) {
-            return parent::prepare_for_set($value_inputted_for_field_on_model_object);
-        } elseif (is_array($value_inputted_for_field_on_model_object)) {
-            return array_map(array($this, 'prepare_for_set'), $value_inputted_for_field_on_model_object);
-        } else {//so they passed NULL or an INT or something wack
-            return $value_inputted_for_field_on_model_object;
-        }
-    }
+	function prepare_for_set($value_inputted_for_field_on_model_object)
+	{
+		$value_inputted_for_field_on_model_object = EEH_Array::maybe_unserialize($value_inputted_for_field_on_model_object);
+		if (is_string($value_inputted_for_field_on_model_object)) {
+			return parent::prepare_for_set($value_inputted_for_field_on_model_object);
+		} elseif (is_array($value_inputted_for_field_on_model_object)) {
+			return array_map(array($this, 'prepare_for_set'), $value_inputted_for_field_on_model_object);
+		} else {//so they passed NULL or an INT or something wack
+			return $value_inputted_for_field_on_model_object;
+		}
+	}
 
-    /**
-     * Value provided should definetely be a serialized string. We should unserialize into an array
-     *
-     * @param string $value_found_in_db_for_model_object
-     * @return array
-     */
-    function prepare_for_set_from_db($value_found_in_db_for_model_object)
-    {
-        return EEH_Array::maybe_unserialize($value_found_in_db_for_model_object);
-    }
+	/**
+	 * Value provided should definetely be a serialized string. We should unserialize into an array
+	 *
+	 * @param string $value_found_in_db_for_model_object
+	 * @return array
+	 */
+	function prepare_for_set_from_db($value_found_in_db_for_model_object)
+	{
+		return EEH_Array::maybe_unserialize($value_found_in_db_for_model_object);
+	}
 
-    /**
-     * Gets a string representation of the array
-     *
-     * @param type   $value_on_field_to_be_outputted
-     * @param string $schema , possible values are ',', others can be added
-     * @return string
-     */
-    function prepare_for_pretty_echoing($value_on_field_to_be_outputted, $schema = null)
-    {
-        switch ($schema) {
-            case 'print_r':
-                $pretty_value = print_r($value_on_field_to_be_outputted, true);
-                break;
-            case 'as_table':
-                $pretty_value = EEH_Template::layout_array_as_table($value_on_field_to_be_outputted);
-                break;
-            default:
-                $pretty_value = implode(", ", $value_on_field_to_be_outputted);
-        }
-        return $pretty_value;
-    }
+	/**
+	 * Gets a string representation of the array
+	 *
+	 * @param type   $value_on_field_to_be_outputted
+	 * @param string $schema , possible values are ',', others can be added
+	 * @return string
+	 */
+	function prepare_for_pretty_echoing($value_on_field_to_be_outputted, $schema = null)
+	{
+		switch ($schema) {
+			case 'print_r':
+				$pretty_value = print_r($value_on_field_to_be_outputted, true);
+				break;
+			case 'as_table':
+				$pretty_value = EEH_Template::layout_array_as_table($value_on_field_to_be_outputted);
+				break;
+			default:
+				$pretty_value = implode(", ", $value_on_field_to_be_outputted);
+		}
+		return $pretty_value;
+	}
 }

Spacing +1 added lines, -1 removed lines

@@ -19,7 +19,7 @@
     public function __construct($table_column, $nicename, $nullable, $default_value = null)
     {
         parent::__construct($table_column, $nicename, $nullable, $default_value);
-        $this->setSchemaType(array('object','string'));
+        $this->setSchemaType(array('object', 'string'));
     }
 
 

core/db_models/fields/EE_Enum_Integer_Field.php

Indentation +102 added lines, -102 removed lines

@@ -10,115 +10,115 @@
  */
 class EE_Enum_Integer_Field extends EE_Integer_Field
 {
-    /**
-     * @var array $_allowed_enum_values
-     */
-    public $_allowed_enum_values;
+	/**
+	 * @var array $_allowed_enum_values
+	 */
+	public $_allowed_enum_values;
 
 
-    /**
-     * @param string  $table_column
-     * @param string  $nicename
-     * @param boolean $nullable
-     * @param int     $default_value
-     * @param array   $allowed_enum_values keys are values to be used in the DB, values are how they should be displayed
-     */
-    public function __construct($table_column, $nicename, $nullable, $default_value, $allowed_enum_values)
-    {
-        $this->_allowed_enum_values = $allowed_enum_values;
-        parent::__construct($table_column, $nicename, $nullable, $default_value);
-        $this->setSchemaType('object');
-    }
+	/**
+	 * @param string  $table_column
+	 * @param string  $nicename
+	 * @param boolean $nullable
+	 * @param int     $default_value
+	 * @param array   $allowed_enum_values keys are values to be used in the DB, values are how they should be displayed
+	 */
+	public function __construct($table_column, $nicename, $nullable, $default_value, $allowed_enum_values)
+	{
+		$this->_allowed_enum_values = $allowed_enum_values;
+		parent::__construct($table_column, $nicename, $nullable, $default_value);
+		$this->setSchemaType('object');
+	}
 
-    /**
-     * Returns the list of allowed enum options, but filterable.
-     * This is used internally
-     *
-     * @return array
-     */
-    protected function _allowed_enum_values()
-    {
-        return (array)apply_filters(
-            'FHEE__EE_Enum_Integer_Field___allowed_enum_options',
-            $this->_allowed_enum_values,
-            $this
-        );
-    }
+	/**
+	 * Returns the list of allowed enum options, but filterable.
+	 * This is used internally
+	 *
+	 * @return array
+	 */
+	protected function _allowed_enum_values()
+	{
+		return (array)apply_filters(
+			'FHEE__EE_Enum_Integer_Field___allowed_enum_options',
+			$this->_allowed_enum_values,
+			$this
+		);
+	}
 
-    /**
-     * When setting, just verify that the value being used matches what we've defined as allowable enum values.
-     * If not, throw an error (but if WP_DEBUG is false, just set the value to default)
-     *
-     * @param int $value_inputted_for_field_on_model_object
-     * @return int
-     * @throws EE_Error
-     */
-    public function prepare_for_set($value_inputted_for_field_on_model_object)
-    {
-        $allowed_enum_values = $this->_allowed_enum_values();
-        if (
-            $value_inputted_for_field_on_model_object !== null
-            && ! array_key_exists($value_inputted_for_field_on_model_object, $allowed_enum_values)
-        ) {
-            if (defined('WP_DEBUG') && WP_DEBUG) {
-                $msg = sprintf(
-                    __('System is assigning incompatible value "%1$s" to field "%2$s"', 'event_espresso'),
-                    $value_inputted_for_field_on_model_object,
-                    $this->_name
-                );
-                $msg2 = sprintf(
-                    __('Allowed values for "%1$s" are "%2$s". You provided "%3$s"', 'event_espresso'),
-                    $this->_name,
-                    implode(', ', array_keys($allowed_enum_values)),
-                    $value_inputted_for_field_on_model_object
-                );
-                EE_Error::add_error("{$msg}||{$msg2}", __FILE__, __FUNCTION__, __LINE__);
-            }
-            return $this->get_default_value();
-        }
-        return (int)$value_inputted_for_field_on_model_object;
-    }
+	/**
+	 * When setting, just verify that the value being used matches what we've defined as allowable enum values.
+	 * If not, throw an error (but if WP_DEBUG is false, just set the value to default)
+	 *
+	 * @param int $value_inputted_for_field_on_model_object
+	 * @return int
+	 * @throws EE_Error
+	 */
+	public function prepare_for_set($value_inputted_for_field_on_model_object)
+	{
+		$allowed_enum_values = $this->_allowed_enum_values();
+		if (
+			$value_inputted_for_field_on_model_object !== null
+			&& ! array_key_exists($value_inputted_for_field_on_model_object, $allowed_enum_values)
+		) {
+			if (defined('WP_DEBUG') && WP_DEBUG) {
+				$msg = sprintf(
+					__('System is assigning incompatible value "%1$s" to field "%2$s"', 'event_espresso'),
+					$value_inputted_for_field_on_model_object,
+					$this->_name
+				);
+				$msg2 = sprintf(
+					__('Allowed values for "%1$s" are "%2$s". You provided "%3$s"', 'event_espresso'),
+					$this->_name,
+					implode(', ', array_keys($allowed_enum_values)),
+					$value_inputted_for_field_on_model_object
+				);
+				EE_Error::add_error("{$msg}||{$msg2}", __FILE__, __FUNCTION__, __LINE__);
+			}
+			return $this->get_default_value();
+		}
+		return (int)$value_inputted_for_field_on_model_object;
+	}
 
 
 
-    /**
-     * Gets the pretty version of the enum's value.
-     *
-     * @param int | string $value_on_field_to_be_outputted
-     * @param null         $schema
-     * @return string
-     */
-    public function prepare_for_pretty_echoing($value_on_field_to_be_outputted, $schema = null)
-    {
-        $options = $this->_allowed_enum_values();
-        if (isset($options[$value_on_field_to_be_outputted])) {
-            return $options[$value_on_field_to_be_outputted];
-        } else {
-            return $value_on_field_to_be_outputted;
-        }
-    }
+	/**
+	 * Gets the pretty version of the enum's value.
+	 *
+	 * @param int | string $value_on_field_to_be_outputted
+	 * @param null         $schema
+	 * @return string
+	 */
+	public function prepare_for_pretty_echoing($value_on_field_to_be_outputted, $schema = null)
+	{
+		$options = $this->_allowed_enum_values();
+		if (isset($options[$value_on_field_to_be_outputted])) {
+			return $options[$value_on_field_to_be_outputted];
+		} else {
+			return $value_on_field_to_be_outputted;
+		}
+	}
 
 
-    public function getSchemaProperties()
-    {
-        return array(
-            'raw' => array(
-                'description' =>  sprintf(
-                    __('%s - the value in the database.', 'event_espresso'),
-                    $this->get_nicename()
-                ),
-                'enum' => array_keys($this->_allowed_enum_values()),
-                'type' => 'integer'
-            ),
-            'pretty' => array(
-                'description' =>  sprintf(
-                    __('%s - the value for display.', 'event_espresso'),
-                    $this->get_nicename()
-                ),
-                'enum' => array_values($this->_allowed_enum_values()),
-                'type' => 'string',
-                'read_only' => true
-            )
-        );
-    }
+	public function getSchemaProperties()
+	{
+		return array(
+			'raw' => array(
+				'description' =>  sprintf(
+					__('%s - the value in the database.', 'event_espresso'),
+					$this->get_nicename()
+				),
+				'enum' => array_keys($this->_allowed_enum_values()),
+				'type' => 'integer'
+			),
+			'pretty' => array(
+				'description' =>  sprintf(
+					__('%s - the value for display.', 'event_espresso'),
+					$this->get_nicename()
+				),
+				'enum' => array_values($this->_allowed_enum_values()),
+				'type' => 'string',
+				'read_only' => true
+			)
+		);
+	}
 }

Spacing +2 added lines, -2 removed lines

@@ -38,7 +38,7 @@ 
      */
     protected function _allowed_enum_values()
     {
-        return (array)apply_filters(
+        return (array) apply_filters(
             'FHEE__EE_Enum_Integer_Field___allowed_enum_options',
             $this->_allowed_enum_values,
             $this
@@ -76,7 +76,7 @@ 
             }
             return $this->get_default_value();
         }
-        return (int)$value_inputted_for_field_on_model_object;
+        return (int) $value_inputted_for_field_on_model_object;
     }