eventespresso / event-espresso-core

core/db_models/helpers/EE_Table_Base.php

Spacing +5 added lines, -5 removed lines

@@ -93,7 +93,7 @@ 
      */
     public function get_table_name()
     {
-        return $this->get_table_prefix() . $this->_table_name;
+        return $this->get_table_prefix().$this->_table_name;
     }
 
 
@@ -105,7 +105,7 @@ 
      */
     public function get_table_alias()
     {
-        if (! $this->_table_alias) {
+        if ( ! $this->_table_alias) {
             throw new EE_Error("You must call _construct_finalize_with_alias before using the EE_Table_Base. Did you forget to call parent::__construct at the end of your EEMerimental_Base child's __construct?");
         }
         return $this->_table_alias;
@@ -128,7 +128,7 @@ 
      */
     public function get_fully_qualified_pk_column()
     {
-        return $this->get_table_alias() . "." . $this->get_pk_column();
+        return $this->get_table_alias().".".$this->get_pk_column();
     }
 
 
@@ -139,8 +139,8 @@ 
      */
     public function get_select_join_limit($limit)
     {
-        $limit = is_array($limit) ? 'LIMIT ' . implode(',', array_map('intval', $limit)) : 'LIMIT ' . (int) $limit;
-        return SP . '(SELECT * FROM ' . $this->_table_name . SP . $limit . ') AS ' . $this->_table_alias;
+        $limit = is_array($limit) ? 'LIMIT '.implode(',', array_map('intval', $limit)) : 'LIMIT '.(int) $limit;
+        return SP.'(SELECT * FROM '.$this->_table_name.SP.$limit.') AS '.$this->_table_alias;
     }
 
 

Indentation +147 added lines, -147 removed lines

@@ -6,151 +6,151 @@
  */
 abstract class EE_Table_Base
 {
-    /**
-     * This holds the table_name without the table prefix.
-     *
-     * @var string
-     */
-    public $_table_name;
-
-
-    /**
-     * This holds what is used as the alias for the table in queries.
-     *
-     * @var string
-     */
-    public $_table_alias;
-
-
-    /**
-     * Table's private key column
-     *
-     * @var string
-     */
-    protected $_pk_column;
-
-
-    /**
-     * Whether this table is a global table (in multisite) or specific to site.
-     *
-     * @var bool
-     */
-    protected $_global;
-
-
-    /**
-     * @param string  $table_name with or without wpdb prefix
-     * @param string  $pk_column
-     * @param boolean $global     whether the table is "global" as in there is only 1 table on an entire multisite
-     *                            install, or whether each site on a multisite install has a copy of this table
-     * @global wpdb   $wpdb
-     */
-    public function __construct($table_name, $pk_column, $global = false)
-    {
-        $this->_global = $global;
-        $prefix        = $this->get_table_prefix();
-        // if they added the prefix, let's remove it because we delay adding the prefix until right when its needed.
-        if (strpos($table_name, $prefix) === 0) {
-            $table_name = substr_replace($table_name, '', 0, strlen($prefix));
-        }
-        $this->_table_name = $table_name;
-        $this->_pk_column  = $pk_column;
-    }
-
-
-    /**
-     * This returns the table prefix for the current model state.
-     *
-     * @return string
-     * @global wpdb $wpdb
-     */
-    public function get_table_prefix()
-    {
-        global $wpdb;
-        if ($this->_global) {
-            return $wpdb->base_prefix;
-        }
-        return $wpdb->get_blog_prefix(EEM_Base::get_model_query_blog_id());
-    }
-
-
-    /**
-     * Used to set the table_alias property
-     *
-     * @param string $table_alias
-     */
-    public function _construct_finalize_with_alias($table_alias)
-    {
-        $this->_table_alias = $table_alias;
-    }
-
-
-    /**
-     * Returns the fully qualified table name for the database (includes the table prefix current for the blog).
-     *
-     * @return string
-     */
-    public function get_table_name()
-    {
-        return $this->get_table_prefix() . $this->_table_name;
-    }
-
-
-    /**
-     * Provides what is currently set as the alias for the table to be used in queries.
-     *
-     * @return string
-     * @throws EE_Error
-     */
-    public function get_table_alias()
-    {
-        if (! $this->_table_alias) {
-            throw new EE_Error("You must call _construct_finalize_with_alias before using the EE_Table_Base. Did you forget to call parent::__construct at the end of your EEMerimental_Base child's __construct?");
-        }
-        return $this->_table_alias;
-    }
-
-
-    /**
-     * @return string name of column of PK
-     */
-    public function get_pk_column()
-    {
-        return $this->_pk_column;
-    }
-
-
-    /**
-     * returns a string with the table alias, a period, and the private key's column.
-     *
-     * @return string
-     */
-    public function get_fully_qualified_pk_column()
-    {
-        return $this->get_table_alias() . "." . $this->get_pk_column();
-    }
-
-
-    /**
-     * returns the special sql for a inner select with a limit.
-     *
-     * @return string    SQL select
-     */
-    public function get_select_join_limit($limit)
-    {
-        $limit = is_array($limit) ? 'LIMIT ' . implode(',', array_map('intval', $limit)) : 'LIMIT ' . (int) $limit;
-        return SP . '(SELECT * FROM ' . $this->_table_name . SP . $limit . ') AS ' . $this->_table_alias;
-    }
-
-
-    /**
-     * Returns whether or not htis is a global table (ie, on multisite there's
-     * only one of these tables, on the main blog)
-     *
-     * @return boolean
-     */
-    public function is_global()
-    {
-        return $this->_global;
-    }
+	/**
+	 * This holds the table_name without the table prefix.
+	 *
+	 * @var string
+	 */
+	public $_table_name;
+
+
+	/**
+	 * This holds what is used as the alias for the table in queries.
+	 *
+	 * @var string
+	 */
+	public $_table_alias;
+
+
+	/**
+	 * Table's private key column
+	 *
+	 * @var string
+	 */
+	protected $_pk_column;
+
+
+	/**
+	 * Whether this table is a global table (in multisite) or specific to site.
+	 *
+	 * @var bool
+	 */
+	protected $_global;
+
+
+	/**
+	 * @param string  $table_name with or without wpdb prefix
+	 * @param string  $pk_column
+	 * @param boolean $global     whether the table is "global" as in there is only 1 table on an entire multisite
+	 *                            install, or whether each site on a multisite install has a copy of this table
+	 * @global wpdb   $wpdb
+	 */
+	public function __construct($table_name, $pk_column, $global = false)
+	{
+		$this->_global = $global;
+		$prefix        = $this->get_table_prefix();
+		// if they added the prefix, let's remove it because we delay adding the prefix until right when its needed.
+		if (strpos($table_name, $prefix) === 0) {
+			$table_name = substr_replace($table_name, '', 0, strlen($prefix));
+		}
+		$this->_table_name = $table_name;
+		$this->_pk_column  = $pk_column;
+	}
+
+
+	/**
+	 * This returns the table prefix for the current model state.
+	 *
+	 * @return string
+	 * @global wpdb $wpdb
+	 */
+	public function get_table_prefix()
+	{
+		global $wpdb;
+		if ($this->_global) {
+			return $wpdb->base_prefix;
+		}
+		return $wpdb->get_blog_prefix(EEM_Base::get_model_query_blog_id());
+	}
+
+
+	/**
+	 * Used to set the table_alias property
+	 *
+	 * @param string $table_alias
+	 */
+	public function _construct_finalize_with_alias($table_alias)
+	{
+		$this->_table_alias = $table_alias;
+	}
+
+
+	/**
+	 * Returns the fully qualified table name for the database (includes the table prefix current for the blog).
+	 *
+	 * @return string
+	 */
+	public function get_table_name()
+	{
+		return $this->get_table_prefix() . $this->_table_name;
+	}
+
+
+	/**
+	 * Provides what is currently set as the alias for the table to be used in queries.
+	 *
+	 * @return string
+	 * @throws EE_Error
+	 */
+	public function get_table_alias()
+	{
+		if (! $this->_table_alias) {
+			throw new EE_Error("You must call _construct_finalize_with_alias before using the EE_Table_Base. Did you forget to call parent::__construct at the end of your EEMerimental_Base child's __construct?");
+		}
+		return $this->_table_alias;
+	}
+
+
+	/**
+	 * @return string name of column of PK
+	 */
+	public function get_pk_column()
+	{
+		return $this->_pk_column;
+	}
+
+
+	/**
+	 * returns a string with the table alias, a period, and the private key's column.
+	 *
+	 * @return string
+	 */
+	public function get_fully_qualified_pk_column()
+	{
+		return $this->get_table_alias() . "." . $this->get_pk_column();
+	}
+
+
+	/**
+	 * returns the special sql for a inner select with a limit.
+	 *
+	 * @return string    SQL select
+	 */
+	public function get_select_join_limit($limit)
+	{
+		$limit = is_array($limit) ? 'LIMIT ' . implode(',', array_map('intval', $limit)) : 'LIMIT ' . (int) $limit;
+		return SP . '(SELECT * FROM ' . $this->_table_name . SP . $limit . ') AS ' . $this->_table_alias;
+	}
+
+
+	/**
+	 * Returns whether or not htis is a global table (ie, on multisite there's
+	 * only one of these tables, on the main blog)
+	 *
+	 * @return boolean
+	 */
+	public function is_global()
+	{
+		return $this->_global;
+	}
 }

core/services/form/meta/InputOptions.php

Spacing +2 added lines, -2 removed lines

@@ -93,7 +93,7 @@ 
             $value = sanitize_key($option['value']);
 
             // use `value` as key
-            $this->options[ $value ] = compact('label', 'value');
+            $this->options[$value] = compact('label', 'value');
         }
     }
 
@@ -104,7 +104,7 @@ 
     public function removeOption(string $option_value): void
     {
         $option_value = sanitize_key($option_value);
-        unset($this->options[ $option_value ]);
+        unset($this->options[$option_value]);
     }
 
 

Indentation +102 added lines, -102 removed lines

@@ -14,106 +14,106 @@
  */
 class InputOptions implements JsonableInterface
 {
-    /**
-     * @var JsonDataHandler
-     */
-    private $json_data_handler;
-
-    /**
-     * Options for ENUM type inputs like checkboxes, radio buttons, select inputs, etc
-     *
-     * @var array
-     */
-    private $options = [];
-
-
-    /**
-     * HelpText constructor.
-     *
-     * @param JsonDataHandler $json_data_handler
-     * @param array           $options
-     */
-    public function __construct(JsonDataHandler $json_data_handler, array $options)
-    {
-        $this->json_data_handler = $json_data_handler;
-        $this->setOptions($options);
-    }
-
-
-    /**
-     * @param string $json
-     * @return InputOptions
-     */
-    public static function fromJson(string $json): InputOptions
-    {
-        $json_data_handler = new JsonDataHandler();
-        $json_data_handler->configure(JsonDataHandler::DATA_TYPE_ARRAY);
-        $data = $json_data_handler->decodeJson($json);
-        return new InputOptions($json_data_handler, $data ?? []);
-    }
-
-
-    /**
-     * @return array
-     */
-    public function toArray(): array
-    {
-        return array_values($this->options);
-    }
-
-
-    /**
-     * @return string
-     */
-    public function toJson(): string
-    {
-        return $this->json_data_handler->encodeData($this->toArray());
-    }
-
-
-    /**
-     * an array where keys are option values and values are option labels
-     *
-     * @return array
-     */
-    public function options(): array
-    {
-        return $this->options;
-    }
-
-
-    /**
-     * @param array $option
-     */
-    public function addOption(array $option): void
-    {
-        if (isset($option['label'], $option['value'])) {
-            $label = sanitize_text_field($option['label']);
-            $value = sanitize_key($option['value']);
-
-            // use `value` as key
-            $this->options[ $value ] = compact('label', 'value');
-        }
-    }
-
-
-    /**
-     * @param int|float|string $option_value
-     */
-    public function removeOption(string $option_value): void
-    {
-        $option_value = sanitize_key($option_value);
-        unset($this->options[ $option_value ]);
-    }
-
-
-    /**
-     * @param array $options an array where keys are option values and values are option labels
-     */
-    public function setOptions(array $options): void
-    {
-        foreach ($options as $option) {
-            $this->addOption($option);
-        }
-    }
+	/**
+	 * @var JsonDataHandler
+	 */
+	private $json_data_handler;
+
+	/**
+	 * Options for ENUM type inputs like checkboxes, radio buttons, select inputs, etc
+	 *
+	 * @var array
+	 */
+	private $options = [];
+
+
+	/**
+	 * HelpText constructor.
+	 *
+	 * @param JsonDataHandler $json_data_handler
+	 * @param array           $options
+	 */
+	public function __construct(JsonDataHandler $json_data_handler, array $options)
+	{
+		$this->json_data_handler = $json_data_handler;
+		$this->setOptions($options);
+	}
+
+
+	/**
+	 * @param string $json
+	 * @return InputOptions
+	 */
+	public static function fromJson(string $json): InputOptions
+	{
+		$json_data_handler = new JsonDataHandler();
+		$json_data_handler->configure(JsonDataHandler::DATA_TYPE_ARRAY);
+		$data = $json_data_handler->decodeJson($json);
+		return new InputOptions($json_data_handler, $data ?? []);
+	}
+
+
+	/**
+	 * @return array
+	 */
+	public function toArray(): array
+	{
+		return array_values($this->options);
+	}
+
+
+	/**
+	 * @return string
+	 */
+	public function toJson(): string
+	{
+		return $this->json_data_handler->encodeData($this->toArray());
+	}
+
+
+	/**
+	 * an array where keys are option values and values are option labels
+	 *
+	 * @return array
+	 */
+	public function options(): array
+	{
+		return $this->options;
+	}
+
+
+	/**
+	 * @param array $option
+	 */
+	public function addOption(array $option): void
+	{
+		if (isset($option['label'], $option['value'])) {
+			$label = sanitize_text_field($option['label']);
+			$value = sanitize_key($option['value']);
+
+			// use `value` as key
+			$this->options[ $value ] = compact('label', 'value');
+		}
+	}
+
+
+	/**
+	 * @param int|float|string $option_value
+	 */
+	public function removeOption(string $option_value): void
+	{
+		$option_value = sanitize_key($option_value);
+		unset($this->options[ $option_value ]);
+	}
+
+
+	/**
+	 * @param array $options an array where keys are option values and values are option labels
+	 */
+	public function setOptions(array $options): void
+	{
+		foreach ($options as $option) {
+			$this->addOption($option);
+		}
+	}
 }

core/db_models/fields/EE_JSON_Field.php

Indentation +64 added lines, -64 removed lines

@@ -5,76 +5,76 @@
 class EE_JSON_Field extends EE_Model_Field_Base
 {
 
-    /**
-     * @var JsonDataHandler
-     */
-    private $json_data_handler;
+	/**
+	 * @var JsonDataHandler
+	 */
+	private $json_data_handler;
 
 
-    /**
-     * @param string $table_column
-     * @param string $nicename
-     * @param bool   $nullable
-     * @param null   $default_value
-     */
-    public function __construct(
-        $table_column,
-        $nicename,
-        $nullable,
-        $default_value = null
-    ) {
-        $this->json_data_handler = new JsonDataHandler();
-        $this->json_data_handler->configure(
-            JsonDataHandler::DATA_TYPE_OBJECT
-        );
-        parent::__construct($table_column, $nicename, $nullable, $default_value);
-    }
+	/**
+	 * @param string $table_column
+	 * @param string $nicename
+	 * @param bool   $nullable
+	 * @param null   $default_value
+	 */
+	public function __construct(
+		$table_column,
+		$nicename,
+		$nullable,
+		$default_value = null
+	) {
+		$this->json_data_handler = new JsonDataHandler();
+		$this->json_data_handler->configure(
+			JsonDataHandler::DATA_TYPE_OBJECT
+		);
+		parent::__construct($table_column, $nicename, $nullable, $default_value);
+	}
 
 
-    // /**
-    //  * When get() is called on a model object (eg EE_Event), before returning its value,
-    //  * call this function on it, allowing us to customize the returned value based on
-    //  * the field's type. Eg, we may want to unserialize it, strip tags, etc. By default,
-    //  * we simply return it.
-    //  *
-    //  * @param mixed $value_of_field_on_model_object
-    //  * @return mixed
-    //  */
-    // public function prepare_for_get($value_of_field_on_model_object)
-    // {
-    //     // return $this->json_data_handler->decodeJson($value_of_field_on_model_object);
-    //     return $value_of_field_on_model_object;
-    // }
+	// /**
+	//  * When get() is called on a model object (eg EE_Event), before returning its value,
+	//  * call this function on it, allowing us to customize the returned value based on
+	//  * the field's type. Eg, we may want to unserialize it, strip tags, etc. By default,
+	//  * we simply return it.
+	//  *
+	//  * @param mixed $value_of_field_on_model_object
+	//  * @return mixed
+	//  */
+	// public function prepare_for_get($value_of_field_on_model_object)
+	// {
+	//     // return $this->json_data_handler->decodeJson($value_of_field_on_model_object);
+	//     return $value_of_field_on_model_object;
+	// }
 
 
-    /**
-     * When creating a brand-new model object, or setting a particular value for one of its fields, this function
-     * is called before setting it on the model object. We may want to strip slashes, unserialize the value, etc.
-     * By default, we do nothing.
-     *
-     * If the model field is going to perform any validation on the input, this is where it should be done
-     * (once the value is on the model object, it may be used in other ways besides putting it into the DB
-     * so it's best to validate it right away).
-     *
-     * @param mixed $value_inputted_for_field_on_model_object
-     * @return string
-     */
-    public function prepare_for_set($value_inputted_for_field_on_model_object)
-    {
-        return $this->json_data_handler->encodeData($value_inputted_for_field_on_model_object);
-    }
+	/**
+	 * When creating a brand-new model object, or setting a particular value for one of its fields, this function
+	 * is called before setting it on the model object. We may want to strip slashes, unserialize the value, etc.
+	 * By default, we do nothing.
+	 *
+	 * If the model field is going to perform any validation on the input, this is where it should be done
+	 * (once the value is on the model object, it may be used in other ways besides putting it into the DB
+	 * so it's best to validate it right away).
+	 *
+	 * @param mixed $value_inputted_for_field_on_model_object
+	 * @return string
+	 */
+	public function prepare_for_set($value_inputted_for_field_on_model_object)
+	{
+		return $this->json_data_handler->encodeData($value_inputted_for_field_on_model_object);
+	}
 
 
-    /**
-     * When inserting or updating a field on a model object, run this function on each
-     * value to prepare it for insertion into the db. Generally this converts
-     * the validated input on the model object into the format used in the DB.
-     *
-     * @param mixed $value_of_field_on_model_object
-     * @return string
-     */
-    public function prepare_for_use_in_db($value_of_field_on_model_object)
-    {
-        return $this->json_data_handler->encodeData($value_of_field_on_model_object);
-    }
+	/**
+	 * When inserting or updating a field on a model object, run this function on each
+	 * value to prepare it for insertion into the db. Generally this converts
+	 * the validated input on the model object into the format used in the DB.
+	 *
+	 * @param mixed $value_of_field_on_model_object
+	 * @return string
+	 */
+	public function prepare_for_use_in_db($value_of_field_on_model_object)
+	{
+		return $this->json_data_handler->encodeData($value_of_field_on_model_object);
+	}
 }

core/db_classes/EE_Form_Element.class.php

Spacing +6 added lines, -6 removed lines

@@ -137,7 +137,7 @@ 
      */
     public function attributes(): ?Attributes
     {
-        if (! $this->attributes instanceof Attributes) {
+        if ( ! $this->attributes instanceof Attributes) {
             $this->attributes = Attributes::fromJson($this->get('FIN_attributes'));
         }
         return $this->attributes;
@@ -191,7 +191,7 @@ 
      */
     public function helpText(): ?HelpText
     {
-        if (! $this->helpText instanceof HelpText) {
+        if ( ! $this->helpText instanceof HelpText) {
             $this->helpText = HelpText::fromJson($this->get('FIN_helpText'));
         }
         return $this->helpText;
@@ -221,7 +221,7 @@ 
      */
     public function label(): ?FormLabel
     {
-        if (! $this->label instanceof FormLabel) {
+        if ( ! $this->label instanceof FormLabel) {
             $this->label = FormLabel::fromJson($this->get('FIN_label'));
         }
         return $this->label;
@@ -264,7 +264,7 @@ 
     public function setMapsTo(string $model, string $field)
     {
         $model_name = strpos($model, 'EEM_') !== 0 ? "EEM_$model" : $model;
-        if (! class_exists($model_name)) {
+        if ( ! class_exists($model_name)) {
             throw new DomainException(
                 sprintf(
                     esc_html__(
@@ -288,7 +288,7 @@ 
      */
     public function options(): ?InputOptions
     {
-        if (! $this->options instanceof InputOptions) {
+        if ( ! $this->options instanceof InputOptions) {
             $this->options = InputOptions::fromJson($this->get('FIN_options'));
         }
         return $this->options;
@@ -367,7 +367,7 @@ 
      */
     public function required(): ?Required
     {
-        if (! $this->required instanceof Required) {
+        if ( ! $this->required instanceof Required) {
             $this->required = Required::fromJson($this->get('FIN_required'));
         }
         return $this->required;

Indentation +467 added lines, -467 removed lines

@@ -28,471 +28,471 @@
  */
 class EE_Form_Element extends EE_Base_Class
 {
-    /**
-     * @var Attributes
-     */
-    private $attributes;
-
-    /**
-     * @var FormLabel
-     */
-    private $label;
-
-    /**
-     * @var HelpText
-     */
-    private $helpText;
-
-    /**
-     * @var InputOptions
-     */
-    private $options;
-
-    /**
-     * @var Required
-     */
-    private $required;
-
-
-    /**
-     * @param array $props_n_values
-     * @return EE_Form_Element
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    public static function new_instance(array $props_n_values = []): EE_Form_Element
-    {
-        $has_object = parent::_check_for_object($props_n_values, __CLASS__);
-        return $has_object ?: new self($props_n_values);
-    }
-
-
-    /**
-     * @param array $props_n_values
-     * @return EE_Form_Element
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    public static function new_instance_from_db(array $props_n_values = []): EE_Form_Element
-    {
-        return new self($props_n_values);
-    }
-
-
-    /**
-     * Form Element UUID (universally unique identifier)
-     *
-     * @return string
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    public function UUID(): string
-    {
-        return $this->get('FIN_UUID');
-    }
-
-
-    /**
-     * @param string $UUID
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    public function setUUID(string $UUID)
-    {
-        $this->set('FIN_UUID', $UUID);
-    }
-
-
-    /**
-     * Whether or not input is only displayed in the admin. If false, input will appear in public forms
-     *
-     * @return bool
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    public function adminOnly(): ?bool
-    {
-        return $this->get('FIN_adminOnly');
-    }
-
-
-    /**
-     * @param bool $admin_only
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    public function setAdminOnly(bool $admin_only)
-    {
-        $this->set('FIN_adminOnly', $admin_only);
-    }
-
-
-    /**
-     * JSON string of HTML attributes such as class, max, min, placeholder, type, etc.
-     *
-     * @return Attributes
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    public function attributes(): ?Attributes
-    {
-        if (! $this->attributes instanceof Attributes) {
-            $this->attributes = Attributes::fromJson($this->get('FIN_attributes'));
-        }
-        return $this->attributes;
-    }
-
-
-    /**
-     * @param Attributes $attributes
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    public function setAttributes(Attributes $attributes)
-    {
-        // set local object
-        $this->attributes = $attributes;
-        // then pass to model as an array which will get converted to JSON by the model field
-        $this->set('FIN_attributes', $attributes->toArray());
-    }
-
-
-    /**
-     * UUID of parent form section this form input belongs to.
-     *
-     * @return string
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    public function belongsTo(): string
-    {
-        return $this->get('FSC_UUID');
-    }
-
-
-    /**
-     * @param string $relation_UUID
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    public function setBelongsTo(string $relation_UUID)
-    {
-        $this->set('FSC_UUID', $relation_UUID);
-    }
-
-
-    /**
-     * returns a HelpText object for managing input help text
-     *
-     * @return HelpText
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    public function helpText(): ?HelpText
-    {
-        if (! $this->helpText instanceof HelpText) {
-            $this->helpText = HelpText::fromJson($this->get('FIN_helpText'));
-        }
-        return $this->helpText;
-    }
-
-
-    /**
-     * @param HelpText $helpText
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    public function setHelpText(HelpText $helpText)
-    {
-        // set local object
-        $this->helpText = $helpText;
-        // then pass to model as an array which will get converted to JSON by the model field
-        $this->set('FIN_helpText', $helpText->toArray());
-    }
-
-
-    /**
-     * returns a FormLabel object for managing input labels
-     *
-     * @return FormLabel
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    public function label(): ?FormLabel
-    {
-        if (! $this->label instanceof FormLabel) {
-            $this->label = FormLabel::fromJson($this->get('FIN_label'));
-        }
-        return $this->label;
-    }
-
-
-    /**
-     * @param FormLabel $label
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    public function setLabel(FormLabel $label)
-    {
-        // set local object
-        $this->label = $label;
-        // then pass to model as an array which will get converted to JSON by the model field
-        $this->set('FIN_label', $label->toArray());
-    }
-
-
-    /**
-     * Model and Fields name that this input maps to; ex: Attendee.email
-     *
-     * @return string
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    public function mapsTo(): ?string
-    {
-        return $this->get('FIN_mapsTo');
-    }
-
-
-    /**
-     * @param string $model ex: Attendee
-     * @param string $field ex: email
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    public function setMapsTo(string $model, string $field)
-    {
-        $model_name = strpos($model, 'EEM_') !== 0 ? "EEM_$model" : $model;
-        if (! class_exists($model_name)) {
-            throw new DomainException(
-                sprintf(
-                    esc_html__(
-                        'The %1$s model does not exist or can not be located. Please verify the spelling and whether it is loaded.',
-                        'event_espresso'
-                    ),
-                    $model_name
-                )
-            );
-        }
-        $this->set('FIN_mapsTo', "{$model}.{$field}");
-    }
-
-
-    /**
-     * Options for ENUM type inputs like checkboxes, radio buttons, select inputs, etc
-     *
-     * @return InputOptions
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    public function options(): ?InputOptions
-    {
-        if (! $this->options instanceof InputOptions) {
-            $this->options = InputOptions::fromJson($this->get('FIN_options'));
-        }
-        return $this->options;
-    }
-
-
-    /**
-     * @param InputOptions $options
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    public function setOptions(InputOptions $options)
-    {
-        // set local object
-        $this->options = $options;
-        // then pass to model as an array which will get converted to JSON by the model field
-        $this->set('FIN_options', $options->toArray());
-    }
-
-
-
-    /**
-     * Order in which form input appears in a form.
-     *
-     * @return int
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    public function order(): int
-    {
-        return $this->get('FIN_order');
-    }
-
-
-    /**
-     * @param int $order
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    public function setOrder(int $order)
-    {
-        $this->set('FIN_order', $order);
-    }
-
-
-    /**
-     * Example text displayed within an input to assist users with completing the form.
-     *
-     * @return string
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    public function placeholder(): ?string
-    {
-        return $this->get('FIN_placeholder');
-    }
-
-
-    /**
-     * @param string $placeholder
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    public function setPlaceholder(string $placeholder)
-    {
-        $this->set('FIN_placeholder', $placeholder);
-    }
-
-
-    /**
-     * Whether or not the input must be supplied with a value in order to complete the form.
-     *
-     * @return Required
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    public function required(): ?Required
-    {
-        if (! $this->required instanceof Required) {
-            $this->required = Required::fromJson($this->get('FIN_required'));
-        }
-        return $this->required;
-    }
-
-
-    /**
-     * @param Required $required
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    public function setRequired(Required $required)
-    {
-        // set local object
-        $this->required = $required;
-        // then pass to model as an array which will get converted to JSON by the model field
-        $this->set('FIN_required', $required->toArray());
-    }
-
-
-    /**
-     * version of public label for use in identifiers
-     *
-     * @return string
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    public function slug(): ?string
-    {
-        return sanitize_title($this->label()->publicLabel());
-    }
-
-
-    /**
-     * Whether form input is active, archived, trashed, or used as a default on new forms.
-     * Values correspond to the EEM_Form_Element::STATUS_* constants.
-     *
-     * @return string
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    public function status(): string
-    {
-        return $this->get('FIN_status');
-    }
-
-
-    /**
-     * Whether form input is active, archived, trashed, or used as a default on new forms.
-     * Values correspond to the EEM_Form_Element::STATUS_* constants.
-     *
-     * @param string $status
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    public function setStatus(string $status)
-    {
-        $this->set('FIN_status', $status);
-    }
-
-
-    /**
-     * Form input type.
-     * Values correspond to the EventEspresso\core\domain\entities\form\Input::TYPE_* constants.
-     *
-     * @return string
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    public function type(): ?string
-    {
-        return $this->get('FIN_type');
-    }
-
-
-    /**
-     * @param string $type
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    public function setType(string $type)
-    {
-        $this->set('FIN_type', $type);
-    }
-
-
-    /**
-     * ID of the WP User that created this form input.
-     *
-     * @return int
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    public function wp_user(): int
-    {
-        return $this->get('FIN_wpUser');
-    }
-
-
-    /**
-     * returns the id the wordpress user who created this question
-     *
-     * @param int $wp_user
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    public function setWpUser(int $wp_user)
-    {
-        $this->set('FIN_wpUser', $wp_user);
-    }
-
-
-    /**
-     * @param array $set_cols_n_values
-     * @return bool|int|string
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    public function save($set_cols_n_values = [])
-    {
-        // make sure internal versions for all composite objects are updated
-        $this->set('FIN_attributes', $this->attributes()->toArray());
-        $this->set('FIN_helpText', $this->helpText()->toArray());
-        $this->set('FIN_label', $this->label()->toArray());
-        $this->set('FIN_options', $this->options()->toArray());
-        $this->set('FIN_required', $this->required()->toArray());
-        return parent::save($set_cols_n_values);
-    }
+	/**
+	 * @var Attributes
+	 */
+	private $attributes;
+
+	/**
+	 * @var FormLabel
+	 */
+	private $label;
+
+	/**
+	 * @var HelpText
+	 */
+	private $helpText;
+
+	/**
+	 * @var InputOptions
+	 */
+	private $options;
+
+	/**
+	 * @var Required
+	 */
+	private $required;
+
+
+	/**
+	 * @param array $props_n_values
+	 * @return EE_Form_Element
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	public static function new_instance(array $props_n_values = []): EE_Form_Element
+	{
+		$has_object = parent::_check_for_object($props_n_values, __CLASS__);
+		return $has_object ?: new self($props_n_values);
+	}
+
+
+	/**
+	 * @param array $props_n_values
+	 * @return EE_Form_Element
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	public static function new_instance_from_db(array $props_n_values = []): EE_Form_Element
+	{
+		return new self($props_n_values);
+	}
+
+
+	/**
+	 * Form Element UUID (universally unique identifier)
+	 *
+	 * @return string
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	public function UUID(): string
+	{
+		return $this->get('FIN_UUID');
+	}
+
+
+	/**
+	 * @param string $UUID
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	public function setUUID(string $UUID)
+	{
+		$this->set('FIN_UUID', $UUID);
+	}
+
+
+	/**
+	 * Whether or not input is only displayed in the admin. If false, input will appear in public forms
+	 *
+	 * @return bool
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	public function adminOnly(): ?bool
+	{
+		return $this->get('FIN_adminOnly');
+	}
+
+
+	/**
+	 * @param bool $admin_only
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	public function setAdminOnly(bool $admin_only)
+	{
+		$this->set('FIN_adminOnly', $admin_only);
+	}
+
+
+	/**
+	 * JSON string of HTML attributes such as class, max, min, placeholder, type, etc.
+	 *
+	 * @return Attributes
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	public function attributes(): ?Attributes
+	{
+		if (! $this->attributes instanceof Attributes) {
+			$this->attributes = Attributes::fromJson($this->get('FIN_attributes'));
+		}
+		return $this->attributes;
+	}
+
+
+	/**
+	 * @param Attributes $attributes
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	public function setAttributes(Attributes $attributes)
+	{
+		// set local object
+		$this->attributes = $attributes;
+		// then pass to model as an array which will get converted to JSON by the model field
+		$this->set('FIN_attributes', $attributes->toArray());
+	}
+
+
+	/**
+	 * UUID of parent form section this form input belongs to.
+	 *
+	 * @return string
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	public function belongsTo(): string
+	{
+		return $this->get('FSC_UUID');
+	}
+
+
+	/**
+	 * @param string $relation_UUID
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	public function setBelongsTo(string $relation_UUID)
+	{
+		$this->set('FSC_UUID', $relation_UUID);
+	}
+
+
+	/**
+	 * returns a HelpText object for managing input help text
+	 *
+	 * @return HelpText
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	public function helpText(): ?HelpText
+	{
+		if (! $this->helpText instanceof HelpText) {
+			$this->helpText = HelpText::fromJson($this->get('FIN_helpText'));
+		}
+		return $this->helpText;
+	}
+
+
+	/**
+	 * @param HelpText $helpText
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	public function setHelpText(HelpText $helpText)
+	{
+		// set local object
+		$this->helpText = $helpText;
+		// then pass to model as an array which will get converted to JSON by the model field
+		$this->set('FIN_helpText', $helpText->toArray());
+	}
+
+
+	/**
+	 * returns a FormLabel object for managing input labels
+	 *
+	 * @return FormLabel
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	public function label(): ?FormLabel
+	{
+		if (! $this->label instanceof FormLabel) {
+			$this->label = FormLabel::fromJson($this->get('FIN_label'));
+		}
+		return $this->label;
+	}
+
+
+	/**
+	 * @param FormLabel $label
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	public function setLabel(FormLabel $label)
+	{
+		// set local object
+		$this->label = $label;
+		// then pass to model as an array which will get converted to JSON by the model field
+		$this->set('FIN_label', $label->toArray());
+	}
+
+
+	/**
+	 * Model and Fields name that this input maps to; ex: Attendee.email
+	 *
+	 * @return string
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	public function mapsTo(): ?string
+	{
+		return $this->get('FIN_mapsTo');
+	}
+
+
+	/**
+	 * @param string $model ex: Attendee
+	 * @param string $field ex: email
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	public function setMapsTo(string $model, string $field)
+	{
+		$model_name = strpos($model, 'EEM_') !== 0 ? "EEM_$model" : $model;
+		if (! class_exists($model_name)) {
+			throw new DomainException(
+				sprintf(
+					esc_html__(
+						'The %1$s model does not exist or can not be located. Please verify the spelling and whether it is loaded.',
+						'event_espresso'
+					),
+					$model_name
+				)
+			);
+		}
+		$this->set('FIN_mapsTo', "{$model}.{$field}");
+	}
+
+
+	/**
+	 * Options for ENUM type inputs like checkboxes, radio buttons, select inputs, etc
+	 *
+	 * @return InputOptions
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	public function options(): ?InputOptions
+	{
+		if (! $this->options instanceof InputOptions) {
+			$this->options = InputOptions::fromJson($this->get('FIN_options'));
+		}
+		return $this->options;
+	}
+
+
+	/**
+	 * @param InputOptions $options
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	public function setOptions(InputOptions $options)
+	{
+		// set local object
+		$this->options = $options;
+		// then pass to model as an array which will get converted to JSON by the model field
+		$this->set('FIN_options', $options->toArray());
+	}
+
+
+
+	/**
+	 * Order in which form input appears in a form.
+	 *
+	 * @return int
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	public function order(): int
+	{
+		return $this->get('FIN_order');
+	}
+
+
+	/**
+	 * @param int $order
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	public function setOrder(int $order)
+	{
+		$this->set('FIN_order', $order);
+	}
+
+
+	/**
+	 * Example text displayed within an input to assist users with completing the form.
+	 *
+	 * @return string
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	public function placeholder(): ?string
+	{
+		return $this->get('FIN_placeholder');
+	}
+
+
+	/**
+	 * @param string $placeholder
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	public function setPlaceholder(string $placeholder)
+	{
+		$this->set('FIN_placeholder', $placeholder);
+	}
+
+
+	/**
+	 * Whether or not the input must be supplied with a value in order to complete the form.
+	 *
+	 * @return Required
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	public function required(): ?Required
+	{
+		if (! $this->required instanceof Required) {
+			$this->required = Required::fromJson($this->get('FIN_required'));
+		}
+		return $this->required;
+	}
+
+
+	/**
+	 * @param Required $required
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	public function setRequired(Required $required)
+	{
+		// set local object
+		$this->required = $required;
+		// then pass to model as an array which will get converted to JSON by the model field
+		$this->set('FIN_required', $required->toArray());
+	}
+
+
+	/**
+	 * version of public label for use in identifiers
+	 *
+	 * @return string
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	public function slug(): ?string
+	{
+		return sanitize_title($this->label()->publicLabel());
+	}
+
+
+	/**
+	 * Whether form input is active, archived, trashed, or used as a default on new forms.
+	 * Values correspond to the EEM_Form_Element::STATUS_* constants.
+	 *
+	 * @return string
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	public function status(): string
+	{
+		return $this->get('FIN_status');
+	}
+
+
+	/**
+	 * Whether form input is active, archived, trashed, or used as a default on new forms.
+	 * Values correspond to the EEM_Form_Element::STATUS_* constants.
+	 *
+	 * @param string $status
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	public function setStatus(string $status)
+	{
+		$this->set('FIN_status', $status);
+	}
+
+
+	/**
+	 * Form input type.
+	 * Values correspond to the EventEspresso\core\domain\entities\form\Input::TYPE_* constants.
+	 *
+	 * @return string
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	public function type(): ?string
+	{
+		return $this->get('FIN_type');
+	}
+
+
+	/**
+	 * @param string $type
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	public function setType(string $type)
+	{
+		$this->set('FIN_type', $type);
+	}
+
+
+	/**
+	 * ID of the WP User that created this form input.
+	 *
+	 * @return int
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	public function wp_user(): int
+	{
+		return $this->get('FIN_wpUser');
+	}
+
+
+	/**
+	 * returns the id the wordpress user who created this question
+	 *
+	 * @param int $wp_user
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	public function setWpUser(int $wp_user)
+	{
+		$this->set('FIN_wpUser', $wp_user);
+	}
+
+
+	/**
+	 * @param array $set_cols_n_values
+	 * @return bool|int|string
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	public function save($set_cols_n_values = [])
+	{
+		// make sure internal versions for all composite objects are updated
+		$this->set('FIN_attributes', $this->attributes()->toArray());
+		$this->set('FIN_helpText', $this->helpText()->toArray());
+		$this->set('FIN_label', $this->label()->toArray());
+		$this->set('FIN_options', $this->options()->toArray());
+		$this->set('FIN_required', $this->required()->toArray());
+		return parent::save($set_cols_n_values);
+	}
 }

core/domain/services/registration/form/v1/CopyAttendeeInfoForm.php

Indentation +70 added lines, -70 removed lines

@@ -12,77 +12,77 @@
 
 class CopyAttendeeInfoForm extends EE_Form_Section_Proper
 {
-    /**
-     * CopyAttendeeInfoForm constructor.
-     *
-     * @param EE_Registration[] $registrations
-     * @param string            $slug
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    public function __construct(array $registrations, string $slug)
-    {
-        parent::__construct(
-            [
-                'subsections'     => $this->copyAttendeeInfoInputs($registrations),
-                'layout_strategy' => new EE_Template_Layout(
-                    [
-                        'layout_template_file'     => SPCO_REG_STEPS_PATH
-                                                      . $slug
-                                                      . '/copy_attendee_info.template.php',
-                        'begin_template_file'      => null,
-                        'input_template_file'      => null,
-                        'subsection_template_file' => null,
-                        'end_template_file'        => null,
-                    ]
-                ),
-            ]
-        );
-    }
+	/**
+	 * CopyAttendeeInfoForm constructor.
+	 *
+	 * @param EE_Registration[] $registrations
+	 * @param string            $slug
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	public function __construct(array $registrations, string $slug)
+	{
+		parent::__construct(
+			[
+				'subsections'     => $this->copyAttendeeInfoInputs($registrations),
+				'layout_strategy' => new EE_Template_Layout(
+					[
+						'layout_template_file'     => SPCO_REG_STEPS_PATH
+													  . $slug
+													  . '/copy_attendee_info.template.php',
+						'begin_template_file'      => null,
+						'input_template_file'      => null,
+						'subsection_template_file' => null,
+						'end_template_file'        => null,
+					]
+				),
+			]
+		);
+	}
 
 
-    /**
-     * @param array $registrations
-     * @return array
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    private function copyAttendeeInfoInputs(array $registrations): array
-    {
-        $copy_attendee_info_inputs = [];
-        $prev_ticket               = null;
-        foreach ($registrations as $registration) {
-            // for all  attendees other than the primary attendee
-            if ($registration instanceof EE_Registration && ! $registration->is_primary_registrant()) {
-                // if this is a new ticket OR if this is the very first additional attendee after the primary attendee
-                if ($registration->ticket()->ID() !== $prev_ticket) {
-                    $item_name   = $registration->ticket()->name();
-                    $item_name   .= $registration->ticket()->description() !== ''
-                        ? ' - ' . $registration->ticket()->description()
-                        : '';
-                    $copy_attendee_info_inputs[ 'spco_copy_attendee_chk[ticket-' . $registration->ticket()->ID() . ']' ]
-                                 = new EE_Form_Section_HTML(
-                                     '<h6 class="spco-copy-attendee-event-hdr">' . $item_name . '</h6>'
-                                 );
-                    $prev_ticket = $registration->ticket()->ID();
-                }
+	/**
+	 * @param array $registrations
+	 * @return array
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	private function copyAttendeeInfoInputs(array $registrations): array
+	{
+		$copy_attendee_info_inputs = [];
+		$prev_ticket               = null;
+		foreach ($registrations as $registration) {
+			// for all  attendees other than the primary attendee
+			if ($registration instanceof EE_Registration && ! $registration->is_primary_registrant()) {
+				// if this is a new ticket OR if this is the very first additional attendee after the primary attendee
+				if ($registration->ticket()->ID() !== $prev_ticket) {
+					$item_name   = $registration->ticket()->name();
+					$item_name   .= $registration->ticket()->description() !== ''
+						? ' - ' . $registration->ticket()->description()
+						: '';
+					$copy_attendee_info_inputs[ 'spco_copy_attendee_chk[ticket-' . $registration->ticket()->ID() . ']' ]
+								 = new EE_Form_Section_HTML(
+									 '<h6 class="spco-copy-attendee-event-hdr">' . $item_name . '</h6>'
+								 );
+					$prev_ticket = $registration->ticket()->ID();
+				}
 
-                $copy_attendee_info_inputs[ 'spco_copy_attendee_chk[' . $registration->ID() . ']' ]
-                    = new EE_Checkbox_Multi_Input(
-                        [
-                        $registration->ID() => sprintf(
-                            esc_html_x('Attendee #%s', 'Attendee #123', 'event_espresso'),
-                            $registration->count()
-                        )
-                        ],
-                        [
-                            'html_id'                 => 'spco-copy-attendee-chk-' . $registration->reg_url_link(),
-                            'html_class'              => 'spco-copy-attendee-chk ee-do-not-validate',
-                            'display_html_label_text' => false,
-                        ]
-                    );
-            }
-        }
-        return $copy_attendee_info_inputs;
-    }
+				$copy_attendee_info_inputs[ 'spco_copy_attendee_chk[' . $registration->ID() . ']' ]
+					= new EE_Checkbox_Multi_Input(
+						[
+						$registration->ID() => sprintf(
+							esc_html_x('Attendee #%s', 'Attendee #123', 'event_espresso'),
+							$registration->count()
+						)
+						],
+						[
+							'html_id'                 => 'spco-copy-attendee-chk-' . $registration->reg_url_link(),
+							'html_class'              => 'spco-copy-attendee-chk ee-do-not-validate',
+							'display_html_label_text' => false,
+						]
+					);
+			}
+		}
+		return $copy_attendee_info_inputs;
+	}
 }

Spacing +7 added lines, -7 removed lines

@@ -56,18 +56,18 @@ 
             if ($registration instanceof EE_Registration && ! $registration->is_primary_registrant()) {
                 // if this is a new ticket OR if this is the very first additional attendee after the primary attendee
                 if ($registration->ticket()->ID() !== $prev_ticket) {
-                    $item_name   = $registration->ticket()->name();
-                    $item_name   .= $registration->ticket()->description() !== ''
-                        ? ' - ' . $registration->ticket()->description()
+                    $item_name = $registration->ticket()->name();
+                    $item_name .= $registration->ticket()->description() !== ''
+                        ? ' - '.$registration->ticket()->description()
                         : '';
-                    $copy_attendee_info_inputs[ 'spco_copy_attendee_chk[ticket-' . $registration->ticket()->ID() . ']' ]
+                    $copy_attendee_info_inputs['spco_copy_attendee_chk[ticket-'.$registration->ticket()->ID().']']
                                  = new EE_Form_Section_HTML(
-                                     '<h6 class="spco-copy-attendee-event-hdr">' . $item_name . '</h6>'
+                                     '<h6 class="spco-copy-attendee-event-hdr">'.$item_name.'</h6>'
                                  );
                     $prev_ticket = $registration->ticket()->ID();
                 }
 
-                $copy_attendee_info_inputs[ 'spco_copy_attendee_chk[' . $registration->ID() . ']' ]
+                $copy_attendee_info_inputs['spco_copy_attendee_chk['.$registration->ID().']']
                     = new EE_Checkbox_Multi_Input(
                         [
                         $registration->ID() => sprintf(
@@ -76,7 +76,7 @@ 
                         )
                         ],
                         [
-                            'html_id'                 => 'spco-copy-attendee-chk-' . $registration->reg_url_link(),
+                            'html_id'                 => 'spco-copy-attendee-chk-'.$registration->reg_url_link(),
                             'html_class'              => 'spco-copy-attendee-chk ee-do-not-validate',
                             'display_html_label_text' => false,
                         ]

core/domain/services/registration/form/v1/RegForm.php

Spacing +14 added lines, -14 removed lines

@@ -139,7 +139,7 @@ 
      */
     public function addRequiredQuestion(string $identifier, string $required_question): void
     {
-        $this->required_questions[ $identifier ] = $required_question;
+        $this->required_questions[$identifier] = $required_question;
     }
 
 
@@ -203,17 +203,17 @@ 
                     // Increment the reg forms number if form is valid.
                     if ($registrant_form->hasQuestions()) {
                         $this->reg_form_count++;
-                        $subsections[ $reg_url_link ] = $registrant_form;
+                        $subsections[$reg_url_link] = $registrant_form;
                     } else {
                         // or just add a blank section if there are no questions
-                        $subsections[ $reg_url_link ] = new EE_Form_Section_HTML();
+                        $subsections[$reg_url_link] = new EE_Form_Section_HTML();
                     }
 
-                    $this->template_args['registrations'][ $reg_url_link ]                = $registration;
-                    $this->template_args['ticket_count'][ $registration->ticket()->ID() ] = isset(
-                        $this->template_args['ticket_count'][ $registration->ticket()->ID() ]
+                    $this->template_args['registrations'][$reg_url_link]                = $registration;
+                    $this->template_args['ticket_count'][$registration->ticket()->ID()] = isset(
+                        $this->template_args['ticket_count'][$registration->ticket()->ID()]
                     )
-                        ? $this->template_args['ticket_count'][ $registration->ticket()->ID() ] + 1
+                        ? $this->template_args['ticket_count'][$registration->ticket()->ID()] + 1
                         : 1;
                     $ticket_line_item = EEH_Line_Item::get_line_items_by_object_type_and_IDs(
                         $this->reg_step->checkout->cart->get_grand_total(),
@@ -223,7 +223,7 @@ 
                     $ticket_line_item = is_array($ticket_line_item)
                         ? reset($ticket_line_item)
                         : $ticket_line_item;
-                    $this->template_args['ticket_line_item'][ $registration->ticket()->ID() ] =
+                    $this->template_args['ticket_line_item'][$registration->ticket()->ID()] =
                         $Line_Item_Display->display_line_item($ticket_line_item);
                     if ($registration->is_primary_registrant()) {
                         $primary_registrant = $reg_url_link;
@@ -233,13 +233,13 @@ 
 
             if ($primary_registrant && count($registrations) > 1) {
                 if (
-                    isset($subsections[ $primary_registrant ])
-                    && $subsections[ $primary_registrant ] instanceof EE_Form_Section_Proper
+                    isset($subsections[$primary_registrant])
+                    && $subsections[$primary_registrant] instanceof EE_Form_Section_Proper
                 ) {
                     $copy_options['spco_copy_attendee_chk'] = $this->print_copy_info
                         ? new CopyAttendeeInfoForm($registrations, $this->reg_step->slug())
                         : new AutoCopyAttendeeInfoForm($this->reg_step->slug());
-                    $subsections[ $primary_registrant ]->add_subsections(
+                    $subsections[$primary_registrant]->add_subsections(
                         $copy_options,
                         'primary_registrant',
                         false
@@ -251,8 +251,8 @@ 
         // Set the registration form template (default: one form per ticket details table).
         // We decide the template to used based on the number of forms.
         $template = $this->reg_form_count > 1
-            ? SPCO_REG_STEPS_PATH . $this->reg_step->slug() . '/attendee_info_main.template.php'
-            : SPCO_REG_STEPS_PATH . $this->reg_step->slug() . '/attendee_info_single.template.php';
+            ? SPCO_REG_STEPS_PATH . $this->reg_step->slug().'/attendee_info_main.template.php'
+            : SPCO_REG_STEPS_PATH.$this->reg_step->slug().'/attendee_info_single.template.php';
         $this->reg_step->setTemplate($template);
 
         return $subsections;
@@ -266,7 +266,7 @@ 
     private function addPrivacyConsentCheckbox(EE_Form_Section_Proper $extra_inputs_section)
     {
         // if this isn't a revisit, and they have the privacy consent box enabled, add it
-        if (! $this->reg_step->checkout->revisit && $this->reg_config->isConsentCheckboxEnabled()) {
+        if ( ! $this->reg_step->checkout->revisit && $this->reg_config->isConsentCheckboxEnabled()) {
             $extra_inputs_section->add_subsections(
                 [
                     'consent_box' => new PrivacyConsentCheckboxForm(

Indentation +220 added lines, -220 removed lines

@@ -31,251 +31,251 @@
  */
 class RegForm extends EE_Form_Section_Proper
 {
-    /**
-     * @var bool
-     */
-    private $print_copy_info = false;
+	/**
+	 * @var bool
+	 */
+	private $print_copy_info = false;
 
-    /**
-     * @var EE_Registration_Config
-     */
-    public $reg_config;
+	/**
+	 * @var EE_Registration_Config
+	 */
+	public $reg_config;
 
-    /**
-     * @var int
-     */
-    protected $reg_form_count = 0;
+	/**
+	 * @var int
+	 */
+	protected $reg_form_count = 0;
 
-    /**
-     * @var EE_SPCO_Reg_Step_Attendee_Information
-     */
-    public $reg_step;
+	/**
+	 * @var EE_SPCO_Reg_Step_Attendee_Information
+	 */
+	public $reg_step;
 
-    /**
-     * @var array
-     */
-    private $required_questions = [];
+	/**
+	 * @var array
+	 */
+	private $required_questions = [];
 
-    /**
-     * @var array
-     */
-    private $template_args = [];
+	/**
+	 * @var array
+	 */
+	private $template_args = [];
 
 
-    /**
-     * RegForm constructor.
-     *
-     * @param EE_SPCO_Reg_Step_Attendee_Information $reg_step
-     * @param EE_Registration_Config                $reg_config
-     * @throws ReflectionException
-     * @throws EE_Error
-     */
-    public function __construct(
-        EE_SPCO_Reg_Step_Attendee_Information $reg_step,
-        EE_Registration_Config $reg_config
-    ) {
-        $this->reg_step   = $reg_step;
-        $this->reg_config = $reg_config;
-        // setup some classes so that they are ready for loading during construction of other classes
-        LoaderFactory::getShared(CountryOptions::class, [$this->reg_step->checkout->action]);
-        LoaderFactory::getShared(StateOptions::class, [$this->reg_step->checkout->action]);
-        LoaderFactory::getShared(RegFormQuestionFactory::class, [[$this, 'addRequiredQuestion']]);
-        parent::__construct(
-            [
-                'name'            => $this->reg_step->reg_form_name(),
-                'html_id'         => $this->reg_step->reg_form_name(),
-                'subsections'     => $this->generateSubsections(),
-                'layout_strategy' => new EE_Template_Layout(
-                    [
-                        'layout_template_file' => $this->reg_step->template(), // layout_template
-                        'template_args'        => $this->template_args,
-                    ]
-                ),
-            ]
-        );
-    }
+	/**
+	 * RegForm constructor.
+	 *
+	 * @param EE_SPCO_Reg_Step_Attendee_Information $reg_step
+	 * @param EE_Registration_Config                $reg_config
+	 * @throws ReflectionException
+	 * @throws EE_Error
+	 */
+	public function __construct(
+		EE_SPCO_Reg_Step_Attendee_Information $reg_step,
+		EE_Registration_Config $reg_config
+	) {
+		$this->reg_step   = $reg_step;
+		$this->reg_config = $reg_config;
+		// setup some classes so that they are ready for loading during construction of other classes
+		LoaderFactory::getShared(CountryOptions::class, [$this->reg_step->checkout->action]);
+		LoaderFactory::getShared(StateOptions::class, [$this->reg_step->checkout->action]);
+		LoaderFactory::getShared(RegFormQuestionFactory::class, [[$this, 'addRequiredQuestion']]);
+		parent::__construct(
+			[
+				'name'            => $this->reg_step->reg_form_name(),
+				'html_id'         => $this->reg_step->reg_form_name(),
+				'subsections'     => $this->generateSubsections(),
+				'layout_strategy' => new EE_Template_Layout(
+					[
+						'layout_template_file' => $this->reg_step->template(), // layout_template
+						'template_args'        => $this->template_args,
+					]
+				),
+			]
+		);
+	}
 
 
-    /**
-     * @return void
-     */
-    public function enablePrintCopyInfo(): void
-    {
-        $this->print_copy_info = true;
-    }
+	/**
+	 * @return void
+	 */
+	public function enablePrintCopyInfo(): void
+	{
+		$this->print_copy_info = true;
+	}
 
 
-    /**
-     * @return bool
-     */
-    public function printCopyInfo(): bool
-    {
-        return $this->print_copy_info;
-    }
+	/**
+	 * @return bool
+	 */
+	public function printCopyInfo(): bool
+	{
+		return $this->print_copy_info;
+	}
 
 
-    /**
-     * @return int
-     */
-    public function regFormCount(): int
-    {
-        return $this->reg_form_count;
-    }
+	/**
+	 * @return int
+	 */
+	public function regFormCount(): int
+	{
+		return $this->reg_form_count;
+	}
 
 
-    /**
-     * @return array
-     */
-    public function requiredQuestions(): array
-    {
-        return $this->required_questions;
-    }
+	/**
+	 * @return array
+	 */
+	public function requiredQuestions(): array
+	{
+		return $this->required_questions;
+	}
 
 
-    /**
-     * @param string $identifier
-     * @param string $required_question
-     */
-    public function addRequiredQuestion(string $identifier, string $required_question): void
-    {
-        $this->required_questions[ $identifier ] = $required_question;
-    }
+	/**
+	 * @param string $identifier
+	 * @param string $required_question
+	 */
+	public function addRequiredQuestion(string $identifier, string $required_question): void
+	{
+		$this->required_questions[ $identifier ] = $required_question;
+	}
 
 
-    /**
-     * @return EE_Form_Section_Proper[]
-     * @throws DomainException
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws ReflectionException
-     * @throws EntityNotFoundException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     */
-    private function generateSubsections(): array
-    {
-        // Init reg forms count.
-        $this->reg_form_count = 0;
+	/**
+	 * @return EE_Form_Section_Proper[]
+	 * @throws DomainException
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws ReflectionException
+	 * @throws EntityNotFoundException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 */
+	private function generateSubsections(): array
+	{
+		// Init reg forms count.
+		$this->reg_form_count = 0;
 
-        $primary_registrant = null;
-        // autoload Line_Item_Display classes
-        EEH_Autoloader::register_line_item_display_autoloaders();
-        $Line_Item_Display = new EE_Line_Item_Display();
-        // calculate taxes
-        $Line_Item_Display->display_line_item(
-            $this->reg_step->checkout->cart->get_grand_total(),
-            ['set_tax_rate' => true]
-        );
-        $extra_inputs_section = $this->reg_step->reg_step_hidden_inputs();
-        $this->addPrivacyConsentCheckbox($extra_inputs_section);
-        $subsections = [
-            'default_hidden_inputs' => $extra_inputs_section,
-        ];
+		$primary_registrant = null;
+		// autoload Line_Item_Display classes
+		EEH_Autoloader::register_line_item_display_autoloaders();
+		$Line_Item_Display = new EE_Line_Item_Display();
+		// calculate taxes
+		$Line_Item_Display->display_line_item(
+			$this->reg_step->checkout->cart->get_grand_total(),
+			['set_tax_rate' => true]
+		);
+		$extra_inputs_section = $this->reg_step->reg_step_hidden_inputs();
+		$this->addPrivacyConsentCheckbox($extra_inputs_section);
+		$subsections = [
+			'default_hidden_inputs' => $extra_inputs_section,
+		];
 
-        $this->template_args = [
-            'revisit'       => $this->reg_step->checkout->revisit,
-            'registrations' => [],
-            'ticket_count'  => [],
-        ];
-        // grab the saved registrations from the transaction
-        $registrations = $this->reg_step->checkout->transaction->registrations(
-            $this->reg_step->checkout->reg_cache_where_params
-        );
-        if ($registrations) {
-            foreach ($registrations as $registration) {
-                // can this registration be processed during this visit ?
-                if (
-                    $registration instanceof EE_Registration
-                    && $this->reg_step->checkout->visit_allows_processing_of_this_registration($registration)
-                ) {
-                    $reg_url_link = $registration->reg_url_link();
-                    /** @var RegistrantForm $registrant_form */
-                    $registrant_form = LoaderFactory::getNew(
-                        RegistrantForm::class,
-                        [
-                            $registration,
-                            $this->reg_config->copyAttendeeInfo(),
-                            [$this, 'enablePrintCopyInfo'],
-                            $this->reg_step,
-                        ]
-                    );
-                    // Increment the reg forms number if form is valid.
-                    if ($registrant_form->hasQuestions()) {
-                        $this->reg_form_count++;
-                        $subsections[ $reg_url_link ] = $registrant_form;
-                    } else {
-                        // or just add a blank section if there are no questions
-                        $subsections[ $reg_url_link ] = new EE_Form_Section_HTML();
-                    }
+		$this->template_args = [
+			'revisit'       => $this->reg_step->checkout->revisit,
+			'registrations' => [],
+			'ticket_count'  => [],
+		];
+		// grab the saved registrations from the transaction
+		$registrations = $this->reg_step->checkout->transaction->registrations(
+			$this->reg_step->checkout->reg_cache_where_params
+		);
+		if ($registrations) {
+			foreach ($registrations as $registration) {
+				// can this registration be processed during this visit ?
+				if (
+					$registration instanceof EE_Registration
+					&& $this->reg_step->checkout->visit_allows_processing_of_this_registration($registration)
+				) {
+					$reg_url_link = $registration->reg_url_link();
+					/** @var RegistrantForm $registrant_form */
+					$registrant_form = LoaderFactory::getNew(
+						RegistrantForm::class,
+						[
+							$registration,
+							$this->reg_config->copyAttendeeInfo(),
+							[$this, 'enablePrintCopyInfo'],
+							$this->reg_step,
+						]
+					);
+					// Increment the reg forms number if form is valid.
+					if ($registrant_form->hasQuestions()) {
+						$this->reg_form_count++;
+						$subsections[ $reg_url_link ] = $registrant_form;
+					} else {
+						// or just add a blank section if there are no questions
+						$subsections[ $reg_url_link ] = new EE_Form_Section_HTML();
+					}
 
-                    $this->template_args['registrations'][ $reg_url_link ]                = $registration;
-                    $this->template_args['ticket_count'][ $registration->ticket()->ID() ] = isset(
-                        $this->template_args['ticket_count'][ $registration->ticket()->ID() ]
-                    )
-                        ? $this->template_args['ticket_count'][ $registration->ticket()->ID() ] + 1
-                        : 1;
-                    $ticket_line_item = EEH_Line_Item::get_line_items_by_object_type_and_IDs(
-                        $this->reg_step->checkout->cart->get_grand_total(),
-                        'Ticket',
-                        [$registration->ticket()->ID()]
-                    );
-                    $ticket_line_item = is_array($ticket_line_item)
-                        ? reset($ticket_line_item)
-                        : $ticket_line_item;
-                    $this->template_args['ticket_line_item'][ $registration->ticket()->ID() ] =
-                        $Line_Item_Display->display_line_item($ticket_line_item);
-                    if ($registration->is_primary_registrant()) {
-                        $primary_registrant = $reg_url_link;
-                    }
-                }
-            }
+					$this->template_args['registrations'][ $reg_url_link ]                = $registration;
+					$this->template_args['ticket_count'][ $registration->ticket()->ID() ] = isset(
+						$this->template_args['ticket_count'][ $registration->ticket()->ID() ]
+					)
+						? $this->template_args['ticket_count'][ $registration->ticket()->ID() ] + 1
+						: 1;
+					$ticket_line_item = EEH_Line_Item::get_line_items_by_object_type_and_IDs(
+						$this->reg_step->checkout->cart->get_grand_total(),
+						'Ticket',
+						[$registration->ticket()->ID()]
+					);
+					$ticket_line_item = is_array($ticket_line_item)
+						? reset($ticket_line_item)
+						: $ticket_line_item;
+					$this->template_args['ticket_line_item'][ $registration->ticket()->ID() ] =
+						$Line_Item_Display->display_line_item($ticket_line_item);
+					if ($registration->is_primary_registrant()) {
+						$primary_registrant = $reg_url_link;
+					}
+				}
+			}
 
-            if ($primary_registrant && count($registrations) > 1) {
-                if (
-                    isset($subsections[ $primary_registrant ])
-                    && $subsections[ $primary_registrant ] instanceof EE_Form_Section_Proper
-                ) {
-                    $copy_options['spco_copy_attendee_chk'] = $this->print_copy_info
-                        ? new CopyAttendeeInfoForm($registrations, $this->reg_step->slug())
-                        : new AutoCopyAttendeeInfoForm($this->reg_step->slug());
-                    $subsections[ $primary_registrant ]->add_subsections(
-                        $copy_options,
-                        'primary_registrant',
-                        false
-                    );
-                }
-            }
-        }
+			if ($primary_registrant && count($registrations) > 1) {
+				if (
+					isset($subsections[ $primary_registrant ])
+					&& $subsections[ $primary_registrant ] instanceof EE_Form_Section_Proper
+				) {
+					$copy_options['spco_copy_attendee_chk'] = $this->print_copy_info
+						? new CopyAttendeeInfoForm($registrations, $this->reg_step->slug())
+						: new AutoCopyAttendeeInfoForm($this->reg_step->slug());
+					$subsections[ $primary_registrant ]->add_subsections(
+						$copy_options,
+						'primary_registrant',
+						false
+					);
+				}
+			}
+		}
 
-        // Set the registration form template (default: one form per ticket details table).
-        // We decide the template to used based on the number of forms.
-        $template = $this->reg_form_count > 1
-            ? SPCO_REG_STEPS_PATH . $this->reg_step->slug() . '/attendee_info_main.template.php'
-            : SPCO_REG_STEPS_PATH . $this->reg_step->slug() . '/attendee_info_single.template.php';
-        $this->reg_step->setTemplate($template);
+		// Set the registration form template (default: one form per ticket details table).
+		// We decide the template to used based on the number of forms.
+		$template = $this->reg_form_count > 1
+			? SPCO_REG_STEPS_PATH . $this->reg_step->slug() . '/attendee_info_main.template.php'
+			: SPCO_REG_STEPS_PATH . $this->reg_step->slug() . '/attendee_info_single.template.php';
+		$this->reg_step->setTemplate($template);
 
-        return $subsections;
-    }
+		return $subsections;
+	}
 
 
-    /**
-     * @param EE_Form_Section_Proper $extra_inputs_section
-     * @throws EE_Error
-     */
-    private function addPrivacyConsentCheckbox(EE_Form_Section_Proper $extra_inputs_section)
-    {
-        // if this isn't a revisit, and they have the privacy consent box enabled, add it
-        if (! $this->reg_step->checkout->revisit && $this->reg_config->isConsentCheckboxEnabled()) {
-            $extra_inputs_section->add_subsections(
-                [
-                    'consent_box' => new PrivacyConsentCheckboxForm(
-                        $this->reg_step->slug(),
-                        $this->reg_config->getConsentCheckboxLabelText()
-                    )
-                ],
-                null,
-                false
-            );
-        }
-    }
+	/**
+	 * @param EE_Form_Section_Proper $extra_inputs_section
+	 * @throws EE_Error
+	 */
+	private function addPrivacyConsentCheckbox(EE_Form_Section_Proper $extra_inputs_section)
+	{
+		// if this isn't a revisit, and they have the privacy consent box enabled, add it
+		if (! $this->reg_step->checkout->revisit && $this->reg_config->isConsentCheckboxEnabled()) {
+			$extra_inputs_section->add_subsections(
+				[
+					'consent_box' => new PrivacyConsentCheckboxForm(
+						$this->reg_step->slug(),
+						$this->reg_config->getConsentCheckboxLabelText()
+					)
+				],
+				null,
+				false
+			);
+		}
+	}
 }

core/db_models/EEM_Form_Submission.model.php

Indentation +114 added lines, -114 removed lines

@@ -11,130 +11,130 @@
  */
 class EEM_Form_Submission extends EEM_Base
 {
-    /**
-     * @var EEM_Form_Submission
-     */
-    protected static $_instance;
+	/**
+	 * @var EEM_Form_Submission
+	 */
+	protected static $_instance;
 
-    /**
-     * @var RequestInterface
-     */
-    private $request;
+	/**
+	 * @var RequestInterface
+	 */
+	private $request;
 
 
-    /**
-     * EEM_Form_Submission constructor.
-     *
-     * @param string|null $timezone
-     * @throws EE_Error
-     */
-    protected function __construct(?string $timezone)
-    {
-        $this->singular_item = esc_html__('Form Submission', 'event_espresso');
-        $this->plural_item   = esc_html__('Form Submissions', 'event_espresso');
+	/**
+	 * EEM_Form_Submission constructor.
+	 *
+	 * @param string|null $timezone
+	 * @throws EE_Error
+	 */
+	protected function __construct(?string $timezone)
+	{
+		$this->singular_item = esc_html__('Form Submission', 'event_espresso');
+		$this->plural_item   = esc_html__('Form Submissions', 'event_espresso');
 
-        $this->_tables          = [
-            'Form_Submission' => new EE_Primary_Table('esp_form_submission', 'FSB_UUID'),
-        ];
-        $this->_fields          = [
-            'Form_Submission' => [
-                'FSB_UUID'      => new EE_Primary_Key_String_Field(
-                    'FSB_UUID',
-                    esc_html__('Form Submission UUID (universally unique identifier)', 'event_espresso')
-                ),
-                'FSC_UUID'      => new EE_Foreign_Key_String_Field(
-                    'FSC_UUID',
-                    esc_html__('Form Section UUID (universally unique identifier)', 'event_espresso'),
-                    false,
-                    '',
-                    'Form_Section',
-                    false
-                ),
-                'TXN_ID'        => new EE_Foreign_Key_Int_Field(
-                    'TXN_ID',
-                    esc_html__('Transaction ID', 'event_espresso'),
-                    false,
-                    0,
-                    'Transaction'
-                ),
-                'FSB_data'      => new EE_JSON_Field(
-                    'FSB_data',
-                    esc_html__('Serialized form submission data', 'event_espresso'),
-                    true,
-                    null
-                ),
-                'FSB_submitted' => new EE_Datetime_Field(
-                    'FSB_submitted',
-                    esc_html__('Form submission timestamp', 'event_espresso'),
-                    false,
-                    EE_Datetime_Field::now,
-                    $timezone
-                ),
-            ],
-        ];
-        $this->_model_relations = [
-            'Form_Section' => new EE_Belongs_To_Relation(),
-            'Transaction'  => new EE_Belongs_To_Relation(),
-        ];
-        parent::__construct($timezone);
-        $this->request = $this->getLoader()->getShared('EventEspresso\core\services\request\RequestInterface');
-    }
+		$this->_tables          = [
+			'Form_Submission' => new EE_Primary_Table('esp_form_submission', 'FSB_UUID'),
+		];
+		$this->_fields          = [
+			'Form_Submission' => [
+				'FSB_UUID'      => new EE_Primary_Key_String_Field(
+					'FSB_UUID',
+					esc_html__('Form Submission UUID (universally unique identifier)', 'event_espresso')
+				),
+				'FSC_UUID'      => new EE_Foreign_Key_String_Field(
+					'FSC_UUID',
+					esc_html__('Form Section UUID (universally unique identifier)', 'event_espresso'),
+					false,
+					'',
+					'Form_Section',
+					false
+				),
+				'TXN_ID'        => new EE_Foreign_Key_Int_Field(
+					'TXN_ID',
+					esc_html__('Transaction ID', 'event_espresso'),
+					false,
+					0,
+					'Transaction'
+				),
+				'FSB_data'      => new EE_JSON_Field(
+					'FSB_data',
+					esc_html__('Serialized form submission data', 'event_espresso'),
+					true,
+					null
+				),
+				'FSB_submitted' => new EE_Datetime_Field(
+					'FSB_submitted',
+					esc_html__('Form submission timestamp', 'event_espresso'),
+					false,
+					EE_Datetime_Field::now,
+					$timezone
+				),
+			],
+		];
+		$this->_model_relations = [
+			'Form_Section' => new EE_Belongs_To_Relation(),
+			'Transaction'  => new EE_Belongs_To_Relation(),
+		];
+		parent::__construct($timezone);
+		$this->request = $this->getLoader()->getShared('EventEspresso\core\services\request\RequestInterface');
+	}
 
 
-    /**
-     * adds all default where conditions unless the current request originates from the admin
-     *
-     * @param array $query_params
-     * @return array
-     */
-    private function addDefaultWhereConditions(array $query_params): array
-    {
-        // might need to add a way to identify GQL requests for admin domains
-        $query_params['default_where_conditions'] = $this->request->isAdmin() || $this->request->isAdminAjax()
-            ? EEM_Base::default_where_conditions_none
-            : EEM_Base::default_where_conditions_all;
-        return $query_params;
-    }
+	/**
+	 * adds all default where conditions unless the current request originates from the admin
+	 *
+	 * @param array $query_params
+	 * @return array
+	 */
+	private function addDefaultWhereConditions(array $query_params): array
+	{
+		// might need to add a way to identify GQL requests for admin domains
+		$query_params['default_where_conditions'] = $this->request->isAdmin() || $this->request->isAdminAjax()
+			? EEM_Base::default_where_conditions_none
+			: EEM_Base::default_where_conditions_all;
+		return $query_params;
+	}
 
 
-    /**
-     * form sections should always be sorted in ascending order via the FSC_order field
-     *
-     * @param array $query_params
-     * @return array
-     */
-    private function addOrderByQueryParams(array $query_params): array
-    {
-        $query_params['order_by'] = ['FSB_submitted' => 'ASC'];
-        return $query_params;
-    }
+	/**
+	 * form sections should always be sorted in ascending order via the FSC_order field
+	 *
+	 * @param array $query_params
+	 * @return array
+	 */
+	private function addOrderByQueryParams(array $query_params): array
+	{
+		$query_params['order_by'] = ['FSB_submitted' => 'ASC'];
+		return $query_params;
+	}
 
 
-    /**
-     * @param EE_Event $event
-     * @return EE_Form_Submission[]|null
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    public function getAllFormSubmissionsForEvent(EE_Event $event): ?array
-    {
-        $query_params = [['FSC_UUID' => $event->registrationFormUuid()]];
-        $query_params = $this->addDefaultWhereConditions($query_params);
-        $query_params = $this->addOrderByQueryParams($query_params);
-        return $this->get_all($query_params);
-    }
+	/**
+	 * @param EE_Event $event
+	 * @return EE_Form_Submission[]|null
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	public function getAllFormSubmissionsForEvent(EE_Event $event): ?array
+	{
+		$query_params = [['FSC_UUID' => $event->registrationFormUuid()]];
+		$query_params = $this->addDefaultWhereConditions($query_params);
+		$query_params = $this->addOrderByQueryParams($query_params);
+		return $this->get_all($query_params);
+	}
 
 
-    /**
-     * @param EE_Transaction $transaction
-     * @return EE_Form_Submission|null
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    public function getFormSubmissionForTransaction(EE_Transaction $transaction): ?EE_Form_Submission
-    {
-        $query_params = [['TXN_ID' => $transaction->ID()]];
-        $query_params = $this->addDefaultWhereConditions($query_params);
-        return $this->get_one($query_params);
-    }
+	/**
+	 * @param EE_Transaction $transaction
+	 * @return EE_Form_Submission|null
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	public function getFormSubmissionForTransaction(EE_Transaction $transaction): ?EE_Form_Submission
+	{
+		$query_params = [['TXN_ID' => $transaction->ID()]];
+		$query_params = $this->addDefaultWhereConditions($query_params);
+		return $this->get_one($query_params);
+	}
 }

core/services/orm/tree_traversal/NodeGroupDao.php

Spacing +5 added lines, -5 removed lines

@@ -50,7 +50,7 @@ 
      */
     public function getModelObjNodesInGroup($code)
     {
-        if (! $code) {
+        if ( ! $code) {
             throw new Exception(
                 esc_html__(
                     'We aren’t sure which job you are performing. Please press back in your browser and try again.',
@@ -58,9 +58,9 @@ 
                 )
             );
         }
-        $deletion_data = get_option($this->getOptionPrefix() . $code, []);
+        $deletion_data = get_option($this->getOptionPrefix().$code, []);
         foreach ($deletion_data as $root) {
-            if (! $root instanceof ModelObjNode) {
+            if ( ! $root instanceof ModelObjNode) {
                 throw new UnexpectedEntityException($root, 'ModelObjNode');
             }
         }
@@ -121,7 +121,7 @@ 
     public function persistModelObjNodesGroup(array $model_obj_nodes, $code)
     {
         return add_option(
-            $this->getOptionPrefix() . $code,
+            $this->getOptionPrefix().$code,
             $model_obj_nodes,
             null,
             'no'
@@ -137,7 +137,7 @@ 
      */
     public function deleteModelObjNodesInGroup($code)
     {
-        return delete_option($this->getOptionPrefix() . $code);
+        return delete_option($this->getOptionPrefix().$code);
     }
 }
 // End of file NodeGroupDao.php

Indentation +107 added lines, -107 removed lines

@@ -22,125 +22,125 @@
  */
 class NodeGroupDao
 {
-    /**
-     * @return mixed|void
-     */
-    public function generateGroupCode()
-    {
-        return wp_generate_password(6, false);
-    }
+	/**
+	 * @return mixed|void
+	 */
+	public function generateGroupCode()
+	{
+		return wp_generate_password(6, false);
+	}
 
 
-    /**
-     * Gets the string we put in front of the WP Option name used to store the jobs.
-     *
-     * @return string
-     */
-    private function getOptionPrefix()
-    {
-        return 'ee_deletion_';
-    }
+	/**
+	 * Gets the string we put in front of the WP Option name used to store the jobs.
+	 *
+	 * @return string
+	 */
+	private function getOptionPrefix()
+	{
+		return 'ee_deletion_';
+	}
 
 
-    /**
-     * @param $code
-     * @return ModelObjNode[]
-     * @throws Exception
-     * @throws UnexpectedEntityException
-     * @throws Exception
-     */
-    public function getModelObjNodesInGroup($code)
-    {
-        if (! $code) {
-            throw new Exception(
-                esc_html__(
-                    'We aren’t sure which job you are performing. Please press back in your browser and try again.',
-                    'event_espresso'
-                )
-            );
-        }
-        $deletion_data = get_option($this->getOptionPrefix() . $code, []);
-        foreach ($deletion_data as $root) {
-            if (! $root instanceof ModelObjNode) {
-                throw new UnexpectedEntityException($root, 'ModelObjNode');
-            }
-        }
-        return $deletion_data;
-    }
+	/**
+	 * @param $code
+	 * @return ModelObjNode[]
+	 * @throws Exception
+	 * @throws UnexpectedEntityException
+	 * @throws Exception
+	 */
+	public function getModelObjNodesInGroup($code)
+	{
+		if (! $code) {
+			throw new Exception(
+				esc_html__(
+					'We aren’t sure which job you are performing. Please press back in your browser and try again.',
+					'event_espresso'
+				)
+			);
+		}
+		$deletion_data = get_option($this->getOptionPrefix() . $code, []);
+		foreach ($deletion_data as $root) {
+			if (! $root instanceof ModelObjNode) {
+				throw new UnexpectedEntityException($root, 'ModelObjNode');
+			}
+		}
+		return $deletion_data;
+	}
 
 
-    /**
-     * Gets an array indicating what database rows are contained in the job.
-     * Each top-level key is a model name, and its value is an array of IDs.
-     *
-     * @param ModelObjNode[] $model_obj_nodes
-     * @return array
-     * @throws EE_Error
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     * @throws InvalidArgumentException
-     * @throws ReflectionException
-     */
-    public function getModelsAndIdsContainedIn(array $model_obj_nodes)
-    {
-        $models_and_ids_to_delete = [];
-        foreach ($model_obj_nodes as $root) {
-            $models_and_ids_to_delete = array_replace_recursive($models_and_ids_to_delete, $root->getIds());
-        }
-        return $models_and_ids_to_delete;
-    }
+	/**
+	 * Gets an array indicating what database rows are contained in the job.
+	 * Each top-level key is a model name, and its value is an array of IDs.
+	 *
+	 * @param ModelObjNode[] $model_obj_nodes
+	 * @return array
+	 * @throws EE_Error
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 * @throws InvalidArgumentException
+	 * @throws ReflectionException
+	 */
+	public function getModelsAndIdsContainedIn(array $model_obj_nodes)
+	{
+		$models_and_ids_to_delete = [];
+		foreach ($model_obj_nodes as $root) {
+			$models_and_ids_to_delete = array_replace_recursive($models_and_ids_to_delete, $root->getIds());
+		}
+		return $models_and_ids_to_delete;
+	}
 
 
-    /**
-     * Gets an array indicating what database rows are contained in the job.
-     * Each top-level key is a model name, and its value is an array of IDs.
-     *
-     * @param string $code
-     * @return array
-     * @throws EE_Error
-     * @throws Exception
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     * @throws ReflectionException
-     * @throws UnexpectedEntityException
-     * @throws Exception
-     */
-    public function getModelsAndIdsFromGroup($code)
-    {
-        $model_obj_nodes = $this->getModelObjNodesInGroup($code);
-        return $this->getModelsAndIdsContainedIn($model_obj_nodes);
-    }
+	/**
+	 * Gets an array indicating what database rows are contained in the job.
+	 * Each top-level key is a model name, and its value is an array of IDs.
+	 *
+	 * @param string $code
+	 * @return array
+	 * @throws EE_Error
+	 * @throws Exception
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 * @throws ReflectionException
+	 * @throws UnexpectedEntityException
+	 * @throws Exception
+	 */
+	public function getModelsAndIdsFromGroup($code)
+	{
+		$model_obj_nodes = $this->getModelObjNodesInGroup($code);
+		return $this->getModelsAndIdsContainedIn($model_obj_nodes);
+	}
 
 
-    /**
-     * Persists the ModelObjNodes for future requests, using the code for reference.
-     *
-     * @param ModelObjNode[] $model_obj_nodes
-     * @param string         $code
-     * @return bool
-     */
-    public function persistModelObjNodesGroup(array $model_obj_nodes, $code)
-    {
-        return add_option(
-            $this->getOptionPrefix() . $code,
-            $model_obj_nodes,
-            null,
-            'no'
-        );
-    }
+	/**
+	 * Persists the ModelObjNodes for future requests, using the code for reference.
+	 *
+	 * @param ModelObjNode[] $model_obj_nodes
+	 * @param string         $code
+	 * @return bool
+	 */
+	public function persistModelObjNodesGroup(array $model_obj_nodes, $code)
+	{
+		return add_option(
+			$this->getOptionPrefix() . $code,
+			$model_obj_nodes,
+			null,
+			'no'
+		);
+	}
 
 
-    /**
-     * Forgets about the group of ModelObjNodes. Doesn't delete the rows in the database they reference though.
-     *
-     * @param $code
-     * @return bool
-     */
-    public function deleteModelObjNodesInGroup($code)
-    {
-        return delete_option($this->getOptionPrefix() . $code);
-    }
+	/**
+	 * Forgets about the group of ModelObjNodes. Doesn't delete the rows in the database they reference though.
+	 *
+	 * @param $code
+	 * @return bool
+	 */
+	public function deleteModelObjNodesInGroup($code)
+	{
+		return delete_option($this->getOptionPrefix() . $code);
+	}
 }
 // End of file NodeGroupDao.php
 // Location: EventEspresso\core\services\orm\tree_traversal/NodeGroupDao.php

core/services/orm/tree_traversal/RelationNode.php

Spacing +8 added lines, -8 removed lines

@@ -98,17 +98,17 @@ 
                     ],
                 ]
             );
-            $new_item_nodes     = [];
+            $new_item_nodes = [];
 
             // Add entity nodes for each of the model objects we fetched.
             foreach ($related_model_objs as $related_model_obj) {
-                $entity_node                                = new ModelObjNode(
+                $entity_node = new ModelObjNode(
                     $related_model_obj->ID(),
                     $related_model_obj->get_model(),
                     $this->dont_traverse_models
                 );
-                $this->nodes[ $related_model_obj->ID() ]    = $entity_node;
-                $new_item_nodes[ $related_model_obj->ID() ] = $entity_node;
+                $this->nodes[$related_model_obj->ID()]    = $entity_node;
+                $new_item_nodes[$related_model_obj->ID()] = $entity_node;
             }
             $num_identified += count($new_item_nodes);
             if ($num_identified < $model_objects_to_identify) {
@@ -135,7 +135,7 @@ 
     protected function allChildrenComplete()
     {
         foreach ($this->nodes as $model_obj_node) {
-            if (! $model_obj_node->isComplete()) {
+            if ( ! $model_obj_node->isComplete()) {
                 return false;
             }
         }
@@ -153,7 +153,7 @@ 
     protected function visitAlreadyDiscoveredNodes($model_obj_nodes, $work_budget)
     {
         $work_done = 0;
-        if (! $model_obj_nodes) {
+        if ( ! $model_obj_nodes) {
             return 0;
         }
         foreach ($model_obj_nodes as $model_obj_node) {
@@ -229,7 +229,7 @@ 
             $relation_settings = null;
         }
         if ($relation_settings instanceof EE_Has_Many_Any_Relation) {
-            $where_params[ $this->related_model->get_field_containing_related_model_name()->get_name() ] =
+            $where_params[$this->related_model->get_field_containing_related_model_name()->get_name()] =
                 $this->main_model->get_this_model_name();
         }
         return $where_params;
@@ -249,7 +249,7 @@ 
             'objs'     => [],
         ];
         foreach ($this->nodes as $id => $model_obj_node) {
-            $tree['objs'][ $id ] = $model_obj_node->toArray();
+            $tree['objs'][$id] = $model_obj_node->toArray();
         }
         return $tree;
     }

Indentation +303 added lines, -303 removed lines

@@ -24,309 +24,309 @@
  */
 class RelationNode extends BaseNode
 {
-    /**
-     * @var int
-     */
-    protected $count;
-
-    /**
-     * @var string|int
-     */
-    protected $id;
-
-    /**
-     * @var EEM_Base
-     */
-    protected $main_model;
-
-    /**
-     * @var ModelObjNode[]
-     */
-    protected $nodes;
-
-    /**
-     * @var EEM_Base
-     */
-    protected $related_model;
-
-
-
-    /**
-     * RelationNode constructor.
-     *
-     * @param          $main_model_obj_id
-     * @param EEM_Base $main_model
-     * @param EEM_Base $related_model
-     * @param array    $dont_traverse_models array of model names we DON'T want to traverse
-     */
-    public function __construct(
-        $main_model_obj_id,
-        EEM_Base $main_model,
-        EEM_Base $related_model,
-        array $dont_traverse_models = []
-    ) {
-        $this->id                   = $main_model_obj_id;
-        $this->main_model           = $main_model;
-        $this->related_model        = $related_model;
-        $this->nodes                = [];
-        $this->dont_traverse_models = $dont_traverse_models;
-    }
-
-
-    /**
-     * Here is where most of the work happens. We've counted how many related model objects exist, here we identify
-     * them (ie, learn their IDs). But its recursive, so we'll also find their related dependent model objects etc.
-     *
-     * @param int $model_objects_to_identify
-     * @return int
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     * @throws ReflectionException
-     */
-    protected function work($model_objects_to_identify)
-    {
-        $num_identified = $this->visitAlreadyDiscoveredNodes($this->nodes, $model_objects_to_identify);
-        if ($num_identified < $model_objects_to_identify) {
-            $related_model_objs = $this->related_model->get_all(
-                [
-                    $this->whereQueryParams(),
-                    'limit' => [
-                        count($this->nodes),
-                        $model_objects_to_identify - $num_identified,
-                    ],
-                ]
-            );
-            $new_item_nodes     = [];
-
-            // Add entity nodes for each of the model objects we fetched.
-            foreach ($related_model_objs as $related_model_obj) {
-                $entity_node                                = new ModelObjNode(
-                    $related_model_obj->ID(),
-                    $related_model_obj->get_model(),
-                    $this->dont_traverse_models
-                );
-                $this->nodes[ $related_model_obj->ID() ]    = $entity_node;
-                $new_item_nodes[ $related_model_obj->ID() ] = $entity_node;
-            }
-            $num_identified += count($new_item_nodes);
-            if ($num_identified < $model_objects_to_identify) {
-                // And lastly do the work.
-                $num_identified += $this->visitAlreadyDiscoveredNodes(
-                    $new_item_nodes,
-                    $model_objects_to_identify - $num_identified
-                );
-            }
-        }
-
-        if (count($this->nodes) >= $this->count && $this->allChildrenComplete()) {
-            $this->complete = true;
-        }
-        return $num_identified;
-    }
-
-
-    /**
-     * Checks if all the identified child nodes are complete or not.
-     *
-     * @return bool
-     */
-    protected function allChildrenComplete()
-    {
-        foreach ($this->nodes as $model_obj_node) {
-            if (! $model_obj_node->isComplete()) {
-                return false;
-            }
-        }
-        return true;
-    }
-
-
-    /**
-     * Visits the provided nodes and keeps track of how much work was done, making sure to not go over budget.
-     *
-     * @param ModelObjNode[] $model_obj_nodes
-     * @param                $work_budget
-     * @return int
-     */
-    protected function visitAlreadyDiscoveredNodes($model_obj_nodes, $work_budget)
-    {
-        $work_done = 0;
-        if (! $model_obj_nodes) {
-            return 0;
-        }
-        foreach ($model_obj_nodes as $model_obj_node) {
-            if ($work_done >= $work_budget) {
-                break;
-            }
-            $work_done += $model_obj_node->visit($work_budget - $work_done);
-        }
-        return $work_done;
-    }
-
-
-    /**
-     * Whether this item has already been initialized
-     */
-    protected function isDiscovered()
-    {
-        return $this->count !== null;
-    }
-
-
-    /**
-     * @return boolean
-     */
-    public function isComplete()
-    {
-        if ($this->complete === null) {
-            if (count($this->nodes) === $this->count) {
-                $this->complete = true;
-            } else {
-                $this->complete = false;
-            }
-        }
-        return $this->complete;
-    }
-
-
-    /**
-     * Discovers how many related model objects exist.
-     *
-     * @return void
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     */
-    protected function discover()
-    {
-        $this->count = $this->related_model->count([$this->whereQueryParams()]);
-    }
-
-
-    /**
-     * @return array
-     * @throws EE_Error
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     * @throws InvalidArgumentException
-     */
-    protected function whereQueryParams()
-    {
-        $where_params = [
-            $this->related_model->get_foreign_key_to(
-                $this->main_model->get_this_model_name()
-            )->get_name() => $this->id,
-        ];
-        try {
-            $relation_settings = $this->main_model->related_settings_for($this->related_model->get_this_model_name());
-        } catch (EE_Error $e) {
-            // This will happen for has-and-belongs-to-many relations, when this node's related model is that join table
-            // which hasn't been explicitly declared in the main model object's model's relations.
-            $relation_settings = null;
-        }
-        if ($relation_settings instanceof EE_Has_Many_Any_Relation) {
-            $where_params[ $this->related_model->get_field_containing_related_model_name()->get_name() ] =
-                $this->main_model->get_this_model_name();
-        }
-        return $where_params;
-    }
-
-
-    /**
-     * @return array
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    public function toArray()
-    {
-        $tree = [
-            'count'    => $this->count,
-            'complete' => $this->isComplete(),
-            'objs'     => [],
-        ];
-        foreach ($this->nodes as $id => $model_obj_node) {
-            $tree['objs'][ $id ] = $model_obj_node->toArray();
-        }
-        return $tree;
-    }
-
-
-    /**
-     * Gets the IDs of all the model objects to delete; indexed first by model object name.
-     *
-     * @return array
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    public function getIds()
-    {
-        if (empty($this->nodes)) {
-            return [];
-        }
-        $ids = [
-            $this->related_model->get_this_model_name() => array_combine(
-                array_keys($this->nodes),
-                array_keys($this->nodes)
-            ),
-        ];
-        foreach ($this->nodes as $model_obj_node) {
-            $ids = array_replace_recursive($ids, $model_obj_node->getIds());
-        }
-        return $ids;
-    }
-
-
-    /**
-     * Returns the number of sub-nodes found (ie, related model objects across this relation.)
-     *
-     * @return int
-     */
-    public function countSubNodes()
-    {
-        return count($this->nodes);
-    }
-
-
-    /**
-     * Don't serialize the models. Just record their names on some dynamic properties.
-     *
-     * @return array
-     */
-    public function __sleep()
-    {
-        $this->m  = $this->main_model->get_this_model_name();
-        $this->rm = $this->related_model->get_this_model_name();
-        return array_merge(
-            [
-                'm',
-                'rm',
-                'id',
-                'count',
-                'nodes',
-            ],
-            parent::__sleep()
-        );
-    }
-
-
-    /**
-     * Use the dynamic properties to instantiate the models we use.
-     *
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     * @throws ReflectionException
-     */
-    public function __wakeup()
-    {
-        $this->main_model    = EE_Registry::instance()->load_model($this->m);
-        $this->related_model = EE_Registry::instance()->load_model($this->rm);
-        parent::__wakeup();
-    }
+	/**
+	 * @var int
+	 */
+	protected $count;
+
+	/**
+	 * @var string|int
+	 */
+	protected $id;
+
+	/**
+	 * @var EEM_Base
+	 */
+	protected $main_model;
+
+	/**
+	 * @var ModelObjNode[]
+	 */
+	protected $nodes;
+
+	/**
+	 * @var EEM_Base
+	 */
+	protected $related_model;
+
+
+
+	/**
+	 * RelationNode constructor.
+	 *
+	 * @param          $main_model_obj_id
+	 * @param EEM_Base $main_model
+	 * @param EEM_Base $related_model
+	 * @param array    $dont_traverse_models array of model names we DON'T want to traverse
+	 */
+	public function __construct(
+		$main_model_obj_id,
+		EEM_Base $main_model,
+		EEM_Base $related_model,
+		array $dont_traverse_models = []
+	) {
+		$this->id                   = $main_model_obj_id;
+		$this->main_model           = $main_model;
+		$this->related_model        = $related_model;
+		$this->nodes                = [];
+		$this->dont_traverse_models = $dont_traverse_models;
+	}
+
+
+	/**
+	 * Here is where most of the work happens. We've counted how many related model objects exist, here we identify
+	 * them (ie, learn their IDs). But its recursive, so we'll also find their related dependent model objects etc.
+	 *
+	 * @param int $model_objects_to_identify
+	 * @return int
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 * @throws ReflectionException
+	 */
+	protected function work($model_objects_to_identify)
+	{
+		$num_identified = $this->visitAlreadyDiscoveredNodes($this->nodes, $model_objects_to_identify);
+		if ($num_identified < $model_objects_to_identify) {
+			$related_model_objs = $this->related_model->get_all(
+				[
+					$this->whereQueryParams(),
+					'limit' => [
+						count($this->nodes),
+						$model_objects_to_identify - $num_identified,
+					],
+				]
+			);
+			$new_item_nodes     = [];
+
+			// Add entity nodes for each of the model objects we fetched.
+			foreach ($related_model_objs as $related_model_obj) {
+				$entity_node                                = new ModelObjNode(
+					$related_model_obj->ID(),
+					$related_model_obj->get_model(),
+					$this->dont_traverse_models
+				);
+				$this->nodes[ $related_model_obj->ID() ]    = $entity_node;
+				$new_item_nodes[ $related_model_obj->ID() ] = $entity_node;
+			}
+			$num_identified += count($new_item_nodes);
+			if ($num_identified < $model_objects_to_identify) {
+				// And lastly do the work.
+				$num_identified += $this->visitAlreadyDiscoveredNodes(
+					$new_item_nodes,
+					$model_objects_to_identify - $num_identified
+				);
+			}
+		}
+
+		if (count($this->nodes) >= $this->count && $this->allChildrenComplete()) {
+			$this->complete = true;
+		}
+		return $num_identified;
+	}
+
+
+	/**
+	 * Checks if all the identified child nodes are complete or not.
+	 *
+	 * @return bool
+	 */
+	protected function allChildrenComplete()
+	{
+		foreach ($this->nodes as $model_obj_node) {
+			if (! $model_obj_node->isComplete()) {
+				return false;
+			}
+		}
+		return true;
+	}
+
+
+	/**
+	 * Visits the provided nodes and keeps track of how much work was done, making sure to not go over budget.
+	 *
+	 * @param ModelObjNode[] $model_obj_nodes
+	 * @param                $work_budget
+	 * @return int
+	 */
+	protected function visitAlreadyDiscoveredNodes($model_obj_nodes, $work_budget)
+	{
+		$work_done = 0;
+		if (! $model_obj_nodes) {
+			return 0;
+		}
+		foreach ($model_obj_nodes as $model_obj_node) {
+			if ($work_done >= $work_budget) {
+				break;
+			}
+			$work_done += $model_obj_node->visit($work_budget - $work_done);
+		}
+		return $work_done;
+	}
+
+
+	/**
+	 * Whether this item has already been initialized
+	 */
+	protected function isDiscovered()
+	{
+		return $this->count !== null;
+	}
+
+
+	/**
+	 * @return boolean
+	 */
+	public function isComplete()
+	{
+		if ($this->complete === null) {
+			if (count($this->nodes) === $this->count) {
+				$this->complete = true;
+			} else {
+				$this->complete = false;
+			}
+		}
+		return $this->complete;
+	}
+
+
+	/**
+	 * Discovers how many related model objects exist.
+	 *
+	 * @return void
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 */
+	protected function discover()
+	{
+		$this->count = $this->related_model->count([$this->whereQueryParams()]);
+	}
+
+
+	/**
+	 * @return array
+	 * @throws EE_Error
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 * @throws InvalidArgumentException
+	 */
+	protected function whereQueryParams()
+	{
+		$where_params = [
+			$this->related_model->get_foreign_key_to(
+				$this->main_model->get_this_model_name()
+			)->get_name() => $this->id,
+		];
+		try {
+			$relation_settings = $this->main_model->related_settings_for($this->related_model->get_this_model_name());
+		} catch (EE_Error $e) {
+			// This will happen for has-and-belongs-to-many relations, when this node's related model is that join table
+			// which hasn't been explicitly declared in the main model object's model's relations.
+			$relation_settings = null;
+		}
+		if ($relation_settings instanceof EE_Has_Many_Any_Relation) {
+			$where_params[ $this->related_model->get_field_containing_related_model_name()->get_name() ] =
+				$this->main_model->get_this_model_name();
+		}
+		return $where_params;
+	}
+
+
+	/**
+	 * @return array
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	public function toArray()
+	{
+		$tree = [
+			'count'    => $this->count,
+			'complete' => $this->isComplete(),
+			'objs'     => [],
+		];
+		foreach ($this->nodes as $id => $model_obj_node) {
+			$tree['objs'][ $id ] = $model_obj_node->toArray();
+		}
+		return $tree;
+	}
+
+
+	/**
+	 * Gets the IDs of all the model objects to delete; indexed first by model object name.
+	 *
+	 * @return array
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	public function getIds()
+	{
+		if (empty($this->nodes)) {
+			return [];
+		}
+		$ids = [
+			$this->related_model->get_this_model_name() => array_combine(
+				array_keys($this->nodes),
+				array_keys($this->nodes)
+			),
+		];
+		foreach ($this->nodes as $model_obj_node) {
+			$ids = array_replace_recursive($ids, $model_obj_node->getIds());
+		}
+		return $ids;
+	}
+
+
+	/**
+	 * Returns the number of sub-nodes found (ie, related model objects across this relation.)
+	 *
+	 * @return int
+	 */
+	public function countSubNodes()
+	{
+		return count($this->nodes);
+	}
+
+
+	/**
+	 * Don't serialize the models. Just record their names on some dynamic properties.
+	 *
+	 * @return array
+	 */
+	public function __sleep()
+	{
+		$this->m  = $this->main_model->get_this_model_name();
+		$this->rm = $this->related_model->get_this_model_name();
+		return array_merge(
+			[
+				'm',
+				'rm',
+				'id',
+				'count',
+				'nodes',
+			],
+			parent::__sleep()
+		);
+	}
+
+
+	/**
+	 * Use the dynamic properties to instantiate the models we use.
+	 *
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 * @throws ReflectionException
+	 */
+	public function __wakeup()
+	{
+		$this->main_model    = EE_Registry::instance()->load_model($this->m);
+		$this->related_model = EE_Registry::instance()->load_model($this->rm);
+		parent::__wakeup();
+	}
 }
 // End of file RelationNode.php
 // Location: EventEspresso\core\services\orm\tree_traversal/RelationNode.php