eventespresso / event-espresso-core

core/domain/services/admin/events/editor/FormBuilder.php

Spacing +2 added lines, -2 removed lines

@@ -55,7 +55,7 @@ 
                 $UUID = $section->UUID();
 
                 // Avoid duplicates, if any
-                $sections[ $UUID ] = [
+                $sections[$UUID] = [
                     'id'         => $UUID,
                     'appliesTo'  => GQLUtils::formatEnumKey($section->appliesTo()),
                     'attributes' => $section->attributes()->toJson(),
@@ -85,7 +85,7 @@ 
                 $UUID = $element->UUID();
 
             // Avoid duplicates
-                $elements[ $UUID ] = [
+                $elements[$UUID] = [
                 'id'         => $UUID,
                 'adminOnly'  => $element->adminOnly(),
                 'attributes' => $element->attributes()->toJson(),

Indentation +76 added lines, -76 removed lines

@@ -23,87 +23,87 @@
  */
 class FormBuilder implements EventEditorDataInterface
 {
-    /**
-     * @param int $eventId
-     * @return array
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    public function getData(int $eventId): array
-    {
-        /** @var EE_Event $event */
-        $event = EEM_Event::instance()->get_one_by_ID($eventId);
-        $topLevelSectionId = $event->registrationFormUuid();
+	/**
+	 * @param int $eventId
+	 * @return array
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	public function getData(int $eventId): array
+	{
+		/** @var EE_Event $event */
+		$event = EEM_Event::instance()->get_one_by_ID($eventId);
+		$topLevelSectionId = $event->registrationFormUuid();
 
-        /** @var EE_Form_Section[] $form_sections */
-        $form_sections = EEM_Form_Section::instance()->get_all([
-            [
-                'OR' => [
-                    'FSC_UUID'      => $topLevelSectionId, // top level form
-                    'FSC_belongsTo' => $topLevelSectionId, // child form sections
-                    'FSC_status'    => FormStatus::SHARED, // shared form sections
-                ]
-                ],
-            'order_by' => ['FSC_order' => 'ASC'],
-        ]);
+		/** @var EE_Form_Section[] $form_sections */
+		$form_sections = EEM_Form_Section::instance()->get_all([
+			[
+				'OR' => [
+					'FSC_UUID'      => $topLevelSectionId, // top level form
+					'FSC_belongsTo' => $topLevelSectionId, // child form sections
+					'FSC_status'    => FormStatus::SHARED, // shared form sections
+				]
+				],
+			'order_by' => ['FSC_order' => 'ASC'],
+		]);
 
-        $sections = [];
-        foreach ($form_sections as $section) {
-            if ($section instanceof EE_Form_Section) {
-                $UUID = $section->UUID();
+		$sections = [];
+		foreach ($form_sections as $section) {
+			if ($section instanceof EE_Form_Section) {
+				$UUID = $section->UUID();
 
-                // Avoid duplicates, if any
-                $sections[ $UUID ] = [
-                    'id'         => $UUID,
-                    'appliesTo'  => GQLUtils::formatEnumKey($section->appliesTo()),
-                    'attributes' => $section->attributes()->toJson(),
-                    'belongsTo'  => $section->belongsTo(),
-                    'isActive'   => $section->isActive(),
-                    'isArchived' => $section->isArchived(),
-                    'isDefault'  => $section->isDefault(),
-                    'isShared'   => $section->isShared(),
-                    'isTrashed'  => $section->isTrashed(),
-                    'label'      => $section->label()->toJson(),
-                    'order'      => $section->order(),
-                    'status'     => GQLUtils::formatEnumKey($section->status()),
-                ];
-            }
-        }
+				// Avoid duplicates, if any
+				$sections[ $UUID ] = [
+					'id'         => $UUID,
+					'appliesTo'  => GQLUtils::formatEnumKey($section->appliesTo()),
+					'attributes' => $section->attributes()->toJson(),
+					'belongsTo'  => $section->belongsTo(),
+					'isActive'   => $section->isActive(),
+					'isArchived' => $section->isArchived(),
+					'isDefault'  => $section->isDefault(),
+					'isShared'   => $section->isShared(),
+					'isTrashed'  => $section->isTrashed(),
+					'label'      => $section->label()->toJson(),
+					'order'      => $section->order(),
+					'status'     => GQLUtils::formatEnumKey($section->status()),
+				];
+			}
+		}
 
-        /** @var EE_Form_Element[] $form_elements */
-        $form_elements = EEM_Form_Element::instance()->get_all([
-            [
-                'FSC_UUID' => ['IN', array_keys($sections)]
-            ]
-        ]);
+		/** @var EE_Form_Element[] $form_elements */
+		$form_elements = EEM_Form_Element::instance()->get_all([
+			[
+				'FSC_UUID' => ['IN', array_keys($sections)]
+			]
+		]);
 
-        $elements = [];
-        foreach ($form_elements as $element) {
-            if ($element instanceof EE_Form_Element) {
-                $UUID = $element->UUID();
+		$elements = [];
+		foreach ($form_elements as $element) {
+			if ($element instanceof EE_Form_Element) {
+				$UUID = $element->UUID();
 
-            // Avoid duplicates
-                $elements[ $UUID ] = [
-                'id'         => $UUID,
-                'adminOnly'  => $element->adminOnly(),
-                'attributes' => $element->attributes()->toJson(),
-                'belongsTo'  => $element->belongsTo(),
-                'helpText'   => $element->helpText()->toJson(),
-                'label'      => $element->label()->toJson(),
-                'mapsTo'     => $element->mapsTo(),
-                'options'    => $element->options()->toJson(),
-                'order'      => $element->order(),
-                'required'   => $element->required()->toJson(),
-                'status'     => GQLUtils::formatEnumKey($element->status()),
-                'type'       => GQLUtils::formatEnumKey($element->type()),
-                ];
-            }
-        }
+			// Avoid duplicates
+				$elements[ $UUID ] = [
+				'id'         => $UUID,
+				'adminOnly'  => $element->adminOnly(),
+				'attributes' => $element->attributes()->toJson(),
+				'belongsTo'  => $element->belongsTo(),
+				'helpText'   => $element->helpText()->toJson(),
+				'label'      => $element->label()->toJson(),
+				'mapsTo'     => $element->mapsTo(),
+				'options'    => $element->options()->toJson(),
+				'order'      => $element->order(),
+				'required'   => $element->required()->toJson(),
+				'status'     => GQLUtils::formatEnumKey($element->status()),
+				'type'       => GQLUtils::formatEnumKey($element->type()),
+				];
+			}
+		}
 
-        return [
-            'elements'          => array_values($elements),
-            'sections'          => array_values($sections),
-            'topLevelSectionId' => $event->registrationFormUuid()
-        ];
-    }
+		return [
+			'elements'          => array_values($elements),
+			'sections'          => array_values($sections),
+			'topLevelSectionId' => $event->registrationFormUuid()
+		];
+	}
 }

core/services/form/meta/inputs/Text.php

Indentation +47 added lines, -47 removed lines

@@ -4,61 +4,61 @@
 
 class Text
 {
-    /**
-     * indicates that the HTML input type is 'email'
-     */
-    public const TYPE_EMAIL = 'email';
+	/**
+	 * indicates that the HTML input type is 'email'
+	 */
+	public const TYPE_EMAIL = 'email';
 
-    /**
-     * indicates that the input is used to confirm an email address
-     */
-    public const TYPE_EMAIL_CONFIRMATION = 'email-confirmation';
+	/**
+	 * indicates that the input is used to confirm an email address
+	 */
+	public const TYPE_EMAIL_CONFIRMATION = 'email-confirmation';
 
-    /**
-     * indicates that the HTML input type is 'text'
-     */
-    public const TYPE_TEXT = 'text';
+	/**
+	 * indicates that the HTML input type is 'text'
+	 */
+	public const TYPE_TEXT = 'text';
 
-    /**
-     * indicates that the input is a TEXTAREA that only allows plain text
-     */
-    public const TYPE_TEXTAREA = 'textarea';
+	/**
+	 * indicates that the input is a TEXTAREA that only allows plain text
+	 */
+	public const TYPE_TEXTAREA = 'textarea';
 
-    /**
-     * indicates that the input is a TEXTAREA that allows simple html
-     */
-    public const TYPE_TEXTAREA_HTML = 'textarea-html';
+	/**
+	 * indicates that the input is a TEXTAREA that allows simple html
+	 */
+	public const TYPE_TEXTAREA_HTML = 'textarea-html';
 
 
-    /**
-     * @var array
-     */
-    private $valid_type_options;
+	/**
+	 * @var array
+	 */
+	private $valid_type_options;
 
 
-    public function __construct()
-    {
-        $this->valid_type_options = apply_filters(
-            'FHEE__EventEspresso_core_services_form_meta_inputs_Text__valid_type_options',
-            [
-                Text::TYPE_EMAIL              => esc_html__('Email', 'event_espresso'),
-                Text::TYPE_EMAIL_CONFIRMATION => esc_html__('Email Confirmation', 'event_espresso'),
-                Text::TYPE_TEXT               => esc_html__('Plain Text', 'event_espresso'),
-                Text::TYPE_TEXTAREA           => esc_html__('Plain Textarea', 'event_espresso'),
-                Text::TYPE_TEXTAREA_HTML      => esc_html__('Simple HTML Textarea', 'event_espresso'),
-            ]
-        );
-    }
+	public function __construct()
+	{
+		$this->valid_type_options = apply_filters(
+			'FHEE__EventEspresso_core_services_form_meta_inputs_Text__valid_type_options',
+			[
+				Text::TYPE_EMAIL              => esc_html__('Email', 'event_espresso'),
+				Text::TYPE_EMAIL_CONFIRMATION => esc_html__('Email Confirmation', 'event_espresso'),
+				Text::TYPE_TEXT               => esc_html__('Plain Text', 'event_espresso'),
+				Text::TYPE_TEXTAREA           => esc_html__('Plain Textarea', 'event_espresso'),
+				Text::TYPE_TEXTAREA_HTML      => esc_html__('Simple HTML Textarea', 'event_espresso'),
+			]
+		);
+	}
 
 
-    /**
-     * @param bool $constants_only
-     * @return array
-     */
-    public function validTypeOptions(bool $constants_only = false): array
-    {
-        return $constants_only
-            ? array_keys($this->valid_type_options)
-            : $this->valid_type_options;
-    }
+	/**
+	 * @param bool $constants_only
+	 * @return array
+	 */
+	public function validTypeOptions(bool $constants_only = false): array
+	{
+		return $constants_only
+			? array_keys($this->valid_type_options)
+			: $this->valid_type_options;
+	}
 }

core/services/form/meta/inputs/Input.php

Indentation +86 added lines, -86 removed lines

@@ -5,90 +5,90 @@
 class Input
 {
 
-    /**
-     * indicates that the HTML input type is 'checkbox'
-     */
-    public const TYPE_CHECKBOX = 'checkbox';
-
-    /**
-     * indicates that the HTML input type is 'multi checkbox'
-     */
-    public const TYPE_CHECKBOX_MULTI = 'checkbox-multi';
-
-    /**
-     * indicates that the HTML input type is 'color'
-     */
-    public const TYPE_COLOR = 'color';
-
-    /**
-     * indicates that the HTML input type is 'file'
-     */
-    public const TYPE_FILE = 'file';
-
-    /**
-     * indicates that the HTML input type is 'hidden'
-     */
-    public const TYPE_HIDDEN = 'hidden';
-
-    /**
-     * indicates that the HTML input type is 'image'
-     */
-    public const TYPE_IMAGE = 'image';
-
-    /**
-     * indicates that the HTML input type is 'password'
-     */
-    public const TYPE_PASSWORD = 'password';
-
-    /**
-     * indicates that the input is used to confirm a password
-     */
-    public const TYPE_PASSWORD_CONFIRMATION = 'password-confirmation';
-
-    /**
-     * indicates that the HTML input type is 'radio'
-     */
-    public const TYPE_RADIO = 'radio';
-
-    /**
-     * indicates that the HTML input type is 'url'
-     */
-    public const TYPE_URL = 'url';
-
-    /**
-     * @var array
-     */
-    private $valid_type_options;
-
-
-    public function __construct()
-    {
-        $this->valid_type_options = apply_filters(
-            'FHEE__EventEspresso_core_services_form_meta_inputs_Input__valid_type_options',
-            [
-                Input::TYPE_CHECKBOX              => esc_html__('Checkbox', 'event_espresso'),
-                Input::TYPE_CHECKBOX_MULTI        => esc_html__('Multi Checkbox', 'event_espresso'),
-                Input::TYPE_COLOR                 => esc_html__('Color Picker', 'event_espresso'),
-                Input::TYPE_FILE                  => esc_html__('File Upload', 'event_espresso'),
-                Input::TYPE_HIDDEN                => esc_html__('Hidden', 'event_espresso'),
-                Input::TYPE_IMAGE                 => esc_html__('Image Upload', 'event_espresso'),
-                Input::TYPE_PASSWORD              => esc_html__('Password', 'event_espresso'),
-                Input::TYPE_PASSWORD_CONFIRMATION => esc_html__('Password Confirmation', 'event_espresso'),
-                Input::TYPE_RADIO                 => esc_html__('Radio Button', 'event_espresso'),
-                Input::TYPE_URL                   => esc_html__('URL', 'event_espresso'),
-            ]
-        );
-    }
-
-
-    /**
-     * @param bool $constants_only
-     * @return array
-     */
-    public function validTypeOptions(bool $constants_only = false): array
-    {
-        return $constants_only
-            ? array_keys($this->valid_type_options)
-            : $this->valid_type_options;
-    }
+	/**
+	 * indicates that the HTML input type is 'checkbox'
+	 */
+	public const TYPE_CHECKBOX = 'checkbox';
+
+	/**
+	 * indicates that the HTML input type is 'multi checkbox'
+	 */
+	public const TYPE_CHECKBOX_MULTI = 'checkbox-multi';
+
+	/**
+	 * indicates that the HTML input type is 'color'
+	 */
+	public const TYPE_COLOR = 'color';
+
+	/**
+	 * indicates that the HTML input type is 'file'
+	 */
+	public const TYPE_FILE = 'file';
+
+	/**
+	 * indicates that the HTML input type is 'hidden'
+	 */
+	public const TYPE_HIDDEN = 'hidden';
+
+	/**
+	 * indicates that the HTML input type is 'image'
+	 */
+	public const TYPE_IMAGE = 'image';
+
+	/**
+	 * indicates that the HTML input type is 'password'
+	 */
+	public const TYPE_PASSWORD = 'password';
+
+	/**
+	 * indicates that the input is used to confirm a password
+	 */
+	public const TYPE_PASSWORD_CONFIRMATION = 'password-confirmation';
+
+	/**
+	 * indicates that the HTML input type is 'radio'
+	 */
+	public const TYPE_RADIO = 'radio';
+
+	/**
+	 * indicates that the HTML input type is 'url'
+	 */
+	public const TYPE_URL = 'url';
+
+	/**
+	 * @var array
+	 */
+	private $valid_type_options;
+
+
+	public function __construct()
+	{
+		$this->valid_type_options = apply_filters(
+			'FHEE__EventEspresso_core_services_form_meta_inputs_Input__valid_type_options',
+			[
+				Input::TYPE_CHECKBOX              => esc_html__('Checkbox', 'event_espresso'),
+				Input::TYPE_CHECKBOX_MULTI        => esc_html__('Multi Checkbox', 'event_espresso'),
+				Input::TYPE_COLOR                 => esc_html__('Color Picker', 'event_espresso'),
+				Input::TYPE_FILE                  => esc_html__('File Upload', 'event_espresso'),
+				Input::TYPE_HIDDEN                => esc_html__('Hidden', 'event_espresso'),
+				Input::TYPE_IMAGE                 => esc_html__('Image Upload', 'event_espresso'),
+				Input::TYPE_PASSWORD              => esc_html__('Password', 'event_espresso'),
+				Input::TYPE_PASSWORD_CONFIRMATION => esc_html__('Password Confirmation', 'event_espresso'),
+				Input::TYPE_RADIO                 => esc_html__('Radio Button', 'event_espresso'),
+				Input::TYPE_URL                   => esc_html__('URL', 'event_espresso'),
+			]
+		);
+	}
+
+
+	/**
+	 * @param bool $constants_only
+	 * @return array
+	 */
+	public function validTypeOptions(bool $constants_only = false): array
+	{
+		return $constants_only
+			? array_keys($this->valid_type_options)
+			: $this->valid_type_options;
+	}
 }

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/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 +217 added lines, -217 removed lines

@@ -31,221 +31,221 @@
  */
 class ShortcodesManager
 {
-    protected CurrentPage $current_page;
-
-    private LegacyShortcodesManager $legacy_shortcodes_manager;
-
-    /**
-     * @var CollectionInterface|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;
-    }
-
-
-    public function setHooks()
-    {
-        // 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
-     * @throws Throwable
-     */
-    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
-     * @throws Throwable
-     */
-    public function addShortcodes()
-    {
-        try {
-            // cycle thru shortcode folders
-            foreach ($this->shortcodes as $shortcode) {
-                if ($shortcode instanceof EnqueueAssetsInterface) {
-                    add_action('wp_enqueue_scripts', [$shortcode, 'registerScriptsAndStylesheets']);
-                    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
-            // and typcast to string despite WP_Post object typehint because it is not always correct
-            $load_assets = $this->parseContentForShortcodes((string) $post->post_content, $post)
-                ? 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
-     * @param WP_Post $post
-     * @return bool
-     */
-    public function parseContentForShortcodes(string $content, WP_Post $post): bool
-    {
-        if (empty($this->shortcodes)) {
-            return false;
-        }
-        $has_shortcode = false;
-        foreach ($this->shortcodes as $shortcode) {
-            if (
-                apply_filters(
-                    'FHEE__EventEspresso_core_services_shortcodes_ShortcodesManager__parseContentForShortcodes__has_shortcode',
-                    has_shortcode($content, $shortcode->getTag()),
-                    $content,
-                    $post,
-                    $shortcode
-                )
-            ) {
-                $shortcode->initializeShortcode();
-                $has_shortcode = true;
-            }
-        }
-        return $has_shortcode;
-    }
+	protected CurrentPage $current_page;
+
+	private LegacyShortcodesManager $legacy_shortcodes_manager;
+
+	/**
+	 * @var CollectionInterface|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;
+	}
+
+
+	public function setHooks()
+	{
+		// 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
+	 * @throws Throwable
+	 */
+	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
+	 * @throws Throwable
+	 */
+	public function addShortcodes()
+	{
+		try {
+			// cycle thru shortcode folders
+			foreach ($this->shortcodes as $shortcode) {
+				if ($shortcode instanceof EnqueueAssetsInterface) {
+					add_action('wp_enqueue_scripts', [$shortcode, 'registerScriptsAndStylesheets']);
+					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
+			// and typcast to string despite WP_Post object typehint because it is not always correct
+			$load_assets = $this->parseContentForShortcodes((string) $post->post_content, $post)
+				? 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
+	 * @param WP_Post $post
+	 * @return bool
+	 */
+	public function parseContentForShortcodes(string $content, WP_Post $post): bool
+	{
+		if (empty($this->shortcodes)) {
+			return false;
+		}
+		$has_shortcode = false;
+		foreach ($this->shortcodes as $shortcode) {
+			if (
+				apply_filters(
+					'FHEE__EventEspresso_core_services_shortcodes_ShortcodesManager__parseContentForShortcodes__has_shortcode',
+					has_shortcode($content, $shortcode->getTag()),
+					$content,
+					$post,
+					$shortcode
+				)
+			) {
+				$shortcode->initializeShortcode();
+				$has_shortcode = true;
+			}
+		}
+		return $has_shortcode;
+	}
 }

core/libraries/iframe_display/Iframe.php

Spacing +22 added lines, -22 removed lines

@@ -83,7 +83,7 @@ 
     public function __construct($title, $content)
     {
         global $wp_version;
-        if (! defined('EE_IFRAME_DIR_URL')) {
+        if ( ! defined('EE_IFRAME_DIR_URL')) {
             define('EE_IFRAME_DIR_URL', plugin_dir_url(__FILE__));
         }
         $this->setContent($content);
@@ -93,10 +93,10 @@ 
                 'FHEE___EventEspresso_core_libraries_iframe_display_Iframe__construct__default_css',
                 array(
                     'site_theme'       => get_stylesheet_directory_uri()
-                                          . '/style.css?ver=' . EVENT_ESPRESSO_VERSION,
-                    'dashicons'        => includes_url('css/dashicons.min.css?ver=' . $wp_version),
+                                          . '/style.css?ver='.EVENT_ESPRESSO_VERSION,
+                    'dashicons'        => includes_url('css/dashicons.min.css?ver='.$wp_version),
                     'espresso_default' => EE_GLOBAL_ASSETS_URL
-                                          . 'css/espresso_default.css?ver=' . EVENT_ESPRESSO_VERSION,
+                                          . 'css/espresso_default.css?ver='.EVENT_ESPRESSO_VERSION,
                 ),
                 $this
             )
@@ -105,9 +105,9 @@ 
             apply_filters(
                 'FHEE___EventEspresso_core_libraries_iframe_display_Iframe__construct__default_js',
                 array(
-                    'jquery'        => includes_url('js/jquery/jquery.js?ver=' . $wp_version),
+                    'jquery'        => includes_url('js/jquery/jquery.js?ver='.$wp_version),
                     'espresso_core' => EE_GLOBAL_ASSETS_URL
-                                       . 'scripts/espresso_core.js?ver=' . EVENT_ESPRESSO_VERSION,
+                                       . 'scripts/espresso_core.js?ver='.EVENT_ESPRESSO_VERSION,
                 ),
                 $this
             )
@@ -181,7 +181,7 @@ 
             );
         }
         foreach ($stylesheets as $handle => $stylesheet) {
-            $this->css[ $handle ] = $stylesheet;
+            $this->css[$handle] = $stylesheet;
         }
     }
 
@@ -203,9 +203,9 @@ 
         }
         foreach ($scripts as $handle => $script) {
             if ($add_to_header) {
-                $this->header_js[ $handle ] = $script;
+                $this->header_js[$handle] = $script;
             } else {
-                $this->footer_js[ $handle ] = $script;
+                $this->footer_js[$handle] = $script;
             }
         }
     }
@@ -228,9 +228,9 @@ 
         }
         foreach ($script_attributes as $handle => $script_attribute) {
             if ($add_to_header) {
-                $this->header_js_attributes[ $handle ] = $script_attribute;
+                $this->header_js_attributes[$handle] = $script_attribute;
             } else {
-                $this->footer_js_attributes[ $handle ] = $script_attribute;
+                $this->footer_js_attributes[$handle] = $script_attribute;
             }
         }
     }
@@ -253,14 +253,14 @@ 
         }
         foreach ($vars as $handle => $var) {
             if ($var_name === 'eei18n') {
-                EE_Registry::$i18n_js_strings[ $handle ] = $var;
+                EE_Registry::$i18n_js_strings[$handle] = $var;
             } elseif ($var_name === 'eeCAL' && $handle === 'espresso_calendar') {
-                $this->localized_vars[ $var_name ] = $var;
+                $this->localized_vars[$var_name] = $var;
             } else {
-                if (! isset($this->localized_vars[ $var_name ])) {
-                    $this->localized_vars[ $var_name ] = array();
+                if ( ! isset($this->localized_vars[$var_name])) {
+                    $this->localized_vars[$var_name] = array();
                 }
-                $this->localized_vars[ $var_name ][ $handle ] = $var;
+                $this->localized_vars[$var_name][$handle] = $var;
             }
         }
     }
@@ -290,7 +290,7 @@ 
     public function getTemplate()
     {
         return EEH_Template::display_template(
-            __DIR__ . DIRECTORY_SEPARATOR . 'iframe_wrapper.template.php',
+            __DIR__.DIRECTORY_SEPARATOR.'iframe_wrapper.template.php',
             array(
                 'title'                => apply_filters(
                     'FHEE___EventEspresso_core_libraries_iframe_display_Iframe__getTemplate__title',
@@ -334,11 +334,11 @@ 
                 ),
                 'eei18n'               => apply_filters(
                     'FHEE___EventEspresso_core_libraries_iframe_display_Iframe__getTemplate__eei18n_js_strings',
-                    EE_Registry::localize_i18n_js_strings() . $this->localizeJsonVars(),
+                    EE_Registry::localize_i18n_js_strings().$this->localizeJsonVars(),
                     $this
                 ),
                 'notices'              => EEH_Template::display_template(
-                    EE_TEMPLATES . 'espresso-ajax-notices.template.php',
+                    EE_TEMPLATES.'espresso-ajax-notices.template.php',
                     array(),
                     true
                 ),
@@ -358,9 +358,9 @@ 
     {
         $JSON = '';
         foreach ($this->localized_vars as $var_name => $vars) {
-            $this->localized_vars[ $var_name ] = $this->encodeJsonVars($vars);
+            $this->localized_vars[$var_name] = $this->encodeJsonVars($vars);
             $JSON .= "/* <![CDATA[ */ var {$var_name} = ";
-            $JSON .= wp_json_encode($this->localized_vars[ $var_name ]);
+            $JSON .= wp_json_encode($this->localized_vars[$var_name]);
             $JSON .= '; /* ]]> */';
         }
         return $JSON;
@@ -376,7 +376,7 @@ 
         if (is_array($var)) {
             $localized_vars = array();
             foreach ((array) $var as $key => $value) {
-                $localized_vars[ $key ] = $this->encodeJsonVars($value);
+                $localized_vars[$key] = $this->encodeJsonVars($value);
             }
             return $localized_vars;
         }

Indentation +334 added lines, -334 removed lines

@@ -18,373 +18,373 @@
  */
 class Iframe
 {
-    /*
+	/*
     * HTML for notices and ajax gif
     * @var string $title
     */
-    protected $title = '';
+	protected $title = '';
 
-    /*
+	/*
     * HTML for the content being displayed
     * @var string $content
     */
-    protected $content = '';
+	protected $content = '';
 
-    /*
+	/*
     * whether or not to call wp_head() and wp_footer()
     * @var boolean $enqueue_wp_assets
     */
-    protected $enqueue_wp_assets = false;
+	protected $enqueue_wp_assets = false;
 
-    /*
+	/*
     * an array of CSS URLs
     * @var array $css
     */
-    protected $css = array();
+	protected $css = array();
 
-    /*
+	/*
     * an array of JS URLs to be set in the HTML header.
     * @var array $header_js
     */
-    protected $header_js = array();
+	protected $header_js = array();
 
-    /*
+	/*
     * an array of additional attributes to be added to <script> tags for header JS
     * @var array $footer_js
     */
-    protected $header_js_attributes = array();
+	protected $header_js_attributes = array();
 
-    /*
+	/*
     * an array of JS URLs to be displayed before the HTML </body> tag
     * @var array $footer_js
     */
-    protected $footer_js = array();
+	protected $footer_js = array();
 
-    /*
+	/*
     * an array of additional attributes to be added to <script> tags for footer JS
     * @var array $footer_js_attributes
     */
-    protected $footer_js_attributes = array();
+	protected $footer_js_attributes = array();
 
-    /*
+	/*
     * an array of JSON vars to be set in the HTML header.
     * @var array $localized_vars
     */
-    protected $localized_vars = array();
-
-
-    /**
-     * Iframe constructor
-     *
-     * @param string $title
-     * @param string $content
-     * @throws DomainException
-     */
-    public function __construct($title, $content)
-    {
-        global $wp_version;
-        if (! defined('EE_IFRAME_DIR_URL')) {
-            define('EE_IFRAME_DIR_URL', plugin_dir_url(__FILE__));
-        }
-        $this->setContent($content);
-        $this->setTitle($title);
-        $this->addStylesheets(
-            apply_filters(
-                'FHEE___EventEspresso_core_libraries_iframe_display_Iframe__construct__default_css',
-                array(
-                    'site_theme'       => get_stylesheet_directory_uri()
-                                          . '/style.css?ver=' . EVENT_ESPRESSO_VERSION,
-                    'dashicons'        => includes_url('css/dashicons.min.css?ver=' . $wp_version),
-                    'espresso_default' => EE_GLOBAL_ASSETS_URL
-                                          . 'css/espresso_default.css?ver=' . EVENT_ESPRESSO_VERSION,
-                ),
-                $this
-            )
-        );
-        $this->addScripts(
-            apply_filters(
-                'FHEE___EventEspresso_core_libraries_iframe_display_Iframe__construct__default_js',
-                array(
-                    'jquery'        => includes_url('js/jquery/jquery.js?ver=' . $wp_version),
-                    'espresso_core' => EE_GLOBAL_ASSETS_URL
-                                       . 'scripts/espresso_core.js?ver=' . EVENT_ESPRESSO_VERSION,
-                ),
-                $this
-            )
-        );
-        if (
-            apply_filters(
-                'FHEE___EventEspresso_core_libraries_iframe_display_Iframe__construct__load_default_theme_stylesheet',
-                false
-            )
-        ) {
-            $this->addStylesheets(
-                apply_filters(
-                    'FHEE___EventEspresso_core_libraries_iframe_display_Iframe__construct__default_theme_stylesheet',
-                    array('default_theme_stylesheet' => get_stylesheet_uri()),
-                    $this
-                )
-            );
-        }
-    }
-
-
-    /**
-     * @param string $title
-     * @throws DomainException
-     */
-    public function setTitle($title)
-    {
-        if (empty($title)) {
-            throw new DomainException(
-                esc_html__('You must provide a page title in order to create an iframe.', 'event_espresso')
-            );
-        }
-        $this->title = $title;
-    }
-
-
-    /**
-     * @param string $content
-     * @throws DomainException
-     */
-    public function setContent($content)
-    {
-        if (empty($content)) {
-            throw new DomainException(
-                esc_html__('You must provide content in order to create an iframe.', 'event_espresso')
-            );
-        }
-        $this->content = $content;
-    }
-
-
-    /**
-     * @param boolean $enqueue_wp_assets
-     */
-    public function setEnqueueWpAssets($enqueue_wp_assets)
-    {
-        $this->enqueue_wp_assets = filter_var($enqueue_wp_assets, FILTER_VALIDATE_BOOLEAN);
-    }
-
-
-    /**
-     * @param array $stylesheets
-     * @throws DomainException
-     */
-    public function addStylesheets(array $stylesheets)
-    {
-        if (empty($stylesheets)) {
-            throw new DomainException(
-                esc_html__(
-                    'A non-empty array of URLs, is required to add a CSS stylesheet to an iframe.',
-                    'event_espresso'
-                )
-            );
-        }
-        foreach ($stylesheets as $handle => $stylesheet) {
-            $this->css[ $handle ] = $stylesheet;
-        }
-    }
-
-
-    /**
-     * @param array $scripts
-     * @param bool  $add_to_header
-     * @throws DomainException
-     */
-    public function addScripts(array $scripts, $add_to_header = false)
-    {
-        if (empty($scripts)) {
-            throw new DomainException(
-                esc_html__(
-                    'A non-empty array of URLs, is required to add Javascript to an iframe.',
-                    'event_espresso'
-                )
-            );
-        }
-        foreach ($scripts as $handle => $script) {
-            if ($add_to_header) {
-                $this->header_js[ $handle ] = $script;
-            } else {
-                $this->footer_js[ $handle ] = $script;
-            }
-        }
-    }
-
-
-    /**
-     * @param array $script_attributes
-     * @param bool  $add_to_header
-     * @throws DomainException
-     */
-    public function addScriptAttributes(array $script_attributes, $add_to_header = false)
-    {
-        if (empty($script_attributes)) {
-            throw new DomainException(
-                esc_html__(
-                    'A non-empty array of strings, is required to add attributes to iframe Javascript.',
-                    'event_espresso'
-                )
-            );
-        }
-        foreach ($script_attributes as $handle => $script_attribute) {
-            if ($add_to_header) {
-                $this->header_js_attributes[ $handle ] = $script_attribute;
-            } else {
-                $this->footer_js_attributes[ $handle ] = $script_attribute;
-            }
-        }
-    }
-
-
-    /**
-     * @param array  $vars
-     * @param string $var_name
-     * @throws DomainException
-     */
-    public function addLocalizedVars(array $vars, $var_name = 'eei18n')
-    {
-        if (empty($vars)) {
-            throw new DomainException(
-                esc_html__(
-                    'A non-empty array of vars, is required to add localized Javascript vars to an iframe.',
-                    'event_espresso'
-                )
-            );
-        }
-        foreach ($vars as $handle => $var) {
-            if ($var_name === 'eei18n') {
-                EE_Registry::$i18n_js_strings[ $handle ] = $var;
-            } elseif ($var_name === 'eeCAL' && $handle === 'espresso_calendar') {
-                $this->localized_vars[ $var_name ] = $var;
-            } else {
-                if (! isset($this->localized_vars[ $var_name ])) {
-                    $this->localized_vars[ $var_name ] = array();
-                }
-                $this->localized_vars[ $var_name ][ $handle ] = $var;
-            }
-        }
-    }
-
-
-    /**
-     * @param string $utm_content
-     * @throws DomainException
-     */
-    public function display($utm_content = '')
-    {
-        $this->content .= EEH_Template::powered_by_event_espresso(
-            '',
-            '',
-            ! empty($utm_content) ? array('utm_content' => $utm_content) : array()
-        );
-        EE_System::do_not_cache();
-        echo $this->getTemplate();
-        exit;
-    }
-
-
-    /**
-     * @return string
-     * @throws DomainException
-     */
-    public function getTemplate()
-    {
-        return EEH_Template::display_template(
-            __DIR__ . DIRECTORY_SEPARATOR . 'iframe_wrapper.template.php',
-            array(
-                'title'                => apply_filters(
-                    'FHEE___EventEspresso_core_libraries_iframe_display_Iframe__getTemplate__title',
-                    $this->title,
-                    $this
-                ),
-                'content'              => apply_filters(
-                    'FHEE___EventEspresso_core_libraries_iframe_display_Iframe__getTemplate__content',
-                    $this->content,
-                    $this
-                ),
-                'enqueue_wp_assets'    => apply_filters(
-                    'FHEE___EventEspresso_core_libraries_iframe_display_Iframe__getTemplate__enqueue_wp_assets',
-                    $this->enqueue_wp_assets,
-                    $this
-                ),
-                'css'                  => (array) apply_filters(
-                    'FHEE___EventEspresso_core_libraries_iframe_display_Iframe__getTemplate__css_urls',
-                    $this->css,
-                    $this
-                ),
-                'header_js'            => (array) apply_filters(
-                    'FHEE___EventEspresso_core_libraries_iframe_display_Iframe__getTemplate__header_js_urls',
-                    $this->header_js,
-                    $this
-                ),
-                'header_js_attributes' => (array) apply_filters(
-                    'FHEE___EventEspresso_core_libraries_iframe_display_Iframe__getTemplate__header_js_attributes',
-                    $this->header_js_attributes,
-                    $this
-                ),
-                'footer_js'            => (array) apply_filters(
-                    'FHEE___EventEspresso_core_libraries_iframe_display_Iframe__getTemplate__footer_js_urls',
-                    $this->footer_js,
-                    $this
-                ),
-                'footer_js_attributes' => (array) apply_filters(
-                    'FHEE___EventEspresso_core_libraries_iframe_display_Iframe__getTemplate__footer_js_attributes',
-                    $this->footer_js_attributes,
-                    $this
-                ),
-                'eei18n'               => apply_filters(
-                    'FHEE___EventEspresso_core_libraries_iframe_display_Iframe__getTemplate__eei18n_js_strings',
-                    EE_Registry::localize_i18n_js_strings() . $this->localizeJsonVars(),
-                    $this
-                ),
-                'notices'              => EEH_Template::display_template(
-                    EE_TEMPLATES . 'espresso-ajax-notices.template.php',
-                    array(),
-                    true
-                ),
-            ),
-            true,
-            true
-        );
-    }
-
-
-    /**
-     * localizeJsonVars
-     *
-     * @return string
-     */
-    public function localizeJsonVars()
-    {
-        $JSON = '';
-        foreach ($this->localized_vars as $var_name => $vars) {
-            $this->localized_vars[ $var_name ] = $this->encodeJsonVars($vars);
-            $JSON .= "/* <![CDATA[ */ var {$var_name} = ";
-            $JSON .= wp_json_encode($this->localized_vars[ $var_name ]);
-            $JSON .= '; /* ]]> */';
-        }
-        return $JSON;
-    }
-
-
-    /**
-     * @param bool|int|float|string|array $var
-     * @return array|string|null
-     */
-    public function encodeJsonVars($var)
-    {
-        if (is_array($var)) {
-            $localized_vars = array();
-            foreach ((array) $var as $key => $value) {
-                $localized_vars[ $key ] = $this->encodeJsonVars($value);
-            }
-            return $localized_vars;
-        }
-        if (is_scalar($var)) {
-            return html_entity_decode((string) $var, ENT_QUOTES, 'UTF-8');
-        }
-        return null;
-    }
+	protected $localized_vars = array();
+
+
+	/**
+	 * Iframe constructor
+	 *
+	 * @param string $title
+	 * @param string $content
+	 * @throws DomainException
+	 */
+	public function __construct($title, $content)
+	{
+		global $wp_version;
+		if (! defined('EE_IFRAME_DIR_URL')) {
+			define('EE_IFRAME_DIR_URL', plugin_dir_url(__FILE__));
+		}
+		$this->setContent($content);
+		$this->setTitle($title);
+		$this->addStylesheets(
+			apply_filters(
+				'FHEE___EventEspresso_core_libraries_iframe_display_Iframe__construct__default_css',
+				array(
+					'site_theme'       => get_stylesheet_directory_uri()
+										  . '/style.css?ver=' . EVENT_ESPRESSO_VERSION,
+					'dashicons'        => includes_url('css/dashicons.min.css?ver=' . $wp_version),
+					'espresso_default' => EE_GLOBAL_ASSETS_URL
+										  . 'css/espresso_default.css?ver=' . EVENT_ESPRESSO_VERSION,
+				),
+				$this
+			)
+		);
+		$this->addScripts(
+			apply_filters(
+				'FHEE___EventEspresso_core_libraries_iframe_display_Iframe__construct__default_js',
+				array(
+					'jquery'        => includes_url('js/jquery/jquery.js?ver=' . $wp_version),
+					'espresso_core' => EE_GLOBAL_ASSETS_URL
+									   . 'scripts/espresso_core.js?ver=' . EVENT_ESPRESSO_VERSION,
+				),
+				$this
+			)
+		);
+		if (
+			apply_filters(
+				'FHEE___EventEspresso_core_libraries_iframe_display_Iframe__construct__load_default_theme_stylesheet',
+				false
+			)
+		) {
+			$this->addStylesheets(
+				apply_filters(
+					'FHEE___EventEspresso_core_libraries_iframe_display_Iframe__construct__default_theme_stylesheet',
+					array('default_theme_stylesheet' => get_stylesheet_uri()),
+					$this
+				)
+			);
+		}
+	}
+
+
+	/**
+	 * @param string $title
+	 * @throws DomainException
+	 */
+	public function setTitle($title)
+	{
+		if (empty($title)) {
+			throw new DomainException(
+				esc_html__('You must provide a page title in order to create an iframe.', 'event_espresso')
+			);
+		}
+		$this->title = $title;
+	}
+
+
+	/**
+	 * @param string $content
+	 * @throws DomainException
+	 */
+	public function setContent($content)
+	{
+		if (empty($content)) {
+			throw new DomainException(
+				esc_html__('You must provide content in order to create an iframe.', 'event_espresso')
+			);
+		}
+		$this->content = $content;
+	}
+
+
+	/**
+	 * @param boolean $enqueue_wp_assets
+	 */
+	public function setEnqueueWpAssets($enqueue_wp_assets)
+	{
+		$this->enqueue_wp_assets = filter_var($enqueue_wp_assets, FILTER_VALIDATE_BOOLEAN);
+	}
+
+
+	/**
+	 * @param array $stylesheets
+	 * @throws DomainException
+	 */
+	public function addStylesheets(array $stylesheets)
+	{
+		if (empty($stylesheets)) {
+			throw new DomainException(
+				esc_html__(
+					'A non-empty array of URLs, is required to add a CSS stylesheet to an iframe.',
+					'event_espresso'
+				)
+			);
+		}
+		foreach ($stylesheets as $handle => $stylesheet) {
+			$this->css[ $handle ] = $stylesheet;
+		}
+	}
+
+
+	/**
+	 * @param array $scripts
+	 * @param bool  $add_to_header
+	 * @throws DomainException
+	 */
+	public function addScripts(array $scripts, $add_to_header = false)
+	{
+		if (empty($scripts)) {
+			throw new DomainException(
+				esc_html__(
+					'A non-empty array of URLs, is required to add Javascript to an iframe.',
+					'event_espresso'
+				)
+			);
+		}
+		foreach ($scripts as $handle => $script) {
+			if ($add_to_header) {
+				$this->header_js[ $handle ] = $script;
+			} else {
+				$this->footer_js[ $handle ] = $script;
+			}
+		}
+	}
+
+
+	/**
+	 * @param array $script_attributes
+	 * @param bool  $add_to_header
+	 * @throws DomainException
+	 */
+	public function addScriptAttributes(array $script_attributes, $add_to_header = false)
+	{
+		if (empty($script_attributes)) {
+			throw new DomainException(
+				esc_html__(
+					'A non-empty array of strings, is required to add attributes to iframe Javascript.',
+					'event_espresso'
+				)
+			);
+		}
+		foreach ($script_attributes as $handle => $script_attribute) {
+			if ($add_to_header) {
+				$this->header_js_attributes[ $handle ] = $script_attribute;
+			} else {
+				$this->footer_js_attributes[ $handle ] = $script_attribute;
+			}
+		}
+	}
+
+
+	/**
+	 * @param array  $vars
+	 * @param string $var_name
+	 * @throws DomainException
+	 */
+	public function addLocalizedVars(array $vars, $var_name = 'eei18n')
+	{
+		if (empty($vars)) {
+			throw new DomainException(
+				esc_html__(
+					'A non-empty array of vars, is required to add localized Javascript vars to an iframe.',
+					'event_espresso'
+				)
+			);
+		}
+		foreach ($vars as $handle => $var) {
+			if ($var_name === 'eei18n') {
+				EE_Registry::$i18n_js_strings[ $handle ] = $var;
+			} elseif ($var_name === 'eeCAL' && $handle === 'espresso_calendar') {
+				$this->localized_vars[ $var_name ] = $var;
+			} else {
+				if (! isset($this->localized_vars[ $var_name ])) {
+					$this->localized_vars[ $var_name ] = array();
+				}
+				$this->localized_vars[ $var_name ][ $handle ] = $var;
+			}
+		}
+	}
+
+
+	/**
+	 * @param string $utm_content
+	 * @throws DomainException
+	 */
+	public function display($utm_content = '')
+	{
+		$this->content .= EEH_Template::powered_by_event_espresso(
+			'',
+			'',
+			! empty($utm_content) ? array('utm_content' => $utm_content) : array()
+		);
+		EE_System::do_not_cache();
+		echo $this->getTemplate();
+		exit;
+	}
+
+
+	/**
+	 * @return string
+	 * @throws DomainException
+	 */
+	public function getTemplate()
+	{
+		return EEH_Template::display_template(
+			__DIR__ . DIRECTORY_SEPARATOR . 'iframe_wrapper.template.php',
+			array(
+				'title'                => apply_filters(
+					'FHEE___EventEspresso_core_libraries_iframe_display_Iframe__getTemplate__title',
+					$this->title,
+					$this
+				),
+				'content'              => apply_filters(
+					'FHEE___EventEspresso_core_libraries_iframe_display_Iframe__getTemplate__content',
+					$this->content,
+					$this
+				),
+				'enqueue_wp_assets'    => apply_filters(
+					'FHEE___EventEspresso_core_libraries_iframe_display_Iframe__getTemplate__enqueue_wp_assets',
+					$this->enqueue_wp_assets,
+					$this
+				),
+				'css'                  => (array) apply_filters(
+					'FHEE___EventEspresso_core_libraries_iframe_display_Iframe__getTemplate__css_urls',
+					$this->css,
+					$this
+				),
+				'header_js'            => (array) apply_filters(
+					'FHEE___EventEspresso_core_libraries_iframe_display_Iframe__getTemplate__header_js_urls',
+					$this->header_js,
+					$this
+				),
+				'header_js_attributes' => (array) apply_filters(
+					'FHEE___EventEspresso_core_libraries_iframe_display_Iframe__getTemplate__header_js_attributes',
+					$this->header_js_attributes,
+					$this
+				),
+				'footer_js'            => (array) apply_filters(
+					'FHEE___EventEspresso_core_libraries_iframe_display_Iframe__getTemplate__footer_js_urls',
+					$this->footer_js,
+					$this
+				),
+				'footer_js_attributes' => (array) apply_filters(
+					'FHEE___EventEspresso_core_libraries_iframe_display_Iframe__getTemplate__footer_js_attributes',
+					$this->footer_js_attributes,
+					$this
+				),
+				'eei18n'               => apply_filters(
+					'FHEE___EventEspresso_core_libraries_iframe_display_Iframe__getTemplate__eei18n_js_strings',
+					EE_Registry::localize_i18n_js_strings() . $this->localizeJsonVars(),
+					$this
+				),
+				'notices'              => EEH_Template::display_template(
+					EE_TEMPLATES . 'espresso-ajax-notices.template.php',
+					array(),
+					true
+				),
+			),
+			true,
+			true
+		);
+	}
+
+
+	/**
+	 * localizeJsonVars
+	 *
+	 * @return string
+	 */
+	public function localizeJsonVars()
+	{
+		$JSON = '';
+		foreach ($this->localized_vars as $var_name => $vars) {
+			$this->localized_vars[ $var_name ] = $this->encodeJsonVars($vars);
+			$JSON .= "/* <![CDATA[ */ var {$var_name} = ";
+			$JSON .= wp_json_encode($this->localized_vars[ $var_name ]);
+			$JSON .= '; /* ]]> */';
+		}
+		return $JSON;
+	}
+
+
+	/**
+	 * @param bool|int|float|string|array $var
+	 * @return array|string|null
+	 */
+	public function encodeJsonVars($var)
+	{
+		if (is_array($var)) {
+			$localized_vars = array();
+			foreach ((array) $var as $key => $value) {
+				$localized_vars[ $key ] = $this->encodeJsonVars($value);
+			}
+			return $localized_vars;
+		}
+		if (is_scalar($var)) {
+			return html_entity_decode((string) $var, ENT_QUOTES, 'UTF-8');
+		}
+		return null;
+	}
 }

modules/events_archive/EventsArchiveIframe.php

Spacing +4 added lines, -4 removed lines

@@ -47,9 +47,9 @@ 
             apply_filters(
                 'FHEE__EventEspresso_modules_events_archive_EventsArchiveIframe__display__css',
                 [
-                    'espresso_default' => is_readable(EVENT_ESPRESSO_UPLOAD_DIR . 'css/style.css')
-                        ? EVENT_ESPRESSO_UPLOAD_DIR . 'css/espresso_default.css?ver=' . EVENT_ESPRESSO_VERSION
-                        : EE_GLOBAL_ASSETS_URL . 'css/espresso_default.css?ver=' . EVENT_ESPRESSO_VERSION,
+                    'espresso_default' => is_readable(EVENT_ESPRESSO_UPLOAD_DIR.'css/style.css')
+                        ? EVENT_ESPRESSO_UPLOAD_DIR . 'css/espresso_default.css?ver='.EVENT_ESPRESSO_VERSION
+                        : EE_GLOBAL_ASSETS_URL.'css/espresso_default.css?ver='.EVENT_ESPRESSO_VERSION,
                 ],
                 $this
             )
@@ -65,7 +65,7 @@ 
                             EE_Registry::instance()->CFG->map_settings->google_map_api_key
                         )
                     ),
-                    'ee_gmap'  => EE_HELPERS_ASSETS . 'ee_gmap.js?ver=1.0',
+                    'ee_gmap'  => EE_HELPERS_ASSETS.'ee_gmap.js?ver=1.0',
                 ],
                 $this
             )

Indentation +58 added lines, -58 removed lines

@@ -21,62 +21,62 @@
  */
 class EventsArchiveIframe extends Iframe
 {
-    /**
-     * EventsArchiveIframe constructor.
-     *
-     * @param EED_Events_Archive $EED_Events_Archive
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    public function __construct($EED_Events_Archive)
-    {
-        /** @var CurrentPage $current_page */
-        $current_page = LoaderFactory::getLoader()->getShared(CurrentPage::class);
-        $current_page->setEspressoPage(true);
-        add_filter('FHEE__EED_Events_Archive__event_list_iframe', '__return_true');
-        $EED_Events_Archive->event_list();
-        /** @var EspressoEvents $event_list */
-        $event_list = EE_Registry::instance()->create('EventEspresso\core\domain\entities\shortcodes\EspressoEvents');
-        $shortcode_content = $event_list->processShortcode();
-        if (empty($shortcode_content)) {
-            return;
-        }
-        parent::__construct(
-            esc_html__('Event List', 'event_espresso'),
-            $shortcode_content
-        );
-        $this->addStylesheets(
-            apply_filters(
-                'FHEE__EventEspresso_modules_events_archive_EventsArchiveIframe__display__css',
-                [
-                    'espresso_default' => is_readable(EVENT_ESPRESSO_UPLOAD_DIR . 'css/style.css')
-                        ? EVENT_ESPRESSO_UPLOAD_DIR . 'css/espresso_default.css?ver=' . EVENT_ESPRESSO_VERSION
-                        : EE_GLOBAL_ASSETS_URL . 'css/espresso_default.css?ver=' . EVENT_ESPRESSO_VERSION,
-                ],
-                $this
-            )
-        );
-        $this->addScripts(
-            apply_filters(
-                'FHEE__EventEspresso_modules_events_archive_EventsArchiveIframe__display__js',
-                [
-                    'gmap_api' => sprintf(
-                        'https://maps.googleapis.com/maps/api/js?key=%s',
-                        apply_filters(
-                            'FHEE__EEH_Maps__espresso_google_maps_js__api_key',
-                            EE_Registry::instance()->CFG->map_settings->google_map_api_key
-                        )
-                    ),
-                    'ee_gmap'  => EE_HELPERS_ASSETS . 'ee_gmap.js?ver=1.0',
-                ],
-                $this
-            )
-        );
-        $this->addLocalizedVars(
-            [
-                'ee_gmap' => EEH_Maps::$gmap_vars,
-            ],
-            'ee_gmap_vars'
-        );
-    }
+	/**
+	 * EventsArchiveIframe constructor.
+	 *
+	 * @param EED_Events_Archive $EED_Events_Archive
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	public function __construct($EED_Events_Archive)
+	{
+		/** @var CurrentPage $current_page */
+		$current_page = LoaderFactory::getLoader()->getShared(CurrentPage::class);
+		$current_page->setEspressoPage(true);
+		add_filter('FHEE__EED_Events_Archive__event_list_iframe', '__return_true');
+		$EED_Events_Archive->event_list();
+		/** @var EspressoEvents $event_list */
+		$event_list = EE_Registry::instance()->create('EventEspresso\core\domain\entities\shortcodes\EspressoEvents');
+		$shortcode_content = $event_list->processShortcode();
+		if (empty($shortcode_content)) {
+			return;
+		}
+		parent::__construct(
+			esc_html__('Event List', 'event_espresso'),
+			$shortcode_content
+		);
+		$this->addStylesheets(
+			apply_filters(
+				'FHEE__EventEspresso_modules_events_archive_EventsArchiveIframe__display__css',
+				[
+					'espresso_default' => is_readable(EVENT_ESPRESSO_UPLOAD_DIR . 'css/style.css')
+						? EVENT_ESPRESSO_UPLOAD_DIR . 'css/espresso_default.css?ver=' . EVENT_ESPRESSO_VERSION
+						: EE_GLOBAL_ASSETS_URL . 'css/espresso_default.css?ver=' . EVENT_ESPRESSO_VERSION,
+				],
+				$this
+			)
+		);
+		$this->addScripts(
+			apply_filters(
+				'FHEE__EventEspresso_modules_events_archive_EventsArchiveIframe__display__js',
+				[
+					'gmap_api' => sprintf(
+						'https://maps.googleapis.com/maps/api/js?key=%s',
+						apply_filters(
+							'FHEE__EEH_Maps__espresso_google_maps_js__api_key',
+							EE_Registry::instance()->CFG->map_settings->google_map_api_key
+						)
+					),
+					'ee_gmap'  => EE_HELPERS_ASSETS . 'ee_gmap.js?ver=1.0',
+				],
+				$this
+			)
+		);
+		$this->addLocalizedVars(
+			[
+				'ee_gmap' => EEH_Maps::$gmap_vars,
+			],
+			'ee_gmap_vars'
+		);
+	}
 }

modules/ticket_selector/TicketSelectorSimple.php

Spacing +1 added lines, -1 removed lines

@@ -72,6 +72,6 @@
         }
         $this->template_args['ticket_description'] = $ticket_selector_row->getTicketDescription();
         $this->template_args['template_path']      =
-            TICKET_SELECTOR_TEMPLATES_PATH . 'simple_ticket_selector.template.php';
+            TICKET_SELECTOR_TEMPLATES_PATH.'simple_ticket_selector.template.php';
     }
 }

Indentation +51 added lines, -51 removed lines

@@ -19,59 +19,59 @@
  */
 class TicketSelectorSimple extends TicketSelector
 {
-    /**
-     * @var EE_Ticket $ticket
-     */
-    protected $ticket;
+	/**
+	 * @var EE_Ticket $ticket
+	 */
+	protected $ticket;
 
 
-    /**
-     * TicketSelectorSimple constructor.
-     *
-     * @param EE_Event  $event
-     * @param EE_Ticket $ticket
-     * @param int       $max_attendees
-     * @param array     $template_args
-     * @throws EE_Error
-     */
-    public function __construct(EE_Event $event, EE_Ticket $ticket, $max_attendees, array $template_args)
-    {
-        $this->ticket = $ticket;
-        parent::__construct(
-            $event,
-            [$this->ticket],
-            $max_attendees,
-            $template_args
-        );
-    }
+	/**
+	 * TicketSelectorSimple constructor.
+	 *
+	 * @param EE_Event  $event
+	 * @param EE_Ticket $ticket
+	 * @param int       $max_attendees
+	 * @param array     $template_args
+	 * @throws EE_Error
+	 */
+	public function __construct(EE_Event $event, EE_Ticket $ticket, $max_attendees, array $template_args)
+	{
+		$this->ticket = $ticket;
+		parent::__construct(
+			$event,
+			[$this->ticket],
+			$max_attendees,
+			$template_args
+		);
+	}
 
 
-    /**
-     * sets any and all template args that are required for this Ticket Selector
-     *
-     * @return void
-     * @throws UnexpectedEntityException
-     * @throws EE_Error
-     */
-    protected function addTemplateArgs()
-    {
-        $this->ticket_rows = 1;
-        unset($this->template_args['tickets']);
-        $this->template_args['ticket'] = $this->ticket;
-        $ticket_selector_row           = new TicketSelectorRowSimple(
-            $this->ticket,
-            $this->max_attendees,
-            $this->template_args['date_format'],
-            $this->template_args['event_status']
-        );
-        $this->template_args['TKT_ID'] = $this->ticket->ID();
-        $ticket_selector_row->setupTicketStatusDisplay();
-        $this->template_args['ticket_status_display'] = $ticket_selector_row->getTicketStatusDisplay();
-        if (empty($this->template_args['ticket_status_display'])) {
-            add_filter('FHEE__EE_Ticket_Selector__display_ticket_selector_submit', '__return_true');
-        }
-        $this->template_args['ticket_description'] = $ticket_selector_row->getTicketDescription();
-        $this->template_args['template_path']      =
-            TICKET_SELECTOR_TEMPLATES_PATH . 'simple_ticket_selector.template.php';
-    }
+	/**
+	 * sets any and all template args that are required for this Ticket Selector
+	 *
+	 * @return void
+	 * @throws UnexpectedEntityException
+	 * @throws EE_Error
+	 */
+	protected function addTemplateArgs()
+	{
+		$this->ticket_rows = 1;
+		unset($this->template_args['tickets']);
+		$this->template_args['ticket'] = $this->ticket;
+		$ticket_selector_row           = new TicketSelectorRowSimple(
+			$this->ticket,
+			$this->max_attendees,
+			$this->template_args['date_format'],
+			$this->template_args['event_status']
+		);
+		$this->template_args['TKT_ID'] = $this->ticket->ID();
+		$ticket_selector_row->setupTicketStatusDisplay();
+		$this->template_args['ticket_status_display'] = $ticket_selector_row->getTicketStatusDisplay();
+		if (empty($this->template_args['ticket_status_display'])) {
+			add_filter('FHEE__EE_Ticket_Selector__display_ticket_selector_submit', '__return_true');
+		}
+		$this->template_args['ticket_description'] = $ticket_selector_row->getTicketDescription();
+		$this->template_args['template_path']      =
+			TICKET_SELECTOR_TEMPLATES_PATH . 'simple_ticket_selector.template.php';
+	}
 }