eventespresso / event-espresso-core

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

Doc Comments +1 added lines

@@ -372,6 +372,7 @@
      * save the relations indicated
      *
      * @type string $relation_name
+     * @param integer $relation_name
      * @return bool
      * @throws EE_Error
      */

Indentation +455 added lines, -455 removed lines

@@ -14,459 +14,459 @@
 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(__(
-                "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(__(
-                            "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(__(
-                            "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(__(
-                            "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, __("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(__(
-                            "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(__(
-                            "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['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(__(
-                            "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(__(
-                            "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(__(
-                            "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 $_REQUEST (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(__(
-                "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(__(
-                '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(__(
+				"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(__(
+							"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(__(
+							"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(__(
+							"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, __("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(__(
+							"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(__(
+							"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['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(__(
+							"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(__(
+							"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(__(
+							"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 $_REQUEST (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(__(
+				"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(__(
+				'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;
+		}
+	}
 }

Spacing +13 added lines, -13 removed lines

@@ -40,7 +40,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(__(
                 "Model Form Sections must first specify the _model property to be a subclass of EEM_Base",
                 "event_espresso"
@@ -104,10 +104,10 @@ 
             $input = null;
             switch (get_class($relation_obj)) {
                 case 'EE_HABTM_Relation':
-                    if (isset($subsection_args[ $relation_name ])
-                        && isset($subsection_args[ $relation_name ]['model_objects'])
+                    if (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();
                     }
@@ -116,7 +116,7 @@ 
                 default:
             }
             if ($input) {
-                $inputs[ $relation_name ] = $input;
+                $inputs[$relation_name] = $input;
             }
         }
         return $inputs;
@@ -266,7 +266,7 @@ 
                 }
                 $reflection = new ReflectionClass($input_class);
                 $input = $reflection->newInstanceArgs($input_constructor_args);
-                $inputs[ $field_name ] = $input;
+                $inputs[$field_name] = $input;
             }
         }
         return $inputs;
@@ -292,14 +292,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;
                 }
             }
         }
@@ -337,7 +337,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));
@@ -362,7 +362,7 @@ 
      */
     public function save()
     {
-        if (! $this->_model_object) {
+        if ( ! $this->_model_object) {
             throw new EE_Error(sprintf(__(
                 "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"
@@ -377,7 +377,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);
             }
         }
@@ -464,8 +464,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;
         }
     }

core/libraries/form_sections/payment_methods/EE_Payment_Method_Form.form.php

Doc Comments +1 added lines, -1 removed lines

@@ -119,7 +119,7 @@
 
 
     /**
-     * @param $payment_method_type
+     * @param EE_PMT_Base $payment_method_type
      * @throws EE_Error
      */
     public function set_payment_method_type($payment_method_type)

Indentation +191 added lines, -191 removed lines

@@ -9,195 +9,195 @@
 class EE_Payment_Method_Form extends EE_Model_Form_Section
 {
 
-    /**
-     * All the subsection inputs that correspond ot extra meta rows
-     * for this payment method
-     *
-     * @var EE_Form_Input_Base[]
-     */
-    protected $_extra_meta_inputs = array();
-
-    /**
-     * Because payment method form might DELAY part of construction, we want to remember
-     * what options were passed in
-     *
-     * @var array
-     */
-    protected $_options_array = array();
-
-    /**
-     * The payment method type for this form
-     *
-     * @var EE_PMT_Base
-     */
-    protected $_payment_method_type;
-
-
-
-    /**
-     * @param array      $options_array       {
-     * @type string      $extra_meta_inputs   should be EE_Form_Section_Validatable[] which
-     *                                        will be _subsections and will be saved as extra meta on the payment
-     *                                        method object;
-     * @type EE_PMT_Base $payment_method_type the payment method type this form is for
-     * @see EE_Model_Form_Section::__construct() for more
-     *                                        }
-     */
-    public function __construct($options_array = array())
-    {
-        $this->_model = EEM_Payment_Method::instance();
-        $this->_options_array = $options_array;
-        if (isset($options_array['payment_method_type'])) {
-            $this->_payment_method_type = $options_array['payment_method_type'];
-        }
-        $options_array = $this->_options_array;
-        if (isset($options_array['extra_meta_inputs'])) {
-            $this->_extra_meta_inputs = array_merge($this->_extra_meta_inputs, $options_array['extra_meta_inputs']);
-        }
-        if ($this->_extra_meta_inputs) {
-            $this->_subsections = array_merge($this->_subsections, $this->_extra_meta_inputs);
-        }
-        $this->_subsections['PMD_button_url'] = new EE_Admin_File_Uploader_Input(
-            array('html_label_text' => __('Button URL', 'event_espresso'))
-        );
-        $this->_subsections['PMD_scope'] = new EE_Checkbox_Multi_Input(
-            EEM_Payment_Method::instance()->scopes(),
-            array(
-                'html_label_text' => $this->_model->field_settings_for('PMD_scope')->get_nicename()
-                                     . EEH_Template::get_help_tab_link('payment_methods_overview'),
-            )
-        );
-        // setup the currency options
-        $this->_subsections['Currency'] = new EE_Select_Multi_Model_Input(
-            EEM_Currency::instance()->get_all_currencies_usable_by($this->_payment_method_type),
-            array(
-                'html_label_text' => __('Currencies Supported', 'event_espresso'),
-                'required'        => true,
-            )
-        );
-        $this->_subsections['PMD_order'] = new EE_Text_Input(array(
-            'html_label_text'        => __('Order', 'event_espresso'),
-            'html_help_text'         => __('Lowest numbers will be shown first', 'event_espresso'),
-            'normalization_strategy' => new EE_Int_Normalization(),
-            'validation_strategies'  => array(
-                new EE_Int_Validation_Strategy(),
-            ),
-            'default'                => 0,
-        ));
-        $this->_layout_strategy = new EE_Admin_Two_Column_Layout();
-        parent::__construct($options_array);
-        $debug_mode = isset($this->_subsections['PMD_debug_mode']) ? $this->_subsections['PMD_debug_mode'] : null;
-        if ($debug_mode instanceof EE_Form_Input_Base) {
-            $debug_mode->set_html_help_text(__(
-                'This payment method has a Sandbox Server (also known as Testing Server, Development Server, Quality Assurance Server, etc). While in debug mode and using this sandbox server, real payments will not be processed.',
-                'event_espresso'
-            ));
-        }
-    }
-
-
-
-    /**
-     * Finishes construction given the parent form section and this form section's name
-     *
-     * @param EE_Form_Section_Proper $parent_form_section
-     * @param string                 $name
-     * @throws EE_Error
-     */
-    public function _construct_finalize($parent_form_section, $name)
-    {
-        if (! $this->_payment_method_type instanceof EE_PMT_Base) {
-            throw new EE_Error(sprintf(__(
-                'Payment Method forms must have set their payment method type BEFORE calling _construct_finalize',
-                'event_espresso'
-            )));
-        }
-        // set the name of this form based on the payment method type
-        if (! $this->_name && ! $name) {
-            $name = str_replace(" ", "_", ucwords(str_replace("_", " ", ($this->_payment_method_type->system_name()))))
-                    . "_Settings_Form";
-        }
-        parent::_construct_finalize($parent_form_section, $name);
-    }
-
-
-
-    /**
-     * @param $payment_method_type
-     * @throws EE_Error
-     */
-    public function set_payment_method_type($payment_method_type)
-    {
-        if (! $payment_method_type instanceof EE_PMT_Base) {
-            throw new EE_Error(sprintf(__(
-                "Payment Method forms MUST set a payment method type by using _set_payment_method_type",
-                "event_espresso"
-            )));
-        }
-        $this->_payment_method_type = $payment_method_type;
-    }
-
-
-
-    /**
-     * extends the model form section's save method to also save the extra meta field values
-     *
-     * @return int ID of the payment method inserted, or true on update
-     */
-    public function save()
-    {
-        $parent_save_val = parent::save();
-        if ($this->_model_object && $this->_model_object->ID()) {
-            foreach ($this->_extra_meta_inputs as $input_name => $input) {
-                $this->_model_object->update_extra_meta($input_name, $input->normalized_value());
-            }
-        }
-        return $parent_save_val;
-    }
-
-
-
-    /**
-     * Overrides parent's populate_model_obj to also populate the extra meta fields
-     *
-     * @param EE_Base_Class $model_obj
-     */
-    public function populate_model_obj($model_obj)
-    {
-        $model_obj = $this->_model->ensure_is_obj($model_obj);
-        parent::populate_model_obj($model_obj);
-        $extra_meta = $model_obj->all_extra_meta_array();
-        foreach ($this->_extra_meta_inputs as $input_name => $extra_meta_input) {
-            if (isset($extra_meta[ $input_name ])) {
-                $extra_meta_input->set_default($extra_meta[ $input_name ]);
-            }
-        }
-    }
-
-
-
-    /**
-     * gets the 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;
-        }
-    }
-
-
-
-    /**
-     * Gets all the extra meta inputs in this form
-     *
-     * @return EE_Form_Input_Base[]
-     */
-    public function extra_meta_inputs()
-    {
-        return $this->_extra_meta_inputs;
-    }
+	/**
+	 * All the subsection inputs that correspond ot extra meta rows
+	 * for this payment method
+	 *
+	 * @var EE_Form_Input_Base[]
+	 */
+	protected $_extra_meta_inputs = array();
+
+	/**
+	 * Because payment method form might DELAY part of construction, we want to remember
+	 * what options were passed in
+	 *
+	 * @var array
+	 */
+	protected $_options_array = array();
+
+	/**
+	 * The payment method type for this form
+	 *
+	 * @var EE_PMT_Base
+	 */
+	protected $_payment_method_type;
+
+
+
+	/**
+	 * @param array      $options_array       {
+	 * @type string      $extra_meta_inputs   should be EE_Form_Section_Validatable[] which
+	 *                                        will be _subsections and will be saved as extra meta on the payment
+	 *                                        method object;
+	 * @type EE_PMT_Base $payment_method_type the payment method type this form is for
+	 * @see EE_Model_Form_Section::__construct() for more
+	 *                                        }
+	 */
+	public function __construct($options_array = array())
+	{
+		$this->_model = EEM_Payment_Method::instance();
+		$this->_options_array = $options_array;
+		if (isset($options_array['payment_method_type'])) {
+			$this->_payment_method_type = $options_array['payment_method_type'];
+		}
+		$options_array = $this->_options_array;
+		if (isset($options_array['extra_meta_inputs'])) {
+			$this->_extra_meta_inputs = array_merge($this->_extra_meta_inputs, $options_array['extra_meta_inputs']);
+		}
+		if ($this->_extra_meta_inputs) {
+			$this->_subsections = array_merge($this->_subsections, $this->_extra_meta_inputs);
+		}
+		$this->_subsections['PMD_button_url'] = new EE_Admin_File_Uploader_Input(
+			array('html_label_text' => __('Button URL', 'event_espresso'))
+		);
+		$this->_subsections['PMD_scope'] = new EE_Checkbox_Multi_Input(
+			EEM_Payment_Method::instance()->scopes(),
+			array(
+				'html_label_text' => $this->_model->field_settings_for('PMD_scope')->get_nicename()
+									 . EEH_Template::get_help_tab_link('payment_methods_overview'),
+			)
+		);
+		// setup the currency options
+		$this->_subsections['Currency'] = new EE_Select_Multi_Model_Input(
+			EEM_Currency::instance()->get_all_currencies_usable_by($this->_payment_method_type),
+			array(
+				'html_label_text' => __('Currencies Supported', 'event_espresso'),
+				'required'        => true,
+			)
+		);
+		$this->_subsections['PMD_order'] = new EE_Text_Input(array(
+			'html_label_text'        => __('Order', 'event_espresso'),
+			'html_help_text'         => __('Lowest numbers will be shown first', 'event_espresso'),
+			'normalization_strategy' => new EE_Int_Normalization(),
+			'validation_strategies'  => array(
+				new EE_Int_Validation_Strategy(),
+			),
+			'default'                => 0,
+		));
+		$this->_layout_strategy = new EE_Admin_Two_Column_Layout();
+		parent::__construct($options_array);
+		$debug_mode = isset($this->_subsections['PMD_debug_mode']) ? $this->_subsections['PMD_debug_mode'] : null;
+		if ($debug_mode instanceof EE_Form_Input_Base) {
+			$debug_mode->set_html_help_text(__(
+				'This payment method has a Sandbox Server (also known as Testing Server, Development Server, Quality Assurance Server, etc). While in debug mode and using this sandbox server, real payments will not be processed.',
+				'event_espresso'
+			));
+		}
+	}
+
+
+
+	/**
+	 * Finishes construction given the parent form section and this form section's name
+	 *
+	 * @param EE_Form_Section_Proper $parent_form_section
+	 * @param string                 $name
+	 * @throws EE_Error
+	 */
+	public function _construct_finalize($parent_form_section, $name)
+	{
+		if (! $this->_payment_method_type instanceof EE_PMT_Base) {
+			throw new EE_Error(sprintf(__(
+				'Payment Method forms must have set their payment method type BEFORE calling _construct_finalize',
+				'event_espresso'
+			)));
+		}
+		// set the name of this form based on the payment method type
+		if (! $this->_name && ! $name) {
+			$name = str_replace(" ", "_", ucwords(str_replace("_", " ", ($this->_payment_method_type->system_name()))))
+					. "_Settings_Form";
+		}
+		parent::_construct_finalize($parent_form_section, $name);
+	}
+
+
+
+	/**
+	 * @param $payment_method_type
+	 * @throws EE_Error
+	 */
+	public function set_payment_method_type($payment_method_type)
+	{
+		if (! $payment_method_type instanceof EE_PMT_Base) {
+			throw new EE_Error(sprintf(__(
+				"Payment Method forms MUST set a payment method type by using _set_payment_method_type",
+				"event_espresso"
+			)));
+		}
+		$this->_payment_method_type = $payment_method_type;
+	}
+
+
+
+	/**
+	 * extends the model form section's save method to also save the extra meta field values
+	 *
+	 * @return int ID of the payment method inserted, or true on update
+	 */
+	public function save()
+	{
+		$parent_save_val = parent::save();
+		if ($this->_model_object && $this->_model_object->ID()) {
+			foreach ($this->_extra_meta_inputs as $input_name => $input) {
+				$this->_model_object->update_extra_meta($input_name, $input->normalized_value());
+			}
+		}
+		return $parent_save_val;
+	}
+
+
+
+	/**
+	 * Overrides parent's populate_model_obj to also populate the extra meta fields
+	 *
+	 * @param EE_Base_Class $model_obj
+	 */
+	public function populate_model_obj($model_obj)
+	{
+		$model_obj = $this->_model->ensure_is_obj($model_obj);
+		parent::populate_model_obj($model_obj);
+		$extra_meta = $model_obj->all_extra_meta_array();
+		foreach ($this->_extra_meta_inputs as $input_name => $extra_meta_input) {
+			if (isset($extra_meta[ $input_name ])) {
+				$extra_meta_input->set_default($extra_meta[ $input_name ]);
+			}
+		}
+	}
+
+
+
+	/**
+	 * gets the 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;
+		}
+	}
+
+
+
+	/**
+	 * Gets all the extra meta inputs in this form
+	 *
+	 * @return EE_Form_Input_Base[]
+	 */
+	public function extra_meta_inputs()
+	{
+		return $this->_extra_meta_inputs;
+	}
 }

Spacing +7 added lines, -7 removed lines

@@ -106,14 +106,14 @@ 
      */
     public function _construct_finalize($parent_form_section, $name)
     {
-        if (! $this->_payment_method_type instanceof EE_PMT_Base) {
+        if ( ! $this->_payment_method_type instanceof EE_PMT_Base) {
             throw new EE_Error(sprintf(__(
                 'Payment Method forms must have set their payment method type BEFORE calling _construct_finalize',
                 'event_espresso'
             )));
         }
         // set the name of this form based on the payment method type
-        if (! $this->_name && ! $name) {
+        if ( ! $this->_name && ! $name) {
             $name = str_replace(" ", "_", ucwords(str_replace("_", " ", ($this->_payment_method_type->system_name()))))
                     . "_Settings_Form";
         }
@@ -128,7 +128,7 @@ 
      */
     public function set_payment_method_type($payment_method_type)
     {
-        if (! $payment_method_type instanceof EE_PMT_Base) {
+        if ( ! $payment_method_type instanceof EE_PMT_Base) {
             throw new EE_Error(sprintf(__(
                 "Payment Method forms MUST set a payment method type by using _set_payment_method_type",
                 "event_espresso"
@@ -168,8 +168,8 @@ 
         parent::populate_model_obj($model_obj);
         $extra_meta = $model_obj->all_extra_meta_array();
         foreach ($this->_extra_meta_inputs as $input_name => $extra_meta_input) {
-            if (isset($extra_meta[ $input_name ])) {
-                $extra_meta_input->set_default($extra_meta[ $input_name ]);
+            if (isset($extra_meta[$input_name])) {
+                $extra_meta_input->set_default($extra_meta[$input_name]);
             }
         }
     }
@@ -183,8 +183,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;
         }
     }

core/libraries/shortcodes/EE_Shortcodes.lib.php

Doc Comments +1 added lines, -1 removed lines

@@ -352,7 +352,7 @@
      *
      * Note: regex comes in part from the WP `get_shortcode_regex` expression in \wp-includes\shortcodes.php
      *
-     * @param $shortcode
+     * @param string $shortcode
      * @since 4.9.32
      * @return string
      */

Indentation +453 added lines, -453 removed lines

@@ -17,457 +17,457 @@
 abstract class EE_Shortcodes extends EE_Base
 {
 
-    /**
-     * holds label for library
-     * This is used for referencing the library label
-     *
-     * @access public
-     * @var string
-     */
-    public $label;
-
-
-    /**
-     * This property is used for referencing a short description of the library
-     *
-     * @access public
-     * @var string
-     */
-    public $description;
-
-
-    /**
-     * This will hold an array of shortcodes with the key as the shortcode ([shortcode]) and the value as a
-     * label/description for the shortcode.
-     *
-     * @access protected
-     * @var array
-     */
-    protected $_shortcodes;
-
-
-    /**
-     * This will hold the incoming data item sent to the parser method
-     *
-     * @access protected
-     * @var mixed (array|object)
-     */
-    protected $_data;
-
-
-    /**
-     * some shortcodes may require extra data to parse.  This property is provided for that.
-     *
-     * @var array
-     */
-    protected $_extra_data;
-
-
-    /**
-     * EE_messenger used to generate the template being parsed.
-     *
-     * @since 4.5.0
-     * @var EE_messenger
-     */
-    protected $_messenger;
-
-
-    /**
-     * message type used to generate the template being parsed.
-     *
-     * @since 4.5.0
-     * @var EE_message_type
-     */
-    protected $_message_type;
-
-
-    /**
-     * context used for the template being parsed
-     *
-     * @since 4.5.0
-     * @var string
-     */
-    protected $_context;
-
-
-    /**
-     * Specific Message Template Group ID
-     *
-     * @since 4.5.0
-     * @var int
-     */
-    protected $_GRP_ID;
-
-
-    /**
-     * @since 4.9.0
-     * @type EE_Message
-     */
-    protected $_message;
-
-
-    /**
-     * This will hold an instance of the EEH_Parse_Shortcodes helper that will be used when handling list type
-     * shortcodes
-     *
-     * @var EEH_Parse_Shortcodes
-     */
-    protected $_shortcode_helper;
-
-
-    public function __construct()
-    {
-        $this->_set_defaults();
-        $this->_init_props();
-    }
-
-
-    /**
-     * This sets the defaults for the properties.  Child classes will override these properties in their _init_props
-     * method
-     */
-    private function _set_defaults()
-    {
-        $this->name = $this->description = '';
-        $this->_shortcodes = array();
-        $this->_set_shortcode_helper();
-    }
-
-
-    /**
-     * loads an instance of the EE_Shortcode_Parser helper when requested
-     */
-    protected function _set_shortcode_helper()
-    {
-        // get shortcode_replace instance- set when _get_messages is called in child...
-        $this->_shortcode_helper = new EEH_Parse_Shortcodes();
-    }
-
-
-    public function get_shortcode_helper()
-    {
-        if (! $this->_shortcode_helper instanceof EEH_Parse_Shortcodes) {
-            $this->_set_shortcode_helper();
-        }
-        return $this->_shortcode_helper;
-    }
-
-
-    /**
-     * This is the public method for kicking of the parser included with each child.  It can be overridden by child
-     * classes if necessary (see EE_Questions_Answers for example)
-     *
-     * @param  string $shortcode incoming shortcode to be parsed
-     * @param  mixed (object|array) $data       incoming data to be be used for parsing
-     * @param  mixed (object|array) $extra_data extra incoming data (usually EE_Messages_Addressee)
-     * @return string            parsed shortcode.
-     */
-    public function parser($shortcode, $data, $extra_data = array())
-    {
-
-        // filter setup shortcodes
-        $this->_shortcodes = $this->get_shortcodes();
-
-        // we need to setup any dynamic shortcodes so that they work with the array_key_exists
-        $sc = preg_match_all('/(\[[A-Za-z0-9\_]+_\*)/', $shortcode, $matches);
-        $sc_to_verify = ! empty($matches[0]) ? $matches[0][0] . ']' : $shortcode;
-
-        // first we want to make sure this is a valid shortcode
-        if (! array_key_exists($sc_to_verify, $this->_shortcodes)) {
-            return false;
-        } //get out, this parser doesn't handle the incoming shortcode.
-        $this->_data = $data;
-        $this->_extra_data = $extra_data;
-        $this->_set_messages_properties();
-        $parsed = apply_filters(
-            'FHEE__' . get_class($this) . '__parser_after',
-            $this->_parser($shortcode),
-            $shortcode,
-            $data,
-            $extra_data,
-            $this
-        );
-
-        // note the below filter applies to ALL shortcode parsers... be careful!
-        $parsed = apply_filters('FHEE__EE_Shortcodes__parser_after', $parsed, $shortcode, $data, $extra_data, $this);
-        return $parsed;
-    }
-
-
-    /**
-     * This method just returns the shortcodes in the $_shortcodes array property.
-     *
-     * @access public
-     * @return array array of shortcodes => description pairs
-     */
-    public function get_shortcodes()
-    {
-        $this->_shortcodes = apply_filters('FHEE__' . get_class($this) . '__shortcodes', $this->_shortcodes, $this);
-
-        // note the below filter applies to ALL shortcode parsers... be careful!
-        $this->_shortcodes = apply_filters('FHEE__EE_Shortcodes__shortcodes', $this->_shortcodes, $this);
-
-        return $this->_shortcodes;
-    }
-
-
-    /**
-     * Child classes use this method to set the $name, $description, and $_shortcodes properties.
-     *
-     * @abstract
-     * @access protected
-     * @return void
-     */
-    abstract protected function _init_props();
-
-
-    /**
-     * This method will give parsing instructions for each shortcode defined in the _shortcodes array.  Child methods
-     * will have to take care of handling.
-     *
-     * @abstract
-     * @access protected
-     * @param string $shortcode    the shortcode to be parsed.
-     * @param mixed (object|array) $data      incoming data for the parser.  The data could be either an object or
-     *                             array because there are some shortcodes that might be replaced by prepared data that
-     *                             has multiple items in a list (i.e. list of attendees in an event and we're showing
-     *                             fname/lname for each attendee).  In this case data will be in an array.  Otherwise
-     *                             the data shoudl be in a properly formatted object.  The
-     *                             EEH_Parse_Shortcodes.helper.php describes the data object we're expecting.
-     * @return string parsed shortcode
-     */
-    abstract protected function _parser($shortcode);
-
-
-    /**
-     * This just validates incoming data for list type shortcode parsers (and they call this method) to make sure it
-     * meets their requirements
-     *
-     * @return mixed (void|exception) If validation fails we'll throw an exception.
-     */
-    protected function _validate_list_requirements()
-    {
-
-        // first test to make sure we've got an array!
-        if (! is_array($this->_data)) {
-            throw new EE_Error(
-                sprintf(
-                    __(
-                        'Expecting an array for the data sent to %s. Instead it was %s',
-                        'event_espresso'
-                    ),
-                    get_class($this),
-                    gettype($this->_data)
-                )
-            );
-        }
-
-        // next test to make sure we've got the required template in the index!
-        if (! isset($this->_data['template'])) {
-            throw new EE_Error(
-                sprintf(
-                    __(
-                        'The incoming data does not have the required template index in its array',
-                        'event_espresso'
-                    )
-                )
-            );
-        }
-
-        // next test to make sure we've got got a data index in the incoming data array
-        if (! isset($this->_data['data'])) {
-            throw new EE_Error(
-                __(
-                    'The incoming data does not have the required data index in its array',
-                    'event_espresso'
-                )
-            );
-        }
-
-        // all is well let's make sure _extra_data always has the values needed.
-        // let's make sure that extra_data includes all templates (for later parsing if necessary)
-        if (empty($this->_extra_data) || (empty($this->_extra_data['data']) && empty($this->_extra_data['template']))) {
-            $this->_extra_data['data'] = $this->_data['data'];
-            $this->_extra_data['template'] = $this->_data['template'];
-        }
-    }
-
-
-    /**
-     * This returns any attributes that may be existing on an EE_Shortcode
-     *
-     * @since 4.5.0
-     * @param string $shortcode incoming shortcode
-     * @return array An array with the attributes
-     */
-    protected function _get_shortcode_attrs($shortcode)
-    {
-        // make sure the required wp helper function is present
-        // require the shortcode file if necessary
-        if (! function_exists('shortcode_parse_atts')) {
-            require_once(ABSPATH . WPINC . '/shortcodes.php');
-        }
-
-        // let's get any attributes that may be present and set the defaults.
-        $shortcode_to_parse = str_replace('[', '', str_replace(']', '', $shortcode));
-        return shortcode_parse_atts($shortcode_to_parse);
-    }
-
-
-    /**
-     * Conditional blocks are shortcode patterns with an opening conditional tag `[IF_*]` and a corresponding
-     * closing tag (eg `[/IF_*]`).  The content within the tags will be displayed/hidden depending on whatever
-     * conditions existed in the opening tag.  This method handles parsing the actual template to show/hide this
-     * conditional content.
-     *
-     * @since 4.9.32
-     *
-     * @param string $shortcode This should be original shortcode as used in the template and passed to the parser.
-     * @param bool   $show      true means the opening and closing tags are removed and the content is left showing,
-     *                          false means the opening and closing tags and the contained content are removed.
-     * @return string     The template for the shortcode is returned.
-     */
-    protected function _mutate_conditional_block_in_template($shortcode, $show = true)
-    {
-        // first let's get all the matches in the template for this particular shortcode.
-        preg_match_all('~' . $this->_get_conditional_block_regex($shortcode) . '~', $this->_data['template'], $matches);
-
-        if ($matches && is_array($matches[0]) && ! empty($matches[0])) {
-            // we need to hide all instances of the matches
-            foreach ($matches[0] as $index => $content_to_show_or_hide) {
-                $content_to_show_or_hide = preg_quote($content_to_show_or_hide);
-                $replacement = $show ? $matches[4][ $index ] : '';
-                $this->_data['template'] = preg_replace(
-                    '~' . $content_to_show_or_hide . '~',
-                    $replacement,
-                    $this->_data['template']
-                );
-            }
-        }
-        // return $template
-        return $this->_data['template'];
-    }
-
-
-    /**
-     * This returns the regex pattern to use for conditional shortcodes parsing.
-     *
-     * Note: regex comes in part from the WP `get_shortcode_regex` expression in \wp-includes\shortcodes.php
-     *
-     * @param $shortcode
-     * @since 4.9.32
-     * @return string
-     */
-    private function _get_conditional_block_regex($shortcode)
-    {
-        // get just the shortcode tag for the match
-        preg_match('@\[([^<>&/\[\]\x00-\x20=]++)@', $shortcode, $shortcode_tag_matches);
-        if (empty($shortcode_tag_matches[1])) {
-            return $this->_data['template'];
-        }
-
-        $shortcode_tag = $shortcode_tag_matches[1];
-        // get attributes_part_of_tag
-        $attributes_part = preg_quote(str_replace(array($shortcode_tag, '[', ']'), '', $shortcode));
-        // escape
-        $shortcode_tag = preg_quote($shortcode_tag);
-
-        return
-            '\['                                  // Opening Bracket
-            . "($shortcode_tag)$attributes_part"    // 1: Shortcode Name
-            . '(?![\w-])'                           // Not followed by word character or hyphen
-            . '('                                   // 2: Unroll the loop: Inside the opening shortcode tag
-            . '[^\]\/]*'                          // Not a closing bracket or forward slash
-            . '(?:'
-            . '\/(?!\])'                      // A forward slash not followed by a closing bracket
-            . '[^\]\/]*'                      // Not a closing bracket or forward slash.
-            . ')*?'
-            . ')'
-            . '(?:'
-            . '(\/)'                              // 3. Self closing tag ...
-            . '\]'                                // ... and closing bracket
-            . '|'
-            . '\]'                                // Closing bracket
-            . '(?:'
-            . '('                             // 4: Unroll the loop: Optionally, anything between the opening and closing brackets
-            . '[^\[]*+'                   // Not an opening bracket
-            . '(?:'
-            . '\[(?!\/\1\])'          // An opening bracket not followed by the closing shortcode tag.
-            . '[^\[]*+'               // Not an opening bracket
-            . ')*+'
-            . ')'
-            . '\[\/\1\]'                      // Closing shortcode tag
-            . ')?'
-            . ')';
-    }
-
-
-    /**
-     * This sets the properties related to the messages system
-     *
-     * @since 4.5.0
-     * @return void
-     */
-    protected function _set_messages_properties()
-    {
-        // should be in _extra_data
-        if (isset($this->_extra_data['messenger'])) {
-            $this->_messenger = $this->_extra_data['messenger'];
-            $this->_message_type = $this->_extra_data['message_type'];
-            $this->_context = $this->_extra_data['message'] instanceof EE_Message
-                ? $this->_extra_data['message']->context() : '';
-            $this->_GRP_ID = $this->_extra_data['message'] instanceof EE_Message
-                ? $this->_extra_data['message']->GRP_ID() : 0;
-            $this->_message = $this->_extra_data['message'] instanceof EE_Message ? $this->_extra_data['message']
-                : null;
-        }
-    }
-
-
-    /**
-     * This returns whatever the set message type object is that was set on this shortcode parser.
-     *
-     * @since 4.5.0
-     * @return EE_message_type
-     */
-    public function get_set_message_type()
-    {
-        return $this->_message_type;
-    }
-
-
-    /**
-     * This returns whatever the set messenger object is that was set on this shortcode parser
-     *
-     * @since 4.5.0
-     * @return EE_messenger
-     */
-    public function get_set_messenger()
-    {
-        return $this->_messenger;
-    }
-
-
-    /**
-     * This returns whatever the set context string is on this shortcode parser.
-     *
-     * @since 4.5.0
-     * @return string
-     */
-    public function get_set_context()
-    {
-        return $this->_context;
-    }
-
-
-    /**
-     * This returns whatever the set EE_Message object is on this shortcode.
-     *
-     * @since 4.9.0
-     * @return EE_Message
-     */
-    public function get_set_message()
-    {
-        return $this->_message;
-    }
+	/**
+	 * holds label for library
+	 * This is used for referencing the library label
+	 *
+	 * @access public
+	 * @var string
+	 */
+	public $label;
+
+
+	/**
+	 * This property is used for referencing a short description of the library
+	 *
+	 * @access public
+	 * @var string
+	 */
+	public $description;
+
+
+	/**
+	 * This will hold an array of shortcodes with the key as the shortcode ([shortcode]) and the value as a
+	 * label/description for the shortcode.
+	 *
+	 * @access protected
+	 * @var array
+	 */
+	protected $_shortcodes;
+
+
+	/**
+	 * This will hold the incoming data item sent to the parser method
+	 *
+	 * @access protected
+	 * @var mixed (array|object)
+	 */
+	protected $_data;
+
+
+	/**
+	 * some shortcodes may require extra data to parse.  This property is provided for that.
+	 *
+	 * @var array
+	 */
+	protected $_extra_data;
+
+
+	/**
+	 * EE_messenger used to generate the template being parsed.
+	 *
+	 * @since 4.5.0
+	 * @var EE_messenger
+	 */
+	protected $_messenger;
+
+
+	/**
+	 * message type used to generate the template being parsed.
+	 *
+	 * @since 4.5.0
+	 * @var EE_message_type
+	 */
+	protected $_message_type;
+
+
+	/**
+	 * context used for the template being parsed
+	 *
+	 * @since 4.5.0
+	 * @var string
+	 */
+	protected $_context;
+
+
+	/**
+	 * Specific Message Template Group ID
+	 *
+	 * @since 4.5.0
+	 * @var int
+	 */
+	protected $_GRP_ID;
+
+
+	/**
+	 * @since 4.9.0
+	 * @type EE_Message
+	 */
+	protected $_message;
+
+
+	/**
+	 * This will hold an instance of the EEH_Parse_Shortcodes helper that will be used when handling list type
+	 * shortcodes
+	 *
+	 * @var EEH_Parse_Shortcodes
+	 */
+	protected $_shortcode_helper;
+
+
+	public function __construct()
+	{
+		$this->_set_defaults();
+		$this->_init_props();
+	}
+
+
+	/**
+	 * This sets the defaults for the properties.  Child classes will override these properties in their _init_props
+	 * method
+	 */
+	private function _set_defaults()
+	{
+		$this->name = $this->description = '';
+		$this->_shortcodes = array();
+		$this->_set_shortcode_helper();
+	}
+
+
+	/**
+	 * loads an instance of the EE_Shortcode_Parser helper when requested
+	 */
+	protected function _set_shortcode_helper()
+	{
+		// get shortcode_replace instance- set when _get_messages is called in child...
+		$this->_shortcode_helper = new EEH_Parse_Shortcodes();
+	}
+
+
+	public function get_shortcode_helper()
+	{
+		if (! $this->_shortcode_helper instanceof EEH_Parse_Shortcodes) {
+			$this->_set_shortcode_helper();
+		}
+		return $this->_shortcode_helper;
+	}
+
+
+	/**
+	 * This is the public method for kicking of the parser included with each child.  It can be overridden by child
+	 * classes if necessary (see EE_Questions_Answers for example)
+	 *
+	 * @param  string $shortcode incoming shortcode to be parsed
+	 * @param  mixed (object|array) $data       incoming data to be be used for parsing
+	 * @param  mixed (object|array) $extra_data extra incoming data (usually EE_Messages_Addressee)
+	 * @return string            parsed shortcode.
+	 */
+	public function parser($shortcode, $data, $extra_data = array())
+	{
+
+		// filter setup shortcodes
+		$this->_shortcodes = $this->get_shortcodes();
+
+		// we need to setup any dynamic shortcodes so that they work with the array_key_exists
+		$sc = preg_match_all('/(\[[A-Za-z0-9\_]+_\*)/', $shortcode, $matches);
+		$sc_to_verify = ! empty($matches[0]) ? $matches[0][0] . ']' : $shortcode;
+
+		// first we want to make sure this is a valid shortcode
+		if (! array_key_exists($sc_to_verify, $this->_shortcodes)) {
+			return false;
+		} //get out, this parser doesn't handle the incoming shortcode.
+		$this->_data = $data;
+		$this->_extra_data = $extra_data;
+		$this->_set_messages_properties();
+		$parsed = apply_filters(
+			'FHEE__' . get_class($this) . '__parser_after',
+			$this->_parser($shortcode),
+			$shortcode,
+			$data,
+			$extra_data,
+			$this
+		);
+
+		// note the below filter applies to ALL shortcode parsers... be careful!
+		$parsed = apply_filters('FHEE__EE_Shortcodes__parser_after', $parsed, $shortcode, $data, $extra_data, $this);
+		return $parsed;
+	}
+
+
+	/**
+	 * This method just returns the shortcodes in the $_shortcodes array property.
+	 *
+	 * @access public
+	 * @return array array of shortcodes => description pairs
+	 */
+	public function get_shortcodes()
+	{
+		$this->_shortcodes = apply_filters('FHEE__' . get_class($this) . '__shortcodes', $this->_shortcodes, $this);
+
+		// note the below filter applies to ALL shortcode parsers... be careful!
+		$this->_shortcodes = apply_filters('FHEE__EE_Shortcodes__shortcodes', $this->_shortcodes, $this);
+
+		return $this->_shortcodes;
+	}
+
+
+	/**
+	 * Child classes use this method to set the $name, $description, and $_shortcodes properties.
+	 *
+	 * @abstract
+	 * @access protected
+	 * @return void
+	 */
+	abstract protected function _init_props();
+
+
+	/**
+	 * This method will give parsing instructions for each shortcode defined in the _shortcodes array.  Child methods
+	 * will have to take care of handling.
+	 *
+	 * @abstract
+	 * @access protected
+	 * @param string $shortcode    the shortcode to be parsed.
+	 * @param mixed (object|array) $data      incoming data for the parser.  The data could be either an object or
+	 *                             array because there are some shortcodes that might be replaced by prepared data that
+	 *                             has multiple items in a list (i.e. list of attendees in an event and we're showing
+	 *                             fname/lname for each attendee).  In this case data will be in an array.  Otherwise
+	 *                             the data shoudl be in a properly formatted object.  The
+	 *                             EEH_Parse_Shortcodes.helper.php describes the data object we're expecting.
+	 * @return string parsed shortcode
+	 */
+	abstract protected function _parser($shortcode);
+
+
+	/**
+	 * This just validates incoming data for list type shortcode parsers (and they call this method) to make sure it
+	 * meets their requirements
+	 *
+	 * @return mixed (void|exception) If validation fails we'll throw an exception.
+	 */
+	protected function _validate_list_requirements()
+	{
+
+		// first test to make sure we've got an array!
+		if (! is_array($this->_data)) {
+			throw new EE_Error(
+				sprintf(
+					__(
+						'Expecting an array for the data sent to %s. Instead it was %s',
+						'event_espresso'
+					),
+					get_class($this),
+					gettype($this->_data)
+				)
+			);
+		}
+
+		// next test to make sure we've got the required template in the index!
+		if (! isset($this->_data['template'])) {
+			throw new EE_Error(
+				sprintf(
+					__(
+						'The incoming data does not have the required template index in its array',
+						'event_espresso'
+					)
+				)
+			);
+		}
+
+		// next test to make sure we've got got a data index in the incoming data array
+		if (! isset($this->_data['data'])) {
+			throw new EE_Error(
+				__(
+					'The incoming data does not have the required data index in its array',
+					'event_espresso'
+				)
+			);
+		}
+
+		// all is well let's make sure _extra_data always has the values needed.
+		// let's make sure that extra_data includes all templates (for later parsing if necessary)
+		if (empty($this->_extra_data) || (empty($this->_extra_data['data']) && empty($this->_extra_data['template']))) {
+			$this->_extra_data['data'] = $this->_data['data'];
+			$this->_extra_data['template'] = $this->_data['template'];
+		}
+	}
+
+
+	/**
+	 * This returns any attributes that may be existing on an EE_Shortcode
+	 *
+	 * @since 4.5.0
+	 * @param string $shortcode incoming shortcode
+	 * @return array An array with the attributes
+	 */
+	protected function _get_shortcode_attrs($shortcode)
+	{
+		// make sure the required wp helper function is present
+		// require the shortcode file if necessary
+		if (! function_exists('shortcode_parse_atts')) {
+			require_once(ABSPATH . WPINC . '/shortcodes.php');
+		}
+
+		// let's get any attributes that may be present and set the defaults.
+		$shortcode_to_parse = str_replace('[', '', str_replace(']', '', $shortcode));
+		return shortcode_parse_atts($shortcode_to_parse);
+	}
+
+
+	/**
+	 * Conditional blocks are shortcode patterns with an opening conditional tag `[IF_*]` and a corresponding
+	 * closing tag (eg `[/IF_*]`).  The content within the tags will be displayed/hidden depending on whatever
+	 * conditions existed in the opening tag.  This method handles parsing the actual template to show/hide this
+	 * conditional content.
+	 *
+	 * @since 4.9.32
+	 *
+	 * @param string $shortcode This should be original shortcode as used in the template and passed to the parser.
+	 * @param bool   $show      true means the opening and closing tags are removed and the content is left showing,
+	 *                          false means the opening and closing tags and the contained content are removed.
+	 * @return string     The template for the shortcode is returned.
+	 */
+	protected function _mutate_conditional_block_in_template($shortcode, $show = true)
+	{
+		// first let's get all the matches in the template for this particular shortcode.
+		preg_match_all('~' . $this->_get_conditional_block_regex($shortcode) . '~', $this->_data['template'], $matches);
+
+		if ($matches && is_array($matches[0]) && ! empty($matches[0])) {
+			// we need to hide all instances of the matches
+			foreach ($matches[0] as $index => $content_to_show_or_hide) {
+				$content_to_show_or_hide = preg_quote($content_to_show_or_hide);
+				$replacement = $show ? $matches[4][ $index ] : '';
+				$this->_data['template'] = preg_replace(
+					'~' . $content_to_show_or_hide . '~',
+					$replacement,
+					$this->_data['template']
+				);
+			}
+		}
+		// return $template
+		return $this->_data['template'];
+	}
+
+
+	/**
+	 * This returns the regex pattern to use for conditional shortcodes parsing.
+	 *
+	 * Note: regex comes in part from the WP `get_shortcode_regex` expression in \wp-includes\shortcodes.php
+	 *
+	 * @param $shortcode
+	 * @since 4.9.32
+	 * @return string
+	 */
+	private function _get_conditional_block_regex($shortcode)
+	{
+		// get just the shortcode tag for the match
+		preg_match('@\[([^<>&/\[\]\x00-\x20=]++)@', $shortcode, $shortcode_tag_matches);
+		if (empty($shortcode_tag_matches[1])) {
+			return $this->_data['template'];
+		}
+
+		$shortcode_tag = $shortcode_tag_matches[1];
+		// get attributes_part_of_tag
+		$attributes_part = preg_quote(str_replace(array($shortcode_tag, '[', ']'), '', $shortcode));
+		// escape
+		$shortcode_tag = preg_quote($shortcode_tag);
+
+		return
+			'\['                                  // Opening Bracket
+			. "($shortcode_tag)$attributes_part"    // 1: Shortcode Name
+			. '(?![\w-])'                           // Not followed by word character or hyphen
+			. '('                                   // 2: Unroll the loop: Inside the opening shortcode tag
+			. '[^\]\/]*'                          // Not a closing bracket or forward slash
+			. '(?:'
+			. '\/(?!\])'                      // A forward slash not followed by a closing bracket
+			. '[^\]\/]*'                      // Not a closing bracket or forward slash.
+			. ')*?'
+			. ')'
+			. '(?:'
+			. '(\/)'                              // 3. Self closing tag ...
+			. '\]'                                // ... and closing bracket
+			. '|'
+			. '\]'                                // Closing bracket
+			. '(?:'
+			. '('                             // 4: Unroll the loop: Optionally, anything between the opening and closing brackets
+			. '[^\[]*+'                   // Not an opening bracket
+			. '(?:'
+			. '\[(?!\/\1\])'          // An opening bracket not followed by the closing shortcode tag.
+			. '[^\[]*+'               // Not an opening bracket
+			. ')*+'
+			. ')'
+			. '\[\/\1\]'                      // Closing shortcode tag
+			. ')?'
+			. ')';
+	}
+
+
+	/**
+	 * This sets the properties related to the messages system
+	 *
+	 * @since 4.5.0
+	 * @return void
+	 */
+	protected function _set_messages_properties()
+	{
+		// should be in _extra_data
+		if (isset($this->_extra_data['messenger'])) {
+			$this->_messenger = $this->_extra_data['messenger'];
+			$this->_message_type = $this->_extra_data['message_type'];
+			$this->_context = $this->_extra_data['message'] instanceof EE_Message
+				? $this->_extra_data['message']->context() : '';
+			$this->_GRP_ID = $this->_extra_data['message'] instanceof EE_Message
+				? $this->_extra_data['message']->GRP_ID() : 0;
+			$this->_message = $this->_extra_data['message'] instanceof EE_Message ? $this->_extra_data['message']
+				: null;
+		}
+	}
+
+
+	/**
+	 * This returns whatever the set message type object is that was set on this shortcode parser.
+	 *
+	 * @since 4.5.0
+	 * @return EE_message_type
+	 */
+	public function get_set_message_type()
+	{
+		return $this->_message_type;
+	}
+
+
+	/**
+	 * This returns whatever the set messenger object is that was set on this shortcode parser
+	 *
+	 * @since 4.5.0
+	 * @return EE_messenger
+	 */
+	public function get_set_messenger()
+	{
+		return $this->_messenger;
+	}
+
+
+	/**
+	 * This returns whatever the set context string is on this shortcode parser.
+	 *
+	 * @since 4.5.0
+	 * @return string
+	 */
+	public function get_set_context()
+	{
+		return $this->_context;
+	}
+
+
+	/**
+	 * This returns whatever the set EE_Message object is on this shortcode.
+	 *
+	 * @since 4.9.0
+	 * @return EE_Message
+	 */
+	public function get_set_message()
+	{
+		return $this->_message;
+	}
 }

Spacing +13 added lines, -13 removed lines

@@ -146,7 +146,7 @@ 
 
     public function get_shortcode_helper()
     {
-        if (! $this->_shortcode_helper instanceof EEH_Parse_Shortcodes) {
+        if ( ! $this->_shortcode_helper instanceof EEH_Parse_Shortcodes) {
             $this->_set_shortcode_helper();
         }
         return $this->_shortcode_helper;
@@ -170,17 +170,17 @@ 
 
         // we need to setup any dynamic shortcodes so that they work with the array_key_exists
         $sc = preg_match_all('/(\[[A-Za-z0-9\_]+_\*)/', $shortcode, $matches);
-        $sc_to_verify = ! empty($matches[0]) ? $matches[0][0] . ']' : $shortcode;
+        $sc_to_verify = ! empty($matches[0]) ? $matches[0][0].']' : $shortcode;
 
         // first we want to make sure this is a valid shortcode
-        if (! array_key_exists($sc_to_verify, $this->_shortcodes)) {
+        if ( ! array_key_exists($sc_to_verify, $this->_shortcodes)) {
             return false;
         } //get out, this parser doesn't handle the incoming shortcode.
         $this->_data = $data;
         $this->_extra_data = $extra_data;
         $this->_set_messages_properties();
         $parsed = apply_filters(
-            'FHEE__' . get_class($this) . '__parser_after',
+            'FHEE__'.get_class($this).'__parser_after',
             $this->_parser($shortcode),
             $shortcode,
             $data,
@@ -202,7 +202,7 @@ 
      */
     public function get_shortcodes()
     {
-        $this->_shortcodes = apply_filters('FHEE__' . get_class($this) . '__shortcodes', $this->_shortcodes, $this);
+        $this->_shortcodes = apply_filters('FHEE__'.get_class($this).'__shortcodes', $this->_shortcodes, $this);
 
         // note the below filter applies to ALL shortcode parsers... be careful!
         $this->_shortcodes = apply_filters('FHEE__EE_Shortcodes__shortcodes', $this->_shortcodes, $this);
@@ -249,7 +249,7 @@ 
     {
 
         // first test to make sure we've got an array!
-        if (! is_array($this->_data)) {
+        if ( ! is_array($this->_data)) {
             throw new EE_Error(
                 sprintf(
                     __(
@@ -263,7 +263,7 @@ 
         }
 
         // next test to make sure we've got the required template in the index!
-        if (! isset($this->_data['template'])) {
+        if ( ! isset($this->_data['template'])) {
             throw new EE_Error(
                 sprintf(
                     __(
@@ -275,7 +275,7 @@ 
         }
 
         // next test to make sure we've got got a data index in the incoming data array
-        if (! isset($this->_data['data'])) {
+        if ( ! isset($this->_data['data'])) {
             throw new EE_Error(
                 __(
                     'The incoming data does not have the required data index in its array',
@@ -304,8 +304,8 @@ 
     {
         // make sure the required wp helper function is present
         // require the shortcode file if necessary
-        if (! function_exists('shortcode_parse_atts')) {
-            require_once(ABSPATH . WPINC . '/shortcodes.php');
+        if ( ! function_exists('shortcode_parse_atts')) {
+            require_once(ABSPATH.WPINC.'/shortcodes.php');
         }
 
         // let's get any attributes that may be present and set the defaults.
@@ -330,15 +330,15 @@ 
     protected function _mutate_conditional_block_in_template($shortcode, $show = true)
     {
         // first let's get all the matches in the template for this particular shortcode.
-        preg_match_all('~' . $this->_get_conditional_block_regex($shortcode) . '~', $this->_data['template'], $matches);
+        preg_match_all('~'.$this->_get_conditional_block_regex($shortcode).'~', $this->_data['template'], $matches);
 
         if ($matches && is_array($matches[0]) && ! empty($matches[0])) {
             // we need to hide all instances of the matches
             foreach ($matches[0] as $index => $content_to_show_or_hide) {
                 $content_to_show_or_hide = preg_quote($content_to_show_or_hide);
-                $replacement = $show ? $matches[4][ $index ] : '';
+                $replacement = $show ? $matches[4][$index] : '';
                 $this->_data['template'] = preg_replace(
-                    '~' . $content_to_show_or_hide . '~',
+                    '~'.$content_to_show_or_hide.'~',
                     $replacement,
                     $this->_data['template']
                 );

core/services/commands/transaction/CreateTransactionCommand.php

Spacing +1 added lines, -1 removed lines

@@ -57,7 +57,7 @@
     public function getCapCheck()
     {
         // need cap for non-AJAX admin requests
-        if (! (defined('DOING_AJAX') && DOING_AJAX) && is_admin()) {
+        if ( ! (defined('DOING_AJAX') && DOING_AJAX) && is_admin()) {
             // there's no specific caps for editing/creating transactions,
             // so that's why we are using ee_edit_registrations
             return new CapCheck('ee_edit_registrations', 'create_new_transaction');

Indentation +47 added lines, -47 removed lines

@@ -20,60 +20,60 @@
 class CreateTransactionCommand extends Command implements CommandRequiresCapCheckInterface
 {
 
-    /**
-     * @var EE_Checkout $checkout
-     */
-    protected $checkout;
+	/**
+	 * @var EE_Checkout $checkout
+	 */
+	protected $checkout;
 
-    /**
-     * @var array $transaction_details
-     */
-    protected $transaction_details;
+	/**
+	 * @var array $transaction_details
+	 */
+	protected $transaction_details;
 
 
-    /**
-     * CreateTransactionCommand constructor.
-     *
-     * @param EE_Checkout $checkout
-     * @param array       $transaction_details
-     */
-    public function __construct(EE_Checkout $checkout = null, array $transaction_details = array())
-    {
-        $this->checkout = $checkout;
-        $this->transaction_details = $transaction_details;
-    }
+	/**
+	 * CreateTransactionCommand constructor.
+	 *
+	 * @param EE_Checkout $checkout
+	 * @param array       $transaction_details
+	 */
+	public function __construct(EE_Checkout $checkout = null, array $transaction_details = array())
+	{
+		$this->checkout = $checkout;
+		$this->transaction_details = $transaction_details;
+	}
 
 
-    /**
-     * @return CapCheckInterface
-     * @throws InvalidDataTypeException
-     */
-    public function getCapCheck()
-    {
-        // need cap for non-AJAX admin requests
-        if (! (defined('DOING_AJAX') && DOING_AJAX) && is_admin()) {
-            // there's no specific caps for editing/creating transactions,
-            // so that's why we are using ee_edit_registrations
-            return new CapCheck('ee_edit_registrations', 'create_new_transaction');
-        }
-        return new PublicCapabilities('', 'create_new_transaction');
-    }
+	/**
+	 * @return CapCheckInterface
+	 * @throws InvalidDataTypeException
+	 */
+	public function getCapCheck()
+	{
+		// need cap for non-AJAX admin requests
+		if (! (defined('DOING_AJAX') && DOING_AJAX) && is_admin()) {
+			// there's no specific caps for editing/creating transactions,
+			// so that's why we are using ee_edit_registrations
+			return new CapCheck('ee_edit_registrations', 'create_new_transaction');
+		}
+		return new PublicCapabilities('', 'create_new_transaction');
+	}
 
 
-    /**
-     * @return EE_Checkout
-     */
-    public function checkout()
-    {
-        return $this->checkout;
-    }
+	/**
+	 * @return EE_Checkout
+	 */
+	public function checkout()
+	{
+		return $this->checkout;
+	}
 
 
-    /**
-     * @return array
-     */
-    public function transactionDetails()
-    {
-        return $this->transaction_details;
-    }
+	/**
+	 * @return array
+	 */
+	public function transactionDetails()
+	{
+		return $this->transaction_details;
+	}
 }

core/services/commands/transaction/CreateTransactionCommandHandler.php

Indentation +38 added lines, -38 removed lines

@@ -26,44 +26,44 @@
 {
 
 
-    /**
-     * @param CommandInterface $command
-     * @return mixed
-     * @throws EE_Error
-     * @throws InvalidEntityException
-     */
-    public function handle(CommandInterface $command)
-    {
-        /** @var CreateTransactionCommand $command */
-        if (! $command instanceof CreateTransactionCommand) {
-            throw new InvalidEntityException(get_class($command), 'CreateTransactionCommand');
-        }
-        $transaction_details = $command->transactionDetails();
-        $cart_total = null;
-        if ($command->checkout() instanceof EE_Checkout) {
-            // ensure cart totals have been calculated
-            $command->checkout()->cart->get_grand_total()->recalculate_total_including_taxes();
-            // grab the cart grand total
-            $cart_total = $command->checkout()->cart->get_cart_grand_total();
-            $transaction_details['TXN_reg_steps'] = $command->checkout()->initialize_txn_reg_steps_array();
-            $transaction_details['TXN_total'] = $cart_total > 0 ? $cart_total : 0;
-        }
-        // create new TXN and save it so it has an ID
-        $transaction = EE_Transaction::new_instance($transaction_details);
-        if (! $transaction instanceof EE_Transaction) {
-            throw new InvalidEntityException(get_class($transaction), 'EE_Transaction');
-        }
-        $transaction->save();
-        // ensure grand total line item created
-        $cart_total = $cart_total instanceof EE_Line_Item
-            ? $cart_total
-            : EEH_Line_Item::create_total_line_item($transaction);
-        if (! $cart_total instanceof EE_Line_Item) {
-            throw new InvalidEntityException(get_class($cart_total), 'EE_Line_Item');
-        }
-        $cart_total->save_this_and_descendants_to_txn($transaction->ID());
-        return $transaction;
-    }
+	/**
+	 * @param CommandInterface $command
+	 * @return mixed
+	 * @throws EE_Error
+	 * @throws InvalidEntityException
+	 */
+	public function handle(CommandInterface $command)
+	{
+		/** @var CreateTransactionCommand $command */
+		if (! $command instanceof CreateTransactionCommand) {
+			throw new InvalidEntityException(get_class($command), 'CreateTransactionCommand');
+		}
+		$transaction_details = $command->transactionDetails();
+		$cart_total = null;
+		if ($command->checkout() instanceof EE_Checkout) {
+			// ensure cart totals have been calculated
+			$command->checkout()->cart->get_grand_total()->recalculate_total_including_taxes();
+			// grab the cart grand total
+			$cart_total = $command->checkout()->cart->get_cart_grand_total();
+			$transaction_details['TXN_reg_steps'] = $command->checkout()->initialize_txn_reg_steps_array();
+			$transaction_details['TXN_total'] = $cart_total > 0 ? $cart_total : 0;
+		}
+		// create new TXN and save it so it has an ID
+		$transaction = EE_Transaction::new_instance($transaction_details);
+		if (! $transaction instanceof EE_Transaction) {
+			throw new InvalidEntityException(get_class($transaction), 'EE_Transaction');
+		}
+		$transaction->save();
+		// ensure grand total line item created
+		$cart_total = $cart_total instanceof EE_Line_Item
+			? $cart_total
+			: EEH_Line_Item::create_total_line_item($transaction);
+		if (! $cart_total instanceof EE_Line_Item) {
+			throw new InvalidEntityException(get_class($cart_total), 'EE_Line_Item');
+		}
+		$cart_total->save_this_and_descendants_to_txn($transaction->ID());
+		return $transaction;
+	}
 
 
 }

Spacing +3 added lines, -3 removed lines

@@ -35,7 +35,7 @@ 
     public function handle(CommandInterface $command)
     {
         /** @var CreateTransactionCommand $command */
-        if (! $command instanceof CreateTransactionCommand) {
+        if ( ! $command instanceof CreateTransactionCommand) {
             throw new InvalidEntityException(get_class($command), 'CreateTransactionCommand');
         }
         $transaction_details = $command->transactionDetails();
@@ -50,7 +50,7 @@ 
         }
         // create new TXN and save it so it has an ID
         $transaction = EE_Transaction::new_instance($transaction_details);
-        if (! $transaction instanceof EE_Transaction) {
+        if ( ! $transaction instanceof EE_Transaction) {
             throw new InvalidEntityException(get_class($transaction), 'EE_Transaction');
         }
         $transaction->save();
@@ -58,7 +58,7 @@ 
         $cart_total = $cart_total instanceof EE_Line_Item
             ? $cart_total
             : EEH_Line_Item::create_total_line_item($transaction);
-        if (! $cart_total instanceof EE_Line_Item) {
+        if ( ! $cart_total instanceof EE_Line_Item) {
             throw new InvalidEntityException(get_class($cart_total), 'EE_Line_Item');
         }
         $cart_total->save_this_and_descendants_to_txn($transaction->ID());

core/services/commands/attendee/CreateAttendeeCommand.php

Spacing +1 added lines, -1 removed lines

@@ -81,7 +81,7 @@
     public function getCapCheck()
     {
         // need cap for non-AJAX admin requests
-        if (! (defined('DOING_AJAX') && DOING_AJAX) && is_admin()) {
+        if ( ! (defined('DOING_AJAX') && DOING_AJAX) && is_admin()) {
             return new CapCheck('ee_edit_contacts', 'create_new_contact');
         }
         return new PublicCapabilities('', 'create_new_contact');

Indentation +49 added lines, -49 removed lines

@@ -20,62 +20,62 @@
 class CreateAttendeeCommand extends Command implements CommandRequiresCapCheckInterface
 {
 
-    /**
-     * array of details where keys are names of EEM_Attendee model fields
-     *
-     * @var array $attendee_details
-     */
-    protected $attendee_details;
+	/**
+	 * array of details where keys are names of EEM_Attendee model fields
+	 *
+	 * @var array $attendee_details
+	 */
+	protected $attendee_details;
 
-    /**
-     * an existing registration to associate this attendee with
-     *
-     * @var EE_Registration $registration
-     */
-    protected $registration;
+	/**
+	 * an existing registration to associate this attendee with
+	 *
+	 * @var EE_Registration $registration
+	 */
+	protected $registration;
 
 
-    /**
-     * CreateAttendeeCommand constructor.
-     *
-     * @param array           $attendee_details
-     * @param EE_Registration $registration
-     */
-    public function __construct(array $attendee_details, EE_Registration $registration)
-    {
-        $this->attendee_details = $attendee_details;
-        $this->registration = $registration;
-    }
+	/**
+	 * CreateAttendeeCommand constructor.
+	 *
+	 * @param array           $attendee_details
+	 * @param EE_Registration $registration
+	 */
+	public function __construct(array $attendee_details, EE_Registration $registration)
+	{
+		$this->attendee_details = $attendee_details;
+		$this->registration = $registration;
+	}
 
 
-    /**
-     * @return array
-     */
-    public function attendeeDetails()
-    {
-        return $this->attendee_details;
-    }
+	/**
+	 * @return array
+	 */
+	public function attendeeDetails()
+	{
+		return $this->attendee_details;
+	}
 
 
-    /**
-     * @return EE_Registration
-     */
-    public function registration()
-    {
-        return $this->registration;
-    }
+	/**
+	 * @return EE_Registration
+	 */
+	public function registration()
+	{
+		return $this->registration;
+	}
 
 
-    /**
-     * @return CapCheckInterface
-     * @throws InvalidDataTypeException
-     */
-    public function getCapCheck()
-    {
-        // need cap for non-AJAX admin requests
-        if (! (defined('DOING_AJAX') && DOING_AJAX) && is_admin()) {
-            return new CapCheck('ee_edit_contacts', 'create_new_contact');
-        }
-        return new PublicCapabilities('', 'create_new_contact');
-    }
+	/**
+	 * @return CapCheckInterface
+	 * @throws InvalidDataTypeException
+	 */
+	public function getCapCheck()
+	{
+		// need cap for non-AJAX admin requests
+		if (! (defined('DOING_AJAX') && DOING_AJAX) && is_admin()) {
+			return new CapCheck('ee_edit_contacts', 'create_new_contact');
+		}
+		return new PublicCapabilities('', 'create_new_contact');
+	}
 }

core/libraries/rest_api/controllers/Base.php

Doc Comments +1 added lines, -1 removed lines

@@ -314,7 +314,7 @@
      *
      * @param string $route
      * @param string $regex
-     * @param array  $match_keys EXCLUDING matching the entire regex
+     * @param string[]  $match_keys EXCLUDING matching the entire regex
      * @return array where  $match_keys are the keys (the first value of $match_keys
      *                           becomes the first key of the return value, etc. Eg passing in $match_keys of
      *                           array( 'model', 'id' ), will, if the regex is successful, will return

Unused Use Statements -1 removed lines

@@ -5,7 +5,6 @@
 use WP_Error;
 use WP_REST_Response;
 use EventEspresso\core\libraries\rest_api\RestException;
-
 use EE_Error;
 use EED_Core_Rest_Api;
 use EEH_Inflector;

Spacing +12 added lines, -12 removed lines

@@ -96,7 +96,7 @@ 
      */
     protected function setDebugInfo($key, $info)
     {
-        $this->debug_info[ $key ] = $info;
+        $this->debug_info[$key] = $info;
     }
 
 
@@ -113,11 +113,11 @@ 
     {
         if (is_array($value)) {
             foreach ($value as $value_key => $value_value) {
-                $this->setResponseHeader($header_key . '[' . $value_key . ']', $value_value);
+                $this->setResponseHeader($header_key.'['.$value_key.']', $value_value);
             }
         } else {
             $prefix = $use_ee_prefix ? Base::HEADER_PREFIX_FOR_EE : Base::HEADER_PREFIX_FOR_WP;
-            $this->response_headers[ $prefix . $header_key ] = $value;
+            $this->response_headers[$prefix.$header_key] = $value;
         }
     }
 
@@ -147,7 +147,7 @@ 
     protected function addEeErrorsToResponse(WP_Error $wp_error_response)
     {
         $notices_during_checkin = EE_Error::get_raw_notices();
-        if (! empty($notices_during_checkin['errors'])) {
+        if ( ! empty($notices_during_checkin['errors'])) {
             foreach ($notices_during_checkin['errors'] as $error_code => $error_message) {
                 $wp_error_response->add(
                     sanitize_key($error_code),
@@ -190,7 +190,7 @@ 
                 if (is_array($debug_info)) {
                     $debug_info = wp_json_encode($debug_info);
                 }
-                $headers[ 'X-EE4-Debug-' . ucwords($debug_key) ] = $debug_info;
+                $headers['X-EE4-Debug-'.ucwords($debug_key)] = $debug_info;
             }
         }
         $headers = array_merge(
@@ -249,15 +249,15 @@ 
         $headers = array();
         $notices = EE_Error::get_raw_notices();
         foreach ($notices as $notice_type => $sub_notices) {
-            if (! is_array($sub_notices)) {
+            if ( ! is_array($sub_notices)) {
                 continue;
             }
             foreach ($sub_notices as $notice_code => $sub_notice) {
-                $headers[ 'X-EE4-Notices-'
+                $headers['X-EE4-Notices-'
                           . EEH_Inflector::humanize($notice_type)
                           . '['
                           . $notice_code
-                          . ']' ] = strip_tags($sub_notice);
+                          . ']'] = strip_tags($sub_notice);
             }
         }
         return apply_filters(
@@ -286,7 +286,7 @@ 
         }
         $matches = $this->parseRoute(
             $route,
-            '~' . EED_Core_Rest_Api::ee_api_namespace_for_regex . '~',
+            '~'.EED_Core_Rest_Api::ee_api_namespace_for_regex.'~',
             array('version')
         );
         if (isset($matches['version'])) {
@@ -320,14 +320,14 @@ 
         if (is_array($matches)) {
             // skip the overall regex match. Who cares
             for ($i = 1; $i <= count($match_keys); $i++) {
-                if (! isset($matches[ $i ])) {
+                if ( ! isset($matches[$i])) {
                     $success = false;
                 } else {
-                    $indexed_matches[ $match_keys[ $i - 1 ] ] = $matches[ $i ];
+                    $indexed_matches[$match_keys[$i - 1]] = $matches[$i];
                 }
             }
         }
-        if (! $success) {
+        if ( ! $success) {
             throw new EE_Error(
                 __('We could not parse the URL. Please contact Event Espresso Support', 'event_espresso'),
                 'endpoint_parsing_error'

Indentation +334 added lines, -334 removed lines

@@ -22,338 +22,338 @@
 class Base
 {
 
-    /**
-     * @deprecated use all-caps version
-     */
-    // @codingStandardsIgnoreStart
-    const header_prefix_for_ee = 'X-EE-';
-    // @codingStandardsIgnoreEnd
-
-    const HEADER_PREFIX_FOR_EE = 'X-EE-';
-
-    /**
-     * @deprecated use all-caps version instead
-     */
-    // @codingStandardsIgnoreStart
-    const header_prefix_for_wp = 'X-WP-';
-    // @codingStandardsIgnoreEnd
-
-    const HEADER_PREFIX_FOR_WP = 'X-WP-';
-
-    /**
-     * Contains debug info we'll send back in the response headers
-     *
-     * @var array
-     */
-    protected $debug_info = array();
-
-    /**
-     * Indicates whether or not the API is in debug mode
-     *
-     * @var boolean
-     */
-    protected $debug_mode = false;
-
-    /**
-     * Indicates the version that was requested
-     *
-     * @var string
-     */
-    protected $requested_version;
-
-    /**
-     * flat array of headers to send in the response
-     *
-     * @var array
-     */
-    protected $response_headers = array();
-
-
-    public function __construct()
-    {
-        $this->debug_mode = EED_Core_Rest_Api::debugMode();
-        // we are handling a REST request. Don't show a fancy HTML error message is any error comes up
-        add_filter('FHEE__EE_Error__get_error__show_normal_exceptions', '__return_true');
-    }
-
-
-    /**
-     * Sets the version the user requested
-     *
-     * @param string $version eg '4.8'
-     */
-    public function setRequestedVersion($version)
-    {
-        $this->requested_version = $version;
-    }
-
-
-    /**
-     * Sets some debug info that we'll send back in headers
-     *
-     * @param string       $key
-     * @param string|array $info
-     */
-    protected function setDebugInfo($key, $info)
-    {
-        $this->debug_info[ $key ] = $info;
-    }
-
-
-    /**
-     * Sets headers for the response
-     *
-     * @param string       $header_key    , excluding the "X-EE-" part
-     * @param array|string $value         if an array, multiple headers will be added, one
-     *                                    for each key in the array
-     * @param boolean      $use_ee_prefix whether to use the EE prefix on the header, or fallback to
-     *                                    the standard WP one
-     */
-    protected function setResponseHeader($header_key, $value, $use_ee_prefix = true)
-    {
-        if (is_array($value)) {
-            foreach ($value as $value_key => $value_value) {
-                $this->setResponseHeader($header_key . '[' . $value_key . ']', $value_value);
-            }
-        } else {
-            $prefix = $use_ee_prefix ? Base::HEADER_PREFIX_FOR_EE : Base::HEADER_PREFIX_FOR_WP;
-            $this->response_headers[ $prefix . $header_key ] = $value;
-        }
-    }
-
-
-    /**
-     * Returns a flat array of headers to be added to the response
-     *
-     * @return array
-     */
-    protected function getResponseHeaders()
-    {
-        return apply_filters(
-            'FHEE__EventEspresso\core\libraries\rest_api\controllers\Base___get_response_headers',
-            $this->response_headers,
-            $this,
-            $this->requested_version
-        );
-    }
-
-
-    /**
-     * Adds error notices from EE_Error onto the provided \WP_Error
-     *
-     * @param WP_Error $wp_error_response
-     * @return WP_Error
-     */
-    protected function addEeErrorsToResponse(WP_Error $wp_error_response)
-    {
-        $notices_during_checkin = EE_Error::get_raw_notices();
-        if (! empty($notices_during_checkin['errors'])) {
-            foreach ($notices_during_checkin['errors'] as $error_code => $error_message) {
-                $wp_error_response->add(
-                    sanitize_key($error_code),
-                    strip_tags($error_message)
-                );
-            }
-        }
-        return $wp_error_response;
-    }
-
-
-    /**
-     * Sends a response, but also makes sure to attach headers that
-     * are handy for debugging.
-     * Specifically, we assume folks will want to know what exactly was the DB query that got run,
-     * what exactly was the Models query that got run, what capabilities came into play, what fields were omitted from
-     * the response, others?
-     *
-     * @param array|WP_Error|Exception|RestException $response
-     * @return WP_REST_Response
-     */
-    public function sendResponse($response)
-    {
-        if ($response instanceof RestException) {
-            $response = new WP_Error($response->getStringCode(), $response->getMessage(), $response->getData());
-        }
-        if ($response instanceof Exception) {
-            $code = $response->getCode() ? $response->getCode() : 'error_occurred';
-            $response = new WP_Error($code, $response->getMessage());
-        }
-        if ($response instanceof WP_Error) {
-            $response = $this->addEeErrorsToResponse($response);
-            $rest_response = $this->createRestResponseFromWpError($response);
-        } else {
-            $rest_response = new WP_REST_Response($response, 200);
-        }
-        $headers = array();
-        if ($this->debug_mode && is_array($this->debug_info)) {
-            foreach ($this->debug_info as $debug_key => $debug_info) {
-                if (is_array($debug_info)) {
-                    $debug_info = wp_json_encode($debug_info);
-                }
-                $headers[ 'X-EE4-Debug-' . ucwords($debug_key) ] = $debug_info;
-            }
-        }
-        $headers = array_merge(
-            $headers,
-            $this->getResponseHeaders(),
-            $this->getHeadersFromEeNotices()
-        );
-        $rest_response->set_headers($headers);
-        return $rest_response;
-    }
-
-
-    /**
-     * Converts the \WP_Error into `WP_REST_Response.
-     * Mostly this is just a copy-and-paste from \WP_REST_Server::error_to_response
-     * (which is protected)
-     *
-     * @param WP_Error $wp_error
-     * @return WP_REST_Response
-     */
-    protected function createRestResponseFromWpError(WP_Error $wp_error)
-    {
-        $error_data = $wp_error->get_error_data();
-        if (is_array($error_data) && isset($error_data['status'])) {
-            $status = $error_data['status'];
-        } else {
-            $status = 500;
-        }
-        $errors = array();
-        foreach ((array) $wp_error->errors as $code => $messages) {
-            foreach ((array) $messages as $message) {
-                $errors[] = array(
-                    'code'    => $code,
-                    'message' => $message,
-                    'data'    => $wp_error->get_error_data($code),
-                );
-            }
-        }
-        $data = isset($errors[0]) ? $errors[0] : array();
-        if (count($errors) > 1) {
-            // Remove the primary error.
-            array_shift($errors);
-            $data['additional_errors'] = $errors;
-        }
-        return new WP_REST_Response($data, $status);
-    }
-
-
-    /**
-     * Array of headers derived from EE success, attention, and error messages
-     *
-     * @return array
-     */
-    protected function getHeadersFromEeNotices()
-    {
-        $headers = array();
-        $notices = EE_Error::get_raw_notices();
-        foreach ($notices as $notice_type => $sub_notices) {
-            if (! is_array($sub_notices)) {
-                continue;
-            }
-            foreach ($sub_notices as $notice_code => $sub_notice) {
-                $headers[ 'X-EE4-Notices-'
-                          . EEH_Inflector::humanize($notice_type)
-                          . '['
-                          . $notice_code
-                          . ']' ] = strip_tags($sub_notice);
-            }
-        }
-        return apply_filters(
-            'FHEE__EventEspresso\core\libraries\rest_api\controllers\Base___get_headers_from_ee_notices__return',
-            $headers,
-            $this->requested_version,
-            $notices
-        );
-    }
-
-
-    /**
-     * Finds which version of the API was requested given the route, and returns it.
-     * eg in a request to "mysite.com/wp-json/ee/v4.8.29/events/123" this would return
-     * "4.8.29".
-     * We should know hte requested version in this model though, so if no route is
-     * provided just use what we set earlier
-     *
-     * @param string $route
-     * @return string
-     */
-    public function getRequestedVersion($route = null)
-    {
-        if ($route === null) {
-            return $this->requested_version;
-        }
-        $matches = $this->parseRoute(
-            $route,
-            '~' . EED_Core_Rest_Api::ee_api_namespace_for_regex . '~',
-            array('version')
-        );
-        if (isset($matches['version'])) {
-            return $matches['version'];
-        } else {
-            return EED_Core_Rest_Api::latest_rest_api_version();
-        }
-    }
-
-
-    /**
-     * Applies the regex to the route, then creates an array using the values of
-     * $match_keys as keys (but ignores the full pattern match). Returns the array of matches.
-     * For example, if you call
-     * parse_route( '/ee/v4.8/events', '~\/ee\/v([^/]*)\/(.*)~', array( 'version', 'model' ) )
-     * it will return array( 'version' => '4.8', 'model' => 'events' )
-     *
-     * @param string $route
-     * @param string $regex
-     * @param array  $match_keys EXCLUDING matching the entire regex
-     * @return array where  $match_keys are the keys (the first value of $match_keys
-     *                           becomes the first key of the return value, etc. Eg passing in $match_keys of
-     *                           array( 'model', 'id' ), will, if the regex is successful, will return
-     *                           array( 'model' => 'foo', 'id' => 'bar' )
-     * @throws EE_Error if it couldn't be parsed
-     */
-    public function parseRoute($route, $regex, $match_keys)
-    {
-        $indexed_matches = array();
-        $success = preg_match($regex, $route, $matches);
-        if (is_array($matches)) {
-            // skip the overall regex match. Who cares
-            for ($i = 1; $i <= count($match_keys); $i++) {
-                if (! isset($matches[ $i ])) {
-                    $success = false;
-                } else {
-                    $indexed_matches[ $match_keys[ $i - 1 ] ] = $matches[ $i ];
-                }
-            }
-        }
-        if (! $success) {
-            throw new EE_Error(
-                __('We could not parse the URL. Please contact Event Espresso Support', 'event_espresso'),
-                'endpoint_parsing_error'
-            );
-        }
-        return $indexed_matches;
-    }
-
-
-    /**
-     * Gets the body's params (either from JSON or parsed body), which EXCLUDES the GET params and URL params
-     *
-     * @param \WP_REST_Request $request
-     * @return array
-     */
-    protected function getBodyParams(\WP_REST_Request $request)
-    {
-        // $request->get_params();
-        return array_merge(
-            (array) $request->get_body_params(),
-            (array) $request->get_json_params()
-        );
-        // return array_diff_key(
-        //    $request->get_params(),
-        //     $request->get_url_params(),
-        //     $request->get_query_params()
-        // );
-    }
+	/**
+	 * @deprecated use all-caps version
+	 */
+	// @codingStandardsIgnoreStart
+	const header_prefix_for_ee = 'X-EE-';
+	// @codingStandardsIgnoreEnd
+
+	const HEADER_PREFIX_FOR_EE = 'X-EE-';
+
+	/**
+	 * @deprecated use all-caps version instead
+	 */
+	// @codingStandardsIgnoreStart
+	const header_prefix_for_wp = 'X-WP-';
+	// @codingStandardsIgnoreEnd
+
+	const HEADER_PREFIX_FOR_WP = 'X-WP-';
+
+	/**
+	 * Contains debug info we'll send back in the response headers
+	 *
+	 * @var array
+	 */
+	protected $debug_info = array();
+
+	/**
+	 * Indicates whether or not the API is in debug mode
+	 *
+	 * @var boolean
+	 */
+	protected $debug_mode = false;
+
+	/**
+	 * Indicates the version that was requested
+	 *
+	 * @var string
+	 */
+	protected $requested_version;
+
+	/**
+	 * flat array of headers to send in the response
+	 *
+	 * @var array
+	 */
+	protected $response_headers = array();
+
+
+	public function __construct()
+	{
+		$this->debug_mode = EED_Core_Rest_Api::debugMode();
+		// we are handling a REST request. Don't show a fancy HTML error message is any error comes up
+		add_filter('FHEE__EE_Error__get_error__show_normal_exceptions', '__return_true');
+	}
+
+
+	/**
+	 * Sets the version the user requested
+	 *
+	 * @param string $version eg '4.8'
+	 */
+	public function setRequestedVersion($version)
+	{
+		$this->requested_version = $version;
+	}
+
+
+	/**
+	 * Sets some debug info that we'll send back in headers
+	 *
+	 * @param string       $key
+	 * @param string|array $info
+	 */
+	protected function setDebugInfo($key, $info)
+	{
+		$this->debug_info[ $key ] = $info;
+	}
+
+
+	/**
+	 * Sets headers for the response
+	 *
+	 * @param string       $header_key    , excluding the "X-EE-" part
+	 * @param array|string $value         if an array, multiple headers will be added, one
+	 *                                    for each key in the array
+	 * @param boolean      $use_ee_prefix whether to use the EE prefix on the header, or fallback to
+	 *                                    the standard WP one
+	 */
+	protected function setResponseHeader($header_key, $value, $use_ee_prefix = true)
+	{
+		if (is_array($value)) {
+			foreach ($value as $value_key => $value_value) {
+				$this->setResponseHeader($header_key . '[' . $value_key . ']', $value_value);
+			}
+		} else {
+			$prefix = $use_ee_prefix ? Base::HEADER_PREFIX_FOR_EE : Base::HEADER_PREFIX_FOR_WP;
+			$this->response_headers[ $prefix . $header_key ] = $value;
+		}
+	}
+
+
+	/**
+	 * Returns a flat array of headers to be added to the response
+	 *
+	 * @return array
+	 */
+	protected function getResponseHeaders()
+	{
+		return apply_filters(
+			'FHEE__EventEspresso\core\libraries\rest_api\controllers\Base___get_response_headers',
+			$this->response_headers,
+			$this,
+			$this->requested_version
+		);
+	}
+
+
+	/**
+	 * Adds error notices from EE_Error onto the provided \WP_Error
+	 *
+	 * @param WP_Error $wp_error_response
+	 * @return WP_Error
+	 */
+	protected function addEeErrorsToResponse(WP_Error $wp_error_response)
+	{
+		$notices_during_checkin = EE_Error::get_raw_notices();
+		if (! empty($notices_during_checkin['errors'])) {
+			foreach ($notices_during_checkin['errors'] as $error_code => $error_message) {
+				$wp_error_response->add(
+					sanitize_key($error_code),
+					strip_tags($error_message)
+				);
+			}
+		}
+		return $wp_error_response;
+	}
+
+
+	/**
+	 * Sends a response, but also makes sure to attach headers that
+	 * are handy for debugging.
+	 * Specifically, we assume folks will want to know what exactly was the DB query that got run,
+	 * what exactly was the Models query that got run, what capabilities came into play, what fields were omitted from
+	 * the response, others?
+	 *
+	 * @param array|WP_Error|Exception|RestException $response
+	 * @return WP_REST_Response
+	 */
+	public function sendResponse($response)
+	{
+		if ($response instanceof RestException) {
+			$response = new WP_Error($response->getStringCode(), $response->getMessage(), $response->getData());
+		}
+		if ($response instanceof Exception) {
+			$code = $response->getCode() ? $response->getCode() : 'error_occurred';
+			$response = new WP_Error($code, $response->getMessage());
+		}
+		if ($response instanceof WP_Error) {
+			$response = $this->addEeErrorsToResponse($response);
+			$rest_response = $this->createRestResponseFromWpError($response);
+		} else {
+			$rest_response = new WP_REST_Response($response, 200);
+		}
+		$headers = array();
+		if ($this->debug_mode && is_array($this->debug_info)) {
+			foreach ($this->debug_info as $debug_key => $debug_info) {
+				if (is_array($debug_info)) {
+					$debug_info = wp_json_encode($debug_info);
+				}
+				$headers[ 'X-EE4-Debug-' . ucwords($debug_key) ] = $debug_info;
+			}
+		}
+		$headers = array_merge(
+			$headers,
+			$this->getResponseHeaders(),
+			$this->getHeadersFromEeNotices()
+		);
+		$rest_response->set_headers($headers);
+		return $rest_response;
+	}
+
+
+	/**
+	 * Converts the \WP_Error into `WP_REST_Response.
+	 * Mostly this is just a copy-and-paste from \WP_REST_Server::error_to_response
+	 * (which is protected)
+	 *
+	 * @param WP_Error $wp_error
+	 * @return WP_REST_Response
+	 */
+	protected function createRestResponseFromWpError(WP_Error $wp_error)
+	{
+		$error_data = $wp_error->get_error_data();
+		if (is_array($error_data) && isset($error_data['status'])) {
+			$status = $error_data['status'];
+		} else {
+			$status = 500;
+		}
+		$errors = array();
+		foreach ((array) $wp_error->errors as $code => $messages) {
+			foreach ((array) $messages as $message) {
+				$errors[] = array(
+					'code'    => $code,
+					'message' => $message,
+					'data'    => $wp_error->get_error_data($code),
+				);
+			}
+		}
+		$data = isset($errors[0]) ? $errors[0] : array();
+		if (count($errors) > 1) {
+			// Remove the primary error.
+			array_shift($errors);
+			$data['additional_errors'] = $errors;
+		}
+		return new WP_REST_Response($data, $status);
+	}
+
+
+	/**
+	 * Array of headers derived from EE success, attention, and error messages
+	 *
+	 * @return array
+	 */
+	protected function getHeadersFromEeNotices()
+	{
+		$headers = array();
+		$notices = EE_Error::get_raw_notices();
+		foreach ($notices as $notice_type => $sub_notices) {
+			if (! is_array($sub_notices)) {
+				continue;
+			}
+			foreach ($sub_notices as $notice_code => $sub_notice) {
+				$headers[ 'X-EE4-Notices-'
+						  . EEH_Inflector::humanize($notice_type)
+						  . '['
+						  . $notice_code
+						  . ']' ] = strip_tags($sub_notice);
+			}
+		}
+		return apply_filters(
+			'FHEE__EventEspresso\core\libraries\rest_api\controllers\Base___get_headers_from_ee_notices__return',
+			$headers,
+			$this->requested_version,
+			$notices
+		);
+	}
+
+
+	/**
+	 * Finds which version of the API was requested given the route, and returns it.
+	 * eg in a request to "mysite.com/wp-json/ee/v4.8.29/events/123" this would return
+	 * "4.8.29".
+	 * We should know hte requested version in this model though, so if no route is
+	 * provided just use what we set earlier
+	 *
+	 * @param string $route
+	 * @return string
+	 */
+	public function getRequestedVersion($route = null)
+	{
+		if ($route === null) {
+			return $this->requested_version;
+		}
+		$matches = $this->parseRoute(
+			$route,
+			'~' . EED_Core_Rest_Api::ee_api_namespace_for_regex . '~',
+			array('version')
+		);
+		if (isset($matches['version'])) {
+			return $matches['version'];
+		} else {
+			return EED_Core_Rest_Api::latest_rest_api_version();
+		}
+	}
+
+
+	/**
+	 * Applies the regex to the route, then creates an array using the values of
+	 * $match_keys as keys (but ignores the full pattern match). Returns the array of matches.
+	 * For example, if you call
+	 * parse_route( '/ee/v4.8/events', '~\/ee\/v([^/]*)\/(.*)~', array( 'version', 'model' ) )
+	 * it will return array( 'version' => '4.8', 'model' => 'events' )
+	 *
+	 * @param string $route
+	 * @param string $regex
+	 * @param array  $match_keys EXCLUDING matching the entire regex
+	 * @return array where  $match_keys are the keys (the first value of $match_keys
+	 *                           becomes the first key of the return value, etc. Eg passing in $match_keys of
+	 *                           array( 'model', 'id' ), will, if the regex is successful, will return
+	 *                           array( 'model' => 'foo', 'id' => 'bar' )
+	 * @throws EE_Error if it couldn't be parsed
+	 */
+	public function parseRoute($route, $regex, $match_keys)
+	{
+		$indexed_matches = array();
+		$success = preg_match($regex, $route, $matches);
+		if (is_array($matches)) {
+			// skip the overall regex match. Who cares
+			for ($i = 1; $i <= count($match_keys); $i++) {
+				if (! isset($matches[ $i ])) {
+					$success = false;
+				} else {
+					$indexed_matches[ $match_keys[ $i - 1 ] ] = $matches[ $i ];
+				}
+			}
+		}
+		if (! $success) {
+			throw new EE_Error(
+				__('We could not parse the URL. Please contact Event Espresso Support', 'event_espresso'),
+				'endpoint_parsing_error'
+			);
+		}
+		return $indexed_matches;
+	}
+
+
+	/**
+	 * Gets the body's params (either from JSON or parsed body), which EXCLUDES the GET params and URL params
+	 *
+	 * @param \WP_REST_Request $request
+	 * @return array
+	 */
+	protected function getBodyParams(\WP_REST_Request $request)
+	{
+		// $request->get_params();
+		return array_merge(
+			(array) $request->get_body_params(),
+			(array) $request->get_json_params()
+		);
+		// return array_diff_key(
+		//    $request->get_params(),
+		//     $request->get_url_params(),
+		//     $request->get_query_params()
+		// );
+	}
 }

core/services/container/CoffeeMaker.php

Doc Comments +2 added lines, -2 removed lines

@@ -69,7 +69,7 @@ 
 
 
     /**
-     * @param $type
+     * @param string $type
      * @throws \EventEspresso\core\exceptions\InvalidIdentifierException
      */
     public static function validateType($type)
@@ -127,7 +127,7 @@ 
      * Examines the constructor to determine which method should be used for instantiation
      *
      * @param \ReflectionClass $reflector
-     * @return mixed
+     * @return string
      * @throws InstantiationException
      */
     protected function resolveInstantiationMethod(\ReflectionClass $reflector)

Indentation +152 added lines, -152 removed lines

@@ -18,156 +18,156 @@
 abstract class CoffeeMaker implements CoffeeMakerInterface
 {
 
-    /**
-     * Indicates that CoffeeMaker should construct a NEW entity instance from the provided arguments (if given)
-     */
-    const BREW_NEW = 'new';
-
-    /**
-     * Indicates that CoffeeMaker should always return a SHARED instance
-     */
-    const BREW_SHARED = 'shared';
-
-    /**
-     * Indicates that CoffeeMaker should only load the file/class/interface but NOT instantiate
-     */
-    const BREW_LOAD_ONLY = 'load_only';
-
-
-    /**
-     * @var CoffeePotInterface $coffee_pot
-     */
-    private $coffee_pot;
-
-    /**
-     * @var DependencyInjector $injector
-     */
-    private $injector;
-
-
-    /**
-     * @return array
-     */
-    public static function getTypes()
-    {
-        return (array) apply_filters(
-            'FHEE__EventEspresso\core\services\container\CoffeeMaker__getTypes',
-            array(
-                CoffeeMaker::BREW_NEW,
-                CoffeeMaker::BREW_SHARED,
-                CoffeeMaker::BREW_LOAD_ONLY,
-            )
-        );
-    }
-
-
-    /**
-     * @param $type
-     * @throws \EventEspresso\core\exceptions\InvalidIdentifierException
-     */
-    public static function validateType($type)
-    {
-        $types = CoffeeMaker::getTypes();
-        if (! in_array($type, $types, true)) {
-            throw new InvalidIdentifierException(
-                is_object($type) ? get_class($type) : gettype($type),
-                __(
-                    'recipe type (one of the class constants on \EventEspresso\core\services\container\CoffeeMaker)',
-                    'event_espresso'
-                )
-            );
-        }
-        return $type;
-    }
-
-
-    /**
-     * CoffeeMaker constructor.
-     *
-     * @param CoffeePotInterface $coffee_pot
-     * @param InjectorInterface  $injector
-     */
-    public function __construct(CoffeePotInterface $coffee_pot, InjectorInterface $injector)
-    {
-        $this->coffee_pot = $coffee_pot;
-        $this->injector = $injector;
-    }
-
-
-    /**
-     * @return \EventEspresso\core\services\container\CoffeePotInterface
-     */
-    protected function coffeePot()
-    {
-        return $this->coffee_pot;
-    }
-
-
-    /**
-     * @return \EventEspresso\core\services\container\DependencyInjector
-     */
-    protected function injector()
-    {
-        return $this->injector;
-    }
-
-
-    /**
-     * Examines the constructor to determine which method should be used for instantiation
-     *
-     * @param \ReflectionClass $reflector
-     * @return mixed
-     * @throws InstantiationException
-     */
-    protected function resolveInstantiationMethod(\ReflectionClass $reflector)
-    {
-        if ($reflector->getConstructor() === null) {
-            return 'NewInstance';
-        }
-        if ($reflector->isInstantiable()) {
-            return 'NewInstanceArgs';
-        }
-        if (method_exists($reflector->getName(), 'instance')) {
-            return 'instance';
-        }
-        if (method_exists($reflector->getName(), 'new_instance')) {
-            return 'new_instance';
-        }
-        if (method_exists($reflector->getName(), 'new_instance_from_db')) {
-            return 'new_instance_from_db';
-        }
-        throw new InstantiationException($reflector->getName());
-    }
-
-
-    /**
-     * Ensures files for classes that are not PSR-4 compatible are loaded
-     * and then verifies that classes exist where applicable
-     *
-     * @param RecipeInterface $recipe
-     * @return bool
-     * @throws InvalidClassException
-     */
-    protected function resolveClassAndFilepath(RecipeInterface $recipe)
-    {
-        $paths = $recipe->paths();
-        if (! empty($paths)) {
-            foreach ($paths as $path) {
-                if (strpos($path, '*') === false && is_readable($path)) {
-                    require_once($path);
-                }
-            }
-        }
-        // re: using "false" for class_exists() second param:
-        // if a class name is not already known to PHP, then class_exists() will run through
-        // all of the registered spl_autoload functions until it either finds the class,
-        // or gets to the end of the registered spl_autoload functions.
-        // When the second parameter is true, it will also attempt to load the class file,
-        // but it will also trigger an error if the class can not be loaded.
-        // We don't want that extra error in the mix, so we have set the second param to "false"
-        if ($recipe->type() !== CoffeeMaker::BREW_LOAD_ONLY && ! class_exists($recipe->fqcn(), false)) {
-            throw new InvalidClassException($recipe->identifier());
-        }
-        return true;
-    }
+	/**
+	 * Indicates that CoffeeMaker should construct a NEW entity instance from the provided arguments (if given)
+	 */
+	const BREW_NEW = 'new';
+
+	/**
+	 * Indicates that CoffeeMaker should always return a SHARED instance
+	 */
+	const BREW_SHARED = 'shared';
+
+	/**
+	 * Indicates that CoffeeMaker should only load the file/class/interface but NOT instantiate
+	 */
+	const BREW_LOAD_ONLY = 'load_only';
+
+
+	/**
+	 * @var CoffeePotInterface $coffee_pot
+	 */
+	private $coffee_pot;
+
+	/**
+	 * @var DependencyInjector $injector
+	 */
+	private $injector;
+
+
+	/**
+	 * @return array
+	 */
+	public static function getTypes()
+	{
+		return (array) apply_filters(
+			'FHEE__EventEspresso\core\services\container\CoffeeMaker__getTypes',
+			array(
+				CoffeeMaker::BREW_NEW,
+				CoffeeMaker::BREW_SHARED,
+				CoffeeMaker::BREW_LOAD_ONLY,
+			)
+		);
+	}
+
+
+	/**
+	 * @param $type
+	 * @throws \EventEspresso\core\exceptions\InvalidIdentifierException
+	 */
+	public static function validateType($type)
+	{
+		$types = CoffeeMaker::getTypes();
+		if (! in_array($type, $types, true)) {
+			throw new InvalidIdentifierException(
+				is_object($type) ? get_class($type) : gettype($type),
+				__(
+					'recipe type (one of the class constants on \EventEspresso\core\services\container\CoffeeMaker)',
+					'event_espresso'
+				)
+			);
+		}
+		return $type;
+	}
+
+
+	/**
+	 * CoffeeMaker constructor.
+	 *
+	 * @param CoffeePotInterface $coffee_pot
+	 * @param InjectorInterface  $injector
+	 */
+	public function __construct(CoffeePotInterface $coffee_pot, InjectorInterface $injector)
+	{
+		$this->coffee_pot = $coffee_pot;
+		$this->injector = $injector;
+	}
+
+
+	/**
+	 * @return \EventEspresso\core\services\container\CoffeePotInterface
+	 */
+	protected function coffeePot()
+	{
+		return $this->coffee_pot;
+	}
+
+
+	/**
+	 * @return \EventEspresso\core\services\container\DependencyInjector
+	 */
+	protected function injector()
+	{
+		return $this->injector;
+	}
+
+
+	/**
+	 * Examines the constructor to determine which method should be used for instantiation
+	 *
+	 * @param \ReflectionClass $reflector
+	 * @return mixed
+	 * @throws InstantiationException
+	 */
+	protected function resolveInstantiationMethod(\ReflectionClass $reflector)
+	{
+		if ($reflector->getConstructor() === null) {
+			return 'NewInstance';
+		}
+		if ($reflector->isInstantiable()) {
+			return 'NewInstanceArgs';
+		}
+		if (method_exists($reflector->getName(), 'instance')) {
+			return 'instance';
+		}
+		if (method_exists($reflector->getName(), 'new_instance')) {
+			return 'new_instance';
+		}
+		if (method_exists($reflector->getName(), 'new_instance_from_db')) {
+			return 'new_instance_from_db';
+		}
+		throw new InstantiationException($reflector->getName());
+	}
+
+
+	/**
+	 * Ensures files for classes that are not PSR-4 compatible are loaded
+	 * and then verifies that classes exist where applicable
+	 *
+	 * @param RecipeInterface $recipe
+	 * @return bool
+	 * @throws InvalidClassException
+	 */
+	protected function resolveClassAndFilepath(RecipeInterface $recipe)
+	{
+		$paths = $recipe->paths();
+		if (! empty($paths)) {
+			foreach ($paths as $path) {
+				if (strpos($path, '*') === false && is_readable($path)) {
+					require_once($path);
+				}
+			}
+		}
+		// re: using "false" for class_exists() second param:
+		// if a class name is not already known to PHP, then class_exists() will run through
+		// all of the registered spl_autoload functions until it either finds the class,
+		// or gets to the end of the registered spl_autoload functions.
+		// When the second parameter is true, it will also attempt to load the class file,
+		// but it will also trigger an error if the class can not be loaded.
+		// We don't want that extra error in the mix, so we have set the second param to "false"
+		if ($recipe->type() !== CoffeeMaker::BREW_LOAD_ONLY && ! class_exists($recipe->fqcn(), false)) {
+			throw new InvalidClassException($recipe->identifier());
+		}
+		return true;
+	}
 }

Spacing +2 added lines, -2 removed lines

@@ -68,7 +68,7 @@ 
     public static function validateType($type)
     {
         $types = CoffeeMaker::getTypes();
-        if (! in_array($type, $types, true)) {
+        if ( ! in_array($type, $types, true)) {
             throw new InvalidIdentifierException(
                 is_object($type) ? get_class($type) : gettype($type),
                 __(
@@ -151,7 +151,7 @@ 
     protected function resolveClassAndFilepath(RecipeInterface $recipe)
     {
         $paths = $recipe->paths();
-        if (! empty($paths)) {
+        if ( ! empty($paths)) {
             foreach ($paths as $path) {
                 if (strpos($path, '*') === false && is_readable($path)) {
                     require_once($path);

core/services/container/CoffeeShop.php

Doc Comments +2 added lines, -2 removed lines

@@ -361,7 +361,7 @@ 
      * Adds instructions on how to brew objects
      *
      * @param RecipeInterface $recipe
-     * @return mixed
+     * @return boolean
      * @throws InvalidIdentifierException
      */
     public function addRecipe(RecipeInterface $recipe)
@@ -461,7 +461,7 @@ 
     /**
      * Adds a service to one of the internal collections
      *
-     * @param        $identifier
+     * @param        string $identifier
      * @param array  $arguments
      * @param string $type
      * @return mixed

Indentation +565 added lines, -565 removed lines

@@ -30,569 +30,569 @@
 {
 
 
-    /**
-     * This was the best coffee related name I could think of to represent class name "aliases"
-     * So classes can be found via an alias identifier,
-     * that is revealed when it is run through... the filters... eh? get it?
-     *
-     * @var array $filters
-     */
-    private $filters;
-
-    /**
-     * These are the classes that will actually build the objects (to order of course)
-     *
-     * @var array $coffee_makers
-     */
-    private $coffee_makers;
-
-    /**
-     * where the instantiated "singleton" objects are stored
-     *
-     * @var CollectionInterface $carafe
-     */
-    private $carafe;
-
-    /**
-     * collection of Recipes that instruct us how to brew objects
-     *
-     * @var CollectionInterface $recipes
-     */
-    private $recipes;
-
-    /**
-     * collection of closures for brewing objects
-     *
-     * @var CollectionInterface $reservoir
-     */
-    private $reservoir;
-
-
-    /**
-     * CoffeeShop constructor
-     *
-     * @throws InvalidInterfaceException
-     */
-    public function __construct()
-    {
-        // array for storing class aliases
-        $this->filters = array();
-        // create collection for storing shared services
-        $this->carafe = new LooseCollection('');
-        // create collection for storing recipes that tell us how to build services and entities
-        $this->recipes = new Collection('EventEspresso\core\services\container\RecipeInterface');
-        // create collection for storing closures for constructing new entities
-        $this->reservoir = new Collection('Closure');
-        // create collection for storing the generators that build our services and entity closures
-        $this->coffee_makers = new Collection('EventEspresso\core\services\container\CoffeeMakerInterface');
-    }
-
-
-    /**
-     * Returns true if the container can return an entry for the given identifier.
-     * Returns false otherwise.
-     * `has($identifier)` returning true does not mean that `get($identifier)` will not throw an exception.
-     * It does however mean that `get($identifier)` will not throw a `ServiceNotFoundException`.
-     *
-     * @param string $identifier  Identifier of the entry to look for.
-     *                            Typically a Fully Qualified Class Name
-     * @return boolean
-     * @throws InvalidIdentifierException
-     */
-    public function has($identifier)
-    {
-        $identifier = $this->filterIdentifier($identifier);
-        return $this->carafe->has($identifier);
-    }
-
-
-    /**
-     * finds a previously brewed (SHARED) service and returns it
-     *
-     * @param  string $identifier Identifier for the entity class to be constructed.
-     *                            Typically a Fully Qualified Class Name
-     * @return mixed
-     * @throws InvalidIdentifierException
-     * @throws ServiceNotFoundException No service was found for this identifier.
-     */
-    public function get($identifier)
-    {
-        $identifier = $this->filterIdentifier($identifier);
-        if ($this->carafe->has($identifier)) {
-            return $this->carafe->get($identifier);
-        }
-        throw new ServiceNotFoundException($identifier);
-    }
-
-
-    /**
-     * returns an instance of the requested entity type using the supplied arguments.
-     * If a shared service is requested and an instance is already in the carafe, then it will be returned.
-     * If it is not already in the carafe, then the service will be constructed, added to the carafe, and returned
-     * If the request is for a new entity and a closure exists in the reservoir for creating it,
-     * then a new entity will be instantiated from the closure and returned.
-     * If a closure does not exist, then one will be built and added to the reservoir
-     * before instantiating the requested entity.
-     *
-     * @param  string $identifier Identifier for the entity class to be constructed.
-     *                            Typically a Fully Qualified Class Name
-     * @param array   $arguments  an array of arguments to be passed to the entity constructor
-     * @param string  $type
-     * @return mixed
-     * @throws OutOfBoundsException
-     * @throws InstantiationException
-     * @throws InvalidDataTypeException
-     * @throws InvalidClassException
-     * @throws InvalidIdentifierException
-     * @throws ServiceExistsException
-     * @throws ServiceNotFoundException No service was found for this identifier.
-     */
-    public function brew($identifier, $arguments = array(), $type = '')
-    {
-        // resolve any class aliases that may exist
-        $identifier = $this->filterIdentifier($identifier);
-        // is a shared service being requested and already exists in the carafe?
-        $brewed = $this->getShared($identifier, $type);
-        // then return whatever was found
-        if ($brewed !== false) {
-            return $brewed;
-        }
-        // if the reservoir doesn't have a closure already for the requested identifier,
-        // then neither a shared service nor a closure for making entities has been built yet
-        if (! $this->reservoir->has($identifier)) {
-            // so let's brew something up and add it to the proper collection
-            $brewed = $this->makeCoffee($identifier, $arguments, $type);
-        }
-        // did the requested class only require loading, and if so, was that successful?
-        if ($this->brewedLoadOnly($brewed, $identifier, $type) === true) {
-            return true;
-        }
-        // was the brewed item a callable factory function ?
-        if (is_callable($brewed)) {
-            // then instantiate a new entity from the cached closure
-            return $brewed($arguments);
-        }
-        if ($brewed) {
-            // requested object was a shared entity, so attempt to get it from the carafe again
-            // because if it wasn't there before, then it should have just been brewed and added,
-            // but if it still isn't there, then this time the thrown ServiceNotFoundException will not be caught
-            return $this->get($identifier);
-        }
-        // if identifier is for a non-shared entity,
-        // then either a cached closure already existed, or was just brewed
-        return $this->brewedClosure($identifier, $arguments);
-    }
-
-
-    /**
-     * @param string $identifier
-     * @param string $type
-     * @return bool|mixed
-     * @throws InvalidIdentifierException
-     */
-    protected function getShared($identifier, $type)
-    {
-        try {
-            if (empty($type) || $type === CoffeeMaker::BREW_SHARED) {
-                // if a shared service was requested and an instance is in the carafe, then return it
-                return $this->get($identifier);
-            }
-        } catch (ServiceNotFoundException $e) {
-            // if not then we'll just catch the ServiceNotFoundException but not do anything just yet,
-            // and instead, attempt to build whatever was requested
-        }
-        return false;
-    }
-
-
-    /**
-     * @param mixed  $brewed
-     * @param string $identifier
-     * @param string $type
-     * @return bool
-     * @throws InvalidClassException
-     * @throws InvalidDataTypeException
-     * @throws InvalidIdentifierException
-     * @throws OutOfBoundsException
-     * @throws ServiceExistsException
-     * @throws ServiceNotFoundException
-     */
-    protected function brewedLoadOnly($brewed, $identifier, $type)
-    {
-        if ($type === CoffeeMaker::BREW_LOAD_ONLY) {
-            if ($brewed !== true) {
-                throw new ServiceNotFoundException(
-                    sprintf(
-                        esc_html__(
-                            'The "%1$s" class could not be loaded.',
-                            'event_espresso'
-                        ),
-                        $identifier
-                    )
-                );
-            }
-            return true;
-        }
-        return false;
-    }
-
-
-    /**
-     * @param string $identifier
-     * @param array  $arguments
-     * @return mixed
-     * @throws InstantiationException
-     */
-    protected function brewedClosure($identifier, array $arguments)
-    {
-        $closure = $this->reservoir->get($identifier);
-        if (empty($closure)) {
-            throw new InstantiationException(
-                sprintf(
-                    esc_html__(
-                        'Could not brew an instance of "%1$s".',
-                        'event_espresso'
-                    ),
-                    $identifier
-                )
-            );
-        }
-        return $closure($arguments);
-    }
-
-
-    /**
-     * @param CoffeeMakerInterface $coffee_maker
-     * @param string               $type
-     * @return bool
-     * @throws InvalidIdentifierException
-     * @throws InvalidEntityException
-     */
-    public function addCoffeeMaker(CoffeeMakerInterface $coffee_maker, $type)
-    {
-        $type = CoffeeMaker::validateType($type);
-        return $this->coffee_makers->add($coffee_maker, $type);
-    }
-
-
-    /**
-     * @param string   $identifier
-     * @param callable $closure
-     * @return callable|null
-     * @throws InvalidIdentifierException
-     * @throws InvalidDataTypeException
-     */
-    public function addClosure($identifier, $closure)
-    {
-        if (! is_callable($closure)) {
-            throw new InvalidDataTypeException('$closure', $closure, 'Closure');
-        }
-        $identifier = $this->processIdentifier($identifier);
-        if ($this->reservoir->add($closure, $identifier)) {
-            return $closure;
-        }
-        return null;
-    }
-
-
-    /**
-     * @param string $identifier
-     * @return boolean
-     * @throws InvalidIdentifierException
-     */
-    public function removeClosure($identifier)
-    {
-        $identifier = $this->processIdentifier($identifier);
-        if ($this->reservoir->has($identifier)) {
-            return $this->reservoir->remove($this->reservoir->get($identifier));
-        }
-        return false;
-    }
-
-
-    /**
-     * @param  string $identifier Identifier for the entity class that the service applies to
-     *                            Typically a Fully Qualified Class Name
-     * @param mixed   $service
-     * @return bool
-     * @throws \EventEspresso\core\services\container\exceptions\InvalidServiceException
-     * @throws InvalidIdentifierException
-     */
-    public function addService($identifier, $service)
-    {
-        $identifier = $this->processIdentifier($identifier);
-        $service = $this->validateService($identifier, $service);
-        return $this->carafe->add($service, $identifier);
-    }
-
-
-    /**
-     * @param string $identifier
-     * @return boolean
-     * @throws InvalidIdentifierException
-     */
-    public function removeService($identifier)
-    {
-        $identifier = $this->processIdentifier($identifier);
-        if ($this->carafe->has($identifier)) {
-            return $this->carafe->remove($this->carafe->get($identifier));
-        }
-        return false;
-    }
-
-
-    /**
-     * Adds instructions on how to brew objects
-     *
-     * @param RecipeInterface $recipe
-     * @return mixed
-     * @throws InvalidIdentifierException
-     */
-    public function addRecipe(RecipeInterface $recipe)
-    {
-        $this->addAliases($recipe->identifier(), $recipe->filters());
-        $identifier = $this->processIdentifier($recipe->identifier());
-        return $this->recipes->add($recipe, $identifier);
-    }
-
-
-    /**
-     * @param string $identifier The Recipe's identifier
-     * @return boolean
-     * @throws InvalidIdentifierException
-     */
-    public function removeRecipe($identifier)
-    {
-        $identifier = $this->processIdentifier($identifier);
-        if ($this->recipes->has($identifier)) {
-            return $this->recipes->remove($this->recipes->get($identifier));
-        }
-        return false;
-    }
-
-
-    /**
-     * Get instructions on how to brew objects
-     *
-     * @param  string $identifier Identifier for the entity class that the recipe applies to
-     *                            Typically a Fully Qualified Class Name
-     * @param string  $type
-     * @return RecipeInterface
-     * @throws OutOfBoundsException
-     * @throws InvalidIdentifierException
-     */
-    public function getRecipe($identifier, $type = '')
-    {
-        $identifier = $this->processIdentifier($identifier);
-        if ($this->recipes->has($identifier)) {
-            return $this->recipes->get($identifier);
-        }
-        $default_recipes = $this->getDefaultRecipes();
-        $matches = array();
-        foreach ($default_recipes as $wildcard => $default_recipe) {
-            // is the wildcard recipe prefix in the identifier ?
-            if (strpos($identifier, $wildcard) !== false) {
-                // track matches and use the number of wildcard characters matched for the key
-                $matches[ strlen($wildcard) ] = $default_recipe;
-            }
-        }
-        if (count($matches) > 0) {
-            // sort our recipes by the number of wildcard characters matched
-            ksort($matches);
-            // then grab the last recipe form the list, since it had the most matching characters
-            $match = array_pop($matches);
-            // since we are using a default recipe, we need to set it's identifier and fqcn
-            return $this->copyDefaultRecipe($match, $identifier, $type);
-        }
-        if ($this->recipes->has(Recipe::DEFAULT_ID)) {
-            // since we are using a default recipe, we need to set it's identifier and fqcn
-            return $this->copyDefaultRecipe($this->recipes->get(Recipe::DEFAULT_ID), $identifier, $type);
-        }
-        throw new OutOfBoundsException(
-            sprintf(
-                __('Could not brew coffee because no recipes were found for class "%1$s".', 'event_espresso'),
-                $identifier
-            )
-        );
-    }
-
-
-    /**
-     * adds class name aliases to list of filters
-     *
-     * @param  string       $identifier Identifier for the entity class that the alias applies to
-     *                                  Typically a Fully Qualified Class Name
-     * @param  array|string $aliases
-     * @return void
-     * @throws InvalidIdentifierException
-     */
-    public function addAliases($identifier, $aliases)
-    {
-        if (empty($aliases)) {
-            return;
-        }
-        $identifier = $this->processIdentifier($identifier);
-        foreach ((array) $aliases as $alias) {
-            $this->filters[ $this->processIdentifier($alias) ] = $identifier;
-        }
-    }
-
-
-    /**
-     * Adds a service to one of the internal collections
-     *
-     * @param        $identifier
-     * @param array  $arguments
-     * @param string $type
-     * @return mixed
-     * @throws InvalidDataTypeException
-     * @throws InvalidClassException
-     * @throws OutOfBoundsException
-     * @throws InvalidIdentifierException
-     * @throws ServiceExistsException
-     */
-    private function makeCoffee($identifier, $arguments = array(), $type = '')
-    {
-        if ((empty($type) || $type === CoffeeMaker::BREW_SHARED) && $this->has($identifier)) {
-            throw new ServiceExistsException($identifier);
-        }
-        $identifier = $this->filterIdentifier($identifier);
-        $recipe = $this->getRecipe($identifier, $type);
-        $type = ! empty($type) ? $type : $recipe->type();
-        $coffee_maker = $this->getCoffeeMaker($type);
-        return $coffee_maker->brew($recipe, $arguments);
-    }
-
-
-    /**
-     * filters alias identifiers to find the real class name
-     *
-     * @param  string $identifier Identifier for the entity class that the filter applies to
-     *                            Typically a Fully Qualified Class Name
-     * @return string
-     * @throws InvalidIdentifierException
-     */
-    private function filterIdentifier($identifier)
-    {
-        $identifier = $this->processIdentifier($identifier);
-        return isset($this->filters[ $identifier ]) && ! empty($this->filters[ $identifier ])
-            ? $this->filters[ $identifier ]
-            : $identifier;
-    }
-
-
-    /**
-     * verifies and standardizes identifiers
-     *
-     * @param  string $identifier Identifier for the entity class
-     *                            Typically a Fully Qualified Class Name
-     * @return string
-     * @throws InvalidIdentifierException
-     */
-    private function processIdentifier($identifier)
-    {
-        if (! is_string($identifier)) {
-            throw new InvalidIdentifierException(
-                is_object($identifier) ? get_class($identifier) : gettype($identifier),
-                '\Fully\Qualified\ClassName'
-            );
-        }
-        return ltrim($identifier, '\\');
-    }
-
-
-    /**
-     * @param string $type
-     * @return CoffeeMakerInterface
-     * @throws OutOfBoundsException
-     * @throws InvalidDataTypeException
-     * @throws InvalidClassException
-     */
-    private function getCoffeeMaker($type)
-    {
-        if (! $this->coffee_makers->has($type)) {
-            throw new OutOfBoundsException(
-                __('The requested coffee maker is either missing or invalid.', 'event_espresso')
-            );
-        }
-        return $this->coffee_makers->get($type);
-    }
-
-
-    /**
-     * Retrieves all recipes that use a wildcard "*" in their identifier
-     * This allows recipes to be set up for handling
-     * legacy classes that do not support PSR-4 autoloading.
-     * for example:
-     * using "EEM_*" for a recipe identifier would target all legacy models like EEM_Attendee
-     *
-     * @return array
-     */
-    private function getDefaultRecipes()
-    {
-        $default_recipes = array();
-        $this->recipes->rewind();
-        while ($this->recipes->valid()) {
-            $identifier = $this->recipes->getInfo();
-            // does this recipe use a wildcard ? (but is NOT the global default)
-            if ($identifier !== Recipe::DEFAULT_ID && strpos($identifier, '*') !== false) {
-                // strip the wildcard and use identifier as key
-                $default_recipes[ str_replace('*', '', $identifier) ] = $this->recipes->current();
-            }
-            $this->recipes->next();
-        }
-        return $default_recipes;
-    }
-
-
-    /**
-     * clones a default recipe and then copies details
-     * from the incoming request to it so that it can be used
-     *
-     * @param RecipeInterface $default_recipe
-     * @param string          $identifier
-     * @param string          $type
-     * @return RecipeInterface
-     */
-    private function copyDefaultRecipe(RecipeInterface $default_recipe, $identifier, $type = '')
-    {
-        $recipe = clone $default_recipe;
-        if (! empty($type)) {
-            $recipe->setType($type);
-        }
-        // is this the base default recipe ?
-        if ($default_recipe->identifier() === Recipe::DEFAULT_ID) {
-            $recipe->setIdentifier($identifier);
-            $recipe->setFqcn($identifier);
-            return $recipe;
-        }
-        $recipe->setIdentifier($identifier);
-        foreach ($default_recipe->paths() as $path) {
-            $path = str_replace('*', $identifier, $path);
-            if (is_readable($path)) {
-                $recipe->setPaths($path);
-            }
-        }
-        $recipe->setFqcn($identifier);
-        return $recipe;
-    }
-
-
-    /**
-     * @param  string $identifier Identifier for the entity class that the service applies to
-     *                            Typically a Fully Qualified Class Name
-     * @param mixed   $service
-     * @return mixed
-     * @throws InvalidServiceException
-     */
-    private function validateService($identifier, $service)
-    {
-        if (! is_object($service)) {
-            throw new InvalidServiceException(
-                $identifier,
-                $service
-            );
-        }
-        return $service;
-    }
+	/**
+	 * This was the best coffee related name I could think of to represent class name "aliases"
+	 * So classes can be found via an alias identifier,
+	 * that is revealed when it is run through... the filters... eh? get it?
+	 *
+	 * @var array $filters
+	 */
+	private $filters;
+
+	/**
+	 * These are the classes that will actually build the objects (to order of course)
+	 *
+	 * @var array $coffee_makers
+	 */
+	private $coffee_makers;
+
+	/**
+	 * where the instantiated "singleton" objects are stored
+	 *
+	 * @var CollectionInterface $carafe
+	 */
+	private $carafe;
+
+	/**
+	 * collection of Recipes that instruct us how to brew objects
+	 *
+	 * @var CollectionInterface $recipes
+	 */
+	private $recipes;
+
+	/**
+	 * collection of closures for brewing objects
+	 *
+	 * @var CollectionInterface $reservoir
+	 */
+	private $reservoir;
+
+
+	/**
+	 * CoffeeShop constructor
+	 *
+	 * @throws InvalidInterfaceException
+	 */
+	public function __construct()
+	{
+		// array for storing class aliases
+		$this->filters = array();
+		// create collection for storing shared services
+		$this->carafe = new LooseCollection('');
+		// create collection for storing recipes that tell us how to build services and entities
+		$this->recipes = new Collection('EventEspresso\core\services\container\RecipeInterface');
+		// create collection for storing closures for constructing new entities
+		$this->reservoir = new Collection('Closure');
+		// create collection for storing the generators that build our services and entity closures
+		$this->coffee_makers = new Collection('EventEspresso\core\services\container\CoffeeMakerInterface');
+	}
+
+
+	/**
+	 * Returns true if the container can return an entry for the given identifier.
+	 * Returns false otherwise.
+	 * `has($identifier)` returning true does not mean that `get($identifier)` will not throw an exception.
+	 * It does however mean that `get($identifier)` will not throw a `ServiceNotFoundException`.
+	 *
+	 * @param string $identifier  Identifier of the entry to look for.
+	 *                            Typically a Fully Qualified Class Name
+	 * @return boolean
+	 * @throws InvalidIdentifierException
+	 */
+	public function has($identifier)
+	{
+		$identifier = $this->filterIdentifier($identifier);
+		return $this->carafe->has($identifier);
+	}
+
+
+	/**
+	 * finds a previously brewed (SHARED) service and returns it
+	 *
+	 * @param  string $identifier Identifier for the entity class to be constructed.
+	 *                            Typically a Fully Qualified Class Name
+	 * @return mixed
+	 * @throws InvalidIdentifierException
+	 * @throws ServiceNotFoundException No service was found for this identifier.
+	 */
+	public function get($identifier)
+	{
+		$identifier = $this->filterIdentifier($identifier);
+		if ($this->carafe->has($identifier)) {
+			return $this->carafe->get($identifier);
+		}
+		throw new ServiceNotFoundException($identifier);
+	}
+
+
+	/**
+	 * returns an instance of the requested entity type using the supplied arguments.
+	 * If a shared service is requested and an instance is already in the carafe, then it will be returned.
+	 * If it is not already in the carafe, then the service will be constructed, added to the carafe, and returned
+	 * If the request is for a new entity and a closure exists in the reservoir for creating it,
+	 * then a new entity will be instantiated from the closure and returned.
+	 * If a closure does not exist, then one will be built and added to the reservoir
+	 * before instantiating the requested entity.
+	 *
+	 * @param  string $identifier Identifier for the entity class to be constructed.
+	 *                            Typically a Fully Qualified Class Name
+	 * @param array   $arguments  an array of arguments to be passed to the entity constructor
+	 * @param string  $type
+	 * @return mixed
+	 * @throws OutOfBoundsException
+	 * @throws InstantiationException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidClassException
+	 * @throws InvalidIdentifierException
+	 * @throws ServiceExistsException
+	 * @throws ServiceNotFoundException No service was found for this identifier.
+	 */
+	public function brew($identifier, $arguments = array(), $type = '')
+	{
+		// resolve any class aliases that may exist
+		$identifier = $this->filterIdentifier($identifier);
+		// is a shared service being requested and already exists in the carafe?
+		$brewed = $this->getShared($identifier, $type);
+		// then return whatever was found
+		if ($brewed !== false) {
+			return $brewed;
+		}
+		// if the reservoir doesn't have a closure already for the requested identifier,
+		// then neither a shared service nor a closure for making entities has been built yet
+		if (! $this->reservoir->has($identifier)) {
+			// so let's brew something up and add it to the proper collection
+			$brewed = $this->makeCoffee($identifier, $arguments, $type);
+		}
+		// did the requested class only require loading, and if so, was that successful?
+		if ($this->brewedLoadOnly($brewed, $identifier, $type) === true) {
+			return true;
+		}
+		// was the brewed item a callable factory function ?
+		if (is_callable($brewed)) {
+			// then instantiate a new entity from the cached closure
+			return $brewed($arguments);
+		}
+		if ($brewed) {
+			// requested object was a shared entity, so attempt to get it from the carafe again
+			// because if it wasn't there before, then it should have just been brewed and added,
+			// but if it still isn't there, then this time the thrown ServiceNotFoundException will not be caught
+			return $this->get($identifier);
+		}
+		// if identifier is for a non-shared entity,
+		// then either a cached closure already existed, or was just brewed
+		return $this->brewedClosure($identifier, $arguments);
+	}
+
+
+	/**
+	 * @param string $identifier
+	 * @param string $type
+	 * @return bool|mixed
+	 * @throws InvalidIdentifierException
+	 */
+	protected function getShared($identifier, $type)
+	{
+		try {
+			if (empty($type) || $type === CoffeeMaker::BREW_SHARED) {
+				// if a shared service was requested and an instance is in the carafe, then return it
+				return $this->get($identifier);
+			}
+		} catch (ServiceNotFoundException $e) {
+			// if not then we'll just catch the ServiceNotFoundException but not do anything just yet,
+			// and instead, attempt to build whatever was requested
+		}
+		return false;
+	}
+
+
+	/**
+	 * @param mixed  $brewed
+	 * @param string $identifier
+	 * @param string $type
+	 * @return bool
+	 * @throws InvalidClassException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidIdentifierException
+	 * @throws OutOfBoundsException
+	 * @throws ServiceExistsException
+	 * @throws ServiceNotFoundException
+	 */
+	protected function brewedLoadOnly($brewed, $identifier, $type)
+	{
+		if ($type === CoffeeMaker::BREW_LOAD_ONLY) {
+			if ($brewed !== true) {
+				throw new ServiceNotFoundException(
+					sprintf(
+						esc_html__(
+							'The "%1$s" class could not be loaded.',
+							'event_espresso'
+						),
+						$identifier
+					)
+				);
+			}
+			return true;
+		}
+		return false;
+	}
+
+
+	/**
+	 * @param string $identifier
+	 * @param array  $arguments
+	 * @return mixed
+	 * @throws InstantiationException
+	 */
+	protected function brewedClosure($identifier, array $arguments)
+	{
+		$closure = $this->reservoir->get($identifier);
+		if (empty($closure)) {
+			throw new InstantiationException(
+				sprintf(
+					esc_html__(
+						'Could not brew an instance of "%1$s".',
+						'event_espresso'
+					),
+					$identifier
+				)
+			);
+		}
+		return $closure($arguments);
+	}
+
+
+	/**
+	 * @param CoffeeMakerInterface $coffee_maker
+	 * @param string               $type
+	 * @return bool
+	 * @throws InvalidIdentifierException
+	 * @throws InvalidEntityException
+	 */
+	public function addCoffeeMaker(CoffeeMakerInterface $coffee_maker, $type)
+	{
+		$type = CoffeeMaker::validateType($type);
+		return $this->coffee_makers->add($coffee_maker, $type);
+	}
+
+
+	/**
+	 * @param string   $identifier
+	 * @param callable $closure
+	 * @return callable|null
+	 * @throws InvalidIdentifierException
+	 * @throws InvalidDataTypeException
+	 */
+	public function addClosure($identifier, $closure)
+	{
+		if (! is_callable($closure)) {
+			throw new InvalidDataTypeException('$closure', $closure, 'Closure');
+		}
+		$identifier = $this->processIdentifier($identifier);
+		if ($this->reservoir->add($closure, $identifier)) {
+			return $closure;
+		}
+		return null;
+	}
+
+
+	/**
+	 * @param string $identifier
+	 * @return boolean
+	 * @throws InvalidIdentifierException
+	 */
+	public function removeClosure($identifier)
+	{
+		$identifier = $this->processIdentifier($identifier);
+		if ($this->reservoir->has($identifier)) {
+			return $this->reservoir->remove($this->reservoir->get($identifier));
+		}
+		return false;
+	}
+
+
+	/**
+	 * @param  string $identifier Identifier for the entity class that the service applies to
+	 *                            Typically a Fully Qualified Class Name
+	 * @param mixed   $service
+	 * @return bool
+	 * @throws \EventEspresso\core\services\container\exceptions\InvalidServiceException
+	 * @throws InvalidIdentifierException
+	 */
+	public function addService($identifier, $service)
+	{
+		$identifier = $this->processIdentifier($identifier);
+		$service = $this->validateService($identifier, $service);
+		return $this->carafe->add($service, $identifier);
+	}
+
+
+	/**
+	 * @param string $identifier
+	 * @return boolean
+	 * @throws InvalidIdentifierException
+	 */
+	public function removeService($identifier)
+	{
+		$identifier = $this->processIdentifier($identifier);
+		if ($this->carafe->has($identifier)) {
+			return $this->carafe->remove($this->carafe->get($identifier));
+		}
+		return false;
+	}
+
+
+	/**
+	 * Adds instructions on how to brew objects
+	 *
+	 * @param RecipeInterface $recipe
+	 * @return mixed
+	 * @throws InvalidIdentifierException
+	 */
+	public function addRecipe(RecipeInterface $recipe)
+	{
+		$this->addAliases($recipe->identifier(), $recipe->filters());
+		$identifier = $this->processIdentifier($recipe->identifier());
+		return $this->recipes->add($recipe, $identifier);
+	}
+
+
+	/**
+	 * @param string $identifier The Recipe's identifier
+	 * @return boolean
+	 * @throws InvalidIdentifierException
+	 */
+	public function removeRecipe($identifier)
+	{
+		$identifier = $this->processIdentifier($identifier);
+		if ($this->recipes->has($identifier)) {
+			return $this->recipes->remove($this->recipes->get($identifier));
+		}
+		return false;
+	}
+
+
+	/**
+	 * Get instructions on how to brew objects
+	 *
+	 * @param  string $identifier Identifier for the entity class that the recipe applies to
+	 *                            Typically a Fully Qualified Class Name
+	 * @param string  $type
+	 * @return RecipeInterface
+	 * @throws OutOfBoundsException
+	 * @throws InvalidIdentifierException
+	 */
+	public function getRecipe($identifier, $type = '')
+	{
+		$identifier = $this->processIdentifier($identifier);
+		if ($this->recipes->has($identifier)) {
+			return $this->recipes->get($identifier);
+		}
+		$default_recipes = $this->getDefaultRecipes();
+		$matches = array();
+		foreach ($default_recipes as $wildcard => $default_recipe) {
+			// is the wildcard recipe prefix in the identifier ?
+			if (strpos($identifier, $wildcard) !== false) {
+				// track matches and use the number of wildcard characters matched for the key
+				$matches[ strlen($wildcard) ] = $default_recipe;
+			}
+		}
+		if (count($matches) > 0) {
+			// sort our recipes by the number of wildcard characters matched
+			ksort($matches);
+			// then grab the last recipe form the list, since it had the most matching characters
+			$match = array_pop($matches);
+			// since we are using a default recipe, we need to set it's identifier and fqcn
+			return $this->copyDefaultRecipe($match, $identifier, $type);
+		}
+		if ($this->recipes->has(Recipe::DEFAULT_ID)) {
+			// since we are using a default recipe, we need to set it's identifier and fqcn
+			return $this->copyDefaultRecipe($this->recipes->get(Recipe::DEFAULT_ID), $identifier, $type);
+		}
+		throw new OutOfBoundsException(
+			sprintf(
+				__('Could not brew coffee because no recipes were found for class "%1$s".', 'event_espresso'),
+				$identifier
+			)
+		);
+	}
+
+
+	/**
+	 * adds class name aliases to list of filters
+	 *
+	 * @param  string       $identifier Identifier for the entity class that the alias applies to
+	 *                                  Typically a Fully Qualified Class Name
+	 * @param  array|string $aliases
+	 * @return void
+	 * @throws InvalidIdentifierException
+	 */
+	public function addAliases($identifier, $aliases)
+	{
+		if (empty($aliases)) {
+			return;
+		}
+		$identifier = $this->processIdentifier($identifier);
+		foreach ((array) $aliases as $alias) {
+			$this->filters[ $this->processIdentifier($alias) ] = $identifier;
+		}
+	}
+
+
+	/**
+	 * Adds a service to one of the internal collections
+	 *
+	 * @param        $identifier
+	 * @param array  $arguments
+	 * @param string $type
+	 * @return mixed
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidClassException
+	 * @throws OutOfBoundsException
+	 * @throws InvalidIdentifierException
+	 * @throws ServiceExistsException
+	 */
+	private function makeCoffee($identifier, $arguments = array(), $type = '')
+	{
+		if ((empty($type) || $type === CoffeeMaker::BREW_SHARED) && $this->has($identifier)) {
+			throw new ServiceExistsException($identifier);
+		}
+		$identifier = $this->filterIdentifier($identifier);
+		$recipe = $this->getRecipe($identifier, $type);
+		$type = ! empty($type) ? $type : $recipe->type();
+		$coffee_maker = $this->getCoffeeMaker($type);
+		return $coffee_maker->brew($recipe, $arguments);
+	}
+
+
+	/**
+	 * filters alias identifiers to find the real class name
+	 *
+	 * @param  string $identifier Identifier for the entity class that the filter applies to
+	 *                            Typically a Fully Qualified Class Name
+	 * @return string
+	 * @throws InvalidIdentifierException
+	 */
+	private function filterIdentifier($identifier)
+	{
+		$identifier = $this->processIdentifier($identifier);
+		return isset($this->filters[ $identifier ]) && ! empty($this->filters[ $identifier ])
+			? $this->filters[ $identifier ]
+			: $identifier;
+	}
+
+
+	/**
+	 * verifies and standardizes identifiers
+	 *
+	 * @param  string $identifier Identifier for the entity class
+	 *                            Typically a Fully Qualified Class Name
+	 * @return string
+	 * @throws InvalidIdentifierException
+	 */
+	private function processIdentifier($identifier)
+	{
+		if (! is_string($identifier)) {
+			throw new InvalidIdentifierException(
+				is_object($identifier) ? get_class($identifier) : gettype($identifier),
+				'\Fully\Qualified\ClassName'
+			);
+		}
+		return ltrim($identifier, '\\');
+	}
+
+
+	/**
+	 * @param string $type
+	 * @return CoffeeMakerInterface
+	 * @throws OutOfBoundsException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidClassException
+	 */
+	private function getCoffeeMaker($type)
+	{
+		if (! $this->coffee_makers->has($type)) {
+			throw new OutOfBoundsException(
+				__('The requested coffee maker is either missing or invalid.', 'event_espresso')
+			);
+		}
+		return $this->coffee_makers->get($type);
+	}
+
+
+	/**
+	 * Retrieves all recipes that use a wildcard "*" in their identifier
+	 * This allows recipes to be set up for handling
+	 * legacy classes that do not support PSR-4 autoloading.
+	 * for example:
+	 * using "EEM_*" for a recipe identifier would target all legacy models like EEM_Attendee
+	 *
+	 * @return array
+	 */
+	private function getDefaultRecipes()
+	{
+		$default_recipes = array();
+		$this->recipes->rewind();
+		while ($this->recipes->valid()) {
+			$identifier = $this->recipes->getInfo();
+			// does this recipe use a wildcard ? (but is NOT the global default)
+			if ($identifier !== Recipe::DEFAULT_ID && strpos($identifier, '*') !== false) {
+				// strip the wildcard and use identifier as key
+				$default_recipes[ str_replace('*', '', $identifier) ] = $this->recipes->current();
+			}
+			$this->recipes->next();
+		}
+		return $default_recipes;
+	}
+
+
+	/**
+	 * clones a default recipe and then copies details
+	 * from the incoming request to it so that it can be used
+	 *
+	 * @param RecipeInterface $default_recipe
+	 * @param string          $identifier
+	 * @param string          $type
+	 * @return RecipeInterface
+	 */
+	private function copyDefaultRecipe(RecipeInterface $default_recipe, $identifier, $type = '')
+	{
+		$recipe = clone $default_recipe;
+		if (! empty($type)) {
+			$recipe->setType($type);
+		}
+		// is this the base default recipe ?
+		if ($default_recipe->identifier() === Recipe::DEFAULT_ID) {
+			$recipe->setIdentifier($identifier);
+			$recipe->setFqcn($identifier);
+			return $recipe;
+		}
+		$recipe->setIdentifier($identifier);
+		foreach ($default_recipe->paths() as $path) {
+			$path = str_replace('*', $identifier, $path);
+			if (is_readable($path)) {
+				$recipe->setPaths($path);
+			}
+		}
+		$recipe->setFqcn($identifier);
+		return $recipe;
+	}
+
+
+	/**
+	 * @param  string $identifier Identifier for the entity class that the service applies to
+	 *                            Typically a Fully Qualified Class Name
+	 * @param mixed   $service
+	 * @return mixed
+	 * @throws InvalidServiceException
+	 */
+	private function validateService($identifier, $service)
+	{
+		if (! is_object($service)) {
+			throw new InvalidServiceException(
+				$identifier,
+				$service
+			);
+		}
+		return $service;
+	}
 }

Spacing +11 added lines, -11 removed lines

@@ -159,7 +159,7 @@ 
         }
         // if the reservoir doesn't have a closure already for the requested identifier,
         // then neither a shared service nor a closure for making entities has been built yet
-        if (! $this->reservoir->has($identifier)) {
+        if ( ! $this->reservoir->has($identifier)) {
             // so let's brew something up and add it to the proper collection
             $brewed = $this->makeCoffee($identifier, $arguments, $type);
         }
@@ -284,7 +284,7 @@ 
      */
     public function addClosure($identifier, $closure)
     {
-        if (! is_callable($closure)) {
+        if ( ! is_callable($closure)) {
             throw new InvalidDataTypeException('$closure', $closure, 'Closure');
         }
         $identifier = $this->processIdentifier($identifier);
@@ -393,7 +393,7 @@ 
             // is the wildcard recipe prefix in the identifier ?
             if (strpos($identifier, $wildcard) !== false) {
                 // track matches and use the number of wildcard characters matched for the key
-                $matches[ strlen($wildcard) ] = $default_recipe;
+                $matches[strlen($wildcard)] = $default_recipe;
             }
         }
         if (count($matches) > 0) {
@@ -433,7 +433,7 @@ 
         }
         $identifier = $this->processIdentifier($identifier);
         foreach ((array) $aliases as $alias) {
-            $this->filters[ $this->processIdentifier($alias) ] = $identifier;
+            $this->filters[$this->processIdentifier($alias)] = $identifier;
         }
     }
 
@@ -475,8 +475,8 @@ 
     private function filterIdentifier($identifier)
     {
         $identifier = $this->processIdentifier($identifier);
-        return isset($this->filters[ $identifier ]) && ! empty($this->filters[ $identifier ])
-            ? $this->filters[ $identifier ]
+        return isset($this->filters[$identifier]) && ! empty($this->filters[$identifier])
+            ? $this->filters[$identifier]
             : $identifier;
     }
 
@@ -491,7 +491,7 @@ 
      */
     private function processIdentifier($identifier)
     {
-        if (! is_string($identifier)) {
+        if ( ! is_string($identifier)) {
             throw new InvalidIdentifierException(
                 is_object($identifier) ? get_class($identifier) : gettype($identifier),
                 '\Fully\Qualified\ClassName'
@@ -510,7 +510,7 @@ 
      */
     private function getCoffeeMaker($type)
     {
-        if (! $this->coffee_makers->has($type)) {
+        if ( ! $this->coffee_makers->has($type)) {
             throw new OutOfBoundsException(
                 __('The requested coffee maker is either missing or invalid.', 'event_espresso')
             );
@@ -537,7 +537,7 @@ 
             // does this recipe use a wildcard ? (but is NOT the global default)
             if ($identifier !== Recipe::DEFAULT_ID && strpos($identifier, '*') !== false) {
                 // strip the wildcard and use identifier as key
-                $default_recipes[ str_replace('*', '', $identifier) ] = $this->recipes->current();
+                $default_recipes[str_replace('*', '', $identifier)] = $this->recipes->current();
             }
             $this->recipes->next();
         }
@@ -557,7 +557,7 @@ 
     private function copyDefaultRecipe(RecipeInterface $default_recipe, $identifier, $type = '')
     {
         $recipe = clone $default_recipe;
-        if (! empty($type)) {
+        if ( ! empty($type)) {
             $recipe->setType($type);
         }
         // is this the base default recipe ?
@@ -587,7 +587,7 @@ 
      */
     private function validateService($identifier, $service)
     {
-        if (! is_object($service)) {
+        if ( ! is_object($service)) {
             throw new InvalidServiceException(
                 $identifier,
                 $service