eventespresso / event-espresso-core

core/libraries/batch/Helpers/JobParameters.php

Indentation +392 added lines, -392 removed lines

@@ -14,396 +14,396 @@
  */
 class JobParameters
 {
-    // phpcs:disable Generic.NamingConventions.UpperCaseConstantName.ClassConstantNotUpperCase
-    // phpcs:disable PSR1.Methods.CamelCapsMethodName.NotCamelCaps
-    // phpcs:disable PSR2.Classes.PropertyDeclaration.Underscore
-    /**
-     * status indicating the job should continue
-     */
-    const status_continue = 'continue';
-
-    /**
-     * status indicated the job has been completed successfully and should be cleaned up next
-     */
-    const status_complete = 'complete';
-
-    /**
-     * status indicating there was an error and the job should be cleaned up
-     */
-    const status_error = 'error';
-
-    /**
-     * status indicating the job has been cleaned up, and so this is probably the last
-     * time you'll see this job
-     */
-    const status_cleaned_up = 'cleaned_up';
-
-    const wp_option_prefix = 'ee_job_parameters_';
-
-
-    /**
-     * String uniquely identifying the job
-     *
-     * @var string
-     */
-    protected $_job_id;
-
-    /**
-     * @var string
-     */
-    protected $_classname;
-
-    /**
-     * @var array
-     */
-    protected $_request_data;
-
-    /**
-     * Array of any extra data we want to remember about this request, that
-     * wasn't necessarily past in with the request data
-     *
-     * @var array
-     */
-    protected $_extra_data;
-
-    /**
-     * Estimate of how many units HAVE been processed
-     *
-     * @var int
-     */
-    protected $_units_processed = 0;
-
-    /**
-     * @var string
-     */
-    protected $_status;
-
-    /**
-     * The size of the total job in whatever units you want.
-     * If you can't provide an estimate leave as 0.
-     * Once _units_processed equals _job_size, we should be done
-     *
-     * @var int
-     */
-    protected $_job_size = 0;
-
-
-    /**
-     * @param string $job_id
-     * @param string $classname
-     * @param array  $request_data
-     * @param array  $extra_data
-     */
-    public function __construct($job_id, $classname, $request_data, $extra_data = array())
-    {
-        $this->set_job_id($job_id);
-        $this->set_classname($classname);
-        $this->set_request_data($request_data);
-        $this->set_extra_data($extra_data);
-        $this->set_status(JobParameters::status_continue);
-    }
-
-
-    /**
-     * Returns the array of strings of valid stati
-     *
-     * @return array
-     */
-    public static function valid_stati()
-    {
-        return array(
-            JobParameters::status_complete,
-            JobParameters::status_continue,
-            JobParameters::status_error,
-            JobParameters::status_cleaned_up,
-        );
-    }
-
-
-    /**
-     * Saves this option to the database (wordpress options table)
-     *
-     * @param boolean $first
-     * @return boolean success
-     */
-    public function save($first = false)
-    {
-        $object_vars = get_object_vars($this);
-        if ($first) {
-            return add_option($this->option_name(), $object_vars, null, 'no');
-        } else {
-            return update_option($this->option_name(), $object_vars);
-        }
-    }
-
-
-    /**
-     * Deletes the job from teh database, although this object is still usable
-     * for the rest of the request
-     *
-     * @return boolean
-     */
-    public function delete()
-    {
-        return delete_option($this->option_name());
-    }
-
-
-    /**
-     * Loads the specified job from the database
-     *
-     * @param string $job_id
-     * @return JobParameters
-     * @throws BatchRequestException
-     */
-    public static function load($job_id)
-    {
-        $job_parameter_vars = get_option(JobParameters::wp_option_prefix . $job_id);
-        if (! is_array($job_parameter_vars) ||
-            ! isset($job_parameter_vars['_classname']) ||
-            ! isset($job_parameter_vars['_request_data'])
-        ) {
-            throw new BatchRequestException(
-                sprintf(
-                    __(
-                        'Could not retrieve job %1$s from the Wordpress options table, and so the job could not continue. The wordpress option was %2$s',
-                        'event_espresso'
-                    ),
-                    $job_id,
-                    get_option(JobParameters::wp_option_prefix . $job_id)
-                )
-            );
-        }
-        $job_parameters = new JobParameters(
-            $job_id,
-            $job_parameter_vars['_classname'],
-            $job_parameter_vars['_request_data']
-        );
-        foreach ($job_parameter_vars as $key => $value) {
-            $job_parameters->{$key} = $value;
-        }
-        return $job_parameters;
-    }
-
-
-    /**
-     * Gets the job's unique string
-     *
-     * @return string
-     */
-    public function job_id()
-    {
-        return $this->_job_id;
-    }
-
-
-    /**
-     * Gets the classname that should run this job
-     *
-     * @return string
-     */
-    public function classname()
-    {
-        return $this->_classname;
-    }
-
-
-    /**
-     * Gets the original array of $_REQUEST data for this job
-     *
-     * @return array
-     */
-    public function request_data()
-    {
-        return $this->_request_data;
-    }
-
-
-    /**
-     * Gets a single item from the request data
-     *
-     * @param string       $key
-     * @param string|array $default
-     * @return string|array
-     */
-    public function request_datum($key, $default = '')
-    {
-        if (isset($this->_request_data[ $key ])) {
-            return $this->_request_data[ $key ];
-        } else {
-            return $default;
-        }
-    }
-
-
-    /**
-     * Gets a single item from the extra data
-     *
-     * @param string       $key
-     * @param string|array $default
-     * @return string|array
-     */
-    public function extra_datum($key, $default = '')
-    {
-        if (isset($this->_extra_data[ $key ])) {
-            return $this->_extra_data[ $key ];
-        } else {
-            return $default;
-        }
-    }
-
-
-    /**
-     * Adds an extra piece of extra data that we're going to want later during the job
-     *
-     * @param string                $key
-     * @param string|int|array|null $value almost any extra data you want to store
-     */
-    public function add_extra_data($key, $value)
-    {
-        $this->_extra_data[ $key ] = $value;
-    }
-
-
-    /**
-     * Array of any extra data we want to store
-     *
-     * @return array
-     */
-    public function extra_data()
-    {
-        return $this->_extra_data;
-    }
-
-
-    /**
-     * Returns the job size, in whatever units you want
-     *
-     * @return int
-     */
-    public function job_size()
-    {
-        return $this->_job_size;
-    }
-
-
-    /**
-     * Sets the job size. You decide what units to use
-     *
-     * @param int $size
-     */
-    public function set_job_size($size)
-    {
-        $this->_job_size = $size;
-    }
-
-
-    /**
-     * The number of "units" processed, in the same units as the "job size"
-     *
-     * @return int
-     */
-    public function units_processed()
-    {
-        return $this->_units_processed;
-    }
-
-
-    /**
-     * Marks more units as processed
-     *
-     * @param int $newly_processed
-     * @return int updated units processed
-     */
-    public function mark_processed($newly_processed)
-    {
-        $this->_units_processed += $newly_processed;
-        return $this->_units_processed;
-    }
-
-
-    /**
-     * Sets the total count of units processed. You might prefer to use mark_processed
-     *
-     * @param int $total_units_processed
-     */
-    public function set_units_processed($total_units_processed)
-    {
-        $this->_units_processed = $total_units_processed;
-    }
-
-
-    /**
-     * Sets the job's ID
-     *
-     * @param string $job_id
-     */
-    public function set_job_id($job_id)
-    {
-        $this->_job_id = $job_id;
-    }
-
-
-    /**
-     * sets the classname
-     *
-     * @param string $classname
-     */
-    public function set_classname($classname)
-    {
-        $this->_classname = $classname;
-    }
-
-
-    /**
-     * Sets the request data
-     *
-     * @param array $request_data
-     */
-    public function set_request_data($request_data)
-    {
-        $this->_request_data = $request_data;
-    }
-
-
-    /**
-     * Sets the array of extra data we want to store on this request
-     *
-     * @param array $extra_data
-     */
-    public function set_extra_data($extra_data)
-    {
-        $this->_extra_data = $extra_data;
-    }
-
-
-    /**
-     * Gets the name of the wordpress option that should store these job parameters
-     *
-     * @return string
-     */
-    public function option_name()
-    {
-        return JobParameters::wp_option_prefix . $this->job_id();
-    }
-
-
-    /**
-     * Gets the job\s current status. One of JobParameters::valid_stati();
-     *
-     * @return string
-     */
-    public function status()
-    {
-        return $this->_status;
-    }
-
-
-    /**
-     * @param string $status on eof JobParameters::valid_stati()
-     */
-    public function set_status($status)
-    {
-        $this->_status = $status;
-    }
+	// phpcs:disable Generic.NamingConventions.UpperCaseConstantName.ClassConstantNotUpperCase
+	// phpcs:disable PSR1.Methods.CamelCapsMethodName.NotCamelCaps
+	// phpcs:disable PSR2.Classes.PropertyDeclaration.Underscore
+	/**
+	 * status indicating the job should continue
+	 */
+	const status_continue = 'continue';
+
+	/**
+	 * status indicated the job has been completed successfully and should be cleaned up next
+	 */
+	const status_complete = 'complete';
+
+	/**
+	 * status indicating there was an error and the job should be cleaned up
+	 */
+	const status_error = 'error';
+
+	/**
+	 * status indicating the job has been cleaned up, and so this is probably the last
+	 * time you'll see this job
+	 */
+	const status_cleaned_up = 'cleaned_up';
+
+	const wp_option_prefix = 'ee_job_parameters_';
+
+
+	/**
+	 * String uniquely identifying the job
+	 *
+	 * @var string
+	 */
+	protected $_job_id;
+
+	/**
+	 * @var string
+	 */
+	protected $_classname;
+
+	/**
+	 * @var array
+	 */
+	protected $_request_data;
+
+	/**
+	 * Array of any extra data we want to remember about this request, that
+	 * wasn't necessarily past in with the request data
+	 *
+	 * @var array
+	 */
+	protected $_extra_data;
+
+	/**
+	 * Estimate of how many units HAVE been processed
+	 *
+	 * @var int
+	 */
+	protected $_units_processed = 0;
+
+	/**
+	 * @var string
+	 */
+	protected $_status;
+
+	/**
+	 * The size of the total job in whatever units you want.
+	 * If you can't provide an estimate leave as 0.
+	 * Once _units_processed equals _job_size, we should be done
+	 *
+	 * @var int
+	 */
+	protected $_job_size = 0;
+
+
+	/**
+	 * @param string $job_id
+	 * @param string $classname
+	 * @param array  $request_data
+	 * @param array  $extra_data
+	 */
+	public function __construct($job_id, $classname, $request_data, $extra_data = array())
+	{
+		$this->set_job_id($job_id);
+		$this->set_classname($classname);
+		$this->set_request_data($request_data);
+		$this->set_extra_data($extra_data);
+		$this->set_status(JobParameters::status_continue);
+	}
+
+
+	/**
+	 * Returns the array of strings of valid stati
+	 *
+	 * @return array
+	 */
+	public static function valid_stati()
+	{
+		return array(
+			JobParameters::status_complete,
+			JobParameters::status_continue,
+			JobParameters::status_error,
+			JobParameters::status_cleaned_up,
+		);
+	}
+
+
+	/**
+	 * Saves this option to the database (wordpress options table)
+	 *
+	 * @param boolean $first
+	 * @return boolean success
+	 */
+	public function save($first = false)
+	{
+		$object_vars = get_object_vars($this);
+		if ($first) {
+			return add_option($this->option_name(), $object_vars, null, 'no');
+		} else {
+			return update_option($this->option_name(), $object_vars);
+		}
+	}
+
+
+	/**
+	 * Deletes the job from teh database, although this object is still usable
+	 * for the rest of the request
+	 *
+	 * @return boolean
+	 */
+	public function delete()
+	{
+		return delete_option($this->option_name());
+	}
+
+
+	/**
+	 * Loads the specified job from the database
+	 *
+	 * @param string $job_id
+	 * @return JobParameters
+	 * @throws BatchRequestException
+	 */
+	public static function load($job_id)
+	{
+		$job_parameter_vars = get_option(JobParameters::wp_option_prefix . $job_id);
+		if (! is_array($job_parameter_vars) ||
+			! isset($job_parameter_vars['_classname']) ||
+			! isset($job_parameter_vars['_request_data'])
+		) {
+			throw new BatchRequestException(
+				sprintf(
+					__(
+						'Could not retrieve job %1$s from the Wordpress options table, and so the job could not continue. The wordpress option was %2$s',
+						'event_espresso'
+					),
+					$job_id,
+					get_option(JobParameters::wp_option_prefix . $job_id)
+				)
+			);
+		}
+		$job_parameters = new JobParameters(
+			$job_id,
+			$job_parameter_vars['_classname'],
+			$job_parameter_vars['_request_data']
+		);
+		foreach ($job_parameter_vars as $key => $value) {
+			$job_parameters->{$key} = $value;
+		}
+		return $job_parameters;
+	}
+
+
+	/**
+	 * Gets the job's unique string
+	 *
+	 * @return string
+	 */
+	public function job_id()
+	{
+		return $this->_job_id;
+	}
+
+
+	/**
+	 * Gets the classname that should run this job
+	 *
+	 * @return string
+	 */
+	public function classname()
+	{
+		return $this->_classname;
+	}
+
+
+	/**
+	 * Gets the original array of $_REQUEST data for this job
+	 *
+	 * @return array
+	 */
+	public function request_data()
+	{
+		return $this->_request_data;
+	}
+
+
+	/**
+	 * Gets a single item from the request data
+	 *
+	 * @param string       $key
+	 * @param string|array $default
+	 * @return string|array
+	 */
+	public function request_datum($key, $default = '')
+	{
+		if (isset($this->_request_data[ $key ])) {
+			return $this->_request_data[ $key ];
+		} else {
+			return $default;
+		}
+	}
+
+
+	/**
+	 * Gets a single item from the extra data
+	 *
+	 * @param string       $key
+	 * @param string|array $default
+	 * @return string|array
+	 */
+	public function extra_datum($key, $default = '')
+	{
+		if (isset($this->_extra_data[ $key ])) {
+			return $this->_extra_data[ $key ];
+		} else {
+			return $default;
+		}
+	}
+
+
+	/**
+	 * Adds an extra piece of extra data that we're going to want later during the job
+	 *
+	 * @param string                $key
+	 * @param string|int|array|null $value almost any extra data you want to store
+	 */
+	public function add_extra_data($key, $value)
+	{
+		$this->_extra_data[ $key ] = $value;
+	}
+
+
+	/**
+	 * Array of any extra data we want to store
+	 *
+	 * @return array
+	 */
+	public function extra_data()
+	{
+		return $this->_extra_data;
+	}
+
+
+	/**
+	 * Returns the job size, in whatever units you want
+	 *
+	 * @return int
+	 */
+	public function job_size()
+	{
+		return $this->_job_size;
+	}
+
+
+	/**
+	 * Sets the job size. You decide what units to use
+	 *
+	 * @param int $size
+	 */
+	public function set_job_size($size)
+	{
+		$this->_job_size = $size;
+	}
+
+
+	/**
+	 * The number of "units" processed, in the same units as the "job size"
+	 *
+	 * @return int
+	 */
+	public function units_processed()
+	{
+		return $this->_units_processed;
+	}
+
+
+	/**
+	 * Marks more units as processed
+	 *
+	 * @param int $newly_processed
+	 * @return int updated units processed
+	 */
+	public function mark_processed($newly_processed)
+	{
+		$this->_units_processed += $newly_processed;
+		return $this->_units_processed;
+	}
+
+
+	/**
+	 * Sets the total count of units processed. You might prefer to use mark_processed
+	 *
+	 * @param int $total_units_processed
+	 */
+	public function set_units_processed($total_units_processed)
+	{
+		$this->_units_processed = $total_units_processed;
+	}
+
+
+	/**
+	 * Sets the job's ID
+	 *
+	 * @param string $job_id
+	 */
+	public function set_job_id($job_id)
+	{
+		$this->_job_id = $job_id;
+	}
+
+
+	/**
+	 * sets the classname
+	 *
+	 * @param string $classname
+	 */
+	public function set_classname($classname)
+	{
+		$this->_classname = $classname;
+	}
+
+
+	/**
+	 * Sets the request data
+	 *
+	 * @param array $request_data
+	 */
+	public function set_request_data($request_data)
+	{
+		$this->_request_data = $request_data;
+	}
+
+
+	/**
+	 * Sets the array of extra data we want to store on this request
+	 *
+	 * @param array $extra_data
+	 */
+	public function set_extra_data($extra_data)
+	{
+		$this->_extra_data = $extra_data;
+	}
+
+
+	/**
+	 * Gets the name of the wordpress option that should store these job parameters
+	 *
+	 * @return string
+	 */
+	public function option_name()
+	{
+		return JobParameters::wp_option_prefix . $this->job_id();
+	}
+
+
+	/**
+	 * Gets the job\s current status. One of JobParameters::valid_stati();
+	 *
+	 * @return string
+	 */
+	public function status()
+	{
+		return $this->_status;
+	}
+
+
+	/**
+	 * @param string $status on eof JobParameters::valid_stati()
+	 */
+	public function set_status($status)
+	{
+		$this->_status = $status;
+	}
 }

Spacing +9 added lines, -9 removed lines

@@ -158,8 +158,8 @@ 
      */
     public static function load($job_id)
     {
-        $job_parameter_vars = get_option(JobParameters::wp_option_prefix . $job_id);
-        if (! is_array($job_parameter_vars) ||
+        $job_parameter_vars = get_option(JobParameters::wp_option_prefix.$job_id);
+        if ( ! is_array($job_parameter_vars) ||
             ! isset($job_parameter_vars['_classname']) ||
             ! isset($job_parameter_vars['_request_data'])
         ) {
@@ -170,7 +170,7 @@ 
                         'event_espresso'
                     ),
                     $job_id,
-                    get_option(JobParameters::wp_option_prefix . $job_id)
+                    get_option(JobParameters::wp_option_prefix.$job_id)
                 )
             );
         }
@@ -228,8 +228,8 @@ 
      */
     public function request_datum($key, $default = '')
     {
-        if (isset($this->_request_data[ $key ])) {
-            return $this->_request_data[ $key ];
+        if (isset($this->_request_data[$key])) {
+            return $this->_request_data[$key];
         } else {
             return $default;
         }
@@ -245,8 +245,8 @@ 
      */
     public function extra_datum($key, $default = '')
     {
-        if (isset($this->_extra_data[ $key ])) {
-            return $this->_extra_data[ $key ];
+        if (isset($this->_extra_data[$key])) {
+            return $this->_extra_data[$key];
         } else {
             return $default;
         }
@@ -261,7 +261,7 @@ 
      */
     public function add_extra_data($key, $value)
     {
-        $this->_extra_data[ $key ] = $value;
+        $this->_extra_data[$key] = $value;
     }
 
 
@@ -384,7 +384,7 @@ 
      */
     public function option_name()
     {
-        return JobParameters::wp_option_prefix . $this->job_id();
+        return JobParameters::wp_option_prefix.$this->job_id();
     }
 
 

core/libraries/batch/Helpers/JobStepResponse.php

Indentation +84 added lines, -84 removed lines

@@ -13,99 +13,99 @@
  */
 class JobStepResponse
 {
-    // phpcs:disable PSR2.Classes.PropertyDeclaration.Underscore
-    /**
-     * Description fo what happened during this step
-     *
-     * @var string
-     */
-    protected $_update_text;
+	// phpcs:disable PSR2.Classes.PropertyDeclaration.Underscore
+	/**
+	 * Description fo what happened during this step
+	 *
+	 * @var string
+	 */
+	protected $_update_text;
 
-    /**
-     * @var JobParameters
-     */
-    protected $_job_parameters;
+	/**
+	 * @var JobParameters
+	 */
+	protected $_job_parameters;
 
-    /**
-     * Extra data to include as part of the response.
-     *
-     * @var array
-     */
-    protected $_extra_data = array();
-    // phpcs:enable
+	/**
+	 * Extra data to include as part of the response.
+	 *
+	 * @var array
+	 */
+	protected $_extra_data = array();
+	// phpcs:enable
 
-    // phpcs:disable PSR1.Methods.CamelCapsMethodName.NotCamelCaps
-    /**
-     * @param \EventEspressoBatchRequest\Helpers\JobParameters $job_parameters
-     * @param string                                           $update_text
-     * @param array                                            $extra_data
-     */
-    public function __construct(JobParameters $job_parameters, $update_text, $extra_data = array())
-    {
-        $this->_job_parameters = $job_parameters;
-        $this->_update_text = $update_text;
-        $this->_extra_data = (array) $extra_data;
-    }
+	// phpcs:disable PSR1.Methods.CamelCapsMethodName.NotCamelCaps
+	/**
+	 * @param \EventEspressoBatchRequest\Helpers\JobParameters $job_parameters
+	 * @param string                                           $update_text
+	 * @param array                                            $extra_data
+	 */
+	public function __construct(JobParameters $job_parameters, $update_text, $extra_data = array())
+	{
+		$this->_job_parameters = $job_parameters;
+		$this->_update_text = $update_text;
+		$this->_extra_data = (array) $extra_data;
+	}
 
 
-    /**
-     * @return JobParameters
-     */
-    public function job_parameters()
-    {
-        return $this->_job_parameters;
-    }
+	/**
+	 * @return JobParameters
+	 */
+	public function job_parameters()
+	{
+		return $this->_job_parameters;
+	}
 
 
-    /**
-     * Gets the update_text of what happened in this job during the current step
-     *
-     * @return string
-     */
-    public function update_text()
-    {
-        return $this->_update_text;
-    }
+	/**
+	 * Gets the update_text of what happened in this job during the current step
+	 *
+	 * @return string
+	 */
+	public function update_text()
+	{
+		return $this->_update_text;
+	}
 
 
-    /**
-     * Returns any extra data we may want to include with this response
-     *
-     * @return array
-     */
-    public function extra_data()
-    {
-        return $this->_extra_data;
-    }
+	/**
+	 * Returns any extra data we may want to include with this response
+	 *
+	 * @return array
+	 */
+	public function extra_data()
+	{
+		return $this->_extra_data;
+	}
 
 
-    /**
-     * Converts this response into an array that can be easily serialized.
-     * This is most useful for serializing or json encoding
-     *
-     * @return array {
-     * @type string $status          , one of JobParameters::valid_stati()
-     * @type int    $units_processed count of units processed
-     * @type int    $job_size        total number of units TO process
-     * @type string $job_id          unique string identifying the job
-     * @type string $update_text     string describing what happened during this step
-     * } and any other items from $this->extra_data()
-     */
-    public function to_array()
-    {
-        return apply_filters(
-            'FHEE__EventEspressoBatchRequest\Helpers\JobStepResponse__to_array__return',
-            array_merge(
-                $this->extra_data(),
-                array(
-                    'status'          => $this->job_parameters()->status(),
-                    'units_processed' => $this->job_parameters()->units_processed(),
-                    'job_size'        => $this->job_parameters()->job_size(),
-                    'job_id'          => $this->job_parameters()->job_id(),
-                    'update_text'     => $this->update_text(),
-                )
-            ),
-            $this
-        );
-    }
+	/**
+	 * Converts this response into an array that can be easily serialized.
+	 * This is most useful for serializing or json encoding
+	 *
+	 * @return array {
+	 * @type string $status          , one of JobParameters::valid_stati()
+	 * @type int    $units_processed count of units processed
+	 * @type int    $job_size        total number of units TO process
+	 * @type string $job_id          unique string identifying the job
+	 * @type string $update_text     string describing what happened during this step
+	 * } and any other items from $this->extra_data()
+	 */
+	public function to_array()
+	{
+		return apply_filters(
+			'FHEE__EventEspressoBatchRequest\Helpers\JobStepResponse__to_array__return',
+			array_merge(
+				$this->extra_data(),
+				array(
+					'status'          => $this->job_parameters()->status(),
+					'units_processed' => $this->job_parameters()->units_processed(),
+					'job_size'        => $this->job_parameters()->job_size(),
+					'job_id'          => $this->job_parameters()->job_id(),
+					'update_text'     => $this->update_text(),
+				)
+			),
+			$this
+		);
+	}
 }

core/libraries/form_sections/strategies/filter/VsprintfFilter.php

Indentation +41 added lines, -41 removed lines

@@ -19,45 +19,45 @@
 class VsprintfFilter extends FormHtmlFilter
 {
 
-    /**
-     * @var string $format
-     */
-    protected $format = '';
-
-
-    /**
-     * @var array $args
-     */
-    protected $args = array();
-
-
-    /**
-     * VsprintfFilter constructor.
-     *
-     * @param string $format
-     * @param array  $args
-     */
-    public function __construct($format, array $args)
-    {
-        $this->format = $format;
-        $this->args = $args;
-    }
-
-
-    /**
-     * @param                             $html
-     * @param EE_Form_Section_Validatable $form_section
-     * @return string
-     */
-    public function filterHtml($html, EE_Form_Section_Validatable $form_section)
-    {
-        $this->args[] = $html;
-        if ($form_section instanceof EE_Form_Section_Proper) {
-            $subsections = $form_section->subsections();
-            foreach ((array) $subsections as $subsection) {
-                $this->args[] = $subsection->get_html();
-            }
-        }
-        return vsprintf($this->format, $this->args);
-    }
+	/**
+	 * @var string $format
+	 */
+	protected $format = '';
+
+
+	/**
+	 * @var array $args
+	 */
+	protected $args = array();
+
+
+	/**
+	 * VsprintfFilter constructor.
+	 *
+	 * @param string $format
+	 * @param array  $args
+	 */
+	public function __construct($format, array $args)
+	{
+		$this->format = $format;
+		$this->args = $args;
+	}
+
+
+	/**
+	 * @param                             $html
+	 * @param EE_Form_Section_Validatable $form_section
+	 * @return string
+	 */
+	public function filterHtml($html, EE_Form_Section_Validatable $form_section)
+	{
+		$this->args[] = $html;
+		if ($form_section instanceof EE_Form_Section_Proper) {
+			$subsections = $form_section->subsections();
+			foreach ((array) $subsections as $subsection) {
+				$this->args[] = $subsection->get_html();
+			}
+		}
+		return vsprintf($this->format, $this->args);
+	}
 }

core/domain/entities/custom_post_types/CustomPostTypeDefinitions.php

Indentation +263 added lines, -263 removed lines

@@ -17,287 +17,287 @@
 class CustomPostTypeDefinitions
 {
 
-    /**
-     * @var EE_Core_Config
-     */
-    public $core_config;
+	/**
+	 * @var EE_Core_Config
+	 */
+	public $core_config;
 
-    /**
-     * @var array $custom_post_types
-     */
-    private $custom_post_types;
+	/**
+	 * @var array $custom_post_types
+	 */
+	private $custom_post_types;
 
-    /**
-     * @var LoaderInterface $loader
-     */
-    private $loader;
+	/**
+	 * @var LoaderInterface $loader
+	 */
+	private $loader;
 
 
-    /**
-     * EspressoCustomPostTypeDefinitions constructor.
-     *
-     * @param EE_Core_Config  $core_config
-     * @param LoaderInterface $loader
-     */
-    public function __construct(EE_Core_Config $core_config, LoaderInterface $loader)
-    {
-        $this->core_config = $core_config;
-        $this->loader = $loader;
-        $this->setDefinitions();
-    }
+	/**
+	 * EspressoCustomPostTypeDefinitions constructor.
+	 *
+	 * @param EE_Core_Config  $core_config
+	 * @param LoaderInterface $loader
+	 */
+	public function __construct(EE_Core_Config $core_config, LoaderInterface $loader)
+	{
+		$this->core_config = $core_config;
+		$this->loader = $loader;
+		$this->setDefinitions();
+	}
 
 
-    /**
-     * defines Espresso Custom Post Types
-     * NOTE the ['args']['page_templates'] array index is something specific to our CPTs
-     * and not part of the WP custom post type api.
-     *
-     * @return void
-     */
-    private function setDefinitions()
-    {
-        $this->custom_post_types = array(
-            'espresso_events'    => array(
-                'singular_name' => esc_html__('Event', 'event_espresso'),
-                'plural_name'   => esc_html__('Events', 'event_espresso'),
-                'singular_slug' => esc_html__('event', 'event_espresso'),
-                'plural_slug'   => $this->core_config->event_cpt_slug,
-                'class_name'    => 'EE_Event',
-                'model_name'    => 'EEM_Event',
-                'args'          => array(
-                    'public'            => true,
-                    'show_in_nav_menus' => true,
-                    'capability_type'   => 'event',
-                    'capabilities'      => array(
-                        'edit_post'              => 'ee_edit_event',
-                        'read_post'              => 'ee_read_event',
-                        'delete_post'            => 'ee_delete_event',
-                        'edit_posts'             => 'ee_edit_events',
-                        'edit_others_posts'      => 'ee_edit_others_events',
-                        'publish_posts'          => 'ee_publish_events',
-                        'read_private_posts'     => 'ee_read_private_events',
-                        'delete_posts'           => 'ee_delete_events',
-                        'delete_private_posts'   => 'ee_delete_private_events',
-                        'delete_published_posts' => 'ee_delete_published_events',
-                        'delete_others_posts'    => 'ee_delete_others_events',
-                        'edit_private_posts'     => 'ee_edit_private_events',
-                        'edit_published_posts'   => 'ee_edit_published_events',
-                    ),
-                    'taxonomies'        => array(
-                        'espresso_event_categories',
-                        'espresso_event_type',
-                        'post_tag',
-                    ),
-                    'page_templates'    => true,
-                ),
-            ),
-            'espresso_venues'    => array(
-                'singular_name' => esc_html__('Venue', 'event_espresso'),
-                'plural_name'   => esc_html__('Venues', 'event_espresso'),
-                'singular_slug' => esc_html__('venue', 'event_espresso'),
-                'plural_slug'   => esc_html__('venues', 'event_espresso'),
-                'class_name'    => 'EE_Venue',
-                'model_name'    => 'EEM_Venue',
-                'args'          => array(
-                    'public'            => true,
-                    'show_in_nav_menus' => false, // by default this doesn't show for decaf,
-                    'capability_type'   => 'venue',
-                    'capabilities'      => array(
-                        'edit_post'              => 'ee_edit_venue',
-                        'read_post'              => 'ee_read_venue',
-                        'delete_post'            => 'ee_delete_venue',
-                        'edit_posts'             => 'ee_edit_venues',
-                        'edit_others_posts'      => 'ee_edit_others_venues',
-                        'publish_posts'          => 'ee_publish_venues',
-                        'read_private_posts'     => 'ee_read_private_venues',
-                        'delete_posts'           => 'ee_delete_venues',
-                        'delete_private_posts'   => 'ee_delete_private_venues',
-                        'delete_published_posts' => 'ee_delete_published_venues',
-                        'delete_others_posts'    => 'ee_edit_others_venues',
-                        'edit_private_posts'     => 'ee_edit_private_venues',
-                        'edit_published_posts'   => 'ee_edit_published_venues',
-                    ),
-                    'taxonomies'        => array(
-                        'espresso_venue_categories',
-                        'post_tag',
-                    ),
-                    'page_templates'    => true,
-                ),
-            ),
-            'espresso_attendees' => array(
-                'singular_name' => esc_html__('Contact', 'event_espresso'),
-                'plural_name'   => esc_html__('Contacts', 'event_espresso'),
-                'singular_slug' => esc_html__('contact', 'event_espresso'),
-                'plural_slug'   => esc_html__('contacts', 'event_espresso'),
-                'class_name'    => 'EE_Attendee',
-                'model_name'    => 'EEM_Attendee',
-                'args'          => array(
-                    'public'             => false,
-                    'publicly_queryable' => false,
-                    'hierarchical'       => false,
-                    'has_archive'        => false,
-                    'supports'           => array(
-                        'editor',
-                        'thumbnail',
-                        'excerpt',
-                        'custom-fields',
-                        'comments',
-                    ),
-                    'taxonomies'         => array('post_tag'),
-                    'capability_type'    => 'contact',
-                    'capabilities'       => array(
-                        'edit_post'              => 'ee_edit_contact',
-                        'read_post'              => 'ee_read_contact',
-                        'delete_post'            => 'ee_delete_contact',
-                        'edit_posts'             => 'ee_edit_contacts',
-                        'edit_others_posts'      => 'ee_edit_contacts',
-                        'publish_posts'          => 'ee_edit_contacts',
-                        'read_private_posts'     => 'ee_edit_contacts',
-                        'delete_posts'           => 'ee_delete_contacts',
-                        'delete_private_posts'   => 'ee_delete_contacts',
-                        'delete_published_posts' => 'ee_delete_contacts',
-                        'delete_others_posts'    => 'ee_delete_contacts',
-                        'edit_private_posts'     => 'ee_edit_contacts',
-                        'edit_published_posts'   => 'ee_edit_contacts',
-                    ),
-                ),
-            ),
-        );
-    }
+	/**
+	 * defines Espresso Custom Post Types
+	 * NOTE the ['args']['page_templates'] array index is something specific to our CPTs
+	 * and not part of the WP custom post type api.
+	 *
+	 * @return void
+	 */
+	private function setDefinitions()
+	{
+		$this->custom_post_types = array(
+			'espresso_events'    => array(
+				'singular_name' => esc_html__('Event', 'event_espresso'),
+				'plural_name'   => esc_html__('Events', 'event_espresso'),
+				'singular_slug' => esc_html__('event', 'event_espresso'),
+				'plural_slug'   => $this->core_config->event_cpt_slug,
+				'class_name'    => 'EE_Event',
+				'model_name'    => 'EEM_Event',
+				'args'          => array(
+					'public'            => true,
+					'show_in_nav_menus' => true,
+					'capability_type'   => 'event',
+					'capabilities'      => array(
+						'edit_post'              => 'ee_edit_event',
+						'read_post'              => 'ee_read_event',
+						'delete_post'            => 'ee_delete_event',
+						'edit_posts'             => 'ee_edit_events',
+						'edit_others_posts'      => 'ee_edit_others_events',
+						'publish_posts'          => 'ee_publish_events',
+						'read_private_posts'     => 'ee_read_private_events',
+						'delete_posts'           => 'ee_delete_events',
+						'delete_private_posts'   => 'ee_delete_private_events',
+						'delete_published_posts' => 'ee_delete_published_events',
+						'delete_others_posts'    => 'ee_delete_others_events',
+						'edit_private_posts'     => 'ee_edit_private_events',
+						'edit_published_posts'   => 'ee_edit_published_events',
+					),
+					'taxonomies'        => array(
+						'espresso_event_categories',
+						'espresso_event_type',
+						'post_tag',
+					),
+					'page_templates'    => true,
+				),
+			),
+			'espresso_venues'    => array(
+				'singular_name' => esc_html__('Venue', 'event_espresso'),
+				'plural_name'   => esc_html__('Venues', 'event_espresso'),
+				'singular_slug' => esc_html__('venue', 'event_espresso'),
+				'plural_slug'   => esc_html__('venues', 'event_espresso'),
+				'class_name'    => 'EE_Venue',
+				'model_name'    => 'EEM_Venue',
+				'args'          => array(
+					'public'            => true,
+					'show_in_nav_menus' => false, // by default this doesn't show for decaf,
+					'capability_type'   => 'venue',
+					'capabilities'      => array(
+						'edit_post'              => 'ee_edit_venue',
+						'read_post'              => 'ee_read_venue',
+						'delete_post'            => 'ee_delete_venue',
+						'edit_posts'             => 'ee_edit_venues',
+						'edit_others_posts'      => 'ee_edit_others_venues',
+						'publish_posts'          => 'ee_publish_venues',
+						'read_private_posts'     => 'ee_read_private_venues',
+						'delete_posts'           => 'ee_delete_venues',
+						'delete_private_posts'   => 'ee_delete_private_venues',
+						'delete_published_posts' => 'ee_delete_published_venues',
+						'delete_others_posts'    => 'ee_edit_others_venues',
+						'edit_private_posts'     => 'ee_edit_private_venues',
+						'edit_published_posts'   => 'ee_edit_published_venues',
+					),
+					'taxonomies'        => array(
+						'espresso_venue_categories',
+						'post_tag',
+					),
+					'page_templates'    => true,
+				),
+			),
+			'espresso_attendees' => array(
+				'singular_name' => esc_html__('Contact', 'event_espresso'),
+				'plural_name'   => esc_html__('Contacts', 'event_espresso'),
+				'singular_slug' => esc_html__('contact', 'event_espresso'),
+				'plural_slug'   => esc_html__('contacts', 'event_espresso'),
+				'class_name'    => 'EE_Attendee',
+				'model_name'    => 'EEM_Attendee',
+				'args'          => array(
+					'public'             => false,
+					'publicly_queryable' => false,
+					'hierarchical'       => false,
+					'has_archive'        => false,
+					'supports'           => array(
+						'editor',
+						'thumbnail',
+						'excerpt',
+						'custom-fields',
+						'comments',
+					),
+					'taxonomies'         => array('post_tag'),
+					'capability_type'    => 'contact',
+					'capabilities'       => array(
+						'edit_post'              => 'ee_edit_contact',
+						'read_post'              => 'ee_read_contact',
+						'delete_post'            => 'ee_delete_contact',
+						'edit_posts'             => 'ee_edit_contacts',
+						'edit_others_posts'      => 'ee_edit_contacts',
+						'publish_posts'          => 'ee_edit_contacts',
+						'read_private_posts'     => 'ee_edit_contacts',
+						'delete_posts'           => 'ee_delete_contacts',
+						'delete_private_posts'   => 'ee_delete_contacts',
+						'delete_published_posts' => 'ee_delete_contacts',
+						'delete_others_posts'    => 'ee_delete_contacts',
+						'edit_private_posts'     => 'ee_edit_contacts',
+						'edit_published_posts'   => 'ee_edit_contacts',
+					),
+				),
+			),
+		);
+	}
 
 
-    /**
-     * @return array
-     */
-    public function getDefinitions()
-    {
-        return (array) apply_filters(
-            'FHEE__EventEspresso_core_domain_entities_custom_post_types_CustomPostTypeDefinitions__getCustomPostTypes',
-            // legacy filter applied for now,
-            // later on we'll run a has_filter($tag) check and throw a doing_it_wrong() notice
-            apply_filters(
-                'FHEE__EE_Register_CPTs__get_CPTs__cpts',
-                $this->custom_post_types
-            )
-        );
-    }
+	/**
+	 * @return array
+	 */
+	public function getDefinitions()
+	{
+		return (array) apply_filters(
+			'FHEE__EventEspresso_core_domain_entities_custom_post_types_CustomPostTypeDefinitions__getCustomPostTypes',
+			// legacy filter applied for now,
+			// later on we'll run a has_filter($tag) check and throw a doing_it_wrong() notice
+			apply_filters(
+				'FHEE__EE_Register_CPTs__get_CPTs__cpts',
+				$this->custom_post_types
+			)
+		);
+	}
 
 
-    /**
-     * @return array
-     */
-    public function getCustomPostTypeSlugs()
-    {
-        return array_keys($this->getDefinitions());
-    }
+	/**
+	 * @return array
+	 */
+	public function getCustomPostTypeSlugs()
+	{
+		return array_keys($this->getDefinitions());
+	}
 
 
-    /**
-     * This basically goes through the CPT array and returns only CPT's
-     * that have the ['args']['public'] option set as false
-     *
-     * @return array
-     */
-    public function getPrivateCustomPostTypes()
-    {
-        $private_CPTs = array();
-        foreach ($this->getDefinitions() as $CPT => $details) {
-            if (empty($details['args']['public'])) {
-                $private_CPTs[ $CPT ] = $details;
-            }
-        }
-        return $private_CPTs;
-    }
+	/**
+	 * This basically goes through the CPT array and returns only CPT's
+	 * that have the ['args']['public'] option set as false
+	 *
+	 * @return array
+	 */
+	public function getPrivateCustomPostTypes()
+	{
+		$private_CPTs = array();
+		foreach ($this->getDefinitions() as $CPT => $details) {
+			if (empty($details['args']['public'])) {
+				$private_CPTs[ $CPT ] = $details;
+			}
+		}
+		return $private_CPTs;
+	}
 
 
-    /**
-     * This returns the corresponding model name for cpts registered by EE.
-     *
-     * @param string $post_type_slug    If a slug is included, then attempt to retrieve
-     *                                  the model name for the given cpt slug.
-     *                                  Otherwise if empty, then we'll return
-     *                                  all cpt model names for cpts registered in EE.
-     * @return array                    Empty array if no matching model names for the given slug
-     *                                  or an array of model names indexed by post type slug.
-     */
-    public function getCustomPostTypeModelNames($post_type_slug = '')
-    {
-        $cpts = $this->getDefinitions();
-        // first if slug passed in...
-        if (! empty($post_type_slug)) {
-            // check that slug and cpt match
-            if (! isset($cpts[ $post_type_slug ])) {
-                return array();
-            }
-            if (empty($cpts[ $post_type_slug ]['class_name'])
-                && empty($cpts[ $post_type_slug ]['model_name'])
-            ) {
-                return array();
-            }
-            // k let's get the model name for this cpt.
-            return $this->getCustomPostTypeModelName($post_type_slug, $cpts[ $post_type_slug ]);
-        }
-        // if we made it here then we're returning an array of cpt model names indexed by post_type_slug.
-        $cpt_models = array();
-        foreach ($cpts as $slug => $args) {
-            $model = $this->getCustomPostTypeModelName($post_type_slug, $cpts[ $post_type_slug ]);
-            if (! empty($model)) {
-                $cpt_models[ $slug ] = $model;
-            }
-        }
-        return $cpt_models;
-    }
+	/**
+	 * This returns the corresponding model name for cpts registered by EE.
+	 *
+	 * @param string $post_type_slug    If a slug is included, then attempt to retrieve
+	 *                                  the model name for the given cpt slug.
+	 *                                  Otherwise if empty, then we'll return
+	 *                                  all cpt model names for cpts registered in EE.
+	 * @return array                    Empty array if no matching model names for the given slug
+	 *                                  or an array of model names indexed by post type slug.
+	 */
+	public function getCustomPostTypeModelNames($post_type_slug = '')
+	{
+		$cpts = $this->getDefinitions();
+		// first if slug passed in...
+		if (! empty($post_type_slug)) {
+			// check that slug and cpt match
+			if (! isset($cpts[ $post_type_slug ])) {
+				return array();
+			}
+			if (empty($cpts[ $post_type_slug ]['class_name'])
+				&& empty($cpts[ $post_type_slug ]['model_name'])
+			) {
+				return array();
+			}
+			// k let's get the model name for this cpt.
+			return $this->getCustomPostTypeModelName($post_type_slug, $cpts[ $post_type_slug ]);
+		}
+		// if we made it here then we're returning an array of cpt model names indexed by post_type_slug.
+		$cpt_models = array();
+		foreach ($cpts as $slug => $args) {
+			$model = $this->getCustomPostTypeModelName($post_type_slug, $cpts[ $post_type_slug ]);
+			if (! empty($model)) {
+				$cpt_models[ $slug ] = $model;
+			}
+		}
+		return $cpt_models;
+	}
 
 
-    /**
-     * @param       $post_type_slug
-     * @param array $cpt
-     * @return array
-     */
-    private function getCustomPostTypeModelName($post_type_slug, array $cpt)
-    {
-        if (! empty($cpt['model_name'])) {
-            return array($post_type_slug => $cpt['model_name']);
-        }
-        if (! empty($cpt['class_name'])) {
-            return array(
-                $post_type_slug => $this->deriveCptModelNameFromClassName($cpt['class_name']),
-            );
-        }
-        return array();
-    }
+	/**
+	 * @param       $post_type_slug
+	 * @param array $cpt
+	 * @return array
+	 */
+	private function getCustomPostTypeModelName($post_type_slug, array $cpt)
+	{
+		if (! empty($cpt['model_name'])) {
+			return array($post_type_slug => $cpt['model_name']);
+		}
+		if (! empty($cpt['class_name'])) {
+			return array(
+				$post_type_slug => $this->deriveCptModelNameFromClassName($cpt['class_name']),
+			);
+		}
+		return array();
+	}
 
 
-    /**
-     * @param string $class_name
-     * @return string
-     */
-    private function deriveCptModelNameFromClassName($class_name)
-    {
-        return str_replace('EE', 'EEM', $class_name);
-    }
+	/**
+	 * @param string $class_name
+	 * @return string
+	 */
+	private function deriveCptModelNameFromClassName($class_name)
+	{
+		return str_replace('EE', 'EEM', $class_name);
+	}
 
 
-    /**
-     * This instantiates cpt models related to the cpts registered via EE.
-     *
-     * @since 4.6.16.rc.000
-     * @param string $post_type_slug If valid slug is provided, then will instantiate the model only for
-     *                               the cpt matching the given slug.  Otherwise all cpt models will be
-     *                               instantiated (if possible).
-     * @return EEM_CPT_Base[]        successful instantiation will return an array of successfully instantiated
-     *                               EEM models indexed by post slug.
-     */
-    public function getCustomPostTypeModels($post_type_slug = '')
-    {
-        $cpt_model_names = $this->getCustomPostTypeModelNames($post_type_slug);
-        $instantiated = array();
-        foreach ($cpt_model_names as $slug => $model_name) {
-            $model = $this->loader->getShared($model_name);
-            if ($model instanceof EEM_CPT_Base) {
-                $instantiated[ $slug ] = $model;
-            }
-        }
-        return $instantiated;
-    }
+	/**
+	 * This instantiates cpt models related to the cpts registered via EE.
+	 *
+	 * @since 4.6.16.rc.000
+	 * @param string $post_type_slug If valid slug is provided, then will instantiate the model only for
+	 *                               the cpt matching the given slug.  Otherwise all cpt models will be
+	 *                               instantiated (if possible).
+	 * @return EEM_CPT_Base[]        successful instantiation will return an array of successfully instantiated
+	 *                               EEM models indexed by post slug.
+	 */
+	public function getCustomPostTypeModels($post_type_slug = '')
+	{
+		$cpt_model_names = $this->getCustomPostTypeModelNames($post_type_slug);
+		$instantiated = array();
+		foreach ($cpt_model_names as $slug => $model_name) {
+			$model = $this->loader->getShared($model_name);
+			if ($model instanceof EEM_CPT_Base) {
+				$instantiated[ $slug ] = $model;
+			}
+		}
+		return $instantiated;
+	}
 }

Spacing +12 added lines, -12 removed lines

@@ -203,7 +203,7 @@ 
         $private_CPTs = array();
         foreach ($this->getDefinitions() as $CPT => $details) {
             if (empty($details['args']['public'])) {
-                $private_CPTs[ $CPT ] = $details;
+                $private_CPTs[$CPT] = $details;
             }
         }
         return $private_CPTs;
@@ -224,25 +224,25 @@ 
     {
         $cpts = $this->getDefinitions();
         // first if slug passed in...
-        if (! empty($post_type_slug)) {
+        if ( ! empty($post_type_slug)) {
             // check that slug and cpt match
-            if (! isset($cpts[ $post_type_slug ])) {
+            if ( ! isset($cpts[$post_type_slug])) {
                 return array();
             }
-            if (empty($cpts[ $post_type_slug ]['class_name'])
-                && empty($cpts[ $post_type_slug ]['model_name'])
+            if (empty($cpts[$post_type_slug]['class_name'])
+                && empty($cpts[$post_type_slug]['model_name'])
             ) {
                 return array();
             }
             // k let's get the model name for this cpt.
-            return $this->getCustomPostTypeModelName($post_type_slug, $cpts[ $post_type_slug ]);
+            return $this->getCustomPostTypeModelName($post_type_slug, $cpts[$post_type_slug]);
         }
         // if we made it here then we're returning an array of cpt model names indexed by post_type_slug.
         $cpt_models = array();
         foreach ($cpts as $slug => $args) {
-            $model = $this->getCustomPostTypeModelName($post_type_slug, $cpts[ $post_type_slug ]);
-            if (! empty($model)) {
-                $cpt_models[ $slug ] = $model;
+            $model = $this->getCustomPostTypeModelName($post_type_slug, $cpts[$post_type_slug]);
+            if ( ! empty($model)) {
+                $cpt_models[$slug] = $model;
             }
         }
         return $cpt_models;
@@ -256,10 +256,10 @@ 
      */
     private function getCustomPostTypeModelName($post_type_slug, array $cpt)
     {
-        if (! empty($cpt['model_name'])) {
+        if ( ! empty($cpt['model_name'])) {
             return array($post_type_slug => $cpt['model_name']);
         }
-        if (! empty($cpt['class_name'])) {
+        if ( ! empty($cpt['class_name'])) {
             return array(
                 $post_type_slug => $this->deriveCptModelNameFromClassName($cpt['class_name']),
             );
@@ -295,7 +295,7 @@ 
         foreach ($cpt_model_names as $slug => $model_name) {
             $model = $this->loader->getShared($model_name);
             if ($model instanceof EEM_CPT_Base) {
-                $instantiated[ $slug ] = $model;
+                $instantiated[$slug] = $model;
             }
         }
         return $instantiated;

core/domain/entities/RegUrlLink.php

Indentation +83 added lines, -83 removed lines

@@ -18,97 +18,97 @@
 class RegUrlLink
 {
 
-    /*
+	/*
      * @var string $reg_url_link
      */
-    private $reg_url_link;
+	private $reg_url_link;
 
 
-    /**
-     * @param string $reg_url_link
-     * @return RegUrlLink
-     * @throws InvalidArgumentException
-     */
-    public static function fromRegUrlLinkString($reg_url_link)
-    {
-        if (empty($reg_url_link) || ! is_string($reg_url_link)) {
-            throw new InvalidArgumentException(
-                __(
-                    'You must supply a valid non-empty string to generate a reg_url_link.',
-                    'event_espresso'
-                )
-            );
-        }
-        return new RegUrlLink(1, '', $reg_url_link);
-    }
+	/**
+	 * @param string $reg_url_link
+	 * @return RegUrlLink
+	 * @throws InvalidArgumentException
+	 */
+	public static function fromRegUrlLinkString($reg_url_link)
+	{
+		if (empty($reg_url_link) || ! is_string($reg_url_link)) {
+			throw new InvalidArgumentException(
+				__(
+					'You must supply a valid non-empty string to generate a reg_url_link.',
+					'event_espresso'
+				)
+			);
+		}
+		return new RegUrlLink(1, '', $reg_url_link);
+	}
 
 
-    /**
-     * @param EE_Registration $registration
-     * @return RegUrlLink
-     * @throws EntityNotFoundException
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     */
-    public static function fromRegistration(EE_Registration $registration)
-    {
-        return new RegUrlLink(
-            $registration->count(),
-            $registration->ticket_line_item()
-        );
-    }
+	/**
+	 * @param EE_Registration $registration
+	 * @return RegUrlLink
+	 * @throws EntityNotFoundException
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 */
+	public static function fromRegistration(EE_Registration $registration)
+	{
+		return new RegUrlLink(
+			$registration->count(),
+			$registration->ticket_line_item()
+		);
+	}
 
 
-    /**
-     * CreateRegUrlLinkCommand constructor.
-     *
-     * @param int    $reg_count
-     * @param mixed  $base_code
-     * @param string $reg_url_link
-     * @throws InvalidArgumentException
-     */
-    public function __construct(
-        $reg_count = 1,
-        $base_code = '',
-        $reg_url_link = ''
-    ) {
-        if (! empty($reg_url_link) && is_string($reg_url_link)) {
-            $this->reg_url_link = apply_filters(
-                'FHEE__\EventEspresso\core\domain\entities\RegUrlLink__construct__reg_url_link',
-                $reg_url_link,
-                $reg_count,
-                $base_code,
-                $reg_url_link
-            );
-            return;
-        }
-        $reg_count = max(1, absint($reg_count));
-        $base_code = $base_code instanceof \EE_Line_Item ? $base_code->code() : $base_code;
-        if (empty($base_code) || ! is_string($base_code)) {
-            throw new InvalidArgumentException(
-                __(
-                    'You must supply a valid EE_Line_Item or a non-empty string to generate a reg_url_link.',
-                    'event_espresso'
-                )
-            );
-        }
-        $this->reg_url_link = (string) apply_filters(
-            'FHEE__\EventEspresso\core\domain\entities\RegUrlLink__construct__reg_url_link',
-            $reg_count . '-' . md5($base_code . microtime()),
-            $reg_count,
-            $base_code,
-            $reg_url_link
-        );
-    }
+	/**
+	 * CreateRegUrlLinkCommand constructor.
+	 *
+	 * @param int    $reg_count
+	 * @param mixed  $base_code
+	 * @param string $reg_url_link
+	 * @throws InvalidArgumentException
+	 */
+	public function __construct(
+		$reg_count = 1,
+		$base_code = '',
+		$reg_url_link = ''
+	) {
+		if (! empty($reg_url_link) && is_string($reg_url_link)) {
+			$this->reg_url_link = apply_filters(
+				'FHEE__\EventEspresso\core\domain\entities\RegUrlLink__construct__reg_url_link',
+				$reg_url_link,
+				$reg_count,
+				$base_code,
+				$reg_url_link
+			);
+			return;
+		}
+		$reg_count = max(1, absint($reg_count));
+		$base_code = $base_code instanceof \EE_Line_Item ? $base_code->code() : $base_code;
+		if (empty($base_code) || ! is_string($base_code)) {
+			throw new InvalidArgumentException(
+				__(
+					'You must supply a valid EE_Line_Item or a non-empty string to generate a reg_url_link.',
+					'event_espresso'
+				)
+			);
+		}
+		$this->reg_url_link = (string) apply_filters(
+			'FHEE__\EventEspresso\core\domain\entities\RegUrlLink__construct__reg_url_link',
+			$reg_count . '-' . md5($base_code . microtime()),
+			$reg_count,
+			$base_code,
+			$reg_url_link
+		);
+	}
 
 
-    /**
-     * Return the object as a string
-     *
-     * @return string
-     */
-    public function __toString()
-    {
-        return $this->reg_url_link;
-    }
+	/**
+	 * Return the object as a string
+	 *
+	 * @return string
+	 */
+	public function __toString()
+	{
+		return $this->reg_url_link;
+	}
 }

Spacing +2 added lines, -2 removed lines

@@ -72,7 +72,7 @@ 
         $base_code = '',
         $reg_url_link = ''
     ) {
-        if (! empty($reg_url_link) && is_string($reg_url_link)) {
+        if ( ! empty($reg_url_link) && is_string($reg_url_link)) {
             $this->reg_url_link = apply_filters(
                 'FHEE__\EventEspresso\core\domain\entities\RegUrlLink__construct__reg_url_link',
                 $reg_url_link,
@@ -94,7 +94,7 @@ 
         }
         $this->reg_url_link = (string) apply_filters(
             'FHEE__\EventEspresso\core\domain\entities\RegUrlLink__construct__reg_url_link',
-            $reg_count . '-' . md5($base_code . microtime()),
+            $reg_count.'-'.md5($base_code.microtime()),
             $reg_count,
             $base_code,
             $reg_url_link

core/domain/entities/shortcodes/EspressoEvents.php

Indentation +118 added lines, -118 removed lines

@@ -30,132 +30,132 @@
 {
 
 
-    /**
-     * the actual shortcode tag that gets registered with WordPress
-     *
-     * @return string
-     */
-    public function getTag()
-    {
-        return 'ESPRESSO_EVENTS';
-    }
+	/**
+	 * the actual shortcode tag that gets registered with WordPress
+	 *
+	 * @return string
+	 */
+	public function getTag()
+	{
+		return 'ESPRESSO_EVENTS';
+	}
 
 
-    /**
-     * the time in seconds to cache the results of the processShortcode() method
-     * 0 means the processShortcode() results will NOT be cached at all
-     *
-     * @return int
-     */
-    public function cacheExpiration()
-    {
-        return 0;
-    }
+	/**
+	 * the time in seconds to cache the results of the processShortcode() method
+	 * 0 means the processShortcode() results will NOT be cached at all
+	 *
+	 * @return int
+	 */
+	public function cacheExpiration()
+	{
+		return 0;
+	}
 
 
-    /**
-     * a place for adding any initialization code that needs to run prior to wp_header().
-     * this may be required for shortcodes that utilize a corresponding module,
-     * and need to enqueue assets for that module
-     *
-     * @return void
-     */
-    public function initializeShortcode()
-    {
-        EED_Events_Archive::instance()->event_list();
-        $this->shortcodeHasBeenInitialized();
-    }
+	/**
+	 * a place for adding any initialization code that needs to run prior to wp_header().
+	 * this may be required for shortcodes that utilize a corresponding module,
+	 * and need to enqueue assets for that module
+	 *
+	 * @return void
+	 */
+	public function initializeShortcode()
+	{
+		EED_Events_Archive::instance()->event_list();
+		$this->shortcodeHasBeenInitialized();
+	}
 
 
-    /**
-     * callback that runs when the shortcode is encountered in post content.
-     * IMPORTANT !!!
-     * remember that shortcode content should be RETURNED and NOT echoed out
-     *
-     * @param array $attributes
-     * @return string
-     */
-    public function processShortcode($attributes = array())
-    {
-        // grab attributes and merge with defaults
-        $attributes = $this->getAttributes($attributes);
-        // make sure we use the_excerpt()
-        add_filter('FHEE__EES_Espresso_Events__process_shortcode__true', '__return_true');
-        // apply query filters
-        add_filter('FHEE__EEH_Event_Query__apply_query_filters', '__return_true');
-        // run the query
-        global $wp_query;
-        // yes we have to overwrite the main wp query, but it's ok...
-        // we're going to reset it again below, so everything will be Hunky Dory (amazing album)
-        $wp_query = new EventListQuery($attributes);
-        // check what template is loaded and load filters accordingly
-        EED_Events_Archive::instance()->template_include('loop-espresso_events.php');
-        // load our template
-        $event_list = EEH_Template::locate_template(
-            'loop-espresso_events.php',
-            array(),
-            true,
-            true
-        );
-        // now reset the query and post data
-        wp_reset_query();
-        wp_reset_postdata();
-        EED_Events_Archive::remove_all_events_archive_filters();
-        // remove query filters
-        remove_filter('FHEE__EEH_Event_Query__apply_query_filters', '__return_true');
-        // pull our content from the output buffer and return it
-        return $event_list;
-    }
+	/**
+	 * callback that runs when the shortcode is encountered in post content.
+	 * IMPORTANT !!!
+	 * remember that shortcode content should be RETURNED and NOT echoed out
+	 *
+	 * @param array $attributes
+	 * @return string
+	 */
+	public function processShortcode($attributes = array())
+	{
+		// grab attributes and merge with defaults
+		$attributes = $this->getAttributes($attributes);
+		// make sure we use the_excerpt()
+		add_filter('FHEE__EES_Espresso_Events__process_shortcode__true', '__return_true');
+		// apply query filters
+		add_filter('FHEE__EEH_Event_Query__apply_query_filters', '__return_true');
+		// run the query
+		global $wp_query;
+		// yes we have to overwrite the main wp query, but it's ok...
+		// we're going to reset it again below, so everything will be Hunky Dory (amazing album)
+		$wp_query = new EventListQuery($attributes);
+		// check what template is loaded and load filters accordingly
+		EED_Events_Archive::instance()->template_include('loop-espresso_events.php');
+		// load our template
+		$event_list = EEH_Template::locate_template(
+			'loop-espresso_events.php',
+			array(),
+			true,
+			true
+		);
+		// now reset the query and post data
+		wp_reset_query();
+		wp_reset_postdata();
+		EED_Events_Archive::remove_all_events_archive_filters();
+		// remove query filters
+		remove_filter('FHEE__EEH_Event_Query__apply_query_filters', '__return_true');
+		// pull our content from the output buffer and return it
+		return $event_list;
+	}
 
 
-    /**
-     * merge incoming attributes with filtered defaults
-     *
-     * @param array $attributes
-     * @return array
-     */
-    private function getAttributes(array $attributes)
-    {
-        return array_merge(
-            (array) apply_filters(
-                'EES_Espresso_Events__process_shortcode__default_espresso_events_shortcode_atts',
-                array(
-                    'title'         => '',
-                    'limit'         => 10,
-                    'css_class'     => '',
-                    'show_expired'  => false,
-                    'month'         => '',
-                    'category_slug' => '',
-                    'order_by'      => 'start_date',
-                    'sort'          => 'ASC',
-                    'show_title'    => true,
-                )
-            ),
-            $attributes
-        );
-    }
+	/**
+	 * merge incoming attributes with filtered defaults
+	 *
+	 * @param array $attributes
+	 * @return array
+	 */
+	private function getAttributes(array $attributes)
+	{
+		return array_merge(
+			(array) apply_filters(
+				'EES_Espresso_Events__process_shortcode__default_espresso_events_shortcode_atts',
+				array(
+					'title'         => '',
+					'limit'         => 10,
+					'css_class'     => '',
+					'show_expired'  => false,
+					'month'         => '',
+					'category_slug' => '',
+					'order_by'      => 'start_date',
+					'sort'          => 'ASC',
+					'show_title'    => true,
+				)
+			),
+			$attributes
+		);
+	}
 
 
-    /**
-     * array for defining custom attribute sanitization callbacks,
-     * where keys match keys in your attributes array,
-     * and values represent the sanitization function you wish to be applied to that attribute.
-     * So for example, if you had an integer attribute named "event_id"
-     * that you wanted to be sanitized using absint(),
-     * then you would pass the following for your $custom_sanitization array:
-     *      array('event_id' => 'absint')
-     *
-     * @return array
-     */
-    protected function customAttributeSanitizationMap()
-    {
-        // the following get sanitized/whitelisted in EEH_Event_Query
-        return array(
-            'category_slug' => 'skip_sanitization',
-            'show_expired'  => 'skip_sanitization',
-            'order_by'      => 'skip_sanitization',
-            'month'         => 'skip_sanitization',
-            'sort'          => 'skip_sanitization',
-        );
-    }
+	/**
+	 * array for defining custom attribute sanitization callbacks,
+	 * where keys match keys in your attributes array,
+	 * and values represent the sanitization function you wish to be applied to that attribute.
+	 * So for example, if you had an integer attribute named "event_id"
+	 * that you wanted to be sanitized using absint(),
+	 * then you would pass the following for your $custom_sanitization array:
+	 *      array('event_id' => 'absint')
+	 *
+	 * @return array
+	 */
+	protected function customAttributeSanitizationMap()
+	{
+		// the following get sanitized/whitelisted in EEH_Event_Query
+		return array(
+			'category_slug' => 'skip_sanitization',
+			'show_expired'  => 'skip_sanitization',
+			'order_by'      => 'skip_sanitization',
+			'month'         => 'skip_sanitization',
+			'sort'          => 'skip_sanitization',
+		);
+	}
 }

core/domain/entities/shortcodes/EspressoCancelled.php

Indentation +68 added lines, -68 removed lines

@@ -20,78 +20,78 @@
 {
 
 
-    /**
-     * the actual shortcode tag that gets registered with WordPress
-     *
-     * @return string
-     */
-    public function getTag()
-    {
-        return 'ESPRESSO_CANCELLED';
-    }
+	/**
+	 * the actual shortcode tag that gets registered with WordPress
+	 *
+	 * @return string
+	 */
+	public function getTag()
+	{
+		return 'ESPRESSO_CANCELLED';
+	}
 
 
-    /**
-     * the time in seconds to cache the results of the processShortcode() method
-     * 0 means the processShortcode() results will NOT be cached at all
-     *
-     * @return int
-     */
-    public function cacheExpiration()
-    {
-        return 0;
-    }
+	/**
+	 * the time in seconds to cache the results of the processShortcode() method
+	 * 0 means the processShortcode() results will NOT be cached at all
+	 *
+	 * @return int
+	 */
+	public function cacheExpiration()
+	{
+		return 0;
+	}
 
 
-    /**
-     * a place for adding any initialization code that needs to run prior to wp_header().
-     * this may be required for shortcodes that utilize a corresponding module,
-     * and need to enqueue assets for that module
-     *
-     * @return void
-     */
-    public function initializeShortcode()
-    {
-        $this->shortcodeHasBeenInitialized();
-    }
+	/**
+	 * a place for adding any initialization code that needs to run prior to wp_header().
+	 * this may be required for shortcodes that utilize a corresponding module,
+	 * and need to enqueue assets for that module
+	 *
+	 * @return void
+	 */
+	public function initializeShortcode()
+	{
+		$this->shortcodeHasBeenInitialized();
+	}
 
 
-    /**
-     * callback that runs when the shortcode is encountered in post content.
-     * IMPORTANT !!!
-     * remember that shortcode content should be RETURNED and NOT echoed out
-     *
-     * @param array $attributes
-     * @return string
-     * @throws \EE_Error
-     */
-    public function processShortcode($attributes = array())
-    {
-        $transaction = EE_Registry::instance()->SSN->get_session_data('transaction');
-        if ($transaction instanceof EE_Transaction) {
-            do_action('AHEE__EES_Espresso_Cancelled__process_shortcode__transaction', $transaction);
-            $registrations = $transaction->registrations();
-            foreach ($registrations as $registration) {
-                if ($registration instanceof EE_Registration) {
-                    do_action('AHEE__EES_Espresso_Cancelled__process_shortcode__registration', $registration);
-                }
-            }
-        }
-        do_action('AHEE__EES_Espresso_Cancelled__process_shortcode__clear_session');
-        // remove all unwanted records from the db
-        if (EE_Registry::instance()->CART instanceof EE_Cart) {
-            EE_Registry::instance()->CART->delete_cart();
-        }
-        // phpcs:disable WordPress.WP.I18n.UnorderedPlaceholdersText
-        EE_Registry::instance()->SSN->clear_session(__CLASS__, __FUNCTION__);
-        return sprintf(
-            __(
-                '%sAll unsaved registration information entered during this session has been deleted.%s',
-                'event_espresso'
-            ),
-            '<p class="ee-registrations-cancelled-pg ee-attention">',
-            '</p>'
-        );
-        // phpcs:enable
-    }
+	/**
+	 * callback that runs when the shortcode is encountered in post content.
+	 * IMPORTANT !!!
+	 * remember that shortcode content should be RETURNED and NOT echoed out
+	 *
+	 * @param array $attributes
+	 * @return string
+	 * @throws \EE_Error
+	 */
+	public function processShortcode($attributes = array())
+	{
+		$transaction = EE_Registry::instance()->SSN->get_session_data('transaction');
+		if ($transaction instanceof EE_Transaction) {
+			do_action('AHEE__EES_Espresso_Cancelled__process_shortcode__transaction', $transaction);
+			$registrations = $transaction->registrations();
+			foreach ($registrations as $registration) {
+				if ($registration instanceof EE_Registration) {
+					do_action('AHEE__EES_Espresso_Cancelled__process_shortcode__registration', $registration);
+				}
+			}
+		}
+		do_action('AHEE__EES_Espresso_Cancelled__process_shortcode__clear_session');
+		// remove all unwanted records from the db
+		if (EE_Registry::instance()->CART instanceof EE_Cart) {
+			EE_Registry::instance()->CART->delete_cart();
+		}
+		// phpcs:disable WordPress.WP.I18n.UnorderedPlaceholdersText
+		EE_Registry::instance()->SSN->clear_session(__CLASS__, __FUNCTION__);
+		return sprintf(
+			__(
+				'%sAll unsaved registration information entered during this session has been deleted.%s',
+				'event_espresso'
+			),
+			'<p class="ee-registrations-cancelled-pg ee-attention">',
+			'</p>'
+		);
+		// phpcs:enable
+	}
 }

core/domain/services/wp_queries/EventListQuery.php

Indentation +194 added lines, -194 removed lines

@@ -16,198 +16,198 @@
 class EventListQuery extends WP_Query
 {
 
-    /**
-     * @var string $title
-     */
-    private $title;
-
-    /**
-     * @var integer $limit
-     */
-    private $limit = 10;
-
-    /**
-     * @var string $css_class
-     */
-    private $css_class;
-
-    /**
-     * @var boolean $show_expired
-     */
-    private $show_expired = false;
-
-    /**
-     * @var string $month
-     */
-    private $month;
-
-    /**
-     * @var string $category_slug
-     */
-    private $category_slug;
-
-    /**
-     * @var string $order_by
-     */
-    private $order_by;
-
-    /**
-     * @var string $sort
-     */
-    private $sort;
-
-    /**
-     * @var boolean $show_title
-     */
-    private $show_title = true;
-
-
-    /**
-     * EE_Event_List_Query Constructor     *
-     *
-     * @param array $args
-     */
-    public function __construct($args = array())
-    {
-        $args = $this->parseArgs((array) $args);
-        $this->setupEventQueryHelper();
-        $this->setupFilters();
-        $args = $this->getQueryArgs($args);
-        // run the query
-        parent::__construct($args);
-    }
-
-
-    /**
-     * @param array $args
-     * @return array
-     */
-    private function parseArgs(array $args)
-    {
-        // incoming args could be a mix of WP query args + EE shortcode args
-        foreach ($args as $property => $value) {
-            // if the arg is a property of this class, then it's an EE shortcode arg
-            if (property_exists($this, $property) && ! property_exists('WP_Query', $property)) {
-                // set the property value
-                $this->{$property} = $value;
-                // then remove it from the array of args that will later be passed to WP_Query()
-                unset($args[ $property ]);
-            }
-        }
-        return $args;
-    }
-
-
-    private function setupEventQueryHelper()
-    {
-        // add query filters
-        EEH_Event_Query::add_query_filters();
-        // set params that will get used by the filters
-        EEH_Event_Query::set_query_params(
-            $this->month,
-            $this->category_slug,
-            $this->show_expired,
-            $this->order_by,
-            $this->sort
-        );
-    }
-
-
-    private function setupFilters()
-    {
-        // first off, let's remove any filters from previous queries
-        remove_filter(
-            'FHEE__archive_espresso_events_template__show_header',
-            array($this, 'show_event_list_title')
-        );
-        remove_filter(
-            'FHEE__archive_espresso_events_template__upcoming_events_h1',
-            array($this, 'event_list_title')
-        );
-        remove_all_filters('FHEE__content_espresso_events__event_class');
-        // Event List Title ?
-        add_filter(
-            'FHEE__archive_espresso_events_template__show_header',
-            array($this, 'show_event_list_title')
-        );
-        add_filter(
-            'FHEE__archive_espresso_events_template__upcoming_events_h1',
-            array($this, 'event_list_title'),
-            10,
-            1
-        );
-        // add the css class
-        add_filter(
-            'FHEE__content_espresso_events__event_class',
-            array($this, 'event_list_css'),
-            10,
-            1
-        );
-    }
-
-
-    private function getQueryArgs(array $args)
-    {
-        // the current "page" we are viewing
-        $paged = max(1, get_query_var('paged'));
-        // Force these args
-        return array_merge(
-            $args,
-            array(
-                'post_type'              => 'espresso_events',
-                'posts_per_page'         => $this->limit,
-                'update_post_term_cache' => false,
-                'update_post_meta_cache' => false,
-                'paged'                  => $paged,
-                'offset'                 => ($paged - 1) * $this->limit,
-            )
-        );
-    }
-
-    // phpcs:disable PSR1.Methods.CamelCapsMethodName.NotCamelCaps
-
-    /**
-     * show_event_list_title
-     *
-     * @return boolean
-     */
-    public function show_event_list_title()
-    {
-        return filter_var(
-            $this->show_title,
-            FILTER_VALIDATE_BOOLEAN
-        );
-    }
-
-
-    /**
-     * callback for FHEE__archive_espresso_events_template__upcoming_events_h1 filter
-     *
-     * @param string $event_list_title
-     * @return    string
-     */
-    public function event_list_title($event_list_title = '')
-    {
-        if (! empty($this->title)) {
-            return $this->title;
-        }
-        return $event_list_title;
-    }
-
-
-    /**
-     * callback for FHEE__content_espresso_events__event_class filter
-     *
-     * @param string $event_list_css
-     * @return string
-     */
-    public function event_list_css($event_list_css = '')
-    {
-        $event_list_css .= ! empty($event_list_css) ? ' ' : '';
-        $event_list_css .= ! empty($this->css_class) ? $this->css_class : '';
-        $event_list_css .= ! empty($event_list_css) ? ' ' : '';
-        $event_list_css .= ! empty($this->category_slug) ? $this->category_slug : '';
-        return $event_list_css;
-    }
-    // phpcs:enable
+	/**
+	 * @var string $title
+	 */
+	private $title;
+
+	/**
+	 * @var integer $limit
+	 */
+	private $limit = 10;
+
+	/**
+	 * @var string $css_class
+	 */
+	private $css_class;
+
+	/**
+	 * @var boolean $show_expired
+	 */
+	private $show_expired = false;
+
+	/**
+	 * @var string $month
+	 */
+	private $month;
+
+	/**
+	 * @var string $category_slug
+	 */
+	private $category_slug;
+
+	/**
+	 * @var string $order_by
+	 */
+	private $order_by;
+
+	/**
+	 * @var string $sort
+	 */
+	private $sort;
+
+	/**
+	 * @var boolean $show_title
+	 */
+	private $show_title = true;
+
+
+	/**
+	 * EE_Event_List_Query Constructor     *
+	 *
+	 * @param array $args
+	 */
+	public function __construct($args = array())
+	{
+		$args = $this->parseArgs((array) $args);
+		$this->setupEventQueryHelper();
+		$this->setupFilters();
+		$args = $this->getQueryArgs($args);
+		// run the query
+		parent::__construct($args);
+	}
+
+
+	/**
+	 * @param array $args
+	 * @return array
+	 */
+	private function parseArgs(array $args)
+	{
+		// incoming args could be a mix of WP query args + EE shortcode args
+		foreach ($args as $property => $value) {
+			// if the arg is a property of this class, then it's an EE shortcode arg
+			if (property_exists($this, $property) && ! property_exists('WP_Query', $property)) {
+				// set the property value
+				$this->{$property} = $value;
+				// then remove it from the array of args that will later be passed to WP_Query()
+				unset($args[ $property ]);
+			}
+		}
+		return $args;
+	}
+
+
+	private function setupEventQueryHelper()
+	{
+		// add query filters
+		EEH_Event_Query::add_query_filters();
+		// set params that will get used by the filters
+		EEH_Event_Query::set_query_params(
+			$this->month,
+			$this->category_slug,
+			$this->show_expired,
+			$this->order_by,
+			$this->sort
+		);
+	}
+
+
+	private function setupFilters()
+	{
+		// first off, let's remove any filters from previous queries
+		remove_filter(
+			'FHEE__archive_espresso_events_template__show_header',
+			array($this, 'show_event_list_title')
+		);
+		remove_filter(
+			'FHEE__archive_espresso_events_template__upcoming_events_h1',
+			array($this, 'event_list_title')
+		);
+		remove_all_filters('FHEE__content_espresso_events__event_class');
+		// Event List Title ?
+		add_filter(
+			'FHEE__archive_espresso_events_template__show_header',
+			array($this, 'show_event_list_title')
+		);
+		add_filter(
+			'FHEE__archive_espresso_events_template__upcoming_events_h1',
+			array($this, 'event_list_title'),
+			10,
+			1
+		);
+		// add the css class
+		add_filter(
+			'FHEE__content_espresso_events__event_class',
+			array($this, 'event_list_css'),
+			10,
+			1
+		);
+	}
+
+
+	private function getQueryArgs(array $args)
+	{
+		// the current "page" we are viewing
+		$paged = max(1, get_query_var('paged'));
+		// Force these args
+		return array_merge(
+			$args,
+			array(
+				'post_type'              => 'espresso_events',
+				'posts_per_page'         => $this->limit,
+				'update_post_term_cache' => false,
+				'update_post_meta_cache' => false,
+				'paged'                  => $paged,
+				'offset'                 => ($paged - 1) * $this->limit,
+			)
+		);
+	}
+
+	// phpcs:disable PSR1.Methods.CamelCapsMethodName.NotCamelCaps
+
+	/**
+	 * show_event_list_title
+	 *
+	 * @return boolean
+	 */
+	public function show_event_list_title()
+	{
+		return filter_var(
+			$this->show_title,
+			FILTER_VALIDATE_BOOLEAN
+		);
+	}
+
+
+	/**
+	 * callback for FHEE__archive_espresso_events_template__upcoming_events_h1 filter
+	 *
+	 * @param string $event_list_title
+	 * @return    string
+	 */
+	public function event_list_title($event_list_title = '')
+	{
+		if (! empty($this->title)) {
+			return $this->title;
+		}
+		return $event_list_title;
+	}
+
+
+	/**
+	 * callback for FHEE__content_espresso_events__event_class filter
+	 *
+	 * @param string $event_list_css
+	 * @return string
+	 */
+	public function event_list_css($event_list_css = '')
+	{
+		$event_list_css .= ! empty($event_list_css) ? ' ' : '';
+		$event_list_css .= ! empty($this->css_class) ? $this->css_class : '';
+		$event_list_css .= ! empty($event_list_css) ? ' ' : '';
+		$event_list_css .= ! empty($this->category_slug) ? $this->category_slug : '';
+		return $event_list_css;
+	}
+	// phpcs:enable
 }

Spacing +2 added lines, -2 removed lines

@@ -91,7 +91,7 @@ 
                 // set the property value
                 $this->{$property} = $value;
                 // then remove it from the array of args that will later be passed to WP_Query()
-                unset($args[ $property ]);
+                unset($args[$property]);
             }
         }
         return $args;
@@ -188,7 +188,7 @@ 
      */
     public function event_list_title($event_list_title = '')
     {
-        if (! empty($this->title)) {
+        if ( ! empty($this->title)) {
             return $this->title;
         }
         return $event_list_title;

core/domain/services/validation/email/strategies/Basic.php

Indentation +102 added lines, -102 removed lines

@@ -15,112 +15,112 @@
 class Basic implements EmailValidatorInterface
 {
 
-    /**
-     * @param string $email_address
-     * @return bool
-     * @throws EmailValidationException
-     */
-    public function validate($email_address)
-    {
-        if (! preg_match('/^.+\@\S+$/', $email_address)) {
-            // email not in correct {string}@{string} format
-            throw new EmailValidationException(
-                esc_html__('Email does not have the required @ sign.', 'event_espresso')
-            );
-        }
-        $atIndex = $this->getAtIndex($email_address);
-        $local = $this->getLocalPartOfEmail($email_address, $atIndex);
-        $localLen = strlen($local);
-        if ($localLen < 1) {
-            // no local part
-            throw new EmailValidationException(
-                esc_html__('Email local-part (before the @) is required.', 'event_espresso')
-            );
-        }
-        if ($localLen > 64) {
-            // local part length exceeded
-            throw new EmailValidationException(
-                esc_html__('Email local-part (before the @) is too long.', 'event_espresso')
-            );
-        }
-        if ($local[0] === '.') {
-            // local part starts with '.'
-            throw new EmailValidationException(
-                esc_html__('Email local-part (before the @) must not begin with a period.', 'event_espresso')
-            );
-        }
-        if ($local[ $localLen - 1 ] === '.') {
-            // local part starts or ends with '.'
-            throw new EmailValidationException(
-                esc_html__('Email local-part (before the @) must not end with a period.', 'event_espresso')
-            );
-        }
-        if (preg_match('/\\.\\./', $local)) {
-            // local part has two consecutive dots
-            throw new EmailValidationException(
-                esc_html__(
-                    'Email local-part (before the @) must not have two consecutive periods.',
-                    'event_espresso'
-                )
-            );
-        }
-        $domain = $this->getDomainPartOfEmail($email_address, $atIndex);
-        $domainLen = strlen($domain);
-        if ($domainLen < 1) {
-            throw new EmailValidationException(
-                esc_html__('Email domain (after the @) is required.', 'event_espresso')
-            );
-        }
-        if ($domainLen > 255) {
-            // domain part length exceeded
-            throw new EmailValidationException(
-                esc_html__('Email domain (after the @) is too long.', 'event_espresso')
-            );
-        }
-        if (preg_match('/\\.\\./', $domain)) {
-            // domain part has two consecutive dots
-            throw new EmailValidationException(
-                esc_html__('Email domain (after the @) must not have two consecutive periods.', 'event_espresso')
-            );
-        }
-        return true;
-    }
+	/**
+	 * @param string $email_address
+	 * @return bool
+	 * @throws EmailValidationException
+	 */
+	public function validate($email_address)
+	{
+		if (! preg_match('/^.+\@\S+$/', $email_address)) {
+			// email not in correct {string}@{string} format
+			throw new EmailValidationException(
+				esc_html__('Email does not have the required @ sign.', 'event_espresso')
+			);
+		}
+		$atIndex = $this->getAtIndex($email_address);
+		$local = $this->getLocalPartOfEmail($email_address, $atIndex);
+		$localLen = strlen($local);
+		if ($localLen < 1) {
+			// no local part
+			throw new EmailValidationException(
+				esc_html__('Email local-part (before the @) is required.', 'event_espresso')
+			);
+		}
+		if ($localLen > 64) {
+			// local part length exceeded
+			throw new EmailValidationException(
+				esc_html__('Email local-part (before the @) is too long.', 'event_espresso')
+			);
+		}
+		if ($local[0] === '.') {
+			// local part starts with '.'
+			throw new EmailValidationException(
+				esc_html__('Email local-part (before the @) must not begin with a period.', 'event_espresso')
+			);
+		}
+		if ($local[ $localLen - 1 ] === '.') {
+			// local part starts or ends with '.'
+			throw new EmailValidationException(
+				esc_html__('Email local-part (before the @) must not end with a period.', 'event_espresso')
+			);
+		}
+		if (preg_match('/\\.\\./', $local)) {
+			// local part has two consecutive dots
+			throw new EmailValidationException(
+				esc_html__(
+					'Email local-part (before the @) must not have two consecutive periods.',
+					'event_espresso'
+				)
+			);
+		}
+		$domain = $this->getDomainPartOfEmail($email_address, $atIndex);
+		$domainLen = strlen($domain);
+		if ($domainLen < 1) {
+			throw new EmailValidationException(
+				esc_html__('Email domain (after the @) is required.', 'event_espresso')
+			);
+		}
+		if ($domainLen > 255) {
+			// domain part length exceeded
+			throw new EmailValidationException(
+				esc_html__('Email domain (after the @) is too long.', 'event_espresso')
+			);
+		}
+		if (preg_match('/\\.\\./', $domain)) {
+			// domain part has two consecutive dots
+			throw new EmailValidationException(
+				esc_html__('Email domain (after the @) must not have two consecutive periods.', 'event_espresso')
+			);
+		}
+		return true;
+	}
 
 
-    /**
-     * returns the location of the @ symbol
-     *
-     * @param string $email_address
-     * @return bool|string
-     */
-    protected function getAtIndex($email_address)
-    {
-        return strrpos($email_address, '@');
-    }
+	/**
+	 * returns the location of the @ symbol
+	 *
+	 * @param string $email_address
+	 * @return bool|string
+	 */
+	protected function getAtIndex($email_address)
+	{
+		return strrpos($email_address, '@');
+	}
 
 
-    /**
-     * Gets the local part of the email
-     *
-     * @param string   $email_address
-     * @param bool|int $atIndex
-     * @return bool|string
-     */
-    protected function getLocalPartOfEmail($email_address, $atIndex)
-    {
-        return substr($email_address, 0, $atIndex);
-    }
+	/**
+	 * Gets the local part of the email
+	 *
+	 * @param string   $email_address
+	 * @param bool|int $atIndex
+	 * @return bool|string
+	 */
+	protected function getLocalPartOfEmail($email_address, $atIndex)
+	{
+		return substr($email_address, 0, $atIndex);
+	}
 
 
-    /**
-     * Gets the domain part of the email
-     *
-     * @param string   $email_address
-     * @param bool|int $atIndex
-     * @return bool|string
-     */
-    protected function getDomainPartOfEmail($email_address, $atIndex)
-    {
-        return substr($email_address, $atIndex + 1);
-    }
+	/**
+	 * Gets the domain part of the email
+	 *
+	 * @param string   $email_address
+	 * @param bool|int $atIndex
+	 * @return bool|string
+	 */
+	protected function getDomainPartOfEmail($email_address, $atIndex)
+	{
+		return substr($email_address, $atIndex + 1);
+	}
 }

Spacing +2 added lines, -2 removed lines

@@ -22,7 +22,7 @@ 
      */
     public function validate($email_address)
     {
-        if (! preg_match('/^.+\@\S+$/', $email_address)) {
+        if ( ! preg_match('/^.+\@\S+$/', $email_address)) {
             // email not in correct {string}@{string} format
             throw new EmailValidationException(
                 esc_html__('Email does not have the required @ sign.', 'event_espresso')
@@ -49,7 +49,7 @@ 
                 esc_html__('Email local-part (before the @) must not begin with a period.', 'event_espresso')
             );
         }
-        if ($local[ $localLen - 1 ] === '.') {
+        if ($local[$localLen - 1] === '.') {
             // local part starts or ends with '.'
             throw new EmailValidationException(
                 esc_html__('Email local-part (before the @) must not end with a period.', 'event_espresso')