eventespresso / event-espresso-core

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 has not 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 has not 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;
+	}
 
 
 }

core/EE_Capabilities.core.php

Indentation +1388 added lines, -1388 removed lines

@@ -18,1000 +18,1000 @@ 
 final class EE_Capabilities extends EE_Base
 {
 
-    /**
-     * the name of the wp option used to store caps previously initialized
-     */
-    const option_name = 'ee_caps_initialized';
-
-    /**
-     * instance of EE_Capabilities object
-     *
-     * @var EE_Capabilities
-     */
-    private static $_instance;
-
-
-    /**
-     * This is a map of caps that correspond to a default WP_Role.
-     * Array is indexed by Role and values are ee capabilities.
-     *
-     * @since 4.5.0
-     *
-     * @var array
-     */
-    private $capabilities_map = array();
-
-    /**
-     * This used to hold an array of EE_Meta_Capability_Map objects
-     * that define the granular capabilities mapped to for a user depending on context.
-     *
-     * @var EE_Meta_Capability_Map[]
-     */
-    private $_meta_caps = array();
-
-    /**
-     * The internal $capabilities_map needs to be initialized before it can be used.
-     * This flag tracks whether that has happened or not.
-     * But for this to work, we need three states to indicate:
-     *      initialization has not occurred at all
-     *      initialization has started but is not complete
-     *      initialization is complete
-     * The reason this is needed is because the addCaps() method
-     * normally requires the $capabilities_map to be initialized,
-     * but is also used during the initialization process.
-     * So:
-     *      If initialized === null, init_caps() will be called before any other methods will run.
-     *      If initialized === false, then init_caps() is in the process of running it's logic.
-     *      If initialized === true, then init_caps() has completed the initialization process.
-     *
-     * @var boolean|null $initialized
-     */
-    private $initialized;
-
-    /**
-     * @var boolean $reset
-     */
-    private $reset = false;
-
-
-
-    /**
-     * singleton method used to instantiate class object
-     *
-     * @since 4.5.0
-     *
-     * @return EE_Capabilities
-     */
-    public static function instance()
-    {
-        //check if instantiated, and if not do so.
-        if (! self::$_instance instanceof EE_Capabilities) {
-            self::$_instance = new self();
-        }
-        return self::$_instance;
-    }
-
-
-
-    /**
-     * private constructor
-     *
-     * @since 4.5.0
-     */
-    private function __construct()
-    {
-    }
-
-
-
-    /**
-     * This delays the initialization of the capabilities class until EE_System core is loaded and ready.
-     *
-     * @param bool $reset allows for resetting the default capabilities saved on roles.  Note that this doesn't
-     *                    actually REMOVE any capabilities from existing roles, it just resaves defaults roles and
-     *                    ensures that they are up to date.
-     *
-     * @since 4.5.0
-     * @return bool
-     * @throws EE_Error
-     */
-    public function init_caps($reset = false)
-    {
-        if(! EE_Maintenance_Mode::instance()->models_can_query()){
-            return false;
-        }
-        $this->reset = filter_var($reset, FILTER_VALIDATE_BOOLEAN);
-        // if reset, then completely delete the cache option and clear the $capabilities_map property.
-        if ($this->reset) {
-            $this->initialized = null;
-            $this->capabilities_map = array();
-            delete_option(self::option_name);
-        }
-        if ($this->initialized === null) {
-            $this->initialized = false;
-            do_action(
-                'AHEE__EE_Capabilities__init_caps__before_initialization',
-                $this->reset
-            );
-            $this->addCaps($this->_init_caps_map());
-            $this->_set_meta_caps();
-            do_action(
-                'AHEE__EE_Capabilities__init_caps__after_initialization',
-                $this->capabilities_map
-            );
-            $this->initialized = true;
-        }
-        // reset $this->reset so that it's not stuck on true if init_caps() gets called again
-        $this->reset = false;
-        return true;
-    }
-
-
-
-
-    /**
-     * This sets the meta caps property.
-     *
-     * @since 4.5.0
-     * @return void
-     * @throws EE_Error
-     */
-    private function _set_meta_caps()
-    {
-        // get default meta caps and filter the returned array
-        $this->_meta_caps = apply_filters(
-            'FHEE__EE_Capabilities___set_meta_caps__meta_caps',
-            $this->_get_default_meta_caps_array()
-        );
-        //add filter for map_meta_caps but only if models can query.
-        if (! has_filter('map_meta_cap', array($this, 'map_meta_caps'))) {
-            add_filter('map_meta_cap', array($this, 'map_meta_caps'), 10, 4);
-        }
-    }
-
-
-
-    /**
-     * This builds and returns the default meta_caps array only once.
-     *
-     * @since  4.8.28.rc.012
-     * @return array
-     * @throws EE_Error
-     */
-    private function _get_default_meta_caps_array()
-    {
-        static $default_meta_caps = array();
-        // make sure we're only ever initializing the default _meta_caps array once if it's empty.
-        if (empty($default_meta_caps)) {
-            $default_meta_caps = array(
-                //edits
-                new EE_Meta_Capability_Map_Edit(
-                    'ee_edit_event',
-                    array('Event', 'ee_edit_published_events', 'ee_edit_others_events', 'ee_edit_private_events')
-                ),
-                new EE_Meta_Capability_Map_Edit(
-                    'ee_edit_venue',
-                    array('Venue', 'ee_edit_published_venues', 'ee_edit_others_venues', 'ee_edit_private_venues')
-                ),
-                new EE_Meta_Capability_Map_Edit(
-                    'ee_edit_registration',
-                    array('Registration', '', 'ee_edit_others_registrations', '')
-                ),
-                new EE_Meta_Capability_Map_Edit(
-                    'ee_edit_checkin',
-                    array('Registration', '', 'ee_edit_others_checkins', '')
-                ),
-                new EE_Meta_Capability_Map_Messages_Cap(
-                    'ee_edit_message',
-                    array('Message_Template_Group', '', 'ee_edit_others_messages', 'ee_edit_global_messages')
-                ),
-                new EE_Meta_Capability_Map_Edit(
-                    'ee_edit_default_ticket',
-                    array('Ticket', '', 'ee_edit_others_default_tickets', '')
-                ),
-                new EE_Meta_Capability_Map_Registration_Form_Cap(
-                    'ee_edit_question',
-                    array('Question', '', '', 'ee_edit_system_questions')
-                ),
-                new EE_Meta_Capability_Map_Registration_Form_Cap(
-                    'ee_edit_question_group',
-                    array('Question_Group', '', '', 'ee_edit_system_question_groups')
-                ),
-                new EE_Meta_Capability_Map_Edit(
-                    'ee_edit_payment_method',
-                    array('Payment_Method', '', 'ee_edit_others_payment_methods', '')
-                ),
-                //reads
-                new EE_Meta_Capability_Map_Read(
-                    'ee_read_event',
-                    array('Event', '', 'ee_read_others_events', 'ee_read_private_events')
-                ),
-                new EE_Meta_Capability_Map_Read(
-                    'ee_read_venue',
-                    array('Venue', '', 'ee_read_others_venues', 'ee_read_private_venues')
-                ),
-                new EE_Meta_Capability_Map_Read(
-                    'ee_read_registration',
-                    array('Registration', '', 'ee_read_others_registrations', '')
-                ),
-                new EE_Meta_Capability_Map_Read(
-                    'ee_read_checkin',
-                    array('Registration', '', 'ee_read_others_checkins', '')
-                ),
-                new EE_Meta_Capability_Map_Messages_Cap(
-                    'ee_read_message',
-                    array('Message_Template_Group', '', 'ee_read_others_messages', 'ee_read_global_messages')
-                ),
-                new EE_Meta_Capability_Map_Read(
-                    'ee_read_default_ticket',
-                    array('Ticket', '', 'ee_read_others_default_tickets', '')
-                ),
-                new EE_Meta_Capability_Map_Read(
-                    'ee_read_payment_method',
-                    array('Payment_Method', '', 'ee_read_others_payment_methods', '')
-                ),
-                //deletes
-                new EE_Meta_Capability_Map_Delete(
-                    'ee_delete_event',
-                    array(
-                        'Event',
-                        'ee_delete_published_events',
-                        'ee_delete_others_events',
-                        'ee_delete_private_events',
-                    )
-                ),
-                new EE_Meta_Capability_Map_Delete(
-                    'ee_delete_venue',
-                    array(
-                        'Venue',
-                        'ee_delete_published_venues',
-                        'ee_delete_others_venues',
-                        'ee_delete_private_venues',
-                    )
-                ),
-                new EE_Meta_Capability_Map_Delete(
-                    'ee_delete_registration',
-                    array('Registration', '', 'ee_delete_others_registrations', '')
-                ),
-                new EE_Meta_Capability_Map_Delete(
-                    'ee_delete_checkin',
-                    array('Registration', '', 'ee_delete_others_checkins', '')
-                ),
-                new EE_Meta_Capability_Map_Messages_Cap(
-                    'ee_delete_message',
-                    array('Message_Template_Group', '', 'ee_delete_others_messages', 'ee_delete_global_messages')
-                ),
-                new EE_Meta_Capability_Map_Delete(
-                    'ee_delete_default_ticket',
-                    array('Ticket', '', 'ee_delete_others_default_tickets', '')
-                ),
-                new EE_Meta_Capability_Map_Registration_Form_Cap(
-                    'ee_delete_question',
-                    array('Question', '', '', 'delete_system_questions')
-                ),
-                new EE_Meta_Capability_Map_Registration_Form_Cap(
-                    'ee_delete_question_group',
-                    array('Question_Group', '', '', 'delete_system_question_groups')
-                ),
-                new EE_Meta_Capability_Map_Delete(
-                    'ee_delete_payment_method',
-                    array('Payment_Method', '', 'ee_delete_others_payment_methods', '')
-                ),
-            );
-        }
-        return $default_meta_caps;
-    }
-
-
-
-    /**
-     * This is the callback for the wp map_meta_caps() function which allows for ensuring certain caps that act as a
-     * "meta" for other caps ( i.e. ee_edit_event is a meta for ee_edit_others_events ) work as expected.
-     *
-     * The actual logic is carried out by implementer classes in their definition of _map_meta_caps.
-     *
-     * @since 4.5.0
-     * @see   wp-includes/capabilities.php
-     *
-     * @param array  $caps    actual users capabilities
-     * @param string $cap     initial capability name that is being checked (the "map" key)
-     * @param int    $user_id The user id
-     * @param array  $args    Adds context to the cap. Typically the object ID.
-     * @return array actual users capabilities
-     * @throws EE_Error
-     */
-    public function map_meta_caps($caps, $cap, $user_id, $args)
-    {
-        if (did_action('AHEE__EE_System__load_espresso_addons__complete')) {
-            //loop through our _meta_caps array
-            foreach ($this->_meta_caps as $meta_map) {
-                if (! $meta_map instanceof EE_Meta_Capability_Map) {
-                    continue;
-                }
-                // don't load models if there is no object ID in the args
-                if (! empty($args[0])) {
-                    $meta_map->ensure_is_model();
-                }
-                $caps = $meta_map->map_meta_caps($caps, $cap, $user_id, $args);
-            }
-        }
-        return $caps;
-    }
-
-
-
-    /**
-     * This sets up and returns the initial capabilities map for Event Espresso
-     * Note this array is filtered.
-     * It is assumed that all available EE capabilities are assigned to the administrator role.
-     *
-     * @since 4.5.0
-     *
-     * @return array
-     */
-    private function _init_caps_map()
-    {
-        return apply_filters(
-            'FHEE__EE_Capabilities__init_caps_map__caps',
-            array(
-                'administrator'           => array(
-                    //basic access
-                    'ee_read_ee',
-                    //gateways
-                    /**
-                     * note that with payment method capabilities, although we've implemented
-                     * capability mapping which will be used for accessing payment methods owned by
-                     * other users.  This is not fully implemented yet in the payment method ui.
-                     * Currently only the "plural" caps are in active use.
-                     * (Specific payment method caps are in use as well).
-                     **/
-                    'ee_manage_gateways',
-                    'ee_read_payment_methods',
-                    'ee_read_others_payment_methods',
-                    'ee_edit_payment_methods',
-                    'ee_edit_others_payment_methods',
-                    'ee_delete_payment_methods',
-                    //events
-                    'ee_publish_events',
-                    'ee_read_private_events',
-                    'ee_read_others_events',
-                    'ee_read_events',
-                    'ee_edit_events',
-                    'ee_edit_published_events',
-                    'ee_edit_others_events',
-                    'ee_edit_private_events',
-                    'ee_delete_published_events',
-                    'ee_delete_private_events',
-                    'ee_delete_events',
-                    'ee_delete_others_events',
-                    //event categories
-                    'ee_manage_event_categories',
-                    'ee_edit_event_category',
-                    'ee_delete_event_category',
-                    'ee_assign_event_category',
-                    //venues
-                    'ee_publish_venues',
-                    'ee_read_venues',
-                    'ee_read_others_venues',
-                    'ee_read_private_venues',
-                    'ee_edit_venues',
-                    'ee_edit_others_venues',
-                    'ee_edit_published_venues',
-                    'ee_edit_private_venues',
-                    'ee_delete_venues',
-                    'ee_delete_others_venues',
-                    'ee_delete_private_venues',
-                    'ee_delete_published_venues',
-                    //venue categories
-                    'ee_manage_venue_categories',
-                    'ee_edit_venue_category',
-                    'ee_delete_venue_category',
-                    'ee_assign_venue_category',
-                    //contacts
-                    'ee_read_contacts',
-                    'ee_edit_contacts',
-                    'ee_delete_contacts',
-                    //registrations
-                    'ee_read_registrations',
-                    'ee_read_others_registrations',
-                    'ee_edit_registrations',
-                    'ee_edit_others_registrations',
-                    'ee_delete_registrations',
-                    //checkins
-                    'ee_read_others_checkins',
-                    'ee_read_checkins',
-                    'ee_edit_checkins',
-                    'ee_edit_others_checkins',
-                    'ee_delete_checkins',
-                    'ee_delete_others_checkins',
-                    //transactions && payments
-                    'ee_read_transaction',
-                    'ee_read_transactions',
-                    'ee_edit_payments',
-                    'ee_delete_payments',
-                    //messages
-                    'ee_read_messages',
-                    'ee_read_others_messages',
-                    'ee_read_global_messages',
-                    'ee_edit_global_messages',
-                    'ee_edit_messages',
-                    'ee_edit_others_messages',
-                    'ee_delete_messages',
-                    'ee_delete_others_messages',
-                    'ee_delete_global_messages',
-                    'ee_send_message',
-                    //tickets
-                    'ee_read_default_tickets',
-                    'ee_read_others_default_tickets',
-                    'ee_edit_default_tickets',
-                    'ee_edit_others_default_tickets',
-                    'ee_delete_default_tickets',
-                    'ee_delete_others_default_tickets',
-                    //prices
-                    'ee_edit_default_price',
-                    'ee_edit_default_prices',
-                    'ee_delete_default_price',
-                    'ee_delete_default_prices',
-                    'ee_edit_default_price_type',
-                    'ee_edit_default_price_types',
-                    'ee_delete_default_price_type',
-                    'ee_delete_default_price_types',
-                    'ee_read_default_prices',
-                    'ee_read_default_price_types',
-                    //registration form
-                    'ee_edit_questions',
-                    'ee_edit_system_questions',
-                    'ee_read_questions',
-                    'ee_delete_questions',
-                    'ee_edit_question_groups',
-                    'ee_read_question_groups',
-                    'ee_edit_system_question_groups',
-                    'ee_delete_question_groups',
-                    //event_type taxonomy
-                    'ee_assign_event_type',
-                    'ee_manage_event_types',
-                    'ee_edit_event_type',
-                    'ee_delete_event_type',
-                ),
-                'ee_events_administrator' => array(
-                    //core wp caps
-                    'read',
-                    'read_private_pages',
-                    'read_private_posts',
-                    'edit_users',
-                    'edit_posts',
-                    'edit_pages',
-                    'edit_published_posts',
-                    'edit_published_pages',
-                    'edit_private_pages',
-                    'edit_private_posts',
-                    'edit_others_posts',
-                    'edit_others_pages',
-                    'publish_posts',
-                    'publish_pages',
-                    'delete_posts',
-                    'delete_pages',
-                    'delete_private_pages',
-                    'delete_private_posts',
-                    'delete_published_pages',
-                    'delete_published_posts',
-                    'delete_others_posts',
-                    'delete_others_pages',
-                    'manage_categories',
-                    'manage_links',
-                    'moderate_comments',
-                    'unfiltered_html',
-                    'upload_files',
-                    'export',
-                    'import',
-                    'list_users',
-                    'level_1', //required if user with this role shows up in author dropdowns
-                    //basic ee access
-                    'ee_read_ee',
-                    //events
-                    'ee_publish_events',
-                    'ee_read_private_events',
-                    'ee_read_others_events',
-                    'ee_read_event',
-                    'ee_read_events',
-                    'ee_edit_event',
-                    'ee_edit_events',
-                    'ee_edit_published_events',
-                    'ee_edit_others_events',
-                    'ee_edit_private_events',
-                    'ee_delete_published_events',
-                    'ee_delete_private_events',
-                    'ee_delete_event',
-                    'ee_delete_events',
-                    'ee_delete_others_events',
-                    //event categories
-                    'ee_manage_event_categories',
-                    'ee_edit_event_category',
-                    'ee_delete_event_category',
-                    'ee_assign_event_category',
-                    //venues
-                    'ee_publish_venues',
-                    'ee_read_venue',
-                    'ee_read_venues',
-                    'ee_read_others_venues',
-                    'ee_read_private_venues',
-                    'ee_edit_venue',
-                    'ee_edit_venues',
-                    'ee_edit_others_venues',
-                    'ee_edit_published_venues',
-                    'ee_edit_private_venues',
-                    'ee_delete_venue',
-                    'ee_delete_venues',
-                    'ee_delete_others_venues',
-                    'ee_delete_private_venues',
-                    'ee_delete_published_venues',
-                    //venue categories
-                    'ee_manage_venue_categories',
-                    'ee_edit_venue_category',
-                    'ee_delete_venue_category',
-                    'ee_assign_venue_category',
-                    //contacts
-                    'ee_read_contacts',
-                    'ee_edit_contacts',
-                    'ee_delete_contacts',
-                    //registrations
-                    'ee_read_registrations',
-                    'ee_read_others_registrations',
-                    'ee_edit_registration',
-                    'ee_edit_registrations',
-                    'ee_edit_others_registrations',
-                    'ee_delete_registration',
-                    'ee_delete_registrations',
-                    //checkins
-                    'ee_read_others_checkins',
-                    'ee_read_checkins',
-                    'ee_edit_checkins',
-                    'ee_edit_others_checkins',
-                    'ee_delete_checkins',
-                    'ee_delete_others_checkins',
-                    //transactions && payments
-                    'ee_read_transaction',
-                    'ee_read_transactions',
-                    'ee_edit_payments',
-                    'ee_delete_payments',
-                    //messages
-                    'ee_read_messages',
-                    'ee_read_others_messages',
-                    'ee_read_global_messages',
-                    'ee_edit_global_messages',
-                    'ee_edit_messages',
-                    'ee_edit_others_messages',
-                    'ee_delete_messages',
-                    'ee_delete_others_messages',
-                    'ee_delete_global_messages',
-                    'ee_send_message',
-                    //tickets
-                    'ee_read_default_tickets',
-                    'ee_read_others_default_tickets',
-                    'ee_edit_default_tickets',
-                    'ee_edit_others_default_tickets',
-                    'ee_delete_default_tickets',
-                    'ee_delete_others_default_tickets',
-                    //prices
-                    'ee_edit_default_price',
-                    'ee_edit_default_prices',
-                    'ee_delete_default_price',
-                    'ee_delete_default_prices',
-                    'ee_edit_default_price_type',
-                    'ee_edit_default_price_types',
-                    'ee_delete_default_price_type',
-                    'ee_delete_default_price_types',
-                    'ee_read_default_prices',
-                    'ee_read_default_price_types',
-                    //registration form
-                    'ee_edit_questions',
-                    'ee_edit_system_questions',
-                    'ee_read_questions',
-                    'ee_delete_questions',
-                    'ee_edit_question_groups',
-                    'ee_read_question_groups',
-                    'ee_edit_system_question_groups',
-                    'ee_delete_question_groups',
-                    //event_type taxonomy
-                    'ee_assign_event_type',
-                    'ee_manage_event_types',
-                    'ee_edit_event_type',
-                    'ee_delete_event_type',
-                )
-            )
-        );
-    }
-
-
-
-    /**
-     * @return bool
-     * @throws EE_Error
-     */
-    private function setupCapabilitiesMap()
-    {
-        // if the initialization process hasn't even started, then we need to call init_caps()
-        if($this->initialized === null) {
-            return $this->init_caps();
-        }
-        // unless resetting, get caps from db if we haven't already
-        $this->capabilities_map = $this->reset || ! empty($this->capabilities_map)
-            ? $this->capabilities_map
-            : get_option(self::option_name, array());
-        return true;
-    }
-
-
-
-    /**
-     * @param bool $update
-     * @return bool
-     */
-    private function updateCapabilitiesMap($update = true)
-    {
-        return $update ? update_option(self::option_name, $this->capabilities_map) : false;
-    }
-
-
-
-    /**
-     * Adds capabilities to roles.
-     *
-     * @since 4.9.42
-     * @param array $capabilities_to_add array of capabilities to add, indexed by roles.
-     *                                   Note that this should ONLY be called on activation hook
-     *                                   otherwise the caps will be added on every request.
-     * @return bool
-     * @throws \EE_Error
-     */
-    public function addCaps(array $capabilities_to_add)
-    {
-        // don't do anything if the capabilities map can not be initialized
-        if (! $this->setupCapabilitiesMap()) {
-            return false;
-        }
-        // and filter the array so others can get in on the fun during resets
-        $capabilities_to_add = apply_filters(
-            'FHEE__EE_Capabilities__addCaps__capabilities_to_add',
-            $capabilities_to_add,
-            $this->reset,
-            $this->capabilities_map
-        );
-        $update_capabilities_map = false;
-        // if not reset, see what caps are new for each role. if they're new, add them.
-        foreach ($capabilities_to_add as $role => $caps_for_role) {
-            if (is_array($caps_for_role)) {
-                foreach ($caps_for_role as $cap) {
-                    if (
-                        ! $this->capHasBeenAddedToRole($role, $cap)
-                        && $this->add_cap_to_role($role, $cap, true, false)
-                    ) {
-                        $update_capabilities_map = true;
-                    }
-                }
-            }
-        }
-        // now let's just save the cap that has been set but only if there's been a change.
-        $updated = $this->updateCapabilitiesMap($update_capabilities_map);
-        $this->flushWpUser($updated);
-        do_action('AHEE__EE_Capabilities__addCaps__complete', $this->capabilities_map, $updated);
-        return $updated;
-    }
-
-
-
-    /**
-     * Loops through the capabilities map and removes the role caps specified by the incoming array
-     *
-     * @param array $caps_map map of capabilities to be removed (indexed by roles)
-     * @return bool
-     * @throws \EE_Error
-     */
-    public function removeCaps($caps_map)
-    {
-        // don't do anything if the capabilities map can not be initialized
-        if (! $this->setupCapabilitiesMap()) {
-            return false;
-        }
-        $update_capabilities_map = false;
-        foreach ($caps_map as $role => $caps_for_role) {
-            if (is_array($caps_for_role)) {
-                foreach ($caps_for_role as $cap) {
-                    if ($this->capHasBeenAddedToRole($role, $cap)
-                        && $this->remove_cap_from_role($role, $cap, false)
-                    ) {
-                        $update_capabilities_map = true;
-                    }
-                }
-            }
-        }
-        // maybe resave the caps
-        $updated = $this->updateCapabilitiesMap($update_capabilities_map);
-        $this->flushWpUser($updated);
-        return $updated;
-    }
-
-
-    /**
-     * This ensures that the WP User object cached on the $current_user global in WP has the latest capabilities from
-     * the roles on that user.
-     *
-     * @param bool $flush  Default is to flush the WP_User object.  If false, then this method effectively does nothing.
-     */
-    private function flushWpUser($flush = true)
-    {
-        if ($flush) {
-            $user = wp_get_current_user();
-            if ($user instanceof WP_User) {
-                $user->get_role_caps();
-            }
-        }
-    }
-
-
-
-    /**
-     * This method sets a capability on a role.  Note this should only be done on activation, or if you have something
-     * specific to prevent the cap from being added on every page load (adding caps are persistent to the db). Note.
-     * this is a wrapper for $wp_role->add_cap()
-     *
-     * @see   wp-includes/capabilities.php
-     * @since 4.5.0
-     * @param string|WP_Role $role  A WordPress role the capability is being added to
-     * @param string         $cap   The capability being added to the role
-     * @param bool           $grant Whether to grant access to this cap on this role.
-     * @param bool           $update_capabilities_map
-     * @return bool
-     * @throws \EE_Error
-     */
-    public function add_cap_to_role($role, $cap, $grant = true, $update_capabilities_map = true)
-    {
-        // capture incoming value for $role because we may need it to create a new WP_Role
-        $orig_role = $role;
-        $role = $role instanceof WP_Role ? $role : get_role($role);
-        //if the role isn't available then we create it.
-        if (! $role instanceof WP_Role) {
-            // if a plugin wants to create a specific role name then they should create the role before
-            // EE_Capabilities does.  Otherwise this function will create the role name from the slug:
-            // - removes any `ee_` namespacing from the start of the slug.
-            // - replaces `_` with ` ` (empty space).
-            // - sentence case on the resulting string.
-            $role_label = ucwords(str_replace(array('ee_', '_'), array('', ' '), $orig_role));
-            $role = add_role($orig_role, $role_label);
-        }
-        if ($role instanceof WP_Role) {
-            // don't do anything if the capabilities map can not be initialized
-            if (! $this->setupCapabilitiesMap()) {
-                return false;
-            }
-            if (! $this->capHasBeenAddedToRole($role->name, $cap)) {
-                $role->add_cap($cap, $grant);
-                $this->capabilities_map[ $role->name ][] = $cap;
-                $this->updateCapabilitiesMap($update_capabilities_map);
-                return true;
-            }
-        }
-        return false;
-    }
-
-
-
-    /**
-     * Functions similarly to add_cap_to_role except removes cap from given role.
-     * Wrapper for $wp_role->remove_cap()
-     *
-     * @see   wp-includes/capabilities.php
-     * @since 4.5.0
-     * @param string|WP_Role $role A WordPress role the capability is being removed from.
-     * @param string         $cap  The capability being removed
-     * @param bool           $update_capabilities_map
-     * @return bool
-     * @throws \EE_Error
-     */
-    public function remove_cap_from_role($role, $cap, $update_capabilities_map = true)
-    {
-        // don't do anything if the capabilities map can not be initialized
-        if (! $this->setupCapabilitiesMap()) {
-            return false;
-        }
-        $role = $role instanceof WP_Role ? $role :get_role($role);
-        if ($index = $this->capHasBeenAddedToRole($role->name, $cap, true)) {
-            $role->remove_cap($cap);
-            unset($this->capabilities_map[ $role->name ][ $index ]);
-            $this->updateCapabilitiesMap($update_capabilities_map);
-            return true;
-        }
-        return false;
-    }
-
-
-
-    /**
-     * @param string $role_name
-     * @param string $cap
-     * @param bool   $get_index
-     * @return bool|mixed
-     */
-    private function capHasBeenAddedToRole($role_name='', $cap='', $get_index = false)
-    {
-        if (
-            isset($this->capabilities_map[$role_name])
-            && ($index = array_search($cap, $this->capabilities_map[$role_name], true)) !== false
-        ) {
-            return $get_index ? $index : true;
-        }
-        return false;
-    }
-
-
-
-    /**
-     * Wrapper for the native WP current_user_can() method.
-     * This is provided as a handy method for a couple things:
-     * 1. Using the context string it allows for targeted filtering by addons for a specific check (without having to
-     * write those filters wherever current_user_can is called).
-     * 2. Explicit passing of $id from a given context ( useful in the cases of map_meta_cap filters )
-     *
-     * @since 4.5.0
-     *
-     * @param string $cap     The cap being checked.
-     * @param string $context The context where the current_user_can is being called from.
-     * @param int    $id      Optional. Id for item where current_user_can is being called from (used in map_meta_cap()
-     *                        filters.
-     *
-     * @return bool  Whether user can or not.
-     */
-    public function current_user_can($cap, $context, $id = 0)
-    {
-        //apply filters (both a global on just the cap, and context specific.  Global overrides context specific)
-        $filtered_cap = apply_filters('FHEE__EE_Capabilities__current_user_can__cap__' . $context, $cap, $id);
-        $filtered_cap = apply_filters(
-            'FHEE__EE_Capabilities__current_user_can__cap',
-            $filtered_cap,
-            $context,
-            $cap,
-            $id
-        );
-        return ! empty($id)
-            ? current_user_can($filtered_cap, $id)
-            : current_user_can($filtered_cap);
-    }
-
-
-
-    /**
-     * This is a wrapper for the WP user_can() function and follows the same style as the other wrappers in this class.
-     *
-     * @param int|WP_User $user    Either the user_id or a WP_User object
-     * @param string      $cap     The capability string being checked
-     * @param string      $context The context where the user_can is being called from (used in filters).
-     * @param int         $id      Optional. Id for item where user_can is being called from ( used in map_meta_cap()
-     *                             filters)
-     *
-     * @return bool Whether user can or not.
-     */
-    public function user_can($user, $cap, $context, $id = 0)
-    {
-        //apply filters (both a global on just the cap, and context specific.  Global overrides context specific)
-        $filtered_cap = apply_filters('FHEE__EE_Capabilities__user_can__cap__' . $context, $cap, $user, $id);
-        $filtered_cap = apply_filters(
-            'FHEE__EE_Capabilities__user_can__cap',
-            $filtered_cap,
-            $context,
-            $cap,
-            $user,
-            $id
-        );
-        return ! empty($id)
-            ? user_can($user, $filtered_cap, $id)
-            : user_can($user, $filtered_cap);
-    }
-
-
-
-    /**
-     * Wrapper for the native WP current_user_can_for_blog() method.
-     * This is provided as a handy method for a couple things:
-     * 1. Using the context string it allows for targeted filtering by addons for a specific check (without having to
-     * write those filters wherever current_user_can is called).
-     * 2. Explicit passing of $id from a given context ( useful in the cases of map_meta_cap filters )
-     *
-     * @since 4.5.0
-     *
-     * @param int    $blog_id The blog id that is being checked for.
-     * @param string $cap     The cap being checked.
-     * @param string $context The context where the current_user_can is being called from.
-     * @param int    $id      Optional. Id for item where current_user_can is being called from (used in map_meta_cap()
-     *                        filters.
-     *
-     * @return bool  Whether user can or not.
-     */
-    public function current_user_can_for_blog($blog_id, $cap, $context, $id = 0)
-    {
-        $user_can = ! empty($id)
-            ? current_user_can_for_blog($blog_id, $cap, $id)
-            : current_user_can($blog_id, $cap);
-        //apply filters (both a global on just the cap, and context specific.  Global overrides context specific)
-        $user_can = apply_filters(
-            'FHEE__EE_Capabilities__current_user_can_for_blog__user_can__' . $context,
-            $user_can,
-            $blog_id,
-            $cap,
-            $id
-        );
-        $user_can = apply_filters(
-            'FHEE__EE_Capabilities__current_user_can_for_blog__user_can',
-            $user_can,
-            $context,
-            $blog_id,
-            $cap,
-            $id
-        );
-        return $user_can;
-    }
-
-
-
-    /**
-     * This helper method just returns an array of registered EE capabilities.
-     *
-     * @since 4.5.0
-     * @param string $role If empty then the entire role/capability map is returned.
-     *                     Otherwise just the capabilities for the given role are returned.
-     * @return array
-     * @throws EE_Error
-     */
-    public function get_ee_capabilities($role = 'administrator')
-    {
-        if (! $this->initialized) {
-            $this->init_caps();
-        }
-        if (empty($role)) {
-            return $this->capabilities_map;
-        }
-        return isset($this->capabilities_map[ $role ])
-            ? $this->capabilities_map[ $role ]
-            : array();
-    }
-
-
-
-    /**
-     * @deprecated 4.9.42
-     * @param bool  $reset      If you need to reset Event Espresso's capabilities,
-     *                          then please use the init_caps() method with the "$reset" parameter set to "true"
-     * @param array $caps_map   Optional.
-     *                          Can be used to send a custom map of roles and capabilities for setting them up.
-     *                          Note that this should ONLY be called on activation hook or some other one-time
-     *                          task otherwise the caps will be added on every request.
-     * @return void
-     * @throws EE_Error
-     */
-    public function init_role_caps($reset = false, $caps_map = array())
-    {
-        // If this method is called directly and reset is set as 'true',
-        // then display a doing it wrong notice, because we want resets to go through init_caps()
-        // to guarantee that everything is set up correctly.
-        // This prevents the capabilities map getting reset incorrectly by direct calls to this method.
-        if ($reset) {
-            EE_Error::doing_it_wrong(
-                __METHOD__,
-                sprintf(
-                    esc_html__(
-                        'The "%1$s" parameter for the "%2$s" method is deprecated. If you need to reset Event Espresso\'s capabilities, then please use the "%3$s" method with the "%1$s" parameter set to "%4$s".',
-                        'event_espresso'
-                    ),
-                    '$reset',
-                    __METHOD__ . '()',
-                    'EE_Capabilities::init_caps()',
-                    'true'
-                ),
-                '4.9.42',
-                '5.0.0'
-            );
-        }
-        $this->addCaps($caps_map);
-    }
+	/**
+	 * the name of the wp option used to store caps previously initialized
+	 */
+	const option_name = 'ee_caps_initialized';
+
+	/**
+	 * instance of EE_Capabilities object
+	 *
+	 * @var EE_Capabilities
+	 */
+	private static $_instance;
+
+
+	/**
+	 * This is a map of caps that correspond to a default WP_Role.
+	 * Array is indexed by Role and values are ee capabilities.
+	 *
+	 * @since 4.5.0
+	 *
+	 * @var array
+	 */
+	private $capabilities_map = array();
+
+	/**
+	 * This used to hold an array of EE_Meta_Capability_Map objects
+	 * that define the granular capabilities mapped to for a user depending on context.
+	 *
+	 * @var EE_Meta_Capability_Map[]
+	 */
+	private $_meta_caps = array();
+
+	/**
+	 * The internal $capabilities_map needs to be initialized before it can be used.
+	 * This flag tracks whether that has happened or not.
+	 * But for this to work, we need three states to indicate:
+	 *      initialization has not occurred at all
+	 *      initialization has started but is not complete
+	 *      initialization is complete
+	 * The reason this is needed is because the addCaps() method
+	 * normally requires the $capabilities_map to be initialized,
+	 * but is also used during the initialization process.
+	 * So:
+	 *      If initialized === null, init_caps() will be called before any other methods will run.
+	 *      If initialized === false, then init_caps() is in the process of running it's logic.
+	 *      If initialized === true, then init_caps() has completed the initialization process.
+	 *
+	 * @var boolean|null $initialized
+	 */
+	private $initialized;
+
+	/**
+	 * @var boolean $reset
+	 */
+	private $reset = false;
+
+
+
+	/**
+	 * singleton method used to instantiate class object
+	 *
+	 * @since 4.5.0
+	 *
+	 * @return EE_Capabilities
+	 */
+	public static function instance()
+	{
+		//check if instantiated, and if not do so.
+		if (! self::$_instance instanceof EE_Capabilities) {
+			self::$_instance = new self();
+		}
+		return self::$_instance;
+	}
+
+
+
+	/**
+	 * private constructor
+	 *
+	 * @since 4.5.0
+	 */
+	private function __construct()
+	{
+	}
+
+
+
+	/**
+	 * This delays the initialization of the capabilities class until EE_System core is loaded and ready.
+	 *
+	 * @param bool $reset allows for resetting the default capabilities saved on roles.  Note that this doesn't
+	 *                    actually REMOVE any capabilities from existing roles, it just resaves defaults roles and
+	 *                    ensures that they are up to date.
+	 *
+	 * @since 4.5.0
+	 * @return bool
+	 * @throws EE_Error
+	 */
+	public function init_caps($reset = false)
+	{
+		if(! EE_Maintenance_Mode::instance()->models_can_query()){
+			return false;
+		}
+		$this->reset = filter_var($reset, FILTER_VALIDATE_BOOLEAN);
+		// if reset, then completely delete the cache option and clear the $capabilities_map property.
+		if ($this->reset) {
+			$this->initialized = null;
+			$this->capabilities_map = array();
+			delete_option(self::option_name);
+		}
+		if ($this->initialized === null) {
+			$this->initialized = false;
+			do_action(
+				'AHEE__EE_Capabilities__init_caps__before_initialization',
+				$this->reset
+			);
+			$this->addCaps($this->_init_caps_map());
+			$this->_set_meta_caps();
+			do_action(
+				'AHEE__EE_Capabilities__init_caps__after_initialization',
+				$this->capabilities_map
+			);
+			$this->initialized = true;
+		}
+		// reset $this->reset so that it's not stuck on true if init_caps() gets called again
+		$this->reset = false;
+		return true;
+	}
+
+
+
+
+	/**
+	 * This sets the meta caps property.
+	 *
+	 * @since 4.5.0
+	 * @return void
+	 * @throws EE_Error
+	 */
+	private function _set_meta_caps()
+	{
+		// get default meta caps and filter the returned array
+		$this->_meta_caps = apply_filters(
+			'FHEE__EE_Capabilities___set_meta_caps__meta_caps',
+			$this->_get_default_meta_caps_array()
+		);
+		//add filter for map_meta_caps but only if models can query.
+		if (! has_filter('map_meta_cap', array($this, 'map_meta_caps'))) {
+			add_filter('map_meta_cap', array($this, 'map_meta_caps'), 10, 4);
+		}
+	}
+
+
+
+	/**
+	 * This builds and returns the default meta_caps array only once.
+	 *
+	 * @since  4.8.28.rc.012
+	 * @return array
+	 * @throws EE_Error
+	 */
+	private function _get_default_meta_caps_array()
+	{
+		static $default_meta_caps = array();
+		// make sure we're only ever initializing the default _meta_caps array once if it's empty.
+		if (empty($default_meta_caps)) {
+			$default_meta_caps = array(
+				//edits
+				new EE_Meta_Capability_Map_Edit(
+					'ee_edit_event',
+					array('Event', 'ee_edit_published_events', 'ee_edit_others_events', 'ee_edit_private_events')
+				),
+				new EE_Meta_Capability_Map_Edit(
+					'ee_edit_venue',
+					array('Venue', 'ee_edit_published_venues', 'ee_edit_others_venues', 'ee_edit_private_venues')
+				),
+				new EE_Meta_Capability_Map_Edit(
+					'ee_edit_registration',
+					array('Registration', '', 'ee_edit_others_registrations', '')
+				),
+				new EE_Meta_Capability_Map_Edit(
+					'ee_edit_checkin',
+					array('Registration', '', 'ee_edit_others_checkins', '')
+				),
+				new EE_Meta_Capability_Map_Messages_Cap(
+					'ee_edit_message',
+					array('Message_Template_Group', '', 'ee_edit_others_messages', 'ee_edit_global_messages')
+				),
+				new EE_Meta_Capability_Map_Edit(
+					'ee_edit_default_ticket',
+					array('Ticket', '', 'ee_edit_others_default_tickets', '')
+				),
+				new EE_Meta_Capability_Map_Registration_Form_Cap(
+					'ee_edit_question',
+					array('Question', '', '', 'ee_edit_system_questions')
+				),
+				new EE_Meta_Capability_Map_Registration_Form_Cap(
+					'ee_edit_question_group',
+					array('Question_Group', '', '', 'ee_edit_system_question_groups')
+				),
+				new EE_Meta_Capability_Map_Edit(
+					'ee_edit_payment_method',
+					array('Payment_Method', '', 'ee_edit_others_payment_methods', '')
+				),
+				//reads
+				new EE_Meta_Capability_Map_Read(
+					'ee_read_event',
+					array('Event', '', 'ee_read_others_events', 'ee_read_private_events')
+				),
+				new EE_Meta_Capability_Map_Read(
+					'ee_read_venue',
+					array('Venue', '', 'ee_read_others_venues', 'ee_read_private_venues')
+				),
+				new EE_Meta_Capability_Map_Read(
+					'ee_read_registration',
+					array('Registration', '', 'ee_read_others_registrations', '')
+				),
+				new EE_Meta_Capability_Map_Read(
+					'ee_read_checkin',
+					array('Registration', '', 'ee_read_others_checkins', '')
+				),
+				new EE_Meta_Capability_Map_Messages_Cap(
+					'ee_read_message',
+					array('Message_Template_Group', '', 'ee_read_others_messages', 'ee_read_global_messages')
+				),
+				new EE_Meta_Capability_Map_Read(
+					'ee_read_default_ticket',
+					array('Ticket', '', 'ee_read_others_default_tickets', '')
+				),
+				new EE_Meta_Capability_Map_Read(
+					'ee_read_payment_method',
+					array('Payment_Method', '', 'ee_read_others_payment_methods', '')
+				),
+				//deletes
+				new EE_Meta_Capability_Map_Delete(
+					'ee_delete_event',
+					array(
+						'Event',
+						'ee_delete_published_events',
+						'ee_delete_others_events',
+						'ee_delete_private_events',
+					)
+				),
+				new EE_Meta_Capability_Map_Delete(
+					'ee_delete_venue',
+					array(
+						'Venue',
+						'ee_delete_published_venues',
+						'ee_delete_others_venues',
+						'ee_delete_private_venues',
+					)
+				),
+				new EE_Meta_Capability_Map_Delete(
+					'ee_delete_registration',
+					array('Registration', '', 'ee_delete_others_registrations', '')
+				),
+				new EE_Meta_Capability_Map_Delete(
+					'ee_delete_checkin',
+					array('Registration', '', 'ee_delete_others_checkins', '')
+				),
+				new EE_Meta_Capability_Map_Messages_Cap(
+					'ee_delete_message',
+					array('Message_Template_Group', '', 'ee_delete_others_messages', 'ee_delete_global_messages')
+				),
+				new EE_Meta_Capability_Map_Delete(
+					'ee_delete_default_ticket',
+					array('Ticket', '', 'ee_delete_others_default_tickets', '')
+				),
+				new EE_Meta_Capability_Map_Registration_Form_Cap(
+					'ee_delete_question',
+					array('Question', '', '', 'delete_system_questions')
+				),
+				new EE_Meta_Capability_Map_Registration_Form_Cap(
+					'ee_delete_question_group',
+					array('Question_Group', '', '', 'delete_system_question_groups')
+				),
+				new EE_Meta_Capability_Map_Delete(
+					'ee_delete_payment_method',
+					array('Payment_Method', '', 'ee_delete_others_payment_methods', '')
+				),
+			);
+		}
+		return $default_meta_caps;
+	}
+
+
+
+	/**
+	 * This is the callback for the wp map_meta_caps() function which allows for ensuring certain caps that act as a
+	 * "meta" for other caps ( i.e. ee_edit_event is a meta for ee_edit_others_events ) work as expected.
+	 *
+	 * The actual logic is carried out by implementer classes in their definition of _map_meta_caps.
+	 *
+	 * @since 4.5.0
+	 * @see   wp-includes/capabilities.php
+	 *
+	 * @param array  $caps    actual users capabilities
+	 * @param string $cap     initial capability name that is being checked (the "map" key)
+	 * @param int    $user_id The user id
+	 * @param array  $args    Adds context to the cap. Typically the object ID.
+	 * @return array actual users capabilities
+	 * @throws EE_Error
+	 */
+	public function map_meta_caps($caps, $cap, $user_id, $args)
+	{
+		if (did_action('AHEE__EE_System__load_espresso_addons__complete')) {
+			//loop through our _meta_caps array
+			foreach ($this->_meta_caps as $meta_map) {
+				if (! $meta_map instanceof EE_Meta_Capability_Map) {
+					continue;
+				}
+				// don't load models if there is no object ID in the args
+				if (! empty($args[0])) {
+					$meta_map->ensure_is_model();
+				}
+				$caps = $meta_map->map_meta_caps($caps, $cap, $user_id, $args);
+			}
+		}
+		return $caps;
+	}
+
+
+
+	/**
+	 * This sets up and returns the initial capabilities map for Event Espresso
+	 * Note this array is filtered.
+	 * It is assumed that all available EE capabilities are assigned to the administrator role.
+	 *
+	 * @since 4.5.0
+	 *
+	 * @return array
+	 */
+	private function _init_caps_map()
+	{
+		return apply_filters(
+			'FHEE__EE_Capabilities__init_caps_map__caps',
+			array(
+				'administrator'           => array(
+					//basic access
+					'ee_read_ee',
+					//gateways
+					/**
+					 * note that with payment method capabilities, although we've implemented
+					 * capability mapping which will be used for accessing payment methods owned by
+					 * other users.  This is not fully implemented yet in the payment method ui.
+					 * Currently only the "plural" caps are in active use.
+					 * (Specific payment method caps are in use as well).
+					 **/
+					'ee_manage_gateways',
+					'ee_read_payment_methods',
+					'ee_read_others_payment_methods',
+					'ee_edit_payment_methods',
+					'ee_edit_others_payment_methods',
+					'ee_delete_payment_methods',
+					//events
+					'ee_publish_events',
+					'ee_read_private_events',
+					'ee_read_others_events',
+					'ee_read_events',
+					'ee_edit_events',
+					'ee_edit_published_events',
+					'ee_edit_others_events',
+					'ee_edit_private_events',
+					'ee_delete_published_events',
+					'ee_delete_private_events',
+					'ee_delete_events',
+					'ee_delete_others_events',
+					//event categories
+					'ee_manage_event_categories',
+					'ee_edit_event_category',
+					'ee_delete_event_category',
+					'ee_assign_event_category',
+					//venues
+					'ee_publish_venues',
+					'ee_read_venues',
+					'ee_read_others_venues',
+					'ee_read_private_venues',
+					'ee_edit_venues',
+					'ee_edit_others_venues',
+					'ee_edit_published_venues',
+					'ee_edit_private_venues',
+					'ee_delete_venues',
+					'ee_delete_others_venues',
+					'ee_delete_private_venues',
+					'ee_delete_published_venues',
+					//venue categories
+					'ee_manage_venue_categories',
+					'ee_edit_venue_category',
+					'ee_delete_venue_category',
+					'ee_assign_venue_category',
+					//contacts
+					'ee_read_contacts',
+					'ee_edit_contacts',
+					'ee_delete_contacts',
+					//registrations
+					'ee_read_registrations',
+					'ee_read_others_registrations',
+					'ee_edit_registrations',
+					'ee_edit_others_registrations',
+					'ee_delete_registrations',
+					//checkins
+					'ee_read_others_checkins',
+					'ee_read_checkins',
+					'ee_edit_checkins',
+					'ee_edit_others_checkins',
+					'ee_delete_checkins',
+					'ee_delete_others_checkins',
+					//transactions && payments
+					'ee_read_transaction',
+					'ee_read_transactions',
+					'ee_edit_payments',
+					'ee_delete_payments',
+					//messages
+					'ee_read_messages',
+					'ee_read_others_messages',
+					'ee_read_global_messages',
+					'ee_edit_global_messages',
+					'ee_edit_messages',
+					'ee_edit_others_messages',
+					'ee_delete_messages',
+					'ee_delete_others_messages',
+					'ee_delete_global_messages',
+					'ee_send_message',
+					//tickets
+					'ee_read_default_tickets',
+					'ee_read_others_default_tickets',
+					'ee_edit_default_tickets',
+					'ee_edit_others_default_tickets',
+					'ee_delete_default_tickets',
+					'ee_delete_others_default_tickets',
+					//prices
+					'ee_edit_default_price',
+					'ee_edit_default_prices',
+					'ee_delete_default_price',
+					'ee_delete_default_prices',
+					'ee_edit_default_price_type',
+					'ee_edit_default_price_types',
+					'ee_delete_default_price_type',
+					'ee_delete_default_price_types',
+					'ee_read_default_prices',
+					'ee_read_default_price_types',
+					//registration form
+					'ee_edit_questions',
+					'ee_edit_system_questions',
+					'ee_read_questions',
+					'ee_delete_questions',
+					'ee_edit_question_groups',
+					'ee_read_question_groups',
+					'ee_edit_system_question_groups',
+					'ee_delete_question_groups',
+					//event_type taxonomy
+					'ee_assign_event_type',
+					'ee_manage_event_types',
+					'ee_edit_event_type',
+					'ee_delete_event_type',
+				),
+				'ee_events_administrator' => array(
+					//core wp caps
+					'read',
+					'read_private_pages',
+					'read_private_posts',
+					'edit_users',
+					'edit_posts',
+					'edit_pages',
+					'edit_published_posts',
+					'edit_published_pages',
+					'edit_private_pages',
+					'edit_private_posts',
+					'edit_others_posts',
+					'edit_others_pages',
+					'publish_posts',
+					'publish_pages',
+					'delete_posts',
+					'delete_pages',
+					'delete_private_pages',
+					'delete_private_posts',
+					'delete_published_pages',
+					'delete_published_posts',
+					'delete_others_posts',
+					'delete_others_pages',
+					'manage_categories',
+					'manage_links',
+					'moderate_comments',
+					'unfiltered_html',
+					'upload_files',
+					'export',
+					'import',
+					'list_users',
+					'level_1', //required if user with this role shows up in author dropdowns
+					//basic ee access
+					'ee_read_ee',
+					//events
+					'ee_publish_events',
+					'ee_read_private_events',
+					'ee_read_others_events',
+					'ee_read_event',
+					'ee_read_events',
+					'ee_edit_event',
+					'ee_edit_events',
+					'ee_edit_published_events',
+					'ee_edit_others_events',
+					'ee_edit_private_events',
+					'ee_delete_published_events',
+					'ee_delete_private_events',
+					'ee_delete_event',
+					'ee_delete_events',
+					'ee_delete_others_events',
+					//event categories
+					'ee_manage_event_categories',
+					'ee_edit_event_category',
+					'ee_delete_event_category',
+					'ee_assign_event_category',
+					//venues
+					'ee_publish_venues',
+					'ee_read_venue',
+					'ee_read_venues',
+					'ee_read_others_venues',
+					'ee_read_private_venues',
+					'ee_edit_venue',
+					'ee_edit_venues',
+					'ee_edit_others_venues',
+					'ee_edit_published_venues',
+					'ee_edit_private_venues',
+					'ee_delete_venue',
+					'ee_delete_venues',
+					'ee_delete_others_venues',
+					'ee_delete_private_venues',
+					'ee_delete_published_venues',
+					//venue categories
+					'ee_manage_venue_categories',
+					'ee_edit_venue_category',
+					'ee_delete_venue_category',
+					'ee_assign_venue_category',
+					//contacts
+					'ee_read_contacts',
+					'ee_edit_contacts',
+					'ee_delete_contacts',
+					//registrations
+					'ee_read_registrations',
+					'ee_read_others_registrations',
+					'ee_edit_registration',
+					'ee_edit_registrations',
+					'ee_edit_others_registrations',
+					'ee_delete_registration',
+					'ee_delete_registrations',
+					//checkins
+					'ee_read_others_checkins',
+					'ee_read_checkins',
+					'ee_edit_checkins',
+					'ee_edit_others_checkins',
+					'ee_delete_checkins',
+					'ee_delete_others_checkins',
+					//transactions && payments
+					'ee_read_transaction',
+					'ee_read_transactions',
+					'ee_edit_payments',
+					'ee_delete_payments',
+					//messages
+					'ee_read_messages',
+					'ee_read_others_messages',
+					'ee_read_global_messages',
+					'ee_edit_global_messages',
+					'ee_edit_messages',
+					'ee_edit_others_messages',
+					'ee_delete_messages',
+					'ee_delete_others_messages',
+					'ee_delete_global_messages',
+					'ee_send_message',
+					//tickets
+					'ee_read_default_tickets',
+					'ee_read_others_default_tickets',
+					'ee_edit_default_tickets',
+					'ee_edit_others_default_tickets',
+					'ee_delete_default_tickets',
+					'ee_delete_others_default_tickets',
+					//prices
+					'ee_edit_default_price',
+					'ee_edit_default_prices',
+					'ee_delete_default_price',
+					'ee_delete_default_prices',
+					'ee_edit_default_price_type',
+					'ee_edit_default_price_types',
+					'ee_delete_default_price_type',
+					'ee_delete_default_price_types',
+					'ee_read_default_prices',
+					'ee_read_default_price_types',
+					//registration form
+					'ee_edit_questions',
+					'ee_edit_system_questions',
+					'ee_read_questions',
+					'ee_delete_questions',
+					'ee_edit_question_groups',
+					'ee_read_question_groups',
+					'ee_edit_system_question_groups',
+					'ee_delete_question_groups',
+					//event_type taxonomy
+					'ee_assign_event_type',
+					'ee_manage_event_types',
+					'ee_edit_event_type',
+					'ee_delete_event_type',
+				)
+			)
+		);
+	}
+
+
+
+	/**
+	 * @return bool
+	 * @throws EE_Error
+	 */
+	private function setupCapabilitiesMap()
+	{
+		// if the initialization process hasn't even started, then we need to call init_caps()
+		if($this->initialized === null) {
+			return $this->init_caps();
+		}
+		// unless resetting, get caps from db if we haven't already
+		$this->capabilities_map = $this->reset || ! empty($this->capabilities_map)
+			? $this->capabilities_map
+			: get_option(self::option_name, array());
+		return true;
+	}
+
+
+
+	/**
+	 * @param bool $update
+	 * @return bool
+	 */
+	private function updateCapabilitiesMap($update = true)
+	{
+		return $update ? update_option(self::option_name, $this->capabilities_map) : false;
+	}
+
+
+
+	/**
+	 * Adds capabilities to roles.
+	 *
+	 * @since 4.9.42
+	 * @param array $capabilities_to_add array of capabilities to add, indexed by roles.
+	 *                                   Note that this should ONLY be called on activation hook
+	 *                                   otherwise the caps will be added on every request.
+	 * @return bool
+	 * @throws \EE_Error
+	 */
+	public function addCaps(array $capabilities_to_add)
+	{
+		// don't do anything if the capabilities map can not be initialized
+		if (! $this->setupCapabilitiesMap()) {
+			return false;
+		}
+		// and filter the array so others can get in on the fun during resets
+		$capabilities_to_add = apply_filters(
+			'FHEE__EE_Capabilities__addCaps__capabilities_to_add',
+			$capabilities_to_add,
+			$this->reset,
+			$this->capabilities_map
+		);
+		$update_capabilities_map = false;
+		// if not reset, see what caps are new for each role. if they're new, add them.
+		foreach ($capabilities_to_add as $role => $caps_for_role) {
+			if (is_array($caps_for_role)) {
+				foreach ($caps_for_role as $cap) {
+					if (
+						! $this->capHasBeenAddedToRole($role, $cap)
+						&& $this->add_cap_to_role($role, $cap, true, false)
+					) {
+						$update_capabilities_map = true;
+					}
+				}
+			}
+		}
+		// now let's just save the cap that has been set but only if there's been a change.
+		$updated = $this->updateCapabilitiesMap($update_capabilities_map);
+		$this->flushWpUser($updated);
+		do_action('AHEE__EE_Capabilities__addCaps__complete', $this->capabilities_map, $updated);
+		return $updated;
+	}
+
+
+
+	/**
+	 * Loops through the capabilities map and removes the role caps specified by the incoming array
+	 *
+	 * @param array $caps_map map of capabilities to be removed (indexed by roles)
+	 * @return bool
+	 * @throws \EE_Error
+	 */
+	public function removeCaps($caps_map)
+	{
+		// don't do anything if the capabilities map can not be initialized
+		if (! $this->setupCapabilitiesMap()) {
+			return false;
+		}
+		$update_capabilities_map = false;
+		foreach ($caps_map as $role => $caps_for_role) {
+			if (is_array($caps_for_role)) {
+				foreach ($caps_for_role as $cap) {
+					if ($this->capHasBeenAddedToRole($role, $cap)
+						&& $this->remove_cap_from_role($role, $cap, false)
+					) {
+						$update_capabilities_map = true;
+					}
+				}
+			}
+		}
+		// maybe resave the caps
+		$updated = $this->updateCapabilitiesMap($update_capabilities_map);
+		$this->flushWpUser($updated);
+		return $updated;
+	}
+
+
+	/**
+	 * This ensures that the WP User object cached on the $current_user global in WP has the latest capabilities from
+	 * the roles on that user.
+	 *
+	 * @param bool $flush  Default is to flush the WP_User object.  If false, then this method effectively does nothing.
+	 */
+	private function flushWpUser($flush = true)
+	{
+		if ($flush) {
+			$user = wp_get_current_user();
+			if ($user instanceof WP_User) {
+				$user->get_role_caps();
+			}
+		}
+	}
+
+
+
+	/**
+	 * This method sets a capability on a role.  Note this should only be done on activation, or if you have something
+	 * specific to prevent the cap from being added on every page load (adding caps are persistent to the db). Note.
+	 * this is a wrapper for $wp_role->add_cap()
+	 *
+	 * @see   wp-includes/capabilities.php
+	 * @since 4.5.0
+	 * @param string|WP_Role $role  A WordPress role the capability is being added to
+	 * @param string         $cap   The capability being added to the role
+	 * @param bool           $grant Whether to grant access to this cap on this role.
+	 * @param bool           $update_capabilities_map
+	 * @return bool
+	 * @throws \EE_Error
+	 */
+	public function add_cap_to_role($role, $cap, $grant = true, $update_capabilities_map = true)
+	{
+		// capture incoming value for $role because we may need it to create a new WP_Role
+		$orig_role = $role;
+		$role = $role instanceof WP_Role ? $role : get_role($role);
+		//if the role isn't available then we create it.
+		if (! $role instanceof WP_Role) {
+			// if a plugin wants to create a specific role name then they should create the role before
+			// EE_Capabilities does.  Otherwise this function will create the role name from the slug:
+			// - removes any `ee_` namespacing from the start of the slug.
+			// - replaces `_` with ` ` (empty space).
+			// - sentence case on the resulting string.
+			$role_label = ucwords(str_replace(array('ee_', '_'), array('', ' '), $orig_role));
+			$role = add_role($orig_role, $role_label);
+		}
+		if ($role instanceof WP_Role) {
+			// don't do anything if the capabilities map can not be initialized
+			if (! $this->setupCapabilitiesMap()) {
+				return false;
+			}
+			if (! $this->capHasBeenAddedToRole($role->name, $cap)) {
+				$role->add_cap($cap, $grant);
+				$this->capabilities_map[ $role->name ][] = $cap;
+				$this->updateCapabilitiesMap($update_capabilities_map);
+				return true;
+			}
+		}
+		return false;
+	}
+
+
+
+	/**
+	 * Functions similarly to add_cap_to_role except removes cap from given role.
+	 * Wrapper for $wp_role->remove_cap()
+	 *
+	 * @see   wp-includes/capabilities.php
+	 * @since 4.5.0
+	 * @param string|WP_Role $role A WordPress role the capability is being removed from.
+	 * @param string         $cap  The capability being removed
+	 * @param bool           $update_capabilities_map
+	 * @return bool
+	 * @throws \EE_Error
+	 */
+	public function remove_cap_from_role($role, $cap, $update_capabilities_map = true)
+	{
+		// don't do anything if the capabilities map can not be initialized
+		if (! $this->setupCapabilitiesMap()) {
+			return false;
+		}
+		$role = $role instanceof WP_Role ? $role :get_role($role);
+		if ($index = $this->capHasBeenAddedToRole($role->name, $cap, true)) {
+			$role->remove_cap($cap);
+			unset($this->capabilities_map[ $role->name ][ $index ]);
+			$this->updateCapabilitiesMap($update_capabilities_map);
+			return true;
+		}
+		return false;
+	}
+
+
+
+	/**
+	 * @param string $role_name
+	 * @param string $cap
+	 * @param bool   $get_index
+	 * @return bool|mixed
+	 */
+	private function capHasBeenAddedToRole($role_name='', $cap='', $get_index = false)
+	{
+		if (
+			isset($this->capabilities_map[$role_name])
+			&& ($index = array_search($cap, $this->capabilities_map[$role_name], true)) !== false
+		) {
+			return $get_index ? $index : true;
+		}
+		return false;
+	}
+
+
+
+	/**
+	 * Wrapper for the native WP current_user_can() method.
+	 * This is provided as a handy method for a couple things:
+	 * 1. Using the context string it allows for targeted filtering by addons for a specific check (without having to
+	 * write those filters wherever current_user_can is called).
+	 * 2. Explicit passing of $id from a given context ( useful in the cases of map_meta_cap filters )
+	 *
+	 * @since 4.5.0
+	 *
+	 * @param string $cap     The cap being checked.
+	 * @param string $context The context where the current_user_can is being called from.
+	 * @param int    $id      Optional. Id for item where current_user_can is being called from (used in map_meta_cap()
+	 *                        filters.
+	 *
+	 * @return bool  Whether user can or not.
+	 */
+	public function current_user_can($cap, $context, $id = 0)
+	{
+		//apply filters (both a global on just the cap, and context specific.  Global overrides context specific)
+		$filtered_cap = apply_filters('FHEE__EE_Capabilities__current_user_can__cap__' . $context, $cap, $id);
+		$filtered_cap = apply_filters(
+			'FHEE__EE_Capabilities__current_user_can__cap',
+			$filtered_cap,
+			$context,
+			$cap,
+			$id
+		);
+		return ! empty($id)
+			? current_user_can($filtered_cap, $id)
+			: current_user_can($filtered_cap);
+	}
+
+
+
+	/**
+	 * This is a wrapper for the WP user_can() function and follows the same style as the other wrappers in this class.
+	 *
+	 * @param int|WP_User $user    Either the user_id or a WP_User object
+	 * @param string      $cap     The capability string being checked
+	 * @param string      $context The context where the user_can is being called from (used in filters).
+	 * @param int         $id      Optional. Id for item where user_can is being called from ( used in map_meta_cap()
+	 *                             filters)
+	 *
+	 * @return bool Whether user can or not.
+	 */
+	public function user_can($user, $cap, $context, $id = 0)
+	{
+		//apply filters (both a global on just the cap, and context specific.  Global overrides context specific)
+		$filtered_cap = apply_filters('FHEE__EE_Capabilities__user_can__cap__' . $context, $cap, $user, $id);
+		$filtered_cap = apply_filters(
+			'FHEE__EE_Capabilities__user_can__cap',
+			$filtered_cap,
+			$context,
+			$cap,
+			$user,
+			$id
+		);
+		return ! empty($id)
+			? user_can($user, $filtered_cap, $id)
+			: user_can($user, $filtered_cap);
+	}
+
+
+
+	/**
+	 * Wrapper for the native WP current_user_can_for_blog() method.
+	 * This is provided as a handy method for a couple things:
+	 * 1. Using the context string it allows for targeted filtering by addons for a specific check (without having to
+	 * write those filters wherever current_user_can is called).
+	 * 2. Explicit passing of $id from a given context ( useful in the cases of map_meta_cap filters )
+	 *
+	 * @since 4.5.0
+	 *
+	 * @param int    $blog_id The blog id that is being checked for.
+	 * @param string $cap     The cap being checked.
+	 * @param string $context The context where the current_user_can is being called from.
+	 * @param int    $id      Optional. Id for item where current_user_can is being called from (used in map_meta_cap()
+	 *                        filters.
+	 *
+	 * @return bool  Whether user can or not.
+	 */
+	public function current_user_can_for_blog($blog_id, $cap, $context, $id = 0)
+	{
+		$user_can = ! empty($id)
+			? current_user_can_for_blog($blog_id, $cap, $id)
+			: current_user_can($blog_id, $cap);
+		//apply filters (both a global on just the cap, and context specific.  Global overrides context specific)
+		$user_can = apply_filters(
+			'FHEE__EE_Capabilities__current_user_can_for_blog__user_can__' . $context,
+			$user_can,
+			$blog_id,
+			$cap,
+			$id
+		);
+		$user_can = apply_filters(
+			'FHEE__EE_Capabilities__current_user_can_for_blog__user_can',
+			$user_can,
+			$context,
+			$blog_id,
+			$cap,
+			$id
+		);
+		return $user_can;
+	}
+
+
+
+	/**
+	 * This helper method just returns an array of registered EE capabilities.
+	 *
+	 * @since 4.5.0
+	 * @param string $role If empty then the entire role/capability map is returned.
+	 *                     Otherwise just the capabilities for the given role are returned.
+	 * @return array
+	 * @throws EE_Error
+	 */
+	public function get_ee_capabilities($role = 'administrator')
+	{
+		if (! $this->initialized) {
+			$this->init_caps();
+		}
+		if (empty($role)) {
+			return $this->capabilities_map;
+		}
+		return isset($this->capabilities_map[ $role ])
+			? $this->capabilities_map[ $role ]
+			: array();
+	}
+
+
+
+	/**
+	 * @deprecated 4.9.42
+	 * @param bool  $reset      If you need to reset Event Espresso's capabilities,
+	 *                          then please use the init_caps() method with the "$reset" parameter set to "true"
+	 * @param array $caps_map   Optional.
+	 *                          Can be used to send a custom map of roles and capabilities for setting them up.
+	 *                          Note that this should ONLY be called on activation hook or some other one-time
+	 *                          task otherwise the caps will be added on every request.
+	 * @return void
+	 * @throws EE_Error
+	 */
+	public function init_role_caps($reset = false, $caps_map = array())
+	{
+		// If this method is called directly and reset is set as 'true',
+		// then display a doing it wrong notice, because we want resets to go through init_caps()
+		// to guarantee that everything is set up correctly.
+		// This prevents the capabilities map getting reset incorrectly by direct calls to this method.
+		if ($reset) {
+			EE_Error::doing_it_wrong(
+				__METHOD__,
+				sprintf(
+					esc_html__(
+						'The "%1$s" parameter for the "%2$s" method is deprecated. If you need to reset Event Espresso\'s capabilities, then please use the "%3$s" method with the "%1$s" parameter set to "%4$s".',
+						'event_espresso'
+					),
+					'$reset',
+					__METHOD__ . '()',
+					'EE_Capabilities::init_caps()',
+					'true'
+				),
+				'4.9.42',
+				'5.0.0'
+			);
+		}
+		$this->addCaps($caps_map);
+	}
 
 
 
@@ -1032,142 +1032,142 @@ 
 abstract class EE_Meta_Capability_Map
 {
 
-    public $meta_cap;
-
-    /**
-     * @var EEM_Base
-     */
-    protected $_model;
-
-    protected $_model_name;
-
-    public $published_cap = '';
-
-    public $others_cap = '';
-
-    public $private_cap = '';
-
-
-    /**
-     * constructor.
-     * Receives the setup arguments for the map.
-     *
-     * @since                        4.5.0
-     *
-     * @param string $meta_cap   What meta capability is this mapping.
-     * @param array  $map_values array {
-     *                           //array of values that MUST match a count of 4.  It's okay to send an empty string for
-     *                           capabilities that don't get mapped to.
-     *
-     * @type         $map_values [0] string A string representing the model name. Required.  String's
-     *                               should always be used when Menu Maps are registered via the
-     *                               plugin API as models are not allowed to be instantiated when
-     *                               in maintenance mode 2 (migrations).
-     * @type         $map_values [1] string represents the capability used for published. Optional.
-     * @type         $map_values [2] string represents the capability used for "others". Optional.
-     * @type         $map_values [3] string represents the capability used for private. Optional.
-     *                               }
-     * @throws EE_Error
-     */
-    public function __construct($meta_cap, $map_values)
-    {
-        $this->meta_cap = $meta_cap;
-        //verify there are four args in the $map_values array;
-        if (count($map_values) !== 4) {
-            throw new EE_Error(
-                sprintf(
-                    __(
-                        'Incoming $map_values array should have a count of four values in it.  This is what was given: %s',
-                        'event_espresso'
-                    ),
-                    '<br>' . print_r($map_values, true)
-                )
-            );
-        }
-        //set properties
-        $this->_model = null;
-        $this->_model_name = $map_values[0];
-        $this->published_cap = (string)$map_values[1];
-        $this->others_cap = (string)$map_values[2];
-        $this->private_cap = (string)$map_values[3];
-    }
-
-    /**
-     * Makes it so this object stops filtering caps
-     */
-    public function remove_filters()
-    {
-        remove_filter('map_meta_cap', array($this, 'map_meta_caps'), 10);
-    }
-
-
-    /**
-     * This method ensures that the $model property is converted from the model name string to a proper EEM_Base class
-     *
-     * @since 4.5.0
-     * @throws EE_Error
-     *
-     * @return void
-     */
-    public function ensure_is_model()
-    {
-        //is it already instantiated?
-        if ($this->_model instanceof EEM_Base) {
-            return;
-        }
-        //ensure model name is string
-        $this->_model_name = (string)$this->_model_name;
-        //error proof if the name has EEM in it
-        $this->_model_name = str_replace('EEM', '', $this->_model_name);
-        $this->_model = EE_Registry::instance()->load_model($this->_model_name);
-        if (! $this->_model instanceof EEM_Base) {
-            throw new EE_Error(
-                sprintf(
-                    __(
-                        'This string passed in to %s to represent a EEM_Base model class was not able to be used to instantiate the class.   Please ensure that the string is a match for the EEM_Base model name (not including the EEM_ part). This was given: %s',
-                        'event_espresso'
-                    ),
-                    get_class($this),
-                    $this->_model
-                )
-            );
-        }
-    }
-
-
-    /**
-     *
-     * @see   EE_Meta_Capability_Map::_map_meta_caps() for docs on params.
-     * @since 4.6.x
-     *
-     * @param $caps
-     * @param $cap
-     * @param $user_id
-     * @param $args
-     *
-     * @return array
-     */
-    public function map_meta_caps($caps, $cap, $user_id, $args)
-    {
-        return $this->_map_meta_caps($caps, $cap, $user_id, $args);
-    }
-
-
-    /**
-     * This is the callback for the wp map_meta_caps() function which allows for ensuring certain caps that act as a
-     * "meta" for other caps ( i.e. ee_edit_event is a meta for ee_edit_others_events ) work as expected.
-     *
-     * @since 4.5.0
-     * @see   wp-includes/capabilities.php
-     *
-     * @param array  $caps    actual users capabilities
-     * @param string $cap     initial capability name that is being checked (the "map" key)
-     * @param int    $user_id The user id
-     * @param array  $args    Adds context to the cap. Typically the object ID.
-     *
-     * @return array   actual users capabilities
-     */
-    abstract protected function _map_meta_caps($caps, $cap, $user_id, $args);
+	public $meta_cap;
+
+	/**
+	 * @var EEM_Base
+	 */
+	protected $_model;
+
+	protected $_model_name;
+
+	public $published_cap = '';
+
+	public $others_cap = '';
+
+	public $private_cap = '';
+
+
+	/**
+	 * constructor.
+	 * Receives the setup arguments for the map.
+	 *
+	 * @since                        4.5.0
+	 *
+	 * @param string $meta_cap   What meta capability is this mapping.
+	 * @param array  $map_values array {
+	 *                           //array of values that MUST match a count of 4.  It's okay to send an empty string for
+	 *                           capabilities that don't get mapped to.
+	 *
+	 * @type         $map_values [0] string A string representing the model name. Required.  String's
+	 *                               should always be used when Menu Maps are registered via the
+	 *                               plugin API as models are not allowed to be instantiated when
+	 *                               in maintenance mode 2 (migrations).
+	 * @type         $map_values [1] string represents the capability used for published. Optional.
+	 * @type         $map_values [2] string represents the capability used for "others". Optional.
+	 * @type         $map_values [3] string represents the capability used for private. Optional.
+	 *                               }
+	 * @throws EE_Error
+	 */
+	public function __construct($meta_cap, $map_values)
+	{
+		$this->meta_cap = $meta_cap;
+		//verify there are four args in the $map_values array;
+		if (count($map_values) !== 4) {
+			throw new EE_Error(
+				sprintf(
+					__(
+						'Incoming $map_values array should have a count of four values in it.  This is what was given: %s',
+						'event_espresso'
+					),
+					'<br>' . print_r($map_values, true)
+				)
+			);
+		}
+		//set properties
+		$this->_model = null;
+		$this->_model_name = $map_values[0];
+		$this->published_cap = (string)$map_values[1];
+		$this->others_cap = (string)$map_values[2];
+		$this->private_cap = (string)$map_values[3];
+	}
+
+	/**
+	 * Makes it so this object stops filtering caps
+	 */
+	public function remove_filters()
+	{
+		remove_filter('map_meta_cap', array($this, 'map_meta_caps'), 10);
+	}
+
+
+	/**
+	 * This method ensures that the $model property is converted from the model name string to a proper EEM_Base class
+	 *
+	 * @since 4.5.0
+	 * @throws EE_Error
+	 *
+	 * @return void
+	 */
+	public function ensure_is_model()
+	{
+		//is it already instantiated?
+		if ($this->_model instanceof EEM_Base) {
+			return;
+		}
+		//ensure model name is string
+		$this->_model_name = (string)$this->_model_name;
+		//error proof if the name has EEM in it
+		$this->_model_name = str_replace('EEM', '', $this->_model_name);
+		$this->_model = EE_Registry::instance()->load_model($this->_model_name);
+		if (! $this->_model instanceof EEM_Base) {
+			throw new EE_Error(
+				sprintf(
+					__(
+						'This string passed in to %s to represent a EEM_Base model class was not able to be used to instantiate the class.   Please ensure that the string is a match for the EEM_Base model name (not including the EEM_ part). This was given: %s',
+						'event_espresso'
+					),
+					get_class($this),
+					$this->_model
+				)
+			);
+		}
+	}
+
+
+	/**
+	 *
+	 * @see   EE_Meta_Capability_Map::_map_meta_caps() for docs on params.
+	 * @since 4.6.x
+	 *
+	 * @param $caps
+	 * @param $cap
+	 * @param $user_id
+	 * @param $args
+	 *
+	 * @return array
+	 */
+	public function map_meta_caps($caps, $cap, $user_id, $args)
+	{
+		return $this->_map_meta_caps($caps, $cap, $user_id, $args);
+	}
+
+
+	/**
+	 * This is the callback for the wp map_meta_caps() function which allows for ensuring certain caps that act as a
+	 * "meta" for other caps ( i.e. ee_edit_event is a meta for ee_edit_others_events ) work as expected.
+	 *
+	 * @since 4.5.0
+	 * @see   wp-includes/capabilities.php
+	 *
+	 * @param array  $caps    actual users capabilities
+	 * @param string $cap     initial capability name that is being checked (the "map" key)
+	 * @param int    $user_id The user id
+	 * @param array  $args    Adds context to the cap. Typically the object ID.
+	 *
+	 * @return array   actual users capabilities
+	 */
+	abstract protected function _map_meta_caps($caps, $cap, $user_id, $args);
 }
 
 
@@ -1183,81 +1183,81 @@ 
 class EE_Meta_Capability_Map_Edit extends EE_Meta_Capability_Map
 {
 
-    /**
-     * This is the callback for the wp map_meta_caps() function which allows for ensuring certain caps that act as a
-     * "meta" for other caps ( i.e. ee_edit_event is a meta for ee_edit_others_events ) work as expected.
-     *
-     * @since 4.5.0
-     * @see   wp-includes/capabilities.php
-     *
-     * @param array  $caps    actual users capabilities
-     * @param string $cap     initial capability name that is being checked (the "map" key)
-     * @param int    $user_id The user id
-     * @param array  $args    Adds context to the cap. Typically the object ID.
-     *
-     * @return array   actual users capabilities
-     */
-    protected function _map_meta_caps($caps, $cap, $user_id, $args)
-    {
-        //only process if we're checking our mapped_cap
-        if ($cap !== $this->meta_cap) {
-            return $caps;
-        }
-
-        //okay it is a meta cap so let's first remove that cap from the $caps array.
-        if (($key = array_search($cap, $caps)) !== false) {
-            unset($caps[$key]);
-        }
-
-        //cast $user_id to int for later explicit comparisons
-        $user_id = (int) $user_id;
-
-        /** @var EE_Base_Class $obj */
-        $obj = ! empty($args[0]) ? $this->_model->get_one_by_ID($args[0]) : null;
-        //if no obj then let's just do cap
-        if (! $obj instanceof EE_Base_Class) {
-            $caps[] = 'do_not_allow';
-            return $caps;
-        }
-        $caps[] = $cap . 's';
-        if ($obj instanceof EE_CPT_Base) {
-            //if the item author is set and the user is the author...
-            if ($obj->wp_user() && $user_id === $obj->wp_user()) {
-                //if obj is published...
-                if ($obj->status() === 'publish') {
-                    $caps[] = $this->published_cap;
-                }
-            } else {
-                //the user is trying to edit someone else's obj
-                if (! empty($this->others_cap)) {
-                    $caps[] = $this->others_cap;
-                }
-                if (! empty($this->published_cap) && $obj->status() === 'publish') {
-                    $caps[] = $this->published_cap;
-                } elseif (! empty($this->private_cap) && $obj->status() === 'private') {
-                    $caps[] = $this->private_cap;
-                }
-            }
-        } else {
-            //not a cpt object so handled differently
-            $has_cap = false;
-            try {
-                $has_cap = method_exists($obj, 'wp_user')
-                    && $obj->wp_user()
-                    && $obj->wp_user() === $user_id;
-            } catch (Exception $e) {
-                if (WP_DEBUG) {
-                    EE_Error::add_error($e->getMessage(), __FILE__, __FUNCTION__, __LINE__);
-                }
-            }
-            if (! $has_cap) {
-                if (! empty($this->others_cap)) {
-                    $caps[] = $this->others_cap;
-                }
-            }
-        }
-        return $caps;
-    }
+	/**
+	 * This is the callback for the wp map_meta_caps() function which allows for ensuring certain caps that act as a
+	 * "meta" for other caps ( i.e. ee_edit_event is a meta for ee_edit_others_events ) work as expected.
+	 *
+	 * @since 4.5.0
+	 * @see   wp-includes/capabilities.php
+	 *
+	 * @param array  $caps    actual users capabilities
+	 * @param string $cap     initial capability name that is being checked (the "map" key)
+	 * @param int    $user_id The user id
+	 * @param array  $args    Adds context to the cap. Typically the object ID.
+	 *
+	 * @return array   actual users capabilities
+	 */
+	protected function _map_meta_caps($caps, $cap, $user_id, $args)
+	{
+		//only process if we're checking our mapped_cap
+		if ($cap !== $this->meta_cap) {
+			return $caps;
+		}
+
+		//okay it is a meta cap so let's first remove that cap from the $caps array.
+		if (($key = array_search($cap, $caps)) !== false) {
+			unset($caps[$key]);
+		}
+
+		//cast $user_id to int for later explicit comparisons
+		$user_id = (int) $user_id;
+
+		/** @var EE_Base_Class $obj */
+		$obj = ! empty($args[0]) ? $this->_model->get_one_by_ID($args[0]) : null;
+		//if no obj then let's just do cap
+		if (! $obj instanceof EE_Base_Class) {
+			$caps[] = 'do_not_allow';
+			return $caps;
+		}
+		$caps[] = $cap . 's';
+		if ($obj instanceof EE_CPT_Base) {
+			//if the item author is set and the user is the author...
+			if ($obj->wp_user() && $user_id === $obj->wp_user()) {
+				//if obj is published...
+				if ($obj->status() === 'publish') {
+					$caps[] = $this->published_cap;
+				}
+			} else {
+				//the user is trying to edit someone else's obj
+				if (! empty($this->others_cap)) {
+					$caps[] = $this->others_cap;
+				}
+				if (! empty($this->published_cap) && $obj->status() === 'publish') {
+					$caps[] = $this->published_cap;
+				} elseif (! empty($this->private_cap) && $obj->status() === 'private') {
+					$caps[] = $this->private_cap;
+				}
+			}
+		} else {
+			//not a cpt object so handled differently
+			$has_cap = false;
+			try {
+				$has_cap = method_exists($obj, 'wp_user')
+					&& $obj->wp_user()
+					&& $obj->wp_user() === $user_id;
+			} catch (Exception $e) {
+				if (WP_DEBUG) {
+					EE_Error::add_error($e->getMessage(), __FILE__, __FUNCTION__, __LINE__);
+				}
+			}
+			if (! $has_cap) {
+				if (! empty($this->others_cap)) {
+					$caps[] = $this->others_cap;
+				}
+			}
+		}
+		return $caps;
+	}
 }
 
 
@@ -1274,24 +1274,24 @@ 
 class EE_Meta_Capability_Map_Delete extends EE_Meta_Capability_Map_Edit
 {
 
-    /**
-     * This is the callback for the wp map_meta_caps() function which allows for ensuring certain caps that act as a
-     * "meta" for other caps ( i.e. ee_edit_event is a meta for ee_edit_others_events ) work as expected.
-     *
-     * @since 4.5.0
-     * @see   wp-includes/capabilities.php
-     *
-     * @param array  $caps    actual users capabilities
-     * @param string $cap     initial capability name that is being checked (the "map" key)
-     * @param int    $user_id The user id
-     * @param array  $args    Adds context to the cap. Typically the object ID.
-     *
-     * @return array   actual users capabilities
-     */
-    protected function _map_meta_caps($caps, $cap, $user_id, $args)
-    {
-        return parent::_map_meta_caps($caps, $cap, $user_id, $args);
-    }
+	/**
+	 * This is the callback for the wp map_meta_caps() function which allows for ensuring certain caps that act as a
+	 * "meta" for other caps ( i.e. ee_edit_event is a meta for ee_edit_others_events ) work as expected.
+	 *
+	 * @since 4.5.0
+	 * @see   wp-includes/capabilities.php
+	 *
+	 * @param array  $caps    actual users capabilities
+	 * @param string $cap     initial capability name that is being checked (the "map" key)
+	 * @param int    $user_id The user id
+	 * @param array  $args    Adds context to the cap. Typically the object ID.
+	 *
+	 * @return array   actual users capabilities
+	 */
+	protected function _map_meta_caps($caps, $cap, $user_id, $args)
+	{
+		return parent::_map_meta_caps($caps, $cap, $user_id, $args);
+	}
 }
 
 
@@ -1307,85 +1307,85 @@ 
 class EE_Meta_Capability_Map_Read extends EE_Meta_Capability_Map
 {
 
-    /**
-     * This is the callback for the wp map_meta_caps() function which allows for ensuring certain caps that act as a
-     * "meta" for other caps ( i.e. ee_edit_event is a meta for ee_edit_others_events ) work as expected.
-     *
-     * @since 4.5.0
-     * @see   wp-includes/capabilities.php
-     *
-     * @param array  $caps    actual users capabilities
-     * @param string $cap     initial capability name that is being checked (the "map" key)
-     * @param int    $user_id The user id
-     * @param array  $args    Adds context to the cap. Typically the object ID.
-     *
-     * @return array   actual users capabilities
-     */
-    protected function _map_meta_caps($caps, $cap, $user_id, $args)
-    {
-        //only process if we're checking our mapped cap;
-        if ($cap !== $this->meta_cap) {
-            return $caps;
-        }
-
-        //okay it is a meta cap so let's first remove that cap from the $caps array.
-        if (($key = array_search($cap, $caps)) !== false) {
-            unset($caps[$key]);
-        }
-
-        //cast $user_id to int for later explicit comparisons
-        $user_id = (int) $user_id;
-
-        $obj = ! empty($args[0]) ? $this->_model->get_one_by_ID($args[0]) : null;
-        //if no obj then let's just do cap
-        if (! $obj instanceof EE_Base_Class) {
-            $caps[] = 'do_not_allow';
-            return $caps;
-        }
-
-        $caps[] = $cap . 's';
-        if ($obj instanceof EE_CPT_Base) {
-            $status_obj = get_post_status_object($obj->status());
-            if ($status_obj->public) {
-                return $caps;
-            }
-            //if the item author is set and the user is not the author...
-            if ($obj->wp_user() && $obj->wp_user() !== $user_id) {
-                if (! empty($this->others_cap)) {
-                    $caps[] = $this->others_cap;
-                }
-            }
-            //yes this means that if users created the private post, they are able to see it regardless of private cap.
-            if ($status_obj->private
-                && ! empty($this->private_cap)
-                && $obj->wp_user() !== $user_id
-            ) {
-                //the user is trying to view a private object for an object they don't own.
-                $caps[] = $this->private_cap;
-            }
-        } else {
-            //not a cpt object so handled differently
-            $has_cap = false;
-            try {
-                $has_cap = method_exists($obj, 'wp_user')
-                           && $obj->wp_user()
-                           && $obj->wp_user() === $user_id;
-            } catch (Exception $e) {
-                if (WP_DEBUG) {
-                    EE_Error::add_error($e->getMessage(), __FILE__, __FUNCTION__, __LINE__);
-                }
-            }
-            if (! $has_cap) {
-                if (! empty($this->private_cap)) {
-                    $caps[] = $this->private_cap;
-                }
-                if (! empty($this->others_cap)) {
-                    $caps[] = $this->others_cap;
-                }
-            }
-        }
-        return $caps;
-    }
+	/**
+	 * This is the callback for the wp map_meta_caps() function which allows for ensuring certain caps that act as a
+	 * "meta" for other caps ( i.e. ee_edit_event is a meta for ee_edit_others_events ) work as expected.
+	 *
+	 * @since 4.5.0
+	 * @see   wp-includes/capabilities.php
+	 *
+	 * @param array  $caps    actual users capabilities
+	 * @param string $cap     initial capability name that is being checked (the "map" key)
+	 * @param int    $user_id The user id
+	 * @param array  $args    Adds context to the cap. Typically the object ID.
+	 *
+	 * @return array   actual users capabilities
+	 */
+	protected function _map_meta_caps($caps, $cap, $user_id, $args)
+	{
+		//only process if we're checking our mapped cap;
+		if ($cap !== $this->meta_cap) {
+			return $caps;
+		}
+
+		//okay it is a meta cap so let's first remove that cap from the $caps array.
+		if (($key = array_search($cap, $caps)) !== false) {
+			unset($caps[$key]);
+		}
+
+		//cast $user_id to int for later explicit comparisons
+		$user_id = (int) $user_id;
+
+		$obj = ! empty($args[0]) ? $this->_model->get_one_by_ID($args[0]) : null;
+		//if no obj then let's just do cap
+		if (! $obj instanceof EE_Base_Class) {
+			$caps[] = 'do_not_allow';
+			return $caps;
+		}
+
+		$caps[] = $cap . 's';
+		if ($obj instanceof EE_CPT_Base) {
+			$status_obj = get_post_status_object($obj->status());
+			if ($status_obj->public) {
+				return $caps;
+			}
+			//if the item author is set and the user is not the author...
+			if ($obj->wp_user() && $obj->wp_user() !== $user_id) {
+				if (! empty($this->others_cap)) {
+					$caps[] = $this->others_cap;
+				}
+			}
+			//yes this means that if users created the private post, they are able to see it regardless of private cap.
+			if ($status_obj->private
+				&& ! empty($this->private_cap)
+				&& $obj->wp_user() !== $user_id
+			) {
+				//the user is trying to view a private object for an object they don't own.
+				$caps[] = $this->private_cap;
+			}
+		} else {
+			//not a cpt object so handled differently
+			$has_cap = false;
+			try {
+				$has_cap = method_exists($obj, 'wp_user')
+						   && $obj->wp_user()
+						   && $obj->wp_user() === $user_id;
+			} catch (Exception $e) {
+				if (WP_DEBUG) {
+					EE_Error::add_error($e->getMessage(), __FILE__, __FUNCTION__, __LINE__);
+				}
+			}
+			if (! $has_cap) {
+				if (! empty($this->private_cap)) {
+					$caps[] = $this->private_cap;
+				}
+				if (! empty($this->others_cap)) {
+					$caps[] = $this->others_cap;
+				}
+			}
+		}
+		return $caps;
+	}
 }
 
 
@@ -1402,56 +1402,56 @@ 
 class EE_Meta_Capability_Map_Messages_Cap extends EE_Meta_Capability_Map
 {
 
-    /**
-     * This is the callback for the wp map_meta_caps() function which allows for ensuring certain caps that act as a
-     * "meta" for other caps ( i.e. ee_edit_event is a meta for ee_edit_others_events ) work as expected.
-     *
-     * @since 4.5.0
-     * @see   wp-includes/capabilities.php
-     *
-     * @param array  $caps    actual users capabilities
-     * @param string $cap     initial capability name that is being checked (the "map" key)
-     * @param int    $user_id The user id
-     * @param array  $args    Adds context to the cap. Typically the object ID.
-     *
-     * @return array   actual users capabilities
-     */
-    protected function _map_meta_caps($caps, $cap, $user_id, $args)
-    {
-        //only process if we're checking our mapped_cap
-        if ($cap !== $this->meta_cap) {
-            return $caps;
-        }
-
-        //okay it is a meta cap so let's first remove that cap from the $caps array.
-        if (($key = array_search($cap, $caps)) !== false) {
-            unset($caps[$key]);
-        }
-
-        //cast $user_id to int for later explicit comparisons
-        $user_id = (int) $user_id;
-
-        $obj = ! empty($args[0]) ? $this->_model->get_one_by_ID($args[0]) : null;
-        //if no obj then let's just do cap
-        if (! $obj instanceof EE_Message_Template_Group) {
-            $caps[] = 'do_not_allow';
-            return $caps;
-        }
-        $caps[] = $cap . 's';
-        $is_global = $obj->is_global();
-        if ($obj->wp_user() && $obj->wp_user() === $user_id) {
-            if ($is_global) {
-                $caps[] = $this->private_cap;
-            }
-        } else {
-            if ($is_global) {
-                $caps[] = $this->private_cap;
-            } else {
-                $caps[] = $this->others_cap;
-            }
-        }
-        return $caps;
-    }
+	/**
+	 * This is the callback for the wp map_meta_caps() function which allows for ensuring certain caps that act as a
+	 * "meta" for other caps ( i.e. ee_edit_event is a meta for ee_edit_others_events ) work as expected.
+	 *
+	 * @since 4.5.0
+	 * @see   wp-includes/capabilities.php
+	 *
+	 * @param array  $caps    actual users capabilities
+	 * @param string $cap     initial capability name that is being checked (the "map" key)
+	 * @param int    $user_id The user id
+	 * @param array  $args    Adds context to the cap. Typically the object ID.
+	 *
+	 * @return array   actual users capabilities
+	 */
+	protected function _map_meta_caps($caps, $cap, $user_id, $args)
+	{
+		//only process if we're checking our mapped_cap
+		if ($cap !== $this->meta_cap) {
+			return $caps;
+		}
+
+		//okay it is a meta cap so let's first remove that cap from the $caps array.
+		if (($key = array_search($cap, $caps)) !== false) {
+			unset($caps[$key]);
+		}
+
+		//cast $user_id to int for later explicit comparisons
+		$user_id = (int) $user_id;
+
+		$obj = ! empty($args[0]) ? $this->_model->get_one_by_ID($args[0]) : null;
+		//if no obj then let's just do cap
+		if (! $obj instanceof EE_Message_Template_Group) {
+			$caps[] = 'do_not_allow';
+			return $caps;
+		}
+		$caps[] = $cap . 's';
+		$is_global = $obj->is_global();
+		if ($obj->wp_user() && $obj->wp_user() === $user_id) {
+			if ($is_global) {
+				$caps[] = $this->private_cap;
+			}
+		} else {
+			if ($is_global) {
+				$caps[] = $this->private_cap;
+			} else {
+				$caps[] = $this->others_cap;
+			}
+		}
+		return $caps;
+	}
 }
 
 
@@ -1468,40 +1468,40 @@ 
 class EE_Meta_Capability_Map_Registration_Form_Cap extends EE_Meta_Capability_Map
 {
 
-    /**
-     * This is the callback for the wp map_meta_caps() function which allows for ensuring certain caps that act as a
-     * "meta" for other caps ( i.e. ee_edit_event is a meta for ee_edit_others_events ) work as expected.
-     *
-     * @since 4.5.0
-     * @see   wp-includes/capabilities.php
-     * @param array  $caps    actual users capabilities
-     * @param string $cap     initial capability name that is being checked (the "map" key)
-     * @param int    $user_id The user id
-     * @param array  $args    Adds context to the cap. Typically the object ID.
-     * @return array   actual users capabilities
-     */
-    protected function _map_meta_caps($caps, $cap, $user_id, $args)
-    {
-        //only process if we're checking our mapped_cap
-        if ($cap !== $this->meta_cap) {
-            return $caps;
-        }
-        //okay it is a meta cap so let's first remove that cap from the $caps array.
-        if (($key = array_search($cap, $caps)) !== false) {
-            unset($caps[$key]);
-        }
-        $obj = ! empty($args[0]) ? $this->_model->get_one_by_ID($args[0]) : null;
-        //if no obj then let's just do cap
-        if (! $obj instanceof EE_Base_Class) {
-            $caps[] = 'do_not_allow';
-            return $caps;
-        }
-        $caps[]    = $cap . 's';
-        $is_system = $obj instanceof EE_Question_Group ? $obj->system_group() : false;
-        $is_system = $obj instanceof EE_Question ? $obj->is_system_question() : $is_system;
-        if ($is_system) {
-            $caps[] = $this->private_cap;
-        }
-        return $caps;
-    }
+	/**
+	 * This is the callback for the wp map_meta_caps() function which allows for ensuring certain caps that act as a
+	 * "meta" for other caps ( i.e. ee_edit_event is a meta for ee_edit_others_events ) work as expected.
+	 *
+	 * @since 4.5.0
+	 * @see   wp-includes/capabilities.php
+	 * @param array  $caps    actual users capabilities
+	 * @param string $cap     initial capability name that is being checked (the "map" key)
+	 * @param int    $user_id The user id
+	 * @param array  $args    Adds context to the cap. Typically the object ID.
+	 * @return array   actual users capabilities
+	 */
+	protected function _map_meta_caps($caps, $cap, $user_id, $args)
+	{
+		//only process if we're checking our mapped_cap
+		if ($cap !== $this->meta_cap) {
+			return $caps;
+		}
+		//okay it is a meta cap so let's first remove that cap from the $caps array.
+		if (($key = array_search($cap, $caps)) !== false) {
+			unset($caps[$key]);
+		}
+		$obj = ! empty($args[0]) ? $this->_model->get_one_by_ID($args[0]) : null;
+		//if no obj then let's just do cap
+		if (! $obj instanceof EE_Base_Class) {
+			$caps[] = 'do_not_allow';
+			return $caps;
+		}
+		$caps[]    = $cap . 's';
+		$is_system = $obj instanceof EE_Question_Group ? $obj->system_group() : false;
+		$is_system = $obj instanceof EE_Question ? $obj->is_system_question() : $is_system;
+		if ($is_system) {
+			$caps[] = $this->private_cap;
+		}
+		return $caps;
+	}
 }

core/services/loaders/Loader.php

Indentation +97 added lines, -97 removed lines

@@ -22,103 +22,103 @@
 {
 
 
-    /**
-     * @var LoaderDecoratorInterface $new_loader
-     */
-    private $new_loader;
-
-
-    /**
-     * @var LoaderDecoratorInterface $shared_loader
-     */
-    private $shared_loader;
-
-
-
-    /**
-     * Loader constructor.
-     *
-     * @param LoaderDecoratorInterface|null $new_loader
-     * @param LoaderDecoratorInterface|null $shared_loader
-     * @throws InvalidInterfaceException
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     */
-    public function __construct(LoaderDecoratorInterface $new_loader, LoaderDecoratorInterface $shared_loader)
-    {
-        $this->new_loader = $new_loader;
-        $this->shared_loader = $shared_loader;
-    }
-
-
-
-    /**
-     * @return LoaderDecoratorInterface
-     */
-    public function getNewLoader()
-    {
-        return $this->new_loader;
-    }
-
-
-
-    /**
-     * @return LoaderDecoratorInterface
-     */
-    public function getSharedLoader()
-    {
-        return $this->shared_loader;
-    }
-
-
-
-    /**
-     * @param string $fqcn
-     * @param array  $arguments
-     * @param bool   $shared
-     * @return mixed
-     */
-    public function load($fqcn, $arguments = array(), $shared = true)
-    {
-        return $shared
-            ? $this->getSharedLoader()->load($fqcn, $arguments, $shared)
-            : $this->getNewLoader()->load($fqcn, $arguments, $shared);
-    }
-
-
-
-    /**
-     * @param string $fqcn
-     * @param array  $arguments
-     * @return mixed
-     */
-    public function getNew($fqcn, $arguments = array())
-    {
-        return $this->getNewLoader()->load($fqcn, $arguments, false);
-    }
-
-
-
-    /**
-     * @param string $fqcn
-     * @param array  $arguments
-     * @return mixed
-     */
-    public function getShared($fqcn, $arguments = array())
-    {
-        return $this->getSharedLoader()->load($fqcn, $arguments, true);
-    }
-
-
-
-    /**
-     * calls reset() on loaders if that method exists
-     */
-    public function reset()
-    {
-        $this->new_loader->reset();
-        $this->shared_loader->reset();
-    }
+	/**
+	 * @var LoaderDecoratorInterface $new_loader
+	 */
+	private $new_loader;
+
+
+	/**
+	 * @var LoaderDecoratorInterface $shared_loader
+	 */
+	private $shared_loader;
+
+
+
+	/**
+	 * Loader constructor.
+	 *
+	 * @param LoaderDecoratorInterface|null $new_loader
+	 * @param LoaderDecoratorInterface|null $shared_loader
+	 * @throws InvalidInterfaceException
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 */
+	public function __construct(LoaderDecoratorInterface $new_loader, LoaderDecoratorInterface $shared_loader)
+	{
+		$this->new_loader = $new_loader;
+		$this->shared_loader = $shared_loader;
+	}
+
+
+
+	/**
+	 * @return LoaderDecoratorInterface
+	 */
+	public function getNewLoader()
+	{
+		return $this->new_loader;
+	}
+
+
+
+	/**
+	 * @return LoaderDecoratorInterface
+	 */
+	public function getSharedLoader()
+	{
+		return $this->shared_loader;
+	}
+
+
+
+	/**
+	 * @param string $fqcn
+	 * @param array  $arguments
+	 * @param bool   $shared
+	 * @return mixed
+	 */
+	public function load($fqcn, $arguments = array(), $shared = true)
+	{
+		return $shared
+			? $this->getSharedLoader()->load($fqcn, $arguments, $shared)
+			: $this->getNewLoader()->load($fqcn, $arguments, $shared);
+	}
+
+
+
+	/**
+	 * @param string $fqcn
+	 * @param array  $arguments
+	 * @return mixed
+	 */
+	public function getNew($fqcn, $arguments = array())
+	{
+		return $this->getNewLoader()->load($fqcn, $arguments, false);
+	}
+
+
+
+	/**
+	 * @param string $fqcn
+	 * @param array  $arguments
+	 * @return mixed
+	 */
+	public function getShared($fqcn, $arguments = array())
+	{
+		return $this->getSharedLoader()->load($fqcn, $arguments, true);
+	}
+
+
+
+	/**
+	 * calls reset() on loaders if that method exists
+	 */
+	public function reset()
+	{
+		$this->new_loader->reset();
+		$this->shared_loader->reset();
+	}
 
 }
 // End of file Loader.php

core/services/loaders/CoreLoader.php

Indentation +61 added lines, -61 removed lines

@@ -26,67 +26,67 @@
 class CoreLoader implements LoaderDecoratorInterface
 {
 
-    /**
-     * @var EE_Registry|CoffeeShop $generator
-     */
-    private $generator;
-
-
-
-    /**
-     * CoreLoader constructor.
-     *
-     * @param EE_Registry|CoffeeShop $generator
-     * @throws InvalidArgumentException
-     */
-    public function __construct($generator)
-    {
-        if(!($generator instanceof EE_Registry || $generator instanceof CoffeeShop)) {
-            throw new InvalidArgumentException(
-                esc_html__(
-                    'The CoreLoader class must receive an instance of EE_Registry or the CoffeeShop DI container.',
-                    'event_espresso'
-                )
-            );
-        }
-        $this->generator = $generator;
-    }
-
-
-
-    /**
-     * @param string $fqcn
-     * @param array  $arguments
-     * @param bool   $shared
-     * @return mixed
-     * @throws EE_Error
-     * @throws ServiceNotFoundException
-     * @throws ReflectionException
-     */
-    public function load($fqcn, $arguments = array(), $shared = true)
-    {
-        if($this->generator instanceof EE_Registry) {
-            return $this->generator->create($fqcn, $arguments, $shared);
-        }
-        $shared = $shared ? CoffeeMaker::BREW_SHARED : CoffeeMaker::BREW_NEW;
-        return $this->generator->brew($fqcn, $arguments, $shared);
-
-    }
-
-
-
-    /**
-     * calls reset() on generator if method exists
-     *
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    public function reset()
-    {
-        if (method_exists($this->generator, 'reset')) {
-            $this->generator->reset();
-        }
-    }
+	/**
+	 * @var EE_Registry|CoffeeShop $generator
+	 */
+	private $generator;
+
+
+
+	/**
+	 * CoreLoader constructor.
+	 *
+	 * @param EE_Registry|CoffeeShop $generator
+	 * @throws InvalidArgumentException
+	 */
+	public function __construct($generator)
+	{
+		if(!($generator instanceof EE_Registry || $generator instanceof CoffeeShop)) {
+			throw new InvalidArgumentException(
+				esc_html__(
+					'The CoreLoader class must receive an instance of EE_Registry or the CoffeeShop DI container.',
+					'event_espresso'
+				)
+			);
+		}
+		$this->generator = $generator;
+	}
+
+
+
+	/**
+	 * @param string $fqcn
+	 * @param array  $arguments
+	 * @param bool   $shared
+	 * @return mixed
+	 * @throws EE_Error
+	 * @throws ServiceNotFoundException
+	 * @throws ReflectionException
+	 */
+	public function load($fqcn, $arguments = array(), $shared = true)
+	{
+		if($this->generator instanceof EE_Registry) {
+			return $this->generator->create($fqcn, $arguments, $shared);
+		}
+		$shared = $shared ? CoffeeMaker::BREW_SHARED : CoffeeMaker::BREW_NEW;
+		return $this->generator->brew($fqcn, $arguments, $shared);
+
+	}
+
+
+
+	/**
+	 * calls reset() on generator if method exists
+	 *
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	public function reset()
+	{
+		if (method_exists($this->generator, 'reset')) {
+			$this->generator->reset();
+		}
+	}
 
 }
 // End of file CoreLoader.php

core/libraries/plugin_api/EE_Register_Shortcode.lib.php

Indentation +144 added lines, -144 removed lines

@@ -20,159 +20,159 @@
 class EE_Register_Shortcode implements EEI_Plugin_API
 {
 
-    /**
-     * Holds values for registered shortcodes
-     *
-     * @var array
-     */
-    protected static $_settings = array();
+	/**
+	 * Holds values for registered shortcodes
+	 *
+	 * @var array
+	 */
+	protected static $_settings = array();
 
 
-    /**
-     *    Method for registering new EE_Shortcodes
-     *
-     * @since    4.3.0
-     * @since    4.9.46.rc.025  for the new `shortcode_fqcns` array argument.
-     * @param string $shortcode_id a unique identifier for this set of modules Required.
-     * @param  array $setup_args   an array of arguments provided for registering shortcodes Required.
-     *               @type array shortcode_paths        an array of full server paths to folders containing any
-     *                                                  EES_Shortcodes
-     *               @type array shortcode_fqcns        an array of fully qualified class names for any new shortcode
-     *                                                  classes to register.  Shortcode classes should extend
-     *                                                  EspressoShortcode and be properly namespaced so they are
-     *                                                  autoloaded.
-     * @throws EE_Error
-     * @return void
-     */
-    public static function register($shortcode_id = null, $setup_args = array())
-    {
-        //required fields MUST be present, so let's make sure they are.
-        if (empty($shortcode_id)
-            || ! is_array($setup_args)
-            || (
-                empty($setup_args['shortcode_paths']))
-                && empty($setup_args['shortcode_fqcns'])
-            ) {
-            throw new EE_Error(
-                esc_html__(
-                    'In order to register Modules with EE_Register_Shortcode::register(), you must include a "shortcode_id" (a unique identifier for this set of shortcodes), and an array containing the following keys: "shortcode_paths" (an array of full server paths to folders that contain shortcodes, or to the shortcode files themselves)',
-                    'event_espresso'
-                )
-            );
-        }
+	/**
+	 *    Method for registering new EE_Shortcodes
+	 *
+	 * @since    4.3.0
+	 * @since    4.9.46.rc.025  for the new `shortcode_fqcns` array argument.
+	 * @param string $shortcode_id a unique identifier for this set of modules Required.
+	 * @param  array $setup_args   an array of arguments provided for registering shortcodes Required.
+	 *               @type array shortcode_paths        an array of full server paths to folders containing any
+	 *                                                  EES_Shortcodes
+	 *               @type array shortcode_fqcns        an array of fully qualified class names for any new shortcode
+	 *                                                  classes to register.  Shortcode classes should extend
+	 *                                                  EspressoShortcode and be properly namespaced so they are
+	 *                                                  autoloaded.
+	 * @throws EE_Error
+	 * @return void
+	 */
+	public static function register($shortcode_id = null, $setup_args = array())
+	{
+		//required fields MUST be present, so let's make sure they are.
+		if (empty($shortcode_id)
+			|| ! is_array($setup_args)
+			|| (
+				empty($setup_args['shortcode_paths']))
+				&& empty($setup_args['shortcode_fqcns'])
+			) {
+			throw new EE_Error(
+				esc_html__(
+					'In order to register Modules with EE_Register_Shortcode::register(), you must include a "shortcode_id" (a unique identifier for this set of shortcodes), and an array containing the following keys: "shortcode_paths" (an array of full server paths to folders that contain shortcodes, or to the shortcode files themselves)',
+					'event_espresso'
+				)
+			);
+		}
 
-        //make sure we don't register twice
-        if (isset(self::$_settings[$shortcode_id])) {
-            return;
-        }
+		//make sure we don't register twice
+		if (isset(self::$_settings[$shortcode_id])) {
+			return;
+		}
 
-        //make sure this was called in the right place!
-        if (! did_action('AHEE__EE_System__load_espresso_addons')
-            || did_action('AHEE__EE_System__register_shortcodes_modules_and_widgets')
-        ) {
-            EE_Error::doing_it_wrong(
-                __METHOD__,
-                esc_html__(
-                    'An attempt to register shortcodes has failed because it was not registered at the correct time.  Please use the "AHEE__EE_System__register_shortcodes_modules_and_widgets" hook to register shortcodes.',
-                    'event_espresso'
-                ),
-                '4.3.0'
-            );
-        }
-        //setup $_settings array from incoming values.
-        self::$_settings[$shortcode_id] = array(
-            // array of full server paths to any EES_Shortcodes used by the shortcode
-            'shortcode_paths' => isset($setup_args['shortcode_paths'])
-                ? (array) $setup_args['shortcode_paths']
-                : array(),
-            'shortcode_fqcns' => isset($setup_args['shortcode_fqcns'])
-                ? (array) $setup_args['shortcode_fqcns']
-                : array()
-        );
-        // add to list of shortcodes to be registered
-        add_filter(
-            'FHEE__EE_Config__register_shortcodes__shortcodes_to_register',
-            array('EE_Register_Shortcode', 'add_shortcodes')
-        );
+		//make sure this was called in the right place!
+		if (! did_action('AHEE__EE_System__load_espresso_addons')
+			|| did_action('AHEE__EE_System__register_shortcodes_modules_and_widgets')
+		) {
+			EE_Error::doing_it_wrong(
+				__METHOD__,
+				esc_html__(
+					'An attempt to register shortcodes has failed because it was not registered at the correct time.  Please use the "AHEE__EE_System__register_shortcodes_modules_and_widgets" hook to register shortcodes.',
+					'event_espresso'
+				),
+				'4.3.0'
+			);
+		}
+		//setup $_settings array from incoming values.
+		self::$_settings[$shortcode_id] = array(
+			// array of full server paths to any EES_Shortcodes used by the shortcode
+			'shortcode_paths' => isset($setup_args['shortcode_paths'])
+				? (array) $setup_args['shortcode_paths']
+				: array(),
+			'shortcode_fqcns' => isset($setup_args['shortcode_fqcns'])
+				? (array) $setup_args['shortcode_fqcns']
+				: array()
+		);
+		// add to list of shortcodes to be registered
+		add_filter(
+			'FHEE__EE_Config__register_shortcodes__shortcodes_to_register',
+			array('EE_Register_Shortcode', 'add_shortcodes')
+		);
 
-        add_filter(
-            'FHEE__EventEspresso_core_services_shortcodes_ShortcodesManager__registerShortcodes__shortcode_collection',
-            array('EE_Register_Shortcode', 'instantiateAndAddToShortcodeCollection')
-        );
-    }
+		add_filter(
+			'FHEE__EventEspresso_core_services_shortcodes_ShortcodesManager__registerShortcodes__shortcode_collection',
+			array('EE_Register_Shortcode', 'instantiateAndAddToShortcodeCollection')
+		);
+	}
 
 
-    /**
-     * Filters the list of shortcodes to add ours.
-     * and they're just full filepaths to FOLDERS containing a shortcode class file. Eg.
-     * array('espresso_monkey'=>'/public_html/wonder-site/wp-content/plugins/ee4/shortcodes/espresso_monkey',...)
-     *
-     * @param array $shortcodes_to_register array of paths to all shortcodes that require registering
-     * @return array
-     */
-    public static function add_shortcodes($shortcodes_to_register)
-    {
-        foreach (self::$_settings as $settings) {
-            $shortcodes_to_register = array_merge($shortcodes_to_register, $settings['shortcode_paths']);
-        }
-        return $shortcodes_to_register;
-    }
+	/**
+	 * Filters the list of shortcodes to add ours.
+	 * and they're just full filepaths to FOLDERS containing a shortcode class file. Eg.
+	 * array('espresso_monkey'=>'/public_html/wonder-site/wp-content/plugins/ee4/shortcodes/espresso_monkey',...)
+	 *
+	 * @param array $shortcodes_to_register array of paths to all shortcodes that require registering
+	 * @return array
+	 */
+	public static function add_shortcodes($shortcodes_to_register)
+	{
+		foreach (self::$_settings as $settings) {
+			$shortcodes_to_register = array_merge($shortcodes_to_register, $settings['shortcode_paths']);
+		}
+		return $shortcodes_to_register;
+	}
 
 
-    /**
-     * Hooks into FHEE__EventEspresso_core_services_shortcodes_ShortcodesManager__registerShortcodes__shortcode_collection
-     * and registers any provided shortcode fully qualified class names.
-     * @param CollectionInterface $shortcodes_collection
-     * @return CollectionInterface
-     * @throws InvalidArgumentException
-     * @throws InvalidClassException
-     * @throws \EventEspresso\core\exceptions\InvalidDataTypeException
-     * @throws \EventEspresso\core\exceptions\InvalidInterfaceException
-     */
-    public static function instantiateAndAddToShortcodeCollection(CollectionInterface $shortcodes_collection)
-    {
-        foreach (self::$_settings as $settings) {
-            if (! empty($settings['shortcode_fqcns'])) {
-                foreach ($settings['shortcode_fqcns'] as $shortcode_fqcn) {
-                    if (! class_exists($shortcode_fqcn)) {
-                        throw new InvalidClassException(
-                            sprintf(
-                                esc_html__(
-                                    'Are you sure %s is the right fully qualified class name for the shortcode class?',
-                                    'event_espresso'
-                                ),
-                                $shortcode_fqcn
-                            )
-                        );
-                    }
-                    if (! EE_Dependency_Map::instance()->has_dependency_for_class($shortcode_fqcn)) {
-                        //register dependencies
-                        EE_Dependency_Map::register_dependencies(
-                            $shortcode_fqcn,
-                            array(
-                                'EventEspresso\core\services\cache\PostRelatedCacheManager' => EE_Dependency_Map::load_from_cache,
-                            )
-                        );
-                    }
-                    $shortcodes_collection->add(LoaderFactory::getLoader()->getShared($shortcode_fqcn));
-                }
-            }
-        }
-        return $shortcodes_collection;
-    }
+	/**
+	 * Hooks into FHEE__EventEspresso_core_services_shortcodes_ShortcodesManager__registerShortcodes__shortcode_collection
+	 * and registers any provided shortcode fully qualified class names.
+	 * @param CollectionInterface $shortcodes_collection
+	 * @return CollectionInterface
+	 * @throws InvalidArgumentException
+	 * @throws InvalidClassException
+	 * @throws \EventEspresso\core\exceptions\InvalidDataTypeException
+	 * @throws \EventEspresso\core\exceptions\InvalidInterfaceException
+	 */
+	public static function instantiateAndAddToShortcodeCollection(CollectionInterface $shortcodes_collection)
+	{
+		foreach (self::$_settings as $settings) {
+			if (! empty($settings['shortcode_fqcns'])) {
+				foreach ($settings['shortcode_fqcns'] as $shortcode_fqcn) {
+					if (! class_exists($shortcode_fqcn)) {
+						throw new InvalidClassException(
+							sprintf(
+								esc_html__(
+									'Are you sure %s is the right fully qualified class name for the shortcode class?',
+									'event_espresso'
+								),
+								$shortcode_fqcn
+							)
+						);
+					}
+					if (! EE_Dependency_Map::instance()->has_dependency_for_class($shortcode_fqcn)) {
+						//register dependencies
+						EE_Dependency_Map::register_dependencies(
+							$shortcode_fqcn,
+							array(
+								'EventEspresso\core\services\cache\PostRelatedCacheManager' => EE_Dependency_Map::load_from_cache,
+							)
+						);
+					}
+					$shortcodes_collection->add(LoaderFactory::getLoader()->getShared($shortcode_fqcn));
+				}
+			}
+		}
+		return $shortcodes_collection;
+	}
 
 
-    /**
-     * This deregisters a shortcode that was previously registered with a specific $shortcode_id.
-     *
-     * @since    4.3.0
-     * @param string $shortcode_id the name for the shortcode that was previously registered
-     * @return void
-     */
-    public static function deregister($shortcode_id = null)
-    {
-        if (isset(self::$_settings[$shortcode_id])) {
-            unset(self::$_settings[$shortcode_id]);
-        }
-    }
+	/**
+	 * This deregisters a shortcode that was previously registered with a specific $shortcode_id.
+	 *
+	 * @since    4.3.0
+	 * @param string $shortcode_id the name for the shortcode that was previously registered
+	 * @return void
+	 */
+	public static function deregister($shortcode_id = null)
+	{
+		if (isset(self::$_settings[$shortcode_id])) {
+			unset(self::$_settings[$shortcode_id]);
+		}
+	}
 }

Spacing +4 added lines, -4 removed lines

@@ -67,7 +67,7 @@ 
         }
 
         //make sure this was called in the right place!
-        if (! did_action('AHEE__EE_System__load_espresso_addons')
+        if ( ! did_action('AHEE__EE_System__load_espresso_addons')
             || did_action('AHEE__EE_System__register_shortcodes_modules_and_widgets')
         ) {
             EE_Error::doing_it_wrong(
@@ -132,9 +132,9 @@ 
     public static function instantiateAndAddToShortcodeCollection(CollectionInterface $shortcodes_collection)
     {
         foreach (self::$_settings as $settings) {
-            if (! empty($settings['shortcode_fqcns'])) {
+            if ( ! empty($settings['shortcode_fqcns'])) {
                 foreach ($settings['shortcode_fqcns'] as $shortcode_fqcn) {
-                    if (! class_exists($shortcode_fqcn)) {
+                    if ( ! class_exists($shortcode_fqcn)) {
                         throw new InvalidClassException(
                             sprintf(
                                 esc_html__(
@@ -145,7 +145,7 @@ 
                             )
                         );
                     }
-                    if (! EE_Dependency_Map::instance()->has_dependency_for_class($shortcode_fqcn)) {
+                    if ( ! EE_Dependency_Map::instance()->has_dependency_for_class($shortcode_fqcn)) {
                         //register dependencies
                         EE_Dependency_Map::register_dependencies(
                             $shortcode_fqcn,

core/helpers/EEH_URL.helper.php

Indentation +227 added lines, -227 removed lines

@@ -14,249 +14,249 @@
 class EEH_URL
 {
 
-    /**
-     * _add_query_arg
-     * adds nonce to array of arguments then calls WP add_query_arg function
-     *
-     * @access public
-     * @param array  $args
-     * @param string $url
-     * @param bool   $exclude_nonce If true then the nonce will be excluded from the generated url.
-     * @return string
-     */
-    public static function add_query_args_and_nonce($args = array(), $url = '', $exclude_nonce = false)
-    {
-        if (empty($url)) {
-            $user_msg = esc_html__(
-                'An error occurred. A URL is a required parameter for the add_query_args_and_nonce method.',
-                'event_espresso'
-            );
-            $dev_msg  = $user_msg . "\n"
-                . sprintf(
-                    esc_html__(
-                        'In order to dynamically generate nonces for your actions, you need to supply a valid URL as a second parameter for the %s method.',
-                        'event_espresso'
-                    ),
-                    __CLASS__ . '::add_query_args_and_nonce'
-                );
-            EE_Error::add_error($user_msg . '||' . $dev_msg, __FILE__, __FUNCTION__, __LINE__);
-        }
-        // check that an action exists and add nonce
-        if (! $exclude_nonce) {
-            if (isset($args['action']) && ! empty($args['action'])) {
-                $args = array_merge(
-                    $args,
-                    array(
-                        $args['action'] . '_nonce' => wp_create_nonce($args['action'] . '_nonce')
-                    )
-                );
-            } else {
-                $args = array_merge(
-                    $args,
-                    array(
-                        'action' => 'default', 'default_nonce' => wp_create_nonce('default_nonce')
-                    )
-                );
-            }
-        }
+	/**
+	 * _add_query_arg
+	 * adds nonce to array of arguments then calls WP add_query_arg function
+	 *
+	 * @access public
+	 * @param array  $args
+	 * @param string $url
+	 * @param bool   $exclude_nonce If true then the nonce will be excluded from the generated url.
+	 * @return string
+	 */
+	public static function add_query_args_and_nonce($args = array(), $url = '', $exclude_nonce = false)
+	{
+		if (empty($url)) {
+			$user_msg = esc_html__(
+				'An error occurred. A URL is a required parameter for the add_query_args_and_nonce method.',
+				'event_espresso'
+			);
+			$dev_msg  = $user_msg . "\n"
+				. sprintf(
+					esc_html__(
+						'In order to dynamically generate nonces for your actions, you need to supply a valid URL as a second parameter for the %s method.',
+						'event_espresso'
+					),
+					__CLASS__ . '::add_query_args_and_nonce'
+				);
+			EE_Error::add_error($user_msg . '||' . $dev_msg, __FILE__, __FUNCTION__, __LINE__);
+		}
+		// check that an action exists and add nonce
+		if (! $exclude_nonce) {
+			if (isset($args['action']) && ! empty($args['action'])) {
+				$args = array_merge(
+					$args,
+					array(
+						$args['action'] . '_nonce' => wp_create_nonce($args['action'] . '_nonce')
+					)
+				);
+			} else {
+				$args = array_merge(
+					$args,
+					array(
+						'action' => 'default', 'default_nonce' => wp_create_nonce('default_nonce')
+					)
+				);
+			}
+		}
 
-        //finally, let's always add a return address (if present) :)
-        $args = ! empty($_REQUEST['action']) && ! isset($_REQUEST['return'])
-            ? array_merge($args, array('return' => $_REQUEST['action']))
-            : $args;
+		//finally, let's always add a return address (if present) :)
+		$args = ! empty($_REQUEST['action']) && ! isset($_REQUEST['return'])
+			? array_merge($args, array('return' => $_REQUEST['action']))
+			: $args;
 
-        return add_query_arg($args, $url);
-    }
+		return add_query_arg($args, $url);
+	}
 
 
-    /**
-     * Returns whether not the remote file exists.
-     * Checking via GET because HEAD requests are blocked on some server configurations.
-     *
-     * @param string  $url
-     * @param array $args  the arguments that should be passed through to the wp_remote_request call.
-     * @return boolean
-     */
-    public static function remote_file_exists($url, $args = array())
-    {
-        $results = wp_remote_request(
-            $url,
-            array_merge(
-                array(
-                    'method'      => 'GET',
-                    'redirection' => 1,
-                ),
-                $args
-            )
-        );
-        if (! $results instanceof WP_Error &&
-            isset($results['response']) &&
-            isset($results['response']['code']) &&
-            $results['response']['code'] == '200') {
-            return true;
-        } else {
-            return false;
-        }
-    }
+	/**
+	 * Returns whether not the remote file exists.
+	 * Checking via GET because HEAD requests are blocked on some server configurations.
+	 *
+	 * @param string  $url
+	 * @param array $args  the arguments that should be passed through to the wp_remote_request call.
+	 * @return boolean
+	 */
+	public static function remote_file_exists($url, $args = array())
+	{
+		$results = wp_remote_request(
+			$url,
+			array_merge(
+				array(
+					'method'      => 'GET',
+					'redirection' => 1,
+				),
+				$args
+			)
+		);
+		if (! $results instanceof WP_Error &&
+			isset($results['response']) &&
+			isset($results['response']['code']) &&
+			$results['response']['code'] == '200') {
+			return true;
+		} else {
+			return false;
+		}
+	}
 
 
-    /**
-     * refactor_url
-     * primarily used for removing the query string from a URL
-     *
-     * @param string $url
-     * @param bool   $remove_query  - TRUE (default) will strip off any URL params, ie: ?this=1&that=2
-     * @param bool   $base_url_only - TRUE will only return the scheme and host with no other parameters
-     * @return string
-     */
-    public static function refactor_url($url = '', $remove_query = true, $base_url_only = false)
-    {
-        // break apart incoming URL
-        $url_bits = parse_url($url);
-        // HTTP or HTTPS ?
-        $scheme = isset($url_bits['scheme']) ? $url_bits['scheme'] . '://' : 'http://';
-        // domain
-        $host = isset($url_bits['host']) ? $url_bits['host'] : '';
-        // if only the base URL is requested, then return that now
-        if ($base_url_only) {
-            return $scheme . $host;
-        }
-        $port = isset($url_bits['port']) ? ':' . $url_bits['port'] : '';
-        $user = isset($url_bits['user']) ? $url_bits['user'] : '';
-        $pass = isset($url_bits['pass']) ? ':' . $url_bits['pass'] : '';
-        $pass = ($user || $pass) ? $pass . '@' : '';
-        $path = isset($url_bits['path']) ? $url_bits['path'] : '';
-        // if the query string is not required, then return what we have so far
-        if ($remove_query) {
-            return $scheme . $user . $pass . $host . $port . $path;
-        }
-        $query    = isset($url_bits['query']) ? '?' . $url_bits['query'] : '';
-        $fragment = isset($url_bits['fragment']) ? '#' . $url_bits['fragment'] : '';
-        return $scheme . $user . $pass . $host . $port . $path . $query . $fragment;
-    }
+	/**
+	 * refactor_url
+	 * primarily used for removing the query string from a URL
+	 *
+	 * @param string $url
+	 * @param bool   $remove_query  - TRUE (default) will strip off any URL params, ie: ?this=1&that=2
+	 * @param bool   $base_url_only - TRUE will only return the scheme and host with no other parameters
+	 * @return string
+	 */
+	public static function refactor_url($url = '', $remove_query = true, $base_url_only = false)
+	{
+		// break apart incoming URL
+		$url_bits = parse_url($url);
+		// HTTP or HTTPS ?
+		$scheme = isset($url_bits['scheme']) ? $url_bits['scheme'] . '://' : 'http://';
+		// domain
+		$host = isset($url_bits['host']) ? $url_bits['host'] : '';
+		// if only the base URL is requested, then return that now
+		if ($base_url_only) {
+			return $scheme . $host;
+		}
+		$port = isset($url_bits['port']) ? ':' . $url_bits['port'] : '';
+		$user = isset($url_bits['user']) ? $url_bits['user'] : '';
+		$pass = isset($url_bits['pass']) ? ':' . $url_bits['pass'] : '';
+		$pass = ($user || $pass) ? $pass . '@' : '';
+		$path = isset($url_bits['path']) ? $url_bits['path'] : '';
+		// if the query string is not required, then return what we have so far
+		if ($remove_query) {
+			return $scheme . $user . $pass . $host . $port . $path;
+		}
+		$query    = isset($url_bits['query']) ? '?' . $url_bits['query'] : '';
+		$fragment = isset($url_bits['fragment']) ? '#' . $url_bits['fragment'] : '';
+		return $scheme . $user . $pass . $host . $port . $path . $query . $fragment;
+	}
 
 
-    /**
-     * get_query_string
-     * returns just the query string from a URL, formatted by default into an array of key value pairs
-     *
-     * @param string $url
-     * @param bool   $as_array TRUE (default) will return query params as an array of key value pairs, FALSE will
-     *                         simply return the query string
-     * @return string|array
-     */
-    public static function get_query_string($url = '', $as_array = true)
-    {
-        // decode, then break apart incoming URL
-        $url_bits = parse_url(html_entity_decode($url));
-        // grab query string from URL
-        $query = isset($url_bits['query']) ? $url_bits['query'] : '';
-        // if we don't want the query string formatted into an array of key => value pairs, then just return it as is
-        if (! $as_array) {
-            return $query;
-        }
-        // if no query string exists then just return an empty array now
-        if (empty($query)) {
-            return array();
-        }
-        // empty array to hold results
-        $query_params = array();
-        // now break apart the query string into separate params
-        $query = explode('&', $query);
-        // loop thru our query params
-        foreach ($query as $query_args) {
-            // break apart the key value pairs
-            $query_args = explode('=', $query_args);
-            // and add to our results array
-            $query_params[$query_args[0]] = $query_args[1];
-        }
-        return $query_params;
-    }
+	/**
+	 * get_query_string
+	 * returns just the query string from a URL, formatted by default into an array of key value pairs
+	 *
+	 * @param string $url
+	 * @param bool   $as_array TRUE (default) will return query params as an array of key value pairs, FALSE will
+	 *                         simply return the query string
+	 * @return string|array
+	 */
+	public static function get_query_string($url = '', $as_array = true)
+	{
+		// decode, then break apart incoming URL
+		$url_bits = parse_url(html_entity_decode($url));
+		// grab query string from URL
+		$query = isset($url_bits['query']) ? $url_bits['query'] : '';
+		// if we don't want the query string formatted into an array of key => value pairs, then just return it as is
+		if (! $as_array) {
+			return $query;
+		}
+		// if no query string exists then just return an empty array now
+		if (empty($query)) {
+			return array();
+		}
+		// empty array to hold results
+		$query_params = array();
+		// now break apart the query string into separate params
+		$query = explode('&', $query);
+		// loop thru our query params
+		foreach ($query as $query_args) {
+			// break apart the key value pairs
+			$query_args = explode('=', $query_args);
+			// and add to our results array
+			$query_params[$query_args[0]] = $query_args[1];
+		}
+		return $query_params;
+	}
 
 
-    /**
-     * prevent_prefetching
-     *
-     * @return void
-     */
-    public static function prevent_prefetching()
-    {
-        // prevent browsers from prefetching of the rel='next' link, because it may contain content that interferes
-        // with the registration process
-        remove_action('wp_head', 'adjacent_posts_rel_link_wp_head');
-    }
+	/**
+	 * prevent_prefetching
+	 *
+	 * @return void
+	 */
+	public static function prevent_prefetching()
+	{
+		// prevent browsers from prefetching of the rel='next' link, because it may contain content that interferes
+		// with the registration process
+		remove_action('wp_head', 'adjacent_posts_rel_link_wp_head');
+	}
 
 
-    /**
-     * This generates a unique site-specific string.
-     * An example usage for this string would be to save as a unique identifier for a record in the db for usage in
-     * urls.
-     *
-     * @param   string $prefix Use this to prefix the string with something.
-     * @return string
-     */
-    public static function generate_unique_token($prefix = '')
-    {
-        $token = md5(uniqid() . mt_rand());
-        return $prefix ? $prefix . '_' . $token : $token;
-    }
+	/**
+	 * This generates a unique site-specific string.
+	 * An example usage for this string would be to save as a unique identifier for a record in the db for usage in
+	 * urls.
+	 *
+	 * @param   string $prefix Use this to prefix the string with something.
+	 * @return string
+	 */
+	public static function generate_unique_token($prefix = '')
+	{
+		$token = md5(uniqid() . mt_rand());
+		return $prefix ? $prefix . '_' . $token : $token;
+	}
 
 
-    /**
-     * filter_input_server_url
-     * uses filter_input() to sanitize one of the INPUT_SERVER URL values
-     * but adds a backup in case filter_input() returns nothing, which can erringly happen on some servers
-     *
-     * @param string $server_variable
-     * @return string
-     */
-    public static function filter_input_server_url($server_variable = 'REQUEST_URI')
-    {
-        $URL              = '';
-        $server_variables = array(
-            'REQUEST_URI' => 1,
-            'HTTP_HOST'   => 1,
-            'PHP_SELF'    => 1,
-        );
-        $server_variable  = strtoupper($server_variable);
-        // whitelist INPUT_SERVER var
-        if (isset($server_variables[$server_variable])) {
-            $URL = filter_input(INPUT_SERVER, $server_variable, FILTER_SANITIZE_URL, FILTER_NULL_ON_FAILURE);
-            if (empty($URL)) {
-                // fallback sanitization if the above fails
-                $URL = wp_sanitize_redirect($_SERVER[$server_variable]);
-            }
-        }
-        return $URL;
-    }
+	/**
+	 * filter_input_server_url
+	 * uses filter_input() to sanitize one of the INPUT_SERVER URL values
+	 * but adds a backup in case filter_input() returns nothing, which can erringly happen on some servers
+	 *
+	 * @param string $server_variable
+	 * @return string
+	 */
+	public static function filter_input_server_url($server_variable = 'REQUEST_URI')
+	{
+		$URL              = '';
+		$server_variables = array(
+			'REQUEST_URI' => 1,
+			'HTTP_HOST'   => 1,
+			'PHP_SELF'    => 1,
+		);
+		$server_variable  = strtoupper($server_variable);
+		// whitelist INPUT_SERVER var
+		if (isset($server_variables[$server_variable])) {
+			$URL = filter_input(INPUT_SERVER, $server_variable, FILTER_SANITIZE_URL, FILTER_NULL_ON_FAILURE);
+			if (empty($URL)) {
+				// fallback sanitization if the above fails
+				$URL = wp_sanitize_redirect($_SERVER[$server_variable]);
+			}
+		}
+		return $URL;
+	}
 
 
-    /**
-     * Gets the current page's full URL.
-     *
-     * @return string
-     */
-    public static function current_url()
-    {
-        $url = '';
-        if (isset($_SERVER['HTTP_HOST'], $_SERVER['REQUEST_URI'])) {
-            $url = is_ssl() ? 'https://' : 'http://';
-            $url .= \EEH_URL::filter_input_server_url('HTTP_HOST');
-            $url .= \EEH_URL::filter_input_server_url('REQUEST_URI');
-        }
-        return $url;
-    }
+	/**
+	 * Gets the current page's full URL.
+	 *
+	 * @return string
+	 */
+	public static function current_url()
+	{
+		$url = '';
+		if (isset($_SERVER['HTTP_HOST'], $_SERVER['REQUEST_URI'])) {
+			$url = is_ssl() ? 'https://' : 'http://';
+			$url .= \EEH_URL::filter_input_server_url('HTTP_HOST');
+			$url .= \EEH_URL::filter_input_server_url('REQUEST_URI');
+		}
+		return $url;
+	}
 
 
-    /**
-     * Identical in functionality to EEH_current_url except it removes any provided query_parameters from it.
-     *
-     * @param array $query_parameters An array of query_parameters to remove from the current url.
-     * @since 4.9.46.rc.029
-     * @return string
-     */
-    public static function current_url_without_query_paramaters(array $query_parameters)
-    {
-        return remove_query_arg($query_parameters, EEH_URL::current_url());
-    }
+	/**
+	 * Identical in functionality to EEH_current_url except it removes any provided query_parameters from it.
+	 *
+	 * @param array $query_parameters An array of query_parameters to remove from the current url.
+	 * @since 4.9.46.rc.029
+	 * @return string
+	 */
+	public static function current_url_without_query_paramaters(array $query_parameters)
+	{
+		return remove_query_arg($query_parameters, EEH_URL::current_url());
+	}
 }

Spacing +19 added lines, -19 removed lines

@@ -31,23 +31,23 @@ 
                 'An error occurred. A URL is a required parameter for the add_query_args_and_nonce method.',
                 'event_espresso'
             );
-            $dev_msg  = $user_msg . "\n"
+            $dev_msg = $user_msg."\n"
                 . sprintf(
                     esc_html__(
                         'In order to dynamically generate nonces for your actions, you need to supply a valid URL as a second parameter for the %s method.',
                         'event_espresso'
                     ),
-                    __CLASS__ . '::add_query_args_and_nonce'
+                    __CLASS__.'::add_query_args_and_nonce'
                 );
-            EE_Error::add_error($user_msg . '||' . $dev_msg, __FILE__, __FUNCTION__, __LINE__);
+            EE_Error::add_error($user_msg.'||'.$dev_msg, __FILE__, __FUNCTION__, __LINE__);
         }
         // check that an action exists and add nonce
-        if (! $exclude_nonce) {
+        if ( ! $exclude_nonce) {
             if (isset($args['action']) && ! empty($args['action'])) {
                 $args = array_merge(
                     $args,
                     array(
-                        $args['action'] . '_nonce' => wp_create_nonce($args['action'] . '_nonce')
+                        $args['action'].'_nonce' => wp_create_nonce($args['action'].'_nonce')
                     )
                 );
             } else {
@@ -89,7 +89,7 @@ 
                 $args
             )
         );
-        if (! $results instanceof WP_Error &&
+        if ( ! $results instanceof WP_Error &&
             isset($results['response']) &&
             isset($results['response']['code']) &&
             $results['response']['code'] == '200') {
@@ -114,25 +114,25 @@ 
         // break apart incoming URL
         $url_bits = parse_url($url);
         // HTTP or HTTPS ?
-        $scheme = isset($url_bits['scheme']) ? $url_bits['scheme'] . '://' : 'http://';
+        $scheme = isset($url_bits['scheme']) ? $url_bits['scheme'].'://' : 'http://';
         // domain
         $host = isset($url_bits['host']) ? $url_bits['host'] : '';
         // if only the base URL is requested, then return that now
         if ($base_url_only) {
-            return $scheme . $host;
+            return $scheme.$host;
         }
-        $port = isset($url_bits['port']) ? ':' . $url_bits['port'] : '';
+        $port = isset($url_bits['port']) ? ':'.$url_bits['port'] : '';
         $user = isset($url_bits['user']) ? $url_bits['user'] : '';
-        $pass = isset($url_bits['pass']) ? ':' . $url_bits['pass'] : '';
-        $pass = ($user || $pass) ? $pass . '@' : '';
+        $pass = isset($url_bits['pass']) ? ':'.$url_bits['pass'] : '';
+        $pass = ($user || $pass) ? $pass.'@' : '';
         $path = isset($url_bits['path']) ? $url_bits['path'] : '';
         // if the query string is not required, then return what we have so far
         if ($remove_query) {
-            return $scheme . $user . $pass . $host . $port . $path;
+            return $scheme.$user.$pass.$host.$port.$path;
         }
-        $query    = isset($url_bits['query']) ? '?' . $url_bits['query'] : '';
-        $fragment = isset($url_bits['fragment']) ? '#' . $url_bits['fragment'] : '';
-        return $scheme . $user . $pass . $host . $port . $path . $query . $fragment;
+        $query    = isset($url_bits['query']) ? '?'.$url_bits['query'] : '';
+        $fragment = isset($url_bits['fragment']) ? '#'.$url_bits['fragment'] : '';
+        return $scheme.$user.$pass.$host.$port.$path.$query.$fragment;
     }
 
 
@@ -152,7 +152,7 @@ 
         // grab query string from URL
         $query = isset($url_bits['query']) ? $url_bits['query'] : '';
         // if we don't want the query string formatted into an array of key => value pairs, then just return it as is
-        if (! $as_array) {
+        if ( ! $as_array) {
             return $query;
         }
         // if no query string exists then just return an empty array now
@@ -197,8 +197,8 @@ 
      */
     public static function generate_unique_token($prefix = '')
     {
-        $token = md5(uniqid() . mt_rand());
-        return $prefix ? $prefix . '_' . $token : $token;
+        $token = md5(uniqid().mt_rand());
+        return $prefix ? $prefix.'_'.$token : $token;
     }
 
 
@@ -218,7 +218,7 @@ 
             'HTTP_HOST'   => 1,
             'PHP_SELF'    => 1,
         );
-        $server_variable  = strtoupper($server_variable);
+        $server_variable = strtoupper($server_variable);
         // whitelist INPUT_SERVER var
         if (isset($server_variables[$server_variable])) {
             $URL = filter_input(INPUT_SERVER, $server_variable, FILTER_SANITIZE_URL, FILTER_NULL_ON_FAILURE);

modules/ticket_selector/TicketSelectorRowStandard.php

Indentation +339 added lines, -339 removed lines

@@ -21,345 +21,345 @@
 class TicketSelectorRowStandard extends TicketSelectorRow
 {
 
-    /**
-     * @var TicketDetails $ticket_details
-     */
-    protected $ticket_details;
-
-    /**
-     * @var \EE_Ticket_Selector_Config $template_settings
-     */
-    protected $template_settings;
-
-    /**
-     * @var EE_Tax_Config $tax_settings
-     */
-    protected $tax_settings;
-
-    /**
-     * @var boolean $prices_displayed_including_taxes
-     */
-    protected $prices_displayed_including_taxes;
-
-    /**
-     * @var int $row
-     */
-    protected $row;
-
-    /**
-     * @var int $cols
-     */
-    protected $cols;
-
-    /**
-     * @var boolean $hidden_input_qty
-     */
-    protected $hidden_input_qty;
-
-    /**
-     * @var string $ticket_datetime_classes
-     */
-    protected $ticket_datetime_classes;
-
-
-
-    /**
-     * TicketDetails constructor.
-     *
-     * @param TicketDetails  $ticket_details
-     * @param EE_Tax_Config $tax_settings
-     * @param int            $total_tickets
-     * @param int            $max_attendees
-     * @param int            $row
-     * @param int            $cols
-     * @param boolean        $required_ticket_sold_out
-     * @param string         $event_status
-     * @param string         $ticket_datetime_classes
-     * @throws EE_Error
-     * @throws UnexpectedEntityException
-     */
-    public function __construct(
-        TicketDetails $ticket_details,
-        EE_Tax_Config $tax_settings,
-        $total_tickets,
-        $max_attendees,
-        $row,
-        $cols,
-        $required_ticket_sold_out,
-        $event_status,
-        $ticket_datetime_classes
-    ) {
-        $this->ticket_details = $ticket_details;
-        $this->template_settings = $ticket_details->getTemplateSettings();
-        $this->tax_settings = $tax_settings;
-        $this->row = $row;
-        $this->cols = $cols;
-        $this->ticket_datetime_classes = $ticket_datetime_classes;
-        parent::__construct(
-            $ticket_details->getTicket(),
-            $max_attendees,
-            $ticket_details->getDateFormat(),
-            $event_status,
-            $required_ticket_sold_out,
-            $total_tickets
-        );
-    }
-
-
-
-    /**
-     * other ticket rows will need to know if a required ticket is sold out,
-     * so that they are not offered for sale
-     *
-     * @return boolean
-     */
-    public function getRequiredTicketSoldOut()
-    {
-        return $this->required_ticket_sold_out;
-    }
-
-
-
-    /**
-     * @return int
-     */
-    public function getCols()
-    {
-        return $this->cols;
-    }
-
-
-
-    /**
-     * getHtml
-     *
-     * @return string
-     * @throws EE_Error
-     */
-    public function getHtml()
-    {
-        $this->min = 0;
-        $this->max = $this->ticket->max();
-        $remaining = $this->ticket->remaining();
-        if ($this->ticket->is_on_sale() && $this->ticket->is_remaining()) {
-             $this->setTicketMinAndMax($remaining);
-        } else {
-            // set flag if ticket is required (flag is set to start date so that future tickets are not blocked)
-            $this->required_ticket_sold_out = $this->ticket->required() && ! $remaining
-                ? $this->ticket->start_date()
-                : $this->required_ticket_sold_out;
-        }
-        $this->setTicketPriceDetails();
-        $this->setTicketStatusClasses($remaining);
-        $filtered_row_html = $this->getFilteredRowHtml();
-        if ($filtered_row_html !== false) {
-            return $filtered_row_html;
-        }
-        $ticket_selector_row_html = EEH_HTML::tr(
-            '', '',
-            "tckt-slctr-tbl-tr {$this->status_class}{$this->ticket_datetime_classes} "
-            . espresso_get_object_css_class($this->ticket)
-        );
-        $filtered_row_content = $this->getFilteredRowContents();
-        if ($filtered_row_content !== false && $this->max_attendees === 1) {
-            return $ticket_selector_row_html
-                   . $filtered_row_content
-                   . $this->ticketQtyAndIdHiddenInputs()
-                   . EEH_HTML::trx();
-        }
-        if ($filtered_row_content !== false) {
-            return $ticket_selector_row_html
-                   . $filtered_row_content
-                   . EEH_HTML::trx();
-        }
-        $this->hidden_input_qty = $this->max_attendees > 1;
-
-        $ticket_selector_row_html .= $this->ticketNameTableCell();
-        $ticket_selector_row_html .= $this->ticketPriceTableCell();
-        $ticket_selector_row_html .= EEH_HTML::td('', '', 'tckt-slctr-tbl-td-qty cntr');
-        $this->setTicketStatusDisplay($remaining);
-        if (empty($this->ticket_status_display)) {
-            if ($this->max_attendees === 1) {
-                // only ONE attendee is allowed to register at a time
-                $ticket_selector_row_html .= $this->onlyOneAttendeeCanRegister();
-            } elseif ($this->max > 0) {
-                $ticket_selector_row_html .= $this->ticketQuantitySelector();
-            }
-        }
-        $ticket_selector_row_html .= $this->ticket_status_display;
-        $ticket_selector_row_html .= $this->ticketQtyAndIdHiddenInputs();
-        $ticket_selector_row_html .= $this->ticket_details->display(
-            $this->ticket_price,
-            $remaining,
-            $this->cols
-        );
-        $ticket_selector_row_html .= EEH_HTML::tdx();
-        $ticket_selector_row_html .= EEH_HTML::trx();
-
-
-        $this->row++;
-        return $ticket_selector_row_html;
-    }
-
-
-
-
-    /**
-     * getTicketPriceDetails
-     *
-     * @return void
-     * @throws EE_Error
-     */
-    protected function setTicketPriceDetails()
-    {
-        $this->ticket_price = $this->tax_settings->prices_displayed_including_taxes
-            ? $this->ticket->get_ticket_total_with_taxes()
-            : $this->ticket->get_ticket_subtotal();
-        $this->ticket_bundle = false;
-        $ticket_min = $this->ticket->min();
-        // for ticket bundles, set min and max qty the same
-        if ($ticket_min !== 0 && $ticket_min === $this->ticket->max()) {
-            $this->ticket_price *= $ticket_min;
-            $this->ticket_bundle = true;
-        }
-        $this->ticket_price = apply_filters(
-            'FHEE__ticket_selector_chart_template__ticket_price',
-            $this->ticket_price,
-            $this->ticket
-        );
-    }
-
-
-
-
-    /**
-     * ticketNameTableCell
-     *
-     * @return string
-     * @throws EE_Error
-     */
-    protected function ticketNameTableCell()
-    {
-        $html = EEH_HTML::td('', '', 'tckt-slctr-tbl-td-name');
-        $html .= EEH_HTML::strong($this->ticket->get_pretty('TKT_name'));
-        $html .= $this->ticket_details->getShowHideLinks();
-        if ($this->ticket->required()) {
-            $html .= EEH_HTML::p(
-                apply_filters(
-                        'FHEE__ticket_selector_chart_template__ticket_required_message',
-                        esc_html__('This ticket is required and must be purchased.', 'event_espresso')
-                ),
-                '', 'ticket-required-pg'
-            );
-        }
-        $html .= EEH_HTML::tdx();
-        return $html;
-    }
-
-
-
-    /**
-     * ticketPriceTableCell
-     *
-     * @return string
-     * @throws EE_Error
-     */
-    protected function ticketPriceTableCell()
-    {
-        $html = '';
-        if (apply_filters('FHEE__ticket_selector_chart_template__display_ticket_price_details', true)) {
-            $html .= EEH_HTML::td('', '', 'tckt-slctr-tbl-td-price jst-rght');
-            $html .= \EEH_Template::format_currency($this->ticket_price);
-            $html .= $this->ticket->taxable()
-                ? EEH_HTML::span( '*', '', 'taxable-tickets-asterisk grey-text' )
-                : '';
-            $html .= ' ';
-            $html .= EEH_HTML::span(
-                $this->ticket_bundle
-                    ? apply_filters(
-                        'FHEE__ticket_selector_chart_template__per_ticket_bundle_text',
-                        __(' / bundle', 'event_espresso')
-                    )
-                    : apply_filters(
-                        'FHEE__ticket_selector_chart_template__per_ticket_text',
-                        __('', 'event_espresso')
-                    ),
-                '', 'smaller-text no-bold'
-            );
-            $html .= ' ';
-            $html .= EEH_HTML::tdx();
-            $this->cols++;
-        }
-        return $html;
-    }
-
-
-
-    /**
-     * onlyOneAttendeeCanRegister
-     *
-     * @return string
-     */
-    protected function onlyOneAttendeeCanRegister()
-    {
-        // display submit button since we have tickets available
-        add_filter('FHEE__EE_Ticket_Selector__display_ticket_selector_submit', '__return_true');
-        $this->hidden_input_qty = false;
-        $html = '<input type="radio" name="tkt-slctr-qty-' . $this->EVT_ID . '"';
-        $html .= ' id="ticket-selector-tbl-qty-slct-' . $this->EVT_ID . '-' . $this->row . '"';
-        $html .= ' class="ticket-selector-tbl-qty-slct" value="' . $this->row . '-1"';
-        $html .= $this->total_tickets === 1 ? ' checked="checked"' : '';
-        $html .= ' title=""/>';
-        return $html;
-    }
-
-
-
-    /**
-     * ticketQuantitySelector
-     *
-     * @return string
-     * @throws EE_Error
-     */
-    protected function ticketQuantitySelector()
-    {
-        // display submit button since we have tickets available
-        add_filter('FHEE__EE_Ticket_Selector__display_ticket_selector_submit', '__return_true');
-        $this->hidden_input_qty = false;
-        $html = '<select name="tkt-slctr-qty-' . $this->EVT_ID . '[]"';
-        $html .= ' id="ticket-selector-tbl-qty-slct-' . $this->EVT_ID . '-' . $this->row . '"';
-        $html .= ' class="ticket-selector-tbl-qty-slct">';
-        // this ensures that non-required tickets with non-zero MIN QTYs don't HAVE to be purchased
-        if ($this->min !== 0 && ! $this->ticket->required()) {
-            $html .= '<option value="0">&nbsp;0&nbsp;</option>';
-        }
-        // offer ticket quantities from the min to the max
-        for ($i = $this->min; $i <= $this->max; $i++) {
-            $html .= '<option value="' . $i . '">&nbsp;' . $i . '&nbsp;</option>';
-        }
-        $html .= '</select>';
-        return $html;
-    }
-
-
-
-    /**
-     * getHiddenInputs
-     *
-     * @return string
-     * @throws EE_Error
-     */
-    protected function ticketQtyAndIdHiddenInputs()
-    {
-        $html = '';
-        // depending on group reg we need to change the format for qty
-        if ($this->hidden_input_qty) {
-            $html .= '<input type="hidden" name="tkt-slctr-qty-' . $this->EVT_ID . '[]" value="0"/>';
-        }
-        $html .= '<input type="hidden" name="tkt-slctr-ticket-id-' . $this->EVT_ID . '[]"';
-        $html .= ' value="' . $this->ticket->ID() . '"/>';
-        return $html;
-    }
+	/**
+	 * @var TicketDetails $ticket_details
+	 */
+	protected $ticket_details;
+
+	/**
+	 * @var \EE_Ticket_Selector_Config $template_settings
+	 */
+	protected $template_settings;
+
+	/**
+	 * @var EE_Tax_Config $tax_settings
+	 */
+	protected $tax_settings;
+
+	/**
+	 * @var boolean $prices_displayed_including_taxes
+	 */
+	protected $prices_displayed_including_taxes;
+
+	/**
+	 * @var int $row
+	 */
+	protected $row;
+
+	/**
+	 * @var int $cols
+	 */
+	protected $cols;
+
+	/**
+	 * @var boolean $hidden_input_qty
+	 */
+	protected $hidden_input_qty;
+
+	/**
+	 * @var string $ticket_datetime_classes
+	 */
+	protected $ticket_datetime_classes;
+
+
+
+	/**
+	 * TicketDetails constructor.
+	 *
+	 * @param TicketDetails  $ticket_details
+	 * @param EE_Tax_Config $tax_settings
+	 * @param int            $total_tickets
+	 * @param int            $max_attendees
+	 * @param int            $row
+	 * @param int            $cols
+	 * @param boolean        $required_ticket_sold_out
+	 * @param string         $event_status
+	 * @param string         $ticket_datetime_classes
+	 * @throws EE_Error
+	 * @throws UnexpectedEntityException
+	 */
+	public function __construct(
+		TicketDetails $ticket_details,
+		EE_Tax_Config $tax_settings,
+		$total_tickets,
+		$max_attendees,
+		$row,
+		$cols,
+		$required_ticket_sold_out,
+		$event_status,
+		$ticket_datetime_classes
+	) {
+		$this->ticket_details = $ticket_details;
+		$this->template_settings = $ticket_details->getTemplateSettings();
+		$this->tax_settings = $tax_settings;
+		$this->row = $row;
+		$this->cols = $cols;
+		$this->ticket_datetime_classes = $ticket_datetime_classes;
+		parent::__construct(
+			$ticket_details->getTicket(),
+			$max_attendees,
+			$ticket_details->getDateFormat(),
+			$event_status,
+			$required_ticket_sold_out,
+			$total_tickets
+		);
+	}
+
+
+
+	/**
+	 * other ticket rows will need to know if a required ticket is sold out,
+	 * so that they are not offered for sale
+	 *
+	 * @return boolean
+	 */
+	public function getRequiredTicketSoldOut()
+	{
+		return $this->required_ticket_sold_out;
+	}
+
+
+
+	/**
+	 * @return int
+	 */
+	public function getCols()
+	{
+		return $this->cols;
+	}
+
+
+
+	/**
+	 * getHtml
+	 *
+	 * @return string
+	 * @throws EE_Error
+	 */
+	public function getHtml()
+	{
+		$this->min = 0;
+		$this->max = $this->ticket->max();
+		$remaining = $this->ticket->remaining();
+		if ($this->ticket->is_on_sale() && $this->ticket->is_remaining()) {
+			 $this->setTicketMinAndMax($remaining);
+		} else {
+			// set flag if ticket is required (flag is set to start date so that future tickets are not blocked)
+			$this->required_ticket_sold_out = $this->ticket->required() && ! $remaining
+				? $this->ticket->start_date()
+				: $this->required_ticket_sold_out;
+		}
+		$this->setTicketPriceDetails();
+		$this->setTicketStatusClasses($remaining);
+		$filtered_row_html = $this->getFilteredRowHtml();
+		if ($filtered_row_html !== false) {
+			return $filtered_row_html;
+		}
+		$ticket_selector_row_html = EEH_HTML::tr(
+			'', '',
+			"tckt-slctr-tbl-tr {$this->status_class}{$this->ticket_datetime_classes} "
+			. espresso_get_object_css_class($this->ticket)
+		);
+		$filtered_row_content = $this->getFilteredRowContents();
+		if ($filtered_row_content !== false && $this->max_attendees === 1) {
+			return $ticket_selector_row_html
+				   . $filtered_row_content
+				   . $this->ticketQtyAndIdHiddenInputs()
+				   . EEH_HTML::trx();
+		}
+		if ($filtered_row_content !== false) {
+			return $ticket_selector_row_html
+				   . $filtered_row_content
+				   . EEH_HTML::trx();
+		}
+		$this->hidden_input_qty = $this->max_attendees > 1;
+
+		$ticket_selector_row_html .= $this->ticketNameTableCell();
+		$ticket_selector_row_html .= $this->ticketPriceTableCell();
+		$ticket_selector_row_html .= EEH_HTML::td('', '', 'tckt-slctr-tbl-td-qty cntr');
+		$this->setTicketStatusDisplay($remaining);
+		if (empty($this->ticket_status_display)) {
+			if ($this->max_attendees === 1) {
+				// only ONE attendee is allowed to register at a time
+				$ticket_selector_row_html .= $this->onlyOneAttendeeCanRegister();
+			} elseif ($this->max > 0) {
+				$ticket_selector_row_html .= $this->ticketQuantitySelector();
+			}
+		}
+		$ticket_selector_row_html .= $this->ticket_status_display;
+		$ticket_selector_row_html .= $this->ticketQtyAndIdHiddenInputs();
+		$ticket_selector_row_html .= $this->ticket_details->display(
+			$this->ticket_price,
+			$remaining,
+			$this->cols
+		);
+		$ticket_selector_row_html .= EEH_HTML::tdx();
+		$ticket_selector_row_html .= EEH_HTML::trx();
+
+
+		$this->row++;
+		return $ticket_selector_row_html;
+	}
+
+
+
+
+	/**
+	 * getTicketPriceDetails
+	 *
+	 * @return void
+	 * @throws EE_Error
+	 */
+	protected function setTicketPriceDetails()
+	{
+		$this->ticket_price = $this->tax_settings->prices_displayed_including_taxes
+			? $this->ticket->get_ticket_total_with_taxes()
+			: $this->ticket->get_ticket_subtotal();
+		$this->ticket_bundle = false;
+		$ticket_min = $this->ticket->min();
+		// for ticket bundles, set min and max qty the same
+		if ($ticket_min !== 0 && $ticket_min === $this->ticket->max()) {
+			$this->ticket_price *= $ticket_min;
+			$this->ticket_bundle = true;
+		}
+		$this->ticket_price = apply_filters(
+			'FHEE__ticket_selector_chart_template__ticket_price',
+			$this->ticket_price,
+			$this->ticket
+		);
+	}
+
+
+
+
+	/**
+	 * ticketNameTableCell
+	 *
+	 * @return string
+	 * @throws EE_Error
+	 */
+	protected function ticketNameTableCell()
+	{
+		$html = EEH_HTML::td('', '', 'tckt-slctr-tbl-td-name');
+		$html .= EEH_HTML::strong($this->ticket->get_pretty('TKT_name'));
+		$html .= $this->ticket_details->getShowHideLinks();
+		if ($this->ticket->required()) {
+			$html .= EEH_HTML::p(
+				apply_filters(
+						'FHEE__ticket_selector_chart_template__ticket_required_message',
+						esc_html__('This ticket is required and must be purchased.', 'event_espresso')
+				),
+				'', 'ticket-required-pg'
+			);
+		}
+		$html .= EEH_HTML::tdx();
+		return $html;
+	}
+
+
+
+	/**
+	 * ticketPriceTableCell
+	 *
+	 * @return string
+	 * @throws EE_Error
+	 */
+	protected function ticketPriceTableCell()
+	{
+		$html = '';
+		if (apply_filters('FHEE__ticket_selector_chart_template__display_ticket_price_details', true)) {
+			$html .= EEH_HTML::td('', '', 'tckt-slctr-tbl-td-price jst-rght');
+			$html .= \EEH_Template::format_currency($this->ticket_price);
+			$html .= $this->ticket->taxable()
+				? EEH_HTML::span( '*', '', 'taxable-tickets-asterisk grey-text' )
+				: '';
+			$html .= '&nbsp;';
+			$html .= EEH_HTML::span(
+				$this->ticket_bundle
+					? apply_filters(
+						'FHEE__ticket_selector_chart_template__per_ticket_bundle_text',
+						__(' / bundle', 'event_espresso')
+					)
+					: apply_filters(
+						'FHEE__ticket_selector_chart_template__per_ticket_text',
+						__('', 'event_espresso')
+					),
+				'', 'smaller-text no-bold'
+			);
+			$html .= '&nbsp;';
+			$html .= EEH_HTML::tdx();
+			$this->cols++;
+		}
+		return $html;
+	}
+
+
+
+	/**
+	 * onlyOneAttendeeCanRegister
+	 *
+	 * @return string
+	 */
+	protected function onlyOneAttendeeCanRegister()
+	{
+		// display submit button since we have tickets available
+		add_filter('FHEE__EE_Ticket_Selector__display_ticket_selector_submit', '__return_true');
+		$this->hidden_input_qty = false;
+		$html = '<input type="radio" name="tkt-slctr-qty-' . $this->EVT_ID . '"';
+		$html .= ' id="ticket-selector-tbl-qty-slct-' . $this->EVT_ID . '-' . $this->row . '"';
+		$html .= ' class="ticket-selector-tbl-qty-slct" value="' . $this->row . '-1"';
+		$html .= $this->total_tickets === 1 ? ' checked="checked"' : '';
+		$html .= ' title=""/>';
+		return $html;
+	}
+
+
+
+	/**
+	 * ticketQuantitySelector
+	 *
+	 * @return string
+	 * @throws EE_Error
+	 */
+	protected function ticketQuantitySelector()
+	{
+		// display submit button since we have tickets available
+		add_filter('FHEE__EE_Ticket_Selector__display_ticket_selector_submit', '__return_true');
+		$this->hidden_input_qty = false;
+		$html = '<select name="tkt-slctr-qty-' . $this->EVT_ID . '[]"';
+		$html .= ' id="ticket-selector-tbl-qty-slct-' . $this->EVT_ID . '-' . $this->row . '"';
+		$html .= ' class="ticket-selector-tbl-qty-slct">';
+		// this ensures that non-required tickets with non-zero MIN QTYs don't HAVE to be purchased
+		if ($this->min !== 0 && ! $this->ticket->required()) {
+			$html .= '<option value="0">&nbsp;0&nbsp;</option>';
+		}
+		// offer ticket quantities from the min to the max
+		for ($i = $this->min; $i <= $this->max; $i++) {
+			$html .= '<option value="' . $i . '">&nbsp;' . $i . '&nbsp;</option>';
+		}
+		$html .= '</select>';
+		return $html;
+	}
+
+
+
+	/**
+	 * getHiddenInputs
+	 *
+	 * @return string
+	 * @throws EE_Error
+	 */
+	protected function ticketQtyAndIdHiddenInputs()
+	{
+		$html = '';
+		// depending on group reg we need to change the format for qty
+		if ($this->hidden_input_qty) {
+			$html .= '<input type="hidden" name="tkt-slctr-qty-' . $this->EVT_ID . '[]" value="0"/>';
+		}
+		$html .= '<input type="hidden" name="tkt-slctr-ticket-id-' . $this->EVT_ID . '[]"';
+		$html .= ' value="' . $this->ticket->ID() . '"/>';
+		return $html;
+	}
 
 }
 // End of file TicketSelectorRowStandard.php

Spacing +10 added lines, -10 removed lines

@@ -271,7 +271,7 @@ 
             $html .= EEH_HTML::td('', '', 'tckt-slctr-tbl-td-price jst-rght');
             $html .= \EEH_Template::format_currency($this->ticket_price);
             $html .= $this->ticket->taxable()
-                ? EEH_HTML::span( '*', '', 'taxable-tickets-asterisk grey-text' )
+                ? EEH_HTML::span('*', '', 'taxable-tickets-asterisk grey-text')
                 : '';
             $html .= ' ';
             $html .= EEH_HTML::span(
@@ -305,9 +305,9 @@ 
         // display submit button since we have tickets available
         add_filter('FHEE__EE_Ticket_Selector__display_ticket_selector_submit', '__return_true');
         $this->hidden_input_qty = false;
-        $html = '<input type="radio" name="tkt-slctr-qty-' . $this->EVT_ID . '"';
-        $html .= ' id="ticket-selector-tbl-qty-slct-' . $this->EVT_ID . '-' . $this->row . '"';
-        $html .= ' class="ticket-selector-tbl-qty-slct" value="' . $this->row . '-1"';
+        $html = '<input type="radio" name="tkt-slctr-qty-'.$this->EVT_ID.'"';
+        $html .= ' id="ticket-selector-tbl-qty-slct-'.$this->EVT_ID.'-'.$this->row.'"';
+        $html .= ' class="ticket-selector-tbl-qty-slct" value="'.$this->row.'-1"';
         $html .= $this->total_tickets === 1 ? ' checked="checked"' : '';
         $html .= ' title=""/>';
         return $html;
@@ -326,8 +326,8 @@ 
         // display submit button since we have tickets available
         add_filter('FHEE__EE_Ticket_Selector__display_ticket_selector_submit', '__return_true');
         $this->hidden_input_qty = false;
-        $html = '<select name="tkt-slctr-qty-' . $this->EVT_ID . '[]"';
-        $html .= ' id="ticket-selector-tbl-qty-slct-' . $this->EVT_ID . '-' . $this->row . '"';
+        $html = '<select name="tkt-slctr-qty-'.$this->EVT_ID.'[]"';
+        $html .= ' id="ticket-selector-tbl-qty-slct-'.$this->EVT_ID.'-'.$this->row.'"';
         $html .= ' class="ticket-selector-tbl-qty-slct">';
         // this ensures that non-required tickets with non-zero MIN QTYs don't HAVE to be purchased
         if ($this->min !== 0 && ! $this->ticket->required()) {
@@ -335,7 +335,7 @@ 
         }
         // offer ticket quantities from the min to the max
         for ($i = $this->min; $i <= $this->max; $i++) {
-            $html .= '<option value="' . $i . '">&nbsp;' . $i . '&nbsp;</option>';
+            $html .= '<option value="'.$i.'">&nbsp;'.$i.'&nbsp;</option>';
         }
         $html .= '</select>';
         return $html;
@@ -354,10 +354,10 @@ 
         $html = '';
         // depending on group reg we need to change the format for qty
         if ($this->hidden_input_qty) {
-            $html .= '<input type="hidden" name="tkt-slctr-qty-' . $this->EVT_ID . '[]" value="0"/>';
+            $html .= '<input type="hidden" name="tkt-slctr-qty-'.$this->EVT_ID.'[]" value="0"/>';
         }
-        $html .= '<input type="hidden" name="tkt-slctr-ticket-id-' . $this->EVT_ID . '[]"';
-        $html .= ' value="' . $this->ticket->ID() . '"/>';
+        $html .= '<input type="hidden" name="tkt-slctr-ticket-id-'.$this->EVT_ID.'[]"';
+        $html .= ' value="'.$this->ticket->ID().'"/>';
         return $html;
     }
 

modules/ticket_selector/TicketSelectorRow.php

Indentation +364 added lines, -364 removed lines

@@ -22,370 +22,370 @@
 abstract class TicketSelectorRow
 {
 
-    /**
-     * @var EE_Ticket $ticket
-     */
-    protected $ticket;
-
-    /**
-     * @var int $total_tickets
-     */
-    protected $total_tickets;
-
-    /**
-     * @var int $max_attendees
-     */
-    protected $max_attendees;
-
-    /**
-     * @var string $date_format
-     */
-    protected $date_format;
-
-    /**
-     * @var int $EVT_ID
-     */
-    protected $EVT_ID;
-
-    /**
-     * @var string $event_status
-     */
-    protected $event_status;
-
-    /**
-     * @var boolean $required_ticket_sold_out
-     */
-    protected $required_ticket_sold_out;
-
-    /**
-     * @var string $ticket_status_display
-     */
-    protected $ticket_status_display;
-
-    /**
-     * @var int $max
-     */
-    protected $max = 0;
-
-    /**
-     * @var int $min
-     */
-    protected $min = 0;
-
-    /**
-     * @var float $ticket_price
-     */
-    protected $ticket_price = 0.00;
-
-    /**
-     * @var bool $ticket_bundle
-     */
-    protected $ticket_bundle = false;
-
-    /**
-     * @var string $ticket_status_id
-     */
-    protected $ticket_status_id = EE_Ticket::sold_out;
-
-    /**
-     * @var string $ticket_status_html
-     */
-    protected $ticket_status_html = 'ticket-sales-sold-out';
-
-    /**
-     * @var string $status_class
-     */
-    protected $status_class = 'ticket-sales-sold-out lt-grey-text';
-
-
-
-    /**
-     * @param EE_Ticket $ticket
-     * @param int       $max_attendees
-     * @param string    $date_format
-     * @param string    $event_status
-     * @param bool      $required_ticket_sold_out
-     * @param int       $total_tickets
-     * @throws EE_Error
-     * @throws UnexpectedEntityException
-     */
-    public function __construct(
-        EE_Ticket $ticket,
-        $max_attendees,
-        $date_format,
-        $event_status,
-        $required_ticket_sold_out = false,
-        $total_tickets = 1
-    ) {
-        $this->ticket = $ticket;
-        $this->max_attendees = $max_attendees;
-        $this->date_format = $date_format;
-        $this->EVT_ID = $this->ticket->get_event_ID();
-        $this->event_status = $event_status;
-        $this->required_ticket_sold_out = $required_ticket_sold_out;
-        $this->total_tickets = $total_tickets;
-    }
-
-
-
-    /**
-     * getTicketStatusClasses
-     *
-     * @param int $remaining
-     * @return void
-     * @throws EE_Error
-     */
-    protected function setTicketStatusClasses($remaining = 0)
-    {
-        // if a previous required ticket with the same sale start date is sold out,
-        // then mark this ticket as sold out as well.
-        // tickets that go on sale at a later date than the required ticket  will NOT be affected
-        $this->ticket_status_id = $this->required_ticket_sold_out !== false
-                      && $this->required_ticket_sold_out === $this->ticket->start_date()
-            ? EE_Ticket::sold_out
-            : $this->ticket->ticket_status();
-        $this->ticket_status_id = $this->event_status === EE_Datetime::sold_out
-            ? EE_Ticket::sold_out
-            : $this->ticket_status_id;
-        // check ticket status
-        switch ($this->ticket_status_id) {
-            // sold_out
-            case EE_Ticket::sold_out :
-                $ticket_status_class = 'ticket-sales-sold-out';
-                $this->status_class = 'ticket-sales-sold-out lt-grey-text';
-                break;
-            // expired
-            case EE_Ticket::expired :
-                $ticket_status_class = 'ticket-sales-expired';
-                $this->status_class = 'ticket-sales-expired lt-grey-text';
-                break;
-            // archived
-            case EE_Ticket::archived :
-                $ticket_status_class = 'archived-ticket';
-                $this->status_class = 'archived-ticket hidden';
-                break;
-            // pending
-            case EE_Ticket::pending :
-                $ticket_status_class = 'ticket-pending';
-                $this->status_class = 'ticket-pending';
-                break;
-            // on sale
-            case EE_Ticket::onsale :
-            default :
-                $ticket_status_class = 'ticket-on-sale';
-                $this->status_class = 'ticket-on-sale';
-                break;
-        }
-        $this->ticket_status_html = EEH_HTML::span(
-            $this->ticket->ticket_status(true, ($remaining > 0)),
-            "{$ticket_status_class}-{$this->ticket->ID()}",
-            $ticket_status_class
-        );
-    }
-
-
-    /**
-     * @return string
-     */
-    public function getTicketStatusDisplay()
-    {
-        return $this->ticket_status_display;
-    }
-
-
-
-    /**
-     * setTicketStatusDisplay
-     *
-     * @param int    $remaining
-     * @throws EE_Error
-     */
-    protected function setTicketStatusDisplay($remaining) {
-        $this->ticket_status_display = '';
-        // now depending on the ticket and other circumstances...
-        if ($this->max_attendees === 0) {
-            // registration is CLOSED because admin set max attendees to ZERO
-            $this->ticket_status_display = $this->registrationClosed();
-        } elseif ($this->ticket_status_id === EE_Ticket::sold_out || $remaining === 0) {
-            // SOLD OUT - no tickets remaining
-            $this->ticket_status_display = $this->ticketsSoldOut();
-        } elseif ($this->ticket_status_id === EE_Ticket::expired || $this->ticket_status_id === EE_Ticket::archived) {
-            // expired or archived ticket
-            $this->ticket_status_display = $this->ticket_status_html;
-        } elseif ($this->ticket_status_id === EE_Ticket::pending) {
-            // ticket not on sale yet
-            $this->ticket_status_display = $this->ticketsSalesPending();
-        } elseif ($this->ticket->min() > $remaining) {
-            // min qty purchasable is less than tickets available
-            $this->ticket_status_display = $this->notEnoughTicketsAvailable();
-        }
-    }
-
-
-
-    /**
-     * registrationClosed
-     */
-    protected function registrationClosed()
-    {
-        return EEH_HTML::span(
-            apply_filters(
-                'FHEE__ticket_selector_chart_template__ticket_closed_msg',
-                __('Closed', 'event_espresso')
-            ),
-            '', 'sold-out'
-        );
-    }
-
-
-
-    /**
-     * ticketsSoldOut
-     */
-    protected function ticketsSoldOut()
-    {
-        return EEH_HTML::span(
-            apply_filters(
-                'FHEE__ticket_selector_chart_template__ticket_sold_out_msg',
-                __('Sold Out', 'event_espresso')
-            ),
-            '', 'sold-out'
-        );
-    }
-
-
-
-    /**
-     * ticketsSalesPending
-     *
-     * @throws EE_Error
-     */
-    protected function ticketsSalesPending()
-    {
-        return EEH_HTML::span(
-            EEH_HTML::span(
-                apply_filters(
-                    'FHEE__ticket_selector_chart_template__ticket_goes_on_sale_msg',
-                    __('Goes On Sale', 'event_espresso')
-                ),
-                '', 'ticket-pending'
-            )
-            . EEH_HTML::br()
-            . EEH_HTML::span(
-                $this->ticket->get_i18n_datetime(
-                    'TKT_start_date',
-                    apply_filters(
-                        'FHEE__EED_Ticket_Selector__display_goes_on_sale__date_format',
-                        $this->date_format
-                    )
-                ),
-                '', 'small-text'
-            ),
-            '', 'ticket-pending-pg'
-        );
-    }
-
-
-
-    /**
-     * notEnoughTicketsAvailable
-     */
-    protected function notEnoughTicketsAvailable()
-    {
-        return EEH_HTML::div(
-            EEH_HTML::span(
-                apply_filters(
-                    'FHEE__ticket_selector_chart_template__ticket_not_available_msg',
-                    __('Not Available', 'event_espresso')
-                ),
-                '', 'archived-ticket small-text'
-            )
-            . EEH_HTML::br(),
-            '', 'archived-ticket-pg'
-        );
-    }
-
-
-
-    /**
-     * setTicketMinAndMax
-     *
-     * @param int $remaining
-     * @return void
-     * @throws EE_Error
-     */
-    protected function setTicketMinAndMax($remaining)
-    {
-        // offer the number of $tickets_remaining or $this->max_attendees, whichever is smaller
-        $this->max = min($remaining, $this->max_attendees);
-        // but... we also want to restrict the number of tickets by the ticket max setting,
-        // however, the max still can't be higher than what was just set above
-        $this->max = $this->ticket->max() > 0
-            ? min($this->ticket->max(), $this->max)
-            : $this->max;
-        // and we also want to restrict the minimum number of tickets by the ticket min setting
-        $this->min = $this->ticket->min() > 0
-            ? $this->ticket->min()
-            : 0;
-        // and if the ticket is required, then make sure that min qty is at least 1
-        $this->min = $this->ticket->required()
-            ? max($this->min, 1)
-            : $this->min;
-    }
-
-
-    /**
-     * Allow plugins to hook in and abort the generation and display of this row to do
-     * something elseif they want.
-     * For an addon to abort things, all they have to do is register a filter with this hook, and
-     * return a value that is NOT false.  Whatever is returned gets echoed instead of the
-     * current row.
-     *
-     * @return string|bool
-     */
-    protected function getFilteredRowHtml() {
-        return apply_filters(
-            'FHEE__ticket_selector_chart_template__do_ticket_entire_row',
-            false,
-            $this->ticket,
-            $this->max,
-            $this->min,
-            $this->required_ticket_sold_out,
-            $this->ticket_price,
-            $this->ticket_bundle,
-            $this->ticket_status_html,
-            $this->status_class,
-            $this
-        );
-    }
-
-
-
-    /**
-     * Allow plugins to hook in and abort the generation and display of the contents of this
-     * row to do something elseif they want.
-     * For an addon to abort things, all they have to do is register a filter with this hook, and
-     * return a value that is NOT false.  Whatever is returned gets echoed instead of the
-     * current row.
-     *
-     * @return string|bool
-     */
-    protected function getFilteredRowContents()
-    {
-        return apply_filters(
-            'FHEE__ticket_selector_chart_template__do_ticket_inside_row',
-            false,
-            $this->ticket,
-            $this->max,
-            $this->min,
-            $this->required_ticket_sold_out,
-            $this->ticket_price,
-            $this->ticket_bundle,
-            $this->ticket_status_html,
-            $this->status_class,
-            $this
-        );
-    }
+	/**
+	 * @var EE_Ticket $ticket
+	 */
+	protected $ticket;
+
+	/**
+	 * @var int $total_tickets
+	 */
+	protected $total_tickets;
+
+	/**
+	 * @var int $max_attendees
+	 */
+	protected $max_attendees;
+
+	/**
+	 * @var string $date_format
+	 */
+	protected $date_format;
+
+	/**
+	 * @var int $EVT_ID
+	 */
+	protected $EVT_ID;
+
+	/**
+	 * @var string $event_status
+	 */
+	protected $event_status;
+
+	/**
+	 * @var boolean $required_ticket_sold_out
+	 */
+	protected $required_ticket_sold_out;
+
+	/**
+	 * @var string $ticket_status_display
+	 */
+	protected $ticket_status_display;
+
+	/**
+	 * @var int $max
+	 */
+	protected $max = 0;
+
+	/**
+	 * @var int $min
+	 */
+	protected $min = 0;
+
+	/**
+	 * @var float $ticket_price
+	 */
+	protected $ticket_price = 0.00;
+
+	/**
+	 * @var bool $ticket_bundle
+	 */
+	protected $ticket_bundle = false;
+
+	/**
+	 * @var string $ticket_status_id
+	 */
+	protected $ticket_status_id = EE_Ticket::sold_out;
+
+	/**
+	 * @var string $ticket_status_html
+	 */
+	protected $ticket_status_html = 'ticket-sales-sold-out';
+
+	/**
+	 * @var string $status_class
+	 */
+	protected $status_class = 'ticket-sales-sold-out lt-grey-text';
+
+
+
+	/**
+	 * @param EE_Ticket $ticket
+	 * @param int       $max_attendees
+	 * @param string    $date_format
+	 * @param string    $event_status
+	 * @param bool      $required_ticket_sold_out
+	 * @param int       $total_tickets
+	 * @throws EE_Error
+	 * @throws UnexpectedEntityException
+	 */
+	public function __construct(
+		EE_Ticket $ticket,
+		$max_attendees,
+		$date_format,
+		$event_status,
+		$required_ticket_sold_out = false,
+		$total_tickets = 1
+	) {
+		$this->ticket = $ticket;
+		$this->max_attendees = $max_attendees;
+		$this->date_format = $date_format;
+		$this->EVT_ID = $this->ticket->get_event_ID();
+		$this->event_status = $event_status;
+		$this->required_ticket_sold_out = $required_ticket_sold_out;
+		$this->total_tickets = $total_tickets;
+	}
+
+
+
+	/**
+	 * getTicketStatusClasses
+	 *
+	 * @param int $remaining
+	 * @return void
+	 * @throws EE_Error
+	 */
+	protected function setTicketStatusClasses($remaining = 0)
+	{
+		// if a previous required ticket with the same sale start date is sold out,
+		// then mark this ticket as sold out as well.
+		// tickets that go on sale at a later date than the required ticket  will NOT be affected
+		$this->ticket_status_id = $this->required_ticket_sold_out !== false
+					  && $this->required_ticket_sold_out === $this->ticket->start_date()
+			? EE_Ticket::sold_out
+			: $this->ticket->ticket_status();
+		$this->ticket_status_id = $this->event_status === EE_Datetime::sold_out
+			? EE_Ticket::sold_out
+			: $this->ticket_status_id;
+		// check ticket status
+		switch ($this->ticket_status_id) {
+			// sold_out
+			case EE_Ticket::sold_out :
+				$ticket_status_class = 'ticket-sales-sold-out';
+				$this->status_class = 'ticket-sales-sold-out lt-grey-text';
+				break;
+			// expired
+			case EE_Ticket::expired :
+				$ticket_status_class = 'ticket-sales-expired';
+				$this->status_class = 'ticket-sales-expired lt-grey-text';
+				break;
+			// archived
+			case EE_Ticket::archived :
+				$ticket_status_class = 'archived-ticket';
+				$this->status_class = 'archived-ticket hidden';
+				break;
+			// pending
+			case EE_Ticket::pending :
+				$ticket_status_class = 'ticket-pending';
+				$this->status_class = 'ticket-pending';
+				break;
+			// on sale
+			case EE_Ticket::onsale :
+			default :
+				$ticket_status_class = 'ticket-on-sale';
+				$this->status_class = 'ticket-on-sale';
+				break;
+		}
+		$this->ticket_status_html = EEH_HTML::span(
+			$this->ticket->ticket_status(true, ($remaining > 0)),
+			"{$ticket_status_class}-{$this->ticket->ID()}",
+			$ticket_status_class
+		);
+	}
+
+
+	/**
+	 * @return string
+	 */
+	public function getTicketStatusDisplay()
+	{
+		return $this->ticket_status_display;
+	}
+
+
+
+	/**
+	 * setTicketStatusDisplay
+	 *
+	 * @param int    $remaining
+	 * @throws EE_Error
+	 */
+	protected function setTicketStatusDisplay($remaining) {
+		$this->ticket_status_display = '';
+		// now depending on the ticket and other circumstances...
+		if ($this->max_attendees === 0) {
+			// registration is CLOSED because admin set max attendees to ZERO
+			$this->ticket_status_display = $this->registrationClosed();
+		} elseif ($this->ticket_status_id === EE_Ticket::sold_out || $remaining === 0) {
+			// SOLD OUT - no tickets remaining
+			$this->ticket_status_display = $this->ticketsSoldOut();
+		} elseif ($this->ticket_status_id === EE_Ticket::expired || $this->ticket_status_id === EE_Ticket::archived) {
+			// expired or archived ticket
+			$this->ticket_status_display = $this->ticket_status_html;
+		} elseif ($this->ticket_status_id === EE_Ticket::pending) {
+			// ticket not on sale yet
+			$this->ticket_status_display = $this->ticketsSalesPending();
+		} elseif ($this->ticket->min() > $remaining) {
+			// min qty purchasable is less than tickets available
+			$this->ticket_status_display = $this->notEnoughTicketsAvailable();
+		}
+	}
+
+
+
+	/**
+	 * registrationClosed
+	 */
+	protected function registrationClosed()
+	{
+		return EEH_HTML::span(
+			apply_filters(
+				'FHEE__ticket_selector_chart_template__ticket_closed_msg',
+				__('Closed', 'event_espresso')
+			),
+			'', 'sold-out'
+		);
+	}
+
+
+
+	/**
+	 * ticketsSoldOut
+	 */
+	protected function ticketsSoldOut()
+	{
+		return EEH_HTML::span(
+			apply_filters(
+				'FHEE__ticket_selector_chart_template__ticket_sold_out_msg',
+				__('Sold Out', 'event_espresso')
+			),
+			'', 'sold-out'
+		);
+	}
+
+
+
+	/**
+	 * ticketsSalesPending
+	 *
+	 * @throws EE_Error
+	 */
+	protected function ticketsSalesPending()
+	{
+		return EEH_HTML::span(
+			EEH_HTML::span(
+				apply_filters(
+					'FHEE__ticket_selector_chart_template__ticket_goes_on_sale_msg',
+					__('Goes On Sale', 'event_espresso')
+				),
+				'', 'ticket-pending'
+			)
+			. EEH_HTML::br()
+			. EEH_HTML::span(
+				$this->ticket->get_i18n_datetime(
+					'TKT_start_date',
+					apply_filters(
+						'FHEE__EED_Ticket_Selector__display_goes_on_sale__date_format',
+						$this->date_format
+					)
+				),
+				'', 'small-text'
+			),
+			'', 'ticket-pending-pg'
+		);
+	}
+
+
+
+	/**
+	 * notEnoughTicketsAvailable
+	 */
+	protected function notEnoughTicketsAvailable()
+	{
+		return EEH_HTML::div(
+			EEH_HTML::span(
+				apply_filters(
+					'FHEE__ticket_selector_chart_template__ticket_not_available_msg',
+					__('Not Available', 'event_espresso')
+				),
+				'', 'archived-ticket small-text'
+			)
+			. EEH_HTML::br(),
+			'', 'archived-ticket-pg'
+		);
+	}
+
+
+
+	/**
+	 * setTicketMinAndMax
+	 *
+	 * @param int $remaining
+	 * @return void
+	 * @throws EE_Error
+	 */
+	protected function setTicketMinAndMax($remaining)
+	{
+		// offer the number of $tickets_remaining or $this->max_attendees, whichever is smaller
+		$this->max = min($remaining, $this->max_attendees);
+		// but... we also want to restrict the number of tickets by the ticket max setting,
+		// however, the max still can't be higher than what was just set above
+		$this->max = $this->ticket->max() > 0
+			? min($this->ticket->max(), $this->max)
+			: $this->max;
+		// and we also want to restrict the minimum number of tickets by the ticket min setting
+		$this->min = $this->ticket->min() > 0
+			? $this->ticket->min()
+			: 0;
+		// and if the ticket is required, then make sure that min qty is at least 1
+		$this->min = $this->ticket->required()
+			? max($this->min, 1)
+			: $this->min;
+	}
+
+
+	/**
+	 * Allow plugins to hook in and abort the generation and display of this row to do
+	 * something elseif they want.
+	 * For an addon to abort things, all they have to do is register a filter with this hook, and
+	 * return a value that is NOT false.  Whatever is returned gets echoed instead of the
+	 * current row.
+	 *
+	 * @return string|bool
+	 */
+	protected function getFilteredRowHtml() {
+		return apply_filters(
+			'FHEE__ticket_selector_chart_template__do_ticket_entire_row',
+			false,
+			$this->ticket,
+			$this->max,
+			$this->min,
+			$this->required_ticket_sold_out,
+			$this->ticket_price,
+			$this->ticket_bundle,
+			$this->ticket_status_html,
+			$this->status_class,
+			$this
+		);
+	}
+
+
+
+	/**
+	 * Allow plugins to hook in and abort the generation and display of the contents of this
+	 * row to do something elseif they want.
+	 * For an addon to abort things, all they have to do is register a filter with this hook, and
+	 * return a value that is NOT false.  Whatever is returned gets echoed instead of the
+	 * current row.
+	 *
+	 * @return string|bool
+	 */
+	protected function getFilteredRowContents()
+	{
+		return apply_filters(
+			'FHEE__ticket_selector_chart_template__do_ticket_inside_row',
+			false,
+			$this->ticket,
+			$this->max,
+			$this->min,
+			$this->required_ticket_sold_out,
+			$this->ticket_price,
+			$this->ticket_bundle,
+			$this->ticket_status_html,
+			$this->status_class,
+			$this
+		);
+	}
 
 }
 // End of file TicketSelectorRow.php

modules/ticket_selector/templates/simple_ticket_selector.template.php

Indentation +8 added lines, -8 removed lines

@@ -12,13 +12,13 @@ 
 <input type="hidden" name="tkt-slctr-ticket-id-<?php echo $EVT_ID; ?>[]" value="<?php echo $TKT_ID; ?>"/>
 <?php
 if ( $ticket instanceof EE_Ticket ) {
-    do_action( 'AHEE__ticket_selector_chart__template__before_ticket_selector', $event );
-    $ticket_description .= ! empty( $ticket_description )
-        ? '<br />' . $ticket_status_display
-        : $ticket_status_display;
-    if (strpos( $ticket_description, '<div' ) === false) {
-        $ticket_description = "<p>{$ticket_description}</p>";
-    }
+	do_action( 'AHEE__ticket_selector_chart__template__before_ticket_selector', $event );
+	$ticket_description .= ! empty( $ticket_description )
+		? '<br />' . $ticket_status_display
+		: $ticket_status_display;
+	if (strpos( $ticket_description, '<div' ) === false) {
+		$ticket_description = "<p>{$ticket_description}</p>";
+	}
 ?>
 <div id="no-tkt-slctr-ticket-dv-<?php echo $EVT_ID; ?>" class="no-tkt-slctr-ticket-dv">
     <div class="no-tkt-slctr-ticket-content-dv">
@@ -28,6 +28,6 @@ 
         <?php } ?>
     </div><!-- .no-tkt-slctr-ticket-content-dv -->
 <?php
-    do_action( 'AHEE__ticket_selector_chart__template__after_ticket_selector', $EVT_ID, $event );
+	do_action( 'AHEE__ticket_selector_chart__template__after_ticket_selector', $EVT_ID, $event );
 }
 ?>

Spacing +7 added lines, -7 removed lines

@@ -11,23 +11,23 @@
 <input type="hidden" name="tkt-slctr-qty-<?php echo $EVT_ID; ?>[]" value="1"/>
 <input type="hidden" name="tkt-slctr-ticket-id-<?php echo $EVT_ID; ?>[]" value="<?php echo $TKT_ID; ?>"/>
 <?php
-if ( $ticket instanceof EE_Ticket ) {
-    do_action( 'AHEE__ticket_selector_chart__template__before_ticket_selector', $event );
-    $ticket_description .= ! empty( $ticket_description )
-        ? '<br />' . $ticket_status_display
+if ($ticket instanceof EE_Ticket) {
+    do_action('AHEE__ticket_selector_chart__template__before_ticket_selector', $event);
+    $ticket_description .= ! empty($ticket_description)
+        ? '<br />'.$ticket_status_display
         : $ticket_status_display;
-    if (strpos( $ticket_description, '<div' ) === false) {
+    if (strpos($ticket_description, '<div') === false) {
         $ticket_description = "<p>{$ticket_description}</p>";
     }
 ?>
 <div id="no-tkt-slctr-ticket-dv-<?php echo $EVT_ID; ?>" class="no-tkt-slctr-ticket-dv">
     <div class="no-tkt-slctr-ticket-content-dv">
         <h5><?php echo $ticket->name(); ?></h5>
-        <?php if ( ! empty( $ticket_description ) ) { ?>
+        <?php if ( ! empty($ticket_description)) { ?>
         <?php echo $ticket_description; ?>
         <?php } ?>
     </div><!-- .no-tkt-slctr-ticket-content-dv -->
 <?php
-    do_action( 'AHEE__ticket_selector_chart__template__after_ticket_selector', $EVT_ID, $event );
+    do_action('AHEE__ticket_selector_chart__template__after_ticket_selector', $EVT_ID, $event);
 }
 ?>