eventespresso / event-espresso-core

core/libraries/form_sections/form_handlers/FormHandler.php

Spacing +17 added lines, -17 removed lines

@@ -171,7 +171,7 @@ 
      */
     public function form($for_display = false)
     {
-        if (! $this->formIsValid()) {
+        if ( ! $this->formIsValid()) {
             return null;
         }
         if ($for_display) {
@@ -274,7 +274,7 @@ 
      */
     public function setFormName($form_name)
     {
-        if (! is_string($form_name)) {
+        if ( ! is_string($form_name)) {
             throw new InvalidDataTypeException('$form_name', $form_name, 'string');
         }
         $this->form_name = $form_name;
@@ -298,7 +298,7 @@ 
      */
     public function setAdminName($admin_name)
     {
-        if (! is_string($admin_name)) {
+        if ( ! is_string($admin_name)) {
             throw new InvalidDataTypeException('$admin_name', $admin_name, 'string');
         }
         $this->admin_name = $admin_name;
@@ -322,7 +322,7 @@ 
      */
     public function setSlug($slug)
     {
-        if (! is_string($slug)) {
+        if ( ! is_string($slug)) {
             throw new InvalidDataTypeException('$slug', $slug, 'string');
         }
         $this->slug = $slug;
@@ -345,7 +345,7 @@ 
      */
     public function setSubmitBtnText($submit_btn_text)
     {
-        if (! is_string($submit_btn_text)) {
+        if ( ! is_string($submit_btn_text)) {
             throw new InvalidDataTypeException('$submit_btn_text', $submit_btn_text, 'string');
         }
         if (empty($submit_btn_text)) {
@@ -374,7 +374,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;
@@ -493,11 +493,11 @@ 
         $text = ! empty($text) ? $text : $this->submitBtnText();
         return new EE_Submit_Input(
             array(
-                'html_name'             => 'ee-form-submit-' . $this->slug(),
-                'html_id'               => 'ee-form-submit-' . $this->slug(),
+                'html_name'             => 'ee-form-submit-'.$this->slug(),
+                'html_id'               => 'ee-form-submit-'.$this->slug(),
                 'html_class'            => 'ee-form-submit',
                 'html_label'            => ' ',
-                'other_html_attributes' => ' rel="' . $this->slug() . '"',
+                'other_html_attributes' => ' rel="'.$this->slug().'"',
                 'default'               => $text,
             )
         );
@@ -513,11 +513,11 @@ 
      */
     public function appendSubmitButton($text = '')
     {
-        if ($this->form->subsection_exists($this->slug() . '-submit-btn')) {
+        if ($this->form->subsection_exists($this->slug().'-submit-btn')) {
             return;
         }
         $this->form->add_subsections(
-            array($this->slug() . '-submit-btn' => $this->generateSubmitButton($text)),
+            array($this->slug().'-submit-btn' => $this->generateSubmitButton($text)),
             null,
             false
         );
@@ -534,11 +534,11 @@ 
     {
         $cancel_button = new EE_Submit_Input(
             array(
-                'html_name'             => 'ee-form-submit-' . $this->slug(), // YES! Same name as submit !!!
-                'html_id'               => 'ee-cancel-form-' . $this->slug(),
+                'html_name'             => 'ee-form-submit-'.$this->slug(), // YES! Same name as submit !!!
+                'html_id'               => 'ee-cancel-form-'.$this->slug(),
                 'html_class'            => 'ee-cancel-form',
                 'html_label'            => ' ',
-                'other_html_attributes' => ' rel="' . $this->slug() . '"',
+                'other_html_attributes' => ' rel="'.$this->slug().'"',
                 'default'               => ! empty($text) ? $text : esc_html__('Cancel', 'event_espresso'),
             )
         );
@@ -558,7 +558,7 @@ 
         $this->form->add_subsections(
             array(
                 'clear-submit-btn-float' => new EE_Form_Section_HTML(
-                    EEH_HTML::div('', '', 'clear-float') . EEH_HTML::divx()
+                    EEH_HTML::div('', '', 'clear-float').EEH_HTML::divx()
                 ),
             ),
             null,
@@ -644,11 +644,11 @@ 
      */
     public function process($submitted_form_data = array())
     {
-        if (! $this->form()->was_submitted($submitted_form_data)) {
+        if ( ! $this->form()->was_submitted($submitted_form_data)) {
             throw new InvalidFormSubmissionException($this->form_name);
         }
         $this->form(true)->receive_form_submission($submitted_form_data);
-        if (! $this->form()->is_valid()) {
+        if ( ! $this->form()->is_valid()) {
             throw new InvalidFormSubmissionException(
                 $this->form_name,
                 sprintf(

Indentation +638 added lines, -638 removed lines

@@ -28,642 +28,642 @@
  */
 abstract class FormHandler implements FormHandlerInterface
 {
-    /**
-     * will add opening and closing HTML form tags as well as a submit button
-     */
-    const ADD_FORM_TAGS_AND_SUBMIT = 'add_form_tags_and_submit';
-
-    /**
-     * will add opening and closing HTML form tags but NOT a submit button
-     */
-    const ADD_FORM_TAGS_ONLY = 'add_form_tags_only';
-
-    /**
-     * will NOT add opening and closing HTML form tags but will add a submit button
-     */
-    const ADD_FORM_SUBMIT_ONLY = 'add_form_submit_only';
-
-    /**
-     * will NOT add opening and closing HTML form tags NOR a submit button
-     */
-    const DO_NOT_SETUP_FORM = 'do_not_setup_form';
-
-    /**
-     * if set to false, then this form has no displayable content,
-     * and will only be used for processing data sent passed via GET or POST
-     * defaults to true ( ie: form has displayable content )
-     *
-     * @var boolean $displayable
-     */
-    private $displayable = true;
-
-    /**
-     * @var string $form_name
-     */
-    private $form_name;
-
-    /**
-     * @var string $admin_name
-     */
-    private $admin_name;
-
-    /**
-     * @var string $slug
-     */
-    private $slug;
-
-    /**
-     * @var string $submit_btn_text
-     */
-    private $submit_btn_text;
-
-    /**
-     * @var string $form_action
-     */
-    private $form_action;
-
-    /**
-     * form params in key value pairs
-     * can be added to form action URL or as hidden inputs
-     *
-     * @var array $form_args
-     */
-    private $form_args = array();
-
-    /**
-     * value of one of the string constant above
-     *
-     * @var string $form_config
-     */
-    private $form_config;
-
-    /**
-     * whether or not the form was determined to be invalid
-     *
-     * @var boolean $form_has_errors
-     */
-    private $form_has_errors;
-
-    /**
-     * the absolute top level form section being used on the page
-     *
-     * @var EE_Form_Section_Proper $form
-     */
-    private $form;
-
-    /**
-     * @var EE_Registry $registry
-     */
-    protected $registry;
-
-    // phpcs:disable PEAR.Functions.ValidDefaultValue.NotAtEnd
-
-
-    /**
-     * Form constructor.
-     *
-     * @param string           $form_name
-     * @param string           $admin_name
-     * @param string           $slug
-     * @param string           $form_action
-     * @param string           $form_config
-     * @param EE_Registry|null $registry
-     */
-    public function __construct(
-        $form_name,
-        $admin_name,
-        $slug,
-        $form_action = '',
-        $form_config = FormHandler::ADD_FORM_TAGS_AND_SUBMIT,
-        EE_Registry $registry = null
-    ) {
-        $this->setFormName($form_name);
-        $this->setAdminName($admin_name);
-        $this->setSlug($slug);
-        $this->setFormAction($form_action);
-        $this->setFormConfig($form_config);
-        $this->setSubmitBtnText(esc_html__('Submit', 'event_espresso'));
-        $this->registry = $registry;
-    }
-
-
-    /**
-     * @return array
-     */
-    public static function getFormConfigConstants()
-    {
-        return array(
-            FormHandler::ADD_FORM_TAGS_AND_SUBMIT,
-            FormHandler::ADD_FORM_TAGS_ONLY,
-            FormHandler::ADD_FORM_SUBMIT_ONLY,
-            FormHandler::DO_NOT_SETUP_FORM,
-        );
-    }
-
-
-    /**
-     * @param bool $for_display
-     * @return EE_Form_Section_Proper
-     * @throws EE_Error
-     * @throws LogicException
-     */
-    public function form($for_display = false)
-    {
-        if (! $this->formIsValid()) {
-            return null;
-        }
-        if ($for_display) {
-            $form_config = $this->formConfig();
-            if (
-                $form_config === FormHandler::ADD_FORM_TAGS_AND_SUBMIT
-                || $form_config === FormHandler::ADD_FORM_SUBMIT_ONLY
-            ) {
-                $this->appendSubmitButton();
-                $this->clearFormButtonFloats();
-            }
-        }
-        return $this->form;
-    }
-
-
-    /**
-     * @return boolean
-     * @throws LogicException
-     */
-    public function formIsValid()
-    {
-        if ($this->form instanceof EE_Form_Section_Proper) {
-            return true;
-        }
-        $form = apply_filters(
-            'FHEE__EventEspresso_core_libraries_form_sections_form_handlers_FormHandler__formIsValid__generated_form_object',
-            $this->generate(),
-            $this
-        );
-        if ($this->verifyForm($form)) {
-            $this->setForm($form);
-        }
-        return true;
-    }
-
-
-    /**
-     * @param EE_Form_Section_Proper|null $form
-     * @return bool
-     * @throws LogicException
-     */
-    public function verifyForm(EE_Form_Section_Proper $form = null)
-    {
-        $form = $form !== null ? $form : $this->form;
-        if ($form instanceof EE_Form_Section_Proper) {
-            return true;
-        }
-        throw new LogicException(
-            sprintf(
-                esc_html__('The "%1$s" form is invalid or missing. %2$s', 'event_espresso'),
-                $this->form_name,
-                var_export($form, true)
-            )
-        );
-    }
-
-
-    /**
-     * @param EE_Form_Section_Proper $form
-     */
-    public function setForm(EE_Form_Section_Proper $form)
-    {
-        $this->form = $form;
-    }
-
-
-    /**
-     * @return boolean
-     */
-    public function displayable()
-    {
-        return $this->displayable;
-    }
-
-
-    /**
-     * @param boolean $displayable
-     */
-    public function setDisplayable($displayable = false)
-    {
-        $this->displayable = filter_var($displayable, FILTER_VALIDATE_BOOLEAN);
-    }
-
-
-    /**
-     * a public name for the form that can be displayed on the frontend of a site
-     *
-     * @return string
-     */
-    public function formName()
-    {
-        return $this->form_name;
-    }
-
-
-    /**
-     * @param string $form_name
-     * @throws InvalidDataTypeException
-     */
-    public function setFormName($form_name)
-    {
-        if (! is_string($form_name)) {
-            throw new InvalidDataTypeException('$form_name', $form_name, 'string');
-        }
-        $this->form_name = $form_name;
-    }
-
-
-    /**
-     * a public name for the form that can be displayed, but only in the admin
-     *
-     * @return string
-     */
-    public function adminName()
-    {
-        return $this->admin_name;
-    }
-
-
-    /**
-     * @param string $admin_name
-     * @throws InvalidDataTypeException
-     */
-    public function setAdminName($admin_name)
-    {
-        if (! is_string($admin_name)) {
-            throw new InvalidDataTypeException('$admin_name', $admin_name, 'string');
-        }
-        $this->admin_name = $admin_name;
-    }
-
-
-    /**
-     * a URL friendly string that can be used for identifying the form
-     *
-     * @return string
-     */
-    public function slug()
-    {
-        return $this->slug;
-    }
-
-
-    /**
-     * @param string $slug
-     * @throws InvalidDataTypeException
-     */
-    public function setSlug($slug)
-    {
-        if (! is_string($slug)) {
-            throw new InvalidDataTypeException('$slug', $slug, 'string');
-        }
-        $this->slug = $slug;
-    }
-
-
-    /**
-     * @return string
-     */
-    public function submitBtnText()
-    {
-        return $this->submit_btn_text;
-    }
-
-
-    /**
-     * @param string $submit_btn_text
-     * @throws InvalidDataTypeException
-     * @throws InvalidArgumentException
-     */
-    public function setSubmitBtnText($submit_btn_text)
-    {
-        if (! is_string($submit_btn_text)) {
-            throw new InvalidDataTypeException('$submit_btn_text', $submit_btn_text, 'string');
-        }
-        if (empty($submit_btn_text)) {
-            throw new InvalidArgumentException(
-                esc_html__('Can not set Submit button text because an empty string was provided.', 'event_espresso')
-            );
-        }
-        $this->submit_btn_text = $submit_btn_text;
-    }
-
-
-    /**
-     * @return string
-     */
-    public function formAction()
-    {
-        return ! empty($this->form_args)
-            ? add_query_arg($this->form_args, $this->form_action)
-            : $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_args
-     * @throws InvalidDataTypeException
-     * @throws InvalidArgumentException
-     */
-    public function addFormActionArgs($form_args = array())
-    {
-        if (is_object($form_args)) {
-            throw new InvalidDataTypeException(
-                '$form_args',
-                $form_args,
-                'anything other than an object was expected.'
-            );
-        }
-        if (empty($form_args)) {
-            throw new InvalidArgumentException(
-                esc_html__('The redirect arguments can not be an empty array.', 'event_espresso')
-            );
-        }
-        $this->form_args = array_merge($this->form_args, $form_args);
-    }
-
-
-    /**
-     * @return string
-     */
-    public function formConfig()
-    {
-        return $this->form_config;
-    }
-
-
-    /**
-     * @param string $form_config
-     * @throws DomainException
-     */
-    public function setFormConfig($form_config)
-    {
-        if (
-            ! in_array(
-                $form_config,
-                array(
-                FormHandler::ADD_FORM_TAGS_AND_SUBMIT,
-                FormHandler::ADD_FORM_TAGS_ONLY,
-                FormHandler::ADD_FORM_SUBMIT_ONLY,
-                FormHandler::DO_NOT_SETUP_FORM,
-                ),
-                true
-            )
-        ) {
-            throw new DomainException(
-                sprintf(
-                    esc_html__(
-                        '"%1$s" is not a valid value for the form config. Please use one of the class constants on \EventEspresso\core\libraries\form_sections\form_handlers\Form',
-                        'event_espresso'
-                    ),
-                    $form_config
-                )
-            );
-        }
-        $this->form_config = $form_config;
-    }
-
-
-    /**
-     * called after the form is instantiated
-     * and used for performing any logic that needs to occur early
-     * before any of the other methods are called.
-     * returns true if everything is ok to proceed,
-     * and false if no further form logic should be implemented
-     *
-     * @return boolean
-     */
-    public function initialize()
-    {
-        $this->form_has_errors = EE_Error::has_error(true);
-        return true;
-    }
-
-
-    /**
-     * used for setting up css and js
-     *
-     * @return void
-     * @throws LogicException
-     * @throws EE_Error
-     */
-    public function enqueueStylesAndScripts()
-    {
-        $this->form()->enqueue_js();
-    }
-
-
-    /**
-     * creates and returns the actual form
-     *
-     * @return EE_Form_Section_Proper
-     */
-    abstract public function generate();
-
-
-    /**
-     * creates and returns an EE_Submit_Input labeled "Submit"
-     *
-     * @param string $text
-     * @return EE_Submit_Input
-     */
-    public function generateSubmitButton($text = '')
-    {
-        $text = ! empty($text) ? $text : $this->submitBtnText();
-        return new EE_Submit_Input(
-            array(
-                'html_name'             => 'ee-form-submit-' . $this->slug(),
-                'html_id'               => 'ee-form-submit-' . $this->slug(),
-                'html_class'            => 'ee-form-submit',
-                'html_label'            => ' ',
-                'other_html_attributes' => ' rel="' . $this->slug() . '"',
-                'default'               => $text,
-            )
-        );
-    }
-
-
-    /**
-     * calls generateSubmitButton() and appends it onto the form along with a float clearing div
-     *
-     * @param string $text
-     * @return void
-     * @throws EE_Error
-     */
-    public function appendSubmitButton($text = '')
-    {
-        if ($this->form->subsection_exists($this->slug() . '-submit-btn')) {
-            return;
-        }
-        $this->form->add_subsections(
-            array($this->slug() . '-submit-btn' => $this->generateSubmitButton($text)),
-            null,
-            false
-        );
-    }
-
-
-    /**
-     * creates and returns an EE_Submit_Input labeled "Cancel"
-     *
-     * @param string $text
-     * @return EE_Submit_Input
-     */
-    public function generateCancelButton($text = '')
-    {
-        $cancel_button = new EE_Submit_Input(
-            array(
-                'html_name'             => 'ee-form-submit-' . $this->slug(), // YES! Same name as submit !!!
-                'html_id'               => 'ee-cancel-form-' . $this->slug(),
-                'html_class'            => 'ee-cancel-form',
-                'html_label'            => ' ',
-                'other_html_attributes' => ' rel="' . $this->slug() . '"',
-                'default'               => ! empty($text) ? $text : esc_html__('Cancel', 'event_espresso'),
-            )
-        );
-        $cancel_button->set_button_css_attributes(false);
-        return $cancel_button;
-    }
-
-
-    /**
-     * appends a float clearing div onto end of form
-     *
-     * @return void
-     * @throws EE_Error
-     */
-    public function clearFormButtonFloats()
-    {
-        $this->form->add_subsections(
-            array(
-                'clear-submit-btn-float' => new EE_Form_Section_HTML(
-                    EEH_HTML::div('', '', 'clear-float') . EEH_HTML::divx()
-                ),
-            ),
-            null,
-            false
-        );
-    }
-
-
-    /**
-     * takes the generated form and displays it along with ony other non-form HTML that may be required
-     * returns a string of HTML that can be directly echoed in a template
-     *
-     * @return string
-     * @throws \InvalidArgumentException
-     * @throws \EventEspresso\core\exceptions\InvalidInterfaceException
-     * @throws \EventEspresso\core\exceptions\InvalidDataTypeException
-     * @throws LogicException
-     * @throws EE_Error
-     */
-    public function display()
-    {
-        $form_html = apply_filters(
-            'FHEE__EventEspresso_core_libraries_form_sections_form_handlers_FormHandler__display__before_form',
-            ''
-        );
-        $form_config = $this->formConfig();
-        if (
-            $form_config === FormHandler::ADD_FORM_TAGS_AND_SUBMIT
-            || $form_config === FormHandler::ADD_FORM_TAGS_ONLY
-        ) {
-            $additional_props = $this->requiresMultipartEnctype()
-                ? ' enctype="multipart/form-data"'
-                : '';
-            $form_html .= $this->form()->form_open(
-                $this->formAction(),
-                'POST',
-                $additional_props
-            );
-        }
-        $form_html .= $this->form(true)->get_html();
-        if (
-            $form_config === FormHandler::ADD_FORM_TAGS_AND_SUBMIT
-            || $form_config === FormHandler::ADD_FORM_TAGS_ONLY
-        ) {
-            $form_html .= $this->form()->form_close();
-        }
-        $form_html .= apply_filters(
-            'FHEE__EventEspresso_core_libraries_form_sections_form_handlers_FormHandler__display__after_form',
-            ''
-        );
-        return $form_html;
-    }
-
-    /**
-     * Determines if this form needs "enctype='multipart/form-data'" or not.
-     * @since 4.9.80.p
-     * @return bool
-     * @throws EE_Error
-     */
-    public function requiresMultipartEnctype()
-    {
-        foreach ($this->form()->inputs_in_subsections() as $input) {
-            if ($input instanceof EE_File_Input) {
-                return true;
-            }
-        }
-        return false;
-    }
-
-
-    /**
-     * handles processing the form submission
-     * returns true or false depending on whether the form was processed successfully or not
-     *
-     * @param array $submitted_form_data
-     * @return array
-     * @throws \InvalidArgumentException
-     * @throws \EventEspresso\core\exceptions\InvalidInterfaceException
-     * @throws \EventEspresso\core\exceptions\InvalidDataTypeException
-     * @throws EE_Error
-     * @throws LogicException
-     * @throws InvalidFormSubmissionException
-     */
-    public function process($submitted_form_data = array())
-    {
-        if (! $this->form()->was_submitted($submitted_form_data)) {
-            throw new InvalidFormSubmissionException($this->form_name);
-        }
-        $this->form(true)->receive_form_submission($submitted_form_data);
-        if (! $this->form()->is_valid()) {
-            throw new InvalidFormSubmissionException(
-                $this->form_name,
-                sprintf(
-                    esc_html__(
-                        'The "%1$s" form is invalid. Please correct the following errors and resubmit: %2$s %3$s',
-                        'event_espresso'
-                    ),
-                    $this->form_name,
-                    '<br />',
-                    implode('<br />', $this->form()->get_validation_errors_accumulated())
-                )
-            );
-        }
-        return apply_filters(
-            'FHEE__EventEspresso_core_libraries_form_sections_form_handlers_FormHandler__process__valid_data',
-            $this->form()->valid_data(),
-            $this
-        );
-    }
+	/**
+	 * will add opening and closing HTML form tags as well as a submit button
+	 */
+	const ADD_FORM_TAGS_AND_SUBMIT = 'add_form_tags_and_submit';
+
+	/**
+	 * will add opening and closing HTML form tags but NOT a submit button
+	 */
+	const ADD_FORM_TAGS_ONLY = 'add_form_tags_only';
+
+	/**
+	 * will NOT add opening and closing HTML form tags but will add a submit button
+	 */
+	const ADD_FORM_SUBMIT_ONLY = 'add_form_submit_only';
+
+	/**
+	 * will NOT add opening and closing HTML form tags NOR a submit button
+	 */
+	const DO_NOT_SETUP_FORM = 'do_not_setup_form';
+
+	/**
+	 * if set to false, then this form has no displayable content,
+	 * and will only be used for processing data sent passed via GET or POST
+	 * defaults to true ( ie: form has displayable content )
+	 *
+	 * @var boolean $displayable
+	 */
+	private $displayable = true;
+
+	/**
+	 * @var string $form_name
+	 */
+	private $form_name;
+
+	/**
+	 * @var string $admin_name
+	 */
+	private $admin_name;
+
+	/**
+	 * @var string $slug
+	 */
+	private $slug;
+
+	/**
+	 * @var string $submit_btn_text
+	 */
+	private $submit_btn_text;
+
+	/**
+	 * @var string $form_action
+	 */
+	private $form_action;
+
+	/**
+	 * form params in key value pairs
+	 * can be added to form action URL or as hidden inputs
+	 *
+	 * @var array $form_args
+	 */
+	private $form_args = array();
+
+	/**
+	 * value of one of the string constant above
+	 *
+	 * @var string $form_config
+	 */
+	private $form_config;
+
+	/**
+	 * whether or not the form was determined to be invalid
+	 *
+	 * @var boolean $form_has_errors
+	 */
+	private $form_has_errors;
+
+	/**
+	 * the absolute top level form section being used on the page
+	 *
+	 * @var EE_Form_Section_Proper $form
+	 */
+	private $form;
+
+	/**
+	 * @var EE_Registry $registry
+	 */
+	protected $registry;
+
+	// phpcs:disable PEAR.Functions.ValidDefaultValue.NotAtEnd
+
+
+	/**
+	 * Form constructor.
+	 *
+	 * @param string           $form_name
+	 * @param string           $admin_name
+	 * @param string           $slug
+	 * @param string           $form_action
+	 * @param string           $form_config
+	 * @param EE_Registry|null $registry
+	 */
+	public function __construct(
+		$form_name,
+		$admin_name,
+		$slug,
+		$form_action = '',
+		$form_config = FormHandler::ADD_FORM_TAGS_AND_SUBMIT,
+		EE_Registry $registry = null
+	) {
+		$this->setFormName($form_name);
+		$this->setAdminName($admin_name);
+		$this->setSlug($slug);
+		$this->setFormAction($form_action);
+		$this->setFormConfig($form_config);
+		$this->setSubmitBtnText(esc_html__('Submit', 'event_espresso'));
+		$this->registry = $registry;
+	}
+
+
+	/**
+	 * @return array
+	 */
+	public static function getFormConfigConstants()
+	{
+		return array(
+			FormHandler::ADD_FORM_TAGS_AND_SUBMIT,
+			FormHandler::ADD_FORM_TAGS_ONLY,
+			FormHandler::ADD_FORM_SUBMIT_ONLY,
+			FormHandler::DO_NOT_SETUP_FORM,
+		);
+	}
+
+
+	/**
+	 * @param bool $for_display
+	 * @return EE_Form_Section_Proper
+	 * @throws EE_Error
+	 * @throws LogicException
+	 */
+	public function form($for_display = false)
+	{
+		if (! $this->formIsValid()) {
+			return null;
+		}
+		if ($for_display) {
+			$form_config = $this->formConfig();
+			if (
+				$form_config === FormHandler::ADD_FORM_TAGS_AND_SUBMIT
+				|| $form_config === FormHandler::ADD_FORM_SUBMIT_ONLY
+			) {
+				$this->appendSubmitButton();
+				$this->clearFormButtonFloats();
+			}
+		}
+		return $this->form;
+	}
+
+
+	/**
+	 * @return boolean
+	 * @throws LogicException
+	 */
+	public function formIsValid()
+	{
+		if ($this->form instanceof EE_Form_Section_Proper) {
+			return true;
+		}
+		$form = apply_filters(
+			'FHEE__EventEspresso_core_libraries_form_sections_form_handlers_FormHandler__formIsValid__generated_form_object',
+			$this->generate(),
+			$this
+		);
+		if ($this->verifyForm($form)) {
+			$this->setForm($form);
+		}
+		return true;
+	}
+
+
+	/**
+	 * @param EE_Form_Section_Proper|null $form
+	 * @return bool
+	 * @throws LogicException
+	 */
+	public function verifyForm(EE_Form_Section_Proper $form = null)
+	{
+		$form = $form !== null ? $form : $this->form;
+		if ($form instanceof EE_Form_Section_Proper) {
+			return true;
+		}
+		throw new LogicException(
+			sprintf(
+				esc_html__('The "%1$s" form is invalid or missing. %2$s', 'event_espresso'),
+				$this->form_name,
+				var_export($form, true)
+			)
+		);
+	}
+
+
+	/**
+	 * @param EE_Form_Section_Proper $form
+	 */
+	public function setForm(EE_Form_Section_Proper $form)
+	{
+		$this->form = $form;
+	}
+
+
+	/**
+	 * @return boolean
+	 */
+	public function displayable()
+	{
+		return $this->displayable;
+	}
+
+
+	/**
+	 * @param boolean $displayable
+	 */
+	public function setDisplayable($displayable = false)
+	{
+		$this->displayable = filter_var($displayable, FILTER_VALIDATE_BOOLEAN);
+	}
+
+
+	/**
+	 * a public name for the form that can be displayed on the frontend of a site
+	 *
+	 * @return string
+	 */
+	public function formName()
+	{
+		return $this->form_name;
+	}
+
+
+	/**
+	 * @param string $form_name
+	 * @throws InvalidDataTypeException
+	 */
+	public function setFormName($form_name)
+	{
+		if (! is_string($form_name)) {
+			throw new InvalidDataTypeException('$form_name', $form_name, 'string');
+		}
+		$this->form_name = $form_name;
+	}
+
+
+	/**
+	 * a public name for the form that can be displayed, but only in the admin
+	 *
+	 * @return string
+	 */
+	public function adminName()
+	{
+		return $this->admin_name;
+	}
+
+
+	/**
+	 * @param string $admin_name
+	 * @throws InvalidDataTypeException
+	 */
+	public function setAdminName($admin_name)
+	{
+		if (! is_string($admin_name)) {
+			throw new InvalidDataTypeException('$admin_name', $admin_name, 'string');
+		}
+		$this->admin_name = $admin_name;
+	}
+
+
+	/**
+	 * a URL friendly string that can be used for identifying the form
+	 *
+	 * @return string
+	 */
+	public function slug()
+	{
+		return $this->slug;
+	}
+
+
+	/**
+	 * @param string $slug
+	 * @throws InvalidDataTypeException
+	 */
+	public function setSlug($slug)
+	{
+		if (! is_string($slug)) {
+			throw new InvalidDataTypeException('$slug', $slug, 'string');
+		}
+		$this->slug = $slug;
+	}
+
+
+	/**
+	 * @return string
+	 */
+	public function submitBtnText()
+	{
+		return $this->submit_btn_text;
+	}
+
+
+	/**
+	 * @param string $submit_btn_text
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidArgumentException
+	 */
+	public function setSubmitBtnText($submit_btn_text)
+	{
+		if (! is_string($submit_btn_text)) {
+			throw new InvalidDataTypeException('$submit_btn_text', $submit_btn_text, 'string');
+		}
+		if (empty($submit_btn_text)) {
+			throw new InvalidArgumentException(
+				esc_html__('Can not set Submit button text because an empty string was provided.', 'event_espresso')
+			);
+		}
+		$this->submit_btn_text = $submit_btn_text;
+	}
+
+
+	/**
+	 * @return string
+	 */
+	public function formAction()
+	{
+		return ! empty($this->form_args)
+			? add_query_arg($this->form_args, $this->form_action)
+			: $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_args
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidArgumentException
+	 */
+	public function addFormActionArgs($form_args = array())
+	{
+		if (is_object($form_args)) {
+			throw new InvalidDataTypeException(
+				'$form_args',
+				$form_args,
+				'anything other than an object was expected.'
+			);
+		}
+		if (empty($form_args)) {
+			throw new InvalidArgumentException(
+				esc_html__('The redirect arguments can not be an empty array.', 'event_espresso')
+			);
+		}
+		$this->form_args = array_merge($this->form_args, $form_args);
+	}
+
+
+	/**
+	 * @return string
+	 */
+	public function formConfig()
+	{
+		return $this->form_config;
+	}
+
+
+	/**
+	 * @param string $form_config
+	 * @throws DomainException
+	 */
+	public function setFormConfig($form_config)
+	{
+		if (
+			! in_array(
+				$form_config,
+				array(
+				FormHandler::ADD_FORM_TAGS_AND_SUBMIT,
+				FormHandler::ADD_FORM_TAGS_ONLY,
+				FormHandler::ADD_FORM_SUBMIT_ONLY,
+				FormHandler::DO_NOT_SETUP_FORM,
+				),
+				true
+			)
+		) {
+			throw new DomainException(
+				sprintf(
+					esc_html__(
+						'"%1$s" is not a valid value for the form config. Please use one of the class constants on \EventEspresso\core\libraries\form_sections\form_handlers\Form',
+						'event_espresso'
+					),
+					$form_config
+				)
+			);
+		}
+		$this->form_config = $form_config;
+	}
+
+
+	/**
+	 * called after the form is instantiated
+	 * and used for performing any logic that needs to occur early
+	 * before any of the other methods are called.
+	 * returns true if everything is ok to proceed,
+	 * and false if no further form logic should be implemented
+	 *
+	 * @return boolean
+	 */
+	public function initialize()
+	{
+		$this->form_has_errors = EE_Error::has_error(true);
+		return true;
+	}
+
+
+	/**
+	 * used for setting up css and js
+	 *
+	 * @return void
+	 * @throws LogicException
+	 * @throws EE_Error
+	 */
+	public function enqueueStylesAndScripts()
+	{
+		$this->form()->enqueue_js();
+	}
+
+
+	/**
+	 * creates and returns the actual form
+	 *
+	 * @return EE_Form_Section_Proper
+	 */
+	abstract public function generate();
+
+
+	/**
+	 * creates and returns an EE_Submit_Input labeled "Submit"
+	 *
+	 * @param string $text
+	 * @return EE_Submit_Input
+	 */
+	public function generateSubmitButton($text = '')
+	{
+		$text = ! empty($text) ? $text : $this->submitBtnText();
+		return new EE_Submit_Input(
+			array(
+				'html_name'             => 'ee-form-submit-' . $this->slug(),
+				'html_id'               => 'ee-form-submit-' . $this->slug(),
+				'html_class'            => 'ee-form-submit',
+				'html_label'            => '&nbsp;',
+				'other_html_attributes' => ' rel="' . $this->slug() . '"',
+				'default'               => $text,
+			)
+		);
+	}
+
+
+	/**
+	 * calls generateSubmitButton() and appends it onto the form along with a float clearing div
+	 *
+	 * @param string $text
+	 * @return void
+	 * @throws EE_Error
+	 */
+	public function appendSubmitButton($text = '')
+	{
+		if ($this->form->subsection_exists($this->slug() . '-submit-btn')) {
+			return;
+		}
+		$this->form->add_subsections(
+			array($this->slug() . '-submit-btn' => $this->generateSubmitButton($text)),
+			null,
+			false
+		);
+	}
+
+
+	/**
+	 * creates and returns an EE_Submit_Input labeled "Cancel"
+	 *
+	 * @param string $text
+	 * @return EE_Submit_Input
+	 */
+	public function generateCancelButton($text = '')
+	{
+		$cancel_button = new EE_Submit_Input(
+			array(
+				'html_name'             => 'ee-form-submit-' . $this->slug(), // YES! Same name as submit !!!
+				'html_id'               => 'ee-cancel-form-' . $this->slug(),
+				'html_class'            => 'ee-cancel-form',
+				'html_label'            => '&nbsp;',
+				'other_html_attributes' => ' rel="' . $this->slug() . '"',
+				'default'               => ! empty($text) ? $text : esc_html__('Cancel', 'event_espresso'),
+			)
+		);
+		$cancel_button->set_button_css_attributes(false);
+		return $cancel_button;
+	}
+
+
+	/**
+	 * appends a float clearing div onto end of form
+	 *
+	 * @return void
+	 * @throws EE_Error
+	 */
+	public function clearFormButtonFloats()
+	{
+		$this->form->add_subsections(
+			array(
+				'clear-submit-btn-float' => new EE_Form_Section_HTML(
+					EEH_HTML::div('', '', 'clear-float') . EEH_HTML::divx()
+				),
+			),
+			null,
+			false
+		);
+	}
+
+
+	/**
+	 * takes the generated form and displays it along with ony other non-form HTML that may be required
+	 * returns a string of HTML that can be directly echoed in a template
+	 *
+	 * @return string
+	 * @throws \InvalidArgumentException
+	 * @throws \EventEspresso\core\exceptions\InvalidInterfaceException
+	 * @throws \EventEspresso\core\exceptions\InvalidDataTypeException
+	 * @throws LogicException
+	 * @throws EE_Error
+	 */
+	public function display()
+	{
+		$form_html = apply_filters(
+			'FHEE__EventEspresso_core_libraries_form_sections_form_handlers_FormHandler__display__before_form',
+			''
+		);
+		$form_config = $this->formConfig();
+		if (
+			$form_config === FormHandler::ADD_FORM_TAGS_AND_SUBMIT
+			|| $form_config === FormHandler::ADD_FORM_TAGS_ONLY
+		) {
+			$additional_props = $this->requiresMultipartEnctype()
+				? ' enctype="multipart/form-data"'
+				: '';
+			$form_html .= $this->form()->form_open(
+				$this->formAction(),
+				'POST',
+				$additional_props
+			);
+		}
+		$form_html .= $this->form(true)->get_html();
+		if (
+			$form_config === FormHandler::ADD_FORM_TAGS_AND_SUBMIT
+			|| $form_config === FormHandler::ADD_FORM_TAGS_ONLY
+		) {
+			$form_html .= $this->form()->form_close();
+		}
+		$form_html .= apply_filters(
+			'FHEE__EventEspresso_core_libraries_form_sections_form_handlers_FormHandler__display__after_form',
+			''
+		);
+		return $form_html;
+	}
+
+	/**
+	 * Determines if this form needs "enctype='multipart/form-data'" or not.
+	 * @since 4.9.80.p
+	 * @return bool
+	 * @throws EE_Error
+	 */
+	public function requiresMultipartEnctype()
+	{
+		foreach ($this->form()->inputs_in_subsections() as $input) {
+			if ($input instanceof EE_File_Input) {
+				return true;
+			}
+		}
+		return false;
+	}
+
+
+	/**
+	 * handles processing the form submission
+	 * returns true or false depending on whether the form was processed successfully or not
+	 *
+	 * @param array $submitted_form_data
+	 * @return array
+	 * @throws \InvalidArgumentException
+	 * @throws \EventEspresso\core\exceptions\InvalidInterfaceException
+	 * @throws \EventEspresso\core\exceptions\InvalidDataTypeException
+	 * @throws EE_Error
+	 * @throws LogicException
+	 * @throws InvalidFormSubmissionException
+	 */
+	public function process($submitted_form_data = array())
+	{
+		if (! $this->form()->was_submitted($submitted_form_data)) {
+			throw new InvalidFormSubmissionException($this->form_name);
+		}
+		$this->form(true)->receive_form_submission($submitted_form_data);
+		if (! $this->form()->is_valid()) {
+			throw new InvalidFormSubmissionException(
+				$this->form_name,
+				sprintf(
+					esc_html__(
+						'The "%1$s" form is invalid. Please correct the following errors and resubmit: %2$s %3$s',
+						'event_espresso'
+					),
+					$this->form_name,
+					'<br />',
+					implode('<br />', $this->form()->get_validation_errors_accumulated())
+				)
+			);
+		}
+		return apply_filters(
+			'FHEE__EventEspresso_core_libraries_form_sections_form_handlers_FormHandler__process__valid_data',
+			$this->form()->valid_data(),
+			$this
+		);
+	}
 }

core/libraries/form_sections/form_handlers/SequentialStepForm.php

Spacing +3 added lines, -3 removed lines

@@ -113,7 +113,7 @@ 
     public function setOrder($order)
     {
         $order = absint($order);
-        if (! $order > 0) {
+        if ( ! $order > 0) {
             throw new InvalidArgumentException(
                 esc_html__('The form order property must be a positive integer.', 'event_espresso')
             );
@@ -142,7 +142,7 @@ 
      */
     public function setRedirectUrl($redirect_url)
     {
-        if (! is_string($redirect_url)) {
+        if ( ! is_string($redirect_url)) {
             throw new InvalidDataTypeException('$redirect_url', $redirect_url, 'string');
         }
         if (empty($redirect_url)) {
@@ -199,7 +199,7 @@ 
             );
         }
         foreach ($redirect_arg_keys_to_remove as $redirect_arg_key) {
-            unset($this->redirect_args[ $redirect_arg_key ]);
+            unset($this->redirect_args[$redirect_arg_key]);
         }
     }
 

Indentation +218 added lines, -218 removed lines

@@ -18,224 +18,224 @@
  */
 abstract class SequentialStepForm extends FormHandler implements SequentialStepFormInterface
 {
-    const REDIRECT_TO_NEXT_STEP    = 'redirect_to_next_step';
-
-    const REDIRECT_TO_CURRENT_STEP = 'redirect_to_current_step';
-
-    const REDIRECT_TO_PREV_STEP    = 'redirect_to_prev_step';
-
-    const REDIRECT_TO_OTHER        = 'redirect_to_other';
-
-    /**
-     * numerical value used for sorting form steps
-     *
-     * @var int $order
-     */
-    private $order = 1;
-
-    /**
-     * a final URL with all form related parameters added
-     * that will be used to advance to the next step
-     *
-     * @var string $redirect_url
-     */
-    private $redirect_url = '';
-
-    /**
-     * URL params in key value pairs
-     *
-     * @var array $redirect_args
-     */
-    private $redirect_args = array();
-
-    /**
-     * Which step should be redirected to after form processing.
-     * Usually after successfully processing this value would be REDIRECT_TO_NEXT_STEP
-     * If a form is invalid and requires errors to be corrected,
-     * then this value would be REDIRECT_TO_CURRENT_STEP so that form can be resubmitted
-     * Some form handlers do not have a form that is displayable,
-     * and only perform data processing, but if an error occurs,
-     * then this value needs to be set to REDIRECT_TO_PREV_STEP
-     * since the current step has no displayable content.
-     * if the form is completely finished, and needs to redirect to somewhere
-     * completely different, then this value will be REDIRECT_TO_OTHER
-     *
-     * @var string $redirect_to
-     */
-    private $redirect_to = SequentialStepForm::REDIRECT_TO_CURRENT_STEP;
-
-
-    /**
-     * SequentialStepForm constructor
-     *
-     * @param int              $order
-     * @param string           $form_name
-     * @param string           $admin_name
-     * @param string           $slug
-     * @param string           $form_action
-     * @param string           $form_config
-     * @param EE_Registry|null $registry
-     */
-    public function __construct(
-        $order,
-        $form_name,
-        $admin_name,
-        $slug,
-        $form_action = '',
-        $form_config = 'add_form_tags_and_submit',
-        EE_Registry $registry = null
-    ) {
-        $this->setOrder($order);
-        parent::__construct($form_name, $admin_name, $slug, $form_action, $form_config, $registry);
-    }
-
-
-
-    /**
-     * @return int
-     */
-    public function order()
-    {
-        return $this->order;
-    }
-
-
-
-    /**
-     * @param int $order
-     * @throws InvalidArgumentException
-     */
-    public function setOrder($order)
-    {
-        $order = absint($order);
-        if (! $order > 0) {
-            throw new InvalidArgumentException(
-                esc_html__('The form order property must be a positive integer.', 'event_espresso')
-            );
-        }
-        $this->order = $order;
-    }
-
-
-
-    /**
-     * @return string
-     */
-    public function redirectUrl()
-    {
-        return ! empty($this->redirect_args)
-            ? add_query_arg($this->redirect_args, $this->redirect_url)
-            : $this->redirect_url;
-    }
-
-
-
-    /**
-     * @param string $redirect_url
-     * @throws InvalidDataTypeException
-     * @throws InvalidArgumentException
-     */
-    public function setRedirectUrl($redirect_url)
-    {
-        if (! is_string($redirect_url)) {
-            throw new InvalidDataTypeException('$redirect_url', $redirect_url, 'string');
-        }
-        if (empty($redirect_url)) {
-            throw new InvalidArgumentException(
-                esc_html__('The redirect URL can not be an empty string.', 'event_espresso')
-            );
-        }
-        $this->redirect_url = $redirect_url;
-    }
-
-
-
-    /**
-     * @param array $redirect_args
-     * @throws InvalidDataTypeException
-     * @throws InvalidArgumentException
-     */
-    public function addRedirectArgs($redirect_args = array())
-    {
-        if (is_object($redirect_args)) {
-            throw new InvalidDataTypeException(
-                '$redirect_args',
-                $redirect_args,
-                'anything other than an object was expected.'
-            );
-        }
-        if (empty($redirect_args)) {
-            throw new InvalidArgumentException(
-                esc_html__('The redirect argument can not be an empty array.', 'event_espresso')
-            );
-        }
-        $this->redirect_args = array_merge($this->redirect_args, (array) $redirect_args);
-    }
-
-
-
-    /**
-     * @param array $redirect_arg_keys_to_remove
-     * @throws InvalidDataTypeException
-     * @throws InvalidArgumentException
-     */
-    public function removeRedirectArgs($redirect_arg_keys_to_remove = array())
-    {
-        if (is_object($redirect_arg_keys_to_remove)) {
-            throw new InvalidDataTypeException(
-                '$redirect_arg_keys_to_remove',
-                $redirect_arg_keys_to_remove,
-                'anything other than an object was expected.'
-            );
-        }
-        if (empty($redirect_arg_keys_to_remove)) {
-            throw new InvalidArgumentException(
-                esc_html__('The $redirect_arg_keys_to_remove argument can not be an empty array.', 'event_espresso')
-            );
-        }
-        foreach ($redirect_arg_keys_to_remove as $redirect_arg_key) {
-            unset($this->redirect_args[ $redirect_arg_key ]);
-        }
-    }
-
-
-
-    /**
-     * @return string
-     */
-    public function redirectTo()
-    {
-        return $this->redirect_to;
-    }
-
-
-
-    /**
-     * @param string $redirect_to
-     * @throws InvalidDataTypeException
-     */
-    public function setRedirectTo($redirect_to)
-    {
-        if (
-            ! in_array(
-                $redirect_to,
-                array(
-                    SequentialStepForm::REDIRECT_TO_NEXT_STEP,
-                    SequentialStepForm::REDIRECT_TO_CURRENT_STEP,
-                    SequentialStepForm::REDIRECT_TO_PREV_STEP,
-                    SequentialStepForm::REDIRECT_TO_OTHER,
-                ),
-                true
-            )
-        ) {
-            throw new InvalidDataTypeException(
-                'setRedirectTo()',
-                $redirect_to,
-                'one of the SequentialStepForm class constants was expected.'
-            );
-        }
-        $this->redirect_to = $redirect_to;
-    }
+	const REDIRECT_TO_NEXT_STEP    = 'redirect_to_next_step';
+
+	const REDIRECT_TO_CURRENT_STEP = 'redirect_to_current_step';
+
+	const REDIRECT_TO_PREV_STEP    = 'redirect_to_prev_step';
+
+	const REDIRECT_TO_OTHER        = 'redirect_to_other';
+
+	/**
+	 * numerical value used for sorting form steps
+	 *
+	 * @var int $order
+	 */
+	private $order = 1;
+
+	/**
+	 * a final URL with all form related parameters added
+	 * that will be used to advance to the next step
+	 *
+	 * @var string $redirect_url
+	 */
+	private $redirect_url = '';
+
+	/**
+	 * URL params in key value pairs
+	 *
+	 * @var array $redirect_args
+	 */
+	private $redirect_args = array();
+
+	/**
+	 * Which step should be redirected to after form processing.
+	 * Usually after successfully processing this value would be REDIRECT_TO_NEXT_STEP
+	 * If a form is invalid and requires errors to be corrected,
+	 * then this value would be REDIRECT_TO_CURRENT_STEP so that form can be resubmitted
+	 * Some form handlers do not have a form that is displayable,
+	 * and only perform data processing, but if an error occurs,
+	 * then this value needs to be set to REDIRECT_TO_PREV_STEP
+	 * since the current step has no displayable content.
+	 * if the form is completely finished, and needs to redirect to somewhere
+	 * completely different, then this value will be REDIRECT_TO_OTHER
+	 *
+	 * @var string $redirect_to
+	 */
+	private $redirect_to = SequentialStepForm::REDIRECT_TO_CURRENT_STEP;
+
+
+	/**
+	 * SequentialStepForm constructor
+	 *
+	 * @param int              $order
+	 * @param string           $form_name
+	 * @param string           $admin_name
+	 * @param string           $slug
+	 * @param string           $form_action
+	 * @param string           $form_config
+	 * @param EE_Registry|null $registry
+	 */
+	public function __construct(
+		$order,
+		$form_name,
+		$admin_name,
+		$slug,
+		$form_action = '',
+		$form_config = 'add_form_tags_and_submit',
+		EE_Registry $registry = null
+	) {
+		$this->setOrder($order);
+		parent::__construct($form_name, $admin_name, $slug, $form_action, $form_config, $registry);
+	}
+
+
+
+	/**
+	 * @return int
+	 */
+	public function order()
+	{
+		return $this->order;
+	}
+
+
+
+	/**
+	 * @param int $order
+	 * @throws InvalidArgumentException
+	 */
+	public function setOrder($order)
+	{
+		$order = absint($order);
+		if (! $order > 0) {
+			throw new InvalidArgumentException(
+				esc_html__('The form order property must be a positive integer.', 'event_espresso')
+			);
+		}
+		$this->order = $order;
+	}
+
+
+
+	/**
+	 * @return string
+	 */
+	public function redirectUrl()
+	{
+		return ! empty($this->redirect_args)
+			? add_query_arg($this->redirect_args, $this->redirect_url)
+			: $this->redirect_url;
+	}
+
+
+
+	/**
+	 * @param string $redirect_url
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidArgumentException
+	 */
+	public function setRedirectUrl($redirect_url)
+	{
+		if (! is_string($redirect_url)) {
+			throw new InvalidDataTypeException('$redirect_url', $redirect_url, 'string');
+		}
+		if (empty($redirect_url)) {
+			throw new InvalidArgumentException(
+				esc_html__('The redirect URL can not be an empty string.', 'event_espresso')
+			);
+		}
+		$this->redirect_url = $redirect_url;
+	}
+
+
+
+	/**
+	 * @param array $redirect_args
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidArgumentException
+	 */
+	public function addRedirectArgs($redirect_args = array())
+	{
+		if (is_object($redirect_args)) {
+			throw new InvalidDataTypeException(
+				'$redirect_args',
+				$redirect_args,
+				'anything other than an object was expected.'
+			);
+		}
+		if (empty($redirect_args)) {
+			throw new InvalidArgumentException(
+				esc_html__('The redirect argument can not be an empty array.', 'event_espresso')
+			);
+		}
+		$this->redirect_args = array_merge($this->redirect_args, (array) $redirect_args);
+	}
+
+
+
+	/**
+	 * @param array $redirect_arg_keys_to_remove
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidArgumentException
+	 */
+	public function removeRedirectArgs($redirect_arg_keys_to_remove = array())
+	{
+		if (is_object($redirect_arg_keys_to_remove)) {
+			throw new InvalidDataTypeException(
+				'$redirect_arg_keys_to_remove',
+				$redirect_arg_keys_to_remove,
+				'anything other than an object was expected.'
+			);
+		}
+		if (empty($redirect_arg_keys_to_remove)) {
+			throw new InvalidArgumentException(
+				esc_html__('The $redirect_arg_keys_to_remove argument can not be an empty array.', 'event_espresso')
+			);
+		}
+		foreach ($redirect_arg_keys_to_remove as $redirect_arg_key) {
+			unset($this->redirect_args[ $redirect_arg_key ]);
+		}
+	}
+
+
+
+	/**
+	 * @return string
+	 */
+	public function redirectTo()
+	{
+		return $this->redirect_to;
+	}
+
+
+
+	/**
+	 * @param string $redirect_to
+	 * @throws InvalidDataTypeException
+	 */
+	public function setRedirectTo($redirect_to)
+	{
+		if (
+			! in_array(
+				$redirect_to,
+				array(
+					SequentialStepForm::REDIRECT_TO_NEXT_STEP,
+					SequentialStepForm::REDIRECT_TO_CURRENT_STEP,
+					SequentialStepForm::REDIRECT_TO_PREV_STEP,
+					SequentialStepForm::REDIRECT_TO_OTHER,
+				),
+				true
+			)
+		) {
+			throw new InvalidDataTypeException(
+				'setRedirectTo()',
+				$redirect_to,
+				'one of the SequentialStepForm class constants was expected.'
+			);
+		}
+		$this->redirect_to = $redirect_to;
+	}
 }
 // End of file SequentialStepForm.php
 // Location: /SequentialStepForm.php

core/libraries/line_item_filters/EE_Specific_Registrations_Line_Item_Filter.class.php

Spacing +8 added lines, -8 removed lines

@@ -73,10 +73,10 @@ 
                 'LIN_code'
             );
             if ($line_item_code) {
-                if (! isset($this->_line_item_registrations[ $line_item_code ])) {
-                    $this->_line_item_registrations[ $line_item_code ] = array();
+                if ( ! isset($this->_line_item_registrations[$line_item_code])) {
+                    $this->_line_item_registrations[$line_item_code] = array();
                 }
-                $this->_line_item_registrations[ $line_item_code ][ $registration->ID() ] = $registration;
+                $this->_line_item_registrations[$line_item_code][$registration->ID()] = $registration;
             }
         }
     }
@@ -93,7 +93,7 @@ 
     public function process(EEI_Line_Item $line_item)
     {
         $this->_adjust_line_item_quantity($line_item);
-        if (! $line_item->children()) {
+        if ( ! $line_item->children()) {
             return $line_item;
         }
         // the original running total (taking ALL tickets into account)
@@ -120,7 +120,7 @@ 
                 $child_line_item->set_total(
                     $running_total_of_children_under_consideration * $percent_of_running_total
                 );
-                if (! $child_line_item->is_percent()) {
+                if ( ! $child_line_item->is_percent()) {
                     $child_line_item->set_unit_price($child_line_item->total() / $child_line_item->quantity());
                 }
             } elseif (
@@ -177,11 +177,11 @@ 
             $quantity = 0;
             // if this ticket is billable at this moment, then we should have a positive quantity
             if (
-                isset($this->_line_item_registrations[ $line_item->code() ])
-                && is_array($this->_line_item_registrations[ $line_item->code() ])
+                isset($this->_line_item_registrations[$line_item->code()])
+                && is_array($this->_line_item_registrations[$line_item->code()])
             ) {
                 // set quantity based on number of open registrations for this ticket
-                foreach ($this->_line_item_registrations[ $line_item->code() ] as $registration) {
+                foreach ($this->_line_item_registrations[$line_item->code()] as $registration) {
                     if (
                         $registration instanceof EE_Registration
                     ) {

Indentation +170 added lines, -170 removed lines

@@ -12,186 +12,186 @@
  */
 class EE_Specific_Registrations_Line_Item_Filter extends EE_Line_Item_Filter_Base
 {
-    /**
-     * array of line item codes and their corresponding quantities for registrations
-     *
-     * @type array $_line_item_registrations
-     */
-    protected $_line_item_registrations = array();
+	/**
+	 * array of line item codes and their corresponding quantities for registrations
+	 *
+	 * @type array $_line_item_registrations
+	 */
+	protected $_line_item_registrations = array();
 
-    /**
-     * Just kept in case we want it someday. Currently unused
-     *
-     * @var EE_Registration[]
-     */
-    protected $_registrations = array();
+	/**
+	 * Just kept in case we want it someday. Currently unused
+	 *
+	 * @var EE_Registration[]
+	 */
+	protected $_registrations = array();
 
-    /**
-     * @var EE_Registration
-     */
-    protected $_current_registration;
+	/**
+	 * @var EE_Registration
+	 */
+	protected $_current_registration;
 
-    /**
-     * these reg statuses should NOT increment the line item quantity
-     *
-     * @var array
-     */
-    protected $_closed_reg_statuses = array();
+	/**
+	 * these reg statuses should NOT increment the line item quantity
+	 *
+	 * @var array
+	 */
+	protected $_closed_reg_statuses = array();
 
 
-    /**
-     * EE_Billable_Line_Item_Filter constructor.
-     *
-     * @param EE_Registration[] $registrations
-     * @throws EE_Error
-     */
-    public function __construct($registrations)
-    {
-        $this->_registrations = $registrations;
-        $this->_calculate_registrations_per_line_item_code($registrations);
-        // these reg statuses should NOT increment the line item quantity
-        $this->_closed_reg_statuses = EEM_Registration::closed_reg_statuses();
-    }
+	/**
+	 * EE_Billable_Line_Item_Filter constructor.
+	 *
+	 * @param EE_Registration[] $registrations
+	 * @throws EE_Error
+	 */
+	public function __construct($registrations)
+	{
+		$this->_registrations = $registrations;
+		$this->_calculate_registrations_per_line_item_code($registrations);
+		// these reg statuses should NOT increment the line item quantity
+		$this->_closed_reg_statuses = EEM_Registration::closed_reg_statuses();
+	}
 
 
-    /**
-     * sets the _line_item_registrations from the provided registrations
-     *
-     * @param EE_Registration[] $registrations
-     * @return void
-     * @throws EE_Error
-     */
-    protected function _calculate_registrations_per_line_item_code($registrations)
-    {
-        foreach ($registrations as $registration) {
-            $line_item_code = EEM_Line_Item::instance()->get_var(
-                EEM_Line_Item::instance()->line_item_for_registration_query_params(
-                    $registration,
-                    array('limit' => 1)
-                ),
-                'LIN_code'
-            );
-            if ($line_item_code) {
-                if (! isset($this->_line_item_registrations[ $line_item_code ])) {
-                    $this->_line_item_registrations[ $line_item_code ] = array();
-                }
-                $this->_line_item_registrations[ $line_item_code ][ $registration->ID() ] = $registration;
-            }
-        }
-    }
+	/**
+	 * sets the _line_item_registrations from the provided registrations
+	 *
+	 * @param EE_Registration[] $registrations
+	 * @return void
+	 * @throws EE_Error
+	 */
+	protected function _calculate_registrations_per_line_item_code($registrations)
+	{
+		foreach ($registrations as $registration) {
+			$line_item_code = EEM_Line_Item::instance()->get_var(
+				EEM_Line_Item::instance()->line_item_for_registration_query_params(
+					$registration,
+					array('limit' => 1)
+				),
+				'LIN_code'
+			);
+			if ($line_item_code) {
+				if (! isset($this->_line_item_registrations[ $line_item_code ])) {
+					$this->_line_item_registrations[ $line_item_code ] = array();
+				}
+				$this->_line_item_registrations[ $line_item_code ][ $registration->ID() ] = $registration;
+			}
+		}
+	}
 
 
-    /**
-     * Creates a duplicate of the line item tree, except only includes billable items
-     * and the portion of line items attributed to billable things
-     *
-     * @param EEI_Line_Item $line_item
-     * @return EEI_Line_Item
-     * @throws EE_Error
-     */
-    public function process(EEI_Line_Item $line_item)
-    {
-        $this->_adjust_line_item_quantity($line_item);
-        if (! $line_item->children()) {
-            return $line_item;
-        }
-        // the original running total (taking ALL tickets into account)
-        $running_total_of_children = 0;
-        // the new running total (only taking the specified ticket quantities into account)
-        $running_total_of_children_under_consideration = 0;
-        // let's also track the quantity of tickets that pertain to the registrations
-        $total_child_ticket_quantity = 0;
-        foreach ($line_item->children() as $child_line_item) {
-            $original_li_total = $child_line_item->is_percent()
-                ? $running_total_of_children * $child_line_item->percent() / 100
-                : $child_line_item->unit_price() * $child_line_item->quantity();
-            $this->process($child_line_item);
-            // If this line item is a normal line item that isn't for a ticket,
-            // we want to modify its total (and unit price if not a percentage line item)
-            // so it reflects only that portion of the surcharge/discount shared by these registrations
-            if (
-                $child_line_item->type() === EEM_Line_Item::type_line_item
-                && $child_line_item->OBJ_type() !== 'Ticket'
-            ) {
-                $percent_of_running_total = $running_total_of_children
-                    ? $original_li_total / $running_total_of_children
-                    : 0;
-                $child_line_item->set_total(
-                    $running_total_of_children_under_consideration * $percent_of_running_total
-                );
-                if (! $child_line_item->is_percent()) {
-                    $child_line_item->set_unit_price($child_line_item->total() / $child_line_item->quantity());
-                }
-            } elseif (
+	/**
+	 * Creates a duplicate of the line item tree, except only includes billable items
+	 * and the portion of line items attributed to billable things
+	 *
+	 * @param EEI_Line_Item $line_item
+	 * @return EEI_Line_Item
+	 * @throws EE_Error
+	 */
+	public function process(EEI_Line_Item $line_item)
+	{
+		$this->_adjust_line_item_quantity($line_item);
+		if (! $line_item->children()) {
+			return $line_item;
+		}
+		// the original running total (taking ALL tickets into account)
+		$running_total_of_children = 0;
+		// the new running total (only taking the specified ticket quantities into account)
+		$running_total_of_children_under_consideration = 0;
+		// let's also track the quantity of tickets that pertain to the registrations
+		$total_child_ticket_quantity = 0;
+		foreach ($line_item->children() as $child_line_item) {
+			$original_li_total = $child_line_item->is_percent()
+				? $running_total_of_children * $child_line_item->percent() / 100
+				: $child_line_item->unit_price() * $child_line_item->quantity();
+			$this->process($child_line_item);
+			// If this line item is a normal line item that isn't for a ticket,
+			// we want to modify its total (and unit price if not a percentage line item)
+			// so it reflects only that portion of the surcharge/discount shared by these registrations
+			if (
+				$child_line_item->type() === EEM_Line_Item::type_line_item
+				&& $child_line_item->OBJ_type() !== 'Ticket'
+			) {
+				$percent_of_running_total = $running_total_of_children
+					? $original_li_total / $running_total_of_children
+					: 0;
+				$child_line_item->set_total(
+					$running_total_of_children_under_consideration * $percent_of_running_total
+				);
+				if (! $child_line_item->is_percent()) {
+					$child_line_item->set_unit_price($child_line_item->total() / $child_line_item->quantity());
+				}
+			} elseif (
 // make sure this item's quantity and total matches its parent
-                $line_item->type() === EEM_Line_Item::type_line_item
-                && $line_item->OBJ_type() === 'Ticket'
-                // but not if it's a percentage modifier
-                && ! $child_line_item->is_percent()
-                && ! (
-                    // or a cancellation
-                    $child_line_item->is_cancelled()
-                    && ! (
-                        // unless it IS a cancellation and the current registration is cancelled
-                        $child_line_item->is_cancelled()
-                        && $this->_current_registration instanceof EE_Registration
-                        && in_array($this->_current_registration->status_ID(), $this->_closed_reg_statuses, true)
-                    )
-                )
-            ) {
-                $child_line_item->set_quantity($line_item->quantity());
-                $child_line_item->set_total($child_line_item->unit_price() * $child_line_item->quantity());
-            }
-            $running_total_of_children += $original_li_total;
-            $running_total_of_children_under_consideration += $child_line_item->total();
-            if ($child_line_item->OBJ_type() === 'Ticket') {
-                $total_child_ticket_quantity += $child_line_item->quantity();
-            }
-        }
-        $line_item->set_total($running_total_of_children_under_consideration);
-        if ($line_item->quantity()) {
-            $line_item->set_unit_price($running_total_of_children_under_consideration / $line_item->quantity());
-        } else {
-            $line_item->set_unit_price(0);
-        }
-        if ($line_item->OBJ_type() === 'Event') {
-            $line_item->set_quantity($total_child_ticket_quantity);
-        }
-        return $line_item;
-    }
+				$line_item->type() === EEM_Line_Item::type_line_item
+				&& $line_item->OBJ_type() === 'Ticket'
+				// but not if it's a percentage modifier
+				&& ! $child_line_item->is_percent()
+				&& ! (
+					// or a cancellation
+					$child_line_item->is_cancelled()
+					&& ! (
+						// unless it IS a cancellation and the current registration is cancelled
+						$child_line_item->is_cancelled()
+						&& $this->_current_registration instanceof EE_Registration
+						&& in_array($this->_current_registration->status_ID(), $this->_closed_reg_statuses, true)
+					)
+				)
+			) {
+				$child_line_item->set_quantity($line_item->quantity());
+				$child_line_item->set_total($child_line_item->unit_price() * $child_line_item->quantity());
+			}
+			$running_total_of_children += $original_li_total;
+			$running_total_of_children_under_consideration += $child_line_item->total();
+			if ($child_line_item->OBJ_type() === 'Ticket') {
+				$total_child_ticket_quantity += $child_line_item->quantity();
+			}
+		}
+		$line_item->set_total($running_total_of_children_under_consideration);
+		if ($line_item->quantity()) {
+			$line_item->set_unit_price($running_total_of_children_under_consideration / $line_item->quantity());
+		} else {
+			$line_item->set_unit_price(0);
+		}
+		if ($line_item->OBJ_type() === 'Event') {
+			$line_item->set_quantity($total_child_ticket_quantity);
+		}
+		return $line_item;
+	}
 
 
-    /**
-     * Adjusts quantities for line items for tickets according to the registrations provided
-     * in the constructor
-     *
-     * @param EEI_Line_Item $line_item
-     * @return EEI_Line_Item
-     */
-    protected function _adjust_line_item_quantity(EEI_Line_Item $line_item)
-    {
-        // is this a ticket ?
-        if ($line_item->type() === EEM_Line_Item::type_line_item && $line_item->OBJ_type() === 'Ticket') {
-            $this->_current_registration = null;
-            $quantity = 0;
-            // if this ticket is billable at this moment, then we should have a positive quantity
-            if (
-                isset($this->_line_item_registrations[ $line_item->code() ])
-                && is_array($this->_line_item_registrations[ $line_item->code() ])
-            ) {
-                // set quantity based on number of open registrations for this ticket
-                foreach ($this->_line_item_registrations[ $line_item->code() ] as $registration) {
-                    if (
-                        $registration instanceof EE_Registration
-                    ) {
-                        $quantity++;
-                        $this->_current_registration = $registration;
-                    }
-                }
-            }
-            $line_item->set_quantity($quantity);
-            $line_item->set_total($line_item->unit_price() * $line_item->quantity());
-        }
-        return $line_item;
-    }
+	/**
+	 * Adjusts quantities for line items for tickets according to the registrations provided
+	 * in the constructor
+	 *
+	 * @param EEI_Line_Item $line_item
+	 * @return EEI_Line_Item
+	 */
+	protected function _adjust_line_item_quantity(EEI_Line_Item $line_item)
+	{
+		// is this a ticket ?
+		if ($line_item->type() === EEM_Line_Item::type_line_item && $line_item->OBJ_type() === 'Ticket') {
+			$this->_current_registration = null;
+			$quantity = 0;
+			// if this ticket is billable at this moment, then we should have a positive quantity
+			if (
+				isset($this->_line_item_registrations[ $line_item->code() ])
+				&& is_array($this->_line_item_registrations[ $line_item->code() ])
+			) {
+				// set quantity based on number of open registrations for this ticket
+				foreach ($this->_line_item_registrations[ $line_item->code() ] as $registration) {
+					if (
+						$registration instanceof EE_Registration
+					) {
+						$quantity++;
+						$this->_current_registration = $registration;
+					}
+				}
+			}
+			$line_item->set_quantity($quantity);
+			$line_item->set_total($line_item->unit_price() * $line_item->quantity());
+		}
+		return $line_item;
+	}
 }

core/libraries/line_item_filters/EE_Billable_Line_Item_Filter.class.php

Spacing +4 added lines, -5 removed lines

@@ -39,17 +39,16 @@ 
      */
     protected function _remove_unbillable_registrations($registrations = array())
     {
-        if (! empty($registrations)) {
+        if ( ! empty($registrations)) {
             // these reg statuses require payment (if event is not free)
             $requires_payment = EEM_Registration::reg_statuses_that_allow_payment();
             foreach ($registrations as $key => $registration) {
-                if (! $registration instanceof EE_Registration) {
+                if ( ! $registration instanceof EE_Registration) {
                     continue;
                 }
                 // are we billing for this registration at this moment ?
                 if (
-                    !
-                    $registration->owes_monies_and_can_pay($requires_payment) &&
+                    ! $registration->owes_monies_and_can_pay($requires_payment) &&
                     ! (
                         // free registration with valid reg status
                         $registration->final_price() == 0 &&
@@ -57,7 +56,7 @@ 
                     )
                 ) {
                     // not billable. remove it
-                    unset($registrations[ $key ]);
+                    unset($registrations[$key]);
                 }
             }
         }

Indentation +43 added lines, -43 removed lines

@@ -16,49 +16,49 @@
  */
 class EE_Billable_Line_Item_Filter extends EE_Specific_Registrations_Line_Item_Filter
 {
-    /**
-     * EE_Billable_Line_Item_Filter constructor.
-     *
-     * @param EE_Registration[] $registrations
-     */
-    public function __construct($registrations)
-    {
-        parent::__construct($this->_remove_unbillable_registrations($registrations));
-    }
+	/**
+	 * EE_Billable_Line_Item_Filter constructor.
+	 *
+	 * @param EE_Registration[] $registrations
+	 */
+	public function __construct($registrations)
+	{
+		parent::__construct($this->_remove_unbillable_registrations($registrations));
+	}
 
 
-    /**
-     *    _calculate_billable_ticket_quantities_from_registrations
-     * compiles a list of EE_Tickets for each event in the passed array
-     *
-     * @access protected
-     * @param EE_Registration[] $registrations
-     * @return mixed
-     */
-    protected function _remove_unbillable_registrations($registrations = array())
-    {
-        if (! empty($registrations)) {
-            // these reg statuses require payment (if event is not free)
-            $requires_payment = EEM_Registration::reg_statuses_that_allow_payment();
-            foreach ($registrations as $key => $registration) {
-                if (! $registration instanceof EE_Registration) {
-                    continue;
-                }
-                // are we billing for this registration at this moment ?
-                if (
-                    !
-                    $registration->owes_monies_and_can_pay($requires_payment) &&
-                    ! (
-                        // free registration with valid reg status
-                        $registration->final_price() == 0 &&
-                        in_array($registration->status_ID(), $requires_payment)
-                    )
-                ) {
-                    // not billable. remove it
-                    unset($registrations[ $key ]);
-                }
-            }
-        }
-        return $registrations;
-    }
+	/**
+	 *    _calculate_billable_ticket_quantities_from_registrations
+	 * compiles a list of EE_Tickets for each event in the passed array
+	 *
+	 * @access protected
+	 * @param EE_Registration[] $registrations
+	 * @return mixed
+	 */
+	protected function _remove_unbillable_registrations($registrations = array())
+	{
+		if (! empty($registrations)) {
+			// these reg statuses require payment (if event is not free)
+			$requires_payment = EEM_Registration::reg_statuses_that_allow_payment();
+			foreach ($registrations as $key => $registration) {
+				if (! $registration instanceof EE_Registration) {
+					continue;
+				}
+				// are we billing for this registration at this moment ?
+				if (
+					!
+					$registration->owes_monies_and_can_pay($requires_payment) &&
+					! (
+						// free registration with valid reg status
+						$registration->final_price() == 0 &&
+						in_array($registration->status_ID(), $requires_payment)
+					)
+				) {
+					// not billable. remove it
+					unset($registrations[ $key ]);
+				}
+			}
+		}
+		return $registrations;
+	}
 }

core/libraries/batch/Helpers/JobParameters.php

Spacing +8 added lines, -8 removed lines

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

Indentation +393 added lines, -393 removed lines

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

core/db_models/EEM_Ticket_Price.model.php

Spacing +4 added lines, -4 removed lines

@@ -42,11 +42,11 @@
             'Price' => new EE_Belongs_To_Relation()
         );
         $this->_model_chain_to_wp_user = 'Ticket';
-        $this->_cap_restriction_generators[ EEM_Base::caps_read ] = new EE_Restriction_Generator_Default_Public('Ticket.TKT_is_default', 'Ticket.Datetime.Event');
+        $this->_cap_restriction_generators[EEM_Base::caps_read] = new EE_Restriction_Generator_Default_Public('Ticket.TKT_is_default', 'Ticket.Datetime.Event');
         // account for default tickets in the caps
-        $this->_cap_restriction_generators[ EEM_Base::caps_read_admin ] = new EE_Restriction_Generator_Default_Protected('Ticket.TKT_is_default', 'Ticket.Datetime.Event');
-        $this->_cap_restriction_generators[ EEM_Base::caps_edit ] = new EE_Restriction_Generator_Default_Protected('Ticket.TKT_is_default', 'Ticket.Datetime.Event');
-        $this->_cap_restriction_generators[ EEM_Base::caps_delete ] = new EE_Restriction_Generator_Default_Protected('Ticket.TKT_is_default', 'Ticket.Datetime.Event');
+        $this->_cap_restriction_generators[EEM_Base::caps_read_admin] = new EE_Restriction_Generator_Default_Protected('Ticket.TKT_is_default', 'Ticket.Datetime.Event');
+        $this->_cap_restriction_generators[EEM_Base::caps_edit] = new EE_Restriction_Generator_Default_Protected('Ticket.TKT_is_default', 'Ticket.Datetime.Event');
+        $this->_cap_restriction_generators[EEM_Base::caps_delete] = new EE_Restriction_Generator_Default_Protected('Ticket.TKT_is_default', 'Ticket.Datetime.Event');
         // follow the caps of the ticket
         $this->_caps_slug = 'tickets';
         parent::__construct($timezone);

Indentation +37 added lines, -37 removed lines

@@ -11,43 +11,43 @@
  */
 class EEM_Ticket_Price extends EEM_Base
 {
-    // private instance of the EEM_Ticket_Price object
-    protected static $_instance = null;
+	// private instance of the EEM_Ticket_Price object
+	protected static $_instance = null;
 
-    /**
-     *      private constructor to prevent direct creation
-     *      @Constructor
-     *      @access protected
-     *      @param string $timezone string representing the timezone we want to set for returned Date Time Strings (and any incoming timezone data that gets saved).  Note this just sends the timezone info to the date time model field objects.  Default is NULL (and will be assumed using the set timezone in the 'timezone_string' wp option)
-     *      @return void
-     */
-    protected function __construct($timezone)
-    {
-        $this->singular_item = esc_html__('Ticket Price', 'event_espresso');
-        $this->plural_item = esc_html__('Ticket Prices', 'event_espresso');
+	/**
+	 *      private constructor to prevent direct creation
+	 *      @Constructor
+	 *      @access protected
+	 *      @param string $timezone string representing the timezone we want to set for returned Date Time Strings (and any incoming timezone data that gets saved).  Note this just sends the timezone info to the date time model field objects.  Default is NULL (and will be assumed using the set timezone in the 'timezone_string' wp option)
+	 *      @return void
+	 */
+	protected function __construct($timezone)
+	{
+		$this->singular_item = esc_html__('Ticket Price', 'event_espresso');
+		$this->plural_item = esc_html__('Ticket Prices', 'event_espresso');
 
-        $this->_tables = array(
-            'Ticket_Price' => new EE_Primary_Table('esp_ticket_price', 'TKP_ID')
-        );
-        $this->_fields = array(
-            'Ticket_Price' => array(
-                'TKP_ID' => new EE_Primary_Key_Int_Field('TKP_ID', 'Ticket Price ID'),
-                'TKT_ID' => new EE_Foreign_Key_Int_Field('TKT_ID', 'Ticket Id', false, 0, 'Ticket'),
-                'PRC_ID' => new EE_Foreign_Key_Int_Field('PRC_ID', 'Price ID', false, 0, 'Price'),
-            )
-        );
-        $this->_model_relations = array(
-            'Ticket' => new EE_Belongs_To_Relation(),
-            'Price' => new EE_Belongs_To_Relation()
-        );
-        $this->_model_chain_to_wp_user = 'Ticket';
-        $this->_cap_restriction_generators[ EEM_Base::caps_read ] = new EE_Restriction_Generator_Default_Public('Ticket.TKT_is_default', 'Ticket.Datetime.Event');
-        // account for default tickets in the caps
-        $this->_cap_restriction_generators[ EEM_Base::caps_read_admin ] = new EE_Restriction_Generator_Default_Protected('Ticket.TKT_is_default', 'Ticket.Datetime.Event');
-        $this->_cap_restriction_generators[ EEM_Base::caps_edit ] = new EE_Restriction_Generator_Default_Protected('Ticket.TKT_is_default', 'Ticket.Datetime.Event');
-        $this->_cap_restriction_generators[ EEM_Base::caps_delete ] = new EE_Restriction_Generator_Default_Protected('Ticket.TKT_is_default', 'Ticket.Datetime.Event');
-        // follow the caps of the ticket
-        $this->_caps_slug = 'tickets';
-        parent::__construct($timezone);
-    }
+		$this->_tables = array(
+			'Ticket_Price' => new EE_Primary_Table('esp_ticket_price', 'TKP_ID')
+		);
+		$this->_fields = array(
+			'Ticket_Price' => array(
+				'TKP_ID' => new EE_Primary_Key_Int_Field('TKP_ID', 'Ticket Price ID'),
+				'TKT_ID' => new EE_Foreign_Key_Int_Field('TKT_ID', 'Ticket Id', false, 0, 'Ticket'),
+				'PRC_ID' => new EE_Foreign_Key_Int_Field('PRC_ID', 'Price ID', false, 0, 'Price'),
+			)
+		);
+		$this->_model_relations = array(
+			'Ticket' => new EE_Belongs_To_Relation(),
+			'Price' => new EE_Belongs_To_Relation()
+		);
+		$this->_model_chain_to_wp_user = 'Ticket';
+		$this->_cap_restriction_generators[ EEM_Base::caps_read ] = new EE_Restriction_Generator_Default_Public('Ticket.TKT_is_default', 'Ticket.Datetime.Event');
+		// account for default tickets in the caps
+		$this->_cap_restriction_generators[ EEM_Base::caps_read_admin ] = new EE_Restriction_Generator_Default_Protected('Ticket.TKT_is_default', 'Ticket.Datetime.Event');
+		$this->_cap_restriction_generators[ EEM_Base::caps_edit ] = new EE_Restriction_Generator_Default_Protected('Ticket.TKT_is_default', 'Ticket.Datetime.Event');
+		$this->_cap_restriction_generators[ EEM_Base::caps_delete ] = new EE_Restriction_Generator_Default_Protected('Ticket.TKT_is_default', 'Ticket.Datetime.Event');
+		// follow the caps of the ticket
+		$this->_caps_slug = 'tickets';
+		parent::__construct($timezone);
+	}
 }

core/db_models/EEM_Currency.model.php

Spacing +4 added lines, -4 removed lines

@@ -34,7 +34,7 @@ 
             'Payment_Method' => new EE_HABTM_Relation('Currency_Payment_Method'),
         );
         // this model is generally available for reading
-        $this->_cap_restriction_generators[ EEM_Base::caps_read ] = new EE_Restriction_Generator_Public();
+        $this->_cap_restriction_generators[EEM_Base::caps_read] = new EE_Restriction_Generator_Public();
 
         parent::__construct($timezone);
     }
@@ -48,8 +48,8 @@ 
     public function get_all_active($query_params = array())
     {
         $query_params[0]['CUR_active'] = true;
-        if (! isset($query_params['order_by'])) {
-            $query_params['order_by'] = array('CUR_code' => 'ASC','CUR_single' => 'ASC');
+        if ( ! isset($query_params['order_by'])) {
+            $query_params['order_by'] = array('CUR_code' => 'ASC', 'CUR_single' => 'ASC');
         }
         return $this->get_all($query_params);
     }
@@ -71,7 +71,7 @@ 
         if ($currencies_supported == EE_Gateway::all_currencies_supported || empty($currencies_supported)) {
             $currencies = $this->get_all_active();
         } else {
-            $currencies = $this->get_all_active(array(array('CUR_code' => array('IN',$currencies_supported))));
+            $currencies = $this->get_all_active(array(array('CUR_code' => array('IN', $currencies_supported))));
         }
         return $currencies;
     }

Indentation +61 added lines, -61 removed lines

@@ -11,68 +11,68 @@
  */
 class EEM_Currency extends EEM_Base
 {
-        // private instance of the Attendee object
-    protected static $_instance = null;
+		// private instance of the Attendee object
+	protected static $_instance = null;
 
-    protected function __construct($timezone = null)
-    {
-        $this->singular_item = esc_html__('Currency', 'event_espresso');
-        $this->plural_item = esc_html__('Currencies', 'event_espresso');
-        $this->_tables = array(
-            'Currency' => new EE_Primary_Table('esp_currency', 'CUR_code')
-        );
-        $this->_fields = array(
-            'Currency' => array(
-                'CUR_code' => new EE_Primary_Key_String_Field('CUR_code', esc_html__('Currency Code', 'event_espresso')),
-                'CUR_single' => new EE_Plain_Text_Field('CUR_single', esc_html__('Currency Name Singular', 'event_espresso'), false),
-                'CUR_plural' => new EE_Plain_Text_Field('CUR_plural', esc_html__('Currency Name Plural', 'event_espresso'), false),
-                'CUR_sign' => new EE_Plain_Text_Field('CUR_sign', esc_html__('Currency Sign', 'event_espresso'), false),
-                'CUR_dec_plc' => new EE_Integer_Field('CUR_dec_plc', esc_html__('Currency Decimal Places', 'event_espresso'), false, 2),
-                'CUR_active' => new EE_Boolean_Field('CUR_active', esc_html__('Active?', 'event_espresso'), false, true),
-            ));
-        $this->_model_relations = array(
-            'Payment_Method' => new EE_HABTM_Relation('Currency_Payment_Method'),
-        );
-        // this model is generally available for reading
-        $this->_cap_restriction_generators[ EEM_Base::caps_read ] = new EE_Restriction_Generator_Public();
+	protected function __construct($timezone = null)
+	{
+		$this->singular_item = esc_html__('Currency', 'event_espresso');
+		$this->plural_item = esc_html__('Currencies', 'event_espresso');
+		$this->_tables = array(
+			'Currency' => new EE_Primary_Table('esp_currency', 'CUR_code')
+		);
+		$this->_fields = array(
+			'Currency' => array(
+				'CUR_code' => new EE_Primary_Key_String_Field('CUR_code', esc_html__('Currency Code', 'event_espresso')),
+				'CUR_single' => new EE_Plain_Text_Field('CUR_single', esc_html__('Currency Name Singular', 'event_espresso'), false),
+				'CUR_plural' => new EE_Plain_Text_Field('CUR_plural', esc_html__('Currency Name Plural', 'event_espresso'), false),
+				'CUR_sign' => new EE_Plain_Text_Field('CUR_sign', esc_html__('Currency Sign', 'event_espresso'), false),
+				'CUR_dec_plc' => new EE_Integer_Field('CUR_dec_plc', esc_html__('Currency Decimal Places', 'event_espresso'), false, 2),
+				'CUR_active' => new EE_Boolean_Field('CUR_active', esc_html__('Active?', 'event_espresso'), false, true),
+			));
+		$this->_model_relations = array(
+			'Payment_Method' => new EE_HABTM_Relation('Currency_Payment_Method'),
+		);
+		// this model is generally available for reading
+		$this->_cap_restriction_generators[ EEM_Base::caps_read ] = new EE_Restriction_Generator_Public();
 
-        parent::__construct($timezone);
-    }
+		parent::__construct($timezone);
+	}
 
-    /**
-     * Gets all thea ctive currencies, and orders them by their singular name, and then their code
-     * (may be overridden)
-     * @param array $query_params @see https://github.com/eventespresso/event-espresso-core/tree/master/docs/G--Model-System/model-query-params.md
-     * @return EE_Currency[]
-     */
-    public function get_all_active($query_params = array())
-    {
-        $query_params[0]['CUR_active'] = true;
-        if (! isset($query_params['order_by'])) {
-            $query_params['order_by'] = array('CUR_code' => 'ASC','CUR_single' => 'ASC');
-        }
-        return $this->get_all($query_params);
-    }
-    /**
-     * Gets all the currencies which can be used by that payment method type
-     * @param EE_PMT_Base $payment_method_type
-     * @return EE_Currency[]
-     */
-    public function get_all_currencies_usable_by($payment_method_type)
-    {
-        if (
-            $payment_method_type instanceof EE_PMT_Base &&
-                $payment_method_type->get_gateway()
-        ) {
-            $currencies_supported = $payment_method_type->get_gateway()->currencies_supported();
-        } else {
-            $currencies_supported = EE_Gateway::all_currencies_supported;
-        }
-        if ($currencies_supported == EE_Gateway::all_currencies_supported || empty($currencies_supported)) {
-            $currencies = $this->get_all_active();
-        } else {
-            $currencies = $this->get_all_active(array(array('CUR_code' => array('IN',$currencies_supported))));
-        }
-        return $currencies;
-    }
+	/**
+	 * Gets all thea ctive currencies, and orders them by their singular name, and then their code
+	 * (may be overridden)
+	 * @param array $query_params @see https://github.com/eventespresso/event-espresso-core/tree/master/docs/G--Model-System/model-query-params.md
+	 * @return EE_Currency[]
+	 */
+	public function get_all_active($query_params = array())
+	{
+		$query_params[0]['CUR_active'] = true;
+		if (! isset($query_params['order_by'])) {
+			$query_params['order_by'] = array('CUR_code' => 'ASC','CUR_single' => 'ASC');
+		}
+		return $this->get_all($query_params);
+	}
+	/**
+	 * Gets all the currencies which can be used by that payment method type
+	 * @param EE_PMT_Base $payment_method_type
+	 * @return EE_Currency[]
+	 */
+	public function get_all_currencies_usable_by($payment_method_type)
+	{
+		if (
+			$payment_method_type instanceof EE_PMT_Base &&
+				$payment_method_type->get_gateway()
+		) {
+			$currencies_supported = $payment_method_type->get_gateway()->currencies_supported();
+		} else {
+			$currencies_supported = EE_Gateway::all_currencies_supported;
+		}
+		if ($currencies_supported == EE_Gateway::all_currencies_supported || empty($currencies_supported)) {
+			$currencies = $this->get_all_active();
+		} else {
+			$currencies = $this->get_all_active(array(array('CUR_code' => array('IN',$currencies_supported))));
+		}
+		return $currencies;
+	}
 }

core/db_models/EEM_Currency_Payment_Method.model.php

Spacing +1 added lines, -1 removed lines

@@ -34,7 +34,7 @@
             'Payment_Method' => new EE_Belongs_To_Relation()
         );
         // this model is generally available for reading
-        $this->_cap_restriction_generators[ EEM_Base::caps_read ] = new EE_Restriction_Generator_Public();
+        $this->_cap_restriction_generators[EEM_Base::caps_read] = new EE_Restriction_Generator_Public();
         $this->_caps_slug = 'payment_methods';
         parent::__construct($timezone);
     }

Indentation +25 added lines, -25 removed lines

@@ -11,31 +11,31 @@
  */
 class EEM_Currency_Payment_Method extends EEM_Base
 {
-    // private instance of the Attendee object
-    protected static $_instance = null;
+	// private instance of the Attendee object
+	protected static $_instance = null;
 
 
-    protected function __construct($timezone = null)
-    {
-        $this->singular_item = esc_html__('Currency Usable by Payment Method', 'event_espresso');
-        $this->plural_item = esc_html__('Currencies Usable by Payment Methods', 'event_espresso');
-        $this->_tables = array(
-            'Currency_Payment_Method' => new EE_Primary_Table('esp_currency_payment_method', 'CPM_ID')
-        );
-        $this->_fields = array(
-            'Currency_Payment_Method' => array(
-                'CPM_ID' => new EE_Primary_Key_Int_Field('CPM_ID', esc_html__('Currency to Payment Method LInk ID', 'event_espresso')),
-                'CUR_code' => new EE_Foreign_Key_String_Field('CUR_code', esc_html__('Currency Code', 'event_espresso'), false, '', 'Currency'),
-                'PMD_ID' => new EE_Foreign_Key_Int_Field('PMD_ID', esc_html__('Paymetn Method ID', 'event_espresso'), false, 0, 'Payment_Method')
-            )
-        );
-        $this->_model_relations = array(
-            'Currency' => new EE_Belongs_To_Relation(),
-            'Payment_Method' => new EE_Belongs_To_Relation()
-        );
-        // this model is generally available for reading
-        $this->_cap_restriction_generators[ EEM_Base::caps_read ] = new EE_Restriction_Generator_Public();
-        $this->_caps_slug = 'payment_methods';
-        parent::__construct($timezone);
-    }
+	protected function __construct($timezone = null)
+	{
+		$this->singular_item = esc_html__('Currency Usable by Payment Method', 'event_espresso');
+		$this->plural_item = esc_html__('Currencies Usable by Payment Methods', 'event_espresso');
+		$this->_tables = array(
+			'Currency_Payment_Method' => new EE_Primary_Table('esp_currency_payment_method', 'CPM_ID')
+		);
+		$this->_fields = array(
+			'Currency_Payment_Method' => array(
+				'CPM_ID' => new EE_Primary_Key_Int_Field('CPM_ID', esc_html__('Currency to Payment Method LInk ID', 'event_espresso')),
+				'CUR_code' => new EE_Foreign_Key_String_Field('CUR_code', esc_html__('Currency Code', 'event_espresso'), false, '', 'Currency'),
+				'PMD_ID' => new EE_Foreign_Key_Int_Field('PMD_ID', esc_html__('Paymetn Method ID', 'event_espresso'), false, 0, 'Payment_Method')
+			)
+		);
+		$this->_model_relations = array(
+			'Currency' => new EE_Belongs_To_Relation(),
+			'Payment_Method' => new EE_Belongs_To_Relation()
+		);
+		// this model is generally available for reading
+		$this->_cap_restriction_generators[ EEM_Base::caps_read ] = new EE_Restriction_Generator_Public();
+		$this->_caps_slug = 'payment_methods';
+		parent::__construct($timezone);
+	}
 }

core/db_models/helpers/EE_Model_Parser.php

Indentation +144 added lines, -144 removed lines

@@ -9,153 +9,153 @@
  */
 class EE_Model_Parser
 {
-    const table_alias_model_relation_chain_separator = '__';
-    const table_alias_model_relation_chain_prefix_end = '___';
-    /**
-     * Adds a period onto the front and end of the string. This often helps in searching.
-     * For example, if we want to find the model name "Event", it can be tricky when the following are possible
-     * "","Event.EVT_ID","Event","Event_Venue.Venue.VNU_ID",etc. It's easier to look for ".Event." in
-     * "..",".Event.EVT_ID.", ".Event.", and ".Event_Venue.Venue.VNU_ID", especially when the last example should NOT
-     * be found because the "Event" model isn't mentioned- it's just a string that has a model name that coincidentally
-     * has it as a substring
-     * @param string $string_to_pad
-     * @return string
-     */
-    public static function pad_with_periods($string_to_pad)
-    {
-        return "." . $string_to_pad . ".";
-    }
-    /**
-     * Basically undoes _pad_with_periods
-     * @param string $string_to_trim
-     * @return string
-     */
-    public static function trim_periods($string_to_trim)
-    {
-        return trim($string_to_trim, '.');
-    }
+	const table_alias_model_relation_chain_separator = '__';
+	const table_alias_model_relation_chain_prefix_end = '___';
+	/**
+	 * Adds a period onto the front and end of the string. This often helps in searching.
+	 * For example, if we want to find the model name "Event", it can be tricky when the following are possible
+	 * "","Event.EVT_ID","Event","Event_Venue.Venue.VNU_ID",etc. It's easier to look for ".Event." in
+	 * "..",".Event.EVT_ID.", ".Event.", and ".Event_Venue.Venue.VNU_ID", especially when the last example should NOT
+	 * be found because the "Event" model isn't mentioned- it's just a string that has a model name that coincidentally
+	 * has it as a substring
+	 * @param string $string_to_pad
+	 * @return string
+	 */
+	public static function pad_with_periods($string_to_pad)
+	{
+		return "." . $string_to_pad . ".";
+	}
+	/**
+	 * Basically undoes _pad_with_periods
+	 * @param string $string_to_trim
+	 * @return string
+	 */
+	public static function trim_periods($string_to_trim)
+	{
+		return trim($string_to_trim, '.');
+	}
 
 
 
-    /**
-     * Gets the calculated table's alias
-     * @param string $model_relation_chain or query param
-     * @param        $this_model_name
-     * @return string which can be added onto table aliases to make them unique
-     */
-    public static function extract_table_alias_model_relation_chain_prefix($model_relation_chain, $this_model_name)
-    {
-        // eg $model_relation_chain = 'Venue.Event_Venue.Event.Registration", and $this_model_name = 'Event'
-        $model_relation_chain = self::pad_with_periods($model_relation_chain);
-        $this_model_name = self::pad_with_periods($this_model_name);
-        // eg '.Venue.Event_Venue.Event.Registration." and '.Event.'
-        // remove this model name and everything afterwards
-        $pos_of_model_name = strpos($model_relation_chain, $this_model_name);
-        $model_relation_chain = substr($model_relation_chain, 0, $pos_of_model_name);
-        // eg '.Venue.Event_Venue.'
-        // trim periods
-        $model_relation_chain = self::trim_periods($model_relation_chain);
-        // eg 'Venue.Event_Venue'
-        // replace periods with double-underscores
-        $model_relation_chain = str_replace(".", self::table_alias_model_relation_chain_separator, $model_relation_chain);
-        // eg 'Venue__Event_Venue'
-        if ($model_relation_chain != '') {
-            $model_relation_chain = $model_relation_chain . self::table_alias_model_relation_chain_prefix_end;
-        }
-        // eg 'Venue_Event_Venue___'
-        return $model_relation_chain;
-    }
-    /**
-     * Gets the table's alias (without prefix or anything)
-     * @param string $table_alias_with_model_relation_chain_prefix which CAN have a table alias model relation chain prefix (or not)
-     * @return string
-     */
-    public static function remove_table_alias_model_relation_chain_prefix($table_alias_with_model_relation_chain_prefix)
-    {
-        // does this actually have a table alias model relation chain prefix?
-        $pos = strpos($table_alias_with_model_relation_chain_prefix, self::table_alias_model_relation_chain_prefix_end);
-        if ($pos !== false) {
-            // yes
-            // find that triple underscore and remove it and everything before it
-            $table_alias = substr($table_alias_with_model_relation_chain_prefix, $pos + strlen(self::table_alias_model_relation_chain_prefix_end));
-        } else {
-            $table_alias = $table_alias_with_model_relation_chain_prefix;
-        }
-        return $table_alias;
-    }
-    /**
-     * Gets the table alias model relation chain prefix from the table alias already containing it
-     * @param string $table_alias_with_model_relation_chain_prefix
-     * @return string
-     */
-    public static function get_prefix_from_table_alias_with_model_relation_chain_prefix($table_alias_with_model_relation_chain_prefix)
-    {
-        // does this actually have a table alias model relation chain prefix?
-        $pos = strpos($table_alias_with_model_relation_chain_prefix, self::table_alias_model_relation_chain_prefix_end);
-        if ($pos !== false) {
-            // yes
-            // find that triple underscore and remove it and everything before it
-            $prefix = substr($table_alias_with_model_relation_chain_prefix, 0, $pos + strlen(self::table_alias_model_relation_chain_prefix_end));
-        } else {
-            $prefix = '';
-        }
-        return $prefix;
-    }
+	/**
+	 * Gets the calculated table's alias
+	 * @param string $model_relation_chain or query param
+	 * @param        $this_model_name
+	 * @return string which can be added onto table aliases to make them unique
+	 */
+	public static function extract_table_alias_model_relation_chain_prefix($model_relation_chain, $this_model_name)
+	{
+		// eg $model_relation_chain = 'Venue.Event_Venue.Event.Registration", and $this_model_name = 'Event'
+		$model_relation_chain = self::pad_with_periods($model_relation_chain);
+		$this_model_name = self::pad_with_periods($this_model_name);
+		// eg '.Venue.Event_Venue.Event.Registration." and '.Event.'
+		// remove this model name and everything afterwards
+		$pos_of_model_name = strpos($model_relation_chain, $this_model_name);
+		$model_relation_chain = substr($model_relation_chain, 0, $pos_of_model_name);
+		// eg '.Venue.Event_Venue.'
+		// trim periods
+		$model_relation_chain = self::trim_periods($model_relation_chain);
+		// eg 'Venue.Event_Venue'
+		// replace periods with double-underscores
+		$model_relation_chain = str_replace(".", self::table_alias_model_relation_chain_separator, $model_relation_chain);
+		// eg 'Venue__Event_Venue'
+		if ($model_relation_chain != '') {
+			$model_relation_chain = $model_relation_chain . self::table_alias_model_relation_chain_prefix_end;
+		}
+		// eg 'Venue_Event_Venue___'
+		return $model_relation_chain;
+	}
+	/**
+	 * Gets the table's alias (without prefix or anything)
+	 * @param string $table_alias_with_model_relation_chain_prefix which CAN have a table alias model relation chain prefix (or not)
+	 * @return string
+	 */
+	public static function remove_table_alias_model_relation_chain_prefix($table_alias_with_model_relation_chain_prefix)
+	{
+		// does this actually have a table alias model relation chain prefix?
+		$pos = strpos($table_alias_with_model_relation_chain_prefix, self::table_alias_model_relation_chain_prefix_end);
+		if ($pos !== false) {
+			// yes
+			// find that triple underscore and remove it and everything before it
+			$table_alias = substr($table_alias_with_model_relation_chain_prefix, $pos + strlen(self::table_alias_model_relation_chain_prefix_end));
+		} else {
+			$table_alias = $table_alias_with_model_relation_chain_prefix;
+		}
+		return $table_alias;
+	}
+	/**
+	 * Gets the table alias model relation chain prefix from the table alias already containing it
+	 * @param string $table_alias_with_model_relation_chain_prefix
+	 * @return string
+	 */
+	public static function get_prefix_from_table_alias_with_model_relation_chain_prefix($table_alias_with_model_relation_chain_prefix)
+	{
+		// does this actually have a table alias model relation chain prefix?
+		$pos = strpos($table_alias_with_model_relation_chain_prefix, self::table_alias_model_relation_chain_prefix_end);
+		if ($pos !== false) {
+			// yes
+			// find that triple underscore and remove it and everything before it
+			$prefix = substr($table_alias_with_model_relation_chain_prefix, 0, $pos + strlen(self::table_alias_model_relation_chain_prefix_end));
+		} else {
+			$prefix = '';
+		}
+		return $prefix;
+	}
 
-    /**
-     * Gets the table alias model relation chain prefix (ie, what can be prepended onto
-     * EE_Model_Field::get_qualified_column() to get the proper column name for that field
-     * in a specific query) from teh query param (eg 'Registration.Event.EVT_ID').
-     *
-     * @param string $model_name of the model on which the related query param was found to be belong
-     * @param string $original_query_param
-     * @return string
-     */
-    public static function extract_table_alias_model_relation_chain_from_query_param($model_name, $original_query_param)
-    {
-        $relation_chain = self::extract_model_relation_chain($model_name, $original_query_param);
-        $table_alias_with_model_relation_chain_prefix = EE_Model_Parser::extract_table_alias_model_relation_chain_prefix($relation_chain, $model_name);
-        return $table_alias_with_model_relation_chain_prefix;
-    }
-    /**
-     * Gets the model relation chain to $model_name from the $original_query_param.
-     * Eg, if $model_name were 'Payment', and $original_query_param were 'Registration.Transaction.Payment.PAY_ID',
-     * this would return 'Registration.Transaction.Payment'. Also if the query param were 'Registration.Transaction.Payment'
-     * and $model_name were 'Payment', it should return 'Registration.Transaction.Payment'
-     * @param string $model_name
-     * @param string $original_query_param
-     * @return string
-     */
-    public static function extract_model_relation_chain($model_name, $original_query_param)
-    {
-        // prefix and postfix both with a period, as this facilitates searching
-        $model_name = EE_Model_Parser::pad_with_periods($model_name);
-        $original_query_param = EE_Model_Parser::pad_with_periods($original_query_param);
-        $pos_of_model_string = strpos($original_query_param, $model_name);
-        // eg, if we're looking for the model relation chain from Event to Payment, the original query param is probably something like
-        // "Registration.Transaction.Payment.PAY_ID", $pos_of_model_string points to the 'P' or Payment. We want the string
-        // "Registration.Transaction.Payment"
-        $model_relation_chain = substr($original_query_param, 0, $pos_of_model_string + strlen($model_name));
-        return EE_Model_Parser::trim_periods($model_relation_chain);
-    }
+	/**
+	 * Gets the table alias model relation chain prefix (ie, what can be prepended onto
+	 * EE_Model_Field::get_qualified_column() to get the proper column name for that field
+	 * in a specific query) from teh query param (eg 'Registration.Event.EVT_ID').
+	 *
+	 * @param string $model_name of the model on which the related query param was found to be belong
+	 * @param string $original_query_param
+	 * @return string
+	 */
+	public static function extract_table_alias_model_relation_chain_from_query_param($model_name, $original_query_param)
+	{
+		$relation_chain = self::extract_model_relation_chain($model_name, $original_query_param);
+		$table_alias_with_model_relation_chain_prefix = EE_Model_Parser::extract_table_alias_model_relation_chain_prefix($relation_chain, $model_name);
+		return $table_alias_with_model_relation_chain_prefix;
+	}
+	/**
+	 * Gets the model relation chain to $model_name from the $original_query_param.
+	 * Eg, if $model_name were 'Payment', and $original_query_param were 'Registration.Transaction.Payment.PAY_ID',
+	 * this would return 'Registration.Transaction.Payment'. Also if the query param were 'Registration.Transaction.Payment'
+	 * and $model_name were 'Payment', it should return 'Registration.Transaction.Payment'
+	 * @param string $model_name
+	 * @param string $original_query_param
+	 * @return string
+	 */
+	public static function extract_model_relation_chain($model_name, $original_query_param)
+	{
+		// prefix and postfix both with a period, as this facilitates searching
+		$model_name = EE_Model_Parser::pad_with_periods($model_name);
+		$original_query_param = EE_Model_Parser::pad_with_periods($original_query_param);
+		$pos_of_model_string = strpos($original_query_param, $model_name);
+		// eg, if we're looking for the model relation chain from Event to Payment, the original query param is probably something like
+		// "Registration.Transaction.Payment.PAY_ID", $pos_of_model_string points to the 'P' or Payment. We want the string
+		// "Registration.Transaction.Payment"
+		$model_relation_chain = substr($original_query_param, 0, $pos_of_model_string + strlen($model_name));
+		return EE_Model_Parser::trim_periods($model_relation_chain);
+	}
 
-    /**
-     * Replaces the specified model in teh model relation chain with teh join model.
-     * Eg EE_Model_Parser::replace_model_name_with_join_model_name_in_model_relation_chain(
-     * "Ticket", "Datetime_Ticket", "Datetime.Ticket" ) will return
-     * "Datetime.Datetime_Ticket" which can be used to find the table alias model relation chain prefix
-     * using EE_Model_Parser::extract_table_alias_model_relation_chain_prefix
-     * @param string $model_name
-     * @param string $join_model_name
-     * @param string $model_relation_chain
-     * @return string
-     */
-    public static function replace_model_name_with_join_model_name_in_model_relation_chain($model_name, $join_model_name, $model_relation_chain)
-    {
-        $model_name = EE_Model_Parser::pad_with_periods($model_name);
-        $join_model_name = EE_Model_Parser::pad_with_periods($join_model_name);
-        $model_relation_chain = EE_Model_Parser::pad_with_periods($model_relation_chain);
-        $replaced_with_periods = str_replace($model_name, $join_model_name, $model_relation_chain);
-        return EE_Model_Parser::trim_periods($replaced_with_periods);
-    }
+	/**
+	 * Replaces the specified model in teh model relation chain with teh join model.
+	 * Eg EE_Model_Parser::replace_model_name_with_join_model_name_in_model_relation_chain(
+	 * "Ticket", "Datetime_Ticket", "Datetime.Ticket" ) will return
+	 * "Datetime.Datetime_Ticket" which can be used to find the table alias model relation chain prefix
+	 * using EE_Model_Parser::extract_table_alias_model_relation_chain_prefix
+	 * @param string $model_name
+	 * @param string $join_model_name
+	 * @param string $model_relation_chain
+	 * @return string
+	 */
+	public static function replace_model_name_with_join_model_name_in_model_relation_chain($model_name, $join_model_name, $model_relation_chain)
+	{
+		$model_name = EE_Model_Parser::pad_with_periods($model_name);
+		$join_model_name = EE_Model_Parser::pad_with_periods($join_model_name);
+		$model_relation_chain = EE_Model_Parser::pad_with_periods($model_relation_chain);
+		$replaced_with_periods = str_replace($model_name, $join_model_name, $model_relation_chain);
+		return EE_Model_Parser::trim_periods($replaced_with_periods);
+	}
 }

Spacing +2 added lines, -2 removed lines

@@ -23,7 +23,7 @@ 
      */
     public static function pad_with_periods($string_to_pad)
     {
-        return "." . $string_to_pad . ".";
+        return ".".$string_to_pad.".";
     }
     /**
      * Basically undoes _pad_with_periods
@@ -60,7 +60,7 @@ 
         $model_relation_chain = str_replace(".", self::table_alias_model_relation_chain_separator, $model_relation_chain);
         // eg 'Venue__Event_Venue'
         if ($model_relation_chain != '') {
-            $model_relation_chain = $model_relation_chain . self::table_alias_model_relation_chain_prefix_end;
+            $model_relation_chain = $model_relation_chain.self::table_alias_model_relation_chain_prefix_end;
         }
         // eg 'Venue_Event_Venue___'
         return $model_relation_chain;