eventespresso / event-espresso-core

core/libraries/form_sections/form_handlers/SequentialStepFormManager.php

Indentation +583 added lines, -583 removed lines

@@ -29,587 +29,587 @@
 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 EE_Request $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 $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',
-        EE_Request $request
-    ) {
-        $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;
-    }
-
-
-    /**
-     * @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 \EventEspresso\core\exceptions\InvalidIdentifierException
-     * @throws InvalidDataTypeException
-     */
-    protected function setCurrentStepFromRequest()
-    {
-        $current_step_slug = $this->request()->get($this->formStepUrlKey(), $this->defaultFormStep());
-        if (! $this->form_steps->setCurrent($current_step_slug)) {
-            throw new InvalidIdentifierException(
-                $current_step_slug,
-                $this->defaultFormStep(),
-                $message = sprintf(
-                    esc_html__(
-                        'The "%1$s" form step could not be set.',
-                        'event_espresso'
-                    ),
-                    $current_step_slug
-                )
-            );
-        }
-    }
-
-
-    /**
-     * @return object|SequentialStepFormInterface
-     * @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 EE_Request
-     */
-    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 $progress_steps;
-        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 $this->getCurrentStep()->display();
-        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, so...
-            // if WP_DEBUG === true, display the Exception and stack trace right now
-            new ExceptionStackTraceDisplay($e);
-            // else 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();
-                break;
-            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 EE_Request $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 $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',
+		EE_Request $request
+	) {
+		$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;
+	}
+
+
+	/**
+	 * @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 \EventEspresso\core\exceptions\InvalidIdentifierException
+	 * @throws InvalidDataTypeException
+	 */
+	protected function setCurrentStepFromRequest()
+	{
+		$current_step_slug = $this->request()->get($this->formStepUrlKey(), $this->defaultFormStep());
+		if (! $this->form_steps->setCurrent($current_step_slug)) {
+			throw new InvalidIdentifierException(
+				$current_step_slug,
+				$this->defaultFormStep(),
+				$message = sprintf(
+					esc_html__(
+						'The "%1$s" form step could not be set.',
+						'event_espresso'
+					),
+					$current_step_slug
+				)
+			);
+		}
+	}
+
+
+	/**
+	 * @return object|SequentialStepFormInterface
+	 * @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 EE_Request
+	 */
+	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 $progress_steps;
+		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 $this->getCurrentStep()->display();
+		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, so...
+			// if WP_DEBUG === true, display the Exception and stack trace right now
+			new ExceptionStackTraceDisplay($e);
+			// else 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();
+				break;
+			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();
+	}
 }

Spacing +12 added lines, -12 removed lines

@@ -141,7 +141,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)) {
@@ -172,7 +172,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';
@@ -194,7 +194,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;
@@ -209,7 +209,7 @@ 
     protected function setCurrentStepFromRequest()
     {
         $current_step_slug = $this->request()->get($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(),
@@ -231,7 +231,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();
@@ -244,7 +244,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;
@@ -257,7 +257,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;
@@ -271,7 +271,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)
@@ -336,7 +336,7 @@ 
     protected function getProgressStepsCollection()
     {
         static $collection = null;
-        if (! $collection instanceof ProgressStepCollection) {
+        if ( ! $collection instanceof ProgressStepCollection) {
             $collection = new ProgressStepCollection();
         }
         return $collection;
@@ -358,7 +358,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(
@@ -427,7 +427,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());
@@ -503,7 +503,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(

core/libraries/form_sections/form_handlers/InvalidFormHandlerException.php

Indentation +21 added lines, -21 removed lines

@@ -13,25 +13,25 @@
 class InvalidFormHandlerException extends \UnexpectedValueException
 {
 
-    /**
-     * InvalidFormHandlerException constructor.
-     *
-     * @param string     $actual the FormHandler object that was received
-     * @param string     $message
-     * @param int        $code
-     * @param \Exception $previous
-     */
-    public function __construct($actual, $message = '', $code = 0, \Exception $previous = null)
-    {
-        if (empty($message)) {
-            $message = sprintf(
-                __(
-                    'A valid Form Handler was expected but instead "%1$s" was received.',
-                    'event_espresso'
-                ),
-                $actual
-            );
-        }
-        parent::__construct($message, $code, $previous);
-    }
+	/**
+	 * InvalidFormHandlerException constructor.
+	 *
+	 * @param string     $actual the FormHandler object that was received
+	 * @param string     $message
+	 * @param int        $code
+	 * @param \Exception $previous
+	 */
+	public function __construct($actual, $message = '', $code = 0, \Exception $previous = null)
+	{
+		if (empty($message)) {
+			$message = sprintf(
+				__(
+					'A valid Form Handler was expected but instead "%1$s" was received.',
+					'event_espresso'
+				),
+				$actual
+			);
+		}
+		parent::__construct($message, $code, $previous);
+	}
 }

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

Indentation +6 added lines, -6 removed lines

@@ -14,10 +14,10 @@
 abstract class FormHtmlFilter
 {
 
-    /**
-     * @param                             $html
-     * @param EE_Form_Section_Validatable $form_section
-     * @return string
-     */
-    abstract public function filterHtml($html, EE_Form_Section_Validatable $form_section);
+	/**
+	 * @param                             $html
+	 * @param EE_Form_Section_Validatable $form_section
+	 * @return string
+	 */
+	abstract public function filterHtml($html, EE_Form_Section_Validatable $form_section);
 }

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

Indentation +41 added lines, -41 removed lines

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

core/libraries/iframe_display/Iframe.php

Indentation +332 added lines, -332 removed lines

@@ -18,371 +18,371 @@
 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() . DS
-                                          . '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 ((array)$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
-     */
-    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() . DS
+										  . '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 ((array)$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
+	 */
+	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;
+	}
 }

Spacing +19 added lines, -19 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);
@@ -92,11 +92,11 @@ 
             apply_filters(
                 'FHEE___EventEspresso_core_libraries_iframe_display_Iframe__construct__default_css',
                 array(
-                    'site_theme'       => get_stylesheet_directory_uri() . DS
-                                          . 'style.css?ver=' . EVENT_ESPRESSO_VERSION,
-                    'dashicons'        => includes_url('css/dashicons.min.css?ver=' . $wp_version),
+                    'site_theme'       => get_stylesheet_directory_uri().DS
+                                          . '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
             )
@@ -257,7 +257,7 @@ 
             } elseif ($var_name === 'eeCAL' && $handle === 'espresso_calendar') {
                 $this->localized_vars[$var_name] = $var;
             } else {
-                if (! isset($this->localized_vars[$var_name])) {
+                if ( ! isset($this->localized_vars[$var_name])) {
                     $this->localized_vars[$var_name] = array();
                 }
                 $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',
@@ -307,38 +307,38 @@ 
                     $this->enqueue_wp_assets,
                     $this
                 ),
-                'css'                  => (array)apply_filters(
+                'css'                  => (array) apply_filters(
                     'FHEE___EventEspresso_core_libraries_iframe_display_Iframe__getTemplate__css_urls',
                     $this->css,
                     $this
                 ),
-                'header_js'            => (array)apply_filters(
+                '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(
+                '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(
+                '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(
+                '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(),
+                    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
                 ),
@@ -357,7 +357,7 @@ 
     public function localizeJsonVars()
     {
         $JSON = '';
-        foreach ((array)$this->localized_vars as $var_name => $vars) {
+        foreach ((array) $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]);
@@ -375,13 +375,13 @@ 
     {
         if (is_array($var)) {
             $localized_vars = array();
-            foreach ((array)$var as $key => $value) {
+            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 html_entity_decode((string) $var, ENT_QUOTES, 'UTF-8');
         }
         return null;
     }

core/libraries/iframe_display/IframeEmbedButton.php

Indentation +245 added lines, -245 removed lines

@@ -13,274 +13,274 @@
 {
 
 
-    /**
-     * @var string $iframe_name
-     */
-    private $iframe_name;
+	/**
+	 * @var string $iframe_name
+	 */
+	private $iframe_name;
 
-    /**
-     * @var string $route_name
-     */
-    private $route_name;
+	/**
+	 * @var string $route_name
+	 */
+	private $route_name;
 
-    /**
-     * @var string $slug
-     */
-    private $slug;
+	/**
+	 * @var string $slug
+	 */
+	private $slug;
 
-    /**
-     * @var boolean $append_filterable_content
-     */
-    private $append_filterable_content;
+	/**
+	 * @var boolean $append_filterable_content
+	 */
+	private $append_filterable_content;
 
 
-    /**
-     * IframeEmbedButton constructor.
-     *
-     * @param string $iframe_name i18n name for the iframe. This will be used in HTML
-     * @param string $route_name  the name of the registered route
-     * @param string $slug        URL slug used for the thing the iframe button is being embedded in.
-     *                            will most likely be "event" since that's the only usage atm
-     */
-    public function __construct($iframe_name, $route_name, $slug = 'event')
-    {
-        $this->iframe_name = $iframe_name;
-        $this->route_name = $route_name;
-        $this->slug = $slug;
-    }
+	/**
+	 * IframeEmbedButton constructor.
+	 *
+	 * @param string $iframe_name i18n name for the iframe. This will be used in HTML
+	 * @param string $route_name  the name of the registered route
+	 * @param string $slug        URL slug used for the thing the iframe button is being embedded in.
+	 *                            will most likely be "event" since that's the only usage atm
+	 */
+	public function __construct($iframe_name, $route_name, $slug = 'event')
+	{
+		$this->iframe_name = $iframe_name;
+		$this->route_name = $route_name;
+		$this->slug = $slug;
+	}
 
 
-    /**
-     * Adds an iframe embed code button to the Event editor.
-     */
-    public function addEventEditorIframeEmbedButtonFilter()
-    {
-        // add button for iframe code to event editor.
-        add_filter(
-            'get_sample_permalink_html',
-            array($this, 'appendIframeEmbedButtonToSamplePermalinkHtml'),
-            10,
-            2
-        );
-        add_action(
-            'admin_enqueue_scripts',
-            array($this, 'embedButtonAssets'),
-            10
-        );
-    }
+	/**
+	 * Adds an iframe embed code button to the Event editor.
+	 */
+	public function addEventEditorIframeEmbedButtonFilter()
+	{
+		// add button for iframe code to event editor.
+		add_filter(
+			'get_sample_permalink_html',
+			array($this, 'appendIframeEmbedButtonToSamplePermalinkHtml'),
+			10,
+			2
+		);
+		add_action(
+			'admin_enqueue_scripts',
+			array($this, 'embedButtonAssets'),
+			10
+		);
+	}
 
 
-    /**
-     * @param $permalink_string
-     * @param $id
-     * @return string
-     */
-    public function appendIframeEmbedButtonToSamplePermalinkHtml($permalink_string, $id)
-    {
-        return $this->eventEditorIframeEmbedButton(
-            $permalink_string,
-            $id
-        );
-    }
+	/**
+	 * @param $permalink_string
+	 * @param $id
+	 * @return string
+	 */
+	public function appendIframeEmbedButtonToSamplePermalinkHtml($permalink_string, $id)
+	{
+		return $this->eventEditorIframeEmbedButton(
+			$permalink_string,
+			$id
+		);
+	}
 
 
-    /**
-     * iframe embed code button to the Event editor.
-     *
-     * @param string $permalink_string
-     * @param int    $id
-     * @return string
-     */
-    public function eventEditorIframeEmbedButton(
-        $permalink_string,
-        $id
-    ) {
-        // make sure this is ONLY when editing and the event id has been set.
-        if (! empty($id)) {
-            $post = get_post($id);
-            // if NOT event then let's get out.
-            if ($post->post_type !== 'espresso_events') {
-                return $permalink_string;
-            }
-            $permalink_string .= $this->embedButtonHtml(
-                array($this->slug => $id),
-                'button-small'
-            );
-        }
-        return $permalink_string;
-    }
+	/**
+	 * iframe embed code button to the Event editor.
+	 *
+	 * @param string $permalink_string
+	 * @param int    $id
+	 * @return string
+	 */
+	public function eventEditorIframeEmbedButton(
+		$permalink_string,
+		$id
+	) {
+		// make sure this is ONLY when editing and the event id has been set.
+		if (! empty($id)) {
+			$post = get_post($id);
+			// if NOT event then let's get out.
+			if ($post->post_type !== 'espresso_events') {
+				return $permalink_string;
+			}
+			$permalink_string .= $this->embedButtonHtml(
+				array($this->slug => $id),
+				'button-small'
+			);
+		}
+		return $permalink_string;
+	}
 
 
-    /**
-     * Adds an iframe embed code button via a WP do_action() as determined by the first parameter
-     *
-     * @param string $action name of the WP do_action() to hook into
-     */
-    public function addActionIframeEmbedButton($action)
-    {
-        // add button for iframe code to event editor.
-        add_action(
-            $action,
-            array($this, 'addActionIframeEmbedButtonCallback'),
-            10,
-            2
-        );
-    }
+	/**
+	 * Adds an iframe embed code button via a WP do_action() as determined by the first parameter
+	 *
+	 * @param string $action name of the WP do_action() to hook into
+	 */
+	public function addActionIframeEmbedButton($action)
+	{
+		// add button for iframe code to event editor.
+		add_action(
+			$action,
+			array($this, 'addActionIframeEmbedButtonCallback'),
+			10,
+			2
+		);
+	}
 
 
-    /**
-     * @return void
-     */
-    public function addActionIframeEmbedButtonCallback()
-    {
-        echo $this->embedButtonHtml();
-    }
+	/**
+	 * @return void
+	 */
+	public function addActionIframeEmbedButtonCallback()
+	{
+		echo $this->embedButtonHtml();
+	}
 
 
-    /**
-     * Adds an iframe embed code button via a WP apply_filters() as determined by the first parameter
-     *
-     * @param string $filter     name of the WP apply_filters() to hook into
-     * @param bool   $append     if true, will add iframe embed button to end of content,
-     *                           else if false, will add to the beginning of the content
-     */
-    public function addFilterIframeEmbedButton($filter, $append = true)
-    {
-        $this->append_filterable_content = $append;
-        // add button for iframe code to event editor.
-        add_filter(
-            $filter,
-            array($this, 'addFilterIframeEmbedButtonCallback'),
-            10
-        );
-    }
+	/**
+	 * Adds an iframe embed code button via a WP apply_filters() as determined by the first parameter
+	 *
+	 * @param string $filter     name of the WP apply_filters() to hook into
+	 * @param bool   $append     if true, will add iframe embed button to end of content,
+	 *                           else if false, will add to the beginning of the content
+	 */
+	public function addFilterIframeEmbedButton($filter, $append = true)
+	{
+		$this->append_filterable_content = $append;
+		// add button for iframe code to event editor.
+		add_filter(
+			$filter,
+			array($this, 'addFilterIframeEmbedButtonCallback'),
+			10
+		);
+	}
 
 
-    /**
-     * @param array|string $filterable_content
-     * @return array|string
-     */
-    public function addFilterIframeEmbedButtonCallback($filterable_content)
-    {
-        $embedButtonHtml = $this->embedButtonHtml();
-        if (is_array($filterable_content)) {
-            $filterable_content = $this->append_filterable_content
-                ? $filterable_content + array($this->route_name => $embedButtonHtml)
-                : array($this->route_name => $embedButtonHtml) + $filterable_content;
-        } else {
-            $filterable_content = $this->append_filterable_content
-                ? $filterable_content . $embedButtonHtml
-                : $embedButtonHtml . $filterable_content;
-        }
-        return $filterable_content;
-    }
+	/**
+	 * @param array|string $filterable_content
+	 * @return array|string
+	 */
+	public function addFilterIframeEmbedButtonCallback($filterable_content)
+	{
+		$embedButtonHtml = $this->embedButtonHtml();
+		if (is_array($filterable_content)) {
+			$filterable_content = $this->append_filterable_content
+				? $filterable_content + array($this->route_name => $embedButtonHtml)
+				: array($this->route_name => $embedButtonHtml) + $filterable_content;
+		} else {
+			$filterable_content = $this->append_filterable_content
+				? $filterable_content . $embedButtonHtml
+				: $embedButtonHtml . $filterable_content;
+		}
+		return $filterable_content;
+	}
 
 
-    /**
-     * iframe_embed_html
-     *
-     * @param array  $query_args
-     * @param string $button_class
-     * @return string
-     */
-    public function embedButtonHtml($query_args = array(), $button_class = '')
-    {
-        // incoming args will replace the defaults listed here in the second array (union preserves first array)
-        $query_args = (array)$query_args + array($this->route_name => 'iframe');
-        $query_args = (array)apply_filters(
-            'FHEE__EventEspresso_core_libraries_iframe_display_IframeEmbedButton__embedButtonHtml__query_args',
-            $query_args
-        );
-        // add this route to our localized vars
-        $iframe_module_routes = isset(\EE_Registry::$i18n_js_strings['iframe_module_routes'])
-            ? \EE_Registry::$i18n_js_strings['iframe_module_routes']
-            : array();
-        $iframe_module_routes[$this->route_name] = $this->route_name;
-        \EE_Registry::$i18n_js_strings['iframe_module_routes'] = $iframe_module_routes;
-        $iframe_embed_html = \EEH_HTML::link(
-            '#',
-            sprintf(esc_html__('Embed %1$s', 'event_espresso'), $this->iframe_name),
-            sprintf(
-                esc_html__(
-                    'click here to generate code for embedding %1$s iframe into another site.',
-                    'event_espresso'
-                ),
-                \EEH_Inflector::add_indefinite_article($this->iframe_name)
-            ),
-            "{$this->route_name}-iframe-embed-trigger-js",
-            'iframe-embed-trigger-js button ' . $button_class,
-            '',
-            ' data-iframe_embed_button="#' . $this->route_name . '-iframe-js" tabindex="-1"'
-        );
-        $iframe_embed_html .= \EEH_HTML::div(
-            '',
-            "{$this->route_name}-iframe-js",
-            'iframe-embed-wrapper-js',
-            'display:none;'
-        );
-        $iframe_embed_html .= esc_html(
-            \EEH_HTML::div(
-                '<iframe src="' . add_query_arg($query_args, site_url()) . '" width="100%" height="100%"></iframe>',
-                '',
-                '',
-                'width:100%; height: 500px;'
-            )
-        );
-        $iframe_embed_html .= \EEH_HTML::divx();
-        return $iframe_embed_html;
-    }
+	/**
+	 * iframe_embed_html
+	 *
+	 * @param array  $query_args
+	 * @param string $button_class
+	 * @return string
+	 */
+	public function embedButtonHtml($query_args = array(), $button_class = '')
+	{
+		// incoming args will replace the defaults listed here in the second array (union preserves first array)
+		$query_args = (array)$query_args + array($this->route_name => 'iframe');
+		$query_args = (array)apply_filters(
+			'FHEE__EventEspresso_core_libraries_iframe_display_IframeEmbedButton__embedButtonHtml__query_args',
+			$query_args
+		);
+		// add this route to our localized vars
+		$iframe_module_routes = isset(\EE_Registry::$i18n_js_strings['iframe_module_routes'])
+			? \EE_Registry::$i18n_js_strings['iframe_module_routes']
+			: array();
+		$iframe_module_routes[$this->route_name] = $this->route_name;
+		\EE_Registry::$i18n_js_strings['iframe_module_routes'] = $iframe_module_routes;
+		$iframe_embed_html = \EEH_HTML::link(
+			'#',
+			sprintf(esc_html__('Embed %1$s', 'event_espresso'), $this->iframe_name),
+			sprintf(
+				esc_html__(
+					'click here to generate code for embedding %1$s iframe into another site.',
+					'event_espresso'
+				),
+				\EEH_Inflector::add_indefinite_article($this->iframe_name)
+			),
+			"{$this->route_name}-iframe-embed-trigger-js",
+			'iframe-embed-trigger-js button ' . $button_class,
+			'',
+			' data-iframe_embed_button="#' . $this->route_name . '-iframe-js" tabindex="-1"'
+		);
+		$iframe_embed_html .= \EEH_HTML::div(
+			'',
+			"{$this->route_name}-iframe-js",
+			'iframe-embed-wrapper-js',
+			'display:none;'
+		);
+		$iframe_embed_html .= esc_html(
+			\EEH_HTML::div(
+				'<iframe src="' . add_query_arg($query_args, site_url()) . '" width="100%" height="100%"></iframe>',
+				'',
+				'',
+				'width:100%; height: 500px;'
+			)
+		);
+		$iframe_embed_html .= \EEH_HTML::divx();
+		return $iframe_embed_html;
+	}
 
 
-    /**
-     * enqueue iframe button js
-     */
-    public function embedButtonAssets()
-    {
-        \EE_Registry::$i18n_js_strings['iframe_embed_title'] = esc_html__(
-            'copy and paste the following into any other site\'s content to display this event:',
-            'event_espresso'
-        );
-        \EE_Registry::$i18n_js_strings['iframe_embed_close_msg'] = esc_html__(
-            'click anywhere outside of this window to close it.',
-            'event_espresso'
-        );
-        wp_register_script(
-            'iframe_embed_button',
-            plugin_dir_url(__FILE__) . 'iframe-embed-button.js',
-            array('ee-dialog'),
-            EVENT_ESPRESSO_VERSION,
-            true
-        );
-        wp_enqueue_script('iframe_embed_button');
-    }
+	/**
+	 * enqueue iframe button js
+	 */
+	public function embedButtonAssets()
+	{
+		\EE_Registry::$i18n_js_strings['iframe_embed_title'] = esc_html__(
+			'copy and paste the following into any other site\'s content to display this event:',
+			'event_espresso'
+		);
+		\EE_Registry::$i18n_js_strings['iframe_embed_close_msg'] = esc_html__(
+			'click anywhere outside of this window to close it.',
+			'event_espresso'
+		);
+		wp_register_script(
+			'iframe_embed_button',
+			plugin_dir_url(__FILE__) . 'iframe-embed-button.js',
+			array('ee-dialog'),
+			EVENT_ESPRESSO_VERSION,
+			true
+		);
+		wp_enqueue_script('iframe_embed_button');
+	}
 
 
-    /**
-     * generates embed button sections for admin pages
-     *
-     * @param array $embed_buttons
-     * @return string
-     */
-    public function addIframeEmbedButtonsSection(array $embed_buttons)
-    {
-        $embed_buttons = (array)apply_filters(
-            'FHEE__EventEspresso_core_libraries_iframe_display_IframeEmbedButton__addIframeEmbedButtonsSection__embed_buttons',
-            $embed_buttons
-        );
-        if (empty($embed_buttons)) {
-            return '';
-        }
-        // add button for iframe code to event editor.
-        $html = \EEH_HTML::br(2);
-        $html .= \EEH_HTML::h3(esc_html__('iFrame Embed Code', 'event_espresso'));
-        $html .= \EEH_HTML::p(
-            esc_html__(
-                'Click the following button(s) to generate iframe HTML that will allow you to embed your event content within the content of other websites.',
-                'event_espresso'
-            )
-        );
-        $html .= ' &nbsp; ' . implode(' &nbsp; ', $embed_buttons) . ' ';
-        $html .= \EEH_HTML::br(2);
-        return $html;
-    }
+	/**
+	 * generates embed button sections for admin pages
+	 *
+	 * @param array $embed_buttons
+	 * @return string
+	 */
+	public function addIframeEmbedButtonsSection(array $embed_buttons)
+	{
+		$embed_buttons = (array)apply_filters(
+			'FHEE__EventEspresso_core_libraries_iframe_display_IframeEmbedButton__addIframeEmbedButtonsSection__embed_buttons',
+			$embed_buttons
+		);
+		if (empty($embed_buttons)) {
+			return '';
+		}
+		// add button for iframe code to event editor.
+		$html = \EEH_HTML::br(2);
+		$html .= \EEH_HTML::h3(esc_html__('iFrame Embed Code', 'event_espresso'));
+		$html .= \EEH_HTML::p(
+			esc_html__(
+				'Click the following button(s) to generate iframe HTML that will allow you to embed your event content within the content of other websites.',
+				'event_espresso'
+			)
+		);
+		$html .= ' &nbsp; ' . implode(' &nbsp; ', $embed_buttons) . ' ';
+		$html .= \EEH_HTML::br(2);
+		return $html;
+	}
 }

Spacing +11 added lines, -11 removed lines

@@ -96,7 +96,7 @@ 
         $id
     ) {
         // make sure this is ONLY when editing and the event id has been set.
-        if (! empty($id)) {
+        if ( ! empty($id)) {
             $post = get_post($id);
             // if NOT event then let's get out.
             if ($post->post_type !== 'espresso_events') {
@@ -169,8 +169,8 @@ 
                 : array($this->route_name => $embedButtonHtml) + $filterable_content;
         } else {
             $filterable_content = $this->append_filterable_content
-                ? $filterable_content . $embedButtonHtml
-                : $embedButtonHtml . $filterable_content;
+                ? $filterable_content.$embedButtonHtml
+                : $embedButtonHtml.$filterable_content;
         }
         return $filterable_content;
     }
@@ -186,8 +186,8 @@ 
     public function embedButtonHtml($query_args = array(), $button_class = '')
     {
         // incoming args will replace the defaults listed here in the second array (union preserves first array)
-        $query_args = (array)$query_args + array($this->route_name => 'iframe');
-        $query_args = (array)apply_filters(
+        $query_args = (array) $query_args + array($this->route_name => 'iframe');
+        $query_args = (array) apply_filters(
             'FHEE__EventEspresso_core_libraries_iframe_display_IframeEmbedButton__embedButtonHtml__query_args',
             $query_args
         );
@@ -208,9 +208,9 @@ 
                 \EEH_Inflector::add_indefinite_article($this->iframe_name)
             ),
             "{$this->route_name}-iframe-embed-trigger-js",
-            'iframe-embed-trigger-js button ' . $button_class,
+            'iframe-embed-trigger-js button '.$button_class,
             '',
-            ' data-iframe_embed_button="#' . $this->route_name . '-iframe-js" tabindex="-1"'
+            ' data-iframe_embed_button="#'.$this->route_name.'-iframe-js" tabindex="-1"'
         );
         $iframe_embed_html .= \EEH_HTML::div(
             '',
@@ -220,7 +220,7 @@ 
         );
         $iframe_embed_html .= esc_html(
             \EEH_HTML::div(
-                '<iframe src="' . add_query_arg($query_args, site_url()) . '" width="100%" height="100%"></iframe>',
+                '<iframe src="'.add_query_arg($query_args, site_url()).'" width="100%" height="100%"></iframe>',
                 '',
                 '',
                 'width:100%; height: 500px;'
@@ -246,7 +246,7 @@ 
         );
         wp_register_script(
             'iframe_embed_button',
-            plugin_dir_url(__FILE__) . 'iframe-embed-button.js',
+            plugin_dir_url(__FILE__).'iframe-embed-button.js',
             array('ee-dialog'),
             EVENT_ESPRESSO_VERSION,
             true
@@ -263,7 +263,7 @@ 
      */
     public function addIframeEmbedButtonsSection(array $embed_buttons)
     {
-        $embed_buttons = (array)apply_filters(
+        $embed_buttons = (array) apply_filters(
             'FHEE__EventEspresso_core_libraries_iframe_display_IframeEmbedButton__addIframeEmbedButtonsSection__embed_buttons',
             $embed_buttons
         );
@@ -279,7 +279,7 @@ 
                 'event_espresso'
             )
         );
-        $html .= ' &nbsp; ' . implode(' &nbsp; ', $embed_buttons) . ' ';
+        $html .= ' &nbsp; '.implode(' &nbsp; ', $embed_buttons).' ';
         $html .= \EEH_HTML::br(2);
         return $html;
     }

core/libraries/iframe_display/EventListIframeEmbedButton.php

Indentation +41 added lines, -41 removed lines

@@ -12,49 +12,49 @@
 class EventListIframeEmbedButton extends IframeEmbedButton
 {
 
-    /**
-     * EventListIframeEmbedButton constructor.
-     */
-    public function __construct()
-    {
-        parent::__construct(
-            esc_html__('Upcoming Event List', 'event_espresso'),
-            'event_list'
-        );
-    }
+	/**
+	 * EventListIframeEmbedButton constructor.
+	 */
+	public function __construct()
+	{
+		parent::__construct(
+			esc_html__('Upcoming Event List', 'event_espresso'),
+			'event_list'
+		);
+	}
 
 
-    public function addEmbedButton()
-    {
-        add_filter(
-            'FHEE__EE_Admin_Page___display_admin_list_table_page__after_list_table__template_args_array',
-            array($this, 'addEventListIframeEmbedButtonSection')
-        );
-        add_action(
-            'admin_enqueue_scripts',
-            array($this, 'embedButtonAssets'),
-            10
-        );
-    }
+	public function addEmbedButton()
+	{
+		add_filter(
+			'FHEE__EE_Admin_Page___display_admin_list_table_page__after_list_table__template_args_array',
+			array($this, 'addEventListIframeEmbedButtonSection')
+		);
+		add_action(
+			'admin_enqueue_scripts',
+			array($this, 'embedButtonAssets'),
+			10
+		);
+	}
 
 
-    /**
-     * Adds an iframe embed code button to the Event editor.
-     * return string
-     *
-     * @param array $after_list_table
-     * @return array
-     */
-    public function addEventListIframeEmbedButtonSection(array $after_list_table)
-    {
-        return \EEH_Array::insert_into_array(
-            $after_list_table,
-            array(
-                'iframe_embed_buttons' => $this->addIframeEmbedButtonsSection(
-                    array('event_list' => $this->embedButtonHtml())
-                ),
-            ),
-            'legend'
-        );
-    }
+	/**
+	 * Adds an iframe embed code button to the Event editor.
+	 * return string
+	 *
+	 * @param array $after_list_table
+	 * @return array
+	 */
+	public function addEventListIframeEmbedButtonSection(array $after_list_table)
+	{
+		return \EEH_Array::insert_into_array(
+			$after_list_table,
+			array(
+				'iframe_embed_buttons' => $this->addIframeEmbedButtonsSection(
+					array('event_list' => $this->embedButtonHtml())
+				),
+			),
+			'legend'
+		);
+	}
 }

core/libraries/rest_api/Capabilities.php

Indentation +140 added lines, -140 removed lines

@@ -15,152 +15,152 @@
 class Capabilities
 {
 
-    /**
-     * The current user can see at least SOME of these entities.
-     *
-     * @param EEM_Base $model
-     * @param string   $model_context one of the return values from EEM_Base::valid_cap_contexts()
-     * @return boolean
-     */
-    public static function currentUserHasPartialAccessTo($model, $model_context = EEM_Base::caps_read)
-    {
-        if (apply_filters(
-            'FHEE__Capabilities__current_user_has_partial_access_to__override_begin',
-            false,
-            $model,
-            $model
-        )) {
-            return true;
-        }
-        foreach ($model->caps_missing($model_context) as $capability_name => $restriction_obj) {
-            if ($restriction_obj instanceof \EE_Return_None_Where_Conditions) {
-                return false;
-            }
-        }
-        if (apply_filters(
-            'FHEE__Capabilities__current_user_has_partial_access_to__override_end',
-            false,
-            $model,
-            $model
-        )) {
-            return false;
-        }
-        return true;
-    }
+	/**
+	 * The current user can see at least SOME of these entities.
+	 *
+	 * @param EEM_Base $model
+	 * @param string   $model_context one of the return values from EEM_Base::valid_cap_contexts()
+	 * @return boolean
+	 */
+	public static function currentUserHasPartialAccessTo($model, $model_context = EEM_Base::caps_read)
+	{
+		if (apply_filters(
+			'FHEE__Capabilities__current_user_has_partial_access_to__override_begin',
+			false,
+			$model,
+			$model
+		)) {
+			return true;
+		}
+		foreach ($model->caps_missing($model_context) as $capability_name => $restriction_obj) {
+			if ($restriction_obj instanceof \EE_Return_None_Where_Conditions) {
+				return false;
+			}
+		}
+		if (apply_filters(
+			'FHEE__Capabilities__current_user_has_partial_access_to__override_end',
+			false,
+			$model,
+			$model
+		)) {
+			return false;
+		}
+		return true;
+	}
 
 
-    /**
-     * Gets an array of all the capabilities the current user is missing that affected
-     * the query
-     *
-     * @param EEM_Base $model
-     * @param string   $request_type one of the constants on WP_JSON_Server
-     * @return array
-     */
-    public static function getMissingPermissions($model, $request_type = EEM_Base::caps_read)
-    {
-        return $model->caps_missing($request_type);
-    }
+	/**
+	 * Gets an array of all the capabilities the current user is missing that affected
+	 * the query
+	 *
+	 * @param EEM_Base $model
+	 * @param string   $request_type one of the constants on WP_JSON_Server
+	 * @return array
+	 */
+	public static function getMissingPermissions($model, $request_type = EEM_Base::caps_read)
+	{
+		return $model->caps_missing($request_type);
+	}
 
 
-    /**
-     * Gets a string of all the capabilities the current user is missing that affected
-     * the query
-     *
-     * @param EEM_Base $model
-     * @param string   $model_context one of the return values from EEM_Base::valid_cap_contexts()
-     * @return string
-     */
-    public static function getMissingPermissionsString($model, $model_context = EEM_Base::caps_read)
-    {
-        return implode(',', array_keys(self::getMissingPermissions($model, $model_context)));
-    }
+	/**
+	 * Gets a string of all the capabilities the current user is missing that affected
+	 * the query
+	 *
+	 * @param EEM_Base $model
+	 * @param string   $model_context one of the return values from EEM_Base::valid_cap_contexts()
+	 * @return string
+	 */
+	public static function getMissingPermissionsString($model, $model_context = EEM_Base::caps_read)
+	{
+		return implode(',', array_keys(self::getMissingPermissions($model, $model_context)));
+	}
 
 
-    /**
-     * Takes a entity that's ready to be returned and removes fields which the user shouldn't be able to access.
-     *
-     * @param array            $entity
-     * @param EEM_Base         $model
-     * @param string           $request_type         one of the return values from EEM_Base::valid_cap_contexts()
-     * @param ModelVersionInfo $model_version_info
-     * @param string           $primary_key_string   result of EEM_Base::get_index_primary_key_string(), so that we can
-     *                                               use this with models that have no primary key
-     * @return array ready for converting into json
-     */
-    public static function filterOutInaccessibleEntityFields(
-        $entity,
-        $model,
-        $request_type,
-        $model_version_info,
-        $primary_key_string = null
-    ) {
-        // if they didn't provide the primary key string, we'll just hope we can figure it out
-        // from the entity (although it's preferred client code does it, because the entity might be missing
-        // necessary fields for creating the primary key string, or they could be named differently)
-        if ($primary_key_string === null) {
-            $primary_key_string = $model->get_index_primary_key_string(
-                $model->deduce_fields_n_values_from_cols_n_values($entity)
-            );
-        }
-        // we only care to do this for frontend reads and when the user can't edit the item
-        if ($request_type !== EEM_Base::caps_read
-            || $model->exists(
-                $model->alter_query_params_to_restrict_by_ID(
-                    $primary_key_string,
-                    array(
-                        'default_where_conditions' => 'none',
-                        'caps'                     => EEM_Base::caps_edit,
-                    )
-                )
-            )
-        ) {
-            return $entity;
-        }
-        foreach ($model->field_settings() as $field_name => $field_obj) {
-            if ($model_version_info->fieldHasRenderedFormat($field_obj)
-                && isset($entity[$field_name])
-                && is_array($entity[$field_name])
-                && isset($entity[$field_name]['raw'])
-            ) {
-                unset($entity[$field_name]['raw']);
-            }
-        }
-        // theoretically we may want to filter out specific fields for specific models
-        return apply_filters(
-            'FHEE__Capabilities__filter_out_inaccessible_entity_fields',
-            $entity,
-            $model,
-            $request_type
-        );
-    }
+	/**
+	 * Takes a entity that's ready to be returned and removes fields which the user shouldn't be able to access.
+	 *
+	 * @param array            $entity
+	 * @param EEM_Base         $model
+	 * @param string           $request_type         one of the return values from EEM_Base::valid_cap_contexts()
+	 * @param ModelVersionInfo $model_version_info
+	 * @param string           $primary_key_string   result of EEM_Base::get_index_primary_key_string(), so that we can
+	 *                                               use this with models that have no primary key
+	 * @return array ready for converting into json
+	 */
+	public static function filterOutInaccessibleEntityFields(
+		$entity,
+		$model,
+		$request_type,
+		$model_version_info,
+		$primary_key_string = null
+	) {
+		// if they didn't provide the primary key string, we'll just hope we can figure it out
+		// from the entity (although it's preferred client code does it, because the entity might be missing
+		// necessary fields for creating the primary key string, or they could be named differently)
+		if ($primary_key_string === null) {
+			$primary_key_string = $model->get_index_primary_key_string(
+				$model->deduce_fields_n_values_from_cols_n_values($entity)
+			);
+		}
+		// we only care to do this for frontend reads and when the user can't edit the item
+		if ($request_type !== EEM_Base::caps_read
+			|| $model->exists(
+				$model->alter_query_params_to_restrict_by_ID(
+					$primary_key_string,
+					array(
+						'default_where_conditions' => 'none',
+						'caps'                     => EEM_Base::caps_edit,
+					)
+				)
+			)
+		) {
+			return $entity;
+		}
+		foreach ($model->field_settings() as $field_name => $field_obj) {
+			if ($model_version_info->fieldHasRenderedFormat($field_obj)
+				&& isset($entity[$field_name])
+				&& is_array($entity[$field_name])
+				&& isset($entity[$field_name]['raw'])
+			) {
+				unset($entity[$field_name]['raw']);
+			}
+		}
+		// theoretically we may want to filter out specific fields for specific models
+		return apply_filters(
+			'FHEE__Capabilities__filter_out_inaccessible_entity_fields',
+			$entity,
+			$model,
+			$request_type
+		);
+	}
 
 
-    /**
-     * Verifies the current user has at least partial access to do this action on this model.
-     * If not, throws an exception (so we can define the code that sets up this error object
-     * once)
-     *
-     * @param EEM_Base $model
-     * @param string   $model_action_context
-     * @param string   $action_name
-     * @return void
-     * @throws RestException
-     */
-    public static function verifyAtLeastPartialAccessTo($model, $model_action_context, $action_name = 'list')
-    {
-        if (! Capabilities::currentUserHasPartialAccessTo($model, $model_action_context)) {
-            $model_name_plural = EEH_Inflector::pluralize_and_lower($model->get_this_model_name());
-            throw new RestException(
-                sprintf('rest_cannot_%s_%s', strtolower($action_name), $model_name_plural),
-                sprintf(
-                    __('Sorry, you are not allowed to %1$s %2$s. Missing permissions: %3$s', 'event_espresso'),
-                    $action_name,
-                    $model_name_plural,
-                    Capabilities::getMissingPermissionsString($model, $model_action_context)
-                ),
-                array('status' => 403)
-            );
-        }
-    }
+	/**
+	 * Verifies the current user has at least partial access to do this action on this model.
+	 * If not, throws an exception (so we can define the code that sets up this error object
+	 * once)
+	 *
+	 * @param EEM_Base $model
+	 * @param string   $model_action_context
+	 * @param string   $action_name
+	 * @return void
+	 * @throws RestException
+	 */
+	public static function verifyAtLeastPartialAccessTo($model, $model_action_context, $action_name = 'list')
+	{
+		if (! Capabilities::currentUserHasPartialAccessTo($model, $model_action_context)) {
+			$model_name_plural = EEH_Inflector::pluralize_and_lower($model->get_this_model_name());
+			throw new RestException(
+				sprintf('rest_cannot_%s_%s', strtolower($action_name), $model_name_plural),
+				sprintf(
+					__('Sorry, you are not allowed to %1$s %2$s. Missing permissions: %3$s', 'event_espresso'),
+					$action_name,
+					$model_name_plural,
+					Capabilities::getMissingPermissionsString($model, $model_action_context)
+				),
+				array('status' => 403)
+			);
+		}
+	}
 }

Spacing +1 added lines, -1 removed lines

@@ -149,7 +149,7 @@
      */
     public static function verifyAtLeastPartialAccessTo($model, $model_action_context, $action_name = 'list')
     {
-        if (! Capabilities::currentUserHasPartialAccessTo($model, $model_action_context)) {
+        if ( ! Capabilities::currentUserHasPartialAccessTo($model, $model_action_context)) {
             $model_name_plural = EEH_Inflector::pluralize_and_lower($model->get_this_model_name());
             throw new RestException(
                 sprintf('rest_cannot_%s_%s', strtolower($action_name), $model_name_plural),

core/libraries/rest_api/ModelVersionInfo.php

Indentation +436 added lines, -436 removed lines

@@ -21,440 +21,440 @@
 class ModelVersionInfo
 {
 
-    /**
-     * Constant used in the $_model_changes array to indicate that a model
-     * was completely new in this version
-     */
-    const MODEL_ADDED = 'model_added_in_this_version';
-
-    /**
-     * Top-level keys are versions (major and minor version numbers, eg "4.6")
-     * next-level keys are model names (eg "Event") that underwent some change in that version
-     * and the value is either Model_Version_Info::model_added (indicating the model is completely NEW in this version),
-     * or it's an array where the values are model field names,
-     * or API resource properties (ie, non-model fields that appear in REST API results)
-     * If a version is missing then we don't know anything about what changes it introduced from the previous version
-     *
-     * @var array
-     */
-    protected $model_changes = array();
-
-    /**
-     * top-level keys are version numbers,
-     * next-level keys are model CLASSNAMES (even parent classnames),
-     * and next-level keys are extra resource properties to attach to those models' resources,
-     * and next-level key-value pairs, where the keys are:
-     * 'raw', 'type', 'nullable', 'table_alias', 'table_column',  'always_available'
-     *
-     * @var array
-     */
-    protected $resource_changes = array();
-
-    /**
-     * @var string indicating what version of the API was requested
-     * (eg although core might be at version 4.8.11, they may have sent a request
-     * for 4.6)
-     */
-    protected $requested_version = null;
-
-    /**
-     * Keys are model names, values are their classnames.
-     * We cache this so we only need to calculate this once per request
-     *
-     * @var array
-     */
-    protected $cached_models_for_requested_version = null;
-
-    /**
-     * @var array
-     */
-    protected $cached_model_changes_between_requested_version_and_current = null;
-
-    /**
-     * @var array
-     */
-    protected $cached_resource_changes_between_requested_version_and_current = null;
-
-    /**
-     * 2d array where top-level keys are model names, 2nd-level keys are field names
-     * and values are the actual field objects
-     *
-     * @var array
-     */
-    protected $cached_fields_on_models = array();
-
-
-    /**
-     * Model_Version_Info constructor.
-     *
-     * @param string $requested_version
-     */
-    public function __construct($requested_version)
-    {
-        $this->requested_version = (string)$requested_version;
-        $this->model_changes = array(
-            '4.8.29' => array(
-                // first version where the REST API is in EE core, so no need
-                // to specify how its different from the previous
-            ),
-        );
-        // setup data for "extra" fields added onto resources which don't actually exist on models
-        $this->resource_changes = apply_filters(
-            'FHEE__Model_Version_Info___construct__extra_resource_properties_for_models',
-            array()
-        );
-        $defaults = array(
-            'raw'              => false,
-            'type'             => 'N/A',
-            'nullable'         => true,
-            'table_alias'      => 'N/A',
-            'table_column'     => 'N/A',
-            'always_available' => true,
-        );
-        foreach ($this->resource_changes as $version => $model_classnames) {
-            foreach ($model_classnames as $model_classname => $extra_fields) {
-                foreach ($extra_fields as $fieldname => $field_data) {
-                    $this->resource_changes[$model_classname][$fieldname]['name'] = $fieldname;
-                    foreach ($defaults as $attribute => $default_value) {
-                        if (! isset($this->resource_changes[$model_classname][$fieldname][$attribute])) {
-                            $this->resource_changes[$model_classname][$fieldname][$attribute] = $default_value;
-                        }
-                    }
-                }
-            }
-        }
-    }
-
-
-    /**
-     * Returns a slice of Model_Version_Info::model_changes()'s array
-     * indicating exactly what changes happened between the current core version,
-     * and the version requested
-     *
-     * @return array
-     */
-    public function modelChangesBetweenRequestedVersionAndCurrent()
-    {
-        if ($this->cached_model_changes_between_requested_version_and_current === null) {
-            $model_changes = array();
-            foreach ($this->modelChanges() as $version => $models_changed_in_version) {
-                if ($version <= EED_Core_Rest_Api::core_version() && $version > $this->requestedVersion()) {
-                    $model_changes[$version] = $models_changed_in_version;
-                }
-            }
-            $this->cached_model_changes_between_requested_version_and_current = $model_changes;
-        }
-        return $this->cached_model_changes_between_requested_version_and_current;
-    }
-
-
-    /**
-     * Returns a slice of Model_Version_Info::model_changes()'s array
-     * indicating exactly what changes happened between the current core version,
-     * and the version requested
-     *
-     * @return array
-     */
-    public function resourceChangesBetweenRequestedVersionAndCurrent()
-    {
-        if ($this->cached_resource_changes_between_requested_version_and_current === null) {
-            $resource_changes = array();
-            foreach ($this->resourceChanges() as $version => $model_classnames) {
-                if ($version <= EED_Core_Rest_Api::core_version() && $version > $this->requestedVersion()) {
-                    $resource_changes[$version] = $model_classnames;
-                }
-            }
-            $this->cached_resource_changes_between_requested_version_and_current = $resource_changes;
-        }
-        return $this->cached_resource_changes_between_requested_version_and_current;
-    }
-
-
-    /**
-     * If a request was sent to 'wp-json/ee/v4.7/events' this would be '4.7'
-     *
-     * @return string like '4.6'
-     */
-    public function requestedVersion()
-    {
-        return $this->requested_version;
-    }
-
-
-    /**
-     * Returns an array describing how the models have changed in each version of core
-     * that supports the API (starting at 4.6)
-     * Top-level keys are versions (major and minor version numbers, eg "4.6")
-     * next-level keys are model names (eg "Event") that underwent some change in that version
-     * and the value is either NULL (indicating the model is completely NEW in this version),
-     * or it's an array where fields are value names.
-     * If a version is missing then we don't know anything about what changes it introduced from the previous version
-     *
-     * @return array
-     */
-    public function modelChanges()
-    {
-        return $this->model_changes;
-    }
-
-
-    /**
-     * Takes into account the requested version, and the current version, and
-     * what changed between the two, and tries to return.
-     * Analogous to EE_Registry::instance()->non_abstract_db_models
-     *
-     * @return array keys are model names, values are their classname
-     */
-    public function modelsForRequestedVersion()
-    {
-        if ($this->cached_models_for_requested_version === null) {
-            $all_models_in_current_version = EE_Registry::instance()->non_abstract_db_models;
-            foreach ($this->modelChangesBetweenRequestedVersionAndCurrent() as $version => $models_changed) {
-                foreach ($models_changed as $model_name => $new_indicator_or_fields_added) {
-                    if ($new_indicator_or_fields_added === ModelVersionInfo::MODEL_ADDED) {
-                        unset($all_models_in_current_version[$model_name]);
-                    }
-                }
-            }
-            $this->cached_models_for_requested_version = apply_filters(
-                'FHEE__EventEspresso_core_libraries_rest_api__models_for_requested_version',
-                $all_models_in_current_version,
-                $this
-            );
-        }
-        return $this->cached_models_for_requested_version;
-    }
-
-
-    /**
-     * Determines if this is a valid model name in the requested version.
-     * Similar to EE_Registry::instance()->is_model_name(), but takes the requested
-     * version's models into account
-     *
-     * @param string $model_name eg 'Event'
-     * @return boolean
-     */
-    public function isModelNameInThisVersion($model_name)
-    {
-        $model_names = $this->modelsForRequestedVersion();
-        if (isset($model_names[$model_name])) {
-            return true;
-        } else {
-            return false;
-        }
-    }
-
-
-    /**
-     * Wrapper for EE_Registry::instance()->load_model(), but takes the requested
-     * version's models into account
-     *
-     * @param string $model_name
-     * @return \EEM_Base
-     * @throws \EE_Error
-     */
-    public function loadModel($model_name)
-    {
-        if ($this->isModelNameInThisVersion($model_name)) {
-            return EE_Registry::instance()->load_model($model_name);
-        } else {
-            throw new \EE_Error(
-                sprintf(
-                    __(
-                        'Cannot load model "%1$s" because it does not exist in version %2$s of Event Espresso',
-                        'event_espresso'
-                    ),
-                    $model_name,
-                    $this->requestedVersion()
-                )
-            );
-        }
-    }
-
-
-    /**
-     * Gets all the fields that should exist on this model right now
-     *
-     * @param \EEM_Base $model
-     * @return array|\EE_Model_Field_Base[]
-     */
-    public function fieldsOnModelInThisVersion($model)
-    {
-        if (! isset($this->cached_fields_on_models[$model->get_this_model_name()])) {
-            // get all model changes between the requested version and current core version
-            $changes = $this->modelChangesBetweenRequestedVersionAndCurrent();
-            // fetch all fields currently on this model
-            $current_fields = $model->field_settings();
-            // remove all fields that have been added since
-            foreach ($changes as $version => $changes_in_version) {
-                if (isset($changes_in_version[$model->get_this_model_name()])
-                    && $changes_in_version[$model->get_this_model_name()] !== ModelVersionInfo::MODEL_ADDED
-                ) {
-                    $current_fields = array_diff_key(
-                        $current_fields,
-                        array_flip($changes_in_version[$model->get_this_model_name()])
-                    );
-                }
-            }
-            $this->cached_fields_on_models = $current_fields;
-        }
-        return $this->cached_fields_on_models;
-    }
-
-
-    /**
-     * Determines if $object is of one of the classes of $classes. Similar to
-     * in_array(), except this checks if $object is a subclass of the classnames provided
-     * in $classnames
-     *
-     * @param object $object
-     * @param array  $classnames
-     * @return boolean
-     */
-    public function isSubclassOfOne($object, $classnames)
-    {
-        foreach ($classnames as $classname) {
-            if (is_a($object, $classname)) {
-                return true;
-            }
-        }
-        return false;
-    }
-
-
-    /**
-     * Returns the list of model field classes that that the API basically ignores
-     *
-     * @return array
-     */
-    public function fieldsIgnored()
-    {
-        return apply_filters(
-            'FHEE__Controller_Model_Read_fields_ignored',
-            array('EE_Foreign_Key_Field_Base', 'EE_Any_Foreign_Model_Name_Field')
-        );
-    }
-
-
-    /**
-     * If this field one that should be ignored by the API?
-     *
-     * @param EE_Model_Field_Base
-     * @return boolean
-     */
-    public function fieldIsIgnored($field_obj)
-    {
-        return $this->isSubclassOfOne($field_obj, $this->fieldsIgnored());
-    }
-
-
-    /**
-     * Returns the list of model field classes that have a "raw" and non-raw formats.
-     * Normally the "raw" versions are only accessible to those who can edit them.
-     *
-     * @return array an array of EE_Model_Field_Base child classnames
-     */
-    public function fieldsThatHaveRenderedFormat()
-    {
-        return apply_filters(
-            'FHEE__Controller_Model_Read__fields_raw',
-            array('EE_Post_Content_Field', 'EE_Full_HTML_Field')
-        );
-    }
-
-
-    /**
-     * If this field one that has a raw format
-     *
-     * @param EE_Model_Field_Base
-     * @return boolean
-     */
-    public function fieldHasRenderedFormat($field_obj)
-    {
-        return $this->isSubclassOfOne($field_obj, $this->fieldsThatHaveRenderedFormat());
-    }
-
-
-    /**
-     * Returns the list of model field classes that have a "_pretty" and non-pretty versions.
-     * The pretty version of the field is NOT query-able or editable, but requires no extra permissions
-     * to view
-     *
-     * @return array an array of EE_Model_Field_Base child classnames
-     */
-    public function fieldsThatHavePrettyFormat()
-    {
-        return apply_filters(
-            'FHEE__Controller_Model_Read__fields_pretty',
-            array('EE_Enum_Integer_Field', 'EE_Enum_Text_Field', 'EE_Money_Field')
-        );
-    }
-
-
-    /**
-     * If this field one that has a pretty equivalent
-     *
-     * @param EE_Model_Field_Base
-     * @return boolean
-     */
-    public function fieldHasPrettyFormat($field_obj)
-    {
-        return $this->isSubclassOfOne($field_obj, $this->fieldsThatHavePrettyFormat());
-    }
-
-
-    /**
-     * Returns an array describing what extra API resource properties have been added through the versions
-     *
-     * @return array @see $this->_extra_resource_properties_for_models
-     */
-    public function resourceChanges()
-    {
-        return $this->resource_changes;
-    }
-
-
-    /**
-     * Returns an array where keys are extra resource properties in this version of the API,
-     * and values are key-value pairs describing the new properties. @see Model_Version::_resource_changes
-     *
-     * @param \EEM_Base $model
-     * @return array
-     */
-    public function extraResourcePropertiesForModel($model)
-    {
-        $extra_properties = array();
-        foreach ($this->resourceChangesBetweenRequestedVersionAndCurrent() as $version => $model_classnames) {
-            foreach ($model_classnames as $model_classname => $properties_added_in_this_version) {
-                if (is_subclass_of($model, $model_classname)) {
-                    $extra_properties = array_merge($extra_properties, $properties_added_in_this_version);
-                }
-            }
-        }
-        return $extra_properties;
-    }
-
-
-    /**
-     * Gets all the related models for the specified model. It's good to use this
-     * in case this model didn't exist for this version or something
-     *
-     * @param \EEM_Base $model
-     * @return \EE_Model_Relation_Base[]
-     */
-    public function relationSettings(\EEM_Base $model)
-    {
-        $relations = array();
-        foreach ($model->relation_settings() as $relation_name => $relation_obj) {
-            if ($this->isModelNameInThisVersion($relation_name)) {
-                $relations[$relation_name] = $relation_obj;
-            }
-        }
-        // filter the results, but use the old filter name
-        return apply_filters(
-            'FHEE__Read__create_entity_from_wpdb_result__related_models_to_include',
-            $relations,
-            $model
-        );
-    }
+	/**
+	 * Constant used in the $_model_changes array to indicate that a model
+	 * was completely new in this version
+	 */
+	const MODEL_ADDED = 'model_added_in_this_version';
+
+	/**
+	 * Top-level keys are versions (major and minor version numbers, eg "4.6")
+	 * next-level keys are model names (eg "Event") that underwent some change in that version
+	 * and the value is either Model_Version_Info::model_added (indicating the model is completely NEW in this version),
+	 * or it's an array where the values are model field names,
+	 * or API resource properties (ie, non-model fields that appear in REST API results)
+	 * If a version is missing then we don't know anything about what changes it introduced from the previous version
+	 *
+	 * @var array
+	 */
+	protected $model_changes = array();
+
+	/**
+	 * top-level keys are version numbers,
+	 * next-level keys are model CLASSNAMES (even parent classnames),
+	 * and next-level keys are extra resource properties to attach to those models' resources,
+	 * and next-level key-value pairs, where the keys are:
+	 * 'raw', 'type', 'nullable', 'table_alias', 'table_column',  'always_available'
+	 *
+	 * @var array
+	 */
+	protected $resource_changes = array();
+
+	/**
+	 * @var string indicating what version of the API was requested
+	 * (eg although core might be at version 4.8.11, they may have sent a request
+	 * for 4.6)
+	 */
+	protected $requested_version = null;
+
+	/**
+	 * Keys are model names, values are their classnames.
+	 * We cache this so we only need to calculate this once per request
+	 *
+	 * @var array
+	 */
+	protected $cached_models_for_requested_version = null;
+
+	/**
+	 * @var array
+	 */
+	protected $cached_model_changes_between_requested_version_and_current = null;
+
+	/**
+	 * @var array
+	 */
+	protected $cached_resource_changes_between_requested_version_and_current = null;
+
+	/**
+	 * 2d array where top-level keys are model names, 2nd-level keys are field names
+	 * and values are the actual field objects
+	 *
+	 * @var array
+	 */
+	protected $cached_fields_on_models = array();
+
+
+	/**
+	 * Model_Version_Info constructor.
+	 *
+	 * @param string $requested_version
+	 */
+	public function __construct($requested_version)
+	{
+		$this->requested_version = (string)$requested_version;
+		$this->model_changes = array(
+			'4.8.29' => array(
+				// first version where the REST API is in EE core, so no need
+				// to specify how its different from the previous
+			),
+		);
+		// setup data for "extra" fields added onto resources which don't actually exist on models
+		$this->resource_changes = apply_filters(
+			'FHEE__Model_Version_Info___construct__extra_resource_properties_for_models',
+			array()
+		);
+		$defaults = array(
+			'raw'              => false,
+			'type'             => 'N/A',
+			'nullable'         => true,
+			'table_alias'      => 'N/A',
+			'table_column'     => 'N/A',
+			'always_available' => true,
+		);
+		foreach ($this->resource_changes as $version => $model_classnames) {
+			foreach ($model_classnames as $model_classname => $extra_fields) {
+				foreach ($extra_fields as $fieldname => $field_data) {
+					$this->resource_changes[$model_classname][$fieldname]['name'] = $fieldname;
+					foreach ($defaults as $attribute => $default_value) {
+						if (! isset($this->resource_changes[$model_classname][$fieldname][$attribute])) {
+							$this->resource_changes[$model_classname][$fieldname][$attribute] = $default_value;
+						}
+					}
+				}
+			}
+		}
+	}
+
+
+	/**
+	 * Returns a slice of Model_Version_Info::model_changes()'s array
+	 * indicating exactly what changes happened between the current core version,
+	 * and the version requested
+	 *
+	 * @return array
+	 */
+	public function modelChangesBetweenRequestedVersionAndCurrent()
+	{
+		if ($this->cached_model_changes_between_requested_version_and_current === null) {
+			$model_changes = array();
+			foreach ($this->modelChanges() as $version => $models_changed_in_version) {
+				if ($version <= EED_Core_Rest_Api::core_version() && $version > $this->requestedVersion()) {
+					$model_changes[$version] = $models_changed_in_version;
+				}
+			}
+			$this->cached_model_changes_between_requested_version_and_current = $model_changes;
+		}
+		return $this->cached_model_changes_between_requested_version_and_current;
+	}
+
+
+	/**
+	 * Returns a slice of Model_Version_Info::model_changes()'s array
+	 * indicating exactly what changes happened between the current core version,
+	 * and the version requested
+	 *
+	 * @return array
+	 */
+	public function resourceChangesBetweenRequestedVersionAndCurrent()
+	{
+		if ($this->cached_resource_changes_between_requested_version_and_current === null) {
+			$resource_changes = array();
+			foreach ($this->resourceChanges() as $version => $model_classnames) {
+				if ($version <= EED_Core_Rest_Api::core_version() && $version > $this->requestedVersion()) {
+					$resource_changes[$version] = $model_classnames;
+				}
+			}
+			$this->cached_resource_changes_between_requested_version_and_current = $resource_changes;
+		}
+		return $this->cached_resource_changes_between_requested_version_and_current;
+	}
+
+
+	/**
+	 * If a request was sent to 'wp-json/ee/v4.7/events' this would be '4.7'
+	 *
+	 * @return string like '4.6'
+	 */
+	public function requestedVersion()
+	{
+		return $this->requested_version;
+	}
+
+
+	/**
+	 * Returns an array describing how the models have changed in each version of core
+	 * that supports the API (starting at 4.6)
+	 * Top-level keys are versions (major and minor version numbers, eg "4.6")
+	 * next-level keys are model names (eg "Event") that underwent some change in that version
+	 * and the value is either NULL (indicating the model is completely NEW in this version),
+	 * or it's an array where fields are value names.
+	 * If a version is missing then we don't know anything about what changes it introduced from the previous version
+	 *
+	 * @return array
+	 */
+	public function modelChanges()
+	{
+		return $this->model_changes;
+	}
+
+
+	/**
+	 * Takes into account the requested version, and the current version, and
+	 * what changed between the two, and tries to return.
+	 * Analogous to EE_Registry::instance()->non_abstract_db_models
+	 *
+	 * @return array keys are model names, values are their classname
+	 */
+	public function modelsForRequestedVersion()
+	{
+		if ($this->cached_models_for_requested_version === null) {
+			$all_models_in_current_version = EE_Registry::instance()->non_abstract_db_models;
+			foreach ($this->modelChangesBetweenRequestedVersionAndCurrent() as $version => $models_changed) {
+				foreach ($models_changed as $model_name => $new_indicator_or_fields_added) {
+					if ($new_indicator_or_fields_added === ModelVersionInfo::MODEL_ADDED) {
+						unset($all_models_in_current_version[$model_name]);
+					}
+				}
+			}
+			$this->cached_models_for_requested_version = apply_filters(
+				'FHEE__EventEspresso_core_libraries_rest_api__models_for_requested_version',
+				$all_models_in_current_version,
+				$this
+			);
+		}
+		return $this->cached_models_for_requested_version;
+	}
+
+
+	/**
+	 * Determines if this is a valid model name in the requested version.
+	 * Similar to EE_Registry::instance()->is_model_name(), but takes the requested
+	 * version's models into account
+	 *
+	 * @param string $model_name eg 'Event'
+	 * @return boolean
+	 */
+	public function isModelNameInThisVersion($model_name)
+	{
+		$model_names = $this->modelsForRequestedVersion();
+		if (isset($model_names[$model_name])) {
+			return true;
+		} else {
+			return false;
+		}
+	}
+
+
+	/**
+	 * Wrapper for EE_Registry::instance()->load_model(), but takes the requested
+	 * version's models into account
+	 *
+	 * @param string $model_name
+	 * @return \EEM_Base
+	 * @throws \EE_Error
+	 */
+	public function loadModel($model_name)
+	{
+		if ($this->isModelNameInThisVersion($model_name)) {
+			return EE_Registry::instance()->load_model($model_name);
+		} else {
+			throw new \EE_Error(
+				sprintf(
+					__(
+						'Cannot load model "%1$s" because it does not exist in version %2$s of Event Espresso',
+						'event_espresso'
+					),
+					$model_name,
+					$this->requestedVersion()
+				)
+			);
+		}
+	}
+
+
+	/**
+	 * Gets all the fields that should exist on this model right now
+	 *
+	 * @param \EEM_Base $model
+	 * @return array|\EE_Model_Field_Base[]
+	 */
+	public function fieldsOnModelInThisVersion($model)
+	{
+		if (! isset($this->cached_fields_on_models[$model->get_this_model_name()])) {
+			// get all model changes between the requested version and current core version
+			$changes = $this->modelChangesBetweenRequestedVersionAndCurrent();
+			// fetch all fields currently on this model
+			$current_fields = $model->field_settings();
+			// remove all fields that have been added since
+			foreach ($changes as $version => $changes_in_version) {
+				if (isset($changes_in_version[$model->get_this_model_name()])
+					&& $changes_in_version[$model->get_this_model_name()] !== ModelVersionInfo::MODEL_ADDED
+				) {
+					$current_fields = array_diff_key(
+						$current_fields,
+						array_flip($changes_in_version[$model->get_this_model_name()])
+					);
+				}
+			}
+			$this->cached_fields_on_models = $current_fields;
+		}
+		return $this->cached_fields_on_models;
+	}
+
+
+	/**
+	 * Determines if $object is of one of the classes of $classes. Similar to
+	 * in_array(), except this checks if $object is a subclass of the classnames provided
+	 * in $classnames
+	 *
+	 * @param object $object
+	 * @param array  $classnames
+	 * @return boolean
+	 */
+	public function isSubclassOfOne($object, $classnames)
+	{
+		foreach ($classnames as $classname) {
+			if (is_a($object, $classname)) {
+				return true;
+			}
+		}
+		return false;
+	}
+
+
+	/**
+	 * Returns the list of model field classes that that the API basically ignores
+	 *
+	 * @return array
+	 */
+	public function fieldsIgnored()
+	{
+		return apply_filters(
+			'FHEE__Controller_Model_Read_fields_ignored',
+			array('EE_Foreign_Key_Field_Base', 'EE_Any_Foreign_Model_Name_Field')
+		);
+	}
+
+
+	/**
+	 * If this field one that should be ignored by the API?
+	 *
+	 * @param EE_Model_Field_Base
+	 * @return boolean
+	 */
+	public function fieldIsIgnored($field_obj)
+	{
+		return $this->isSubclassOfOne($field_obj, $this->fieldsIgnored());
+	}
+
+
+	/**
+	 * Returns the list of model field classes that have a "raw" and non-raw formats.
+	 * Normally the "raw" versions are only accessible to those who can edit them.
+	 *
+	 * @return array an array of EE_Model_Field_Base child classnames
+	 */
+	public function fieldsThatHaveRenderedFormat()
+	{
+		return apply_filters(
+			'FHEE__Controller_Model_Read__fields_raw',
+			array('EE_Post_Content_Field', 'EE_Full_HTML_Field')
+		);
+	}
+
+
+	/**
+	 * If this field one that has a raw format
+	 *
+	 * @param EE_Model_Field_Base
+	 * @return boolean
+	 */
+	public function fieldHasRenderedFormat($field_obj)
+	{
+		return $this->isSubclassOfOne($field_obj, $this->fieldsThatHaveRenderedFormat());
+	}
+
+
+	/**
+	 * Returns the list of model field classes that have a "_pretty" and non-pretty versions.
+	 * The pretty version of the field is NOT query-able or editable, but requires no extra permissions
+	 * to view
+	 *
+	 * @return array an array of EE_Model_Field_Base child classnames
+	 */
+	public function fieldsThatHavePrettyFormat()
+	{
+		return apply_filters(
+			'FHEE__Controller_Model_Read__fields_pretty',
+			array('EE_Enum_Integer_Field', 'EE_Enum_Text_Field', 'EE_Money_Field')
+		);
+	}
+
+
+	/**
+	 * If this field one that has a pretty equivalent
+	 *
+	 * @param EE_Model_Field_Base
+	 * @return boolean
+	 */
+	public function fieldHasPrettyFormat($field_obj)
+	{
+		return $this->isSubclassOfOne($field_obj, $this->fieldsThatHavePrettyFormat());
+	}
+
+
+	/**
+	 * Returns an array describing what extra API resource properties have been added through the versions
+	 *
+	 * @return array @see $this->_extra_resource_properties_for_models
+	 */
+	public function resourceChanges()
+	{
+		return $this->resource_changes;
+	}
+
+
+	/**
+	 * Returns an array where keys are extra resource properties in this version of the API,
+	 * and values are key-value pairs describing the new properties. @see Model_Version::_resource_changes
+	 *
+	 * @param \EEM_Base $model
+	 * @return array
+	 */
+	public function extraResourcePropertiesForModel($model)
+	{
+		$extra_properties = array();
+		foreach ($this->resourceChangesBetweenRequestedVersionAndCurrent() as $version => $model_classnames) {
+			foreach ($model_classnames as $model_classname => $properties_added_in_this_version) {
+				if (is_subclass_of($model, $model_classname)) {
+					$extra_properties = array_merge($extra_properties, $properties_added_in_this_version);
+				}
+			}
+		}
+		return $extra_properties;
+	}
+
+
+	/**
+	 * Gets all the related models for the specified model. It's good to use this
+	 * in case this model didn't exist for this version or something
+	 *
+	 * @param \EEM_Base $model
+	 * @return \EE_Model_Relation_Base[]
+	 */
+	public function relationSettings(\EEM_Base $model)
+	{
+		$relations = array();
+		foreach ($model->relation_settings() as $relation_name => $relation_obj) {
+			if ($this->isModelNameInThisVersion($relation_name)) {
+				$relations[$relation_name] = $relation_obj;
+			}
+		}
+		// filter the results, but use the old filter name
+		return apply_filters(
+			'FHEE__Read__create_entity_from_wpdb_result__related_models_to_include',
+			$relations,
+			$model
+		);
+	}
 }

Spacing +3 added lines, -3 removed lines

@@ -91,7 +91,7 @@ 
      */
     public function __construct($requested_version)
     {
-        $this->requested_version = (string)$requested_version;
+        $this->requested_version = (string) $requested_version;
         $this->model_changes = array(
             '4.8.29' => array(
                 // first version where the REST API is in EE core, so no need
@@ -116,7 +116,7 @@ 
                 foreach ($extra_fields as $fieldname => $field_data) {
                     $this->resource_changes[$model_classname][$fieldname]['name'] = $fieldname;
                     foreach ($defaults as $attribute => $default_value) {
-                        if (! isset($this->resource_changes[$model_classname][$fieldname][$attribute])) {
+                        if ( ! isset($this->resource_changes[$model_classname][$fieldname][$attribute])) {
                             $this->resource_changes[$model_classname][$fieldname][$attribute] = $default_value;
                         }
                     }
@@ -280,7 +280,7 @@ 
      */
     public function fieldsOnModelInThisVersion($model)
     {
-        if (! isset($this->cached_fields_on_models[$model->get_this_model_name()])) {
+        if ( ! isset($this->cached_fields_on_models[$model->get_this_model_name()])) {
             // get all model changes between the requested version and current core version
             $changes = $this->modelChangesBetweenRequestedVersionAndCurrent();
             // fetch all fields currently on this model