eventespresso / event-espresso-core

core/services/commands/registration/CreateRegistrationCommandHandler.php

Indentation +39 added lines, -39 removed lines

@@ -7,7 +7,7 @@ 
 use EventEspresso\core\services\commands\CommandInterface;
 
 if ( ! defined('EVENT_ESPRESSO_VERSION')) {
-    exit('No direct script access allowed');
+	exit('No direct script access allowed');
 }
 
 
@@ -23,50 +23,50 @@ 
 class CreateRegistrationCommandHandler extends CommandHandler
 {
 
-    /**
-     * @var CreateRegistrationService $registration_service
-     */
-    private $registration_service;
+	/**
+	 * @var CreateRegistrationService $registration_service
+	 */
+	private $registration_service;
 
 
 
-    /**
-     * Command constructor
-     *
-     * @param CreateRegistrationService $registration_service
-     */
-    public function __construct(CreateRegistrationService $registration_service)
-    {
-        $this->registration_service = $registration_service;
-    }
+	/**
+	 * Command constructor
+	 *
+	 * @param CreateRegistrationService $registration_service
+	 */
+	public function __construct(CreateRegistrationService $registration_service)
+	{
+		$this->registration_service = $registration_service;
+	}
 
 
 
-    /**
-     * @param  CommandInterface $command
-     * @return mixed
-     * @throws \OutOfRangeException
-     * @throws \EventEspresso\core\exceptions\UnexpectedEntityException
-     * @throws \EE_Error
-     * @throws \EventEspresso\core\exceptions\InvalidEntityException
-     */
-    public function handle(CommandInterface $command)
-    {
-        /** @var CreateRegistrationCommand $command */
-        if ( ! $command instanceof CreateRegistrationCommand) {
-            throw new InvalidEntityException(get_class($command), 'CreateRegistrationCommand');
-        }
-        // now create a new registration for the ticket
-        return $this->registration_service->create(
-            $command->ticket()->get_related_event(),
-            $command->transaction(),
-            $command->ticket(),
-            $command->ticketLineItem(),
-            $command->regCount(),
-            $command->regGroupSize(),
-            $command->regStatus()
-        );
-    }
+	/**
+	 * @param  CommandInterface $command
+	 * @return mixed
+	 * @throws \OutOfRangeException
+	 * @throws \EventEspresso\core\exceptions\UnexpectedEntityException
+	 * @throws \EE_Error
+	 * @throws \EventEspresso\core\exceptions\InvalidEntityException
+	 */
+	public function handle(CommandInterface $command)
+	{
+		/** @var CreateRegistrationCommand $command */
+		if ( ! $command instanceof CreateRegistrationCommand) {
+			throw new InvalidEntityException(get_class($command), 'CreateRegistrationCommand');
+		}
+		// now create a new registration for the ticket
+		return $this->registration_service->create(
+			$command->ticket()->get_related_event(),
+			$command->transaction(),
+			$command->ticket(),
+			$command->ticketLineItem(),
+			$command->regCount(),
+			$command->regGroupSize(),
+			$command->regStatus()
+		);
+	}
 
 
 

modules/single_page_checkout/inc/EE_SPCO_Reg_Step.class.php

Indentation +632 added lines, -632 removed lines

@@ -1,5 +1,5 @@ 
 <?php if (! defined('EVENT_ESPRESSO_VERSION')) {
-    exit('No direct script access allowed');
+	exit('No direct script access allowed');
 }
 
 
@@ -16,672 +16,672 @@ 
 abstract class EE_SPCO_Reg_Step
 {
 
-    /**
-     *    $_completed - TRUE if this step has fully completed it's duties
-     *
-     * @access protected
-     * @type bool $_completed
-     */
-    protected $_completed = false;
-
-    /**
-     *    $_is_current_step - TRUE if this is the current step
-     *
-     * @access protected
-     * @type bool $_is_current_step
-     */
-    protected $_is_current_step = false;
-
-    /**
-     *    $_order - when the reg step should be run relative to other steps
-     *
-     * @access protected
-     * @type int $_template
-     */
-    protected $_order = 0;
-
-    /**
-     *    $_slug - URL param for this step
-     *
-     * @access protected
-     * @type string $_slug
-     */
-    protected $_slug;
-
-    /**
-     *    $_name - Step Name - translatable string
-     *
-     * @access protected
-     * @type string $_slug
-     */
-    protected $_name;
-
-    /**
-     *    $_submit_button_text - translatable string that appears on this step's submit button
-     *
-     * @access protected
-     * @type string $_slug
-     */
-    protected $_submit_button_text;
-
-    /**
-     *    $_template - template name
-     *
-     * @access protected
-     * @type string $_template
-     */
-    protected $_template;
-
-    /**
-     *    $_reg_form_name - the form input name and id attribute
-     *
-     * @access protected
-     * @var string $_reg_form_name
-     */
-    protected $_reg_form_name;
-
-    /**
-     *    $_success_message - text to display upon successful form submission
-     *
-     * @access private
-     * @var string $_success_message
-     */
-    protected $_success_message;
-
-    /**
-     *    $_instructions - a brief description of how to complete the reg step.
-     *    Usually displayed in conjunction with the previous step's success message.
-     *
-     * @access private
-     * @var string $_instructions
-     */
-    protected $_instructions;
-
-    /**
-     *    $_valid_data - the normalized and validated data for this step
-     *
-     * @access public
-     * @var array $_valid_data
-     */
-    protected $_valid_data = array();
-
-    /**
-     *    $reg_form - the registration form for this step
-     *
-     * @access public
-     * @var EE_Form_Section_Proper $reg_form
-     */
-    public $reg_form;
-
-    /**
-     *    $checkout - EE_Checkout object for handling the properties of the current checkout process
-     *
-     * @access public
-     * @var EE_Checkout $checkout
-     */
-    public $checkout;
-
-
-
-    /**
-     * @return void
-     */
-    abstract public function translate_js_strings();
-
-
+	/**
+	 *    $_completed - TRUE if this step has fully completed it's duties
+	 *
+	 * @access protected
+	 * @type bool $_completed
+	 */
+	protected $_completed = false;
+
+	/**
+	 *    $_is_current_step - TRUE if this is the current step
+	 *
+	 * @access protected
+	 * @type bool $_is_current_step
+	 */
+	protected $_is_current_step = false;
+
+	/**
+	 *    $_order - when the reg step should be run relative to other steps
+	 *
+	 * @access protected
+	 * @type int $_template
+	 */
+	protected $_order = 0;
+
+	/**
+	 *    $_slug - URL param for this step
+	 *
+	 * @access protected
+	 * @type string $_slug
+	 */
+	protected $_slug;
+
+	/**
+	 *    $_name - Step Name - translatable string
+	 *
+	 * @access protected
+	 * @type string $_slug
+	 */
+	protected $_name;
+
+	/**
+	 *    $_submit_button_text - translatable string that appears on this step's submit button
+	 *
+	 * @access protected
+	 * @type string $_slug
+	 */
+	protected $_submit_button_text;
+
+	/**
+	 *    $_template - template name
+	 *
+	 * @access protected
+	 * @type string $_template
+	 */
+	protected $_template;
+
+	/**
+	 *    $_reg_form_name - the form input name and id attribute
+	 *
+	 * @access protected
+	 * @var string $_reg_form_name
+	 */
+	protected $_reg_form_name;
+
+	/**
+	 *    $_success_message - text to display upon successful form submission
+	 *
+	 * @access private
+	 * @var string $_success_message
+	 */
+	protected $_success_message;
+
+	/**
+	 *    $_instructions - a brief description of how to complete the reg step.
+	 *    Usually displayed in conjunction with the previous step's success message.
+	 *
+	 * @access private
+	 * @var string $_instructions
+	 */
+	protected $_instructions;
+
+	/**
+	 *    $_valid_data - the normalized and validated data for this step
+	 *
+	 * @access public
+	 * @var array $_valid_data
+	 */
+	protected $_valid_data = array();
+
+	/**
+	 *    $reg_form - the registration form for this step
+	 *
+	 * @access public
+	 * @var EE_Form_Section_Proper $reg_form
+	 */
+	public $reg_form;
+
+	/**
+	 *    $checkout - EE_Checkout object for handling the properties of the current checkout process
+	 *
+	 * @access public
+	 * @var EE_Checkout $checkout
+	 */
+	public $checkout;
+
+
+
+	/**
+	 * @return void
+	 */
+	abstract public function translate_js_strings();
+
+
 
-    /**
-     * @return void
-     */
-    abstract public function enqueue_styles_and_scripts();
-
-
-
-    /**
-     * @return boolean
-     */
-    abstract public function initialize_reg_step();
-
-
-
-    /**
-     * @return string
-     */
-    abstract public function generate_reg_form();
-
-
-
-    /**
-     * @return boolean
-     */
-    abstract public function process_reg_step();
-
-
-
-    /**
-     * @return boolean
-     */
-    abstract public function update_reg_step();
-
-
-
-    /**
-     * @return boolean
-     */
-    public function completed()
-    {
-        return $this->_completed;
-    }
+	/**
+	 * @return void
+	 */
+	abstract public function enqueue_styles_and_scripts();
+
+
+
+	/**
+	 * @return boolean
+	 */
+	abstract public function initialize_reg_step();
+
+
+
+	/**
+	 * @return string
+	 */
+	abstract public function generate_reg_form();
+
+
+
+	/**
+	 * @return boolean
+	 */
+	abstract public function process_reg_step();
+
+
+
+	/**
+	 * @return boolean
+	 */
+	abstract public function update_reg_step();
+
+
+
+	/**
+	 * @return boolean
+	 */
+	public function completed()
+	{
+		return $this->_completed;
+	}
 
 
 
-    /**
-     * set_completed - toggles $_completed to TRUE
-     */
-    public function set_completed()
-    {
-        // DEBUG LOG
-        //$this->checkout->log( __CLASS__, __FUNCTION__, __LINE__ );
-        $this->_completed = apply_filters('FHEE__EE_SPCO_Reg_Step__set_completed___completed', true, $this);
-    }
+	/**
+	 * set_completed - toggles $_completed to TRUE
+	 */
+	public function set_completed()
+	{
+		// DEBUG LOG
+		//$this->checkout->log( __CLASS__, __FUNCTION__, __LINE__ );
+		$this->_completed = apply_filters('FHEE__EE_SPCO_Reg_Step__set_completed___completed', true, $this);
+	}
 
 
 
-    /**
-     * set_completed - toggles $_completed to FALSE
-     */
-    public function set_not_completed()
-    {
-        $this->_completed = false;
-    }
+	/**
+	 * set_completed - toggles $_completed to FALSE
+	 */
+	public function set_not_completed()
+	{
+		$this->_completed = false;
+	}
 
 
 
-    /**
-     * @return string
-     */
-    public function name()
-    {
-        return $this->_name;
-    }
+	/**
+	 * @return string
+	 */
+	public function name()
+	{
+		return $this->_name;
+	}
 
 
 
-    /**
-     * @return string
-     */
-    public function slug()
-    {
-        return $this->_slug;
-    }
+	/**
+	 * @return string
+	 */
+	public function slug()
+	{
+		return $this->_slug;
+	}
 
 
 
-    /**
-     * submit_button_text
-     * the text that appears on the reg step form submit button
-     *
-     * @return string
-     */
-    public function submit_button_text()
-    {
-        return $this->_submit_button_text;
-    }
+	/**
+	 * submit_button_text
+	 * the text that appears on the reg step form submit button
+	 *
+	 * @return string
+	 */
+	public function submit_button_text()
+	{
+		return $this->_submit_button_text;
+	}
 
 
 
-    /**
-     * set_submit_button_text
-     * sets the text that appears on the reg step form submit button
-     *
-     * @param string $submit_button_text
-     */
-    public function set_submit_button_text($submit_button_text = '')
-    {
-        if (! empty($submit_button_text)) {
-            $this->_submit_button_text = $submit_button_text;
-        } else if ($this->checkout->next_step instanceof EE_SPCO_Reg_Step) {
-            if ($this->checkout->revisit) {
-                $this->_submit_button_text = sprintf(
-                    __('Update %s', 'event_espresso'),
-                    $this->checkout->current_step->name()
-                );
-            } else {
-                $this->_submit_button_text = sprintf(
-                    __('Proceed to %s', 'event_espresso'),
-                    $this->checkout->next_step->name()
-                );
-            }
-        }
-        // filters the submit button text
-        $this->_submit_button_text = apply_filters(
-            'FHEE__EE_SPCO_Reg_Step__set_submit_button_text___submit_button_text',
-            $this->_submit_button_text,
-            $this->checkout
-        );
-    }
+	/**
+	 * set_submit_button_text
+	 * sets the text that appears on the reg step form submit button
+	 *
+	 * @param string $submit_button_text
+	 */
+	public function set_submit_button_text($submit_button_text = '')
+	{
+		if (! empty($submit_button_text)) {
+			$this->_submit_button_text = $submit_button_text;
+		} else if ($this->checkout->next_step instanceof EE_SPCO_Reg_Step) {
+			if ($this->checkout->revisit) {
+				$this->_submit_button_text = sprintf(
+					__('Update %s', 'event_espresso'),
+					$this->checkout->current_step->name()
+				);
+			} else {
+				$this->_submit_button_text = sprintf(
+					__('Proceed to %s', 'event_espresso'),
+					$this->checkout->next_step->name()
+				);
+			}
+		}
+		// filters the submit button text
+		$this->_submit_button_text = apply_filters(
+			'FHEE__EE_SPCO_Reg_Step__set_submit_button_text___submit_button_text',
+			$this->_submit_button_text,
+			$this->checkout
+		);
+	}
 
 
 
-    /**
-     * @param boolean $is_current_step
-     */
-    public function set_is_current_step($is_current_step)
-    {
-        $this->_is_current_step = $is_current_step;
-    }
+	/**
+	 * @param boolean $is_current_step
+	 */
+	public function set_is_current_step($is_current_step)
+	{
+		$this->_is_current_step = $is_current_step;
+	}
 
 
 
-    /**
-     * @return boolean
-     */
-    public function is_current_step()
-    {
-        return $this->_is_current_step;
-    }
+	/**
+	 * @return boolean
+	 */
+	public function is_current_step()
+	{
+		return $this->_is_current_step;
+	}
 
 
 
-    /**
-     * @return boolean
-     */
-    public function is_final_step()
-    {
-        return $this instanceof EE_SPCO_Reg_Step_Finalize_Registration ? true : false;
-    }
+	/**
+	 * @return boolean
+	 */
+	public function is_final_step()
+	{
+		return $this instanceof EE_SPCO_Reg_Step_Finalize_Registration ? true : false;
+	}
 
 
 
-    /**
-     * @param int $order
-     */
-    public function set_order($order)
-    {
-        $this->_order = $order;
-    }
-
-
+	/**
+	 * @param int $order
+	 */
+	public function set_order($order)
+	{
+		$this->_order = $order;
+	}
+
+
 
-    /**
-     * @return int
-     */
-    public function order()
-    {
-        return $this->_order;
-    }
-
-
-
-    /**
-     * @return string
-     */
-    public function template()
-    {
-        return $this->_template;
-    }
-
-
-
-    /**
-     * @return string
-     */
-    public function success_message()
-    {
-        return $this->_success_message;
-    }
-
-
-
-    /**
-     * _set_success_message
-     *
-     * @param string $success_message
-     */
-    protected function _set_success_message($success_message)
-    {
-        $this->_success_message = $success_message;
-    }
-
-
-
-    /**
-     * _reset_success_message
-     *
-     * @return void
-     */
-    protected function _reset_success_message()
-    {
-        $this->_success_message = '';
-    }
+	/**
+	 * @return int
+	 */
+	public function order()
+	{
+		return $this->_order;
+	}
+
+
+
+	/**
+	 * @return string
+	 */
+	public function template()
+	{
+		return $this->_template;
+	}
+
+
+
+	/**
+	 * @return string
+	 */
+	public function success_message()
+	{
+		return $this->_success_message;
+	}
+
+
+
+	/**
+	 * _set_success_message
+	 *
+	 * @param string $success_message
+	 */
+	protected function _set_success_message($success_message)
+	{
+		$this->_success_message = $success_message;
+	}
+
+
+
+	/**
+	 * _reset_success_message
+	 *
+	 * @return void
+	 */
+	protected function _reset_success_message()
+	{
+		$this->_success_message = '';
+	}
 
 
 
-    /**
-     * @return string
-     */
-    public function _instructions()
-    {
-        return $this->_instructions;
-    }
-
-
-
-    /**
-     * @param string $instructions
-     */
-    public function set_instructions($instructions)
-    {
-        $this->_instructions = apply_filters(
-            'FHEE__EE_SPCO_Reg_Step__set_instructions__instructions',
-            $instructions,
-            $this
-        );
-    }
-
-
-
-    /**
-     * @param array $valid_data
-     */
-    public function set_valid_data($valid_data)
-    {
-        $this->_valid_data = $valid_data;
-    }
-
-
-
-    /**
-     * @return array
-     */
-    public function valid_data()
-    {
-        if (empty($this->_valid_data)) {
-            $this->_valid_data = $this->reg_form->valid_data();
-        }
-        return $this->_valid_data;
-    }
-
-
-
-    /**
-     * @return string
-     */
-    public function reg_form_name()
-    {
-        if (empty($this->_reg_form_name)) {
-            $this->set_reg_form_name('ee-spco-' . $this->slug() . '-reg-step-form');
-        }
-        return $this->_reg_form_name;
-    }
-
-
-
-    /**
-     * @param string $reg_form_name
-     */
-    protected function set_reg_form_name($reg_form_name)
-    {
-        $this->_reg_form_name = $reg_form_name;
-    }
-
-
-
-    /**
-     * reg_step_url
-     *
-     * @param string $action
-     * @return string
-     */
-    public function reg_step_url($action = '')
-    {
-        $query_args = array('step' => $this->slug());
-        if (! empty($action)) {
-            $query_args['action'] = $action;
-        }
-        // final step has no display
-        if ($this instanceof EE_SPCO_Reg_Step_Finalize_Registration && $action === 'display_spco_reg_step') {
-            $query_args['action'] = 'process_reg_step';
-        }
-        if ($this->checkout->revisit) {
-            $query_args['revisit'] = true;
-        }
-        if ($this->checkout->reg_url_link) {
-            $query_args['e_reg_url_link'] = $this->checkout->reg_url_link;
-        }
-        return add_query_arg($query_args, $this->checkout->reg_page_base_url);
-    }
-
-
-
-    /**
-     * creates the default hidden inputs section
-     *
-     * @return EE_Form_Section_Proper
-     * @throws \EE_Error
-     */
-    public function reg_step_hidden_inputs()
-    {
-        // hidden inputs for admin registrations
-        if ($this->checkout->admin_request) {
-            return new EE_Form_Section_Proper(
-                array(
-                    'layout_strategy' => new EE_Div_Per_Section_Layout(),
-                    'html_id'         => 'ee-' . $this->slug() . '-hidden-inputs',
-                    'subsections'     => array(
-                        'next_step' => new EE_Fixed_Hidden_Input(
-                            array(
-                                'html_name' => 'next_step',
-                                'html_id'   => 'spco-' . $this->slug() . '-next-step',
-                                'default'   => $this->checkout->next_step instanceof EE_SPCO_Reg_Step
-                                    ? $this->checkout->next_step->slug()
-                                    : '',
-                            )
-                        ),
-                    ),
-                )
-            );
-        } else {
-            $default_form_action = apply_filters(
-                'FHEE__EE_SPCO_Reg_Step__reg_step_hidden_inputs__default_form_action',
-                empty($this->checkout->reg_url_link)
-                    ? 'process_reg_step'
-                    : 'update_reg_step',
-                $this
-            );
-            // hidden inputs for frontend registrations
-            return new EE_Form_Section_Proper(
-                array(
-                    'layout_strategy' => new EE_Div_Per_Section_Layout(),
-                    'html_id'         => 'ee-' . $this->slug() . '-hidden-inputs',
-                    'subsections'     => array(
-                        'action'         => new EE_Fixed_Hidden_Input(
-                            array(
-                                'html_name' => 'action',
-                                'html_id'   => 'spco-' . $this->slug() . '-action',
-                                'default'   => $default_form_action,
-                            )
-                        ),
-                        'next_step'      => new EE_Fixed_Hidden_Input(
-                            array(
-                                'html_name' => 'next_step',
-                                'html_id'   => 'spco-' . $this->slug() . '-next-step',
-                                'default'   => $this->checkout->next_step instanceof EE_SPCO_Reg_Step
-                                    ? $this->checkout->next_step->slug()
-                                    : '',
-                            )
-                        ),
-                        'e_reg_url_link' => new EE_Fixed_Hidden_Input(
-                            array(
-                                'html_name' => 'e_reg_url_link',
-                                'html_id'   => 'spco-reg_url_link',
-                                'default'   => $this->checkout->reg_url_link,
-                            )
-                        ),
-                        'revisit'        => new EE_Fixed_Hidden_Input(
-                            array(
-                                'html_name' => 'revisit',
-                                'html_id'   => 'spco-revisit',
-                                'default'   => $this->checkout->revisit,
-                            )
-                        ),
-                    ),
-                )
-            );
-        }
-    }
-
-
-
-    /**
-     * generate_reg_form_for_actions
-     *
-     * @param array $actions
-     * @return void
-     */
-    public function generate_reg_form_for_actions($actions = array())
-    {
-        $actions = array_merge(
-            array(
-                'generate_reg_form',
-                'display_spco_reg_step',
-                'process_reg_step',
-                'update_reg_step',
-            ),
-            $actions
-        );
-        $this->checkout->generate_reg_form = in_array($this->checkout->action, $actions, true) ? true : false;
-    }
-
-
-
-    /**
-     * @return string
-     * @throws \EE_Error
-     */
-    public function display_reg_form()
-    {
-        $html = '';
-        if ($this->reg_form instanceof EE_Form_Section_Proper) {
-            $html .= ! $this->checkout->admin_request ? $this->reg_form->form_open($this->reg_step_url()) : '';
-            if (EE_Registry::instance()->REQ->ajax) {
-                $this->reg_form->localize_validation_rules();
-                $this->checkout->json_response->add_validation_rules(EE_Form_Section_Proper::js_localization());
-            }
-            $html .= $this->reg_form->get_html();
-            $html .= ! $this->checkout->admin_request ? $this->reg_step_submit_button() : '';
-            $html .= ! $this->checkout->admin_request ? $this->reg_form->form_close() : '';
-        }
-        return $html;
-    }
-
-
-
-    /**
-     * div_class - returns nothing for current step, but a css class of "hidden" for others
-     *
-     * @return string
-     * @throws \EE_Error
-     */
-    public function reg_step_submit_button()
-    {
-        if (! $this->checkout->next_step instanceof EE_SPCO_Reg_Step) {
-            return '';
-        }
-        ob_start();
-        do_action(
-            'AHEE__before_spco_whats_next_buttons',
-            $this->slug(),
-            $this->checkout->next_step->slug(),
-            $this->checkout
-        );
-        $html = ob_get_clean();
-        // generate submit button
-        $sbmt_btn = new EE_Submit_Input(array(
-            'html_name'             => 'spco-go-to-step-' . $this->checkout->next_step->slug(),
-            'html_id'               => 'spco-go-to-step-' . $this->checkout->next_step->slug(),
-            'html_class'            => 'spco-next-step-btn',
-            'other_html_attributes' => ' rel="' . $this->slug() . '"',
-            'default'               => $this->submit_button_text(),
-        ));
-        $sbmt_btn->set_button_css_attributes(true, 'large');
-        $sbmt_btn_html = $sbmt_btn->get_html_for_input();
-        $html .= EEH_HTML::div(
-            apply_filters('FHEE__EE_SPCO_Reg_Step__reg_step_submit_button__sbmt_btn_html', $sbmt_btn_html, $this),
-            'spco-' . $this->slug() . '-whats-next-buttons-dv',
-            'spco-whats-next-buttons'
-        );
-        return $html;
-    }
-
-
-
-    /**
-     * div_class - returns nothing for current step, but a css class of "hidden" for others
-     *
-     * @return string
-     */
-    public function div_class()
-    {
-        return $this->is_current_step() ? '' : ' hidden';
-    }
-
-
-
-    /**
-     * div_class - returns  a css class of "hidden" for current step, but nothing for others
-     *
-     * @return string
-     */
-    public function edit_lnk_url()
-    {
-        return add_query_arg(array('step' => $this->slug()), $this->checkout->reg_page_base_url);
-    }
-
-
-
-    /**
-     * div_class - returns  a css class of "hidden" for current step, but nothing for others
-     *
-     * @return string
-     */
-    public function edit_link_class()
-    {
-        return $this->is_current_step() ? ' hidden' : '';
-    }
-
-
-
-    /**
-     * update_checkout with changes that have been made to the cart
-     *
-     * @return void
-     * @throws \EE_Error
-     */
-    public function update_checkout()
-    {
-        // grab the cart grand total and reset TXN total
-        $this->checkout->transaction->set_total($this->checkout->cart->get_cart_grand_total());
-        $this->checkout->stash_transaction_and_checkout();
-    }
-
-
-
-
-
-    /**
-     *    __sleep
-     * to conserve db space, let's remove the reg_form and the EE_Checkout object from EE_SPCO_Reg_Step objects upon
-     * serialization EE_Checkout will handle the reimplementation of itself upon waking, but we won't bother with the
-     * reg form, because if needed, it will be regenerated anyways
-     *
-     * @return array
-     */
-    public function __sleep()
-    {
-        // remove the reg form and the checkout
-        return array_diff(array_keys(get_object_vars($this)), array('reg_form', 'checkout'));
-    }
+	/**
+	 * @return string
+	 */
+	public function _instructions()
+	{
+		return $this->_instructions;
+	}
+
+
+
+	/**
+	 * @param string $instructions
+	 */
+	public function set_instructions($instructions)
+	{
+		$this->_instructions = apply_filters(
+			'FHEE__EE_SPCO_Reg_Step__set_instructions__instructions',
+			$instructions,
+			$this
+		);
+	}
+
+
+
+	/**
+	 * @param array $valid_data
+	 */
+	public function set_valid_data($valid_data)
+	{
+		$this->_valid_data = $valid_data;
+	}
+
+
+
+	/**
+	 * @return array
+	 */
+	public function valid_data()
+	{
+		if (empty($this->_valid_data)) {
+			$this->_valid_data = $this->reg_form->valid_data();
+		}
+		return $this->_valid_data;
+	}
+
+
+
+	/**
+	 * @return string
+	 */
+	public function reg_form_name()
+	{
+		if (empty($this->_reg_form_name)) {
+			$this->set_reg_form_name('ee-spco-' . $this->slug() . '-reg-step-form');
+		}
+		return $this->_reg_form_name;
+	}
+
+
+
+	/**
+	 * @param string $reg_form_name
+	 */
+	protected function set_reg_form_name($reg_form_name)
+	{
+		$this->_reg_form_name = $reg_form_name;
+	}
+
+
+
+	/**
+	 * reg_step_url
+	 *
+	 * @param string $action
+	 * @return string
+	 */
+	public function reg_step_url($action = '')
+	{
+		$query_args = array('step' => $this->slug());
+		if (! empty($action)) {
+			$query_args['action'] = $action;
+		}
+		// final step has no display
+		if ($this instanceof EE_SPCO_Reg_Step_Finalize_Registration && $action === 'display_spco_reg_step') {
+			$query_args['action'] = 'process_reg_step';
+		}
+		if ($this->checkout->revisit) {
+			$query_args['revisit'] = true;
+		}
+		if ($this->checkout->reg_url_link) {
+			$query_args['e_reg_url_link'] = $this->checkout->reg_url_link;
+		}
+		return add_query_arg($query_args, $this->checkout->reg_page_base_url);
+	}
+
+
+
+	/**
+	 * creates the default hidden inputs section
+	 *
+	 * @return EE_Form_Section_Proper
+	 * @throws \EE_Error
+	 */
+	public function reg_step_hidden_inputs()
+	{
+		// hidden inputs for admin registrations
+		if ($this->checkout->admin_request) {
+			return new EE_Form_Section_Proper(
+				array(
+					'layout_strategy' => new EE_Div_Per_Section_Layout(),
+					'html_id'         => 'ee-' . $this->slug() . '-hidden-inputs',
+					'subsections'     => array(
+						'next_step' => new EE_Fixed_Hidden_Input(
+							array(
+								'html_name' => 'next_step',
+								'html_id'   => 'spco-' . $this->slug() . '-next-step',
+								'default'   => $this->checkout->next_step instanceof EE_SPCO_Reg_Step
+									? $this->checkout->next_step->slug()
+									: '',
+							)
+						),
+					),
+				)
+			);
+		} else {
+			$default_form_action = apply_filters(
+				'FHEE__EE_SPCO_Reg_Step__reg_step_hidden_inputs__default_form_action',
+				empty($this->checkout->reg_url_link)
+					? 'process_reg_step'
+					: 'update_reg_step',
+				$this
+			);
+			// hidden inputs for frontend registrations
+			return new EE_Form_Section_Proper(
+				array(
+					'layout_strategy' => new EE_Div_Per_Section_Layout(),
+					'html_id'         => 'ee-' . $this->slug() . '-hidden-inputs',
+					'subsections'     => array(
+						'action'         => new EE_Fixed_Hidden_Input(
+							array(
+								'html_name' => 'action',
+								'html_id'   => 'spco-' . $this->slug() . '-action',
+								'default'   => $default_form_action,
+							)
+						),
+						'next_step'      => new EE_Fixed_Hidden_Input(
+							array(
+								'html_name' => 'next_step',
+								'html_id'   => 'spco-' . $this->slug() . '-next-step',
+								'default'   => $this->checkout->next_step instanceof EE_SPCO_Reg_Step
+									? $this->checkout->next_step->slug()
+									: '',
+							)
+						),
+						'e_reg_url_link' => new EE_Fixed_Hidden_Input(
+							array(
+								'html_name' => 'e_reg_url_link',
+								'html_id'   => 'spco-reg_url_link',
+								'default'   => $this->checkout->reg_url_link,
+							)
+						),
+						'revisit'        => new EE_Fixed_Hidden_Input(
+							array(
+								'html_name' => 'revisit',
+								'html_id'   => 'spco-revisit',
+								'default'   => $this->checkout->revisit,
+							)
+						),
+					),
+				)
+			);
+		}
+	}
+
+
+
+	/**
+	 * generate_reg_form_for_actions
+	 *
+	 * @param array $actions
+	 * @return void
+	 */
+	public function generate_reg_form_for_actions($actions = array())
+	{
+		$actions = array_merge(
+			array(
+				'generate_reg_form',
+				'display_spco_reg_step',
+				'process_reg_step',
+				'update_reg_step',
+			),
+			$actions
+		);
+		$this->checkout->generate_reg_form = in_array($this->checkout->action, $actions, true) ? true : false;
+	}
+
+
+
+	/**
+	 * @return string
+	 * @throws \EE_Error
+	 */
+	public function display_reg_form()
+	{
+		$html = '';
+		if ($this->reg_form instanceof EE_Form_Section_Proper) {
+			$html .= ! $this->checkout->admin_request ? $this->reg_form->form_open($this->reg_step_url()) : '';
+			if (EE_Registry::instance()->REQ->ajax) {
+				$this->reg_form->localize_validation_rules();
+				$this->checkout->json_response->add_validation_rules(EE_Form_Section_Proper::js_localization());
+			}
+			$html .= $this->reg_form->get_html();
+			$html .= ! $this->checkout->admin_request ? $this->reg_step_submit_button() : '';
+			$html .= ! $this->checkout->admin_request ? $this->reg_form->form_close() : '';
+		}
+		return $html;
+	}
+
+
+
+	/**
+	 * div_class - returns nothing for current step, but a css class of "hidden" for others
+	 *
+	 * @return string
+	 * @throws \EE_Error
+	 */
+	public function reg_step_submit_button()
+	{
+		if (! $this->checkout->next_step instanceof EE_SPCO_Reg_Step) {
+			return '';
+		}
+		ob_start();
+		do_action(
+			'AHEE__before_spco_whats_next_buttons',
+			$this->slug(),
+			$this->checkout->next_step->slug(),
+			$this->checkout
+		);
+		$html = ob_get_clean();
+		// generate submit button
+		$sbmt_btn = new EE_Submit_Input(array(
+			'html_name'             => 'spco-go-to-step-' . $this->checkout->next_step->slug(),
+			'html_id'               => 'spco-go-to-step-' . $this->checkout->next_step->slug(),
+			'html_class'            => 'spco-next-step-btn',
+			'other_html_attributes' => ' rel="' . $this->slug() . '"',
+			'default'               => $this->submit_button_text(),
+		));
+		$sbmt_btn->set_button_css_attributes(true, 'large');
+		$sbmt_btn_html = $sbmt_btn->get_html_for_input();
+		$html .= EEH_HTML::div(
+			apply_filters('FHEE__EE_SPCO_Reg_Step__reg_step_submit_button__sbmt_btn_html', $sbmt_btn_html, $this),
+			'spco-' . $this->slug() . '-whats-next-buttons-dv',
+			'spco-whats-next-buttons'
+		);
+		return $html;
+	}
+
+
+
+	/**
+	 * div_class - returns nothing for current step, but a css class of "hidden" for others
+	 *
+	 * @return string
+	 */
+	public function div_class()
+	{
+		return $this->is_current_step() ? '' : ' hidden';
+	}
+
+
+
+	/**
+	 * div_class - returns  a css class of "hidden" for current step, but nothing for others
+	 *
+	 * @return string
+	 */
+	public function edit_lnk_url()
+	{
+		return add_query_arg(array('step' => $this->slug()), $this->checkout->reg_page_base_url);
+	}
+
+
+
+	/**
+	 * div_class - returns  a css class of "hidden" for current step, but nothing for others
+	 *
+	 * @return string
+	 */
+	public function edit_link_class()
+	{
+		return $this->is_current_step() ? ' hidden' : '';
+	}
+
+
+
+	/**
+	 * update_checkout with changes that have been made to the cart
+	 *
+	 * @return void
+	 * @throws \EE_Error
+	 */
+	public function update_checkout()
+	{
+		// grab the cart grand total and reset TXN total
+		$this->checkout->transaction->set_total($this->checkout->cart->get_cart_grand_total());
+		$this->checkout->stash_transaction_and_checkout();
+	}
+
+
+
+
+
+	/**
+	 *    __sleep
+	 * to conserve db space, let's remove the reg_form and the EE_Checkout object from EE_SPCO_Reg_Step objects upon
+	 * serialization EE_Checkout will handle the reimplementation of itself upon waking, but we won't bother with the
+	 * reg form, because if needed, it will be regenerated anyways
+	 *
+	 * @return array
+	 */
+	public function __sleep()
+	{
+		// remove the reg form and the checkout
+		return array_diff(array_keys(get_object_vars($this)), array('reg_form', 'checkout'));
+	}
 
 
 

Spacing +14 added lines, -14 removed lines

@@ -1,4 +1,4 @@ 
-<?php if (! defined('EVENT_ESPRESSO_VERSION')) {
+<?php if ( ! defined('EVENT_ESPRESSO_VERSION')) {
     exit('No direct script access allowed');
 }
 
@@ -238,7 +238,7 @@ 
      */
     public function set_submit_button_text($submit_button_text = '')
     {
-        if (! empty($submit_button_text)) {
+        if ( ! empty($submit_button_text)) {
             $this->_submit_button_text = $submit_button_text;
         } else if ($this->checkout->next_step instanceof EE_SPCO_Reg_Step) {
             if ($this->checkout->revisit) {
@@ -410,7 +410,7 @@ 
     public function reg_form_name()
     {
         if (empty($this->_reg_form_name)) {
-            $this->set_reg_form_name('ee-spco-' . $this->slug() . '-reg-step-form');
+            $this->set_reg_form_name('ee-spco-'.$this->slug().'-reg-step-form');
         }
         return $this->_reg_form_name;
     }
@@ -436,7 +436,7 @@ 
     public function reg_step_url($action = '')
     {
         $query_args = array('step' => $this->slug());
-        if (! empty($action)) {
+        if ( ! empty($action)) {
             $query_args['action'] = $action;
         }
         // final step has no display
@@ -467,12 +467,12 @@ 
             return new EE_Form_Section_Proper(
                 array(
                     'layout_strategy' => new EE_Div_Per_Section_Layout(),
-                    'html_id'         => 'ee-' . $this->slug() . '-hidden-inputs',
+                    'html_id'         => 'ee-'.$this->slug().'-hidden-inputs',
                     'subsections'     => array(
                         'next_step' => new EE_Fixed_Hidden_Input(
                             array(
                                 'html_name' => 'next_step',
-                                'html_id'   => 'spco-' . $this->slug() . '-next-step',
+                                'html_id'   => 'spco-'.$this->slug().'-next-step',
                                 'default'   => $this->checkout->next_step instanceof EE_SPCO_Reg_Step
                                     ? $this->checkout->next_step->slug()
                                     : '',
@@ -493,19 +493,19 @@ 
             return new EE_Form_Section_Proper(
                 array(
                     'layout_strategy' => new EE_Div_Per_Section_Layout(),
-                    'html_id'         => 'ee-' . $this->slug() . '-hidden-inputs',
+                    'html_id'         => 'ee-'.$this->slug().'-hidden-inputs',
                     'subsections'     => array(
                         'action'         => new EE_Fixed_Hidden_Input(
                             array(
                                 'html_name' => 'action',
-                                'html_id'   => 'spco-' . $this->slug() . '-action',
+                                'html_id'   => 'spco-'.$this->slug().'-action',
                                 'default'   => $default_form_action,
                             )
                         ),
                         'next_step'      => new EE_Fixed_Hidden_Input(
                             array(
                                 'html_name' => 'next_step',
-                                'html_id'   => 'spco-' . $this->slug() . '-next-step',
+                                'html_id'   => 'spco-'.$this->slug().'-next-step',
                                 'default'   => $this->checkout->next_step instanceof EE_SPCO_Reg_Step
                                     ? $this->checkout->next_step->slug()
                                     : '',
@@ -585,7 +585,7 @@ 
      */
     public function reg_step_submit_button()
     {
-        if (! $this->checkout->next_step instanceof EE_SPCO_Reg_Step) {
+        if ( ! $this->checkout->next_step instanceof EE_SPCO_Reg_Step) {
             return '';
         }
         ob_start();
@@ -598,17 +598,17 @@ 
         $html = ob_get_clean();
         // generate submit button
         $sbmt_btn = new EE_Submit_Input(array(
-            'html_name'             => 'spco-go-to-step-' . $this->checkout->next_step->slug(),
-            'html_id'               => 'spco-go-to-step-' . $this->checkout->next_step->slug(),
+            'html_name'             => 'spco-go-to-step-'.$this->checkout->next_step->slug(),
+            'html_id'               => 'spco-go-to-step-'.$this->checkout->next_step->slug(),
             'html_class'            => 'spco-next-step-btn',
-            'other_html_attributes' => ' rel="' . $this->slug() . '"',
+            'other_html_attributes' => ' rel="'.$this->slug().'"',
             'default'               => $this->submit_button_text(),
         ));
         $sbmt_btn->set_button_css_attributes(true, 'large');
         $sbmt_btn_html = $sbmt_btn->get_html_for_input();
         $html .= EEH_HTML::div(
             apply_filters('FHEE__EE_SPCO_Reg_Step__reg_step_submit_button__sbmt_btn_html', $sbmt_btn_html, $this),
-            'spco-' . $this->slug() . '-whats-next-buttons-dv',
+            'spco-'.$this->slug().'-whats-next-buttons-dv',
             'spco-whats-next-buttons'
         );
         return $html;

core/services/commands/registration/CreateRegistrationCommand.php

Indentation +157 added lines, -157 removed lines

@@ -13,7 +13,7 @@ 
 use EventEspresso\core\services\commands\CommandRequiresCapCheckInterface;
 
 if ( ! defined('EVENT_ESPRESSO_VERSION')) {
-    exit('No direct script access allowed');
+	exit('No direct script access allowed');
 }
 
 
@@ -29,162 +29,162 @@ 
 class CreateRegistrationCommand extends Command implements CommandRequiresCapCheckInterface
 {
 
-    /**
-     * @var EE_Transaction $transaction
-     */
-    private $transaction;
-
-    /**
-     * @var EE_Ticket $ticket
-     */
-    private $ticket;
-
-    /**
-     * @var EE_Line_Item $ticket_line_item
-     */
-    private $ticket_line_item;
-
-    /**
-     * @var int $reg_count
-     */
-    private $reg_count;
-
-    /**
-     * @var int $reg_group_size
-     */
-    private $reg_group_size;
-
-    /**
-     * @var string $reg_status
-     */
-    private $reg_status;
-
-    /**
-     * @var EE_Registration $registration
-     */
-    protected $registration;
-
-
-
-    /**
-     * CreateRegistrationCommand constructor.
-     *
-     * @param EE_Transaction $transaction
-     * @param EE_Line_Item   $ticket_line_item
-     * @param int             $reg_count
-     * @param int             $reg_group_size
-     * @param string          $reg_status
-     * @throws InvalidEntityException
-     */
-    public function __construct(
-        EE_Transaction $transaction,
-        EE_Line_Item $ticket_line_item,
-        $reg_count = 1,
-        $reg_group_size = 0,
-        $reg_status = EEM_Registration::status_id_incomplete
-    ) {
-        // grab the related ticket object for this line_item
-        $this->ticket = $ticket_line_item->ticket();
-        if ( ! $this->ticket instanceof EE_Ticket) {
-            throw new InvalidEntityException(
-                is_object($this->ticket) ? get_class($this->ticket) : gettype($this->ticket),
-                'EE_Ticket',
-                sprintf(
-                    __('Line item %s did not contain a valid ticket', 'event_espresso'),
-                    $ticket_line_item->ID()
-                )
-            );
-        }
-        $this->transaction = $transaction;
-        $this->ticket_line_item = $ticket_line_item;
-        $this->reg_count = absint($reg_count);
-        $this->reg_group_size = absint($reg_group_size);
-        $this->reg_status = $reg_status;
-    }
-
-
-
-    /**
-     * @return \EventEspresso\core\domain\services\capabilities\CapCheckInterface
-     * @throws \EventEspresso\core\exceptions\InvalidDataTypeException
-     */
-    public function getCapCheck()
-    {
-        if ( ! $this->cap_check instanceof CapCheckInterface) {
-            return new CapCheck('ee_edit_registrations', 'create_new_registration');
-        }
-        return $this->cap_check;
-    }
-
-
-
-    /**
-     * @return EE_Transaction
-     */
-    public function transaction()
-    {
-        return $this->transaction;
-    }
-
-
-
-    /**
-     * @return EE_Ticket
-     */
-    public function ticket()
-    {
-        return $this->ticket;
-    }
-
-
-
-    /**
-     * @return EE_Line_Item
-     */
-    public function ticketLineItem()
-    {
-        return $this->ticket_line_item;
-    }
-
-
-
-    /**
-     * @return int
-     */
-    public function regCount()
-    {
-        return $this->reg_count;
-    }
-
-
-
-    /**
-     * @return int
-     */
-    public function regGroupSize()
-    {
-        return $this->reg_group_size;
-    }
-
-
-
-    /**
-     * @return string
-     */
-    public function regStatus()
-    {
-        return $this->reg_status;
-    }
-
-
-
-    /**
-     * @return EE_Registration
-     */
-    public function registration()
-    {
-        return $this->registration;
-    }
+	/**
+	 * @var EE_Transaction $transaction
+	 */
+	private $transaction;
+
+	/**
+	 * @var EE_Ticket $ticket
+	 */
+	private $ticket;
+
+	/**
+	 * @var EE_Line_Item $ticket_line_item
+	 */
+	private $ticket_line_item;
+
+	/**
+	 * @var int $reg_count
+	 */
+	private $reg_count;
+
+	/**
+	 * @var int $reg_group_size
+	 */
+	private $reg_group_size;
+
+	/**
+	 * @var string $reg_status
+	 */
+	private $reg_status;
+
+	/**
+	 * @var EE_Registration $registration
+	 */
+	protected $registration;
+
+
+
+	/**
+	 * CreateRegistrationCommand constructor.
+	 *
+	 * @param EE_Transaction $transaction
+	 * @param EE_Line_Item   $ticket_line_item
+	 * @param int             $reg_count
+	 * @param int             $reg_group_size
+	 * @param string          $reg_status
+	 * @throws InvalidEntityException
+	 */
+	public function __construct(
+		EE_Transaction $transaction,
+		EE_Line_Item $ticket_line_item,
+		$reg_count = 1,
+		$reg_group_size = 0,
+		$reg_status = EEM_Registration::status_id_incomplete
+	) {
+		// grab the related ticket object for this line_item
+		$this->ticket = $ticket_line_item->ticket();
+		if ( ! $this->ticket instanceof EE_Ticket) {
+			throw new InvalidEntityException(
+				is_object($this->ticket) ? get_class($this->ticket) : gettype($this->ticket),
+				'EE_Ticket',
+				sprintf(
+					__('Line item %s did not contain a valid ticket', 'event_espresso'),
+					$ticket_line_item->ID()
+				)
+			);
+		}
+		$this->transaction = $transaction;
+		$this->ticket_line_item = $ticket_line_item;
+		$this->reg_count = absint($reg_count);
+		$this->reg_group_size = absint($reg_group_size);
+		$this->reg_status = $reg_status;
+	}
+
+
+
+	/**
+	 * @return \EventEspresso\core\domain\services\capabilities\CapCheckInterface
+	 * @throws \EventEspresso\core\exceptions\InvalidDataTypeException
+	 */
+	public function getCapCheck()
+	{
+		if ( ! $this->cap_check instanceof CapCheckInterface) {
+			return new CapCheck('ee_edit_registrations', 'create_new_registration');
+		}
+		return $this->cap_check;
+	}
+
+
+
+	/**
+	 * @return EE_Transaction
+	 */
+	public function transaction()
+	{
+		return $this->transaction;
+	}
+
+
+
+	/**
+	 * @return EE_Ticket
+	 */
+	public function ticket()
+	{
+		return $this->ticket;
+	}
+
+
+
+	/**
+	 * @return EE_Line_Item
+	 */
+	public function ticketLineItem()
+	{
+		return $this->ticket_line_item;
+	}
+
+
+
+	/**
+	 * @return int
+	 */
+	public function regCount()
+	{
+		return $this->reg_count;
+	}
+
+
+
+	/**
+	 * @return int
+	 */
+	public function regGroupSize()
+	{
+		return $this->reg_group_size;
+	}
+
+
+
+	/**
+	 * @return string
+	 */
+	public function regStatus()
+	{
+		return $this->reg_status;
+	}
+
+
+
+	/**
+	 * @return EE_Registration
+	 */
+	public function registration()
+	{
+		return $this->registration;
+	}
 
 
 

core/domain/entities/RegUrlLink.php

Indentation +96 added lines, -96 removed lines

@@ -7,7 +7,7 @@ 
 use InvalidArgumentException;
 
 if ( ! defined('EVENT_ESPRESSO_VERSION')) {
-    exit('No direct script access allowed');
+	exit('No direct script access allowed');
 }
 
 
@@ -23,103 +23,103 @@ 
 class RegUrlLink
 {
 
-    /*
+	/*
      * @var string $reg_url_link
      */
-    private $reg_url_link;
-
-
-
-    /**
-     * @param string $reg_url_link
-     * @return RegUrlLink
-     * @throws InvalidArgumentException
-     */
-    public static function fromRegUrlLinkString($reg_url_link)
-    {
-        if (empty($reg_url_link) || ! is_string($reg_url_link)) {
-            throw new InvalidArgumentException(
-                __(
-                    'You must supply a valid non-empty string to generate a reg_url_link.',
-                    'event_espresso'
-                )
-            );
-        }
-        return new RegUrlLink(1, '', $reg_url_link);
-    }
-
-
-
-    /**
-     * @param EE_Registration $registration
-     * @return RegUrlLink
-     * @throws EntityNotFoundException
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     */
-    public static function fromRegistration(EE_Registration $registration)
-    {
-        return new RegUrlLink(
-            $registration->count(),
-            $registration->ticket_line_item()
-        );
-    }
-
-
-
-    /**
-     * CreateRegUrlLinkCommand constructor.
-     *
-     * @param int    $reg_count
-     * @param mixed  $base_code
-     * @param string $reg_url_link
-     * @throws InvalidArgumentException
-     */
-    public function __construct(
-        $reg_count = 1,
-        $base_code = '',
-        $reg_url_link = ''
-    ) {
-        if ( ! empty($reg_url_link) && is_string($reg_url_link)) {
-            $this->reg_url_link = apply_filters(
-                'FHEE__\EventEspresso\core\domain\entities\RegUrlLink__construct__reg_url_link',
-                $reg_url_link,
-                $reg_count,
-                $base_code,
-                $reg_url_link
-            );
-            return;
-        }
-        $reg_count = max(1, absint($reg_count));
-        $base_code = $base_code instanceof \EE_Line_Item ? $base_code->code() : $base_code;
-        if (empty($base_code) || ! is_string($base_code)) {
-            throw new InvalidArgumentException(
-                __(
-                    'You must supply a valid EE_Line_Item or a non-empty string to generate a reg_url_link.',
-                    'event_espresso'
-                )
-            );
-        }
-        $this->reg_url_link = (string) apply_filters(
-            'FHEE__\EventEspresso\core\domain\entities\RegUrlLink__construct__reg_url_link',
-            $reg_count . '-' . md5($base_code . microtime()),
-            $reg_count,
-            $base_code,
-            $reg_url_link
-        );
-    }
-
-
-
-    /**
-     * Return the object as a string
-     *
-     * @return string
-     */
-    public function __toString()
-    {
-        return $this->reg_url_link;
-    }
+	private $reg_url_link;
+
+
+
+	/**
+	 * @param string $reg_url_link
+	 * @return RegUrlLink
+	 * @throws InvalidArgumentException
+	 */
+	public static function fromRegUrlLinkString($reg_url_link)
+	{
+		if (empty($reg_url_link) || ! is_string($reg_url_link)) {
+			throw new InvalidArgumentException(
+				__(
+					'You must supply a valid non-empty string to generate a reg_url_link.',
+					'event_espresso'
+				)
+			);
+		}
+		return new RegUrlLink(1, '', $reg_url_link);
+	}
+
+
+
+	/**
+	 * @param EE_Registration $registration
+	 * @return RegUrlLink
+	 * @throws EntityNotFoundException
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 */
+	public static function fromRegistration(EE_Registration $registration)
+	{
+		return new RegUrlLink(
+			$registration->count(),
+			$registration->ticket_line_item()
+		);
+	}
+
+
+
+	/**
+	 * CreateRegUrlLinkCommand constructor.
+	 *
+	 * @param int    $reg_count
+	 * @param mixed  $base_code
+	 * @param string $reg_url_link
+	 * @throws InvalidArgumentException
+	 */
+	public function __construct(
+		$reg_count = 1,
+		$base_code = '',
+		$reg_url_link = ''
+	) {
+		if ( ! empty($reg_url_link) && is_string($reg_url_link)) {
+			$this->reg_url_link = apply_filters(
+				'FHEE__\EventEspresso\core\domain\entities\RegUrlLink__construct__reg_url_link',
+				$reg_url_link,
+				$reg_count,
+				$base_code,
+				$reg_url_link
+			);
+			return;
+		}
+		$reg_count = max(1, absint($reg_count));
+		$base_code = $base_code instanceof \EE_Line_Item ? $base_code->code() : $base_code;
+		if (empty($base_code) || ! is_string($base_code)) {
+			throw new InvalidArgumentException(
+				__(
+					'You must supply a valid EE_Line_Item or a non-empty string to generate a reg_url_link.',
+					'event_espresso'
+				)
+			);
+		}
+		$this->reg_url_link = (string) apply_filters(
+			'FHEE__\EventEspresso\core\domain\entities\RegUrlLink__construct__reg_url_link',
+			$reg_count . '-' . md5($base_code . microtime()),
+			$reg_count,
+			$base_code,
+			$reg_url_link
+		);
+	}
+
+
+
+	/**
+	 * Return the object as a string
+	 *
+	 * @return string
+	 */
+	public function __toString()
+	{
+		return $this->reg_url_link;
+	}
 }
 // End of file RegUrlLink.php
 // Location: /RegUrlLink.php
\ No newline at end of file

Spacing +1 added lines, -1 removed lines

@@ -102,7 +102,7 @@
         }
         $this->reg_url_link = (string) apply_filters(
             'FHEE__\EventEspresso\core\domain\entities\RegUrlLink__construct__reg_url_link',
-            $reg_count . '-' . md5($base_code . microtime()),
+            $reg_count.'-'.md5($base_code.microtime()),
             $reg_count,
             $base_code,
             $reg_url_link

core/libraries/form_sections/base/EE_Form_Section_Base.form.php

Indentation +464 added lines, -464 removed lines

@@ -2,7 +2,7 @@ 
 use EventEspresso\core\libraries\form_sections\strategies\filter\FormHtmlFilter;
 
 if (! defined('EVENT_ESPRESSO_VERSION')) {
-    exit('No direct script access allowed');
+	exit('No direct script access allowed');
 }
 
 
@@ -19,480 +19,480 @@ 
 abstract class EE_Form_Section_Base
 {
 
-    /**
-     * the URL the form is submitted to
-     *
-     * @var string
-     */
-    protected $_action;
-
-    /**
-     * POST (default) or GET
-     *
-     * @var string
-     */
-    protected $_method;
-
-    /**
-     * html_id and html_name are derived from this by default
-     *
-     * @var string
-     */
-    protected $_name;
-
-    /**
-     * $_html_id
-     * @var string
-     */
-    protected $_html_id;
-
-    /**
-     * $_html_class
-     * @var string
-     */
-    protected $_html_class;
-
-    /**
-     * $_html_style
-     * @var string
-     */
-    protected $_html_style;
-
-    /**
-     * $_other_html_attributes
-     * @var string
-     */
-    protected $_other_html_attributes;
-
-    /**
-     * The form section of which this form section is a part
-     *
-     * @var EE_Form_Section_Proper
-     */
-    protected $_parent_section;
-
-    /**
-     * flag indicating that _construct_finalize has been called.
-     * If it hasn't been called and we try to use functions which require it, we call it
-     * with no parameters. But normally, _construct_finalize should be called by the instantiating class
-     *
-     * @var boolean
-     */
-    protected $_construction_finalized;
-
-    /**
-     * Strategy for parsing the form HTML upon display
-     *
-     * @var FormHtmlFilter
-     */
-    protected $_form_html_filter;
-
-
-
-    /**
-     * @param array $options_array {
-     * @type        $name          string the name for this form section, if you want to explicitly define it
-     *                             }
-     */
-    public function __construct($options_array = array())
-    {
-        // used by display strategies
-        // assign incoming values to properties
-        foreach ($options_array as $key => $value) {
-            $key = '_' . $key;
-            if (property_exists($this, $key) && empty($this->{$key})) {
-                $this->{$key} = $value;
-            }
-        }
-        // set parser which allows the form section's rendered HTML to be filtered
-        if (isset($options_array['form_html_filter']) && $options_array['form_html_filter'] instanceof FormHtmlFilter) {
-            $this->_form_html_filter = $options_array['form_html_filter'];
-        }
-    }
-
-
-
-    /**
-     * @param $parent_form_section
-     * @param $name
-     * @throws \EE_Error
-     */
-    protected function _construct_finalize($parent_form_section, $name)
-    {
-        $this->_construction_finalized = true;
-        $this->_parent_section = $parent_form_section;
-        if ($name !== null) {
-            $this->_name = $name;
-        }
-    }
-
-
-
-    /**
-     * make sure construction finalized was called, otherwise children might not be ready
-     *
-     * @return void
-     * @throws \EE_Error
-     */
-    public function ensure_construct_finalized_called()
-    {
-        if (! $this->_construction_finalized) {
-            $this->_construct_finalize($this->_parent_section, $this->_name);
-        }
-    }
-
-
-
-    /**
-     * @return string
-     */
-    public function action()
-    {
-        return $this->_action;
-    }
-
-
-
-    /**
-     * @param string $action
-     */
-    public function set_action($action)
-    {
-        $this->_action = $action;
-    }
-
-
-
-    /**
-     * @return string
-     */
-    public function method()
-    {
-        return ! empty($this->_method) ? $this->_method : 'POST';
-    }
-
-
-
-    /**
-     * @param string $method
-     */
-    public function set_method($method)
-    {
-        switch ($method) {
-            case 'get' :
-            case 'GET' :
-                $this->_method = 'GET';
-                break;
-            default :
-                $this->_method = 'POST';
-        }
-    }
-
-
-
-    /**
-     * Sets the html_id to its default value, if none was specified in the constructor.
-     * Calculation involves using the name and the parent's html id
-     * return void
-     *
-     * @throws \EE_Error
-     */
-    protected function _set_default_html_id_if_empty()
-    {
-        if (! $this->_html_id) {
-            if ($this->_parent_section && $this->_parent_section instanceof EE_Form_Section_Proper) {
-                $this->_html_id = $this->_parent_section->html_id()
-                                  . '-'
-                                  . $this->_prep_name_for_html_id($this->name());
-            } else {
-                $this->_html_id = $this->_prep_name_for_html_id($this->name());
-            }
-        }
-    }
-
-
-
-    /**
-     * _prep_name_for_html_id
-     *
-     * @param $name
-     * @return string
-     */
-    private function _prep_name_for_html_id($name)
-    {
-        return sanitize_key(str_replace(array(' ', ' ', '_'), '-', $name));
-    }
+	/**
+	 * the URL the form is submitted to
+	 *
+	 * @var string
+	 */
+	protected $_action;
+
+	/**
+	 * POST (default) or GET
+	 *
+	 * @var string
+	 */
+	protected $_method;
+
+	/**
+	 * html_id and html_name are derived from this by default
+	 *
+	 * @var string
+	 */
+	protected $_name;
+
+	/**
+	 * $_html_id
+	 * @var string
+	 */
+	protected $_html_id;
+
+	/**
+	 * $_html_class
+	 * @var string
+	 */
+	protected $_html_class;
+
+	/**
+	 * $_html_style
+	 * @var string
+	 */
+	protected $_html_style;
+
+	/**
+	 * $_other_html_attributes
+	 * @var string
+	 */
+	protected $_other_html_attributes;
+
+	/**
+	 * The form section of which this form section is a part
+	 *
+	 * @var EE_Form_Section_Proper
+	 */
+	protected $_parent_section;
+
+	/**
+	 * flag indicating that _construct_finalize has been called.
+	 * If it hasn't been called and we try to use functions which require it, we call it
+	 * with no parameters. But normally, _construct_finalize should be called by the instantiating class
+	 *
+	 * @var boolean
+	 */
+	protected $_construction_finalized;
+
+	/**
+	 * Strategy for parsing the form HTML upon display
+	 *
+	 * @var FormHtmlFilter
+	 */
+	protected $_form_html_filter;
+
+
+
+	/**
+	 * @param array $options_array {
+	 * @type        $name          string the name for this form section, if you want to explicitly define it
+	 *                             }
+	 */
+	public function __construct($options_array = array())
+	{
+		// used by display strategies
+		// assign incoming values to properties
+		foreach ($options_array as $key => $value) {
+			$key = '_' . $key;
+			if (property_exists($this, $key) && empty($this->{$key})) {
+				$this->{$key} = $value;
+			}
+		}
+		// set parser which allows the form section's rendered HTML to be filtered
+		if (isset($options_array['form_html_filter']) && $options_array['form_html_filter'] instanceof FormHtmlFilter) {
+			$this->_form_html_filter = $options_array['form_html_filter'];
+		}
+	}
+
+
+
+	/**
+	 * @param $parent_form_section
+	 * @param $name
+	 * @throws \EE_Error
+	 */
+	protected function _construct_finalize($parent_form_section, $name)
+	{
+		$this->_construction_finalized = true;
+		$this->_parent_section = $parent_form_section;
+		if ($name !== null) {
+			$this->_name = $name;
+		}
+	}
+
+
+
+	/**
+	 * make sure construction finalized was called, otherwise children might not be ready
+	 *
+	 * @return void
+	 * @throws \EE_Error
+	 */
+	public function ensure_construct_finalized_called()
+	{
+		if (! $this->_construction_finalized) {
+			$this->_construct_finalize($this->_parent_section, $this->_name);
+		}
+	}
+
+
+
+	/**
+	 * @return string
+	 */
+	public function action()
+	{
+		return $this->_action;
+	}
+
+
+
+	/**
+	 * @param string $action
+	 */
+	public function set_action($action)
+	{
+		$this->_action = $action;
+	}
+
+
+
+	/**
+	 * @return string
+	 */
+	public function method()
+	{
+		return ! empty($this->_method) ? $this->_method : 'POST';
+	}
+
+
+
+	/**
+	 * @param string $method
+	 */
+	public function set_method($method)
+	{
+		switch ($method) {
+			case 'get' :
+			case 'GET' :
+				$this->_method = 'GET';
+				break;
+			default :
+				$this->_method = 'POST';
+		}
+	}
+
+
+
+	/**
+	 * Sets the html_id to its default value, if none was specified in the constructor.
+	 * Calculation involves using the name and the parent's html id
+	 * return void
+	 *
+	 * @throws \EE_Error
+	 */
+	protected function _set_default_html_id_if_empty()
+	{
+		if (! $this->_html_id) {
+			if ($this->_parent_section && $this->_parent_section instanceof EE_Form_Section_Proper) {
+				$this->_html_id = $this->_parent_section->html_id()
+								  . '-'
+								  . $this->_prep_name_for_html_id($this->name());
+			} else {
+				$this->_html_id = $this->_prep_name_for_html_id($this->name());
+			}
+		}
+	}
+
+
+
+	/**
+	 * _prep_name_for_html_id
+	 *
+	 * @param $name
+	 * @return string
+	 */
+	private function _prep_name_for_html_id($name)
+	{
+		return sanitize_key(str_replace(array(' ', ' ', '_'), '-', $name));
+	}
 
 
 
-    /**
-     * Returns the HTML, JS, and CSS necessary to display this form section on a page.
-     * Note however, it's recommended that you instead call enqueue_js on the "wp_enqueue_scripts" action,
-     * and call get_html when you want to output the html. Calling get_html_and_js after
-     * "wp_enqueue_scripts" has already fired seems to work for now, but is contrary
-     * to the instructions on https://developer.wordpress.org/reference/functions/wp_enqueue_script/
-     * and so might stop working anytime.
-     *
-     * @return string
-     */
-    public function get_html_and_js()
-    {
-        return $this->get_html();
-    }
+	/**
+	 * Returns the HTML, JS, and CSS necessary to display this form section on a page.
+	 * Note however, it's recommended that you instead call enqueue_js on the "wp_enqueue_scripts" action,
+	 * and call get_html when you want to output the html. Calling get_html_and_js after
+	 * "wp_enqueue_scripts" has already fired seems to work for now, but is contrary
+	 * to the instructions on https://developer.wordpress.org/reference/functions/wp_enqueue_script/
+	 * and so might stop working anytime.
+	 *
+	 * @return string
+	 */
+	public function get_html_and_js()
+	{
+		return $this->get_html();
+	}
 
 
 
-    /**
-     * Gets the HTML for displaying this form section
-     *
-     * @return string
-     */
-    public abstract function get_html();
+	/**
+	 * Gets the HTML for displaying this form section
+	 *
+	 * @return string
+	 */
+	public abstract function get_html();
 
 
 
-    /**
-     * @param bool $add_pound_sign
-     * @return string
-     */
-    public function html_id($add_pound_sign = false)
-    {
-        $this->_set_default_html_id_if_empty();
-        return $add_pound_sign ? '#' . $this->_html_id : $this->_html_id;
-    }
+	/**
+	 * @param bool $add_pound_sign
+	 * @return string
+	 */
+	public function html_id($add_pound_sign = false)
+	{
+		$this->_set_default_html_id_if_empty();
+		return $add_pound_sign ? '#' . $this->_html_id : $this->_html_id;
+	}
 
 
-
-    /**
-     * @return string
-     */
-    public function html_class()
-    {
-        return $this->_html_class;
-    }
-
-
-
-    /**
-     * @return string
-     */
-    public function html_style()
-    {
-        return $this->_html_style;
-    }
-
-
-
-    /**
-     * @param mixed $html_class
-     */
-    public function set_html_class($html_class)
-    {
-        $this->_html_class = $html_class;
-    }
-
-
-
-    /**
-     * @param mixed $html_id
-     */
-    public function set_html_id($html_id)
-    {
-        $this->_html_id = $html_id;
-    }
-
-
-
-    /**
-     * @param mixed $html_style
-     */
-    public function set_html_style($html_style)
-    {
-        $this->_html_style = $html_style;
-    }
-
-
-
-    /**
-     * @param string $other_html_attributes
-     */
-    public function set_other_html_attributes($other_html_attributes)
-    {
-        $this->_other_html_attributes = $other_html_attributes;
-    }
-
-
-
-    /**
-     * @return string
-     */
-    public function other_html_attributes()
-    {
-        return $this->_other_html_attributes;
-    }
-
-
-
-    /**
-     * Gets the name of the form section. This is not the same as the HTML name.
-     *
-     * @throws EE_Error
-     * @return string
-     */
-    public function name()
-    {
-        if (! $this->_construction_finalized) {
-            throw new EE_Error(sprintf(__('You cannot use the form section\s name until _construct_finalize has been called on it (when we set the name). It was called on a form section of type \'s\'',
-                'event_espresso'), get_class($this)));
-        }
-        return $this->_name;
-    }
-
-
-
-    /**
-     * Gets the parent section
-     *
-     * @return EE_Form_Section_Proper
-     */
-    public function parent_section()
-    {
-        return $this->_parent_section;
-    }
-
-
-
-    /**
-     * returns HTML for generating the opening form HTML tag (<form>)
-     *
-     * @param string $action           the URL the form is submitted to
-     * @param string $method           POST (default) or GET
-     * @param string $other_attributes anything else added to the form open tag, MUST BE VALID HTML
-     * @return string
-     */
-    public function form_open($action = '', $method = '', $other_attributes = '')
-    {
-        if (! empty($action)) {
-            $this->set_action($action);
-        }
-        if (! empty($method)) {
-            $this->set_method($method);
-        }
-        $html = EEH_HTML::nl(1, 'form') . '<form';
-        $html .= $this->html_id() !== '' ? ' id="' . $this->get_html_id_for_form($this->html_id()) . '"' : '';
-        $html .= ' action="' . $this->action() . '"';
-        $html .= ' method="' . $this->method() . '"';
-        $html .= $other_attributes . '>';
-        return $html;
-    }
-
-
-
-    /**
-     * ensures that html id for form either ends in "-form" or "-frm"
-     * so that id doesn't conflict/collide with other elements
-     *
-     * @param string $html_id
-     * @return string
-     */
-    protected function get_html_id_for_form($html_id)
-    {
-        $strlen = strlen($html_id);
-        $html_id = strpos($html_id, '-form') === $strlen-5 || strpos($html_id, '-frm') === $strlen - 4
-            ? $html_id
-            : $html_id . '-frm';
-        return $html_id;
-    }
-
-
-
-    /**
-     * returns HTML for generating the closing form HTML tag (</form>)
-     *
-     * @return string
-     */
-    public function form_close()
-    {
-        return EEH_HTML::nl(-1, 'form')
-               . '</form>'
-               . EEH_HTML::nl()
-               . '<!-- end of ee-'
-               . $this->html_id()
-               . '-form -->'
-               . EEH_HTML::nl();
-    }
-
-
-
-    /**
-     * enqueues JS (and CSS) for the form (ie immediately call wp_enqueue_script and
-     * wp_enqueue_style; the scripts could have optionally been registered earlier)
-     * Default does nothing, but child classes can override
-     *
-     * @return void
-     */
-    public function enqueue_js()
-    {
-        //defaults to enqueue NO js or css
-    }
-
-
-
-    /**
-     * Adds any extra data needed by js. Eventually we'll call wp_localize_script
-     * with it, and it will be on each form section's 'other_data' property.
-     * By default nothing is added, but child classes can extend this method to add something.
-     * Eg, if you have an input that will cause a modal dialog to appear,
-     * here you could add an entry like 'modal_dialog_inputs' to this array
-     * to map between the input's html ID and the modal dialogue's ID, so that
-     * your JS code will know where to find the modal dialog when the input is pressed.
-     * Eg $form_other_js_data['modal_dialog_inputs']['some-input-id']='modal-dialog-id';
-     *
-     * @param array $form_other_js_data
-     * @return array
-     */
-    public function get_other_js_data($form_other_js_data = array())
-    {
-        return $form_other_js_data;
-    }
-
-
-
-    /**
-     * This isn't just the name of an input, it's a path pointing to an input. The
-     * path is similar to a folder path: slash (/) means to descend into a subsection,
-     * dot-dot-slash (../) means to ascend into the parent section.
-     * After a series of slashes and dot-dot-slashes, there should be the name of an input,
-     * which will be returned.
-     * Eg, if you want the related input to be conditional on a sibling input name 'foobar'
-     * just use 'foobar'. If you want it to be conditional on an aunt/uncle input name
-     * 'baz', use '../baz'. If you want it to be conditional on a cousin input,
-     * the child of 'baz_section' named 'baz_child', use '../baz_section/baz_child'.
-     * Etc
-     *
-     * @param string|false $form_section_path we accept false also because substr( '../', '../' ) = false
-     * @return EE_Form_Section_Base
-     */
-    public function find_section_from_path($form_section_path)
-    {
-        if (strpos($form_section_path, '/') === 0) {
-            $form_section_path = substr($form_section_path, strlen('/'));
-        }
-        if (empty($form_section_path)) {
-            return $this;
-        }
-        if (strpos($form_section_path, '../') === 0) {
-            $parent = $this->parent_section();
-            $form_section_path = substr($form_section_path, strlen('../'));
-            if ($parent instanceof EE_Form_Section_Base) {
-                return $parent->find_section_from_path($form_section_path);
-            } elseif (empty($form_section_path)) {
-                return $this;
-            }
-        }
-        //couldn't find it using simple parent following
-        return null;
-    }
+
+	/**
+	 * @return string
+	 */
+	public function html_class()
+	{
+		return $this->_html_class;
+	}
+
+
+
+	/**
+	 * @return string
+	 */
+	public function html_style()
+	{
+		return $this->_html_style;
+	}
+
+
+
+	/**
+	 * @param mixed $html_class
+	 */
+	public function set_html_class($html_class)
+	{
+		$this->_html_class = $html_class;
+	}
+
+
+
+	/**
+	 * @param mixed $html_id
+	 */
+	public function set_html_id($html_id)
+	{
+		$this->_html_id = $html_id;
+	}
+
+
+
+	/**
+	 * @param mixed $html_style
+	 */
+	public function set_html_style($html_style)
+	{
+		$this->_html_style = $html_style;
+	}
+
+
+
+	/**
+	 * @param string $other_html_attributes
+	 */
+	public function set_other_html_attributes($other_html_attributes)
+	{
+		$this->_other_html_attributes = $other_html_attributes;
+	}
+
+
+
+	/**
+	 * @return string
+	 */
+	public function other_html_attributes()
+	{
+		return $this->_other_html_attributes;
+	}
+
+
+
+	/**
+	 * Gets the name of the form section. This is not the same as the HTML name.
+	 *
+	 * @throws EE_Error
+	 * @return string
+	 */
+	public function name()
+	{
+		if (! $this->_construction_finalized) {
+			throw new EE_Error(sprintf(__('You cannot use the form section\s name until _construct_finalize has been called on it (when we set the name). It was called on a form section of type \'s\'',
+				'event_espresso'), get_class($this)));
+		}
+		return $this->_name;
+	}
+
+
+
+	/**
+	 * Gets the parent section
+	 *
+	 * @return EE_Form_Section_Proper
+	 */
+	public function parent_section()
+	{
+		return $this->_parent_section;
+	}
+
+
+
+	/**
+	 * returns HTML for generating the opening form HTML tag (<form>)
+	 *
+	 * @param string $action           the URL the form is submitted to
+	 * @param string $method           POST (default) or GET
+	 * @param string $other_attributes anything else added to the form open tag, MUST BE VALID HTML
+	 * @return string
+	 */
+	public function form_open($action = '', $method = '', $other_attributes = '')
+	{
+		if (! empty($action)) {
+			$this->set_action($action);
+		}
+		if (! empty($method)) {
+			$this->set_method($method);
+		}
+		$html = EEH_HTML::nl(1, 'form') . '<form';
+		$html .= $this->html_id() !== '' ? ' id="' . $this->get_html_id_for_form($this->html_id()) . '"' : '';
+		$html .= ' action="' . $this->action() . '"';
+		$html .= ' method="' . $this->method() . '"';
+		$html .= $other_attributes . '>';
+		return $html;
+	}
+
+
+
+	/**
+	 * ensures that html id for form either ends in "-form" or "-frm"
+	 * so that id doesn't conflict/collide with other elements
+	 *
+	 * @param string $html_id
+	 * @return string
+	 */
+	protected function get_html_id_for_form($html_id)
+	{
+		$strlen = strlen($html_id);
+		$html_id = strpos($html_id, '-form') === $strlen-5 || strpos($html_id, '-frm') === $strlen - 4
+			? $html_id
+			: $html_id . '-frm';
+		return $html_id;
+	}
+
+
+
+	/**
+	 * returns HTML for generating the closing form HTML tag (</form>)
+	 *
+	 * @return string
+	 */
+	public function form_close()
+	{
+		return EEH_HTML::nl(-1, 'form')
+			   . '</form>'
+			   . EEH_HTML::nl()
+			   . '<!-- end of ee-'
+			   . $this->html_id()
+			   . '-form -->'
+			   . EEH_HTML::nl();
+	}
+
+
+
+	/**
+	 * enqueues JS (and CSS) for the form (ie immediately call wp_enqueue_script and
+	 * wp_enqueue_style; the scripts could have optionally been registered earlier)
+	 * Default does nothing, but child classes can override
+	 *
+	 * @return void
+	 */
+	public function enqueue_js()
+	{
+		//defaults to enqueue NO js or css
+	}
+
+
+
+	/**
+	 * Adds any extra data needed by js. Eventually we'll call wp_localize_script
+	 * with it, and it will be on each form section's 'other_data' property.
+	 * By default nothing is added, but child classes can extend this method to add something.
+	 * Eg, if you have an input that will cause a modal dialog to appear,
+	 * here you could add an entry like 'modal_dialog_inputs' to this array
+	 * to map between the input's html ID and the modal dialogue's ID, so that
+	 * your JS code will know where to find the modal dialog when the input is pressed.
+	 * Eg $form_other_js_data['modal_dialog_inputs']['some-input-id']='modal-dialog-id';
+	 *
+	 * @param array $form_other_js_data
+	 * @return array
+	 */
+	public function get_other_js_data($form_other_js_data = array())
+	{
+		return $form_other_js_data;
+	}
+
+
+
+	/**
+	 * This isn't just the name of an input, it's a path pointing to an input. The
+	 * path is similar to a folder path: slash (/) means to descend into a subsection,
+	 * dot-dot-slash (../) means to ascend into the parent section.
+	 * After a series of slashes and dot-dot-slashes, there should be the name of an input,
+	 * which will be returned.
+	 * Eg, if you want the related input to be conditional on a sibling input name 'foobar'
+	 * just use 'foobar'. If you want it to be conditional on an aunt/uncle input name
+	 * 'baz', use '../baz'. If you want it to be conditional on a cousin input,
+	 * the child of 'baz_section' named 'baz_child', use '../baz_section/baz_child'.
+	 * Etc
+	 *
+	 * @param string|false $form_section_path we accept false also because substr( '../', '../' ) = false
+	 * @return EE_Form_Section_Base
+	 */
+	public function find_section_from_path($form_section_path)
+	{
+		if (strpos($form_section_path, '/') === 0) {
+			$form_section_path = substr($form_section_path, strlen('/'));
+		}
+		if (empty($form_section_path)) {
+			return $this;
+		}
+		if (strpos($form_section_path, '../') === 0) {
+			$parent = $this->parent_section();
+			$form_section_path = substr($form_section_path, strlen('../'));
+			if ($parent instanceof EE_Form_Section_Base) {
+				return $parent->find_section_from_path($form_section_path);
+			} elseif (empty($form_section_path)) {
+				return $this;
+			}
+		}
+		//couldn't find it using simple parent following
+		return null;
+	}
 
 
 }

Spacing +15 added lines, -15 removed lines

@@ -1,7 +1,7 @@ 
 <?php
 use EventEspresso\core\libraries\form_sections\strategies\filter\FormHtmlFilter;
 
-if (! defined('EVENT_ESPRESSO_VERSION')) {
+if ( ! defined('EVENT_ESPRESSO_VERSION')) {
     exit('No direct script access allowed');
 }
 
@@ -99,7 +99,7 @@ 
         // used by display strategies
         // assign incoming values to properties
         foreach ($options_array as $key => $value) {
-            $key = '_' . $key;
+            $key = '_'.$key;
             if (property_exists($this, $key) && empty($this->{$key})) {
                 $this->{$key} = $value;
             }
@@ -136,7 +136,7 @@ 
      */
     public function ensure_construct_finalized_called()
     {
-        if (! $this->_construction_finalized) {
+        if ( ! $this->_construction_finalized) {
             $this->_construct_finalize($this->_parent_section, $this->_name);
         }
     }
@@ -199,7 +199,7 @@ 
      */
     protected function _set_default_html_id_if_empty()
     {
-        if (! $this->_html_id) {
+        if ( ! $this->_html_id) {
             if ($this->_parent_section && $this->_parent_section instanceof EE_Form_Section_Proper) {
                 $this->_html_id = $this->_parent_section->html_id()
                                   . '-'
@@ -258,7 +258,7 @@ 
     public function html_id($add_pound_sign = false)
     {
         $this->_set_default_html_id_if_empty();
-        return $add_pound_sign ? '#' . $this->_html_id : $this->_html_id;
+        return $add_pound_sign ? '#'.$this->_html_id : $this->_html_id;
     }
 
 
@@ -341,7 +341,7 @@ 
      */
     public function name()
     {
-        if (! $this->_construction_finalized) {
+        if ( ! $this->_construction_finalized) {
             throw new EE_Error(sprintf(__('You cannot use the form section\s name until _construct_finalize has been called on it (when we set the name). It was called on a form section of type \'s\'',
                 'event_espresso'), get_class($this)));
         }
@@ -372,17 +372,17 @@ 
      */
     public function form_open($action = '', $method = '', $other_attributes = '')
     {
-        if (! empty($action)) {
+        if ( ! empty($action)) {
             $this->set_action($action);
         }
-        if (! empty($method)) {
+        if ( ! empty($method)) {
             $this->set_method($method);
         }
-        $html = EEH_HTML::nl(1, 'form') . '<form';
-        $html .= $this->html_id() !== '' ? ' id="' . $this->get_html_id_for_form($this->html_id()) . '"' : '';
-        $html .= ' action="' . $this->action() . '"';
-        $html .= ' method="' . $this->method() . '"';
-        $html .= $other_attributes . '>';
+        $html = EEH_HTML::nl(1, 'form').'<form';
+        $html .= $this->html_id() !== '' ? ' id="'.$this->get_html_id_for_form($this->html_id()).'"' : '';
+        $html .= ' action="'.$this->action().'"';
+        $html .= ' method="'.$this->method().'"';
+        $html .= $other_attributes.'>';
         return $html;
     }
 
@@ -398,9 +398,9 @@ 
     protected function get_html_id_for_form($html_id)
     {
         $strlen = strlen($html_id);
-        $html_id = strpos($html_id, '-form') === $strlen-5 || strpos($html_id, '-frm') === $strlen - 4
+        $html_id = strpos($html_id, '-form') === $strlen - 5 || strpos($html_id, '-frm') === $strlen - 4
             ? $html_id
-            : $html_id . '-frm';
+            : $html_id.'-frm';
         return $html_id;
     }
 

core/services/commands/CommandBus.php

Indentation +73 added lines, -73 removed lines

@@ -7,7 +7,7 @@ 
 use EventEspresso\core\services\commands\middleware\InvalidCommandBusMiddlewareException;
 
 if (! defined('EVENT_ESPRESSO_VERSION')) {
-    exit('No direct script access allowed');
+	exit('No direct script access allowed');
 }
 
 
@@ -40,78 +40,78 @@ 
 class CommandBus implements CommandBusInterface
 {
 
-    /**
-     * @type CommandHandlerManagerInterface $command_handler_manager
-     */
-    private $command_handler_manager;
-
-    /**
-     * @type CommandBusMiddlewareInterface[] $command_bus_middleware
-     */
-    private $command_bus_middleware;
-
-
-
-    /**
-     * CommandBus constructor
-     *
-     * @param CommandHandlerManagerInterface  $command_handler_manager
-     * @param CommandBusMiddlewareInterface[] $command_bus_middleware
-     */
-    public function __construct(
-        CommandHandlerManagerInterface $command_handler_manager,
-        array $command_bus_middleware = array()
-    ) {
-        $this->command_handler_manager = $command_handler_manager;
-        $this->command_bus_middleware = is_array($command_bus_middleware)
-            ? $command_bus_middleware
-            : array($command_bus_middleware);
-    }
-
-
-
-    /**
-     * @return CommandHandlerManagerInterface
-     */
-    public function getCommandHandlerManager()
-    {
-        return $this->command_handler_manager;
-    }
-
-
-
-    /**
-     * @param CommandInterface $command
-     * @return mixed
-     * @throws InvalidDataTypeException
-     * @throws InvalidCommandBusMiddlewareException
-     */
-    public function execute($command)
-    {
-        if (! $command instanceof CommandInterface) {
-            throw new InvalidDataTypeException(__METHOD__ . '( $command )', $command, 'CommandInterface');
-        }
-        // we're going to add the Command Handler as a callable
-        // that will get run at the end of our middleware stack
-        // can't pass $this to a Closure, so use a named variable
-        $command_bus = $this;
-        $middleware = function ($command) use ($command_bus) {
-            return $command_bus->getCommandHandlerManager()
-                ->getCommandHandler($command, $command_bus)
-                ->handle($command);
-        };
-        // now build the rest of the middleware stack
-        while ($command_bus_middleware = array_pop($this->command_bus_middleware)) {
-            if (! $command_bus_middleware instanceof CommandBusMiddlewareInterface) {
-                throw new InvalidCommandBusMiddlewareException($command_bus_middleware);
-            }
-            $middleware = function ($command) use ($command_bus_middleware, $middleware) {
-                return $command_bus_middleware->handle($command, $middleware);
-            };
-        }
-        // and finally, pass the command into the stack and return the results
-        return $middleware($command);
-    }
+	/**
+	 * @type CommandHandlerManagerInterface $command_handler_manager
+	 */
+	private $command_handler_manager;
+
+	/**
+	 * @type CommandBusMiddlewareInterface[] $command_bus_middleware
+	 */
+	private $command_bus_middleware;
+
+
+
+	/**
+	 * CommandBus constructor
+	 *
+	 * @param CommandHandlerManagerInterface  $command_handler_manager
+	 * @param CommandBusMiddlewareInterface[] $command_bus_middleware
+	 */
+	public function __construct(
+		CommandHandlerManagerInterface $command_handler_manager,
+		array $command_bus_middleware = array()
+	) {
+		$this->command_handler_manager = $command_handler_manager;
+		$this->command_bus_middleware = is_array($command_bus_middleware)
+			? $command_bus_middleware
+			: array($command_bus_middleware);
+	}
+
+
+
+	/**
+	 * @return CommandHandlerManagerInterface
+	 */
+	public function getCommandHandlerManager()
+	{
+		return $this->command_handler_manager;
+	}
+
+
+
+	/**
+	 * @param CommandInterface $command
+	 * @return mixed
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidCommandBusMiddlewareException
+	 */
+	public function execute($command)
+	{
+		if (! $command instanceof CommandInterface) {
+			throw new InvalidDataTypeException(__METHOD__ . '( $command )', $command, 'CommandInterface');
+		}
+		// we're going to add the Command Handler as a callable
+		// that will get run at the end of our middleware stack
+		// can't pass $this to a Closure, so use a named variable
+		$command_bus = $this;
+		$middleware = function ($command) use ($command_bus) {
+			return $command_bus->getCommandHandlerManager()
+				->getCommandHandler($command, $command_bus)
+				->handle($command);
+		};
+		// now build the rest of the middleware stack
+		while ($command_bus_middleware = array_pop($this->command_bus_middleware)) {
+			if (! $command_bus_middleware instanceof CommandBusMiddlewareInterface) {
+				throw new InvalidCommandBusMiddlewareException($command_bus_middleware);
+			}
+			$middleware = function ($command) use ($command_bus_middleware, $middleware) {
+				return $command_bus_middleware->handle($command, $middleware);
+			};
+		}
+		// and finally, pass the command into the stack and return the results
+		return $middleware($command);
+	}
 
 
 }

core/services/notices/NoticesContainer.php

Indentation +105 added lines, -105 removed lines

@@ -18,151 +18,151 @@
 {
 
 
-    /**
-     * @var NoticeInterface[] $attention
-     */
-    private $attention = array();
+	/**
+	 * @var NoticeInterface[] $attention
+	 */
+	private $attention = array();
 
 
-    /**
-     * @var NoticeInterface[] $error
-     */
-    private $error = array();
+	/**
+	 * @var NoticeInterface[] $error
+	 */
+	private $error = array();
 
 
-    /**
-     * @var NoticeInterface[] $success
-     */
-    private $success = array();
+	/**
+	 * @var NoticeInterface[] $success
+	 */
+	private $success = array();
 
 
 
-    /**
-     * @param string $notice
-     * @param string $file
-     * @param string $func
-     * @param string $line
-     */
-    public function addAttention($notice, $file = '', $func = '', $line = '')
-    {
-        $this->attention[] = new Notice(Notice::ATTENTION, $notice, $file, $func, $line);
-    }
+	/**
+	 * @param string $notice
+	 * @param string $file
+	 * @param string $func
+	 * @param string $line
+	 */
+	public function addAttention($notice, $file = '', $func = '', $line = '')
+	{
+		$this->attention[] = new Notice(Notice::ATTENTION, $notice, $file, $func, $line);
+	}
 
 
 
-    /**
-     * @param string $notice
-     * @param string $file
-     * @param string $func
-     * @param string $line
-     */
-    public function addError($notice, $file, $func, $line)
-    {
-        $this->error[] = new Notice(Notice::ERROR, $notice, $file, $func, $line);
-    }
+	/**
+	 * @param string $notice
+	 * @param string $file
+	 * @param string $func
+	 * @param string $line
+	 */
+	public function addError($notice, $file, $func, $line)
+	{
+		$this->error[] = new Notice(Notice::ERROR, $notice, $file, $func, $line);
+	}
 
 
 
-    /**
-     * @param string $notice
-     * @param string $file
-     * @param string $func
-     * @param string $line
-     */
-    public function addSuccess($notice, $file = '', $func = '', $line = '')
-    {
-        $this->success[] = new Notice(Notice::SUCCESS, $notice, $file, $func, $line);
-    }
+	/**
+	 * @param string $notice
+	 * @param string $file
+	 * @param string $func
+	 * @param string $line
+	 */
+	public function addSuccess($notice, $file = '', $func = '', $line = '')
+	{
+		$this->success[] = new Notice(Notice::SUCCESS, $notice, $file, $func, $line);
+	}
 
 
 
-    /**
-     * @return boolean
-     */
-    public function hasAttention()
-    {
-        return ! empty($this->attention);
-    }
+	/**
+	 * @return boolean
+	 */
+	public function hasAttention()
+	{
+		return ! empty($this->attention);
+	}
 
 
 
-    /**
-     * @return boolean
-     */
-    public function hasError()
-    {
-        return ! empty($this->error);
-    }
+	/**
+	 * @return boolean
+	 */
+	public function hasError()
+	{
+		return ! empty($this->error);
+	}
 
 
 
-    /**
-     * @return boolean
-     */
-    public function hasSuccess()
-    {
-        return ! empty($this->success);
-    }
+	/**
+	 * @return boolean
+	 */
+	public function hasSuccess()
+	{
+		return ! empty($this->success);
+	}
 
 
 
-    /**
-     * @return int
-     */
-    public function countAttention()
-    {
-        return count($this->attention);
-    }
+	/**
+	 * @return int
+	 */
+	public function countAttention()
+	{
+		return count($this->attention);
+	}
 
 
 
-    /**
-     * @return int
-     */
-    public function countError()
-    {
-        return count($this->error);
-    }
+	/**
+	 * @return int
+	 */
+	public function countError()
+	{
+		return count($this->error);
+	}
 
 
 
-    /**
-     * @return int
-     */
-    public function countSuccess()
-    {
-        return count($this->success);
-    }
+	/**
+	 * @return int
+	 */
+	public function countSuccess()
+	{
+		return count($this->success);
+	}
 
 
 
-    /**
-     * @return NoticeInterface[]
-     */
-    public function getAttention()
-    {
-        return $this->attention;
-    }
+	/**
+	 * @return NoticeInterface[]
+	 */
+	public function getAttention()
+	{
+		return $this->attention;
+	}
 
 
 
-    /**
-     * @return NoticeInterface[]
-     */
-    public function getError()
-    {
-        return $this->error;
-    }
+	/**
+	 * @return NoticeInterface[]
+	 */
+	public function getError()
+	{
+		return $this->error;
+	}
 
 
 
-    /**
-     * @return NoticeInterface[]
-     */
-    public function getSuccess()
-    {
-        return $this->success;
-    }
+	/**
+	 * @return NoticeInterface[]
+	 */
+	public function getSuccess()
+	{
+		return $this->success;
+	}
 
 
 }

core/services/notices/Notice.php

Indentation +75 added lines, -75 removed lines

@@ -17,108 +17,108 @@
 class Notice implements NoticeInterface
 {
 
-    const ERROR = 'error';
-    const ATTENTION = 'attention';
-    const SUCCESS = 'success';
+	const ERROR = 'error';
+	const ATTENTION = 'attention';
+	const SUCCESS = 'success';
 
-    /**
-     * @var string $type
-     */
-    private $type;
+	/**
+	 * @var string $type
+	 */
+	private $type;
 
 
-    /**
-     * @var string $message
-     */
-    private $message;
+	/**
+	 * @var string $message
+	 */
+	private $message;
 
 
-    /**
-     * @var string $file
-     */
-    private $file;
+	/**
+	 * @var string $file
+	 */
+	private $file;
 
 
-    /**
-     * @var string $func
-     */
-    private $func;
+	/**
+	 * @var string $func
+	 */
+	private $func;
 
 
-    /**
-     * @var string $line
-     */
-    private $line;
+	/**
+	 * @var string $line
+	 */
+	private $line;
 
 
 
-    /**
-     * Notice constructor.
-     *
-     * @param string $type
-     * @param string $message
-     * @param string $file
-     * @param string $func
-     * @param string $line
-     */
-    public function __construct($type, $message, $file, $func, $line)
-    {
-        $this->type = $type;
-        $this->message = $message;
-        $this->file = $file;
-        $this->func = $func;
-        $this->line = $line;
-    }
+	/**
+	 * Notice constructor.
+	 *
+	 * @param string $type
+	 * @param string $message
+	 * @param string $file
+	 * @param string $func
+	 * @param string $line
+	 */
+	public function __construct($type, $message, $file, $func, $line)
+	{
+		$this->type = $type;
+		$this->message = $message;
+		$this->file = $file;
+		$this->func = $func;
+		$this->line = $line;
+	}
 
 
 
-    /**
-     * @return string
-     */
-    public function type()
-    {
-        return $this->type;
-    }
+	/**
+	 * @return string
+	 */
+	public function type()
+	{
+		return $this->type;
+	}
 
 
 
-    /**
-     * @return string
-     */
-    public function message()
-    {
-        return $this->message;
-    }
+	/**
+	 * @return string
+	 */
+	public function message()
+	{
+		return $this->message;
+	}
 
 
 
-    /**
-     * @return string
-     */
-    public function file()
-    {
-        return $this->file;
-    }
+	/**
+	 * @return string
+	 */
+	public function file()
+	{
+		return $this->file;
+	}
 
 
 
-    /**
-     * @return string
-     */
-    public function func()
-    {
-        return $this->func;
-    }
+	/**
+	 * @return string
+	 */
+	public function func()
+	{
+		return $this->func;
+	}
 
 
 
-    /**
-     * @return string
-     */
-    public function line()
-    {
-        return $this->line;
-    }
+	/**
+	 * @return string
+	 */
+	public function line()
+	{
+		return $this->line;
+	}
 
 
 

core/services/notices/NoticesContainerInterface.php

Indentation +57 added lines, -57 removed lines

@@ -16,94 +16,94 @@
 interface NoticesContainerInterface
 {
 
-    /**
-     * @param string $notice
-     * @param string $file
-     * @param string $func
-     * @param string $line
-     */
-    public function addAttention($notice, $file = '', $func = '', $line = '');
+	/**
+	 * @param string $notice
+	 * @param string $file
+	 * @param string $func
+	 * @param string $line
+	 */
+	public function addAttention($notice, $file = '', $func = '', $line = '');
 
 
 
-    /**
-     * @param string $notice
-     * @param string $file
-     * @param string $func
-     * @param string $line
-     */
-    public function addError($notice, $file, $func, $line);
+	/**
+	 * @param string $notice
+	 * @param string $file
+	 * @param string $func
+	 * @param string $line
+	 */
+	public function addError($notice, $file, $func, $line);
 
 
 
-    /**
-     * @param string $notice
-     * @param string $file
-     * @param string $func
-     * @param string $line
-     */
-    public function addSuccess($notice, $file = '', $func = '', $line = '');
+	/**
+	 * @param string $notice
+	 * @param string $file
+	 * @param string $func
+	 * @param string $line
+	 */
+	public function addSuccess($notice, $file = '', $func = '', $line = '');
 
 
 
-    /**
-     * @return boolean
-     */
-    public function hasAttention();
+	/**
+	 * @return boolean
+	 */
+	public function hasAttention();
 
 
 
-    /**
-     * @return boolean
-     */
-    public function hasError();
+	/**
+	 * @return boolean
+	 */
+	public function hasError();
 
 
 
-    /**
-     * @return boolean
-     */
-    public function hasSuccess();
+	/**
+	 * @return boolean
+	 */
+	public function hasSuccess();
 
 
 
-    /**
-     * @return int
-     */
-    public function countAttention();
+	/**
+	 * @return int
+	 */
+	public function countAttention();
 
 
 
-    /**
-     * @return int
-     */
-    public function countError();
+	/**
+	 * @return int
+	 */
+	public function countError();
 
 
 
-    /**
-     * @return int
-     */
-    public function countSuccess();
+	/**
+	 * @return int
+	 */
+	public function countSuccess();
 
 
 
-    /**
-     * @return NoticeInterface[]
-     */
-    public function getAttention();
+	/**
+	 * @return NoticeInterface[]
+	 */
+	public function getAttention();
 
 
 
-    /**
-     * @return NoticeInterface[]
-     */
-    public function getError();
+	/**
+	 * @return NoticeInterface[]
+	 */
+	public function getError();
 
 
 
-    /**
-     * @return NoticeInterface[]
-     */
-    public function getSuccess();
+	/**
+	 * @return NoticeInterface[]
+	 */
+	public function getSuccess();
 }
\ No newline at end of file