eventespresso / event-espresso-core

core/libraries/form_sections/base/EE_Model_Form_Section.form.php

Spacing +13 added lines, -13 removed lines

@@ -38,7 +38,7 @@ 
         if (isset($options_array['model']) && $options_array['model'] instanceof EEM_Base) {
             $this->_model = $options_array['model'];
         }
-        if (! $this->_model || ! $this->_model instanceof EEM_Base) {
+        if ( ! $this->_model || ! $this->_model instanceof EEM_Base) {
             throw new EE_Error(sprintf(esc_html__(
                 "Model Form Sections must first specify the _model property to be a subclass of EEM_Base",
                 "event_espresso"
@@ -103,10 +103,10 @@ 
             switch (get_class($relation_obj)) {
                 case 'EE_HABTM_Relation':
                     if (
-                        isset($subsection_args[ $relation_name ])
-                        && isset($subsection_args[ $relation_name ]['model_objects'])
+                        isset($subsection_args[$relation_name])
+                        && isset($subsection_args[$relation_name]['model_objects'])
                     ) {
-                        $model_objects = $subsection_args[ $relation_name ]['model_objects'];
+                        $model_objects = $subsection_args[$relation_name]['model_objects'];
                     } else {
                         $model_objects = $relation_obj->get_other_model()->get_all();
                     }
@@ -115,7 +115,7 @@ 
                 default:
             }
             if ($input) {
-                $inputs[ $relation_name ] = $input;
+                $inputs[$relation_name] = $input;
             }
         }
         return $inputs;
@@ -265,7 +265,7 @@ 
                 }
                 $reflection = new ReflectionClass($input_class);
                 $input = $reflection->newInstanceArgs($input_constructor_args);
-                $inputs[ $field_name ] = $input;
+                $inputs[$field_name] = $input;
             }
         }
         return $inputs;
@@ -291,14 +291,14 @@ 
                 if ($relation_obj instanceof EE_Belongs_To_Relation) {
                     // then we only expect there to be one
                     $related_item = $this->_model_object->get_first_related($relation_name);
-                    $defaults[ $relation_name ] = $related_item->ID();
+                    $defaults[$relation_name] = $related_item->ID();
                 } else {
                     $related_items = $this->_model_object->get_many_related($relation_name);
                     $ids = array();
                     foreach ($related_items as $related_item) {
                         $ids[] = $related_item->ID();
                     }
-                    $defaults[ $relation_name ] = $ids;
+                    $defaults[$relation_name] = $ids;
                 }
             }
         }
@@ -336,7 +336,7 @@ 
     {
         parent::_normalize($req_data);
         // create or set the model object, if it isn't already
-        if (! $this->_model_object) {
+        if ( ! $this->_model_object) {
             // check to see if the form indicates a PK, in which case we want to only retrieve it and update it
             $pk_name = $this->_model->primary_key_name();
             $model_obj = $this->_model->get_one_by_ID($this->get_input_value($pk_name));
@@ -361,7 +361,7 @@ 
      */
     public function save()
     {
-        if (! $this->_model_object) {
+        if ( ! $this->_model_object) {
             throw new EE_Error(sprintf(esc_html__(
                 "Cannot save the model form's model object (model is '%s') because there is no model object set. You must either set it, or call receive_form_submission where it is set automatically",
                 "event_espresso"
@@ -376,7 +376,7 @@ 
         }
         $success = $this->_model_object->save();
         foreach ($this->_model->relation_settings() as $relation_name => $relation_obj) {
-            if (isset($this->_subsections[ $relation_name ])) {
+            if (isset($this->_subsections[$relation_name])) {
                 $success = $this->_save_related_info($relation_name);
             }
         }
@@ -463,8 +463,8 @@ 
      */
     protected function _set_default_name_if_empty()
     {
-        if (! $this->_name) {
-            $default_name = str_replace("EEM_", "", get_class($this->_model)) . "_Model_Form";
+        if ( ! $this->_name) {
+            $default_name = str_replace("EEM_", "", get_class($this->_model))."_Model_Form";
             $this->_name = $default_name;
         }
     }

Indentation +456 added lines, -456 removed lines

@@ -11,460 +11,460 @@
  */
 class EE_Model_Form_Section extends EE_Form_Section_Proper
 {
-    /**
-     * @var EEM_Base
-     */
-    protected $_model = null;
-
-    /**
-     * @var EE_Base_Class
-     */
-    protected $_model_object = null;
-
-
-
-    /**
-     * @param array        $options_array   keys: {
-     * @type EEM_Base      $model
-     * @type EE_Base_Class $model_object
-     * @type array         $subsection_args array keys should be subsection names (that either do or will exist), and
-     *       values are the arrays as you would pass them to that subsection
-     *                                      }
-     * @throws EE_Error
-     */
-    public function __construct($options_array = array())
-    {
-        if (isset($options_array['model']) && $options_array['model'] instanceof EEM_Base) {
-            $this->_model = $options_array['model'];
-        }
-        if (! $this->_model || ! $this->_model instanceof EEM_Base) {
-            throw new EE_Error(sprintf(esc_html__(
-                "Model Form Sections must first specify the _model property to be a subclass of EEM_Base",
-                "event_espresso"
-            )));
-        }
-        if (isset($options_array['subsection_args'])) {
-            $subsection_args = $options_array['subsection_args'];
-        } else {
-            $subsection_args = array();
-        }
-        // gather fields and relations to convert to inputs
-        // but if they're just going to exclude a field anyways, don't bother converting it to an input
-        $exclude = $this->_subsections;
-        if (isset($options_array['exclude'])) {
-            $exclude = array_merge($exclude, array_flip($options_array['exclude']));
-        }
-        $model_fields = array_diff_key($this->_model->field_settings(), $exclude);
-        $model_relations = array_diff_key($this->_model->relation_settings(), $exclude);
-        // convert fields and relations to inputs
-        $this->_subsections = array_merge(
-            $this->_convert_model_fields_to_inputs($model_fields),
-            $this->_convert_model_relations_to_inputs($model_relations, $subsection_args),
-            $this->_subsections
-        );
-        parent::__construct($options_array);
-        if (isset($options_array['model_object']) && $options_array['model_object'] instanceof EE_Base_Class) {
-            $this->populate_model_obj($options_array['model_object']);
-        }
-    }
-
-
-
-    /**
-     * For now, just makes inputs for only HABTM relations
-     *
-     * @param EE_Model_Relation_Base[] $relations
-     * @param array                    $subsection_args keys should be existing or soon-to-be-existing input names, and
-     *                                                  their values are {
-     * @type array {
-     * @type EE_Base_Class[]           $model_objects   if the subsection is an EE_Select_Multi_Model_Input
-     *                                                  }
-     *                                                  }
-     * @return array
-     */
-    protected function _convert_model_relations_to_inputs($relations, $subsection_args = array())
-    {
-        $inputs = array();
-        foreach ($relations as $relation_name => $relation_obj) {
-            $input_constructor_args = array(
-                array_merge(
-                    array(
-                        'required'        => $relation_obj instanceof EE_Belongs_To_Relation,
-                        'html_label_text' => $relation_obj instanceof EE_Belongs_To_Relation
-                            ? $relation_obj->get_other_model()->item_name(1)
-                            : $relation_obj->get_other_model()
-                                           ->item_name(2),
-                    ),
-                    $subsection_args
-                ),
-            );
-            $input = null;
-            switch (get_class($relation_obj)) {
-                case 'EE_HABTM_Relation':
-                    if (
-                        isset($subsection_args[ $relation_name ])
-                        && isset($subsection_args[ $relation_name ]['model_objects'])
-                    ) {
-                        $model_objects = $subsection_args[ $relation_name ]['model_objects'];
-                    } else {
-                        $model_objects = $relation_obj->get_other_model()->get_all();
-                    }
-                    $input = new EE_Select_Multi_Model_Input($model_objects, $input_constructor_args);
-                    break;
-                default:
-            }
-            if ($input) {
-                $inputs[ $relation_name ] = $input;
-            }
-        }
-        return $inputs;
-    }
-
-
-
-    /**
-     * Changes model fields into form section inputs
-     *
-     * @param EE_Model_Field_Base[] $model_fields keys are the model's name
-     * @throws EE_Error
-     * @return EE_Form_Input_Base[]
-     */
-    protected function _convert_model_fields_to_inputs($model_fields = array())
-    {
-        $inputs = array();
-        foreach ($model_fields as $field_name => $model_field) {
-            if ($model_field instanceof EE_Model_Field_Base) {
-                $input_constructor_args = array(
-                    array(
-                        'required'        => ! $model_field->is_nullable()
-                                             && $model_field->get_default_value()
-                                                === null,
-                        'html_label_text' => $model_field->get_nicename(),
-                        'default'         => $model_field->get_default_value(),
-                    ),
-                );
-                switch (get_class($model_field)) {
-                    case 'EE_All_Caps_Text_Field':
-                    case 'EE_Any_Foreign_Model_Name_Field':
-                        $input_class = 'EE_Text_Input';
-                        break;
-                    case 'EE_Boolean_Field':
-                        $input_class = 'EE_Yes_No_Input';
-                        break;
-                    case 'EE_Datetime_Field':
-                        throw new EE_Error(sprintf(esc_html__(
-                            "Model field '%s' does not yet have a known conversion to form input",
-                            "event_espresso"
-                        ), get_class($model_field)));
-                        break;
-                    case 'EE_Email_Field':
-                        $input_class = 'EE_Email_Input';
-                        break;
-                    case 'EE_Enum_Integer_Field':
-                        throw new EE_Error(sprintf(esc_html__(
-                            "Model field '%s' does not yet have a known conversion to form input",
-                            "event_espresso"
-                        ), get_class($model_field)));
-                        break;
-                    case 'EE_Enum_Text_Field':
-                        throw new EE_Error(sprintf(esc_html__(
-                            "Model field '%s' does not yet have a known conversion to form input",
-                            "event_espresso"
-                        ), get_class($model_field)));
-                        break;
-                    case 'EE_Float_Field':
-                        $input_class = 'EE_Float_Input';
-                        break;
-                    case 'EE_Foreign_Key_Int_Field':
-                    case 'EE_Foreign_Key_String_Field':
-                    case 'EE_WP_User_Field':
-                        $models_pointed_to = $model_field instanceof EE_Field_With_Model_Name
-                            ? $model_field->get_model_class_names_pointed_to() : array();
-                        if (true || is_array($models_pointed_to) && count($models_pointed_to) > 1) {
-                            $input_class = 'EE_Text_Input';
-                        } else {
-                            // so its just one model
-                            $model_name = is_array($models_pointed_to) ? reset($models_pointed_to) : $models_pointed_to;
-                            $model = EE_Registry::instance()->load_model($model_name);
-                            $model_names = $model->get_all_names(array('limit' => 10));
-                            if ($model_field->is_nullable()) {
-                                array_unshift($model_names, esc_html__("Please Select", 'event_espresso'));
-                            }
-                            $input_constructor_args[1] = $input_constructor_args[0];
-                            $input_constructor_args[0] = $model_names;
-                            $input_class = 'EE_Select_Input';
-                        }
-                        break;
-                    case 'EE_Full_HTML_Field':
-                        $input_class = 'EE_Text_Area_Input';
-                        $input_constructor_args[0]['validation_strategies'] = array(new EE_Full_HTML_Validation_Strategy());
-                        break;
-                    case 'EE_Infinite_Integer':
-                        throw new EE_Error(sprintf(esc_html__(
-                            "Model field '%s' does not yet have a known conversion to form input",
-                            "event_espresso"
-                        ), get_class($model_field)));
-                        break;
-                    case 'EE_Integer_Field':
-                        $input_class = 'EE_Text_Input';
-                        break;
-                    case 'EE_Maybe_Serialized_Text_Field':
-                        $input_class = 'EE_Text_Area_Input';
-                        break;
-                    case 'EE_Money_Field':
-                        throw new EE_Error(sprintf(esc_html__(
-                            "Model field '%s' does not yet have a known conversion to form input",
-                            "event_espresso"
-                        ), get_class($model_field)));
-                        break;
-                    case 'EE_Post_Content_Field':
-                        $input_class = 'EE_Text_Area_Input';
-                        $input_constructor_args[0]['validation_strategies'] = array(new EE_Full_HTML_Validation_Strategy());
-                        break;
-                    case 'EE_Plain_Text_Field':
-                        $input_class = 'EE_Text_Input';
-                        break;
-                    case 'EE_Primary_Key_Int_Field':
-                        $input_class = 'EE_Hidden_Input';
-                        $input_constructor_args[0]['normalization_strategy'] = new EE_Int_Normalization();
-                        break;
-                    case 'EE_Primary_Key_String_Field':
-                        $input_class = 'EE_Hidden_Input';
-                        break;
-                    case 'EE_Serialized_Text_Field':
-                        $input_class = 'EE_Text_Area_Input';
-                        break;
-                    case 'EE_Simple_HTML_Field':
-                        $input_class = 'EE_Text_Area_Input';
-                        $input_constructor_args[0]['validation_strategies'] = array(new EE_Simple_HTML_Validation_Strategy());
-                        break;
-                    case 'EE_Slug_Field':
-                        $input_class = 'EE_Text_Input';
-                        break;
-                    case 'EE_Trashed_Flag_Field':
-                        $input_class = 'EE_Yes_No_Input';
-                        break;
-                    case 'EE_WP_Post_Status_Field':
-                        throw new EE_Error(sprintf(esc_html__(
-                            "Model field '%s' does not yet have a known conversion to form input",
-                            "event_espresso"
-                        ), get_class($model_field)));
-                        break;
-                    case 'EE_WP_Post_Type_Field':
-                        throw new EE_Error(sprintf(esc_html__(
-                            "Model field '%s' does not yet have a known conversion to form input",
-                            "event_espresso"
-                        ), get_class($model_field)));
-                        break;
-                    default:
-                        throw new EE_Error(sprintf(esc_html__(
-                            "Model field of type '%s' does not convert to any known Form Input. Please add a case to EE_Model_Form_section's _convert_model_fields_to_inputs switch statement",
-                            "event_espresso"
-                        ), get_class($model_field)));
-                }
-                $reflection = new ReflectionClass($input_class);
-                $input = $reflection->newInstanceArgs($input_constructor_args);
-                $inputs[ $field_name ] = $input;
-            }
-        }
-        return $inputs;
-    }
-
-
-
-    /**
-     * Mostly the same as populate_defaults , except takes a model object as input, not an array,
-     * and also sets the form's _model_object
-     *
-     * @param EE_Base_Class $model_obj
-     * @return void
-     */
-    public function populate_model_obj($model_obj)
-    {
-        $model_obj = $this->_model->ensure_is_obj($model_obj);
-        $this->_model_object = $model_obj;
-        $defaults = $model_obj->model_field_array();
-        foreach ($this->_model->relation_settings() as $relation_name => $relation_obj) {
-            $subsection = $this->get_subsection($relation_name, false);
-            if ($subsection instanceof EE_Form_Input_Base) {
-                if ($relation_obj instanceof EE_Belongs_To_Relation) {
-                    // then we only expect there to be one
-                    $related_item = $this->_model_object->get_first_related($relation_name);
-                    $defaults[ $relation_name ] = $related_item->ID();
-                } else {
-                    $related_items = $this->_model_object->get_many_related($relation_name);
-                    $ids = array();
-                    foreach ($related_items as $related_item) {
-                        $ids[] = $related_item->ID();
-                    }
-                    $defaults[ $relation_name ] = $ids;
-                }
-            }
-        }
-        $defaults = apply_filters(
-            'FHEE__EE_Model_Form_Section__populate_model_obj',
-            $defaults,
-            $this
-        );
-        $this->populate_defaults($defaults);
-    }
-
-
-
-    /**
-     * Gets all the input values that correspond to model fields. Keys are the input/field names,
-     * values are their normalized values
-     *
-     * @return array
-     */
-    public function inputs_values_corresponding_to_model_fields()
-    {
-        return array_intersect_key($this->input_values(), $this->_model->field_settings());
-    }
-
-
-
-    /**
-     * After we've normalized the data as normal, set the corresponding model object
-     * on the form.
-     *
-     * @param array $req_data should usually be the form post/request data (the default).
-     * @return void
-     */
-    public function _normalize($req_data)
-    {
-        parent::_normalize($req_data);
-        // create or set the model object, if it isn't already
-        if (! $this->_model_object) {
-            // check to see if the form indicates a PK, in which case we want to only retrieve it and update it
-            $pk_name = $this->_model->primary_key_name();
-            $model_obj = $this->_model->get_one_by_ID($this->get_input_value($pk_name));
-            if ($model_obj) {
-                $this->_model_object = $model_obj;
-            } else {
-                $this->_model_object = EE_Registry::instance()->load_class($this->_model->get_this_model_name());
-            }
-        }
-    }
-
-
-
-    /**
-     * After this form has been initialized and is verified to be valid,
-     * either creates a model object from its data and saves it, or updates
-     * the model object its data represents
-     *
-     * @throws EE_Error
-     * @return int, 1 on a successful update, the ID of
-     *                    the new entry on insert; 0 on failure
-     */
-    public function save()
-    {
-        if (! $this->_model_object) {
-            throw new EE_Error(sprintf(esc_html__(
-                "Cannot save the model form's model object (model is '%s') because there is no model object set. You must either set it, or call receive_form_submission where it is set automatically",
-                "event_espresso"
-            ), get_class($this->_model)));
-        }
-        // ok so the model object is set. Just set it with the submitted form data
-        foreach ($this->inputs_values_corresponding_to_model_fields() as $field_name => $field_value) {
-            // only set the non-primary key
-            if ($field_name != $this->_model->primary_key_name()) {
-                $this->_model_object->set($field_name, $field_value);
-            }
-        }
-        $success = $this->_model_object->save();
-        foreach ($this->_model->relation_settings() as $relation_name => $relation_obj) {
-            if (isset($this->_subsections[ $relation_name ])) {
-                $success = $this->_save_related_info($relation_name);
-            }
-        }
-        do_action('AHEE__EE_Model_Form_Section__save__done', $this, $success);
-        return $success;
-    }
-
-
-
-    /**
-     * Automatically finds the related model info from the form, if present, and
-     * save the relations indicated
-     *
-     * @type string $relation_name
-     * @return bool
-     * @throws EE_Error
-     */
-    protected function _save_related_info($relation_name)
-    {
-        $relation_obj = $this->_model->related_settings_for($relation_name);
-        if ($relation_obj instanceof EE_Belongs_To_Relation) {
-            // there is just a foreign key on this model pointing to that one
-            $this->_model_object->_add_relation_to($this->get_input_value($relation_name), $relation_name);
-        } elseif ($relation_obj instanceof EE_Has_Many_Relation) {
-            // then we want to consider all of its currently-related things.
-            // if they're in this list, keep them
-            // if they're not in this list, remove them
-            // and lastly add all the new items
-            throw new EE_Error(sprintf(esc_html__(
-                'Automatic saving of related info across a "has many" relation is not yet supported',
-                "event_espresso"
-            )));
-        } elseif ($relation_obj instanceof EE_HABTM_Relation) {
-            // delete everything NOT in this list
-            $normalized_input_value = $this->get_input_value($relation_name);
-            if ($normalized_input_value && is_array($normalized_input_value)) {
-                $where_query_params = array(
-                    $relation_obj->get_other_model()->primary_key_name() => array('NOT_IN', $normalized_input_value),
-                );
-            } else {
-                $where_query_params = array();
-            }
-            $this->_model_object->_remove_relations($relation_name, $where_query_params);
-            foreach ($normalized_input_value as $id) {
-                $this->_model_object->_add_relation_to($id, $relation_name);
-            }
-        }
-        return true;
-    }
-
-
-
-    /**
-     * Gets the model of this model form
-     *
-     * @return EEM_Base
-     */
-    public function get_model()
-    {
-        return $this->_model;
-    }
-
-
-
-    /**
-     * Gets the model object for this model form, which was either set
-     * upon construction (using the $options_array arg 'model_object'), by using
-     * set_model_object($model_obj), or implicitly
-     * when receive_form_submission($req_data) was called.
-     *
-     * @return EE_Base_Class
-     */
-    public function get_model_object()
-    {
-        return $this->_model_object;
-    }
-
-
-
-    /**
-     * gets teh default name of this form section if none is specified
-     *
-     * @return string
-     */
-    protected function _set_default_name_if_empty()
-    {
-        if (! $this->_name) {
-            $default_name = str_replace("EEM_", "", get_class($this->_model)) . "_Model_Form";
-            $this->_name = $default_name;
-        }
-    }
+	/**
+	 * @var EEM_Base
+	 */
+	protected $_model = null;
+
+	/**
+	 * @var EE_Base_Class
+	 */
+	protected $_model_object = null;
+
+
+
+	/**
+	 * @param array        $options_array   keys: {
+	 * @type EEM_Base      $model
+	 * @type EE_Base_Class $model_object
+	 * @type array         $subsection_args array keys should be subsection names (that either do or will exist), and
+	 *       values are the arrays as you would pass them to that subsection
+	 *                                      }
+	 * @throws EE_Error
+	 */
+	public function __construct($options_array = array())
+	{
+		if (isset($options_array['model']) && $options_array['model'] instanceof EEM_Base) {
+			$this->_model = $options_array['model'];
+		}
+		if (! $this->_model || ! $this->_model instanceof EEM_Base) {
+			throw new EE_Error(sprintf(esc_html__(
+				"Model Form Sections must first specify the _model property to be a subclass of EEM_Base",
+				"event_espresso"
+			)));
+		}
+		if (isset($options_array['subsection_args'])) {
+			$subsection_args = $options_array['subsection_args'];
+		} else {
+			$subsection_args = array();
+		}
+		// gather fields and relations to convert to inputs
+		// but if they're just going to exclude a field anyways, don't bother converting it to an input
+		$exclude = $this->_subsections;
+		if (isset($options_array['exclude'])) {
+			$exclude = array_merge($exclude, array_flip($options_array['exclude']));
+		}
+		$model_fields = array_diff_key($this->_model->field_settings(), $exclude);
+		$model_relations = array_diff_key($this->_model->relation_settings(), $exclude);
+		// convert fields and relations to inputs
+		$this->_subsections = array_merge(
+			$this->_convert_model_fields_to_inputs($model_fields),
+			$this->_convert_model_relations_to_inputs($model_relations, $subsection_args),
+			$this->_subsections
+		);
+		parent::__construct($options_array);
+		if (isset($options_array['model_object']) && $options_array['model_object'] instanceof EE_Base_Class) {
+			$this->populate_model_obj($options_array['model_object']);
+		}
+	}
+
+
+
+	/**
+	 * For now, just makes inputs for only HABTM relations
+	 *
+	 * @param EE_Model_Relation_Base[] $relations
+	 * @param array                    $subsection_args keys should be existing or soon-to-be-existing input names, and
+	 *                                                  their values are {
+	 * @type array {
+	 * @type EE_Base_Class[]           $model_objects   if the subsection is an EE_Select_Multi_Model_Input
+	 *                                                  }
+	 *                                                  }
+	 * @return array
+	 */
+	protected function _convert_model_relations_to_inputs($relations, $subsection_args = array())
+	{
+		$inputs = array();
+		foreach ($relations as $relation_name => $relation_obj) {
+			$input_constructor_args = array(
+				array_merge(
+					array(
+						'required'        => $relation_obj instanceof EE_Belongs_To_Relation,
+						'html_label_text' => $relation_obj instanceof EE_Belongs_To_Relation
+							? $relation_obj->get_other_model()->item_name(1)
+							: $relation_obj->get_other_model()
+										   ->item_name(2),
+					),
+					$subsection_args
+				),
+			);
+			$input = null;
+			switch (get_class($relation_obj)) {
+				case 'EE_HABTM_Relation':
+					if (
+						isset($subsection_args[ $relation_name ])
+						&& isset($subsection_args[ $relation_name ]['model_objects'])
+					) {
+						$model_objects = $subsection_args[ $relation_name ]['model_objects'];
+					} else {
+						$model_objects = $relation_obj->get_other_model()->get_all();
+					}
+					$input = new EE_Select_Multi_Model_Input($model_objects, $input_constructor_args);
+					break;
+				default:
+			}
+			if ($input) {
+				$inputs[ $relation_name ] = $input;
+			}
+		}
+		return $inputs;
+	}
+
+
+
+	/**
+	 * Changes model fields into form section inputs
+	 *
+	 * @param EE_Model_Field_Base[] $model_fields keys are the model's name
+	 * @throws EE_Error
+	 * @return EE_Form_Input_Base[]
+	 */
+	protected function _convert_model_fields_to_inputs($model_fields = array())
+	{
+		$inputs = array();
+		foreach ($model_fields as $field_name => $model_field) {
+			if ($model_field instanceof EE_Model_Field_Base) {
+				$input_constructor_args = array(
+					array(
+						'required'        => ! $model_field->is_nullable()
+											 && $model_field->get_default_value()
+												=== null,
+						'html_label_text' => $model_field->get_nicename(),
+						'default'         => $model_field->get_default_value(),
+					),
+				);
+				switch (get_class($model_field)) {
+					case 'EE_All_Caps_Text_Field':
+					case 'EE_Any_Foreign_Model_Name_Field':
+						$input_class = 'EE_Text_Input';
+						break;
+					case 'EE_Boolean_Field':
+						$input_class = 'EE_Yes_No_Input';
+						break;
+					case 'EE_Datetime_Field':
+						throw new EE_Error(sprintf(esc_html__(
+							"Model field '%s' does not yet have a known conversion to form input",
+							"event_espresso"
+						), get_class($model_field)));
+						break;
+					case 'EE_Email_Field':
+						$input_class = 'EE_Email_Input';
+						break;
+					case 'EE_Enum_Integer_Field':
+						throw new EE_Error(sprintf(esc_html__(
+							"Model field '%s' does not yet have a known conversion to form input",
+							"event_espresso"
+						), get_class($model_field)));
+						break;
+					case 'EE_Enum_Text_Field':
+						throw new EE_Error(sprintf(esc_html__(
+							"Model field '%s' does not yet have a known conversion to form input",
+							"event_espresso"
+						), get_class($model_field)));
+						break;
+					case 'EE_Float_Field':
+						$input_class = 'EE_Float_Input';
+						break;
+					case 'EE_Foreign_Key_Int_Field':
+					case 'EE_Foreign_Key_String_Field':
+					case 'EE_WP_User_Field':
+						$models_pointed_to = $model_field instanceof EE_Field_With_Model_Name
+							? $model_field->get_model_class_names_pointed_to() : array();
+						if (true || is_array($models_pointed_to) && count($models_pointed_to) > 1) {
+							$input_class = 'EE_Text_Input';
+						} else {
+							// so its just one model
+							$model_name = is_array($models_pointed_to) ? reset($models_pointed_to) : $models_pointed_to;
+							$model = EE_Registry::instance()->load_model($model_name);
+							$model_names = $model->get_all_names(array('limit' => 10));
+							if ($model_field->is_nullable()) {
+								array_unshift($model_names, esc_html__("Please Select", 'event_espresso'));
+							}
+							$input_constructor_args[1] = $input_constructor_args[0];
+							$input_constructor_args[0] = $model_names;
+							$input_class = 'EE_Select_Input';
+						}
+						break;
+					case 'EE_Full_HTML_Field':
+						$input_class = 'EE_Text_Area_Input';
+						$input_constructor_args[0]['validation_strategies'] = array(new EE_Full_HTML_Validation_Strategy());
+						break;
+					case 'EE_Infinite_Integer':
+						throw new EE_Error(sprintf(esc_html__(
+							"Model field '%s' does not yet have a known conversion to form input",
+							"event_espresso"
+						), get_class($model_field)));
+						break;
+					case 'EE_Integer_Field':
+						$input_class = 'EE_Text_Input';
+						break;
+					case 'EE_Maybe_Serialized_Text_Field':
+						$input_class = 'EE_Text_Area_Input';
+						break;
+					case 'EE_Money_Field':
+						throw new EE_Error(sprintf(esc_html__(
+							"Model field '%s' does not yet have a known conversion to form input",
+							"event_espresso"
+						), get_class($model_field)));
+						break;
+					case 'EE_Post_Content_Field':
+						$input_class = 'EE_Text_Area_Input';
+						$input_constructor_args[0]['validation_strategies'] = array(new EE_Full_HTML_Validation_Strategy());
+						break;
+					case 'EE_Plain_Text_Field':
+						$input_class = 'EE_Text_Input';
+						break;
+					case 'EE_Primary_Key_Int_Field':
+						$input_class = 'EE_Hidden_Input';
+						$input_constructor_args[0]['normalization_strategy'] = new EE_Int_Normalization();
+						break;
+					case 'EE_Primary_Key_String_Field':
+						$input_class = 'EE_Hidden_Input';
+						break;
+					case 'EE_Serialized_Text_Field':
+						$input_class = 'EE_Text_Area_Input';
+						break;
+					case 'EE_Simple_HTML_Field':
+						$input_class = 'EE_Text_Area_Input';
+						$input_constructor_args[0]['validation_strategies'] = array(new EE_Simple_HTML_Validation_Strategy());
+						break;
+					case 'EE_Slug_Field':
+						$input_class = 'EE_Text_Input';
+						break;
+					case 'EE_Trashed_Flag_Field':
+						$input_class = 'EE_Yes_No_Input';
+						break;
+					case 'EE_WP_Post_Status_Field':
+						throw new EE_Error(sprintf(esc_html__(
+							"Model field '%s' does not yet have a known conversion to form input",
+							"event_espresso"
+						), get_class($model_field)));
+						break;
+					case 'EE_WP_Post_Type_Field':
+						throw new EE_Error(sprintf(esc_html__(
+							"Model field '%s' does not yet have a known conversion to form input",
+							"event_espresso"
+						), get_class($model_field)));
+						break;
+					default:
+						throw new EE_Error(sprintf(esc_html__(
+							"Model field of type '%s' does not convert to any known Form Input. Please add a case to EE_Model_Form_section's _convert_model_fields_to_inputs switch statement",
+							"event_espresso"
+						), get_class($model_field)));
+				}
+				$reflection = new ReflectionClass($input_class);
+				$input = $reflection->newInstanceArgs($input_constructor_args);
+				$inputs[ $field_name ] = $input;
+			}
+		}
+		return $inputs;
+	}
+
+
+
+	/**
+	 * Mostly the same as populate_defaults , except takes a model object as input, not an array,
+	 * and also sets the form's _model_object
+	 *
+	 * @param EE_Base_Class $model_obj
+	 * @return void
+	 */
+	public function populate_model_obj($model_obj)
+	{
+		$model_obj = $this->_model->ensure_is_obj($model_obj);
+		$this->_model_object = $model_obj;
+		$defaults = $model_obj->model_field_array();
+		foreach ($this->_model->relation_settings() as $relation_name => $relation_obj) {
+			$subsection = $this->get_subsection($relation_name, false);
+			if ($subsection instanceof EE_Form_Input_Base) {
+				if ($relation_obj instanceof EE_Belongs_To_Relation) {
+					// then we only expect there to be one
+					$related_item = $this->_model_object->get_first_related($relation_name);
+					$defaults[ $relation_name ] = $related_item->ID();
+				} else {
+					$related_items = $this->_model_object->get_many_related($relation_name);
+					$ids = array();
+					foreach ($related_items as $related_item) {
+						$ids[] = $related_item->ID();
+					}
+					$defaults[ $relation_name ] = $ids;
+				}
+			}
+		}
+		$defaults = apply_filters(
+			'FHEE__EE_Model_Form_Section__populate_model_obj',
+			$defaults,
+			$this
+		);
+		$this->populate_defaults($defaults);
+	}
+
+
+
+	/**
+	 * Gets all the input values that correspond to model fields. Keys are the input/field names,
+	 * values are their normalized values
+	 *
+	 * @return array
+	 */
+	public function inputs_values_corresponding_to_model_fields()
+	{
+		return array_intersect_key($this->input_values(), $this->_model->field_settings());
+	}
+
+
+
+	/**
+	 * After we've normalized the data as normal, set the corresponding model object
+	 * on the form.
+	 *
+	 * @param array $req_data should usually be the form post/request data (the default).
+	 * @return void
+	 */
+	public function _normalize($req_data)
+	{
+		parent::_normalize($req_data);
+		// create or set the model object, if it isn't already
+		if (! $this->_model_object) {
+			// check to see if the form indicates a PK, in which case we want to only retrieve it and update it
+			$pk_name = $this->_model->primary_key_name();
+			$model_obj = $this->_model->get_one_by_ID($this->get_input_value($pk_name));
+			if ($model_obj) {
+				$this->_model_object = $model_obj;
+			} else {
+				$this->_model_object = EE_Registry::instance()->load_class($this->_model->get_this_model_name());
+			}
+		}
+	}
+
+
+
+	/**
+	 * After this form has been initialized and is verified to be valid,
+	 * either creates a model object from its data and saves it, or updates
+	 * the model object its data represents
+	 *
+	 * @throws EE_Error
+	 * @return int, 1 on a successful update, the ID of
+	 *                    the new entry on insert; 0 on failure
+	 */
+	public function save()
+	{
+		if (! $this->_model_object) {
+			throw new EE_Error(sprintf(esc_html__(
+				"Cannot save the model form's model object (model is '%s') because there is no model object set. You must either set it, or call receive_form_submission where it is set automatically",
+				"event_espresso"
+			), get_class($this->_model)));
+		}
+		// ok so the model object is set. Just set it with the submitted form data
+		foreach ($this->inputs_values_corresponding_to_model_fields() as $field_name => $field_value) {
+			// only set the non-primary key
+			if ($field_name != $this->_model->primary_key_name()) {
+				$this->_model_object->set($field_name, $field_value);
+			}
+		}
+		$success = $this->_model_object->save();
+		foreach ($this->_model->relation_settings() as $relation_name => $relation_obj) {
+			if (isset($this->_subsections[ $relation_name ])) {
+				$success = $this->_save_related_info($relation_name);
+			}
+		}
+		do_action('AHEE__EE_Model_Form_Section__save__done', $this, $success);
+		return $success;
+	}
+
+
+
+	/**
+	 * Automatically finds the related model info from the form, if present, and
+	 * save the relations indicated
+	 *
+	 * @type string $relation_name
+	 * @return bool
+	 * @throws EE_Error
+	 */
+	protected function _save_related_info($relation_name)
+	{
+		$relation_obj = $this->_model->related_settings_for($relation_name);
+		if ($relation_obj instanceof EE_Belongs_To_Relation) {
+			// there is just a foreign key on this model pointing to that one
+			$this->_model_object->_add_relation_to($this->get_input_value($relation_name), $relation_name);
+		} elseif ($relation_obj instanceof EE_Has_Many_Relation) {
+			// then we want to consider all of its currently-related things.
+			// if they're in this list, keep them
+			// if they're not in this list, remove them
+			// and lastly add all the new items
+			throw new EE_Error(sprintf(esc_html__(
+				'Automatic saving of related info across a "has many" relation is not yet supported',
+				"event_espresso"
+			)));
+		} elseif ($relation_obj instanceof EE_HABTM_Relation) {
+			// delete everything NOT in this list
+			$normalized_input_value = $this->get_input_value($relation_name);
+			if ($normalized_input_value && is_array($normalized_input_value)) {
+				$where_query_params = array(
+					$relation_obj->get_other_model()->primary_key_name() => array('NOT_IN', $normalized_input_value),
+				);
+			} else {
+				$where_query_params = array();
+			}
+			$this->_model_object->_remove_relations($relation_name, $where_query_params);
+			foreach ($normalized_input_value as $id) {
+				$this->_model_object->_add_relation_to($id, $relation_name);
+			}
+		}
+		return true;
+	}
+
+
+
+	/**
+	 * Gets the model of this model form
+	 *
+	 * @return EEM_Base
+	 */
+	public function get_model()
+	{
+		return $this->_model;
+	}
+
+
+
+	/**
+	 * Gets the model object for this model form, which was either set
+	 * upon construction (using the $options_array arg 'model_object'), by using
+	 * set_model_object($model_obj), or implicitly
+	 * when receive_form_submission($req_data) was called.
+	 *
+	 * @return EE_Base_Class
+	 */
+	public function get_model_object()
+	{
+		return $this->_model_object;
+	}
+
+
+
+	/**
+	 * gets teh default name of this form section if none is specified
+	 *
+	 * @return string
+	 */
+	protected function _set_default_name_if_empty()
+	{
+		if (! $this->_name) {
+			$default_name = str_replace("EEM_", "", get_class($this->_model)) . "_Model_Form";
+			$this->_name = $default_name;
+		}
+	}
 }

core/libraries/form_sections/EE_Sample_Form.form.php

Indentation +56 added lines, -56 removed lines

@@ -2,62 +2,62 @@
 
 class EE_Sample_Form extends EE_Form_Section_Proper
 {
-    public function __construct()
-    {
-        $this->_subsections = array(
-            'h1' => new EE_Form_Section_HTML('hello wordl'),
-            'name' => new EE_Text_Input(array('required' => true,'default' => 'your name here')),
-            'email' => new EE_Email_Input(array('required' => false)),
-            'shirt_size' => new EE_Select_Input(array('' => 'Please select...', 's' =>  esc_html__("Small", "event_espresso"),'m' =>  esc_html__("Medium", "event_espresso"),'l' =>  esc_html__("Large", "event_espresso")), array('required' => true,'default' => 's')),
-            'month_normal' => new EE_Month_Input(),
-            'month_leading_zero' => new EE_Month_Input(true),
-            'year_2' => new EE_Year_Input(false, 1, 1),
-            'year_4' => new EE_Year_Input(true, 0, 10, array('default' => '2017')),
-            'yes_no' => new EE_Yes_No_Input(array('html_label_text' =>  esc_html__("Yes or No", "event_espresso"))),
-            'credit_card' => new EE_Credit_Card_Input(),
-            'image_1' => new EE_Admin_File_Uploader_Input(),
-            'image_2' => new EE_Admin_File_Uploader_Input(),
-            'skillz' => new EE_Checkbox_Multi_Input(array('php' => 'PHP','mysql' => 'MYSQL'), array('default' => array('php'))),
-            'float' => new EE_Float_Input(),
-            'essay' => new EE_Text_Area_Input(),
-            'amenities' => new EE_Select_Multiple_Input(
-                array(
-                    'hottub' => 'Hot Tub',
-                    'balcony' => "Balcony",
-                    'skylight' => 'SkyLight',
-                    'no_axe' => 'No Axe Murderers'
-                ),
-                array(
-                    'default' => array(
-                        'hottub',
-                        'no_axe' ),
-                )
-            ),
-            'payment_methods' => new EE_Select_Multi_Model_Input(EEM_Payment_Method::instance()->get_all()),
-            );
-        $this->_layout_strategy = new EE_Div_Per_Section_Layout();
-        parent::__construct();
-    }
+	public function __construct()
+	{
+		$this->_subsections = array(
+			'h1' => new EE_Form_Section_HTML('hello wordl'),
+			'name' => new EE_Text_Input(array('required' => true,'default' => 'your name here')),
+			'email' => new EE_Email_Input(array('required' => false)),
+			'shirt_size' => new EE_Select_Input(array('' => 'Please select...', 's' =>  esc_html__("Small", "event_espresso"),'m' =>  esc_html__("Medium", "event_espresso"),'l' =>  esc_html__("Large", "event_espresso")), array('required' => true,'default' => 's')),
+			'month_normal' => new EE_Month_Input(),
+			'month_leading_zero' => new EE_Month_Input(true),
+			'year_2' => new EE_Year_Input(false, 1, 1),
+			'year_4' => new EE_Year_Input(true, 0, 10, array('default' => '2017')),
+			'yes_no' => new EE_Yes_No_Input(array('html_label_text' =>  esc_html__("Yes or No", "event_espresso"))),
+			'credit_card' => new EE_Credit_Card_Input(),
+			'image_1' => new EE_Admin_File_Uploader_Input(),
+			'image_2' => new EE_Admin_File_Uploader_Input(),
+			'skillz' => new EE_Checkbox_Multi_Input(array('php' => 'PHP','mysql' => 'MYSQL'), array('default' => array('php'))),
+			'float' => new EE_Float_Input(),
+			'essay' => new EE_Text_Area_Input(),
+			'amenities' => new EE_Select_Multiple_Input(
+				array(
+					'hottub' => 'Hot Tub',
+					'balcony' => "Balcony",
+					'skylight' => 'SkyLight',
+					'no_axe' => 'No Axe Murderers'
+				),
+				array(
+					'default' => array(
+						'hottub',
+						'no_axe' ),
+				)
+			),
+			'payment_methods' => new EE_Select_Multi_Model_Input(EEM_Payment_Method::instance()->get_all()),
+			);
+		$this->_layout_strategy = new EE_Div_Per_Section_Layout();
+		parent::__construct();
+	}
 
-    /**
-     * Extra validation for the 'name' input.
-     * @param EE_Text_Input $form_input
-     */
-    public function _validate_name($form_input)
-    {
-        if ($form_input->raw_value() != 'Mike') {
-            $form_input->add_validation_error(esc_html__("You are not mike. You must be brent or darren. Thats ok, I guess", 'event_espresso'), 'not-mike');
-        }
-    }
+	/**
+	 * Extra validation for the 'name' input.
+	 * @param EE_Text_Input $form_input
+	 */
+	public function _validate_name($form_input)
+	{
+		if ($form_input->raw_value() != 'Mike') {
+			$form_input->add_validation_error(esc_html__("You are not mike. You must be brent or darren. Thats ok, I guess", 'event_espresso'), 'not-mike');
+		}
+	}
 
-    public function _validate()
-    {
-        parent::_validate();
-        if (
-            $this->_subsections['shirt_size']->normalized_value() == 's'
-                && $this->_subsections['year_4']->normalized_value() < 2010
-        ) {
-            $this->add_validation_error(esc_html__("If you want a small shirt, you should be born after 2010. Otherwise theyre just too big", 'event_espresso'), 'too-old');
-        }
-    }
+	public function _validate()
+	{
+		parent::_validate();
+		if (
+			$this->_subsections['shirt_size']->normalized_value() == 's'
+				&& $this->_subsections['year_4']->normalized_value() < 2010
+		) {
+			$this->add_validation_error(esc_html__("If you want a small shirt, you should be born after 2010. Otherwise theyre just too big", 'event_espresso'), 'too-old');
+		}
+	}
 }

Spacing +3 added lines, -3 removed lines

@@ -6,9 +6,9 @@ 
     {
         $this->_subsections = array(
             'h1' => new EE_Form_Section_HTML('hello wordl'),
-            'name' => new EE_Text_Input(array('required' => true,'default' => 'your name here')),
+            'name' => new EE_Text_Input(array('required' => true, 'default' => 'your name here')),
             'email' => new EE_Email_Input(array('required' => false)),
-            'shirt_size' => new EE_Select_Input(array('' => 'Please select...', 's' =>  esc_html__("Small", "event_espresso"),'m' =>  esc_html__("Medium", "event_espresso"),'l' =>  esc_html__("Large", "event_espresso")), array('required' => true,'default' => 's')),
+            'shirt_size' => new EE_Select_Input(array('' => 'Please select...', 's' =>  esc_html__("Small", "event_espresso"), 'm' =>  esc_html__("Medium", "event_espresso"), 'l' =>  esc_html__("Large", "event_espresso")), array('required' => true, 'default' => 's')),
             'month_normal' => new EE_Month_Input(),
             'month_leading_zero' => new EE_Month_Input(true),
             'year_2' => new EE_Year_Input(false, 1, 1),
@@ -17,7 +17,7 @@ 
             'credit_card' => new EE_Credit_Card_Input(),
             'image_1' => new EE_Admin_File_Uploader_Input(),
             'image_2' => new EE_Admin_File_Uploader_Input(),
-            'skillz' => new EE_Checkbox_Multi_Input(array('php' => 'PHP','mysql' => 'MYSQL'), array('default' => array('php'))),
+            'skillz' => new EE_Checkbox_Multi_Input(array('php' => 'PHP', 'mysql' => 'MYSQL'), array('default' => array('php'))),
             'float' => new EE_Float_Input(),
             'essay' => new EE_Text_Area_Input(),
             'amenities' => new EE_Select_Multiple_Input(

core/libraries/form_sections/strategies/validation/EE_Int_Validation_Strategy.strategy.php

Spacing +1 added lines, -1 removed lines

@@ -15,7 +15,7 @@
      */
     public function __construct($validation_error_message = null)
     {
-        if (! $validation_error_message) {
+        if ( ! $validation_error_message) {
             $validation_error_message = esc_html__("Only digits are allowed.", "event_espresso");
         }
         parent::__construct($validation_error_message);

Indentation +31 added lines, -31 removed lines

@@ -9,41 +9,41 @@
  */
 class EE_Int_Validation_Strategy extends EE_Validation_Strategy_Base
 {
-    /**
-     * @param null $validation_error_message
-     */
-    public function __construct($validation_error_message = null)
-    {
-        if (! $validation_error_message) {
-            $validation_error_message = esc_html__("Only digits are allowed.", "event_espresso");
-        }
-        parent::__construct($validation_error_message);
-    }
+	/**
+	 * @param null $validation_error_message
+	 */
+	public function __construct($validation_error_message = null)
+	{
+		if (! $validation_error_message) {
+			$validation_error_message = esc_html__("Only digits are allowed.", "event_espresso");
+		}
+		parent::__construct($validation_error_message);
+	}
 
 
 
-    /**
-     * @param $normalized_value
-     */
-    public function validate($normalized_value)
-    {
-        // this should have already been detected by the normalization strategy
-    }
+	/**
+	 * @param $normalized_value
+	 */
+	public function validate($normalized_value)
+	{
+		// this should have already been detected by the normalization strategy
+	}
 
 
 
-    /**
-     * @return array
-     */
-    public function get_jquery_validation_rule_array()
-    {
-        return array(
-            'number' => true,
-            'step' => 1,
-            'messages' => array(
-                'number' => $this->get_validation_error_message(),
-                'step' => $this->get_validation_error_message()
-            )
-        );
-    }
+	/**
+	 * @return array
+	 */
+	public function get_jquery_validation_rule_array()
+	{
+		return array(
+			'number' => true,
+			'step' => 1,
+			'messages' => array(
+				'number' => $this->get_validation_error_message(),
+				'step' => $this->get_validation_error_message()
+			)
+		);
+	}
 }

core/libraries/form_sections/strategies/validation/EE_Full_HTML_Validation_Strategy.strategy.php

Spacing +1 added lines, -1 removed lines

@@ -19,7 +19,7 @@
      */
     public function __construct($validation_error_message = null)
     {
-        if (! $validation_error_message) {
+        if ( ! $validation_error_message) {
             $validation_error_message = sprintf(
                 esc_html__('Only the following HTML tags are allowed:%1$s%2$s', "event_espresso"),
                 '<br />',

Indentation +52 added lines, -52 removed lines

@@ -13,62 +13,62 @@
  */
 class EE_Full_HTML_Validation_Strategy extends EE_Validation_Strategy_Base
 {
-    /**
-     * @param null $validation_error_message
-     */
-    public function __construct($validation_error_message = null)
-    {
-        if (! $validation_error_message) {
-            $validation_error_message = sprintf(
-                esc_html__('Only the following HTML tags are allowed:%1$s%2$s', "event_espresso"),
-                '<br />',
-                $this->get_list_of_allowed_tags()
-            );
-        }
-        parent::__construct($validation_error_message);
-    }
+	/**
+	 * @param null $validation_error_message
+	 */
+	public function __construct($validation_error_message = null)
+	{
+		if (! $validation_error_message) {
+			$validation_error_message = sprintf(
+				esc_html__('Only the following HTML tags are allowed:%1$s%2$s', "event_espresso"),
+				'<br />',
+				$this->get_list_of_allowed_tags()
+			);
+		}
+		parent::__construct($validation_error_message);
+	}
 
 
-    /**
-     * get_list_of_allowed_tags
-     *
-     * generates and returns a string that lists the top-level HTML tags that are allowable for this input
-     *
-     * @return string
-     */
-    public function get_list_of_allowed_tags(): string
-    {
-        $tags_we_allow = $this->getAllowedTags();
-        ksort($tags_we_allow);
-        return implode(', ', array_keys($tags_we_allow));
-    }
+	/**
+	 * get_list_of_allowed_tags
+	 *
+	 * generates and returns a string that lists the top-level HTML tags that are allowable for this input
+	 *
+	 * @return string
+	 */
+	public function get_list_of_allowed_tags(): string
+	{
+		$tags_we_allow = $this->getAllowedTags();
+		ksort($tags_we_allow);
+		return implode(', ', array_keys($tags_we_allow));
+	}
 
 
-    /**
-     * Returns an array whose keys are allowed tags and values are an array of allowed attributes
-     *
-     * @return array
-     */
-    protected function getAllowedTags(): array
-    {
-        global $allowedposttags;
-        return array_merge_recursive(
-            $allowedposttags,
-            EEH_HTML::get_simple_tags()
-        );
-    }
+	/**
+	 * Returns an array whose keys are allowed tags and values are an array of allowed attributes
+	 *
+	 * @return array
+	 */
+	protected function getAllowedTags(): array
+	{
+		global $allowedposttags;
+		return array_merge_recursive(
+			$allowedposttags,
+			EEH_HTML::get_simple_tags()
+		);
+	}
 
 
-    /**
-     * @param mixed $normalized_value
-     * @throws EE_Validation_Error
-     */
-    public function validate($normalized_value)
-    {
-        parent::validate($normalized_value);
-        $normalized_value_sans_tags = wp_kses((string) $normalized_value, $this->getAllowedTags());
-        if (strlen((string) $normalized_value) > strlen($normalized_value_sans_tags)) {
-            throw new EE_Validation_Error($this->get_validation_error_message(), 'complex_html_tags');
-        }
-    }
+	/**
+	 * @param mixed $normalized_value
+	 * @throws EE_Validation_Error
+	 */
+	public function validate($normalized_value)
+	{
+		parent::validate($normalized_value);
+		$normalized_value_sans_tags = wp_kses((string) $normalized_value, $this->getAllowedTags());
+		if (strlen((string) $normalized_value) > strlen($normalized_value_sans_tags)) {
+			throw new EE_Validation_Error($this->get_validation_error_message(), 'complex_html_tags');
+		}
+	}
 }

core/libraries/form_sections/strategies/validation/EE_Credit_Card_Validation_Strategy.strategy.php

Spacing +1 added lines, -1 removed lines

@@ -19,7 +19,7 @@
      */
     public function __construct($validation_error_message = null)
     {
-        if (! $validation_error_message) {
+        if ( ! $validation_error_message) {
             $validation_error_message = esc_html__("Please enter a valid credit card number", "event_espresso");
         }
         parent::__construct(

Indentation +15 added lines, -15 removed lines

@@ -13,19 +13,19 @@
  */
 class EE_Credit_Card_Validation_Strategy extends EE_Text_Validation_Strategy
 {
-    /**
-     * @param null $validation_error_message
-     */
-    public function __construct($validation_error_message = null)
-    {
-        if (! $validation_error_message) {
-            $validation_error_message = esc_html__("Please enter a valid credit card number", "event_espresso");
-        }
-        parent::__construct(
-            $validation_error_message,
-            // @codingStandardsIgnoreStart
-            '~^(?:4[0-9]{12}(?:[0-9]{3})?|5[1-5][0-9]{14}|2[2-7][0-9]{14}|6011[0-9]{12}|3(?:0[0-5]|[68][0-9])[0-9]{11}|3[47][0-9]{13})$~'
-            // @codingStandardsIgnoreEnd
-        );
-    }
+	/**
+	 * @param null $validation_error_message
+	 */
+	public function __construct($validation_error_message = null)
+	{
+		if (! $validation_error_message) {
+			$validation_error_message = esc_html__("Please enter a valid credit card number", "event_espresso");
+		}
+		parent::__construct(
+			$validation_error_message,
+			// @codingStandardsIgnoreStart
+			'~^(?:4[0-9]{12}(?:[0-9]{3})?|5[1-5][0-9]{14}|2[2-7][0-9]{14}|6011[0-9]{12}|3(?:0[0-5]|[68][0-9])[0-9]{11}|3[47][0-9]{13})$~'
+			// @codingStandardsIgnoreEnd
+		);
+	}
 }

core/libraries/form_sections/strategies/validation/EE_Enum_Validation_Strategy.strategy.php

Spacing +2 added lines, -2 removed lines

@@ -22,7 +22,7 @@ 
     public function validate($normalized_value)
     {
         parent::validate($normalized_value);
-        if (! $this->_input instanceof EE_Form_Input_With_Options_Base) {
+        if ( ! $this->_input instanceof EE_Form_Input_With_Options_Base) {
             throw new EE_Error(sprintf(esc_html__("Cannot use Enum Validation Strategy with an input that doesn't have options", "event_espresso")));
         }
         $enum_options = $this->_input->flat_options();
@@ -49,7 +49,7 @@ 
     public function get_validation_error_message()
     {
         $parent_validation_error_message = parent::get_validation_error_message();
-        if (! $parent_validation_error_message) {
+        if ( ! $parent_validation_error_message) {
             $enum_options = $this->_input instanceof EE_Form_Input_With_Options_Base ? $this->_input->flat_options() : '';
             return sprintf(
                 esc_html__("This is not allowed option. Allowed options are %s.", "event_espresso"),

Indentation +46 added lines, -46 removed lines

@@ -11,51 +11,51 @@
  */
 class EE_Enum_Validation_Strategy extends EE_Validation_Strategy_Base
 {
-    /**
-     * Check that the value is in the allowed list
-     * @param $normalized_value
-     * @throws EE_Error
-     * @throws EE_Validation_Error
-     * @return boolean
-     */
-    public function validate($normalized_value)
-    {
-        parent::validate($normalized_value);
-        if (! $this->_input instanceof EE_Form_Input_With_Options_Base) {
-            throw new EE_Error(sprintf(esc_html__("Cannot use Enum Validation Strategy with an input that doesn't have options", "event_espresso")));
-        }
-        $enum_options = $this->_input->flat_options();
-        if ($normalized_value === true) {
-            $normalized_value = 1;
-        } elseif ($normalized_value === false) {
-            $normalized_value = 0;
-        }
-        if ($normalized_value !== null && ! array_key_exists($normalized_value, $enum_options)) {
-            throw new EE_Validation_Error(
-                $this->get_validation_error_message(),
-                'invalid_enum_value'
-            );
-        } else {
-            return true;
-        }
-    }
+	/**
+	 * Check that the value is in the allowed list
+	 * @param $normalized_value
+	 * @throws EE_Error
+	 * @throws EE_Validation_Error
+	 * @return boolean
+	 */
+	public function validate($normalized_value)
+	{
+		parent::validate($normalized_value);
+		if (! $this->_input instanceof EE_Form_Input_With_Options_Base) {
+			throw new EE_Error(sprintf(esc_html__("Cannot use Enum Validation Strategy with an input that doesn't have options", "event_espresso")));
+		}
+		$enum_options = $this->_input->flat_options();
+		if ($normalized_value === true) {
+			$normalized_value = 1;
+		} elseif ($normalized_value === false) {
+			$normalized_value = 0;
+		}
+		if ($normalized_value !== null && ! array_key_exists($normalized_value, $enum_options)) {
+			throw new EE_Validation_Error(
+				$this->get_validation_error_message(),
+				'invalid_enum_value'
+			);
+		} else {
+			return true;
+		}
+	}
 
-    /**
-     * If we are using the default validation error message, make it dynamic based
-     * on the allowed options.
-     * @return string
-     */
-    public function get_validation_error_message()
-    {
-        $parent_validation_error_message = parent::get_validation_error_message();
-        if (! $parent_validation_error_message) {
-            $enum_options = $this->_input instanceof EE_Form_Input_With_Options_Base ? $this->_input->flat_options() : '';
-            return sprintf(
-                esc_html__("This is not allowed option. Allowed options are %s.", "event_espresso"),
-                implode(', ', $enum_options)
-            );
-        } else {
-            return $parent_validation_error_message;
-        }
-    }
+	/**
+	 * If we are using the default validation error message, make it dynamic based
+	 * on the allowed options.
+	 * @return string
+	 */
+	public function get_validation_error_message()
+	{
+		$parent_validation_error_message = parent::get_validation_error_message();
+		if (! $parent_validation_error_message) {
+			$enum_options = $this->_input instanceof EE_Form_Input_With_Options_Base ? $this->_input->flat_options() : '';
+			return sprintf(
+				esc_html__("This is not allowed option. Allowed options are %s.", "event_espresso"),
+				implode(', ', $enum_options)
+			);
+		} else {
+			return $parent_validation_error_message;
+		}
+	}
 }

core/libraries/form_sections/strategies/validation/EE_Required_Validation_Strategy.strategy.php

Spacing +1 added lines, -1 removed lines

@@ -19,7 +19,7 @@
      */
     public function __construct($validation_error_message = null)
     {
-        if (! $validation_error_message) {
+        if ( ! $validation_error_message) {
             $validation_error_message = esc_html__("This field is required.", "event_espresso");
         }
         parent::__construct($validation_error_message);

Indentation +41 added lines, -41 removed lines

@@ -11,51 +11,51 @@
  */
 class EE_Required_Validation_Strategy extends EE_Validation_Strategy_Base
 {
-    /**
-     * @param string $validation_error_message
-     */
-    public function __construct($validation_error_message = null)
-    {
-        if (! $validation_error_message) {
-            $validation_error_message = esc_html__("This field is required.", "event_espresso");
-        }
-        parent::__construct($validation_error_message);
-    }
+	/**
+	 * @param string $validation_error_message
+	 */
+	public function __construct($validation_error_message = null)
+	{
+		if (! $validation_error_message) {
+			$validation_error_message = esc_html__("This field is required.", "event_espresso");
+		}
+		parent::__construct($validation_error_message);
+	}
 
 
 
-    /**
-     * just checks the field isn't blank, provided the requirement conditions
-     * indicate this input is still required
-     *
-     * @param $normalized_value
-     * @return bool
-     * @throws EE_Validation_Error
-     */
-    public function validate($normalized_value)
-    {
-        if (
-            $normalized_value === ''
-            || $normalized_value === null
-            || $normalized_value === array()
-        ) {
-            throw new EE_Validation_Error($this->get_validation_error_message(), 'required');
-        }
-        return true;
-    }
+	/**
+	 * just checks the field isn't blank, provided the requirement conditions
+	 * indicate this input is still required
+	 *
+	 * @param $normalized_value
+	 * @return bool
+	 * @throws EE_Validation_Error
+	 */
+	public function validate($normalized_value)
+	{
+		if (
+			$normalized_value === ''
+			|| $normalized_value === null
+			|| $normalized_value === array()
+		) {
+			throw new EE_Validation_Error($this->get_validation_error_message(), 'required');
+		}
+		return true;
+	}
 
 
 
-    /**
-     * @return array
-     */
-    public function get_jquery_validation_rule_array()
-    {
-        return array(
-            'required' => true,
-            'messages' => array(
-                'required' => $this->get_validation_error_message()
-            )
-        );
-    }
+	/**
+	 * @return array
+	 */
+	public function get_jquery_validation_rule_array()
+	{
+		return array(
+			'required' => true,
+			'messages' => array(
+				'required' => $this->get_validation_error_message()
+			)
+		);
+	}
 }

core/libraries/form_sections/strategies/validation/EE_Model_Matching_Query_Validation_Strategy.strategy.php

Spacing +3 added lines, -3 removed lines

@@ -33,7 +33,7 @@ 
      */
     public function __construct($validation_error_message = null, $model_name = '', $query_params = array(), $input_field_name = '')
     {
-        if (! EE_Registry::instance()->is_model_name($model_name)) {
+        if ( ! EE_Registry::instance()->is_model_name($model_name)) {
             throw new EE_Error(sprintf(esc_html__('You must provide a valid model object ', 'event_espresso'), $model_name));
         }
         $this->_model = EE_Registry::instance()->load_model($model_name);
@@ -59,8 +59,8 @@ 
             return true;
         }
         $combined_query_params = $this->get_query_params();
-        $combined_query_params[0][ $this->treat_input_as_field() ] = $normalized_value;
-        if (! $this->get_model()->exists($combined_query_params)) {
+        $combined_query_params[0][$this->treat_input_as_field()] = $normalized_value;
+        if ( ! $this->get_model()->exists($combined_query_params)) {
             throw new EE_Validation_Error($this->get_validation_error_message(), 'no_matching_model_object');
         }
     }

Indentation +71 added lines, -71 removed lines

@@ -13,86 +13,86 @@
  */
 class EE_Model_Matching_Query_Validation_Strategy extends EE_Validation_Strategy_Base
 {
-    /**
-     *
-     * @var EEM_Base
-     */
-    protected $_model;
-    protected $_query_params;
-    protected $_input_field_name;
+	/**
+	 *
+	 * @var EEM_Base
+	 */
+	protected $_model;
+	protected $_query_params;
+	protected $_input_field_name;
 
 
 
-    /**
-     * @param string $validation_error_message
-     * @param string $model_name  name of an EEM_Base model
-     * @param array  $query_params     @see https://github.com/eventespresso/event-espresso-core/tree/master/docs/G--Model-System/model-query-params.md
-     * @param string $input_field_name the input will be treated as this field's value
-     * @throws \EE_Error
-     */
-    public function __construct($validation_error_message = null, $model_name = '', $query_params = array(), $input_field_name = '')
-    {
-        if (! EE_Registry::instance()->is_model_name($model_name)) {
-            throw new EE_Error(sprintf(esc_html__('You must provide a valid model object ', 'event_espresso'), $model_name));
-        }
-        $this->_model = EE_Registry::instance()->load_model($model_name);
-        $this->_query_params = $query_params;
-        if (empty($input_field_name)) {
-            $input_field_name = $this->_model->primary_key_name();
-        }
-        $this->_input_field_name = $input_field_name;
-        parent::__construct($validation_error_message);
-    }
+	/**
+	 * @param string $validation_error_message
+	 * @param string $model_name  name of an EEM_Base model
+	 * @param array  $query_params     @see https://github.com/eventespresso/event-espresso-core/tree/master/docs/G--Model-System/model-query-params.md
+	 * @param string $input_field_name the input will be treated as this field's value
+	 * @throws \EE_Error
+	 */
+	public function __construct($validation_error_message = null, $model_name = '', $query_params = array(), $input_field_name = '')
+	{
+		if (! EE_Registry::instance()->is_model_name($model_name)) {
+			throw new EE_Error(sprintf(esc_html__('You must provide a valid model object ', 'event_espresso'), $model_name));
+		}
+		$this->_model = EE_Registry::instance()->load_model($model_name);
+		$this->_query_params = $query_params;
+		if (empty($input_field_name)) {
+			$input_field_name = $this->_model->primary_key_name();
+		}
+		$this->_input_field_name = $input_field_name;
+		parent::__construct($validation_error_message);
+	}
 
 
 
-    /**
-     * @param $normalized_value
-     * @return bool|void
-     * @throws \EE_Error
-     * @throws \EE_Validation_Error
-     */
-    public function validate($normalized_value)
-    {
-        if (empty($normalized_value)) {
-            return true;
-        }
-        $combined_query_params = $this->get_query_params();
-        $combined_query_params[0][ $this->treat_input_as_field() ] = $normalized_value;
-        if (! $this->get_model()->exists($combined_query_params)) {
-            throw new EE_Validation_Error($this->get_validation_error_message(), 'no_matching_model_object');
-        }
-    }
+	/**
+	 * @param $normalized_value
+	 * @return bool|void
+	 * @throws \EE_Error
+	 * @throws \EE_Validation_Error
+	 */
+	public function validate($normalized_value)
+	{
+		if (empty($normalized_value)) {
+			return true;
+		}
+		$combined_query_params = $this->get_query_params();
+		$combined_query_params[0][ $this->treat_input_as_field() ] = $normalized_value;
+		if (! $this->get_model()->exists($combined_query_params)) {
+			throw new EE_Validation_Error($this->get_validation_error_message(), 'no_matching_model_object');
+		}
+	}
 
-    /**
-     * Gets the model used for querying
-     * @return EEM_Base
-     */
-    public function get_model()
-    {
-        return $this->_model;
-    }
+	/**
+	 * Gets the model used for querying
+	 * @return EEM_Base
+	 */
+	public function get_model()
+	{
+		return $this->_model;
+	}
 
-    /**
-     * Returns query params used for model query
-     * @return array
-     */
-    public function get_query_params()
-    {
-        return (array) $this->_query_params;
-    }
+	/**
+	 * Returns query params used for model query
+	 * @return array
+	 */
+	public function get_query_params()
+	{
+		return (array) $this->_query_params;
+	}
 
-    /**
-     * Gets the name of the field that will be used for lookup.
-     * eg it could be "EVT_name", meaning that if there is a model object in
-     * the database that has that event name, and matching the other query parameters
-     * on this strategy, the input will pass validation server-side
-     * @return string
-     */
-    public function treat_input_as_field()
-    {
-        return $this->_input_field_name;
-    }
+	/**
+	 * Gets the name of the field that will be used for lookup.
+	 * eg it could be "EVT_name", meaning that if there is a model object in
+	 * the database that has that event name, and matching the other query parameters
+	 * on this strategy, the input will pass validation server-side
+	 * @return string
+	 */
+	public function treat_input_as_field()
+	{
+		return $this->_input_field_name;
+	}
 }
 
 // End of file EE_FUll_HTML_Validation_Strategy.strategy.php

core/libraries/form_sections/strategies/validation/EE_Plaintext_Validation_Strategy.strategy.php

Spacing +1 added lines, -1 removed lines

@@ -19,7 +19,7 @@
      */
     public function __construct($validation_error_message = null)
     {
-        if (! $validation_error_message) {
+        if ( ! $validation_error_message) {
             $validation_error_message = esc_html__("HTML tags are not permitted in this field", "event_espresso");
         }
         parent::__construct($validation_error_message);

Indentation +23 added lines, -23 removed lines

@@ -13,28 +13,28 @@
  */
 class EE_Plaintext_Validation_Strategy extends EE_Validation_Strategy_Base
 {
-    /**
-     * @param null $validation_error_message
-     */
-    public function __construct($validation_error_message = null)
-    {
-        if (! $validation_error_message) {
-            $validation_error_message = esc_html__("HTML tags are not permitted in this field", "event_espresso");
-        }
-        parent::__construct($validation_error_message);
-    }
+	/**
+	 * @param null $validation_error_message
+	 */
+	public function __construct($validation_error_message = null)
+	{
+		if (! $validation_error_message) {
+			$validation_error_message = esc_html__("HTML tags are not permitted in this field", "event_espresso");
+		}
+		parent::__construct($validation_error_message);
+	}
 
-    /**
-     * @param string|null $normalized_value
-     * @throws EE_Validation_Error
-     */
-    public function validate($normalized_value = '')
-    {
-        $normalized_value = (string) $normalized_value;
-        $no_tags = wp_strip_all_tags($normalized_value);
-        if (strlen($no_tags) < strlen(trim($normalized_value))) {
-            throw new EE_Validation_Error($this->get_validation_error_message(), 'no_html_tags');
-        }
-        parent::validate($normalized_value);
-    }
+	/**
+	 * @param string|null $normalized_value
+	 * @throws EE_Validation_Error
+	 */
+	public function validate($normalized_value = '')
+	{
+		$normalized_value = (string) $normalized_value;
+		$no_tags = wp_strip_all_tags($normalized_value);
+		if (strlen($no_tags) < strlen(trim($normalized_value))) {
+			throw new EE_Validation_Error($this->get_validation_error_message(), 'no_html_tags');
+		}
+		parent::validate($normalized_value);
+	}
 }