eventespresso / event-espresso-core

core/libraries/plugin_api/EE_Register_Personal_Data_Exporter.lib.php

Spacing +2 added lines, -2 removed lines

@@ -28,7 +28,7 @@ 
      */
     public static function register($identifier = '', array $setup_args = [])
     {
-        self::$exporters[ $identifier ] = $setup_args;
+        self::$exporters[$identifier] = $setup_args;
         // add to list of modules to be registered
         add_filter(
             'FHEE__EventEspresso_core_services_privacy_export_PersonalDataExporterManager__exporters',
@@ -42,7 +42,7 @@ 
      */
     public static function deregister($identifier = '')
     {
-        unset(self::$exporters[ $identifier ]);
+        unset(self::$exporters[$identifier]);
     }
 
 

Indentation +43 added lines, -43 removed lines

@@ -12,55 +12,55 @@
  */
 class EE_Register_Personal_Data_Exporter implements EEI_Plugin_API
 {
-    /**
-     * FQCN for all privacy policy generators
-     *
-     * @var array keys are plugin_ids, and values are an array of FQCNs or FQCNs
-     */
-    protected static $exporters = [];
+	/**
+	 * FQCN for all privacy policy generators
+	 *
+	 * @var array keys are plugin_ids, and values are an array of FQCNs or FQCNs
+	 */
+	protected static $exporters = [];
 
 
-    /**
-     * @param string $identifier
-     * @param array  $setup_args can be the fully qualified namespaces each containing only privacy policies,
-     *                           OR fully qualified class names of privacy policies
-     */
-    public static function register($identifier = '', array $setup_args = [])
-    {
-        self::$exporters[ $identifier ] = $setup_args;
-        // add to list of modules to be registered
-        add_filter(
-            'FHEE__EventEspresso_core_services_privacy_export_PersonalDataExporterManager__exporters',
-            ['EE_Register_Personal_Data_Exporter', 'addExporters']
-        );
-    }
+	/**
+	 * @param string $identifier
+	 * @param array  $setup_args can be the fully qualified namespaces each containing only privacy policies,
+	 *                           OR fully qualified class names of privacy policies
+	 */
+	public static function register($identifier = '', array $setup_args = [])
+	{
+		self::$exporters[ $identifier ] = $setup_args;
+		// add to list of modules to be registered
+		add_filter(
+			'FHEE__EventEspresso_core_services_privacy_export_PersonalDataExporterManager__exporters',
+			['EE_Register_Personal_Data_Exporter', 'addExporters']
+		);
+	}
 
 
-    /**
-     * @param string $identifier
-     */
-    public static function deregister($identifier = '')
-    {
-        unset(self::$exporters[ $identifier ]);
-    }
+	/**
+	 * @param string $identifier
+	 */
+	public static function deregister($identifier = '')
+	{
+		unset(self::$exporters[ $identifier ]);
+	}
 
 
-    /**
-     * Adds our personal data exporters registered by add-ons
-     *
-     * @param string[] $exporters
-     * @return string[]
-     */
-    public static function addExporters(array $exporters)
-    {
-        foreach (self::$exporters as $exporters_per_addon) {
-            $exporters = array_merge(
-                $exporters,
-                $exporters_per_addon
-            );
-        }
-        return $exporters;
-    }
+	/**
+	 * Adds our personal data exporters registered by add-ons
+	 *
+	 * @param string[] $exporters
+	 * @return string[]
+	 */
+	public static function addExporters(array $exporters)
+	{
+		foreach (self::$exporters as $exporters_per_addon) {
+			$exporters = array_merge(
+				$exporters,
+				$exporters_per_addon
+			);
+		}
+		return $exporters;
+	}
 }
 // End of file EE_Register_Personal_Data_Exporter.lib.php
 // Location: ${NAMESPACE}/EE_Register_Personal_Data_Exporter.lib.php

core/libraries/plugin_api/EE_Register_Personal_Data_Eraser.lib.php

Spacing +2 added lines, -2 removed lines

@@ -28,7 +28,7 @@ 
      */
     public static function register($identifier = '', array $setup_args = [])
     {
-        self::$erasers[ $identifier ] = $setup_args;
+        self::$erasers[$identifier] = $setup_args;
         // add to list of modules to be registered
         add_filter(
             'FHEE__EventEspresso_core_services_privacy_erasure_PersonalDataEraserManager__erasers',
@@ -42,7 +42,7 @@ 
      */
     public static function deregister($identifier = '')
     {
-        unset(self::$erasers[ $identifier ]);
+        unset(self::$erasers[$identifier]);
     }
 
 

Indentation +43 added lines, -43 removed lines

@@ -12,55 +12,55 @@
  */
 class EE_Register_Personal_Data_Eraser implements EEI_Plugin_API
 {
-    /**
-     * FQCN for all privacy policy generators
-     *
-     * @var array keys are plugin_ids, and values are an array of FQCNs or FQCNs
-     */
-    protected static $erasers = [];
+	/**
+	 * FQCN for all privacy policy generators
+	 *
+	 * @var array keys are plugin_ids, and values are an array of FQCNs or FQCNs
+	 */
+	protected static $erasers = [];
 
 
-    /**
-     * @param string $identifier
-     * @param array  $setup_args can be the fully qualified namespaces each containing only privacy policies,
-     *                           OR fully qualified class names of privacy policies
-     */
-    public static function register($identifier = '', array $setup_args = [])
-    {
-        self::$erasers[ $identifier ] = $setup_args;
-        // add to list of modules to be registered
-        add_filter(
-            'FHEE__EventEspresso_core_services_privacy_erasure_PersonalDataEraserManager__erasers',
-            ['EE_Register_Personal_Data_Eraser', 'addErasers']
-        );
-    }
+	/**
+	 * @param string $identifier
+	 * @param array  $setup_args can be the fully qualified namespaces each containing only privacy policies,
+	 *                           OR fully qualified class names of privacy policies
+	 */
+	public static function register($identifier = '', array $setup_args = [])
+	{
+		self::$erasers[ $identifier ] = $setup_args;
+		// add to list of modules to be registered
+		add_filter(
+			'FHEE__EventEspresso_core_services_privacy_erasure_PersonalDataEraserManager__erasers',
+			['EE_Register_Personal_Data_Eraser', 'addErasers']
+		);
+	}
 
 
-    /**
-     * @param string $identifier
-     */
-    public static function deregister($identifier = '')
-    {
-        unset(self::$erasers[ $identifier ]);
-    }
+	/**
+	 * @param string $identifier
+	 */
+	public static function deregister($identifier = '')
+	{
+		unset(self::$erasers[ $identifier ]);
+	}
 
 
-    /**
-     * Adds our personal data erasers registered by add-ons
-     *
-     * @param string[] $erasers
-     * @return string[]
-     */
-    public static function addErasers(array $erasers)
-    {
-        foreach (self::$erasers as $erasers_per_addon) {
-            $erasers = array_merge(
-                $erasers,
-                $erasers_per_addon
-            );
-        }
-        return $erasers;
-    }
+	/**
+	 * Adds our personal data erasers registered by add-ons
+	 *
+	 * @param string[] $erasers
+	 * @return string[]
+	 */
+	public static function addErasers(array $erasers)
+	{
+		foreach (self::$erasers as $erasers_per_addon) {
+			$erasers = array_merge(
+				$erasers,
+				$erasers_per_addon
+			);
+		}
+		return $erasers;
+	}
 }
 // End of file EE_Register_Personal_Data_Eraser.lib.php
 // Location: ${NAMESPACE}/EE_Register_Personal_Data_Eraser.lib.php

core/libraries/plugin_api/EE_Register_Privacy_Policy.lib.php

Spacing +2 added lines, -2 removed lines

@@ -28,7 +28,7 @@ 
      */
     public static function register($identifier = '', array $setup_args = [])
     {
-        self::$privacy_policies[ $identifier ] = $setup_args;
+        self::$privacy_policies[$identifier] = $setup_args;
         // add to list of modules to be registered
         add_filter(
             'FHEE__EventEspresso_core_services_privacy_policy_PrivacyPolicyManager__privacy_policies',
@@ -42,7 +42,7 @@ 
      */
     public static function deregister($identifier = '')
     {
-        unset(self::$privacy_policies[ $identifier ]);
+        unset(self::$privacy_policies[$identifier]);
     }
 
 

Indentation +43 added lines, -43 removed lines

@@ -12,55 +12,55 @@
  */
 class EE_Register_Privacy_Policy implements EEI_Plugin_API
 {
-    /**
-     * FQCN for all privacy policy generators
-     *
-     * @var array keys are plugin_ids, and values are an array of FQCNs or FQCNs
-     */
-    protected static $privacy_policies = array();
+	/**
+	 * FQCN for all privacy policy generators
+	 *
+	 * @var array keys are plugin_ids, and values are an array of FQCNs or FQCNs
+	 */
+	protected static $privacy_policies = array();
 
 
-    /**
-     * @param string $identifier
-     * @param array $setup_args can be the fully qualified namespaces each containing only privacy policies,
-     *              OR fully qualified class names of privacy policies
-     */
-    public static function register($identifier = '', array $setup_args = [])
-    {
-        self::$privacy_policies[ $identifier ] = $setup_args;
-        // add to list of modules to be registered
-        add_filter(
-            'FHEE__EventEspresso_core_services_privacy_policy_PrivacyPolicyManager__privacy_policies',
-            array('EE_Register_Privacy_Policy', 'addPrivacyPolicies')
-        );
-    }
+	/**
+	 * @param string $identifier
+	 * @param array $setup_args can be the fully qualified namespaces each containing only privacy policies,
+	 *              OR fully qualified class names of privacy policies
+	 */
+	public static function register($identifier = '', array $setup_args = [])
+	{
+		self::$privacy_policies[ $identifier ] = $setup_args;
+		// add to list of modules to be registered
+		add_filter(
+			'FHEE__EventEspresso_core_services_privacy_policy_PrivacyPolicyManager__privacy_policies',
+			array('EE_Register_Privacy_Policy', 'addPrivacyPolicies')
+		);
+	}
 
 
-    /**
-     * @param string $identifier
-     */
-    public static function deregister($identifier = '')
-    {
-        unset(self::$privacy_policies[ $identifier ]);
-    }
+	/**
+	 * @param string $identifier
+	 */
+	public static function deregister($identifier = '')
+	{
+		unset(self::$privacy_policies[ $identifier ]);
+	}
 
 
-    /**
-     * Adds our privacy policy generators registered by add-ons
-     *
-     * @param string[] $privacy_policies
-     * @return string[]
-     */
-    public static function addPrivacyPolicies(array $privacy_policies)
-    {
-        foreach (self::$privacy_policies as $privacy_policies_per_addon) {
-            $privacy_policies = array_merge(
-                $privacy_policies,
-                $privacy_policies_per_addon
-            );
-        }
-        return $privacy_policies;
-    }
+	/**
+	 * Adds our privacy policy generators registered by add-ons
+	 *
+	 * @param string[] $privacy_policies
+	 * @return string[]
+	 */
+	public static function addPrivacyPolicies(array $privacy_policies)
+	{
+		foreach (self::$privacy_policies as $privacy_policies_per_addon) {
+			$privacy_policies = array_merge(
+				$privacy_policies,
+				$privacy_policies_per_addon
+			);
+		}
+		return $privacy_policies;
+	}
 }
 // End of file EE_Register_Privacy_Policy.lib.php
 // Location: ${NAMESPACE}/EE_Register_Privacy_Policy.lib.php

core/services/progress_steps/ProgressStepManager.php

Spacing +9 added lines, -9 removed lines

@@ -75,11 +75,11 @@ 
         $this->setDisplayStrategy($display_strategy_name);
         $this->setDefaultStep($default_step);
         $this->setFormStepUrlKey($form_step_url_key);
-        if (! $collection instanceof CollectionInterface) {
+        if ( ! $collection instanceof CollectionInterface) {
             $collection = new Collection('\EventEspresso\core\services\progress_steps\ProgressStepInterface');
         }
         $this->collection = $collection;
-        if (! $request instanceof RequestInterface) {
+        if ( ! $request instanceof RequestInterface) {
             /** @var RequestInterface $request */
             $request = LoaderFactory::getLoader()->getShared('EventEspresso\core\services\request\Request');
         }
@@ -94,23 +94,23 @@ 
      */
     protected function setDisplayStrategy($display_strategy_name = 'number_bubbles')
     {
-        if (! is_string($display_strategy_name)) {
+        if ( ! is_string($display_strategy_name)) {
             throw new InvalidDataTypeException('$display_strategy_name', $display_strategy_name, 'string');
         }
         // build up FQCN from incoming display strategy folder name
         $display_strategy_class = 'EventEspresso\core\services\progress_steps\display_strategies\\';
-        $display_strategy_class .= $display_strategy_name . '\\';
+        $display_strategy_class .= $display_strategy_name.'\\';
         $display_strategy_class .= str_replace(' ', '', ucwords(str_replace('_', ' ', $display_strategy_name)));
         $display_strategy_class .= 'ProgressStepsDisplay';
         $display_strategy_class = apply_filters(
             'FHEE__ProgressStepManager__setDisplayStrategy__display_strategy_class',
             $display_strategy_class
         );
-        if (! class_exists($display_strategy_class)) {
+        if ( ! class_exists($display_strategy_class)) {
             throw new InvalidClassException($display_strategy_class);
         }
         $display_strategy = new $display_strategy_class();
-        if (! $display_strategy instanceof ProgressStepsDisplayInterface) {
+        if ( ! $display_strategy instanceof ProgressStepsDisplayInterface) {
             throw new InvalidClassException(
                 $display_strategy_class,
                 sprintf(
@@ -130,7 +130,7 @@ 
      */
     public function setDefaultStep($default_step)
     {
-        if (! is_string($default_step)) {
+        if ( ! is_string($default_step)) {
             throw new InvalidDataTypeException('$default_step', $default_step, 'string');
         }
         $this->default_step = $default_step;
@@ -143,7 +143,7 @@ 
      */
     public function setFormStepUrlKey($form_step_url_key = 'ee-form-step')
     {
-        if (! is_string($form_step_url_key)) {
+        if ( ! is_string($form_step_url_key)) {
             throw new InvalidDataTypeException('$form_step_key', $form_step_url_key, 'string');
         }
         $this->form_step_url_key = ! empty($form_step_url_key) ? $form_step_url_key : 'ee-form-step';
@@ -163,7 +163,7 @@ 
         // grab the step previously known as current, in case we need to revert
         $current_current_step = $this->collection->current();
         // verify that requested step exists
-        if (! $this->collection->has($step)) {
+        if ( ! $this->collection->has($step)) {
             throw new InvalidIdentifierException($step, $this->default_step);
         }
         if ($this->collection->setCurrent($step)) {

Indentation +221 added lines, -221 removed lines

@@ -26,225 +26,225 @@
  */
 class ProgressStepManager
 {
-    /**
-     * @var ProgressStepInterface[]
-     */
-    private $collection;
-
-    /**
-     * @var string
-     */
-    private $default_step;
-
-    /**
-     * the key used for the URL param that denotes the current form step
-     * defaults to 'ee-form-step'
-     *
-     * @var string
-     */
-    private $form_step_url_key = '';
-
-    /**
-     * @var ProgressStepsDisplayInterface
-     */
-    private $display_strategy;
-
-    /**
-     * @var RequestInterface
-     */
-    private $request;
-
-
-    /**
-     * ProgressStepManager constructor
-     *
-     * @param string              $display_strategy_name
-     * @param string              $default_step
-     * @param string              $form_step_url_key
-     * @param CollectionInterface $collection
-     * @param RequestInterface    $request
-     */
-    public function __construct(
-        $display_strategy_name = 'number_bubbles',
-        $default_step = '',
-        $form_step_url_key = '',
-        CollectionInterface $collection = null,
-        RequestInterface $request = null
-    ) {
-        $this->setDisplayStrategy($display_strategy_name);
-        $this->setDefaultStep($default_step);
-        $this->setFormStepUrlKey($form_step_url_key);
-        if (! $collection instanceof CollectionInterface) {
-            $collection = new Collection('\EventEspresso\core\services\progress_steps\ProgressStepInterface');
-        }
-        $this->collection = $collection;
-        if (! $request instanceof RequestInterface) {
-            /** @var RequestInterface $request */
-            $request = LoaderFactory::getLoader()->getShared('EventEspresso\core\services\request\Request');
-        }
-        $this->request = $request;
-    }
-
-
-    /**
-     * @param string $display_strategy_name
-     * @throws InvalidDataTypeException
-     * @throws InvalidClassException
-     */
-    protected function setDisplayStrategy($display_strategy_name = 'number_bubbles')
-    {
-        if (! is_string($display_strategy_name)) {
-            throw new InvalidDataTypeException('$display_strategy_name', $display_strategy_name, 'string');
-        }
-        // build up FQCN from incoming display strategy folder name
-        $display_strategy_class = 'EventEspresso\core\services\progress_steps\display_strategies\\';
-        $display_strategy_class .= $display_strategy_name . '\\';
-        $display_strategy_class .= str_replace(' ', '', ucwords(str_replace('_', ' ', $display_strategy_name)));
-        $display_strategy_class .= 'ProgressStepsDisplay';
-        $display_strategy_class = apply_filters(
-            'FHEE__ProgressStepManager__setDisplayStrategy__display_strategy_class',
-            $display_strategy_class
-        );
-        if (! class_exists($display_strategy_class)) {
-            throw new InvalidClassException($display_strategy_class);
-        }
-        $display_strategy = new $display_strategy_class();
-        if (! $display_strategy instanceof ProgressStepsDisplayInterface) {
-            throw new InvalidClassException(
-                $display_strategy_class,
-                sprintf(
-                    esc_html__('The "%1$s" Class needs to be an implementation of the "%1$s" Interface.', 'event_espresso'),
-                    $display_strategy_class,
-                    '\EventEspresso\core\services\progress_steps\display_strategies\ProgressStepsDisplayInterface'
-                )
-            );
-        }
-        $this->display_strategy = $display_strategy;
-    }
-
-
-    /**
-     * @param string $default_step
-     * @throws InvalidDataTypeException
-     */
-    public function setDefaultStep($default_step)
-    {
-        if (! is_string($default_step)) {
-            throw new InvalidDataTypeException('$default_step', $default_step, 'string');
-        }
-        $this->default_step = $default_step;
-    }
-
-
-    /**
-     * @param string $form_step_url_key
-     * @throws InvalidDataTypeException
-     */
-    public function setFormStepUrlKey($form_step_url_key = 'ee-form-step')
-    {
-        if (! is_string($form_step_url_key)) {
-            throw new InvalidDataTypeException('$form_step_key', $form_step_url_key, 'string');
-        }
-        $this->form_step_url_key = ! empty($form_step_url_key) ? $form_step_url_key : 'ee-form-step';
-    }
-
-
-    /**
-     * @param string $step
-     * @throws InvalidIdentifierException
-     */
-    public function setCurrentStep($step = '')
-    {
-        // use incoming value if it's set, otherwise use request param if it's set, otherwise use default
-        $step = ! empty($step)
-            ? $step
-            : $this->request->getRequestParam($this->form_step_url_key, $this->default_step);
-        // grab the step previously known as current, in case we need to revert
-        $current_current_step = $this->collection->current();
-        // verify that requested step exists
-        if (! $this->collection->has($step)) {
-            throw new InvalidIdentifierException($step, $this->default_step);
-        }
-        if ($this->collection->setCurrent($step)) {
-            // if the old boss is the same as the new boss, then nothing changes
-            if ($this->collection->current() !== $current_current_step) {
-                $current_current_step->setIsCurrent(false);
-            }
-            $this->collection->current()->setIsCurrent();
-        } else {
-            $this->collection->setCurrent($current_current_step->id());
-            $current_current_step->setIsCurrent(true);
-        }
-    }
-
-
-    /**
-     * setPreviousStepsCompleted
-     */
-    public function setPreviousStepsCompleted()
-    {
-        $current_current_step = $this->collection->current();
-        $this->collection->rewind();
-        while ($this->collection->valid()) {
-            if ($this->collection->current() === $current_current_step) {
-                break;
-            }
-            $this->setCurrentStepCompleted();
-            $this->collection->next();
-        }
-        $this->collection->setCurrentUsingObject($current_current_step);
-        return false;
-    }
-
-
-    /**
-     * @return ProgressStepInterface
-     */
-    public function currentStep()
-    {
-        return $this->collection->current();
-    }
-
-
-    /**
-     * @return ProgressStepInterface
-     */
-    public function nextStep()
-    {
-        return $this->collection->next();
-    }
-
-
-    /**
-     * @return void
-     */
-    public function enqueueStylesAndScripts()
-    {
-        $this->display_strategy->enqueueStylesAndScripts();
-    }
-
-
-    /**
-     * echos out HTML
-     *
-     * @return string
-     */
-    public function displaySteps()
-    {
-        return EEH_Template::display_template(
-            $this->display_strategy->getTemplate(),
-            array('progress_steps' => $this->collection),
-            true
-        );
-    }
-
-
-    /**
-     * @param bool $completed
-     * @return ProgressStepInterface
-     */
-    public function setCurrentStepCompleted($completed = true)
-    {
-        return $this->collection->current()->setIsCompleted($completed);
-    }
+	/**
+	 * @var ProgressStepInterface[]
+	 */
+	private $collection;
+
+	/**
+	 * @var string
+	 */
+	private $default_step;
+
+	/**
+	 * the key used for the URL param that denotes the current form step
+	 * defaults to 'ee-form-step'
+	 *
+	 * @var string
+	 */
+	private $form_step_url_key = '';
+
+	/**
+	 * @var ProgressStepsDisplayInterface
+	 */
+	private $display_strategy;
+
+	/**
+	 * @var RequestInterface
+	 */
+	private $request;
+
+
+	/**
+	 * ProgressStepManager constructor
+	 *
+	 * @param string              $display_strategy_name
+	 * @param string              $default_step
+	 * @param string              $form_step_url_key
+	 * @param CollectionInterface $collection
+	 * @param RequestInterface    $request
+	 */
+	public function __construct(
+		$display_strategy_name = 'number_bubbles',
+		$default_step = '',
+		$form_step_url_key = '',
+		CollectionInterface $collection = null,
+		RequestInterface $request = null
+	) {
+		$this->setDisplayStrategy($display_strategy_name);
+		$this->setDefaultStep($default_step);
+		$this->setFormStepUrlKey($form_step_url_key);
+		if (! $collection instanceof CollectionInterface) {
+			$collection = new Collection('\EventEspresso\core\services\progress_steps\ProgressStepInterface');
+		}
+		$this->collection = $collection;
+		if (! $request instanceof RequestInterface) {
+			/** @var RequestInterface $request */
+			$request = LoaderFactory::getLoader()->getShared('EventEspresso\core\services\request\Request');
+		}
+		$this->request = $request;
+	}
+
+
+	/**
+	 * @param string $display_strategy_name
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidClassException
+	 */
+	protected function setDisplayStrategy($display_strategy_name = 'number_bubbles')
+	{
+		if (! is_string($display_strategy_name)) {
+			throw new InvalidDataTypeException('$display_strategy_name', $display_strategy_name, 'string');
+		}
+		// build up FQCN from incoming display strategy folder name
+		$display_strategy_class = 'EventEspresso\core\services\progress_steps\display_strategies\\';
+		$display_strategy_class .= $display_strategy_name . '\\';
+		$display_strategy_class .= str_replace(' ', '', ucwords(str_replace('_', ' ', $display_strategy_name)));
+		$display_strategy_class .= 'ProgressStepsDisplay';
+		$display_strategy_class = apply_filters(
+			'FHEE__ProgressStepManager__setDisplayStrategy__display_strategy_class',
+			$display_strategy_class
+		);
+		if (! class_exists($display_strategy_class)) {
+			throw new InvalidClassException($display_strategy_class);
+		}
+		$display_strategy = new $display_strategy_class();
+		if (! $display_strategy instanceof ProgressStepsDisplayInterface) {
+			throw new InvalidClassException(
+				$display_strategy_class,
+				sprintf(
+					esc_html__('The "%1$s" Class needs to be an implementation of the "%1$s" Interface.', 'event_espresso'),
+					$display_strategy_class,
+					'\EventEspresso\core\services\progress_steps\display_strategies\ProgressStepsDisplayInterface'
+				)
+			);
+		}
+		$this->display_strategy = $display_strategy;
+	}
+
+
+	/**
+	 * @param string $default_step
+	 * @throws InvalidDataTypeException
+	 */
+	public function setDefaultStep($default_step)
+	{
+		if (! is_string($default_step)) {
+			throw new InvalidDataTypeException('$default_step', $default_step, 'string');
+		}
+		$this->default_step = $default_step;
+	}
+
+
+	/**
+	 * @param string $form_step_url_key
+	 * @throws InvalidDataTypeException
+	 */
+	public function setFormStepUrlKey($form_step_url_key = 'ee-form-step')
+	{
+		if (! is_string($form_step_url_key)) {
+			throw new InvalidDataTypeException('$form_step_key', $form_step_url_key, 'string');
+		}
+		$this->form_step_url_key = ! empty($form_step_url_key) ? $form_step_url_key : 'ee-form-step';
+	}
+
+
+	/**
+	 * @param string $step
+	 * @throws InvalidIdentifierException
+	 */
+	public function setCurrentStep($step = '')
+	{
+		// use incoming value if it's set, otherwise use request param if it's set, otherwise use default
+		$step = ! empty($step)
+			? $step
+			: $this->request->getRequestParam($this->form_step_url_key, $this->default_step);
+		// grab the step previously known as current, in case we need to revert
+		$current_current_step = $this->collection->current();
+		// verify that requested step exists
+		if (! $this->collection->has($step)) {
+			throw new InvalidIdentifierException($step, $this->default_step);
+		}
+		if ($this->collection->setCurrent($step)) {
+			// if the old boss is the same as the new boss, then nothing changes
+			if ($this->collection->current() !== $current_current_step) {
+				$current_current_step->setIsCurrent(false);
+			}
+			$this->collection->current()->setIsCurrent();
+		} else {
+			$this->collection->setCurrent($current_current_step->id());
+			$current_current_step->setIsCurrent(true);
+		}
+	}
+
+
+	/**
+	 * setPreviousStepsCompleted
+	 */
+	public function setPreviousStepsCompleted()
+	{
+		$current_current_step = $this->collection->current();
+		$this->collection->rewind();
+		while ($this->collection->valid()) {
+			if ($this->collection->current() === $current_current_step) {
+				break;
+			}
+			$this->setCurrentStepCompleted();
+			$this->collection->next();
+		}
+		$this->collection->setCurrentUsingObject($current_current_step);
+		return false;
+	}
+
+
+	/**
+	 * @return ProgressStepInterface
+	 */
+	public function currentStep()
+	{
+		return $this->collection->current();
+	}
+
+
+	/**
+	 * @return ProgressStepInterface
+	 */
+	public function nextStep()
+	{
+		return $this->collection->next();
+	}
+
+
+	/**
+	 * @return void
+	 */
+	public function enqueueStylesAndScripts()
+	{
+		$this->display_strategy->enqueueStylesAndScripts();
+	}
+
+
+	/**
+	 * echos out HTML
+	 *
+	 * @return string
+	 */
+	public function displaySteps()
+	{
+		return EEH_Template::display_template(
+			$this->display_strategy->getTemplate(),
+			array('progress_steps' => $this->collection),
+			true
+		);
+	}
+
+
+	/**
+	 * @param bool $completed
+	 * @return ProgressStepInterface
+	 */
+	public function setCurrentStepCompleted($completed = true)
+	{
+		return $this->collection->current()->setIsCompleted($completed);
+	}
 }

core/libraries/form_sections/form_handlers/SequentialStepFormManager.php

Spacing +12 added lines, -12 removed lines

@@ -140,7 +140,7 @@ 
      */
     protected function setBaseUrl($base_url)
     {
-        if (! is_string($base_url)) {
+        if ( ! is_string($base_url)) {
             throw new InvalidDataTypeException('$base_url', $base_url, 'string');
         }
         if (empty($base_url)) {
@@ -171,7 +171,7 @@ 
      */
     public function setFormStepUrlKey($form_step_url_key = 'ee-form-step')
     {
-        if (! is_string($form_step_url_key)) {
+        if ( ! is_string($form_step_url_key)) {
             throw new InvalidDataTypeException('$form_step_key', $form_step_url_key, 'string');
         }
         $this->form_step_url_key = ! empty($form_step_url_key) ? $form_step_url_key : 'ee-form-step';
@@ -193,7 +193,7 @@ 
      */
     protected function setDefaultFormStep($default_form_step)
     {
-        if (! is_string($default_form_step)) {
+        if ( ! is_string($default_form_step)) {
             throw new InvalidDataTypeException('$default_form_step', $default_form_step, 'string');
         }
         $this->default_form_step = $default_form_step;
@@ -208,7 +208,7 @@ 
     protected function setCurrentStepFromRequest()
     {
         $current_step_slug = $this->request()->getRequestParam($this->formStepUrlKey(), $this->defaultFormStep());
-        if (! $this->form_steps->setCurrent($current_step_slug)) {
+        if ( ! $this->form_steps->setCurrent($current_step_slug)) {
             throw new InvalidIdentifierException(
                 $current_step_slug,
                 $this->defaultFormStep(),
@@ -227,7 +227,7 @@ 
      */
     public function getCurrentStep()
     {
-        if (! $this->form_steps->current() instanceof SequentialStepForm) {
+        if ( ! $this->form_steps->current() instanceof SequentialStepForm) {
             throw new InvalidFormHandlerException($this->form_steps->current());
         }
         return $this->form_steps->current();
@@ -240,7 +240,7 @@ 
      */
     public function formAction()
     {
-        if (! is_string($this->form_action) || empty($this->form_action)) {
+        if ( ! is_string($this->form_action) || empty($this->form_action)) {
             $this->form_action = $this->baseUrl();
         }
         return $this->form_action;
@@ -253,7 +253,7 @@ 
      */
     public function setFormAction($form_action)
     {
-        if (! is_string($form_action)) {
+        if ( ! is_string($form_action)) {
             throw new InvalidDataTypeException('$form_action', $form_action, 'string');
         }
         $this->form_action = $form_action;
@@ -267,7 +267,7 @@ 
      */
     public function addFormActionArgs($form_action_args = array())
     {
-        if (! is_array($form_action_args)) {
+        if ( ! is_array($form_action_args)) {
             throw new InvalidDataTypeException('$form_action_args', $form_action_args, 'array');
         }
         $form_action_args = ! empty($form_action_args)
@@ -332,7 +332,7 @@ 
     protected function getProgressStepsCollection()
     {
         static $collection = null;
-        if (! $collection instanceof ProgressStepCollection) {
+        if ( ! $collection instanceof ProgressStepCollection) {
             $collection = new ProgressStepCollection();
         }
         return $collection;
@@ -354,7 +354,7 @@ 
         /** @var SequentialStepForm $form_step */
         foreach ($this->form_steps as $form_step) {
             // is this step active ?
-            if (! $form_step->initialize()) {
+            if ( ! $form_step->initialize()) {
                 continue;
             }
             $progress_steps_collection->add(
@@ -423,7 +423,7 @@ 
     {
         $form_step = $this->buildCurrentStepForm();
         // no displayable content ? then skip straight to processing
-        if (! $form_step->displayable()) {
+        if ( ! $form_step->displayable()) {
             $this->addFormActionArgs();
             $form_step->setFormAction($this->formAction());
             wp_safe_redirect($form_step->formAction());
@@ -499,7 +499,7 @@ 
     public function displayProgressSteps($return_as_string = true)
     {
         $form_step = $this->getCurrentStep();
-        if (! $form_step->displayable()) {
+        if ( ! $form_step->displayable()) {
             return '';
         }
         $progress_steps = apply_filters(

Indentation +579 added lines, -579 removed lines

@@ -30,583 +30,583 @@
  */
 abstract class SequentialStepFormManager
 {
-    /**
-     * a simplified URL with no form related parameters
-     * that will be used to build the form's redirect URLs
-     *
-     * @var string $base_url
-     */
-    private $base_url = '';
-
-    /**
-     * the key used for the URL param that denotes the current form step
-     * defaults to 'ee-form-step'
-     *
-     * @var string $form_step_url_key
-     */
-    private $form_step_url_key = '';
-
-    /**
-     * @var string $default_form_step
-     */
-    private $default_form_step = '';
-
-    /**
-     * @var string $form_action
-     */
-    private $form_action;
-
-    /**
-     * value of one of the string constant above
-     *
-     * @var string $form_config
-     */
-    private $form_config;
-
-    /**
-     * @var string $progress_step_style
-     */
-    private $progress_step_style = '';
-
-    /**
-     * @var RequestInterface $request
-     */
-    private $request;
-
-    /**
-     * @var Collection $form_steps
-     */
-    protected $form_steps;
-
-    /**
-     * @var ProgressStepManager $progress_step_manager
-     */
-    protected $progress_step_manager;
-
-
-    /**
-     * @return Collection|null
-     */
-    abstract protected function getFormStepsCollection();
-
-    // phpcs:disable PEAR.Functions.ValidDefaultValue.NotAtEnd
-    /**
-     * StepsManager constructor
-     *
-     * @param string                           $base_url
-     * @param string                           $default_form_step
-     * @param string                           $form_action
-     * @param string                           $form_config
-     * @param EE_Request|RequestInterface|null $request
-     * @param string                           $progress_step_style
-     * @throws InvalidDataTypeException
-     * @throws InvalidArgumentException
-     */
-    public function __construct(
-        $base_url,
-        $default_form_step,
-        $form_action = '',
-        $form_config = FormHandler::ADD_FORM_TAGS_AND_SUBMIT,
-        $progress_step_style = 'number_bubbles',
-        $request = null
-    ) {
-        $this->setBaseUrl($base_url);
-        $this->setDefaultFormStep($default_form_step);
-        $this->setFormAction($form_action);
-        $this->setFormConfig($form_config);
-        $this->setProgressStepStyle($progress_step_style);
-        $this->request = $request instanceof RequestInterface
-            ? $request
-            : LoaderFactory::getLoader()->getShared('EventEspresso\core\services\request\RequestInterface');
-    }
-
-
-    /**
-     * @return string
-     * @throws InvalidFormHandlerException
-     */
-    public function baseUrl()
-    {
-        if (strpos($this->base_url, $this->getCurrentStep()->slug()) === false) {
-            add_query_arg(
-                array($this->form_step_url_key => $this->getCurrentStep()->slug()),
-                $this->base_url
-            );
-        }
-        return $this->base_url;
-    }
-
-
-    /**
-     * @param string $base_url
-     * @throws InvalidDataTypeException
-     * @throws InvalidArgumentException
-     */
-    protected function setBaseUrl($base_url)
-    {
-        if (! is_string($base_url)) {
-            throw new InvalidDataTypeException('$base_url', $base_url, 'string');
-        }
-        if (empty($base_url)) {
-            throw new InvalidArgumentException(
-                esc_html__('The base URL can not be an empty string.', 'event_espresso')
-            );
-        }
-        $this->base_url = $base_url;
-    }
-
-
-    /**
-     * @return string
-     * @throws InvalidDataTypeException
-     */
-    public function formStepUrlKey()
-    {
-        if (empty($this->form_step_url_key)) {
-            $this->setFormStepUrlKey();
-        }
-        return $this->form_step_url_key;
-    }
-
-
-    /**
-     * @param string $form_step_url_key
-     * @throws InvalidDataTypeException
-     */
-    public function setFormStepUrlKey($form_step_url_key = 'ee-form-step')
-    {
-        if (! is_string($form_step_url_key)) {
-            throw new InvalidDataTypeException('$form_step_key', $form_step_url_key, 'string');
-        }
-        $this->form_step_url_key = ! empty($form_step_url_key) ? $form_step_url_key : 'ee-form-step';
-    }
-
-
-    /**
-     * @return string
-     */
-    public function defaultFormStep()
-    {
-        return $this->default_form_step;
-    }
-
-
-    /**
-     * @param $default_form_step
-     * @throws InvalidDataTypeException
-     */
-    protected function setDefaultFormStep($default_form_step)
-    {
-        if (! is_string($default_form_step)) {
-            throw new InvalidDataTypeException('$default_form_step', $default_form_step, 'string');
-        }
-        $this->default_form_step = $default_form_step;
-    }
-
-
-    /**
-     * @return void
-     * @throws InvalidIdentifierException
-     * @throws InvalidDataTypeException
-     */
-    protected function setCurrentStepFromRequest()
-    {
-        $current_step_slug = $this->request()->getRequestParam($this->formStepUrlKey(), $this->defaultFormStep());
-        if (! $this->form_steps->setCurrent($current_step_slug)) {
-            throw new InvalidIdentifierException(
-                $current_step_slug,
-                $this->defaultFormStep(),
-                sprintf(
-                    esc_html__('The "%1$s" form step could not be set.', 'event_espresso'),
-                    $current_step_slug
-                )
-            );
-        }
-    }
-
-
-    /**
-     * @return SequentialStepFormInterface|object
-     * @throws InvalidFormHandlerException
-     */
-    public function getCurrentStep()
-    {
-        if (! $this->form_steps->current() instanceof SequentialStepForm) {
-            throw new InvalidFormHandlerException($this->form_steps->current());
-        }
-        return $this->form_steps->current();
-    }
-
-
-    /**
-     * @return string
-     * @throws InvalidFormHandlerException
-     */
-    public function formAction()
-    {
-        if (! is_string($this->form_action) || empty($this->form_action)) {
-            $this->form_action = $this->baseUrl();
-        }
-        return $this->form_action;
-    }
-
-
-    /**
-     * @param string $form_action
-     * @throws InvalidDataTypeException
-     */
-    public function setFormAction($form_action)
-    {
-        if (! is_string($form_action)) {
-            throw new InvalidDataTypeException('$form_action', $form_action, 'string');
-        }
-        $this->form_action = $form_action;
-    }
-
-
-    /**
-     * @param array $form_action_args
-     * @throws InvalidDataTypeException
-     * @throws InvalidFormHandlerException
-     */
-    public function addFormActionArgs($form_action_args = array())
-    {
-        if (! is_array($form_action_args)) {
-            throw new InvalidDataTypeException('$form_action_args', $form_action_args, 'array');
-        }
-        $form_action_args = ! empty($form_action_args)
-            ? $form_action_args
-            : array($this->formStepUrlKey() => $this->form_steps->current()->slug());
-        $this->getCurrentStep()->setFormAction(
-            add_query_arg($form_action_args, $this->formAction())
-        );
-        $this->form_action = $this->getCurrentStep()->formAction();
-    }
-
-
-    /**
-     * @return string
-     */
-    public function formConfig()
-    {
-        return $this->form_config;
-    }
-
-
-    /**
-     * @param string $form_config
-     */
-    public function setFormConfig($form_config)
-    {
-        $this->form_config = $form_config;
-    }
-
-
-    /**
-     * @return string
-     */
-    public function progressStepStyle()
-    {
-        return $this->progress_step_style;
-    }
-
-
-    /**
-     * @param string $progress_step_style
-     */
-    public function setProgressStepStyle($progress_step_style)
-    {
-        $this->progress_step_style = $progress_step_style;
-    }
-
-
-    /**
-     * @return RequestInterface
-     */
-    public function request()
-    {
-        return $this->request;
-    }
-
-
-    /**
-     * @return Collection|null
-     * @throws InvalidInterfaceException
-     */
-    protected function getProgressStepsCollection()
-    {
-        static $collection = null;
-        if (! $collection instanceof ProgressStepCollection) {
-            $collection = new ProgressStepCollection();
-        }
-        return $collection;
-    }
-
-
-    /**
-     * @param Collection $progress_steps_collection
-     * @return ProgressStepManager
-     * @throws InvalidInterfaceException
-     * @throws InvalidClassException
-     * @throws InvalidDataTypeException
-     * @throws InvalidEntityException
-     * @throws InvalidFormHandlerException
-     */
-    protected function generateProgressSteps(Collection $progress_steps_collection)
-    {
-        $current_step = $this->getCurrentStep();
-        /** @var SequentialStepForm $form_step */
-        foreach ($this->form_steps as $form_step) {
-            // is this step active ?
-            if (! $form_step->initialize()) {
-                continue;
-            }
-            $progress_steps_collection->add(
-                new ProgressStep(
-                    $form_step->order(),
-                    $form_step->slug(),
-                    $form_step->slug(),
-                    $form_step->formName()
-                ),
-                $form_step->slug()
-            );
-        }
-        // set collection pointer back to current step
-        $this->form_steps->setCurrentUsingObject($current_step);
-        return new ProgressStepManager(
-            $this->progressStepStyle(),
-            $this->defaultFormStep(),
-            $this->formStepUrlKey(),
-            $progress_steps_collection
-        );
-    }
-
-
-    /**
-     * @throws InvalidClassException
-     * @throws InvalidDataTypeException
-     * @throws InvalidEntityException
-     * @throws InvalidIdentifierException
-     * @throws InvalidInterfaceException
-     * @throws InvalidArgumentException
-     * @throws InvalidFormHandlerException
-     */
-    public function buildForm()
-    {
-        $this->buildCurrentStepFormForDisplay();
-    }
-
-
-    /**
-     * @param array $form_data
-     * @throws InvalidArgumentException
-     * @throws InvalidClassException
-     * @throws InvalidDataTypeException
-     * @throws InvalidEntityException
-     * @throws InvalidFormHandlerException
-     * @throws InvalidIdentifierException
-     * @throws InvalidInterfaceException
-     */
-    public function processForm($form_data = array())
-    {
-        $this->buildCurrentStepFormForProcessing();
-        $this->processCurrentStepForm($form_data);
-    }
-
-
-    /**
-     * @throws InvalidClassException
-     * @throws InvalidDataTypeException
-     * @throws InvalidEntityException
-     * @throws InvalidInterfaceException
-     * @throws InvalidIdentifierException
-     * @throws InvalidArgumentException
-     * @throws InvalidFormHandlerException
-     */
-    public function buildCurrentStepFormForDisplay()
-    {
-        $form_step = $this->buildCurrentStepForm();
-        // no displayable content ? then skip straight to processing
-        if (! $form_step->displayable()) {
-            $this->addFormActionArgs();
-            $form_step->setFormAction($this->formAction());
-            wp_safe_redirect($form_step->formAction());
-        }
-    }
-
-
-    /**
-     * @throws InvalidClassException
-     * @throws InvalidDataTypeException
-     * @throws InvalidEntityException
-     * @throws InvalidInterfaceException
-     * @throws InvalidIdentifierException
-     * @throws InvalidArgumentException
-     * @throws InvalidFormHandlerException
-     */
-    public function buildCurrentStepFormForProcessing()
-    {
-        $this->buildCurrentStepForm(false);
-    }
-
-
-    /**
-     * @param bool $for_display
-     * @return SequentialStepFormInterface
-     * @throws InvalidArgumentException
-     * @throws InvalidClassException
-     * @throws InvalidDataTypeException
-     * @throws InvalidEntityException
-     * @throws InvalidFormHandlerException
-     * @throws InvalidIdentifierException
-     * @throws InvalidInterfaceException
-     */
-    private function buildCurrentStepForm($for_display = true)
-    {
-        $this->form_steps = $this->getFormStepsCollection();
-        $this->setCurrentStepFromRequest();
-        $form_step = $this->getCurrentStep();
-        if ($form_step->submitBtnText() === esc_html__('Submit', 'event_espresso')) {
-            $form_step->setSubmitBtnText(esc_html__('Next Step', 'event_espresso'));
-        }
-        if ($for_display && $form_step->displayable()) {
-            $this->progress_step_manager = $this->generateProgressSteps(
-                $this->getProgressStepsCollection()
-            );
-            $this->progress_step_manager->setCurrentStep(
-                $form_step->slug()
-            );
-            // mark all previous progress steps as completed
-            $this->progress_step_manager->setPreviousStepsCompleted();
-            $this->progress_step_manager->enqueueStylesAndScripts();
-            $this->addFormActionArgs();
-            $form_step->setFormAction($this->formAction());
-        } else {
-            $form_step->setRedirectUrl($this->baseUrl());
-            $form_step->addRedirectArgs(
-                array($this->formStepUrlKey() => $this->form_steps->current()->slug())
-            );
-        }
-        $form_step->generate();
-        if ($for_display) {
-            $form_step->enqueueStylesAndScripts();
-        }
-        return $form_step;
-    }
-
-
-    /**
-     * @param bool $return_as_string
-     * @return string
-     * @throws InvalidFormHandlerException
-     */
-    public function displayProgressSteps($return_as_string = true)
-    {
-        $form_step = $this->getCurrentStep();
-        if (! $form_step->displayable()) {
-            return '';
-        }
-        $progress_steps = apply_filters(
-            'FHEE__EventEspresso_core_libraries_form_sections_form_handlers_SequentialStepFormManager__displayProgressSteps__before_steps',
-            ''
-        );
-        $progress_steps .= $this->progress_step_manager->displaySteps();
-        $progress_steps .= apply_filters(
-            'FHEE__EventEspresso_core_libraries_form_sections_form_handlers_SequentialStepFormManager__displayProgressSteps__after_steps',
-            ''
-        );
-        if ($return_as_string) {
-            return $progress_steps;
-        }
-        echo wp_kses($progress_steps, AllowedTags::getWithFormTags());
-        return '';
-    }
-
-
-    /**
-     * @param bool $return_as_string
-     * @return string
-     * @throws InvalidFormHandlerException
-     */
-    public function displayCurrentStepForm($return_as_string = true)
-    {
-        if ($return_as_string) {
-            return $this->getCurrentStep()->display();
-        }
-        echo wp_kses($this->getCurrentStep()->display(), AllowedTags::getWithFormTags());
-        return '';
-    }
-
-
-    /**
-     * @param array $form_data
-     * @return void
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidFormHandlerException
-     */
-    public function processCurrentStepForm($form_data = array())
-    {
-        // grab instance of current step because after calling next() below,
-        // any calls to getCurrentStep() will return the "next" step because we advanced
-        $current_step = $this->getCurrentStep();
-        try {
-            // form processing should either throw exceptions or return true
-            $current_step->process($form_data);
-        } catch (Exception $e) {
-            // something went wrong, convert the Exception to an EE_Error
-            EE_Error::add_error($e->getMessage(), __FILE__, __FUNCTION__, __LINE__);
-            // prevent redirect to next step or other if exception was thrown
-            if (
-                $current_step->redirectTo() === SequentialStepForm::REDIRECT_TO_NEXT_STEP
-                || $current_step->redirectTo() === SequentialStepForm::REDIRECT_TO_OTHER
-            ) {
-                $current_step->setRedirectTo(SequentialStepForm::REDIRECT_TO_CURRENT_STEP);
-            }
-        }
-        // save notices to a transient so that when we redirect back
-        // to the display portion for this step
-        // those notices can be displayed
-        EE_Error::get_notices(false, true);
-        $this->redirectForm($current_step);
-    }
-
-
-    /**
-     * handles where to go to next
-     *
-     * @param SequentialStepFormInterface $current_step
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidFormHandlerException
-     */
-    public function redirectForm(SequentialStepFormInterface $current_step)
-    {
-        $redirect_step = $current_step;
-        switch ($current_step->redirectTo()) {
-            case SequentialStepForm::REDIRECT_TO_OTHER:
-                // going somewhere else, so just check out now
-                wp_safe_redirect($redirect_step->redirectUrl());
-                exit();
-            case SequentialStepForm::REDIRECT_TO_PREV_STEP:
-                $redirect_step = $this->form_steps->previous();
-                break;
-            case SequentialStepForm::REDIRECT_TO_NEXT_STEP:
-                $this->form_steps->next();
-                if ($this->form_steps->valid()) {
-                    $redirect_step = $this->form_steps->current();
-                }
-                break;
-            case SequentialStepForm::REDIRECT_TO_CURRENT_STEP:
-            default:
-                // $redirect_step is already set
-        }
-        $current_step->setRedirectUrl($this->baseUrl());
-        $current_step->addRedirectArgs(
-            // use the slug for whatever step we are redirecting too
-            array($this->formStepUrlKey() => $redirect_step->slug())
-        );
-        wp_safe_redirect($current_step->redirectUrl());
-        exit();
-    }
+	/**
+	 * a simplified URL with no form related parameters
+	 * that will be used to build the form's redirect URLs
+	 *
+	 * @var string $base_url
+	 */
+	private $base_url = '';
+
+	/**
+	 * the key used for the URL param that denotes the current form step
+	 * defaults to 'ee-form-step'
+	 *
+	 * @var string $form_step_url_key
+	 */
+	private $form_step_url_key = '';
+
+	/**
+	 * @var string $default_form_step
+	 */
+	private $default_form_step = '';
+
+	/**
+	 * @var string $form_action
+	 */
+	private $form_action;
+
+	/**
+	 * value of one of the string constant above
+	 *
+	 * @var string $form_config
+	 */
+	private $form_config;
+
+	/**
+	 * @var string $progress_step_style
+	 */
+	private $progress_step_style = '';
+
+	/**
+	 * @var RequestInterface $request
+	 */
+	private $request;
+
+	/**
+	 * @var Collection $form_steps
+	 */
+	protected $form_steps;
+
+	/**
+	 * @var ProgressStepManager $progress_step_manager
+	 */
+	protected $progress_step_manager;
+
+
+	/**
+	 * @return Collection|null
+	 */
+	abstract protected function getFormStepsCollection();
+
+	// phpcs:disable PEAR.Functions.ValidDefaultValue.NotAtEnd
+	/**
+	 * StepsManager constructor
+	 *
+	 * @param string                           $base_url
+	 * @param string                           $default_form_step
+	 * @param string                           $form_action
+	 * @param string                           $form_config
+	 * @param EE_Request|RequestInterface|null $request
+	 * @param string                           $progress_step_style
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidArgumentException
+	 */
+	public function __construct(
+		$base_url,
+		$default_form_step,
+		$form_action = '',
+		$form_config = FormHandler::ADD_FORM_TAGS_AND_SUBMIT,
+		$progress_step_style = 'number_bubbles',
+		$request = null
+	) {
+		$this->setBaseUrl($base_url);
+		$this->setDefaultFormStep($default_form_step);
+		$this->setFormAction($form_action);
+		$this->setFormConfig($form_config);
+		$this->setProgressStepStyle($progress_step_style);
+		$this->request = $request instanceof RequestInterface
+			? $request
+			: LoaderFactory::getLoader()->getShared('EventEspresso\core\services\request\RequestInterface');
+	}
+
+
+	/**
+	 * @return string
+	 * @throws InvalidFormHandlerException
+	 */
+	public function baseUrl()
+	{
+		if (strpos($this->base_url, $this->getCurrentStep()->slug()) === false) {
+			add_query_arg(
+				array($this->form_step_url_key => $this->getCurrentStep()->slug()),
+				$this->base_url
+			);
+		}
+		return $this->base_url;
+	}
+
+
+	/**
+	 * @param string $base_url
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidArgumentException
+	 */
+	protected function setBaseUrl($base_url)
+	{
+		if (! is_string($base_url)) {
+			throw new InvalidDataTypeException('$base_url', $base_url, 'string');
+		}
+		if (empty($base_url)) {
+			throw new InvalidArgumentException(
+				esc_html__('The base URL can not be an empty string.', 'event_espresso')
+			);
+		}
+		$this->base_url = $base_url;
+	}
+
+
+	/**
+	 * @return string
+	 * @throws InvalidDataTypeException
+	 */
+	public function formStepUrlKey()
+	{
+		if (empty($this->form_step_url_key)) {
+			$this->setFormStepUrlKey();
+		}
+		return $this->form_step_url_key;
+	}
+
+
+	/**
+	 * @param string $form_step_url_key
+	 * @throws InvalidDataTypeException
+	 */
+	public function setFormStepUrlKey($form_step_url_key = 'ee-form-step')
+	{
+		if (! is_string($form_step_url_key)) {
+			throw new InvalidDataTypeException('$form_step_key', $form_step_url_key, 'string');
+		}
+		$this->form_step_url_key = ! empty($form_step_url_key) ? $form_step_url_key : 'ee-form-step';
+	}
+
+
+	/**
+	 * @return string
+	 */
+	public function defaultFormStep()
+	{
+		return $this->default_form_step;
+	}
+
+
+	/**
+	 * @param $default_form_step
+	 * @throws InvalidDataTypeException
+	 */
+	protected function setDefaultFormStep($default_form_step)
+	{
+		if (! is_string($default_form_step)) {
+			throw new InvalidDataTypeException('$default_form_step', $default_form_step, 'string');
+		}
+		$this->default_form_step = $default_form_step;
+	}
+
+
+	/**
+	 * @return void
+	 * @throws InvalidIdentifierException
+	 * @throws InvalidDataTypeException
+	 */
+	protected function setCurrentStepFromRequest()
+	{
+		$current_step_slug = $this->request()->getRequestParam($this->formStepUrlKey(), $this->defaultFormStep());
+		if (! $this->form_steps->setCurrent($current_step_slug)) {
+			throw new InvalidIdentifierException(
+				$current_step_slug,
+				$this->defaultFormStep(),
+				sprintf(
+					esc_html__('The "%1$s" form step could not be set.', 'event_espresso'),
+					$current_step_slug
+				)
+			);
+		}
+	}
+
+
+	/**
+	 * @return SequentialStepFormInterface|object
+	 * @throws InvalidFormHandlerException
+	 */
+	public function getCurrentStep()
+	{
+		if (! $this->form_steps->current() instanceof SequentialStepForm) {
+			throw new InvalidFormHandlerException($this->form_steps->current());
+		}
+		return $this->form_steps->current();
+	}
+
+
+	/**
+	 * @return string
+	 * @throws InvalidFormHandlerException
+	 */
+	public function formAction()
+	{
+		if (! is_string($this->form_action) || empty($this->form_action)) {
+			$this->form_action = $this->baseUrl();
+		}
+		return $this->form_action;
+	}
+
+
+	/**
+	 * @param string $form_action
+	 * @throws InvalidDataTypeException
+	 */
+	public function setFormAction($form_action)
+	{
+		if (! is_string($form_action)) {
+			throw new InvalidDataTypeException('$form_action', $form_action, 'string');
+		}
+		$this->form_action = $form_action;
+	}
+
+
+	/**
+	 * @param array $form_action_args
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidFormHandlerException
+	 */
+	public function addFormActionArgs($form_action_args = array())
+	{
+		if (! is_array($form_action_args)) {
+			throw new InvalidDataTypeException('$form_action_args', $form_action_args, 'array');
+		}
+		$form_action_args = ! empty($form_action_args)
+			? $form_action_args
+			: array($this->formStepUrlKey() => $this->form_steps->current()->slug());
+		$this->getCurrentStep()->setFormAction(
+			add_query_arg($form_action_args, $this->formAction())
+		);
+		$this->form_action = $this->getCurrentStep()->formAction();
+	}
+
+
+	/**
+	 * @return string
+	 */
+	public function formConfig()
+	{
+		return $this->form_config;
+	}
+
+
+	/**
+	 * @param string $form_config
+	 */
+	public function setFormConfig($form_config)
+	{
+		$this->form_config = $form_config;
+	}
+
+
+	/**
+	 * @return string
+	 */
+	public function progressStepStyle()
+	{
+		return $this->progress_step_style;
+	}
+
+
+	/**
+	 * @param string $progress_step_style
+	 */
+	public function setProgressStepStyle($progress_step_style)
+	{
+		$this->progress_step_style = $progress_step_style;
+	}
+
+
+	/**
+	 * @return RequestInterface
+	 */
+	public function request()
+	{
+		return $this->request;
+	}
+
+
+	/**
+	 * @return Collection|null
+	 * @throws InvalidInterfaceException
+	 */
+	protected function getProgressStepsCollection()
+	{
+		static $collection = null;
+		if (! $collection instanceof ProgressStepCollection) {
+			$collection = new ProgressStepCollection();
+		}
+		return $collection;
+	}
+
+
+	/**
+	 * @param Collection $progress_steps_collection
+	 * @return ProgressStepManager
+	 * @throws InvalidInterfaceException
+	 * @throws InvalidClassException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidEntityException
+	 * @throws InvalidFormHandlerException
+	 */
+	protected function generateProgressSteps(Collection $progress_steps_collection)
+	{
+		$current_step = $this->getCurrentStep();
+		/** @var SequentialStepForm $form_step */
+		foreach ($this->form_steps as $form_step) {
+			// is this step active ?
+			if (! $form_step->initialize()) {
+				continue;
+			}
+			$progress_steps_collection->add(
+				new ProgressStep(
+					$form_step->order(),
+					$form_step->slug(),
+					$form_step->slug(),
+					$form_step->formName()
+				),
+				$form_step->slug()
+			);
+		}
+		// set collection pointer back to current step
+		$this->form_steps->setCurrentUsingObject($current_step);
+		return new ProgressStepManager(
+			$this->progressStepStyle(),
+			$this->defaultFormStep(),
+			$this->formStepUrlKey(),
+			$progress_steps_collection
+		);
+	}
+
+
+	/**
+	 * @throws InvalidClassException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidEntityException
+	 * @throws InvalidIdentifierException
+	 * @throws InvalidInterfaceException
+	 * @throws InvalidArgumentException
+	 * @throws InvalidFormHandlerException
+	 */
+	public function buildForm()
+	{
+		$this->buildCurrentStepFormForDisplay();
+	}
+
+
+	/**
+	 * @param array $form_data
+	 * @throws InvalidArgumentException
+	 * @throws InvalidClassException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidEntityException
+	 * @throws InvalidFormHandlerException
+	 * @throws InvalidIdentifierException
+	 * @throws InvalidInterfaceException
+	 */
+	public function processForm($form_data = array())
+	{
+		$this->buildCurrentStepFormForProcessing();
+		$this->processCurrentStepForm($form_data);
+	}
+
+
+	/**
+	 * @throws InvalidClassException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidEntityException
+	 * @throws InvalidInterfaceException
+	 * @throws InvalidIdentifierException
+	 * @throws InvalidArgumentException
+	 * @throws InvalidFormHandlerException
+	 */
+	public function buildCurrentStepFormForDisplay()
+	{
+		$form_step = $this->buildCurrentStepForm();
+		// no displayable content ? then skip straight to processing
+		if (! $form_step->displayable()) {
+			$this->addFormActionArgs();
+			$form_step->setFormAction($this->formAction());
+			wp_safe_redirect($form_step->formAction());
+		}
+	}
+
+
+	/**
+	 * @throws InvalidClassException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidEntityException
+	 * @throws InvalidInterfaceException
+	 * @throws InvalidIdentifierException
+	 * @throws InvalidArgumentException
+	 * @throws InvalidFormHandlerException
+	 */
+	public function buildCurrentStepFormForProcessing()
+	{
+		$this->buildCurrentStepForm(false);
+	}
+
+
+	/**
+	 * @param bool $for_display
+	 * @return SequentialStepFormInterface
+	 * @throws InvalidArgumentException
+	 * @throws InvalidClassException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidEntityException
+	 * @throws InvalidFormHandlerException
+	 * @throws InvalidIdentifierException
+	 * @throws InvalidInterfaceException
+	 */
+	private function buildCurrentStepForm($for_display = true)
+	{
+		$this->form_steps = $this->getFormStepsCollection();
+		$this->setCurrentStepFromRequest();
+		$form_step = $this->getCurrentStep();
+		if ($form_step->submitBtnText() === esc_html__('Submit', 'event_espresso')) {
+			$form_step->setSubmitBtnText(esc_html__('Next Step', 'event_espresso'));
+		}
+		if ($for_display && $form_step->displayable()) {
+			$this->progress_step_manager = $this->generateProgressSteps(
+				$this->getProgressStepsCollection()
+			);
+			$this->progress_step_manager->setCurrentStep(
+				$form_step->slug()
+			);
+			// mark all previous progress steps as completed
+			$this->progress_step_manager->setPreviousStepsCompleted();
+			$this->progress_step_manager->enqueueStylesAndScripts();
+			$this->addFormActionArgs();
+			$form_step->setFormAction($this->formAction());
+		} else {
+			$form_step->setRedirectUrl($this->baseUrl());
+			$form_step->addRedirectArgs(
+				array($this->formStepUrlKey() => $this->form_steps->current()->slug())
+			);
+		}
+		$form_step->generate();
+		if ($for_display) {
+			$form_step->enqueueStylesAndScripts();
+		}
+		return $form_step;
+	}
+
+
+	/**
+	 * @param bool $return_as_string
+	 * @return string
+	 * @throws InvalidFormHandlerException
+	 */
+	public function displayProgressSteps($return_as_string = true)
+	{
+		$form_step = $this->getCurrentStep();
+		if (! $form_step->displayable()) {
+			return '';
+		}
+		$progress_steps = apply_filters(
+			'FHEE__EventEspresso_core_libraries_form_sections_form_handlers_SequentialStepFormManager__displayProgressSteps__before_steps',
+			''
+		);
+		$progress_steps .= $this->progress_step_manager->displaySteps();
+		$progress_steps .= apply_filters(
+			'FHEE__EventEspresso_core_libraries_form_sections_form_handlers_SequentialStepFormManager__displayProgressSteps__after_steps',
+			''
+		);
+		if ($return_as_string) {
+			return $progress_steps;
+		}
+		echo wp_kses($progress_steps, AllowedTags::getWithFormTags());
+		return '';
+	}
+
+
+	/**
+	 * @param bool $return_as_string
+	 * @return string
+	 * @throws InvalidFormHandlerException
+	 */
+	public function displayCurrentStepForm($return_as_string = true)
+	{
+		if ($return_as_string) {
+			return $this->getCurrentStep()->display();
+		}
+		echo wp_kses($this->getCurrentStep()->display(), AllowedTags::getWithFormTags());
+		return '';
+	}
+
+
+	/**
+	 * @param array $form_data
+	 * @return void
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidFormHandlerException
+	 */
+	public function processCurrentStepForm($form_data = array())
+	{
+		// grab instance of current step because after calling next() below,
+		// any calls to getCurrentStep() will return the "next" step because we advanced
+		$current_step = $this->getCurrentStep();
+		try {
+			// form processing should either throw exceptions or return true
+			$current_step->process($form_data);
+		} catch (Exception $e) {
+			// something went wrong, convert the Exception to an EE_Error
+			EE_Error::add_error($e->getMessage(), __FILE__, __FUNCTION__, __LINE__);
+			// prevent redirect to next step or other if exception was thrown
+			if (
+				$current_step->redirectTo() === SequentialStepForm::REDIRECT_TO_NEXT_STEP
+				|| $current_step->redirectTo() === SequentialStepForm::REDIRECT_TO_OTHER
+			) {
+				$current_step->setRedirectTo(SequentialStepForm::REDIRECT_TO_CURRENT_STEP);
+			}
+		}
+		// save notices to a transient so that when we redirect back
+		// to the display portion for this step
+		// those notices can be displayed
+		EE_Error::get_notices(false, true);
+		$this->redirectForm($current_step);
+	}
+
+
+	/**
+	 * handles where to go to next
+	 *
+	 * @param SequentialStepFormInterface $current_step
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidFormHandlerException
+	 */
+	public function redirectForm(SequentialStepFormInterface $current_step)
+	{
+		$redirect_step = $current_step;
+		switch ($current_step->redirectTo()) {
+			case SequentialStepForm::REDIRECT_TO_OTHER:
+				// going somewhere else, so just check out now
+				wp_safe_redirect($redirect_step->redirectUrl());
+				exit();
+			case SequentialStepForm::REDIRECT_TO_PREV_STEP:
+				$redirect_step = $this->form_steps->previous();
+				break;
+			case SequentialStepForm::REDIRECT_TO_NEXT_STEP:
+				$this->form_steps->next();
+				if ($this->form_steps->valid()) {
+					$redirect_step = $this->form_steps->current();
+				}
+				break;
+			case SequentialStepForm::REDIRECT_TO_CURRENT_STEP:
+			default:
+				// $redirect_step is already set
+		}
+		$current_step->setRedirectUrl($this->baseUrl());
+		$current_step->addRedirectArgs(
+			// use the slug for whatever step we are redirecting too
+			array($this->formStepUrlKey() => $redirect_step->slug())
+		);
+		wp_safe_redirect($current_step->redirectUrl());
+		exit();
+	}
 }

core/services/request/Response.php

Spacing +3 added lines, -3 removed lines

@@ -54,7 +54,7 @@ 
      */
     public function setNotice($key, $value)
     {
-        $this->notice[ $key ] = $value;
+        $this->notice[$key] = $value;
     }
 
 
@@ -64,7 +64,7 @@ 
      */
     public function getNotice($key)
     {
-        return isset($this->notice[ $key ]) ? $this->notice[ $key ] : null;
+        return isset($this->notice[$key]) ? $this->notice[$key] : null;
     }
 
 
@@ -98,7 +98,7 @@ 
      */
     public function getOutput($as_string = true, $separator = PHP_EOL)
     {
-        return $as_string ? implode($separator, $this->output) : $this->output ;
+        return $as_string ? implode($separator, $this->output) : $this->output;
     }
 
 

Indentation +121 added lines, -121 removed lines

@@ -14,125 +14,125 @@
  */
 class Response implements ResponseInterface, ReservedInstanceInterface
 {
-    /**
-     * @var array $notice
-     */
-    protected $notice = [];
-
-    /**
-     * rendered output to be returned to WP
-     *
-     * @var array
-     */
-    protected $output = [];
-
-    /**
-     * @var bool
-     */
-    protected $request_terminated = false;
-
-    /**
-     * @var bool $deactivate_plugin
-     */
-    protected $deactivate_plugin = false;
-
-
-    /**
-     * EE_Response constructor.
-     */
-    public function __construct()
-    {
-        $this->terminateRequest(false);
-    }
-
-
-    /**
-     * @param $key
-     * @param $value
-     * @return    void
-     */
-    public function setNotice($key, $value)
-    {
-        $this->notice[ $key ] = $value;
-    }
-
-
-    /**
-     * @param $key
-     * @return    mixed
-     */
-    public function getNotice($key)
-    {
-        return isset($this->notice[ $key ]) ? $this->notice[ $key ] : null;
-    }
-
-
-    /**
-     * @return array
-     */
-    public function getNotices()
-    {
-        return $this->notice;
-    }
-
-
-    /**
-     * @param string $string
-     * @param bool   $append
-     */
-    public function addOutput($string, $append = true)
-    {
-        if ($append) {
-            $this->output[] = $string;
-            return;
-        }
-        array_unshift($this->output, $string);
-    }
-
-
-    /**
-     * @param bool   $as_string
-     * @param string $separator
-     * @return array|string
-     */
-    public function getOutput($as_string = true, $separator = PHP_EOL)
-    {
-        return $as_string ? implode($separator, $this->output) : $this->output ;
-    }
-
-
-    /**
-     * @return boolean
-     */
-    public function requestTerminated()
-    {
-        return $this->request_terminated;
-    }
-
-
-    /**
-     * @param boolean $request_terminated
-     */
-    public function terminateRequest($request_terminated = true)
-    {
-        $this->request_terminated = filter_var($request_terminated, FILTER_VALIDATE_BOOLEAN);
-    }
-
-
-    /**
-     * @return boolean
-     */
-    public function pluginDeactivated()
-    {
-        return $this->deactivate_plugin;
-    }
-
-
-    /**
-     * sets $deactivate_plugin to true
-     */
-    public function deactivatePlugin()
-    {
-        $this->deactivate_plugin = true;
-    }
+	/**
+	 * @var array $notice
+	 */
+	protected $notice = [];
+
+	/**
+	 * rendered output to be returned to WP
+	 *
+	 * @var array
+	 */
+	protected $output = [];
+
+	/**
+	 * @var bool
+	 */
+	protected $request_terminated = false;
+
+	/**
+	 * @var bool $deactivate_plugin
+	 */
+	protected $deactivate_plugin = false;
+
+
+	/**
+	 * EE_Response constructor.
+	 */
+	public function __construct()
+	{
+		$this->terminateRequest(false);
+	}
+
+
+	/**
+	 * @param $key
+	 * @param $value
+	 * @return    void
+	 */
+	public function setNotice($key, $value)
+	{
+		$this->notice[ $key ] = $value;
+	}
+
+
+	/**
+	 * @param $key
+	 * @return    mixed
+	 */
+	public function getNotice($key)
+	{
+		return isset($this->notice[ $key ]) ? $this->notice[ $key ] : null;
+	}
+
+
+	/**
+	 * @return array
+	 */
+	public function getNotices()
+	{
+		return $this->notice;
+	}
+
+
+	/**
+	 * @param string $string
+	 * @param bool   $append
+	 */
+	public function addOutput($string, $append = true)
+	{
+		if ($append) {
+			$this->output[] = $string;
+			return;
+		}
+		array_unshift($this->output, $string);
+	}
+
+
+	/**
+	 * @param bool   $as_string
+	 * @param string $separator
+	 * @return array|string
+	 */
+	public function getOutput($as_string = true, $separator = PHP_EOL)
+	{
+		return $as_string ? implode($separator, $this->output) : $this->output ;
+	}
+
+
+	/**
+	 * @return boolean
+	 */
+	public function requestTerminated()
+	{
+		return $this->request_terminated;
+	}
+
+
+	/**
+	 * @param boolean $request_terminated
+	 */
+	public function terminateRequest($request_terminated = true)
+	{
+		$this->request_terminated = filter_var($request_terminated, FILTER_VALIDATE_BOOLEAN);
+	}
+
+
+	/**
+	 * @return boolean
+	 */
+	public function pluginDeactivated()
+	{
+		return $this->deactivate_plugin;
+	}
+
+
+	/**
+	 * sets $deactivate_plugin to true
+	 */
+	public function deactivatePlugin()
+	{
+		$this->deactivate_plugin = true;
+	}
 }

core/services/container/Mirror.php

Spacing +33 added lines, -33 removed lines

@@ -60,13 +60,13 @@ 
      */
     public function getReflectionClass($class_name)
     {
-        if (! is_string($class_name)) {
+        if ( ! is_string($class_name)) {
             throw new InvalidDataTypeException($class_name, '$class_name', 'string (fully qualified class name)');
         }
-        if (! isset($this->classes[ $class_name ])) {
-            $this->classes[ $class_name ] = new ReflectionClass($class_name);
+        if ( ! isset($this->classes[$class_name])) {
+            $this->classes[$class_name] = new ReflectionClass($class_name);
         }
-        return $this->classes[ $class_name ];
+        return $this->classes[$class_name];
     }
 
 
@@ -78,14 +78,14 @@ 
      */
     public function getConstructor($class_name)
     {
-        if (! is_string($class_name)) {
+        if ( ! is_string($class_name)) {
             throw new InvalidDataTypeException($class_name, '$class_name', 'string (fully qualified class name)');
         }
-        if (! isset($this->constructors[ $class_name ])) {
+        if ( ! isset($this->constructors[$class_name])) {
             $reflection_class                  = $this->getReflectionClass($class_name);
-            $this->constructors[ $class_name ] = $reflection_class->getConstructor();
+            $this->constructors[$class_name] = $reflection_class->getConstructor();
         }
-        return $this->constructors[ $class_name ];
+        return $this->constructors[$class_name];
     }
 
 
@@ -109,11 +109,11 @@ 
      */
     public function getParameters($class_name)
     {
-        if (! isset($this->parameters[ $class_name ])) {
+        if ( ! isset($this->parameters[$class_name])) {
             $constructor                     = $this->getConstructor($class_name);
-            $this->parameters[ $class_name ] = $constructor->getParameters();
+            $this->parameters[$class_name] = $constructor->getParameters();
         }
-        return $this->parameters[ $class_name ];
+        return $this->parameters[$class_name];
     }
 
 
@@ -149,20 +149,20 @@ 
      */
     public function getParameterClassName(ReflectionParameter $param, $class_name, $index)
     {
-        if (isset($this->parameter_classes[ $class_name ][ $index ]['param_class_name'])) {
-            return $this->parameter_classes[ $class_name ][ $index ]['param_class_name'];
+        if (isset($this->parameter_classes[$class_name][$index]['param_class_name'])) {
+            return $this->parameter_classes[$class_name][$index]['param_class_name'];
         }
-        if (! isset($this->parameter_classes[ $class_name ])) {
-            $this->parameter_classes[ $class_name ] = [];
+        if ( ! isset($this->parameter_classes[$class_name])) {
+            $this->parameter_classes[$class_name] = [];
         }
-        if (! isset($this->parameter_classes[ $class_name ][ $index ])) {
-            $this->parameter_classes[ $class_name ][ $index ] = [];
+        if ( ! isset($this->parameter_classes[$class_name][$index])) {
+            $this->parameter_classes[$class_name][$index] = [];
         }
         // ReflectionParameter::getClass() is deprecated in PHP 8+
-        $this->parameter_classes[ $class_name ][ $index ]['param_class_name'] = PHP_VERSION_ID < 70100
+        $this->parameter_classes[$class_name][$index]['param_class_name'] = PHP_VERSION_ID < 70100
             ? $this->getParameterClassNameLegacy($param)
             : $this->getParameterClassNamePhp8($param);
-        return $this->parameter_classes[ $class_name ][ $index ]['param_class_name'];
+        return $this->parameter_classes[$class_name][$index]['param_class_name'];
     }
 
 
@@ -215,19 +215,19 @@ 
      */
     public function getParameterDefaultValue(ReflectionParameter $param, $class_name, $index)
     {
-        if (isset($this->parameter_classes[ $class_name ][ $index ]['param_class_default'])) {
-            return $this->parameter_classes[ $class_name ][ $index ]['param_class_default'];
+        if (isset($this->parameter_classes[$class_name][$index]['param_class_default'])) {
+            return $this->parameter_classes[$class_name][$index]['param_class_default'];
         }
-        if (! isset($this->parameter_classes[ $class_name ])) {
-            $this->parameter_classes[ $class_name ] = [];
+        if ( ! isset($this->parameter_classes[$class_name])) {
+            $this->parameter_classes[$class_name] = [];
         }
-        if (! isset($this->parameter_classes[ $class_name ][ $index ])) {
-            $this->parameter_classes[ $class_name ][ $index ] = [];
+        if ( ! isset($this->parameter_classes[$class_name][$index])) {
+            $this->parameter_classes[$class_name][$index] = [];
         }
-        $this->parameter_classes[ $class_name ][ $index ]['param_class_default'] = $param->isDefaultValueAvailable()
+        $this->parameter_classes[$class_name][$index]['param_class_default'] = $param->isDefaultValueAvailable()
             ? $param->getDefaultValue()
             : null;
-        return $this->parameter_classes[ $class_name ][ $index ]['param_class_default'];
+        return $this->parameter_classes[$class_name][$index]['param_class_default'];
     }
 
 
@@ -239,11 +239,11 @@ 
      */
     public function getProperties($class_name)
     {
-        if (! isset($this->properties[ $class_name ])) {
+        if ( ! isset($this->properties[$class_name])) {
             $reflection_class                = $this->getReflectionClass($class_name);
-            $this->properties[ $class_name ] = $reflection_class->getProperties();
+            $this->properties[$class_name] = $reflection_class->getProperties();
         }
-        return $this->properties[ $class_name ];
+        return $this->properties[$class_name];
     }
 
 
@@ -267,11 +267,11 @@ 
      */
     public function getMethods($class_name)
     {
-        if (! isset($this->methods[ $class_name ])) {
+        if ( ! isset($this->methods[$class_name])) {
             $reflection_class             = $this->getReflectionClass($class_name);
-            $this->methods[ $class_name ] = $reflection_class->getMethods();
+            $this->methods[$class_name] = $reflection_class->getMethods();
         }
-        return $this->methods[ $class_name ];
+        return $this->methods[$class_name];
     }
 
 

Indentation +264 added lines, -264 removed lines

@@ -20,268 +20,268 @@
  */
 class Mirror
 {
-    /**
-     * @var ReflectionClass[] $classes
-     */
-    private $classes = [];
-
-    /**
-     * @var ReflectionMethod[] $constructors
-     */
-    private $constructors = [];
-
-    /**
-     * @var ReflectionParameter[][] $parameters
-     */
-    private $parameters = [];
-
-    /**
-     * @var ReflectionParameter[][] $parameters
-     */
-    private $parameter_classes = [];
-
-    /**
-     * @var ReflectionProperty[][] $properties
-     */
-    private $properties = [];
-
-    /**
-     * @var ReflectionMethod[][] $methods
-     */
-    private $methods = [];
-
-
-    /**
-     * @param string $class_name
-     * @return ReflectionClass
-     * @throws ReflectionException
-     * @throws InvalidDataTypeException
-     */
-    public function getReflectionClass($class_name)
-    {
-        if (! is_string($class_name)) {
-            throw new InvalidDataTypeException($class_name, '$class_name', 'string (fully qualified class name)');
-        }
-        if (! isset($this->classes[ $class_name ])) {
-            $this->classes[ $class_name ] = new ReflectionClass($class_name);
-        }
-        return $this->classes[ $class_name ];
-    }
-
-
-    /**
-     * @param string $class_name
-     * @return ReflectionMethod
-     * @throws InvalidDataTypeException
-     * @throws ReflectionException
-     */
-    public function getConstructor($class_name)
-    {
-        if (! is_string($class_name)) {
-            throw new InvalidDataTypeException($class_name, '$class_name', 'string (fully qualified class name)');
-        }
-        if (! isset($this->constructors[ $class_name ])) {
-            $reflection_class                  = $this->getReflectionClass($class_name);
-            $this->constructors[ $class_name ] = $reflection_class->getConstructor();
-        }
-        return $this->constructors[ $class_name ];
-    }
-
-
-    /**
-     * @param ReflectionClass $reflection_class
-     * @return ReflectionMethod
-     * @throws InvalidDataTypeException
-     * @throws ReflectionException
-     */
-    public function getConstructorFromReflection(ReflectionClass $reflection_class)
-    {
-        return $this->getConstructor($reflection_class->getName());
-    }
-
-
-    /**
-     * @param string $class_name
-     * @return ReflectionParameter[]
-     * @throws InvalidDataTypeException
-     * @throws ReflectionException
-     */
-    public function getParameters($class_name)
-    {
-        if (! isset($this->parameters[ $class_name ])) {
-            $constructor                     = $this->getConstructor($class_name);
-            $this->parameters[ $class_name ] = $constructor->getParameters();
-        }
-        return $this->parameters[ $class_name ];
-    }
-
-
-    /**
-     * @param ReflectionClass $reflection_class
-     * @return ReflectionParameter[]
-     * @throws InvalidDataTypeException
-     * @throws ReflectionException
-     */
-    public function getParametersFromReflection(ReflectionClass $reflection_class)
-    {
-        return $this->getParameters($reflection_class->getName());
-    }
-
-
-    /**
-     * @param ReflectionMethod $constructor
-     * @return ReflectionParameter[]
-     * @throws InvalidDataTypeException
-     * @throws ReflectionException
-     */
-    public function getParametersFromReflectionConstructor(ReflectionMethod $constructor)
-    {
-        return $this->getParameters($constructor->getDeclaringClass());
-    }
-
-
-    /**
-     * @param ReflectionParameter $param
-     * @param string              $class_name
-     * @param string              $index
-     * @return string|null
-     */
-    public function getParameterClassName(ReflectionParameter $param, $class_name, $index)
-    {
-        if (isset($this->parameter_classes[ $class_name ][ $index ]['param_class_name'])) {
-            return $this->parameter_classes[ $class_name ][ $index ]['param_class_name'];
-        }
-        if (! isset($this->parameter_classes[ $class_name ])) {
-            $this->parameter_classes[ $class_name ] = [];
-        }
-        if (! isset($this->parameter_classes[ $class_name ][ $index ])) {
-            $this->parameter_classes[ $class_name ][ $index ] = [];
-        }
-        // ReflectionParameter::getClass() is deprecated in PHP 8+
-        $this->parameter_classes[ $class_name ][ $index ]['param_class_name'] = PHP_VERSION_ID < 70100
-            ? $this->getParameterClassNameLegacy($param)
-            : $this->getParameterClassNamePhp8($param);
-        return $this->parameter_classes[ $class_name ][ $index ]['param_class_name'];
-    }
-
-
-    /**
-     * @param ReflectionParameter $param
-     * @return string|null
-     * @since   4.10.13.p
-     */
-    private function getParameterClassNameLegacy(ReflectionParameter $param)
-    {
-        $reflection_class = $param->getClass();
-        return $reflection_class instanceof ReflectionClass
-            ? $reflection_class->getName()
-            : null;
-    }
-
-
-    /**
-     * ReflectionParameter::getClass() is deprecated in PHP 8+,
-     * so the class name for a parameter needs to be extracted from the ReflectionType,
-     * which can either be a ReflectionNamedType or ReflectionUnionType
-     *
-     * @param ReflectionParameter $param
-     * @return null
-     * @since   4.10.13.p
-     */
-    private function getParameterClassNamePhp8(ReflectionParameter $param)
-    {
-        $reflection_type = $param->getType();
-        if ($reflection_type instanceof \ReflectionNamedType) {
-            return $reflection_type->getName();
-        }
-        if ($reflection_type instanceof \ReflectionUnionType) {
-            $reflection_types = $reflection_type->getTypes();
-            if (is_array($reflection_types)) {
-                $first = reset($reflection_types);
-                return $first->getName();
-            }
-        }
-        return null;
-    }
-
-
-    /**
-     * @param ReflectionParameter $param
-     * @param string              $class_name
-     * @param string              $index
-     * @return string|null
-     * @throws ReflectionException
-     */
-    public function getParameterDefaultValue(ReflectionParameter $param, $class_name, $index)
-    {
-        if (isset($this->parameter_classes[ $class_name ][ $index ]['param_class_default'])) {
-            return $this->parameter_classes[ $class_name ][ $index ]['param_class_default'];
-        }
-        if (! isset($this->parameter_classes[ $class_name ])) {
-            $this->parameter_classes[ $class_name ] = [];
-        }
-        if (! isset($this->parameter_classes[ $class_name ][ $index ])) {
-            $this->parameter_classes[ $class_name ][ $index ] = [];
-        }
-        $this->parameter_classes[ $class_name ][ $index ]['param_class_default'] = $param->isDefaultValueAvailable()
-            ? $param->getDefaultValue()
-            : null;
-        return $this->parameter_classes[ $class_name ][ $index ]['param_class_default'];
-    }
-
-
-    /**
-     * @param string $class_name
-     * @return ReflectionProperty[]
-     * @throws InvalidDataTypeException
-     * @throws ReflectionException
-     */
-    public function getProperties($class_name)
-    {
-        if (! isset($this->properties[ $class_name ])) {
-            $reflection_class                = $this->getReflectionClass($class_name);
-            $this->properties[ $class_name ] = $reflection_class->getProperties();
-        }
-        return $this->properties[ $class_name ];
-    }
-
-
-    /**
-     * @param ReflectionClass $reflection_class
-     * @return ReflectionProperty[]
-     * @throws InvalidDataTypeException
-     * @throws ReflectionException
-     */
-    public function getPropertiesFromReflection(ReflectionClass $reflection_class)
-    {
-        return $this->getProperties($reflection_class->getName());
-    }
-
-
-    /**
-     * @param string $class_name
-     * @return ReflectionMethod[]
-     * @throws InvalidDataTypeException
-     * @throws ReflectionException
-     */
-    public function getMethods($class_name)
-    {
-        if (! isset($this->methods[ $class_name ])) {
-            $reflection_class             = $this->getReflectionClass($class_name);
-            $this->methods[ $class_name ] = $reflection_class->getMethods();
-        }
-        return $this->methods[ $class_name ];
-    }
-
-
-    /**
-     * @param ReflectionClass $reflection_class )
-     * @return ReflectionMethod[]
-     * @throws InvalidDataTypeException
-     * @throws ReflectionException
-     */
-    public function getMethodsFromReflection(ReflectionClass $reflection_class)
-    {
-        return $this->getMethods($reflection_class->getName());
-    }
+	/**
+	 * @var ReflectionClass[] $classes
+	 */
+	private $classes = [];
+
+	/**
+	 * @var ReflectionMethod[] $constructors
+	 */
+	private $constructors = [];
+
+	/**
+	 * @var ReflectionParameter[][] $parameters
+	 */
+	private $parameters = [];
+
+	/**
+	 * @var ReflectionParameter[][] $parameters
+	 */
+	private $parameter_classes = [];
+
+	/**
+	 * @var ReflectionProperty[][] $properties
+	 */
+	private $properties = [];
+
+	/**
+	 * @var ReflectionMethod[][] $methods
+	 */
+	private $methods = [];
+
+
+	/**
+	 * @param string $class_name
+	 * @return ReflectionClass
+	 * @throws ReflectionException
+	 * @throws InvalidDataTypeException
+	 */
+	public function getReflectionClass($class_name)
+	{
+		if (! is_string($class_name)) {
+			throw new InvalidDataTypeException($class_name, '$class_name', 'string (fully qualified class name)');
+		}
+		if (! isset($this->classes[ $class_name ])) {
+			$this->classes[ $class_name ] = new ReflectionClass($class_name);
+		}
+		return $this->classes[ $class_name ];
+	}
+
+
+	/**
+	 * @param string $class_name
+	 * @return ReflectionMethod
+	 * @throws InvalidDataTypeException
+	 * @throws ReflectionException
+	 */
+	public function getConstructor($class_name)
+	{
+		if (! is_string($class_name)) {
+			throw new InvalidDataTypeException($class_name, '$class_name', 'string (fully qualified class name)');
+		}
+		if (! isset($this->constructors[ $class_name ])) {
+			$reflection_class                  = $this->getReflectionClass($class_name);
+			$this->constructors[ $class_name ] = $reflection_class->getConstructor();
+		}
+		return $this->constructors[ $class_name ];
+	}
+
+
+	/**
+	 * @param ReflectionClass $reflection_class
+	 * @return ReflectionMethod
+	 * @throws InvalidDataTypeException
+	 * @throws ReflectionException
+	 */
+	public function getConstructorFromReflection(ReflectionClass $reflection_class)
+	{
+		return $this->getConstructor($reflection_class->getName());
+	}
+
+
+	/**
+	 * @param string $class_name
+	 * @return ReflectionParameter[]
+	 * @throws InvalidDataTypeException
+	 * @throws ReflectionException
+	 */
+	public function getParameters($class_name)
+	{
+		if (! isset($this->parameters[ $class_name ])) {
+			$constructor                     = $this->getConstructor($class_name);
+			$this->parameters[ $class_name ] = $constructor->getParameters();
+		}
+		return $this->parameters[ $class_name ];
+	}
+
+
+	/**
+	 * @param ReflectionClass $reflection_class
+	 * @return ReflectionParameter[]
+	 * @throws InvalidDataTypeException
+	 * @throws ReflectionException
+	 */
+	public function getParametersFromReflection(ReflectionClass $reflection_class)
+	{
+		return $this->getParameters($reflection_class->getName());
+	}
+
+
+	/**
+	 * @param ReflectionMethod $constructor
+	 * @return ReflectionParameter[]
+	 * @throws InvalidDataTypeException
+	 * @throws ReflectionException
+	 */
+	public function getParametersFromReflectionConstructor(ReflectionMethod $constructor)
+	{
+		return $this->getParameters($constructor->getDeclaringClass());
+	}
+
+
+	/**
+	 * @param ReflectionParameter $param
+	 * @param string              $class_name
+	 * @param string              $index
+	 * @return string|null
+	 */
+	public function getParameterClassName(ReflectionParameter $param, $class_name, $index)
+	{
+		if (isset($this->parameter_classes[ $class_name ][ $index ]['param_class_name'])) {
+			return $this->parameter_classes[ $class_name ][ $index ]['param_class_name'];
+		}
+		if (! isset($this->parameter_classes[ $class_name ])) {
+			$this->parameter_classes[ $class_name ] = [];
+		}
+		if (! isset($this->parameter_classes[ $class_name ][ $index ])) {
+			$this->parameter_classes[ $class_name ][ $index ] = [];
+		}
+		// ReflectionParameter::getClass() is deprecated in PHP 8+
+		$this->parameter_classes[ $class_name ][ $index ]['param_class_name'] = PHP_VERSION_ID < 70100
+			? $this->getParameterClassNameLegacy($param)
+			: $this->getParameterClassNamePhp8($param);
+		return $this->parameter_classes[ $class_name ][ $index ]['param_class_name'];
+	}
+
+
+	/**
+	 * @param ReflectionParameter $param
+	 * @return string|null
+	 * @since   4.10.13.p
+	 */
+	private function getParameterClassNameLegacy(ReflectionParameter $param)
+	{
+		$reflection_class = $param->getClass();
+		return $reflection_class instanceof ReflectionClass
+			? $reflection_class->getName()
+			: null;
+	}
+
+
+	/**
+	 * ReflectionParameter::getClass() is deprecated in PHP 8+,
+	 * so the class name for a parameter needs to be extracted from the ReflectionType,
+	 * which can either be a ReflectionNamedType or ReflectionUnionType
+	 *
+	 * @param ReflectionParameter $param
+	 * @return null
+	 * @since   4.10.13.p
+	 */
+	private function getParameterClassNamePhp8(ReflectionParameter $param)
+	{
+		$reflection_type = $param->getType();
+		if ($reflection_type instanceof \ReflectionNamedType) {
+			return $reflection_type->getName();
+		}
+		if ($reflection_type instanceof \ReflectionUnionType) {
+			$reflection_types = $reflection_type->getTypes();
+			if (is_array($reflection_types)) {
+				$first = reset($reflection_types);
+				return $first->getName();
+			}
+		}
+		return null;
+	}
+
+
+	/**
+	 * @param ReflectionParameter $param
+	 * @param string              $class_name
+	 * @param string              $index
+	 * @return string|null
+	 * @throws ReflectionException
+	 */
+	public function getParameterDefaultValue(ReflectionParameter $param, $class_name, $index)
+	{
+		if (isset($this->parameter_classes[ $class_name ][ $index ]['param_class_default'])) {
+			return $this->parameter_classes[ $class_name ][ $index ]['param_class_default'];
+		}
+		if (! isset($this->parameter_classes[ $class_name ])) {
+			$this->parameter_classes[ $class_name ] = [];
+		}
+		if (! isset($this->parameter_classes[ $class_name ][ $index ])) {
+			$this->parameter_classes[ $class_name ][ $index ] = [];
+		}
+		$this->parameter_classes[ $class_name ][ $index ]['param_class_default'] = $param->isDefaultValueAvailable()
+			? $param->getDefaultValue()
+			: null;
+		return $this->parameter_classes[ $class_name ][ $index ]['param_class_default'];
+	}
+
+
+	/**
+	 * @param string $class_name
+	 * @return ReflectionProperty[]
+	 * @throws InvalidDataTypeException
+	 * @throws ReflectionException
+	 */
+	public function getProperties($class_name)
+	{
+		if (! isset($this->properties[ $class_name ])) {
+			$reflection_class                = $this->getReflectionClass($class_name);
+			$this->properties[ $class_name ] = $reflection_class->getProperties();
+		}
+		return $this->properties[ $class_name ];
+	}
+
+
+	/**
+	 * @param ReflectionClass $reflection_class
+	 * @return ReflectionProperty[]
+	 * @throws InvalidDataTypeException
+	 * @throws ReflectionException
+	 */
+	public function getPropertiesFromReflection(ReflectionClass $reflection_class)
+	{
+		return $this->getProperties($reflection_class->getName());
+	}
+
+
+	/**
+	 * @param string $class_name
+	 * @return ReflectionMethod[]
+	 * @throws InvalidDataTypeException
+	 * @throws ReflectionException
+	 */
+	public function getMethods($class_name)
+	{
+		if (! isset($this->methods[ $class_name ])) {
+			$reflection_class             = $this->getReflectionClass($class_name);
+			$this->methods[ $class_name ] = $reflection_class->getMethods();
+		}
+		return $this->methods[ $class_name ];
+	}
+
+
+	/**
+	 * @param ReflectionClass $reflection_class )
+	 * @return ReflectionMethod[]
+	 * @throws InvalidDataTypeException
+	 * @throws ReflectionException
+	 */
+	public function getMethodsFromReflection(ReflectionClass $reflection_class)
+	{
+		return $this->getMethods($reflection_class->getName());
+	}
 }

core/services/loaders/ClassInterfaceCache.php

Spacing +14 added lines, -14 removed lines

@@ -49,16 +49,16 @@ 
     {
         $fqn = $this->getFqn($fqn);
         // have we already seen this FQCN ?
-        if (! array_key_exists($fqn, $this->interfaces)) {
-            $this->interfaces[ $fqn ] = array();
+        if ( ! array_key_exists($fqn, $this->interfaces)) {
+            $this->interfaces[$fqn] = array();
             if (class_exists($fqn)) {
-                $this->interfaces[ $fqn ] = class_implements($fqn, false);
-                $this->interfaces[ $fqn ] = $this->interfaces[ $fqn ] !== false
-                    ? $this->interfaces[ $fqn ]
+                $this->interfaces[$fqn] = class_implements($fqn, false);
+                $this->interfaces[$fqn] = $this->interfaces[$fqn] !== false
+                    ? $this->interfaces[$fqn]
                     : array();
             }
         }
-        return $this->interfaces[ $fqn ];
+        return $this->interfaces[$fqn];
     }
 
 
@@ -93,13 +93,13 @@ 
         // are we adding an alias for a specific class?
         if ($for_class !== '') {
             // make sure it's set up as an array
-            if (! isset($this->aliases[ $for_class ])) {
-                $this->aliases[ $for_class ] = array();
+            if ( ! isset($this->aliases[$for_class])) {
+                $this->aliases[$for_class] = array();
             }
-            $this->aliases[ $for_class ][ $alias ] = $fqn;
+            $this->aliases[$for_class][$alias] = $fqn;
             return;
         }
-        $this->aliases[ $alias ] = $fqn;
+        $this->aliases[$alias] = $fqn;
     }
 
 
@@ -131,7 +131,7 @@ 
      */
     protected function isDirectAlias($fqn = '')
     {
-        return isset($this->aliases[ (string) $fqn ]) && ! is_array($this->aliases[ (string) $fqn ]);
+        return isset($this->aliases[(string) $fqn]) && ! is_array($this->aliases[(string) $fqn]);
     }
 
 
@@ -146,7 +146,7 @@ 
     {
         return (
             $for_class !== ''
-            && isset($this->aliases[ (string) $for_class ][ (string) $fqn ])
+            && isset($this->aliases[(string) $for_class][(string) $fqn])
         );
     }
 
@@ -171,11 +171,11 @@ 
     {
         $alias = $this->getFqn($alias);
         if ($this->isAliasForClass($alias, $for_class)) {
-            return $this->getFqnForAlias($this->aliases[ (string) $for_class ][ (string) $alias ], $for_class);
+            return $this->getFqnForAlias($this->aliases[(string) $for_class][(string) $alias], $for_class);
         }
         if ($this->isDirectAlias($alias)) {
             // note: changed '' to $for_class
-            return $this->getFqnForAlias($this->aliases[ (string) $alias ], $for_class);
+            return $this->getFqnForAlias($this->aliases[(string) $alias], $for_class);
         }
         return $alias;
     }

Indentation +176 added lines, -176 removed lines

@@ -16,180 +16,180 @@
  */
 class ClassInterfaceCache
 {
-    /**
-     * array of interfaces indexed by FQCNs where values are arrays of interface FQNs
-     *
-     * @var string[][] $interfaces
-     */
-    private $interfaces = array();
-
-    /**
-     * @type string[][] $aliases
-     */
-    protected $aliases = array();
-
-
-    /**
-     * @param string $fqn
-     * @return string
-     */
-    public function getFqn($fqn)
-    {
-        $fqn = $fqn instanceof FullyQualifiedName ? $fqn->string() : $fqn;
-        return ltrim((string) $fqn, '\\');
-    }
-
-
-    /**
-     * @param string $fqn
-     * @return array
-     */
-    public function getInterfaces($fqn)
-    {
-        $fqn = $this->getFqn($fqn);
-        // have we already seen this FQCN ?
-        if (! array_key_exists($fqn, $this->interfaces)) {
-            $this->interfaces[ $fqn ] = array();
-            if (class_exists($fqn)) {
-                $this->interfaces[ $fqn ] = class_implements($fqn, false);
-                $this->interfaces[ $fqn ] = $this->interfaces[ $fqn ] !== false
-                    ? $this->interfaces[ $fqn ]
-                    : array();
-            }
-        }
-        return $this->interfaces[ $fqn ];
-    }
-
-
-    /**
-     * @param string $fqn
-     * @param string $interface
-     * @return bool
-     */
-    public function hasInterface($fqn, $interface)
-    {
-        $fqn        = $this->getFqn($fqn);
-        $interfaces = $this->getInterfaces($fqn);
-        return in_array($interface, $interfaces, true);
-    }
-
-
-    /**
-     * adds an alias for a classname
-     *
-     * @param string $fqn       the class name that should be used (concrete class to replace interface)
-     * @param string $alias     the class name that would be type hinted for (abstract parent or interface)
-     * @param string $for_class the class that has the dependency (is type hinting for the interface)
-     * @throws InvalidAliasException
-     */
-    public function addAlias($fqn, $alias, $for_class = '')
-    {
-        $fqn   = $this->getFqn($fqn);
-        $alias = $this->getFqn($alias);
-        if (strpos($alias, '\\') !== false && ! is_subclass_of($fqn, $alias)) {
-            throw new InvalidAliasException($fqn, $alias);
-        }
-        // are we adding an alias for a specific class?
-        if ($for_class !== '') {
-            // make sure it's set up as an array
-            if (! isset($this->aliases[ $for_class ])) {
-                $this->aliases[ $for_class ] = array();
-            }
-            $this->aliases[ $for_class ][ $alias ] = $fqn;
-            return;
-        }
-        $this->aliases[ $alias ] = $fqn;
-    }
-
-
-    /**
-     * returns TRUE if the provided FQN is an alias
-     *
-     * @param string $fqn
-     * @param string $for_class
-     * @return bool
-     */
-    public function isAlias($fqn = '', $for_class = '')
-    {
-        $fqn = $this->getFqn($fqn);
-        if ($this->isAliasForClass($fqn, $for_class)) {
-            return true;
-        }
-        if ($this->isDirectAlias($fqn)) {
-            return true;
-        }
-        return false;
-    }
-
-
-    /**
-     * returns TRUE if the provided FQN is an alias
-     *
-     * @param string $fqn
-     * @return bool
-     */
-    protected function isDirectAlias($fqn = '')
-    {
-        return isset($this->aliases[ (string) $fqn ]) && ! is_array($this->aliases[ (string) $fqn ]);
-    }
-
-
-    /**
-     * returns TRUE if the provided FQN is an alias for the specified class
-     *
-     * @param string $fqn
-     * @param string $for_class
-     * @return bool
-     */
-    protected function isAliasForClass($fqn = '', $for_class = '')
-    {
-        return (
-            $for_class !== ''
-            && isset($this->aliases[ (string) $for_class ][ (string) $fqn ])
-        );
-    }
-
-
-    /**
-     * returns FQN for provided alias if one exists, otherwise returns the original FQN
-     * functions recursively, so that multiple aliases can be used to drill down to a FQN
-     *  for example:
-     *      if the following two entries were added to the aliases array:
-     *          array(
-     *              'interface_alias'           => 'some\namespace\interface'
-     *              'some\namespace\interface'  => 'some\namespace\classname'
-     *          )
-     *      then one could use Loader::getNew( 'interface_alias' )
-     *      to load an instance of 'some\namespace\classname'
-     *
-     * @param string $alias
-     * @param string $for_class
-     * @return string
-     */
-    public function getFqnForAlias($alias = '', $for_class = '')
-    {
-        $alias = $this->getFqn($alias);
-        if ($this->isAliasForClass($alias, $for_class)) {
-            return $this->getFqnForAlias($this->aliases[ (string) $for_class ][ (string) $alias ], $for_class);
-        }
-        if ($this->isDirectAlias($alias)) {
-            // note: changed '' to $for_class
-            return $this->getFqnForAlias($this->aliases[ (string) $alias ], $for_class);
-        }
-        return $alias;
-    }
-
-
-    // public function debug($for_class = '')
-    // {
-    //     if ($for_class !== '') {
-    //         if ( ! isset($this->aliases[ $for_class ])) {
-    //             \EEH_Debug_Tools::printr('NOT FOUND', "aliases[ $for_class ]", __FILE__, __LINE__);
-    //             return;
-    //         }
-    //         \EEH_Debug_Tools::printr($this->aliases[ $for_class ], "aliases[ $for_class ]", __FILE__, __LINE__);
-    //         return;
-    //     }
-    //     \EEH_Debug_Tools::printr($this->aliases, '$this->aliases', __FILE__, __LINE__);
-    // }
+	/**
+	 * array of interfaces indexed by FQCNs where values are arrays of interface FQNs
+	 *
+	 * @var string[][] $interfaces
+	 */
+	private $interfaces = array();
+
+	/**
+	 * @type string[][] $aliases
+	 */
+	protected $aliases = array();
+
+
+	/**
+	 * @param string $fqn
+	 * @return string
+	 */
+	public function getFqn($fqn)
+	{
+		$fqn = $fqn instanceof FullyQualifiedName ? $fqn->string() : $fqn;
+		return ltrim((string) $fqn, '\\');
+	}
+
+
+	/**
+	 * @param string $fqn
+	 * @return array
+	 */
+	public function getInterfaces($fqn)
+	{
+		$fqn = $this->getFqn($fqn);
+		// have we already seen this FQCN ?
+		if (! array_key_exists($fqn, $this->interfaces)) {
+			$this->interfaces[ $fqn ] = array();
+			if (class_exists($fqn)) {
+				$this->interfaces[ $fqn ] = class_implements($fqn, false);
+				$this->interfaces[ $fqn ] = $this->interfaces[ $fqn ] !== false
+					? $this->interfaces[ $fqn ]
+					: array();
+			}
+		}
+		return $this->interfaces[ $fqn ];
+	}
+
+
+	/**
+	 * @param string $fqn
+	 * @param string $interface
+	 * @return bool
+	 */
+	public function hasInterface($fqn, $interface)
+	{
+		$fqn        = $this->getFqn($fqn);
+		$interfaces = $this->getInterfaces($fqn);
+		return in_array($interface, $interfaces, true);
+	}
+
+
+	/**
+	 * adds an alias for a classname
+	 *
+	 * @param string $fqn       the class name that should be used (concrete class to replace interface)
+	 * @param string $alias     the class name that would be type hinted for (abstract parent or interface)
+	 * @param string $for_class the class that has the dependency (is type hinting for the interface)
+	 * @throws InvalidAliasException
+	 */
+	public function addAlias($fqn, $alias, $for_class = '')
+	{
+		$fqn   = $this->getFqn($fqn);
+		$alias = $this->getFqn($alias);
+		if (strpos($alias, '\\') !== false && ! is_subclass_of($fqn, $alias)) {
+			throw new InvalidAliasException($fqn, $alias);
+		}
+		// are we adding an alias for a specific class?
+		if ($for_class !== '') {
+			// make sure it's set up as an array
+			if (! isset($this->aliases[ $for_class ])) {
+				$this->aliases[ $for_class ] = array();
+			}
+			$this->aliases[ $for_class ][ $alias ] = $fqn;
+			return;
+		}
+		$this->aliases[ $alias ] = $fqn;
+	}
+
+
+	/**
+	 * returns TRUE if the provided FQN is an alias
+	 *
+	 * @param string $fqn
+	 * @param string $for_class
+	 * @return bool
+	 */
+	public function isAlias($fqn = '', $for_class = '')
+	{
+		$fqn = $this->getFqn($fqn);
+		if ($this->isAliasForClass($fqn, $for_class)) {
+			return true;
+		}
+		if ($this->isDirectAlias($fqn)) {
+			return true;
+		}
+		return false;
+	}
+
+
+	/**
+	 * returns TRUE if the provided FQN is an alias
+	 *
+	 * @param string $fqn
+	 * @return bool
+	 */
+	protected function isDirectAlias($fqn = '')
+	{
+		return isset($this->aliases[ (string) $fqn ]) && ! is_array($this->aliases[ (string) $fqn ]);
+	}
+
+
+	/**
+	 * returns TRUE if the provided FQN is an alias for the specified class
+	 *
+	 * @param string $fqn
+	 * @param string $for_class
+	 * @return bool
+	 */
+	protected function isAliasForClass($fqn = '', $for_class = '')
+	{
+		return (
+			$for_class !== ''
+			&& isset($this->aliases[ (string) $for_class ][ (string) $fqn ])
+		);
+	}
+
+
+	/**
+	 * returns FQN for provided alias if one exists, otherwise returns the original FQN
+	 * functions recursively, so that multiple aliases can be used to drill down to a FQN
+	 *  for example:
+	 *      if the following two entries were added to the aliases array:
+	 *          array(
+	 *              'interface_alias'           => 'some\namespace\interface'
+	 *              'some\namespace\interface'  => 'some\namespace\classname'
+	 *          )
+	 *      then one could use Loader::getNew( 'interface_alias' )
+	 *      to load an instance of 'some\namespace\classname'
+	 *
+	 * @param string $alias
+	 * @param string $for_class
+	 * @return string
+	 */
+	public function getFqnForAlias($alias = '', $for_class = '')
+	{
+		$alias = $this->getFqn($alias);
+		if ($this->isAliasForClass($alias, $for_class)) {
+			return $this->getFqnForAlias($this->aliases[ (string) $for_class ][ (string) $alias ], $for_class);
+		}
+		if ($this->isDirectAlias($alias)) {
+			// note: changed '' to $for_class
+			return $this->getFqnForAlias($this->aliases[ (string) $alias ], $for_class);
+		}
+		return $alias;
+	}
+
+
+	// public function debug($for_class = '')
+	// {
+	//     if ($for_class !== '') {
+	//         if ( ! isset($this->aliases[ $for_class ])) {
+	//             \EEH_Debug_Tools::printr('NOT FOUND', "aliases[ $for_class ]", __FILE__, __LINE__);
+	//             return;
+	//         }
+	//         \EEH_Debug_Tools::printr($this->aliases[ $for_class ], "aliases[ $for_class ]", __FILE__, __LINE__);
+	//         return;
+	//     }
+	//     \EEH_Debug_Tools::printr($this->aliases, '$this->aliases', __FILE__, __LINE__);
+	// }
 }

core/services/shortcodes/ShortcodesManager.php

Spacing +3 added lines, -3 removed lines

@@ -81,7 +81,7 @@ 
      */
     public function getShortcodes()
     {
-        if (! $this->shortcodes instanceof CollectionInterface) {
+        if ( ! $this->shortcodes instanceof CollectionInterface) {
             $this->shortcodes = $this->loadShortcodesCollection();
         }
         return $this->shortcodes;
@@ -138,7 +138,7 @@ 
                 'FHEE__EventEspresso_core_services_shortcodes_ShortcodesManager__registerShortcodes__shortcode_collection',
                 $this->getShortcodes()
             );
-            if (! $this->shortcodes instanceof CollectionInterface) {
+            if ( ! $this->shortcodes instanceof CollectionInterface) {
                 throw new InvalidEntityException(
                     $this->shortcodes,
                     'CollectionInterface',
@@ -172,7 +172,7 @@ 
                     add_action('wp_enqueue_scripts', [$shortcode, 'enqueueStylesheets'], 11);
                 }
                 // add_shortcode() if it has not already been added
-                if (! shortcode_exists($shortcode->getTag())) {
+                if ( ! shortcode_exists($shortcode->getTag())) {
                     add_shortcode($shortcode->getTag(), [$shortcode, 'processShortcodeCallback']);
                 }
             }

Indentation +206 added lines, -206 removed lines

@@ -29,210 +29,210 @@
  */
 class ShortcodesManager
 {
-    /**
-     * @type CurrentPage
-     */
-    protected $current_page;
-
-    /**
-     * @var LegacyShortcodesManager $legacy_shortcodes_manager
-     */
-    private $legacy_shortcodes_manager;
-
-    /**
-     * @var ShortcodeInterface[] $shortcodes
-     */
-    private $shortcodes;
-
-
-    /**
-     * ShortcodesManager constructor
-     *
-     * @param LegacyShortcodesManager $legacy_shortcodes_manager
-     * @param CurrentPage             $current_page
-     */
-    public function __construct(LegacyShortcodesManager $legacy_shortcodes_manager, CurrentPage $current_page)
-    {
-        $this->legacy_shortcodes_manager = $legacy_shortcodes_manager;
-        $this->current_page              = $current_page;
-        // assemble a list of installed and active shortcodes
-        add_action(
-            'AHEE__EE_System__register_shortcodes_modules_and_widgets',
-            [$this, 'registerShortcodes'],
-            999
-        );
-        //  call add_shortcode() for all installed shortcodes
-        add_action('AHEE__EE_System__core_loaded_and_ready', [$this, 'addShortcodes']);
-        // check content for shortcodes the old way
-        add_action('parse_query', [$this->legacy_shortcodes_manager, 'initializeShortcodes'], 5);
-        // check content for shortcodes the NEW more efficient way
-        add_action('template_redirect', [$this, 'templateRedirect'], 999);
-    }
-
-
-    /**
-     * @return CollectionInterface|ShortcodeInterface[]
-     * @throws InvalidIdentifierException
-     * @throws InvalidInterfaceException
-     * @throws InvalidFilePathException
-     * @throws InvalidEntityException
-     * @throws InvalidDataTypeException
-     * @throws InvalidClassException
-     */
-    public function getShortcodes()
-    {
-        if (! $this->shortcodes instanceof CollectionInterface) {
-            $this->shortcodes = $this->loadShortcodesCollection();
-        }
-        return $this->shortcodes;
-    }
-
-
-    /**
-     * @return CollectionInterface|ShortcodeInterface[]
-     * @throws InvalidIdentifierException
-     * @throws InvalidInterfaceException
-     * @throws InvalidFilePathException
-     * @throws InvalidEntityException
-     * @throws InvalidDataTypeException
-     * @throws InvalidClassException
-     */
-    protected function loadShortcodesCollection()
-    {
-        $loader = new CollectionLoader(
-            new CollectionDetails(
-            // collection name
-                'shortcodes',
-                // collection interface
-                'EventEspresso\core\services\shortcodes\ShortcodeInterface',
-                // FQCNs for classes to add (all classes within that namespace will be loaded)
-                ['EventEspresso\core\domain\entities\shortcodes'],
-                // filepaths to classes to add
-                [],
-                // file mask to use if parsing folder for files to add
-                '',
-                // what to use as identifier for collection entities
-                // using CLASS NAME prevents duplicates (works like a singleton)
-                CollectionDetails::ID_CLASS_NAME
-            )
-        );
-        return $loader->getCollection();
-    }
-
-
-    /**
-     * @return void
-     * @throws DomainException
-     * @throws InvalidInterfaceException
-     * @throws InvalidIdentifierException
-     * @throws InvalidFilePathException
-     * @throws InvalidEntityException
-     * @throws InvalidDataTypeException
-     * @throws InvalidClassException
-     * @throws Exception
-     */
-    public function registerShortcodes()
-    {
-        try {
-            $this->shortcodes = apply_filters(
-                'FHEE__EventEspresso_core_services_shortcodes_ShortcodesManager__registerShortcodes__shortcode_collection',
-                $this->getShortcodes()
-            );
-            if (! $this->shortcodes instanceof CollectionInterface) {
-                throw new InvalidEntityException(
-                    $this->shortcodes,
-                    'CollectionInterface',
-                    sprintf(
-                        esc_html__(
-                            'The "FHEE__EventEspresso_core_services_shortcodes_ShortcodesManager__registerShortcodes__shortcode_collection" filter must return a Collection of EspressoShortcode objects. "%1$s" was received instead.',
-                            'event_espresso'
-                        ),
-                        is_object($this->shortcodes) ? get_class($this->shortcodes) : gettype($this->shortcodes)
-                    )
-                );
-            }
-            $this->legacy_shortcodes_manager->registerShortcodes();
-        } catch (Exception $exception) {
-            new ExceptionStackTraceDisplay($exception);
-        }
-    }
-
-
-    /**
-     * @return void
-     * @throws Exception
-     */
-    public function addShortcodes()
-    {
-        try {
-            // cycle thru shortcode folders
-            foreach ($this->shortcodes as $shortcode) {
-                if ($shortcode instanceof EnqueueAssetsInterface) {
-                    add_action('wp_enqueue_scripts', [$shortcode, 'registerScriptsAndStylesheets'], 10);
-                    add_action('wp_enqueue_scripts', [$shortcode, 'enqueueStylesheets'], 11);
-                }
-                // add_shortcode() if it has not already been added
-                if (! shortcode_exists($shortcode->getTag())) {
-                    add_shortcode($shortcode->getTag(), [$shortcode, 'processShortcodeCallback']);
-                }
-            }
-            $this->legacy_shortcodes_manager->addShortcodes();
-        } catch (Exception $exception) {
-            new ExceptionStackTraceDisplay($exception);
-        }
-    }
-
-
-    /**
-     * callback for the "template_redirect" hook point
-     * checks posts for EE shortcodes, and initializes them,
-     * then toggles filter switch that loads core default assets
-     *
-     * @return void
-     */
-    public function templateRedirect()
-    {
-        global $wp_query;
-        if (empty($wp_query->posts)) {
-            return;
-        }
-        $load_assets = false;
-        // array of posts displayed in current request
-        $posts = is_array($wp_query->posts) ? $wp_query->posts : [$wp_query->posts];
-        foreach ($posts as $post) {
-            // now check post content and excerpt for EE shortcodes
-            $load_assets = $this->parseContentForShortcodes($post->post_content)
-                ? true
-                : $load_assets;
-        }
-        if ($load_assets) {
-            $this->current_page->setEspressoPage(true);
-            add_filter('FHEE_load_css', '__return_true');
-            add_filter('FHEE_load_js', '__return_true');
-        }
-    }
-
-
-    /**
-     * checks supplied content against list of shortcodes,
-     * then initializes any found shortcodes, and returns true.
-     * returns false if no shortcodes found.
-     *
-     * @param string $content
-     * @return bool
-     */
-    public function parseContentForShortcodes($content)
-    {
-        if (empty($this->shortcodes)) {
-            return false;
-        }
-        $has_shortcode = false;
-        foreach ($this->shortcodes as $shortcode) {
-            if (has_shortcode($content, $shortcode->getTag())) {
-                $shortcode->initializeShortcode();
-                $has_shortcode = true;
-            }
-        }
-        return $has_shortcode;
-    }
+	/**
+	 * @type CurrentPage
+	 */
+	protected $current_page;
+
+	/**
+	 * @var LegacyShortcodesManager $legacy_shortcodes_manager
+	 */
+	private $legacy_shortcodes_manager;
+
+	/**
+	 * @var ShortcodeInterface[] $shortcodes
+	 */
+	private $shortcodes;
+
+
+	/**
+	 * ShortcodesManager constructor
+	 *
+	 * @param LegacyShortcodesManager $legacy_shortcodes_manager
+	 * @param CurrentPage             $current_page
+	 */
+	public function __construct(LegacyShortcodesManager $legacy_shortcodes_manager, CurrentPage $current_page)
+	{
+		$this->legacy_shortcodes_manager = $legacy_shortcodes_manager;
+		$this->current_page              = $current_page;
+		// assemble a list of installed and active shortcodes
+		add_action(
+			'AHEE__EE_System__register_shortcodes_modules_and_widgets',
+			[$this, 'registerShortcodes'],
+			999
+		);
+		//  call add_shortcode() for all installed shortcodes
+		add_action('AHEE__EE_System__core_loaded_and_ready', [$this, 'addShortcodes']);
+		// check content for shortcodes the old way
+		add_action('parse_query', [$this->legacy_shortcodes_manager, 'initializeShortcodes'], 5);
+		// check content for shortcodes the NEW more efficient way
+		add_action('template_redirect', [$this, 'templateRedirect'], 999);
+	}
+
+
+	/**
+	 * @return CollectionInterface|ShortcodeInterface[]
+	 * @throws InvalidIdentifierException
+	 * @throws InvalidInterfaceException
+	 * @throws InvalidFilePathException
+	 * @throws InvalidEntityException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidClassException
+	 */
+	public function getShortcodes()
+	{
+		if (! $this->shortcodes instanceof CollectionInterface) {
+			$this->shortcodes = $this->loadShortcodesCollection();
+		}
+		return $this->shortcodes;
+	}
+
+
+	/**
+	 * @return CollectionInterface|ShortcodeInterface[]
+	 * @throws InvalidIdentifierException
+	 * @throws InvalidInterfaceException
+	 * @throws InvalidFilePathException
+	 * @throws InvalidEntityException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidClassException
+	 */
+	protected function loadShortcodesCollection()
+	{
+		$loader = new CollectionLoader(
+			new CollectionDetails(
+			// collection name
+				'shortcodes',
+				// collection interface
+				'EventEspresso\core\services\shortcodes\ShortcodeInterface',
+				// FQCNs for classes to add (all classes within that namespace will be loaded)
+				['EventEspresso\core\domain\entities\shortcodes'],
+				// filepaths to classes to add
+				[],
+				// file mask to use if parsing folder for files to add
+				'',
+				// what to use as identifier for collection entities
+				// using CLASS NAME prevents duplicates (works like a singleton)
+				CollectionDetails::ID_CLASS_NAME
+			)
+		);
+		return $loader->getCollection();
+	}
+
+
+	/**
+	 * @return void
+	 * @throws DomainException
+	 * @throws InvalidInterfaceException
+	 * @throws InvalidIdentifierException
+	 * @throws InvalidFilePathException
+	 * @throws InvalidEntityException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidClassException
+	 * @throws Exception
+	 */
+	public function registerShortcodes()
+	{
+		try {
+			$this->shortcodes = apply_filters(
+				'FHEE__EventEspresso_core_services_shortcodes_ShortcodesManager__registerShortcodes__shortcode_collection',
+				$this->getShortcodes()
+			);
+			if (! $this->shortcodes instanceof CollectionInterface) {
+				throw new InvalidEntityException(
+					$this->shortcodes,
+					'CollectionInterface',
+					sprintf(
+						esc_html__(
+							'The "FHEE__EventEspresso_core_services_shortcodes_ShortcodesManager__registerShortcodes__shortcode_collection" filter must return a Collection of EspressoShortcode objects. "%1$s" was received instead.',
+							'event_espresso'
+						),
+						is_object($this->shortcodes) ? get_class($this->shortcodes) : gettype($this->shortcodes)
+					)
+				);
+			}
+			$this->legacy_shortcodes_manager->registerShortcodes();
+		} catch (Exception $exception) {
+			new ExceptionStackTraceDisplay($exception);
+		}
+	}
+
+
+	/**
+	 * @return void
+	 * @throws Exception
+	 */
+	public function addShortcodes()
+	{
+		try {
+			// cycle thru shortcode folders
+			foreach ($this->shortcodes as $shortcode) {
+				if ($shortcode instanceof EnqueueAssetsInterface) {
+					add_action('wp_enqueue_scripts', [$shortcode, 'registerScriptsAndStylesheets'], 10);
+					add_action('wp_enqueue_scripts', [$shortcode, 'enqueueStylesheets'], 11);
+				}
+				// add_shortcode() if it has not already been added
+				if (! shortcode_exists($shortcode->getTag())) {
+					add_shortcode($shortcode->getTag(), [$shortcode, 'processShortcodeCallback']);
+				}
+			}
+			$this->legacy_shortcodes_manager->addShortcodes();
+		} catch (Exception $exception) {
+			new ExceptionStackTraceDisplay($exception);
+		}
+	}
+
+
+	/**
+	 * callback for the "template_redirect" hook point
+	 * checks posts for EE shortcodes, and initializes them,
+	 * then toggles filter switch that loads core default assets
+	 *
+	 * @return void
+	 */
+	public function templateRedirect()
+	{
+		global $wp_query;
+		if (empty($wp_query->posts)) {
+			return;
+		}
+		$load_assets = false;
+		// array of posts displayed in current request
+		$posts = is_array($wp_query->posts) ? $wp_query->posts : [$wp_query->posts];
+		foreach ($posts as $post) {
+			// now check post content and excerpt for EE shortcodes
+			$load_assets = $this->parseContentForShortcodes($post->post_content)
+				? true
+				: $load_assets;
+		}
+		if ($load_assets) {
+			$this->current_page->setEspressoPage(true);
+			add_filter('FHEE_load_css', '__return_true');
+			add_filter('FHEE_load_js', '__return_true');
+		}
+	}
+
+
+	/**
+	 * checks supplied content against list of shortcodes,
+	 * then initializes any found shortcodes, and returns true.
+	 * returns false if no shortcodes found.
+	 *
+	 * @param string $content
+	 * @return bool
+	 */
+	public function parseContentForShortcodes($content)
+	{
+		if (empty($this->shortcodes)) {
+			return false;
+		}
+		$has_shortcode = false;
+		foreach ($this->shortcodes as $shortcode) {
+			if (has_shortcode($content, $shortcode->getTag())) {
+				$shortcode->initializeShortcode();
+				$has_shortcode = true;
+			}
+		}
+		return $has_shortcode;
+	}
 }