eventespresso / event-espresso-core

core/libraries/plugin_api/db/EEME_Base.lib.php

Spacing +17 added lines, -17 removed lines

@@ -71,7 +71,7 @@ 
      */
     public function __construct()
     {
-        if (! $this->_model_name_extended) {
+        if ( ! $this->_model_name_extended) {
             throw new EE_Error(
                 esc_html__(
                     "When declaring a model extension, you must define its _model_name_extended property. It should be a model name like 'Attendee' or 'Event'",
@@ -79,7 +79,7 @@ 
                 )
             );
         }
-        $construct_end_action = 'AHEE__EEM_' . $this->_model_name_extended . '__construct__end';
+        $construct_end_action = 'AHEE__EEM_'.$this->_model_name_extended.'__construct__end';
         if (did_action($construct_end_action)) {
             throw new EE_Error(
                 sprintf(
@@ -94,15 +94,15 @@ 
             );
         }
         add_filter(
-            'FHEE__EEM_' . $this->_model_name_extended . '__construct__tables',
+            'FHEE__EEM_'.$this->_model_name_extended.'__construct__tables',
             array($this, 'add_extra_tables_on_filter')
         );
         add_filter(
-            'FHEE__EEM_' . $this->_model_name_extended . '__construct__fields',
+            'FHEE__EEM_'.$this->_model_name_extended.'__construct__fields',
             array($this, 'add_extra_fields_on_filter')
         );
         add_filter(
-            'FHEE__EEM_' . $this->_model_name_extended . '__construct__model_relations',
+            'FHEE__EEM_'.$this->_model_name_extended.'__construct__model_relations',
             array($this, 'add_extra_relations_on_filter')
         );
         $this->_register_extending_methods();
@@ -127,12 +127,12 @@ 
     {
         if ($this->_extra_fields) {
             foreach ($this->_extra_fields as $table_alias => $fields) {
-                if (! isset($existing_fields[ $table_alias ])) {
-                    $existing_fields[ $table_alias ] = array();
+                if ( ! isset($existing_fields[$table_alias])) {
+                    $existing_fields[$table_alias] = array();
                 }
-                $existing_fields[ $table_alias ] = array_merge(
-                    (array) $existing_fields[ $table_alias ],
-                    $this->_extra_fields[ $table_alias ]
+                $existing_fields[$table_alias] = array_merge(
+                    (array) $existing_fields[$table_alias],
+                    $this->_extra_fields[$table_alias]
                 );
             }
         }
@@ -163,7 +163,7 @@ 
                 $callback_name = "FHEE__EEM_{$this->_model_name_extended}__$method_name_on_model";
                 add_filter(
                     $callback_name,
-                    array($this, self::dynamic_callback_method_prefix . $method_name_on_model),
+                    array($this, self::dynamic_callback_method_prefix.$method_name_on_model),
                     10,
                     10
                 );
@@ -178,15 +178,15 @@ 
     public function deregister()
     {
         remove_filter(
-            'FHEE__EEM_' . $this->_model_name_extended . '__construct__tables',
+            'FHEE__EEM_'.$this->_model_name_extended.'__construct__tables',
             array($this, 'add_extra_tables_on_filter')
         );
         remove_filter(
-            'FHEE__EEM_' . $this->_model_name_extended . '__construct__fields',
+            'FHEE__EEM_'.$this->_model_name_extended.'__construct__fields',
             array($this, 'add_extra_fields_on_filter')
         );
         remove_filter(
-            'FHEE__EEM_' . $this->_model_name_extended . '__construct__model_relations',
+            'FHEE__EEM_'.$this->_model_name_extended.'__construct__model_relations',
             array($this, 'add_extra_relations_on_filter')
         );
         $all_methods = get_class_methods(get_class($this));
@@ -196,13 +196,13 @@ 
                 $callback_name = "FHEE__EEM_{$this->_model_name_extended}__$method_name_on_model";
                 remove_filter(
                     $callback_name,
-                    array($this, self::dynamic_callback_method_prefix . $method_name_on_model),
+                    array($this, self::dynamic_callback_method_prefix.$method_name_on_model),
                     10
                 );
             }
         }
         /** @var EEM_Base $model_to_reset */
-        $model_to_reset = 'EEM_' . $this->_model_name_extended;
+        $model_to_reset = 'EEM_'.$this->_model_name_extended;
         if (class_exists($model_to_reset)) {
             $model_to_reset::reset();
         }
@@ -224,7 +224,7 @@ 
             // phpcs:disable WordPress.WP.I18n.SingleUnderscoreGetTextFunction
             $this->_ = $model_called;
             // phpcs:enable
-            $extending_method = self::extending_method_prefix . $method_called_on_model;
+            $extending_method = self::extending_method_prefix.$method_called_on_model;
             if (method_exists($this, $extending_method)) {
                 return call_user_func_array(array($this, $extending_method), $args_provided_to_method_on_model);
             } else {

Indentation +207 added lines, -207 removed lines

@@ -43,211 +43,211 @@
  */
 abstract class EEME_Base
 {
-    const extending_method_prefix = 'ext_';
-    const dynamic_callback_method_prefix = 'dynamic_callback_method_';
-
-    protected $_extra_tables = array();
-    protected $_extra_fields = array();
-    protected $_extra_relations = array();
-
-    /**
-     * The model name that is extended (not classname)
-     *
-     * @var string
-     */
-    protected $_model_name_extended = null;
-
-    /**
-     * The model this extends
-     *
-     * @var EEM_Base
-     */
-    protected $_ = null;
-
-
-    /**
-     * @throws \EE_Error
-     */
-    public function __construct()
-    {
-        if (! $this->_model_name_extended) {
-            throw new EE_Error(
-                esc_html__(
-                    "When declaring a model extension, you must define its _model_name_extended property. It should be a model name like 'Attendee' or 'Event'",
-                    "event_espresso"
-                )
-            );
-        }
-        $construct_end_action = 'AHEE__EEM_' . $this->_model_name_extended . '__construct__end';
-        if (did_action($construct_end_action)) {
-            throw new EE_Error(
-                sprintf(
-                    esc_html__(
-                        "Hooked in model extension '%s' too late! The model %s has already been used! We know because the action %s has been fired",
-                        "event_espresso"
-                    ),
-                    get_class($this),
-                    $this->_model_name_extended,
-                    $construct_end_action
-                )
-            );
-        }
-        add_filter(
-            'FHEE__EEM_' . $this->_model_name_extended . '__construct__tables',
-            array($this, 'add_extra_tables_on_filter')
-        );
-        add_filter(
-            'FHEE__EEM_' . $this->_model_name_extended . '__construct__fields',
-            array($this, 'add_extra_fields_on_filter')
-        );
-        add_filter(
-            'FHEE__EEM_' . $this->_model_name_extended . '__construct__model_relations',
-            array($this, 'add_extra_relations_on_filter')
-        );
-        $this->_register_extending_methods();
-    }
-
-
-    /**
-     * @param array $existing_tables
-     * @return array
-     */
-    public function add_extra_tables_on_filter($existing_tables)
-    {
-        return array_merge((array) $existing_tables, $this->_extra_tables);
-    }
-
-
-    /**
-     * @param array $existing_fields
-     * @return array
-     */
-    public function add_extra_fields_on_filter($existing_fields)
-    {
-        if ($this->_extra_fields) {
-            foreach ($this->_extra_fields as $table_alias => $fields) {
-                if (! isset($existing_fields[ $table_alias ])) {
-                    $existing_fields[ $table_alias ] = array();
-                }
-                $existing_fields[ $table_alias ] = array_merge(
-                    (array) $existing_fields[ $table_alias ],
-                    $this->_extra_fields[ $table_alias ]
-                );
-            }
-        }
-        return $existing_fields;
-    }
-
-
-    /**
-     * @param array $existing_relations
-     * @return array
-     */
-    public function add_extra_relations_on_filter($existing_relations)
-    {
-        return array_merge((array) $existing_relations, $this->_extra_relations);
-    }
-
-
-    /**
-     * scans the child of EEME_Base for functions starting with ext_, and magically makes them functions on the
-     * model extended. (Internally uses filters, and the __call magic method)
-     */
-    protected function _register_extending_methods()
-    {
-        $all_methods = get_class_methods(get_class($this));
-        foreach ($all_methods as $method_name) {
-            if (strpos($method_name, self::extending_method_prefix) === 0) {
-                $method_name_on_model = str_replace(self::extending_method_prefix, '', $method_name);
-                $callback_name = "FHEE__EEM_{$this->_model_name_extended}__$method_name_on_model";
-                add_filter(
-                    $callback_name,
-                    array($this, self::dynamic_callback_method_prefix . $method_name_on_model),
-                    10,
-                    10
-                );
-            }
-        }
-    }
-
-    /**
-     * scans the child of EEME_Base for functions starting with ext_, and magically REMOVES them as functions on the
-     * model extended. (Internally uses filters, and the __call magic method)
-     */
-    public function deregister()
-    {
-        remove_filter(
-            'FHEE__EEM_' . $this->_model_name_extended . '__construct__tables',
-            array($this, 'add_extra_tables_on_filter')
-        );
-        remove_filter(
-            'FHEE__EEM_' . $this->_model_name_extended . '__construct__fields',
-            array($this, 'add_extra_fields_on_filter')
-        );
-        remove_filter(
-            'FHEE__EEM_' . $this->_model_name_extended . '__construct__model_relations',
-            array($this, 'add_extra_relations_on_filter')
-        );
-        $all_methods = get_class_methods(get_class($this));
-        foreach ($all_methods as $method_name) {
-            if (strpos($method_name, self::extending_method_prefix) === 0) {
-                $method_name_on_model = str_replace(self::extending_method_prefix, '', $method_name);
-                $callback_name = "FHEE__EEM_{$this->_model_name_extended}__$method_name_on_model";
-                remove_filter(
-                    $callback_name,
-                    array($this, self::dynamic_callback_method_prefix . $method_name_on_model),
-                    10
-                );
-            }
-        }
-        /** @var EEM_Base $model_to_reset */
-        $model_to_reset = 'EEM_' . $this->_model_name_extended;
-        if (class_exists($model_to_reset)) {
-            $model_to_reset::reset();
-        }
-    }
-
-
-    /**
-     * @param string $callback_method_name
-     * @param array  $args
-     * @return mixed
-     * @throws EE_Error
-     */
-    public function __call($callback_method_name, $args)
-    {
-        if (strpos($callback_method_name, self::dynamic_callback_method_prefix) === 0) {
-            // it's a dynamic callback for a method name
-            $method_called_on_model = str_replace(self::dynamic_callback_method_prefix, '', $callback_method_name);
-            list($original_return_val, $model_called, $args_provided_to_method_on_model) = (array) $args;
-            // phpcs:disable WordPress.WP.I18n.SingleUnderscoreGetTextFunction
-            $this->_ = $model_called;
-            // phpcs:enable
-            $extending_method = self::extending_method_prefix . $method_called_on_model;
-            if (method_exists($this, $extending_method)) {
-                return call_user_func_array(array($this, $extending_method), $args_provided_to_method_on_model);
-            } else {
-                throw new EE_Error(
-                    sprintf(
-                        esc_html__(
-                            "An odd error occurred. Model '%s' had a method called on it that it didn't recognize. So it passed it onto the model extension '%s' (because it had a function named '%s' which should be able to handle it), but the function '%s' doesnt exist!)",
-                            "event_espresso"
-                        ),
-                        $this->_model_name_extended,
-                        get_class($this),
-                        $extending_method,
-                        $extending_method
-                    )
-                );
-            }
-        } else {
-            throw new EE_Error(
-                sprintf(
-                    esc_html__("There is no method named '%s' on '%s'", "event_espresso"),
-                    $callback_method_name,
-                    get_class($this)
-                )
-            );
-        }
-    }
+	const extending_method_prefix = 'ext_';
+	const dynamic_callback_method_prefix = 'dynamic_callback_method_';
+
+	protected $_extra_tables = array();
+	protected $_extra_fields = array();
+	protected $_extra_relations = array();
+
+	/**
+	 * The model name that is extended (not classname)
+	 *
+	 * @var string
+	 */
+	protected $_model_name_extended = null;
+
+	/**
+	 * The model this extends
+	 *
+	 * @var EEM_Base
+	 */
+	protected $_ = null;
+
+
+	/**
+	 * @throws \EE_Error
+	 */
+	public function __construct()
+	{
+		if (! $this->_model_name_extended) {
+			throw new EE_Error(
+				esc_html__(
+					"When declaring a model extension, you must define its _model_name_extended property. It should be a model name like 'Attendee' or 'Event'",
+					"event_espresso"
+				)
+			);
+		}
+		$construct_end_action = 'AHEE__EEM_' . $this->_model_name_extended . '__construct__end';
+		if (did_action($construct_end_action)) {
+			throw new EE_Error(
+				sprintf(
+					esc_html__(
+						"Hooked in model extension '%s' too late! The model %s has already been used! We know because the action %s has been fired",
+						"event_espresso"
+					),
+					get_class($this),
+					$this->_model_name_extended,
+					$construct_end_action
+				)
+			);
+		}
+		add_filter(
+			'FHEE__EEM_' . $this->_model_name_extended . '__construct__tables',
+			array($this, 'add_extra_tables_on_filter')
+		);
+		add_filter(
+			'FHEE__EEM_' . $this->_model_name_extended . '__construct__fields',
+			array($this, 'add_extra_fields_on_filter')
+		);
+		add_filter(
+			'FHEE__EEM_' . $this->_model_name_extended . '__construct__model_relations',
+			array($this, 'add_extra_relations_on_filter')
+		);
+		$this->_register_extending_methods();
+	}
+
+
+	/**
+	 * @param array $existing_tables
+	 * @return array
+	 */
+	public function add_extra_tables_on_filter($existing_tables)
+	{
+		return array_merge((array) $existing_tables, $this->_extra_tables);
+	}
+
+
+	/**
+	 * @param array $existing_fields
+	 * @return array
+	 */
+	public function add_extra_fields_on_filter($existing_fields)
+	{
+		if ($this->_extra_fields) {
+			foreach ($this->_extra_fields as $table_alias => $fields) {
+				if (! isset($existing_fields[ $table_alias ])) {
+					$existing_fields[ $table_alias ] = array();
+				}
+				$existing_fields[ $table_alias ] = array_merge(
+					(array) $existing_fields[ $table_alias ],
+					$this->_extra_fields[ $table_alias ]
+				);
+			}
+		}
+		return $existing_fields;
+	}
+
+
+	/**
+	 * @param array $existing_relations
+	 * @return array
+	 */
+	public function add_extra_relations_on_filter($existing_relations)
+	{
+		return array_merge((array) $existing_relations, $this->_extra_relations);
+	}
+
+
+	/**
+	 * scans the child of EEME_Base for functions starting with ext_, and magically makes them functions on the
+	 * model extended. (Internally uses filters, and the __call magic method)
+	 */
+	protected function _register_extending_methods()
+	{
+		$all_methods = get_class_methods(get_class($this));
+		foreach ($all_methods as $method_name) {
+			if (strpos($method_name, self::extending_method_prefix) === 0) {
+				$method_name_on_model = str_replace(self::extending_method_prefix, '', $method_name);
+				$callback_name = "FHEE__EEM_{$this->_model_name_extended}__$method_name_on_model";
+				add_filter(
+					$callback_name,
+					array($this, self::dynamic_callback_method_prefix . $method_name_on_model),
+					10,
+					10
+				);
+			}
+		}
+	}
+
+	/**
+	 * scans the child of EEME_Base for functions starting with ext_, and magically REMOVES them as functions on the
+	 * model extended. (Internally uses filters, and the __call magic method)
+	 */
+	public function deregister()
+	{
+		remove_filter(
+			'FHEE__EEM_' . $this->_model_name_extended . '__construct__tables',
+			array($this, 'add_extra_tables_on_filter')
+		);
+		remove_filter(
+			'FHEE__EEM_' . $this->_model_name_extended . '__construct__fields',
+			array($this, 'add_extra_fields_on_filter')
+		);
+		remove_filter(
+			'FHEE__EEM_' . $this->_model_name_extended . '__construct__model_relations',
+			array($this, 'add_extra_relations_on_filter')
+		);
+		$all_methods = get_class_methods(get_class($this));
+		foreach ($all_methods as $method_name) {
+			if (strpos($method_name, self::extending_method_prefix) === 0) {
+				$method_name_on_model = str_replace(self::extending_method_prefix, '', $method_name);
+				$callback_name = "FHEE__EEM_{$this->_model_name_extended}__$method_name_on_model";
+				remove_filter(
+					$callback_name,
+					array($this, self::dynamic_callback_method_prefix . $method_name_on_model),
+					10
+				);
+			}
+		}
+		/** @var EEM_Base $model_to_reset */
+		$model_to_reset = 'EEM_' . $this->_model_name_extended;
+		if (class_exists($model_to_reset)) {
+			$model_to_reset::reset();
+		}
+	}
+
+
+	/**
+	 * @param string $callback_method_name
+	 * @param array  $args
+	 * @return mixed
+	 * @throws EE_Error
+	 */
+	public function __call($callback_method_name, $args)
+	{
+		if (strpos($callback_method_name, self::dynamic_callback_method_prefix) === 0) {
+			// it's a dynamic callback for a method name
+			$method_called_on_model = str_replace(self::dynamic_callback_method_prefix, '', $callback_method_name);
+			list($original_return_val, $model_called, $args_provided_to_method_on_model) = (array) $args;
+			// phpcs:disable WordPress.WP.I18n.SingleUnderscoreGetTextFunction
+			$this->_ = $model_called;
+			// phpcs:enable
+			$extending_method = self::extending_method_prefix . $method_called_on_model;
+			if (method_exists($this, $extending_method)) {
+				return call_user_func_array(array($this, $extending_method), $args_provided_to_method_on_model);
+			} else {
+				throw new EE_Error(
+					sprintf(
+						esc_html__(
+							"An odd error occurred. Model '%s' had a method called on it that it didn't recognize. So it passed it onto the model extension '%s' (because it had a function named '%s' which should be able to handle it), but the function '%s' doesnt exist!)",
+							"event_espresso"
+						),
+						$this->_model_name_extended,
+						get_class($this),
+						$extending_method,
+						$extending_method
+					)
+				);
+			}
+		} else {
+			throw new EE_Error(
+				sprintf(
+					esc_html__("There is no method named '%s' on '%s'", "event_espresso"),
+					$callback_method_name,
+					get_class($this)
+				)
+			);
+		}
+	}
 }

core/libraries/plugin_api/db/EEE_Base_Class.lib.php

Spacing +5 added lines, -5 removed lines

@@ -49,7 +49,7 @@ 
 
     public function __construct()
     {
-        if (! $this->_model_name_extended) {
+        if ( ! $this->_model_name_extended) {
             throw new EE_Error(
                 sprintf(
                     esc_html__(
@@ -59,7 +59,7 @@ 
                 )
             );
         }
-        if (did_action('AHEE__EE_' . $this->_model_name_extended . '__construct__end')) {
+        if (did_action('AHEE__EE_'.$this->_model_name_extended.'__construct__end')) {
             throw new EE_Error(
                 sprintf(
                     esc_html__(
@@ -87,7 +87,7 @@ 
                 $callback_name = "FHEE__EE_{$this->_model_name_extended}__$method_name_on_model";
                 add_filter(
                     $callback_name,
-                    array($this, self::dynamic_callback_method_prefix . $method_name_on_model),
+                    array($this, self::dynamic_callback_method_prefix.$method_name_on_model),
                     10,
                     10
                 );
@@ -108,7 +108,7 @@ 
                 $callback_name = "FHEE__EE_{$this->_model_name_extended}__$method_name_on_model";
                 remove_filter(
                     $callback_name,
-                    array($this, self::dynamic_callback_method_prefix . $method_name_on_model),
+                    array($this, self::dynamic_callback_method_prefix.$method_name_on_model),
                     10
                 );
             }
@@ -127,7 +127,7 @@ 
             $this->_ = $model_called;
             // phpcs:enable
             $args_provided_to_method_on_model = $args[2];
-            $extending_method = self::extending_method_prefix . $method_called_on_model;
+            $extending_method = self::extending_method_prefix.$method_called_on_model;
             if (method_exists($this, $extending_method)) {
                 return call_user_func_array(array($this, $extending_method), $args_provided_to_method_on_model);
             } else {

Indentation +117 added lines, -117 removed lines

@@ -31,126 +31,126 @@
  */
 class EEE_Base_Class
 {
-    const extending_method_prefix = 'ext_';
-    const dynamic_callback_method_prefix = 'dynamic_callback_method_';
-    /**
-     * The model name that is extended (not classname)
-     *
-     * @var string
-     */
-    protected $_model_name_extended = null;
-    /**
-     * The model this extends
-     *
-     * @var EE_Base_Class
-     */
-    protected $_ = null;
+	const extending_method_prefix = 'ext_';
+	const dynamic_callback_method_prefix = 'dynamic_callback_method_';
+	/**
+	 * The model name that is extended (not classname)
+	 *
+	 * @var string
+	 */
+	protected $_model_name_extended = null;
+	/**
+	 * The model this extends
+	 *
+	 * @var EE_Base_Class
+	 */
+	protected $_ = null;
 
-    public function __construct()
-    {
-        if (! $this->_model_name_extended) {
-            throw new EE_Error(
-                sprintf(
-                    esc_html__(
-                        "When declaring a class extension, you must define its _model_name_extended property. It should be a model name like 'Attendee' or 'Event'",
-                        "event_espresso"
-                    )
-                )
-            );
-        }
-        if (did_action('AHEE__EE_' . $this->_model_name_extended . '__construct__end')) {
-            throw new EE_Error(
-                sprintf(
-                    esc_html__(
-                        "Hooked in model object extension '%s' too late! The model object %s has already been used!",
-                        "event_espresso"
-                    ),
-                    get_class($this),
-                    $this->_model_name_extended
-                )
-            );
-        }
-        $this->_register_extending_methods();
-    }
+	public function __construct()
+	{
+		if (! $this->_model_name_extended) {
+			throw new EE_Error(
+				sprintf(
+					esc_html__(
+						"When declaring a class extension, you must define its _model_name_extended property. It should be a model name like 'Attendee' or 'Event'",
+						"event_espresso"
+					)
+				)
+			);
+		}
+		if (did_action('AHEE__EE_' . $this->_model_name_extended . '__construct__end')) {
+			throw new EE_Error(
+				sprintf(
+					esc_html__(
+						"Hooked in model object extension '%s' too late! The model object %s has already been used!",
+						"event_espresso"
+					),
+					get_class($this),
+					$this->_model_name_extended
+				)
+			);
+		}
+		$this->_register_extending_methods();
+	}
 
-    /**
-     * scans the child of EEME_Base for functions starting with ext_, and magically makes them functions on the
-     * model extended. (Internally uses filters, and the __call magic method)
-     */
-    protected function _register_extending_methods()
-    {
-        $all_methods = get_class_methods(get_class($this));
-        foreach ($all_methods as $method_name) {
-            if (strpos($method_name, self::extending_method_prefix) === 0) {
-                $method_name_on_model = str_replace(self::extending_method_prefix, '', $method_name);
-                $callback_name = "FHEE__EE_{$this->_model_name_extended}__$method_name_on_model";
-                add_filter(
-                    $callback_name,
-                    array($this, self::dynamic_callback_method_prefix . $method_name_on_model),
-                    10,
-                    10
-                );
-            }
-        }
-    }
+	/**
+	 * scans the child of EEME_Base for functions starting with ext_, and magically makes them functions on the
+	 * model extended. (Internally uses filters, and the __call magic method)
+	 */
+	protected function _register_extending_methods()
+	{
+		$all_methods = get_class_methods(get_class($this));
+		foreach ($all_methods as $method_name) {
+			if (strpos($method_name, self::extending_method_prefix) === 0) {
+				$method_name_on_model = str_replace(self::extending_method_prefix, '', $method_name);
+				$callback_name = "FHEE__EE_{$this->_model_name_extended}__$method_name_on_model";
+				add_filter(
+					$callback_name,
+					array($this, self::dynamic_callback_method_prefix . $method_name_on_model),
+					10,
+					10
+				);
+			}
+		}
+	}
 
-    /**
-     * scans the child of EEME_Base for functions starting with ext_, and magically REMOVES them as functions on the
-     * model extended. (Internally uses filters, and the __call magic method)
-     */
-    public function deregister()
-    {
-        $all_methods = get_class_methods(get_class($this));
-        foreach ($all_methods as $method_name) {
-            if (strpos($method_name, self::extending_method_prefix) === 0) {
-                $method_name_on_model = str_replace(self::extending_method_prefix, '', $method_name);
-                $callback_name = "FHEE__EE_{$this->_model_name_extended}__$method_name_on_model";
-                remove_filter(
-                    $callback_name,
-                    array($this, self::dynamic_callback_method_prefix . $method_name_on_model),
-                    10
-                );
-            }
-        }
-    }
+	/**
+	 * scans the child of EEME_Base for functions starting with ext_, and magically REMOVES them as functions on the
+	 * model extended. (Internally uses filters, and the __call magic method)
+	 */
+	public function deregister()
+	{
+		$all_methods = get_class_methods(get_class($this));
+		foreach ($all_methods as $method_name) {
+			if (strpos($method_name, self::extending_method_prefix) === 0) {
+				$method_name_on_model = str_replace(self::extending_method_prefix, '', $method_name);
+				$callback_name = "FHEE__EE_{$this->_model_name_extended}__$method_name_on_model";
+				remove_filter(
+					$callback_name,
+					array($this, self::dynamic_callback_method_prefix . $method_name_on_model),
+					10
+				);
+			}
+		}
+	}
 
 
-    public function __call($callback_method_name, $args)
-    {
-        if (strpos($callback_method_name, self::dynamic_callback_method_prefix) === 0) {
-            // it's a dynamic callback for a method name
-            $method_called_on_model = str_replace(self::dynamic_callback_method_prefix, '', $callback_method_name);
-            $original_return_val = $args[0];
-            $model_called = $args[1];
-            // phpcs:disable WordPress.WP.I18n.SingleUnderscoreGetTextFunction
-            $this->_ = $model_called;
-            // phpcs:enable
-            $args_provided_to_method_on_model = $args[2];
-            $extending_method = self::extending_method_prefix . $method_called_on_model;
-            if (method_exists($this, $extending_method)) {
-                return call_user_func_array(array($this, $extending_method), $args_provided_to_method_on_model);
-            } else {
-                throw new EE_Error(
-                    sprintf(
-                        esc_html__(
-                            "An odd error occurred. Model '%s' had a method called on it that it didn't recognize. So it passed it onto the model extension '%s' (because it had a function named '%s' which should be able to handle it), but the function '%s' doesnt exist!)",
-                            "event_espresso"
-                        ),
-                        $this->_model_name_extended,
-                        get_class($this),
-                        $extending_method,
-                        $extending_method
-                    )
-                );
-            }
-        } else {
-            throw new EE_Error(
-                sprintf(
-                    esc_html__("There is no method named '%s' on '%s'", "event_espresso"),
-                    $callback_method_name,
-                    get_class($this)
-                )
-            );
-        }
-    }
+	public function __call($callback_method_name, $args)
+	{
+		if (strpos($callback_method_name, self::dynamic_callback_method_prefix) === 0) {
+			// it's a dynamic callback for a method name
+			$method_called_on_model = str_replace(self::dynamic_callback_method_prefix, '', $callback_method_name);
+			$original_return_val = $args[0];
+			$model_called = $args[1];
+			// phpcs:disable WordPress.WP.I18n.SingleUnderscoreGetTextFunction
+			$this->_ = $model_called;
+			// phpcs:enable
+			$args_provided_to_method_on_model = $args[2];
+			$extending_method = self::extending_method_prefix . $method_called_on_model;
+			if (method_exists($this, $extending_method)) {
+				return call_user_func_array(array($this, $extending_method), $args_provided_to_method_on_model);
+			} else {
+				throw new EE_Error(
+					sprintf(
+						esc_html__(
+							"An odd error occurred. Model '%s' had a method called on it that it didn't recognize. So it passed it onto the model extension '%s' (because it had a function named '%s' which should be able to handle it), but the function '%s' doesnt exist!)",
+							"event_espresso"
+						),
+						$this->_model_name_extended,
+						get_class($this),
+						$extending_method,
+						$extending_method
+					)
+				);
+			}
+		} else {
+			throw new EE_Error(
+				sprintf(
+					esc_html__("There is no method named '%s' on '%s'", "event_espresso"),
+					$callback_method_name,
+					get_class($this)
+				)
+			);
+		}
+	}
 }

core/libraries/plugin_api/EE_Register_CPT.lib.php

Spacing +10 added lines, -10 removed lines

@@ -73,7 +73,7 @@ 
             );
         }
 
-        if (! is_array($setup_args) || (empty($setup_args['cpts']) && empty($setup_args['cts']))) {
+        if ( ! is_array($setup_args) || (empty($setup_args['cpts']) && empty($setup_args['cts']))) {
             throw new EE_Error(
                 esc_html__(
                     'In order to register custom post types or custom taxonomies, you must include an array containing either an array of custom post types to register (key "cpts"), an array of custom taxonomies ("cts") or both.',
@@ -83,13 +83,13 @@ 
         }
 
         // make sure we don't register twice
-        if (isset(self::$_registry[ $identifier ])) {
+        if (isset(self::$_registry[$identifier])) {
             return;
         }
 
         // make sure cpt ref is unique.
-        if (isset(self::$_registry[ $identifier ])) {
-            $identifier = uniqid() . '_' . $identifier;
+        if (isset(self::$_registry[$identifier])) {
+            $identifier = uniqid().'_'.$identifier;
         }
 
         // make sure this was called in the right place!
@@ -119,7 +119,7 @@ 
                 : [],
         ];
 
-        self::$_registry[ $identifier ] = $validated;
+        self::$_registry[$identifier] = $validated;
 
         // hook into to cpt system
         add_filter(
@@ -152,7 +152,7 @@ 
     {
         foreach (self::$_registry as $registries) {
             foreach ($registries['cpts'] as $cpt_name => $cpt_settings) {
-                $custom_post_type_definitions[ $cpt_name ] = $cpt_settings;
+                $custom_post_type_definitions[$cpt_name] = $cpt_settings;
             }
         }
         return $custom_post_type_definitions;
@@ -171,7 +171,7 @@ 
     {
         foreach (self::$_registry as $registries) {
             foreach ($registries['cts'] as $ct_name => $ct_settings) {
-                $custom_taxonomy_definitions[ $ct_name ] = $ct_settings;
+                $custom_taxonomy_definitions[$ct_name] = $ct_settings;
             }
         }
         return $custom_taxonomy_definitions;
@@ -211,7 +211,7 @@ 
     {
         foreach (self::$_registry as $registries) {
             foreach ($registries['cpts'] as $cpt_name => $cpt_settings) {
-                $cpts[ $cpt_name ] = $cpt_settings;
+                $cpts[$cpt_name] = $cpt_settings;
             }
         }
         return $cpts;
@@ -227,7 +227,7 @@ 
     {
         foreach (self::$_registry as $registries) {
             foreach ($registries['cts'] as $ct_name => $ct_settings) {
-                $cts[ $ct_name ] = $ct_settings;
+                $cts[$ct_name] = $ct_settings;
             }
         }
         return $cts;
@@ -262,6 +262,6 @@ 
      */
     public static function deregister($identifier = '')
     {
-        unset(self::$_registry[ $identifier ]);
+        unset(self::$_registry[$identifier]);
     }
 }

Indentation +228 added lines, -228 removed lines

@@ -12,255 +12,255 @@
  */
 class EE_Register_CPT implements EEI_Plugin_API
 {
-    /**
-     * Holds values for registered variations
-     *
-     * @since 4.5.0
-     *
-     * @var array[][][]
-     */
-    protected static $_registry = [];
+	/**
+	 * Holds values for registered variations
+	 *
+	 * @since 4.5.0
+	 *
+	 * @var array[][][]
+	 */
+	protected static $_registry = [];
 
 
-    /**
-     * Used to register new CPTs and Taxonomies.
-     *
-     * @param string $identifier              reference used for the addon registering cpts and cts
-     * @param array  $setup_args              {
-     *                                        An array of required values for registering the cpts and taxonomies
-     * @type array   $cpts                    {
-     *                                        An array of cpts and their arguments.(short example below)
-     * @return void
-     * @throws  EE_Error
-     * @see CustomPostTypeDefinitions::setDefinitions for a more complete example.
-     *                                        'people' => array(
-     *                                        'singular_name' => esc_html__('People', 'event_espresso'),
-     *                                        'plural_name' => esc_html__('People', 'event_espresso'),
-     *                                        'singular_slug' => esc_html__('people', 'event_espresso'),
-     *                                        'plural_slug' => esc_html__('peoples', 'event_espresso'),
-     *                                        'class_name' => 'EE_People'
-     *                                        )
-     *                                        },
-     * @type array   $cts                     {
-     *                                        An array of custom taxonomies and their arguments (short example below).
-     * @see CustomTaxonomyDefinitions::setTaxonomies() for a more complete example.
-     *                                        'espresso_people_type' => array(
-     *                                        'singular_name' => esc_html__('People Type', 'event_espresso'),
-     *                                        'plural_name' => esc_html__('People Types', 'event_espresso'),
-     *                                        'args' => array()
-     *                                        )
-     *                                        },
-     * @type array   $default_terms           {
-     *                                        An array of terms to set as the default for a given taxonomy and the
-     *                                        custom post types applied to.
-     *                                        'taxonomy_name' => array(
-     *                                        'term' => array( 'cpt_a_name', 'cpt_b_name' )
-     *                                        )
-     *                                        }
-     *                                        }
-     */
-    public static function register($identifier = '', array $setup_args = [])
-    {
+	/**
+	 * Used to register new CPTs and Taxonomies.
+	 *
+	 * @param string $identifier              reference used for the addon registering cpts and cts
+	 * @param array  $setup_args              {
+	 *                                        An array of required values for registering the cpts and taxonomies
+	 * @type array   $cpts                    {
+	 *                                        An array of cpts and their arguments.(short example below)
+	 * @return void
+	 * @throws  EE_Error
+	 * @see CustomPostTypeDefinitions::setDefinitions for a more complete example.
+	 *                                        'people' => array(
+	 *                                        'singular_name' => esc_html__('People', 'event_espresso'),
+	 *                                        'plural_name' => esc_html__('People', 'event_espresso'),
+	 *                                        'singular_slug' => esc_html__('people', 'event_espresso'),
+	 *                                        'plural_slug' => esc_html__('peoples', 'event_espresso'),
+	 *                                        'class_name' => 'EE_People'
+	 *                                        )
+	 *                                        },
+	 * @type array   $cts                     {
+	 *                                        An array of custom taxonomies and their arguments (short example below).
+	 * @see CustomTaxonomyDefinitions::setTaxonomies() for a more complete example.
+	 *                                        'espresso_people_type' => array(
+	 *                                        'singular_name' => esc_html__('People Type', 'event_espresso'),
+	 *                                        'plural_name' => esc_html__('People Types', 'event_espresso'),
+	 *                                        'args' => array()
+	 *                                        )
+	 *                                        },
+	 * @type array   $default_terms           {
+	 *                                        An array of terms to set as the default for a given taxonomy and the
+	 *                                        custom post types applied to.
+	 *                                        'taxonomy_name' => array(
+	 *                                        'term' => array( 'cpt_a_name', 'cpt_b_name' )
+	 *                                        )
+	 *                                        }
+	 *                                        }
+	 */
+	public static function register($identifier = '', array $setup_args = [])
+	{
 
-        // check for required params
-        if (empty($identifier)) {
-            throw new EE_Error(
-                esc_html__(
-                    'In order to register custom post types and custom taxonomies, you must include a value to reference what had been registered',
-                    'event_espresso'
-                )
-            );
-        }
+		// check for required params
+		if (empty($identifier)) {
+			throw new EE_Error(
+				esc_html__(
+					'In order to register custom post types and custom taxonomies, you must include a value to reference what had been registered',
+					'event_espresso'
+				)
+			);
+		}
 
-        if (! is_array($setup_args) || (empty($setup_args['cpts']) && empty($setup_args['cts']))) {
-            throw new EE_Error(
-                esc_html__(
-                    'In order to register custom post types or custom taxonomies, you must include an array containing either an array of custom post types to register (key "cpts"), an array of custom taxonomies ("cts") or both.',
-                    'event_espresso'
-                )
-            );
-        }
+		if (! is_array($setup_args) || (empty($setup_args['cpts']) && empty($setup_args['cts']))) {
+			throw new EE_Error(
+				esc_html__(
+					'In order to register custom post types or custom taxonomies, you must include an array containing either an array of custom post types to register (key "cpts"), an array of custom taxonomies ("cts") or both.',
+					'event_espresso'
+				)
+			);
+		}
 
-        // make sure we don't register twice
-        if (isset(self::$_registry[ $identifier ])) {
-            return;
-        }
+		// make sure we don't register twice
+		if (isset(self::$_registry[ $identifier ])) {
+			return;
+		}
 
-        // make sure cpt ref is unique.
-        if (isset(self::$_registry[ $identifier ])) {
-            $identifier = uniqid() . '_' . $identifier;
-        }
+		// make sure cpt ref is unique.
+		if (isset(self::$_registry[ $identifier ])) {
+			$identifier = uniqid() . '_' . $identifier;
+		}
 
-        // make sure this was called in the right place!
-        if (did_action('AHEE__EE_System__load_CPTs_and_session__complete')) {
-            EE_Error::doing_it_wrong(
-                __METHOD__,
-                sprintf(
-                    esc_html__(
-                        'EE_Register_CPT has been called and given a reference of "%s".  It may or may not work because it should be called on or before "AHEE__EE_System__load_CPTs_and_session__complete" action hook.',
-                        'event_espresso'
-                    ),
-                    $identifier
-                ),
-                '4.5.0'
-            );
-        }
-        // validate incoming args
-        $validated = [
-            'cpts'          => isset($setup_args['cpts'])
-                ? (array) $setup_args['cpts']
-                : [],
-            'cts'           => isset($setup_args['cts'])
-                ? (array) $setup_args['cts']
-                : [],
-            'default_terms' => isset($setup_args['default_terms'])
-                ? (array) $setup_args['default_terms']
-                : [],
-        ];
+		// make sure this was called in the right place!
+		if (did_action('AHEE__EE_System__load_CPTs_and_session__complete')) {
+			EE_Error::doing_it_wrong(
+				__METHOD__,
+				sprintf(
+					esc_html__(
+						'EE_Register_CPT has been called and given a reference of "%s".  It may or may not work because it should be called on or before "AHEE__EE_System__load_CPTs_and_session__complete" action hook.',
+						'event_espresso'
+					),
+					$identifier
+				),
+				'4.5.0'
+			);
+		}
+		// validate incoming args
+		$validated = [
+			'cpts'          => isset($setup_args['cpts'])
+				? (array) $setup_args['cpts']
+				: [],
+			'cts'           => isset($setup_args['cts'])
+				? (array) $setup_args['cts']
+				: [],
+			'default_terms' => isset($setup_args['default_terms'])
+				? (array) $setup_args['default_terms']
+				: [],
+		];
 
-        self::$_registry[ $identifier ] = $validated;
+		self::$_registry[ $identifier ] = $validated;
 
-        // hook into to cpt system
-        add_filter(
-            'FHEE__EventEspresso_core_domain_entities_custom_post_types_CustomPostTypeDefinitions__getCustomPostTypes',
-            [__CLASS__, 'filterCustomPostTypeDefinitions'],
-            5
-        );
-        add_filter(
-            'FHEE__EventEspresso_core_domain_entities_custom_post_types_TaxonomyDefinitions__getTaxonomies',
-            [__CLASS__, 'filterCustomTaxonomyDefinitions'],
-            5
-        );
-        add_action(
-            'AHEE__EventEspresso_core_domain_services_custom_post_types_RegisterCustomTaxonomyTerms__construct_end',
-            [__CLASS__, 'registerCustomTaxonomyTerm'],
-            5
-        );
-    }
+		// hook into to cpt system
+		add_filter(
+			'FHEE__EventEspresso_core_domain_entities_custom_post_types_CustomPostTypeDefinitions__getCustomPostTypes',
+			[__CLASS__, 'filterCustomPostTypeDefinitions'],
+			5
+		);
+		add_filter(
+			'FHEE__EventEspresso_core_domain_entities_custom_post_types_TaxonomyDefinitions__getTaxonomies',
+			[__CLASS__, 'filterCustomTaxonomyDefinitions'],
+			5
+		);
+		add_action(
+			'AHEE__EventEspresso_core_domain_services_custom_post_types_RegisterCustomTaxonomyTerms__construct_end',
+			[__CLASS__, 'registerCustomTaxonomyTerm'],
+			5
+		);
+	}
 
 
-    /**
-     * Callback for
-     * FHEE__EventEspresso_core_domain_entities_custom_post_types_CustomPostTypeDefinitions__getCustomPostTypes
-     * that adds additional custom post types to be registered.
-     *
-     * @param array $custom_post_type_definitions array of cpts that are already set
-     * @return array new array of cpts and their registration information
-     */
-    public static function filterCustomPostTypeDefinitions(array $custom_post_type_definitions)
-    {
-        foreach (self::$_registry as $registries) {
-            foreach ($registries['cpts'] as $cpt_name => $cpt_settings) {
-                $custom_post_type_definitions[ $cpt_name ] = $cpt_settings;
-            }
-        }
-        return $custom_post_type_definitions;
-    }
+	/**
+	 * Callback for
+	 * FHEE__EventEspresso_core_domain_entities_custom_post_types_CustomPostTypeDefinitions__getCustomPostTypes
+	 * that adds additional custom post types to be registered.
+	 *
+	 * @param array $custom_post_type_definitions array of cpts that are already set
+	 * @return array new array of cpts and their registration information
+	 */
+	public static function filterCustomPostTypeDefinitions(array $custom_post_type_definitions)
+	{
+		foreach (self::$_registry as $registries) {
+			foreach ($registries['cpts'] as $cpt_name => $cpt_settings) {
+				$custom_post_type_definitions[ $cpt_name ] = $cpt_settings;
+			}
+		}
+		return $custom_post_type_definitions;
+	}
 
 
-    /**
-     * Callback for
-     * FHEE__EventEspresso_core_domain_entities_custom_post_types_TaxonomyDefinitions__getTaxonomies
-     * that adds additional custom taxonomies to be registered.
-     *
-     * @param array $custom_taxonomy_definitions array of cts that are already set.
-     * @return array new array of cts and their registration information.
-     */
-    public static function filterCustomTaxonomyDefinitions(array $custom_taxonomy_definitions)
-    {
-        foreach (self::$_registry as $registries) {
-            foreach ($registries['cts'] as $ct_name => $ct_settings) {
-                $custom_taxonomy_definitions[ $ct_name ] = $ct_settings;
-            }
-        }
-        return $custom_taxonomy_definitions;
-    }
+	/**
+	 * Callback for
+	 * FHEE__EventEspresso_core_domain_entities_custom_post_types_TaxonomyDefinitions__getTaxonomies
+	 * that adds additional custom taxonomies to be registered.
+	 *
+	 * @param array $custom_taxonomy_definitions array of cts that are already set.
+	 * @return array new array of cts and their registration information.
+	 */
+	public static function filterCustomTaxonomyDefinitions(array $custom_taxonomy_definitions)
+	{
+		foreach (self::$_registry as $registries) {
+			foreach ($registries['cts'] as $ct_name => $ct_settings) {
+				$custom_taxonomy_definitions[ $ct_name ] = $ct_settings;
+			}
+		}
+		return $custom_taxonomy_definitions;
+	}
 
 
-    /**
-     * Callback for
-     * AHEE__EventEspresso_core_domain_services_custom_post_types_RegisterCustomTaxonomyTerms__construct_end
-     * which is used to set the default terms
-     *
-     * @param RegisterCustomTaxonomyTerms $register_custom_taxonomy_terms
-     * @return void
-     */
-    public static function registerCustomTaxonomyTerm(RegisterCustomTaxonomyTerms $register_custom_taxonomy_terms)
-    {
-        foreach (self::$_registry as $registries) {
-            foreach ($registries['default_terms'] as $taxonomy => $terms) {
-                foreach ($terms as $term => $cpts) {
-                    $register_custom_taxonomy_terms->registerCustomTaxonomyTerm(
-                        $taxonomy,
-                        $term,
-                        $cpts
-                    );
-                }
-            }
-        }
-    }
+	/**
+	 * Callback for
+	 * AHEE__EventEspresso_core_domain_services_custom_post_types_RegisterCustomTaxonomyTerms__construct_end
+	 * which is used to set the default terms
+	 *
+	 * @param RegisterCustomTaxonomyTerms $register_custom_taxonomy_terms
+	 * @return void
+	 */
+	public static function registerCustomTaxonomyTerm(RegisterCustomTaxonomyTerms $register_custom_taxonomy_terms)
+	{
+		foreach (self::$_registry as $registries) {
+			foreach ($registries['default_terms'] as $taxonomy => $terms) {
+				foreach ($terms as $term => $cpts) {
+					$register_custom_taxonomy_terms->registerCustomTaxonomyTerm(
+						$taxonomy,
+						$term,
+						$cpts
+					);
+				}
+			}
+		}
+	}
 
 
-    /**
-     * @param array $cpts array of cpts that are already set
-     * @return array new array of cpts and their registration information
-     * @deprecated 4.9.62.p
-     */
-    public static function filter_cpts(array $cpts)
-    {
-        foreach (self::$_registry as $registries) {
-            foreach ($registries['cpts'] as $cpt_name => $cpt_settings) {
-                $cpts[ $cpt_name ] = $cpt_settings;
-            }
-        }
-        return $cpts;
-    }
+	/**
+	 * @param array $cpts array of cpts that are already set
+	 * @return array new array of cpts and their registration information
+	 * @deprecated 4.9.62.p
+	 */
+	public static function filter_cpts(array $cpts)
+	{
+		foreach (self::$_registry as $registries) {
+			foreach ($registries['cpts'] as $cpt_name => $cpt_settings) {
+				$cpts[ $cpt_name ] = $cpt_settings;
+			}
+		}
+		return $cpts;
+	}
 
 
-    /**
-     * @param array $cts array of cts that are already set.
-     * @return array new array of cts and their registration information.
-     * @deprecated 4.9.62.p
-     */
-    public static function filter_cts(array $cts)
-    {
-        foreach (self::$_registry as $registries) {
-            foreach ($registries['cts'] as $ct_name => $ct_settings) {
-                $cts[ $ct_name ] = $ct_settings;
-            }
-        }
-        return $cts;
-    }
+	/**
+	 * @param array $cts array of cts that are already set.
+	 * @return array new array of cts and their registration information.
+	 * @deprecated 4.9.62.p
+	 */
+	public static function filter_cts(array $cts)
+	{
+		foreach (self::$_registry as $registries) {
+			foreach ($registries['cts'] as $ct_name => $ct_settings) {
+				$cts[ $ct_name ] = $ct_settings;
+			}
+		}
+		return $cts;
+	}
 
 
-    /**
-     * @param EE_Register_CPTs $cpt_class
-     * @return void
-     * @deprecated 4.9.62.p
-     */
-    public static function default_terms(EE_Register_CPTs $cpt_class)
-    {
-        foreach (self::$_registry as $registries) {
-            foreach ($registries['default_terms'] as $taxonomy => $terms) {
-                foreach ($terms as $term => $cpts) {
-                    $cpt_class->set_default_term($taxonomy, $term, $cpts);
-                }
-            }
-        }
-    }
+	/**
+	 * @param EE_Register_CPTs $cpt_class
+	 * @return void
+	 * @deprecated 4.9.62.p
+	 */
+	public static function default_terms(EE_Register_CPTs $cpt_class)
+	{
+		foreach (self::$_registry as $registries) {
+			foreach ($registries['default_terms'] as $taxonomy => $terms) {
+				foreach ($terms as $term => $cpts) {
+					$cpt_class->set_default_term($taxonomy, $term, $cpts);
+				}
+			}
+		}
+	}
 
 
-    /**
-     * This deregisters whats been registered on this class (for the given slug).
-     *
-     * @param string $identifier The reference for the item registered to be removed.
-     *
-     * @return void
-     * @since 4.5.0
-     *
-     */
-    public static function deregister($identifier = '')
-    {
-        unset(self::$_registry[ $identifier ]);
-    }
+	/**
+	 * This deregisters whats been registered on this class (for the given slug).
+	 *
+	 * @param string $identifier The reference for the item registered to be removed.
+	 *
+	 * @return void
+	 * @since 4.5.0
+	 *
+	 */
+	public static function deregister($identifier = '')
+	{
+		unset(self::$_registry[ $identifier ]);
+	}
 }

core/libraries/plugin_api/EE_Register_Admin_Page.lib.php

Spacing +8 added lines, -8 removed lines

@@ -44,7 +44,7 @@ 
     {
 
         // check that an admin_page has not already been registered with that name
-        if (isset(self::$_ee_admin_page_registry[ $identifier ])) {
+        if (isset(self::$_ee_admin_page_registry[$identifier])) {
             throw new EE_Error(
                 sprintf(
                     esc_html__(
@@ -67,11 +67,11 @@ 
         }
 
         // make sure we don't register twice
-        if (isset(self::$_ee_admin_page_registry[ $identifier ])) {
+        if (isset(self::$_ee_admin_page_registry[$identifier])) {
             return;
         }
 
-        if (! did_action('AHEE__EE_System__load_espresso_addons') || did_action('AHEE__EE_Admin__loaded')) {
+        if ( ! did_action('AHEE__EE_System__load_espresso_addons') || did_action('AHEE__EE_Admin__loaded')) {
             EE_Error::doing_it_wrong(
                 __METHOD__,
                 sprintf(
@@ -86,7 +86,7 @@ 
         }
 
         // add incoming stuff to our registry property
-        self::$_ee_admin_page_registry[ $identifier ] = [
+        self::$_ee_admin_page_registry[$identifier] = [
             'page_path' => $setup_args['page_path'],
             'config'    => $setup_args,
         ];
@@ -113,7 +113,7 @@ 
      */
     public static function deregister($identifier = '')
     {
-        unset(self::$_ee_admin_page_registry[ $identifier ]);
+        unset(self::$_ee_admin_page_registry[$identifier]);
     }
 
 
@@ -125,9 +125,9 @@ 
      */
     public static function set_page_basename($installed_refs)
     {
-        if (! empty(self::$_ee_admin_page_registry)) {
+        if ( ! empty(self::$_ee_admin_page_registry)) {
             foreach (self::$_ee_admin_page_registry as $basename => $args) {
-                $installed_refs[ $basename ] = $args['page_path'];
+                $installed_refs[$basename] = $args['page_path'];
             }
         }
         return $installed_refs;
@@ -143,7 +143,7 @@ 
     public static function set_page_path($paths)
     {
         foreach (self::$_ee_admin_page_registry as $basename => $args) {
-            $paths[ $basename ] = $args['page_path'];
+            $paths[$basename] = $args['page_path'];
         }
         return $paths;
     }

Indentation +135 added lines, -135 removed lines

@@ -10,139 +10,139 @@
  */
 class EE_Register_Admin_Page implements EEI_Plugin_API
 {
-    /**
-     * Holds registered EE_Admin_Pages
-     *
-     * @var array
-     */
-    protected static $_ee_admin_page_registry = [];
-
-
-    /**
-     * The purpose of this method is to provide an easy way for addons to register their admin pages (using the EE
-     * Admin Page loader system).
-     *
-     * @param string $identifier                                      This string represents the basename of the Admin
-     *                                                                Page init. The init file must use this basename
-     *                                                                in its name and class (i.e.
-     *                                                                {page_basename}_Admin_Page_Init.core.php).
-     * @param array  $setup_args                                      {              An array of configuration options
-     *                                                                that will be used in different circumstances
-     *
-     * @type  string $page_path                                       This is the path where the registered admin pages
-     *        reside ( used to setup autoloaders).
-     *
-     *    }
-     * @return void
-     * @throws EE_Error
-     * @since 4.3.0
-     *
-     */
-    public static function register($identifier = '', array $setup_args = [])
-    {
-
-        // check that an admin_page has not already been registered with that name
-        if (isset(self::$_ee_admin_page_registry[ $identifier ])) {
-            throw new EE_Error(
-                sprintf(
-                    esc_html__(
-                        'An Admin Page with the name "%s" has already been registered and each Admin Page requires a unique name.',
-                        'event_espresso'
-                    ),
-                    $identifier
-                )
-            );
-        }
-
-        // required fields MUST be present, so let's make sure they are.
-        if (empty($identifier) || ! is_array($setup_args) || empty($setup_args['page_path'])) {
-            throw new EE_Error(
-                esc_html__(
-                    'In order to register an Admin Page with EE_Register_Admin_Page::register(), you must include the "page_basename" (the class name of the page), and an array containing the following keys: "page_path" (the path where the registered admin pages reside)',
-                    'event_espresso'
-                )
-            );
-        }
-
-        // make sure we don't register twice
-        if (isset(self::$_ee_admin_page_registry[ $identifier ])) {
-            return;
-        }
-
-        if (! did_action('AHEE__EE_System__load_espresso_addons') || did_action('AHEE__EE_Admin__loaded')) {
-            EE_Error::doing_it_wrong(
-                __METHOD__,
-                sprintf(
-                    esc_html__(
-                        'An attempt was made to register "%s" as an EE Admin page has failed because it was not registered at the correct time.  Please use the "AHEE__EE_Admin__loaded" hook to register Admin pages.',
-                        'event_espresso'
-                    ),
-                    $identifier
-                ),
-                '4.3'
-            );
-        }
-
-        // add incoming stuff to our registry property
-        self::$_ee_admin_page_registry[ $identifier ] = [
-            'page_path' => $setup_args['page_path'],
-            'config'    => $setup_args,
-        ];
-
-        // add filters
-
-        add_filter(
-            'FHEE__EE_Admin_Page_Loader___get_installed_pages__installed_refs',
-            ['EE_Register_Admin_Page', 'set_page_basename'],
-            10
-        );
-        add_filter('FHEE__EEH_Autoloader__load_admin_core', ['EE_Register_Admin_Page', 'set_page_path'], 10);
-    }
-
-
-    /**
-     * This deregisters a EE_Admin page that is already registered.  Note, this MUST be loaded after the
-     * page being deregistered is loaded.
-     *
-     * @param string $identifier Use whatever string was used to register the admin page.
-     * @return  void
-     * @since    4.3.0
-     *
-     */
-    public static function deregister($identifier = '')
-    {
-        unset(self::$_ee_admin_page_registry[ $identifier ]);
-    }
-
-
-    /**
-     * set_page_basename
-     *
-     * @param $installed_refs
-     * @return mixed
-     */
-    public static function set_page_basename($installed_refs)
-    {
-        if (! empty(self::$_ee_admin_page_registry)) {
-            foreach (self::$_ee_admin_page_registry as $basename => $args) {
-                $installed_refs[ $basename ] = $args['page_path'];
-            }
-        }
-        return $installed_refs;
-    }
-
-
-    /**
-     * set_page_path
-     *
-     * @param $paths
-     * @return mixed
-     */
-    public static function set_page_path($paths)
-    {
-        foreach (self::$_ee_admin_page_registry as $basename => $args) {
-            $paths[ $basename ] = $args['page_path'];
-        }
-        return $paths;
-    }
+	/**
+	 * Holds registered EE_Admin_Pages
+	 *
+	 * @var array
+	 */
+	protected static $_ee_admin_page_registry = [];
+
+
+	/**
+	 * The purpose of this method is to provide an easy way for addons to register their admin pages (using the EE
+	 * Admin Page loader system).
+	 *
+	 * @param string $identifier                                      This string represents the basename of the Admin
+	 *                                                                Page init. The init file must use this basename
+	 *                                                                in its name and class (i.e.
+	 *                                                                {page_basename}_Admin_Page_Init.core.php).
+	 * @param array  $setup_args                                      {              An array of configuration options
+	 *                                                                that will be used in different circumstances
+	 *
+	 * @type  string $page_path                                       This is the path where the registered admin pages
+	 *        reside ( used to setup autoloaders).
+	 *
+	 *    }
+	 * @return void
+	 * @throws EE_Error
+	 * @since 4.3.0
+	 *
+	 */
+	public static function register($identifier = '', array $setup_args = [])
+	{
+
+		// check that an admin_page has not already been registered with that name
+		if (isset(self::$_ee_admin_page_registry[ $identifier ])) {
+			throw new EE_Error(
+				sprintf(
+					esc_html__(
+						'An Admin Page with the name "%s" has already been registered and each Admin Page requires a unique name.',
+						'event_espresso'
+					),
+					$identifier
+				)
+			);
+		}
+
+		// required fields MUST be present, so let's make sure they are.
+		if (empty($identifier) || ! is_array($setup_args) || empty($setup_args['page_path'])) {
+			throw new EE_Error(
+				esc_html__(
+					'In order to register an Admin Page with EE_Register_Admin_Page::register(), you must include the "page_basename" (the class name of the page), and an array containing the following keys: "page_path" (the path where the registered admin pages reside)',
+					'event_espresso'
+				)
+			);
+		}
+
+		// make sure we don't register twice
+		if (isset(self::$_ee_admin_page_registry[ $identifier ])) {
+			return;
+		}
+
+		if (! did_action('AHEE__EE_System__load_espresso_addons') || did_action('AHEE__EE_Admin__loaded')) {
+			EE_Error::doing_it_wrong(
+				__METHOD__,
+				sprintf(
+					esc_html__(
+						'An attempt was made to register "%s" as an EE Admin page has failed because it was not registered at the correct time.  Please use the "AHEE__EE_Admin__loaded" hook to register Admin pages.',
+						'event_espresso'
+					),
+					$identifier
+				),
+				'4.3'
+			);
+		}
+
+		// add incoming stuff to our registry property
+		self::$_ee_admin_page_registry[ $identifier ] = [
+			'page_path' => $setup_args['page_path'],
+			'config'    => $setup_args,
+		];
+
+		// add filters
+
+		add_filter(
+			'FHEE__EE_Admin_Page_Loader___get_installed_pages__installed_refs',
+			['EE_Register_Admin_Page', 'set_page_basename'],
+			10
+		);
+		add_filter('FHEE__EEH_Autoloader__load_admin_core', ['EE_Register_Admin_Page', 'set_page_path'], 10);
+	}
+
+
+	/**
+	 * This deregisters a EE_Admin page that is already registered.  Note, this MUST be loaded after the
+	 * page being deregistered is loaded.
+	 *
+	 * @param string $identifier Use whatever string was used to register the admin page.
+	 * @return  void
+	 * @since    4.3.0
+	 *
+	 */
+	public static function deregister($identifier = '')
+	{
+		unset(self::$_ee_admin_page_registry[ $identifier ]);
+	}
+
+
+	/**
+	 * set_page_basename
+	 *
+	 * @param $installed_refs
+	 * @return mixed
+	 */
+	public static function set_page_basename($installed_refs)
+	{
+		if (! empty(self::$_ee_admin_page_registry)) {
+			foreach (self::$_ee_admin_page_registry as $basename => $args) {
+				$installed_refs[ $basename ] = $args['page_path'];
+			}
+		}
+		return $installed_refs;
+	}
+
+
+	/**
+	 * set_page_path
+	 *
+	 * @param $paths
+	 * @return mixed
+	 */
+	public static function set_page_path($paths)
+	{
+		foreach (self::$_ee_admin_page_registry as $basename => $args) {
+			$paths[ $basename ] = $args['page_path'];
+		}
+		return $paths;
+	}
 }

core/libraries/shortcodes/EE_Ticket_Shortcodes.lib.php

Spacing +13 added lines, -13 removed lines

@@ -47,20 +47,20 @@ 
             '[TKT_USES_*]'              => esc_html__(
                 'This attribute based shortcode parses to show the number of uses the ticket has.  The optional "schema" attribute can be used to indicate what schema is used when the uses is infinite.  Options are:',
                 'event_espresso'
-            ) .
-                                           '<p><ul>' .
-                                           '<li><strong>symbol</strong>:' . esc_html__(
+            ).
+                                           '<p><ul>'.
+                                           '<li><strong>symbol</strong>:'.esc_html__(
                                                'This returns the &infin; symbol.',
                                                'event_espresso'
-                                           ) . '</li>' .
-                                           '<li><strong>text</strong>:' . esc_html__(
+                                           ).'</li>'.
+                                           '<li><strong>text</strong>:'.esc_html__(
                                                'This returns the word, "Unlimited". This is also the default if the "schema" attribute is not used.',
                                                'event_espresso'
-                                           ) . '</li>' .
-                                           '<li><strong>{custom}</strong>:' . esc_html__(
+                                           ).'</li>'.
+                                           '<li><strong>{custom}</strong>:'.esc_html__(
                                                'You can put anything you want as a string instead and that will be used.  So you could have the world "any" and whenever uses for a ticket is infinity, this shortcode will parse to "any".',
                                                'event_espresso'
-                                           ) . '</li>' .
+                                           ).'</li>'.
                                            '</ul></p>',
         );
     }
@@ -82,9 +82,9 @@ 
         $this->_ticket = empty($this->_ticket)
                          && $this->_data instanceof EE_Line_Item
                          && $aee instanceof EE_Messages_Addressee
-                         && ! empty($aee->line_items_with_children[ $this->_data->ID() ]['EE_Ticket'])
-                         && $aee->line_items_with_children[ $this->_data->ID() ]['EE_Ticket'] instanceof EE_Ticket
-            ? $aee->line_items_with_children[ $this->_data->ID() ]['EE_Ticket']
+                         && ! empty($aee->line_items_with_children[$this->_data->ID()]['EE_Ticket'])
+                         && $aee->line_items_with_children[$this->_data->ID()]['EE_Ticket'] instanceof EE_Ticket
+            ? $aee->line_items_with_children[$this->_data->ID()]['EE_Ticket']
             : $this->_ticket;
 
         // if still no ticket, then let's see if there is a reg_obj.  If there IS, then we'll try and grab the ticket from the reg_obj instead.
@@ -95,7 +95,7 @@ 
 
 
         // If there is no event object by now then get out.
-        if (! $this->_ticket instanceof EE_Ticket) {
+        if ( ! $this->_ticket instanceof EE_Ticket) {
             return '';
         }
 
@@ -121,7 +121,7 @@ 
                 break;
 
             case '[TKT_QTY_PURCHASED]':
-                return $aee instanceof EE_Messages_Addressee ? $aee->tickets[ $this->_ticket->ID() ]['count'] : '';
+                return $aee instanceof EE_Messages_Addressee ? $aee->tickets[$this->_ticket->ID()]['count'] : '';
                 break;
         }
 

Indentation +119 added lines, -119 removed lines

@@ -17,123 +17,123 @@
  */
 class EE_Ticket_Shortcodes extends EE_Shortcodes
 {
-    /**
-     * Will hold the EE_Ticket if available
-     *
-     * @var EE_Ticket
-     */
-    protected $_ticket;
-
-
-    protected function _init_props()
-    {
-        $this->label = esc_html__('Ticket Shortcodes', 'event_espresso');
-        $this->description = esc_html__('All shortcodes specific to ticket related data', 'event_espresso');
-        $this->_shortcodes = array(
-            '[TICKET_ID]'               => esc_html__('Will be replaced by the ticket ID of a ticket', 'event_espresso'),
-            '[TICKET_NAME]'             => esc_html__('The name of the ticket', 'event_espresso'),
-            '[TICKET_DESCRIPTION]'      => esc_html__('The description of the ticket', 'event_espresso'),
-            '[TICKET_PRICE]'            => esc_html__('The price of the ticket', 'event_espresso'),
-            '[TICKET_PRICE_WITH_TAXES]' => esc_html__(
-                'The price of the ticket including any taxes that might be on the ticket',
-                'event_espresso'
-            ),
-            '[TKT_QTY_PURCHASED]'       => esc_html__(
-                'The total quantity of the current ticket in the list that has been purchased in this transaction',
-                'event_espresso'
-            ),
-            '[TKT_USES_*]'              => esc_html__(
-                'This attribute based shortcode parses to show the number of uses the ticket has.  The optional "schema" attribute can be used to indicate what schema is used when the uses is infinite.  Options are:',
-                'event_espresso'
-            ) .
-                                           '<p><ul>' .
-                                           '<li><strong>symbol</strong>:' . esc_html__(
-                                               'This returns the &infin; symbol.',
-                                               'event_espresso'
-                                           ) . '</li>' .
-                                           '<li><strong>text</strong>:' . esc_html__(
-                                               'This returns the word, "Unlimited". This is also the default if the "schema" attribute is not used.',
-                                               'event_espresso'
-                                           ) . '</li>' .
-                                           '<li><strong>{custom}</strong>:' . esc_html__(
-                                               'You can put anything you want as a string instead and that will be used.  So you could have the world "any" and whenever uses for a ticket is infinity, this shortcode will parse to "any".',
-                                               'event_espresso'
-                                           ) . '</li>' .
-                                           '</ul></p>',
-        );
-    }
-
-
-    protected function _parser($shortcode)
-    {
-
-        $this->_ticket = $this->_data instanceof EE_Ticket ? $this->_data : null;
-
-        $aee = $this->_data instanceof EE_Messages_Addressee ? $this->_data : null;
-        $aee = ! $aee instanceof EE_Messages_Addressee && is_array(
-            $this->_extra_data
-        ) && isset($this->_extra_data['data']) && $this->_extra_data['data'] instanceof EE_Messages_Addressee
-            ? $this->_extra_data['data'] : $aee;
-
-
-        // possible EE_Line_Item may be incoming data
-        $this->_ticket = empty($this->_ticket)
-                         && $this->_data instanceof EE_Line_Item
-                         && $aee instanceof EE_Messages_Addressee
-                         && ! empty($aee->line_items_with_children[ $this->_data->ID() ]['EE_Ticket'])
-                         && $aee->line_items_with_children[ $this->_data->ID() ]['EE_Ticket'] instanceof EE_Ticket
-            ? $aee->line_items_with_children[ $this->_data->ID() ]['EE_Ticket']
-            : $this->_ticket;
-
-        // if still no ticket, then let's see if there is a reg_obj.  If there IS, then we'll try and grab the ticket from the reg_obj instead.
-        if (empty($this->_ticket)) {
-            $this->_ticket = $aee instanceof EE_Messages_Addressee && $aee->reg_obj instanceof EE_Registration
-                ? $aee->reg_obj->ticket() : null;
-        }
-
-
-        // If there is no event object by now then get out.
-        if (! $this->_ticket instanceof EE_Ticket) {
-            return '';
-        }
-
-        switch ($shortcode) {
-            case '[TICKET_ID]':
-                return $this->_ticket->ID();
-                break;
-
-            case '[TICKET_NAME]':
-                return $this->_ticket->get('TKT_name');
-                break;
-
-            case '[TICKET_DESCRIPTION]':
-                return $this->_ticket->get('TKT_description');
-                break;
-
-            case '[TICKET_PRICE]':
-                return EEH_Template::format_currency($this->_ticket->get('TKT_price'));
-                break;
-
-            case '[TICKET_PRICE_WITH_TAXES]':
-                return EEH_Template::format_currency($this->_ticket->get_ticket_total_with_taxes());
-                break;
-
-            case '[TKT_QTY_PURCHASED]':
-                return $aee instanceof EE_Messages_Addressee ? $aee->tickets[ $this->_ticket->ID() ]['count'] : '';
-                break;
-        }
-
-        if (strpos($shortcode, '[TKT_USES_*') !== false) {
-            $attrs = $this->_get_shortcode_attrs($shortcode);
-            $schema = empty($attrs['schema']) ? null : $attrs['schema'];
-            return $this->_ticket->get_pretty('TKT_uses', $schema);
-        }
-        return '';
-    }
-
-
-    public function get_ticket_set()
-    {
-        return $this->_ticket;
-    }
+	/**
+	 * Will hold the EE_Ticket if available
+	 *
+	 * @var EE_Ticket
+	 */
+	protected $_ticket;
+
+
+	protected function _init_props()
+	{
+		$this->label = esc_html__('Ticket Shortcodes', 'event_espresso');
+		$this->description = esc_html__('All shortcodes specific to ticket related data', 'event_espresso');
+		$this->_shortcodes = array(
+			'[TICKET_ID]'               => esc_html__('Will be replaced by the ticket ID of a ticket', 'event_espresso'),
+			'[TICKET_NAME]'             => esc_html__('The name of the ticket', 'event_espresso'),
+			'[TICKET_DESCRIPTION]'      => esc_html__('The description of the ticket', 'event_espresso'),
+			'[TICKET_PRICE]'            => esc_html__('The price of the ticket', 'event_espresso'),
+			'[TICKET_PRICE_WITH_TAXES]' => esc_html__(
+				'The price of the ticket including any taxes that might be on the ticket',
+				'event_espresso'
+			),
+			'[TKT_QTY_PURCHASED]'       => esc_html__(
+				'The total quantity of the current ticket in the list that has been purchased in this transaction',
+				'event_espresso'
+			),
+			'[TKT_USES_*]'              => esc_html__(
+				'This attribute based shortcode parses to show the number of uses the ticket has.  The optional "schema" attribute can be used to indicate what schema is used when the uses is infinite.  Options are:',
+				'event_espresso'
+			) .
+										   '<p><ul>' .
+										   '<li><strong>symbol</strong>:' . esc_html__(
+											   'This returns the &infin; symbol.',
+											   'event_espresso'
+										   ) . '</li>' .
+										   '<li><strong>text</strong>:' . esc_html__(
+											   'This returns the word, "Unlimited". This is also the default if the "schema" attribute is not used.',
+											   'event_espresso'
+										   ) . '</li>' .
+										   '<li><strong>{custom}</strong>:' . esc_html__(
+											   'You can put anything you want as a string instead and that will be used.  So you could have the world "any" and whenever uses for a ticket is infinity, this shortcode will parse to "any".',
+											   'event_espresso'
+										   ) . '</li>' .
+										   '</ul></p>',
+		);
+	}
+
+
+	protected function _parser($shortcode)
+	{
+
+		$this->_ticket = $this->_data instanceof EE_Ticket ? $this->_data : null;
+
+		$aee = $this->_data instanceof EE_Messages_Addressee ? $this->_data : null;
+		$aee = ! $aee instanceof EE_Messages_Addressee && is_array(
+			$this->_extra_data
+		) && isset($this->_extra_data['data']) && $this->_extra_data['data'] instanceof EE_Messages_Addressee
+			? $this->_extra_data['data'] : $aee;
+
+
+		// possible EE_Line_Item may be incoming data
+		$this->_ticket = empty($this->_ticket)
+						 && $this->_data instanceof EE_Line_Item
+						 && $aee instanceof EE_Messages_Addressee
+						 && ! empty($aee->line_items_with_children[ $this->_data->ID() ]['EE_Ticket'])
+						 && $aee->line_items_with_children[ $this->_data->ID() ]['EE_Ticket'] instanceof EE_Ticket
+			? $aee->line_items_with_children[ $this->_data->ID() ]['EE_Ticket']
+			: $this->_ticket;
+
+		// if still no ticket, then let's see if there is a reg_obj.  If there IS, then we'll try and grab the ticket from the reg_obj instead.
+		if (empty($this->_ticket)) {
+			$this->_ticket = $aee instanceof EE_Messages_Addressee && $aee->reg_obj instanceof EE_Registration
+				? $aee->reg_obj->ticket() : null;
+		}
+
+
+		// If there is no event object by now then get out.
+		if (! $this->_ticket instanceof EE_Ticket) {
+			return '';
+		}
+
+		switch ($shortcode) {
+			case '[TICKET_ID]':
+				return $this->_ticket->ID();
+				break;
+
+			case '[TICKET_NAME]':
+				return $this->_ticket->get('TKT_name');
+				break;
+
+			case '[TICKET_DESCRIPTION]':
+				return $this->_ticket->get('TKT_description');
+				break;
+
+			case '[TICKET_PRICE]':
+				return EEH_Template::format_currency($this->_ticket->get('TKT_price'));
+				break;
+
+			case '[TICKET_PRICE_WITH_TAXES]':
+				return EEH_Template::format_currency($this->_ticket->get_ticket_total_with_taxes());
+				break;
+
+			case '[TKT_QTY_PURCHASED]':
+				return $aee instanceof EE_Messages_Addressee ? $aee->tickets[ $this->_ticket->ID() ]['count'] : '';
+				break;
+		}
+
+		if (strpos($shortcode, '[TKT_USES_*') !== false) {
+			$attrs = $this->_get_shortcode_attrs($shortcode);
+			$schema = empty($attrs['schema']) ? null : $attrs['schema'];
+			return $this->_ticket->get_pretty('TKT_uses', $schema);
+		}
+		return '';
+	}
+
+
+	public function get_ticket_set()
+	{
+		return $this->_ticket;
+	}
 }

core/libraries/shortcodes/EE_Payment_List_Shortcodes.lib.php

Spacing +4 added lines, -4 removed lines

@@ -29,15 +29,15 @@ 
                 'Outputs a list of payment items. Note, this is a dynamic shortcode in that it accepts some attributes for setting certain defaults.  Attributes that are available are:',
                 'event_espresso'
             )
-                                  . '<p><ul>' .
-                                  '<li><strong>no_payments</strong>:' . sprintf(
+                                  . '<p><ul>'.
+                                  '<li><strong>no_payments</strong>:'.sprintf(
                                       esc_html__(
                                           'Indicate with this attribute what will be used if there are no payments present.  Default is: "%sNo approved payments have been received.%s"',
                                           'event_espresso'
                                       ),
                                       htmlspecialchars('<td class="aln-cntr" colspan="6">'),
                                       htmlspecialchars('</td>')
-                                  ) . '</li>' .
+                                  ).'</li>'.
                                   '</ul></p>',
         );
     }
@@ -67,7 +67,7 @@ 
         $this->_validate_list_requirements();
 
 
-        if (! $this->_data['data'] instanceof EE_Messages_Addressee) {
+        if ( ! $this->_data['data'] instanceof EE_Messages_Addressee) {
             return '';
         }
 

Indentation +84 added lines, -84 removed lines

@@ -18,88 +18,88 @@
  */
 class EE_Payment_List_Shortcodes extends EE_Shortcodes
 {
-    protected function _init_props()
-    {
-        $this->label = esc_html__('Payment List Shortcodes', 'event_espresso');
-        $this->description = esc_html__('All shortcodes specific to payment lists', 'event_espresso');
-        $this->_shortcodes = array(
-            '[PAYMENT_LIST_*]' => esc_html__(
-                'Outputs a list of payment items. Note, this is a dynamic shortcode in that it accepts some attributes for setting certain defaults.  Attributes that are available are:',
-                'event_espresso'
-            )
-                                  . '<p><ul>' .
-                                  '<li><strong>no_payments</strong>:' . sprintf(
-                                      esc_html__(
-                                          'Indicate with this attribute what will be used if there are no payments present.  Default is: "%sNo approved payments have been received.%s"',
-                                          'event_espresso'
-                                      ),
-                                      htmlspecialchars('<td class="aln-cntr" colspan="6">'),
-                                      htmlspecialchars('</td>')
-                                  ) . '</li>' .
-                                  '</ul></p>',
-        );
-    }
-
-
-    protected function _parser($shortcode)
-    {
-
-        if (strpos($shortcode, '[PAYMENT_LIST_*') !== false) {
-            return $this->_get_payment_list($shortcode);
-        }
-        return '';
-    }
-
-
-    /**
-     * verify incoming data contains what is needed for retrieving and parsing each payment for transaction.
-     *
-     * @since 4.5.0
-     *
-     * @param string $shortcode The incoming shortcode.
-     *
-     * @return string parsed ticket line item list.
-     */
-    private function _get_payment_list($shortcode)
-    {
-        $this->_validate_list_requirements();
-
-
-        if (! $this->_data['data'] instanceof EE_Messages_Addressee) {
-            return '';
-        }
-
-        $valid_shortcodes = array('payment');
-
-        $addressee_obj = $this->_data['data'];
-        $templates = $this->_extra_data['template'];
-        $payments = apply_filters(
-            'FHEE__Payment_List_Shortcodes___get_payments_list__payments',
-            $addressee_obj->payments
-        );
-
-        // let's get any attributes that may be present and set the defaults.
-        $atts = $this->_get_shortcode_attrs($shortcode);
-
-        $no_payments_msg = empty($atts['no_payments']) ? esc_html__(
-            'No approved payments have been received.',
-            'event_espresso'
-        ) : $atts['no_payments'];
-
-        // made it here so we have an array of paymnets, so we should have what we need.
-        $payment_content = empty($payments) ? $no_payments_msg : '';
-
-        $payments = (array) $payments;
-
-        foreach ($payments as $payment) {
-            $payment_content .= $this->_shortcode_helper->parse_payment_list_template(
-                $templates['payment_list'],
-                $payment,
-                $valid_shortcodes,
-                $this->_extra_data
-            );
-        }
-
-        return $payment_content;
-    }
+	protected function _init_props()
+	{
+		$this->label = esc_html__('Payment List Shortcodes', 'event_espresso');
+		$this->description = esc_html__('All shortcodes specific to payment lists', 'event_espresso');
+		$this->_shortcodes = array(
+			'[PAYMENT_LIST_*]' => esc_html__(
+				'Outputs a list of payment items. Note, this is a dynamic shortcode in that it accepts some attributes for setting certain defaults.  Attributes that are available are:',
+				'event_espresso'
+			)
+								  . '<p><ul>' .
+								  '<li><strong>no_payments</strong>:' . sprintf(
+									  esc_html__(
+										  'Indicate with this attribute what will be used if there are no payments present.  Default is: "%sNo approved payments have been received.%s"',
+										  'event_espresso'
+									  ),
+									  htmlspecialchars('<td class="aln-cntr" colspan="6">'),
+									  htmlspecialchars('</td>')
+								  ) . '</li>' .
+								  '</ul></p>',
+		);
+	}
+
+
+	protected function _parser($shortcode)
+	{
+
+		if (strpos($shortcode, '[PAYMENT_LIST_*') !== false) {
+			return $this->_get_payment_list($shortcode);
+		}
+		return '';
+	}
+
+
+	/**
+	 * verify incoming data contains what is needed for retrieving and parsing each payment for transaction.
+	 *
+	 * @since 4.5.0
+	 *
+	 * @param string $shortcode The incoming shortcode.
+	 *
+	 * @return string parsed ticket line item list.
+	 */
+	private function _get_payment_list($shortcode)
+	{
+		$this->_validate_list_requirements();
+
+
+		if (! $this->_data['data'] instanceof EE_Messages_Addressee) {
+			return '';
+		}
+
+		$valid_shortcodes = array('payment');
+
+		$addressee_obj = $this->_data['data'];
+		$templates = $this->_extra_data['template'];
+		$payments = apply_filters(
+			'FHEE__Payment_List_Shortcodes___get_payments_list__payments',
+			$addressee_obj->payments
+		);
+
+		// let's get any attributes that may be present and set the defaults.
+		$atts = $this->_get_shortcode_attrs($shortcode);
+
+		$no_payments_msg = empty($atts['no_payments']) ? esc_html__(
+			'No approved payments have been received.',
+			'event_espresso'
+		) : $atts['no_payments'];
+
+		// made it here so we have an array of paymnets, so we should have what we need.
+		$payment_content = empty($payments) ? $no_payments_msg : '';
+
+		$payments = (array) $payments;
+
+		foreach ($payments as $payment) {
+			$payment_content .= $this->_shortcode_helper->parse_payment_list_template(
+				$templates['payment_list'],
+				$payment,
+				$valid_shortcodes,
+				$this->_extra_data
+			);
+		}
+
+		return $payment_content;
+	}
 }

core/libraries/shortcodes/EE_Messenger_Shortcodes.lib.php

Spacing +5 added lines, -5 removed lines

@@ -61,7 +61,7 @@ 
         $action = $request->getRequestParam('action');
         // show error message about buttons/urls not working as expected if messenger deactivated.
         if ($action === 'update_message_template' && is_admin()) {
-            if (! isset($this->_active_messengers['pdf'])) {
+            if ( ! isset($this->_active_messengers['pdf'])) {
                 EE_Error::add_attention(
                     esc_html__(
                         'Be aware that the pdf messenger is inactive.  This means that any pdf related shortcodes will parse to an empty string.',
@@ -70,7 +70,7 @@ 
                 );
             }
 
-            if (! isset($this->_active_messengers['html'])) {
+            if ( ! isset($this->_active_messengers['html'])) {
                 EE_Error::add_attention(
                     esc_html__(
                         'Be aware that the html messenger is inactive. This means that any html related shortcodes will parse to an empty string.',
@@ -93,7 +93,7 @@ 
         $recipient = ! $recipient instanceof EE_Messages_Addressee && ! empty($this->_extra_data['data']) && $this->_extra_data['data'] instanceof EE_Messages_Addressee
             ? $this->_extra_data['data'] : $recipient;
 
-        if (! $recipient instanceof EE_Messages_Addressee) {
+        if ( ! $recipient instanceof EE_Messages_Addressee) {
             return '';
         }
 
@@ -132,8 +132,8 @@ 
                 'event_espresso'
             );
         $content = '
-<form method="post" action="' . $this->_get_url($recipient, $sending_messenger) . '" >
-	<input class="print_button" type="submit" value="' . $download_text . '" />
+<form method="post" action="' . $this->_get_url($recipient, $sending_messenger).'" >
+	<input class="print_button" type="submit" value="' . $download_text.'" />
 </form>
 		';
         return $content;

Indentation +149 added lines, -149 removed lines

@@ -22,157 +22,157 @@
  */
 class EE_Messenger_Shortcodes extends EE_Shortcodes
 {
-    /**
-     * Hold array of active messengers indexed by messenger name.
-     *
-     * @since 4.5.0
-     *
-     * @var EE_messenger[]
-     */
-    protected $_active_messengers = array();
-
-
-    protected function _init_props()
-    {
-        $this->label = esc_html__('Messenger Shortcodes', 'event_espresso');
-        $this->description = esc_html__('All shortcodes that are messenger specific.', 'event_espresso');
-        /** @type EE_Message_Resource_Manager $message_resource_manager */
-        $message_resource_manager = EE_Registry::instance()->load_lib('Message_Resource_Manager');
-        // add messages about what happens  when the messenger is active.
-        $this->_active_messengers = $message_resource_manager->active_messengers();
-
-        $this->_shortcodes['[DISPLAY_HTML_URL]'] = esc_html__(
-            'This will return a link to view the template in a browser if the html messenger is active.',
-            'event_espresso'
-        );
-        $this->_shortcodes['[DISPLAY_PDF_URL]'] = esc_html__(
-            'This will return a link to generate a pdf for the template if the pdf messenger is active.',
-            'event_espresso'
-        );
-        $this->_shortcodes['[DISPLAY_PDF_BUTTON]'] = esc_html__(
-            'This will return html for a download pdf button trigger if the pdf messenger is active.',
-            'event_espresso'
-        );
-
-        /** @var RequestInterface $request */
-        $request = LoaderFactory::getLoader()->getShared(RequestInterface::class);
-        $action = $request->getRequestParam('action');
-        // show error message about buttons/urls not working as expected if messenger deactivated.
-        if ($action === 'update_message_template' && is_admin()) {
-            if (! isset($this->_active_messengers['pdf'])) {
-                EE_Error::add_attention(
-                    esc_html__(
-                        'Be aware that the pdf messenger is inactive.  This means that any pdf related shortcodes will parse to an empty string.',
-                        'event_espresso'
-                    )
-                );
-            }
-
-            if (! isset($this->_active_messengers['html'])) {
-                EE_Error::add_attention(
-                    esc_html__(
-                        'Be aware that the html messenger is inactive. This means that any html related shortcodes will parse to an empty string.',
-                        'event_espresso'
-                    )
-                );
-            }
-        }
-    }
-
-
-    protected function _parser($shortcode)
-    {
-        // make sure we end up with a copy of the EE_Messages_Addressee object
-        $recipient = $this->_data instanceof EE_Messages_Addressee ? $this->_data : null;
-        $recipient = ! $recipient instanceof EE_Messages_Addressee && is_array(
-            $this->_data
-        ) && isset($this->_data['data']) && $this->_data['data'] instanceof EE_Messages_Addressee ? $this->_data['data']
-            : $recipient;
-        $recipient = ! $recipient instanceof EE_Messages_Addressee && ! empty($this->_extra_data['data']) && $this->_extra_data['data'] instanceof EE_Messages_Addressee
-            ? $this->_extra_data['data'] : $recipient;
-
-        if (! $recipient instanceof EE_Messages_Addressee) {
-            return '';
-        }
-
-        switch ($shortcode) {
-            case '[DISPLAY_HTML_URL]':
-                return isset($this->_active_messengers['html']) ? $this->_get_url($recipient, 'html') : '';
-                break;
-            case '[DISPLAY_PDF_URL]':
-                return isset($this->_active_messengers['pdf']) ? $this->_get_url($recipient, 'pdf') : '';
-                break;
-            case '[DISPLAY_PDF_BUTTON]':
-                return isset($this->_active_messengers['pdf']) ? $this->_get_button($recipient, 'pdf') : '';
-                break;
-        }
-        return '';
-    }
-
-
-    /**
-     * This method takes the incoming data and figures out from it what the message type is and evt_id/grp_id and uses
-     * that to generate the html for a button in the template.
-     *
-     * @since 4.5.0
-     *
-     * @param EE_Messages_Addressee $recipient
-     * @param string                $sending_messenger 'html' or 'pdf'
-     *
-     * @return string                Generated html
-     */
-    private function _get_button(EE_Messages_Addressee $recipient, $sending_messenger)
-    {
-        $download_text = $sending_messenger == 'pdf'
-            ? esc_html__('Download PDF', 'event_espresso')
-            : esc_html__(
-                'Show HTML',
-                'event_espresso'
-            );
-        $content = '
+	/**
+	 * Hold array of active messengers indexed by messenger name.
+	 *
+	 * @since 4.5.0
+	 *
+	 * @var EE_messenger[]
+	 */
+	protected $_active_messengers = array();
+
+
+	protected function _init_props()
+	{
+		$this->label = esc_html__('Messenger Shortcodes', 'event_espresso');
+		$this->description = esc_html__('All shortcodes that are messenger specific.', 'event_espresso');
+		/** @type EE_Message_Resource_Manager $message_resource_manager */
+		$message_resource_manager = EE_Registry::instance()->load_lib('Message_Resource_Manager');
+		// add messages about what happens  when the messenger is active.
+		$this->_active_messengers = $message_resource_manager->active_messengers();
+
+		$this->_shortcodes['[DISPLAY_HTML_URL]'] = esc_html__(
+			'This will return a link to view the template in a browser if the html messenger is active.',
+			'event_espresso'
+		);
+		$this->_shortcodes['[DISPLAY_PDF_URL]'] = esc_html__(
+			'This will return a link to generate a pdf for the template if the pdf messenger is active.',
+			'event_espresso'
+		);
+		$this->_shortcodes['[DISPLAY_PDF_BUTTON]'] = esc_html__(
+			'This will return html for a download pdf button trigger if the pdf messenger is active.',
+			'event_espresso'
+		);
+
+		/** @var RequestInterface $request */
+		$request = LoaderFactory::getLoader()->getShared(RequestInterface::class);
+		$action = $request->getRequestParam('action');
+		// show error message about buttons/urls not working as expected if messenger deactivated.
+		if ($action === 'update_message_template' && is_admin()) {
+			if (! isset($this->_active_messengers['pdf'])) {
+				EE_Error::add_attention(
+					esc_html__(
+						'Be aware that the pdf messenger is inactive.  This means that any pdf related shortcodes will parse to an empty string.',
+						'event_espresso'
+					)
+				);
+			}
+
+			if (! isset($this->_active_messengers['html'])) {
+				EE_Error::add_attention(
+					esc_html__(
+						'Be aware that the html messenger is inactive. This means that any html related shortcodes will parse to an empty string.',
+						'event_espresso'
+					)
+				);
+			}
+		}
+	}
+
+
+	protected function _parser($shortcode)
+	{
+		// make sure we end up with a copy of the EE_Messages_Addressee object
+		$recipient = $this->_data instanceof EE_Messages_Addressee ? $this->_data : null;
+		$recipient = ! $recipient instanceof EE_Messages_Addressee && is_array(
+			$this->_data
+		) && isset($this->_data['data']) && $this->_data['data'] instanceof EE_Messages_Addressee ? $this->_data['data']
+			: $recipient;
+		$recipient = ! $recipient instanceof EE_Messages_Addressee && ! empty($this->_extra_data['data']) && $this->_extra_data['data'] instanceof EE_Messages_Addressee
+			? $this->_extra_data['data'] : $recipient;
+
+		if (! $recipient instanceof EE_Messages_Addressee) {
+			return '';
+		}
+
+		switch ($shortcode) {
+			case '[DISPLAY_HTML_URL]':
+				return isset($this->_active_messengers['html']) ? $this->_get_url($recipient, 'html') : '';
+				break;
+			case '[DISPLAY_PDF_URL]':
+				return isset($this->_active_messengers['pdf']) ? $this->_get_url($recipient, 'pdf') : '';
+				break;
+			case '[DISPLAY_PDF_BUTTON]':
+				return isset($this->_active_messengers['pdf']) ? $this->_get_button($recipient, 'pdf') : '';
+				break;
+		}
+		return '';
+	}
+
+
+	/**
+	 * This method takes the incoming data and figures out from it what the message type is and evt_id/grp_id and uses
+	 * that to generate the html for a button in the template.
+	 *
+	 * @since 4.5.0
+	 *
+	 * @param EE_Messages_Addressee $recipient
+	 * @param string                $sending_messenger 'html' or 'pdf'
+	 *
+	 * @return string                Generated html
+	 */
+	private function _get_button(EE_Messages_Addressee $recipient, $sending_messenger)
+	{
+		$download_text = $sending_messenger == 'pdf'
+			? esc_html__('Download PDF', 'event_espresso')
+			: esc_html__(
+				'Show HTML',
+				'event_espresso'
+			);
+		$content = '
 <form method="post" action="' . $this->_get_url($recipient, $sending_messenger) . '" >
 	<input class="print_button" type="submit" value="' . $download_text . '" />
 </form>
 		';
-        return $content;
-    }
-
-
-    /**
-     * This method takes the incoming data and figures out from it what the message type is and
-     * evt_id/grp_id and uses that to generate the url for displaying the template in a browser.
-     *
-     * @since 4.5.0
-     *
-     * @param EE_Messages_Addressee $recipient
-     * @param string                $sending_messenger
-     *
-     * @return string The generated url for displaying the link.
-     * @throws EE_Error
-     */
-    private function _get_url(EE_Messages_Addressee $recipient, $sending_messenger)
-    {
-
-        $reg = $recipient->reg_obj;
-        $reg = ! $reg instanceof EE_Registration ? $recipient->primary_reg_obj : $reg;
-
-
-        if ($this->_message_type instanceof EE_message_type && $this->_message instanceof EE_Message) {
-            EE_Registry::instance()->load_helper('MSG_Template');
-            try {
-                return EEH_MSG_Template::get_url_trigger(
-                    $this->_message_type,
-                    $this->_message,
-                    $reg,
-                    $sending_messenger
-                );
-            } catch (EE_Error $e) {
-                if (WP_DEBUG) {
-                    $e->get_error();
-                }
-            }
-        }
-
-        return '';
-    }
+		return $content;
+	}
+
+
+	/**
+	 * This method takes the incoming data and figures out from it what the message type is and
+	 * evt_id/grp_id and uses that to generate the url for displaying the template in a browser.
+	 *
+	 * @since 4.5.0
+	 *
+	 * @param EE_Messages_Addressee $recipient
+	 * @param string                $sending_messenger
+	 *
+	 * @return string The generated url for displaying the link.
+	 * @throws EE_Error
+	 */
+	private function _get_url(EE_Messages_Addressee $recipient, $sending_messenger)
+	{
+
+		$reg = $recipient->reg_obj;
+		$reg = ! $reg instanceof EE_Registration ? $recipient->primary_reg_obj : $reg;
+
+
+		if ($this->_message_type instanceof EE_message_type && $this->_message instanceof EE_Message) {
+			EE_Registry::instance()->load_helper('MSG_Template');
+			try {
+				return EEH_MSG_Template::get_url_trigger(
+					$this->_message_type,
+					$this->_message,
+					$reg,
+					$sending_messenger
+				);
+			} catch (EE_Error $e) {
+				if (WP_DEBUG) {
+					$e->get_error();
+				}
+			}
+		}
+
+		return '';
+	}
 }

core/libraries/payment_methods/EE_PMT_Base.lib.php

Spacing +18 added lines, -18 removed lines

@@ -118,7 +118,7 @@ 
             $this->_gateway->set_unsupported_character_remover(new AsciiOnly());
             do_action('AHEE__EE_PMT_Base___construct__done_initializing_gateway_class', $this, $this->_gateway);
         }
-        if (! isset($this->_has_billing_form)) {
+        if ( ! isset($this->_has_billing_form)) {
             // by default, On Site gateways have a billing form
             if ($this->payment_occurs() == EE_PMT_Base::onsite) {
                 $this->set_has_billing_form(true);
@@ -127,7 +127,7 @@ 
             }
         }
 
-        if (! $this->_pretty_name) {
+        if ( ! $this->_pretty_name) {
             throw new EE_Error(
                 sprintf(
                     esc_html__(
@@ -139,7 +139,7 @@ 
         }
         // if the child didn't specify a default button, use the credit card one
         if ($this->_default_button_url === null) {
-            $this->_default_button_url = EE_PLUGIN_DIR_URL . 'payment_methods/pay-by-credit-card.png';
+            $this->_default_button_url = EE_PLUGIN_DIR_URL.'payment_methods/pay-by-credit-card.png';
         }
     }
 
@@ -160,7 +160,7 @@ 
     {
         $reflector = new ReflectionClass(get_class($this));
         $fn = $reflector->getFileName();
-        $this->_file_folder = dirname($fn) . '/';
+        $this->_file_folder = dirname($fn).'/';
     }
 
 
@@ -193,7 +193,7 @@ 
      */
     public function file_folder()
     {
-        if (! $this->_file_folder) {
+        if ( ! $this->_file_folder) {
             $this->_set_file_folder();
         }
         return $this->_file_folder;
@@ -205,7 +205,7 @@ 
      */
     public function file_url()
     {
-        if (! $this->_file_url) {
+        if ( ! $this->_file_url) {
             $this->_set_file_url();
         }
         return $this->_file_url;
@@ -239,7 +239,7 @@ 
      */
     public function settings_form()
     {
-        if (! $this->_settings_form) {
+        if ( ! $this->_settings_form) {
             $this->_settings_form = $this->generate_new_settings_form();
             $this->_settings_form->set_payment_method_type($this);
             // if we have already assigned a model object to this pmt, make
@@ -293,7 +293,7 @@ 
     public function billing_form(EE_Transaction $transaction = null, $extra_args = array())
     {
         // has billing form already been regenerated ? or overwrite cache?
-        if (! $this->_billing_form instanceof EE_Billing_Info_Form || ! $this->_cache_billing_form) {
+        if ( ! $this->_billing_form instanceof EE_Billing_Info_Form || ! $this->_cache_billing_form) {
             $this->_billing_form = $this->generate_new_billing_form($transaction, $extra_args);
         }
         // if we know who the attendee is, and this is a billing form
@@ -397,7 +397,7 @@ 
             $payment = EEM_Payment::instance()->get_one(array($duplicate_properties));
             // if we didn't already have a payment in progress for the same thing,
             // then we actually want to make a new payment
-            if (! $payment instanceof EE_Payment) {
+            if ( ! $payment instanceof EE_Payment) {
                 $payment = EE_Payment::new_instance(
                     array_merge(
                         $duplicate_properties,
@@ -498,7 +498,7 @@ 
     public function handle_ipn($req_data, $transaction)
     {
         $transaction = EEM_Transaction::instance()->ensure_is_obj($transaction);
-        if (! $this->_gateway instanceof EE_Offsite_Gateway) {
+        if ( ! $this->_gateway instanceof EE_Offsite_Gateway) {
             throw new EE_Error(
                 sprintf(
                     esc_html__("Could not handle IPN because '%s' is not an offsite gateway", "event_espresso"),
@@ -521,7 +521,7 @@ 
      */
     protected function _save_billing_info_to_attendee($billing_form, $transaction)
     {
-        if (! $transaction || ! $transaction instanceof EE_Transaction) {
+        if ( ! $transaction || ! $transaction instanceof EE_Transaction) {
             EE_Error::add_error(
                 esc_html__("Cannot save billing info because no transaction was specified", "event_espresso"),
                 __FILE__,
@@ -531,7 +531,7 @@ 
             return false;
         }
         $primary_reg = $transaction->primary_registration();
-        if (! $primary_reg) {
+        if ( ! $primary_reg) {
             EE_Error::add_error(
                 esc_html__("Cannot save billing info because the transaction has no primary registration", "event_espresso"),
                 __FILE__,
@@ -541,7 +541,7 @@ 
             return false;
         }
         $attendee = $primary_reg->attendee();
-        if (! $attendee) {
+        if ( ! $attendee) {
             EE_Error::add_error(
                 esc_html__(
                     "Cannot save billing info because the transaction's primary registration has no attendee!",
@@ -654,7 +654,7 @@ 
      */
     public function payment_occurs()
     {
-        if (! $this->_gateway) {
+        if ( ! $this->_gateway) {
             return EE_PMT_Base::offline;
         } elseif ($this->_gateway instanceof EE_Onsite_Gateway) {
             return EE_PMT_Base::onsite;
@@ -685,7 +685,7 @@ 
     public function payment_overview_content(EE_Payment $payment)
     {
         return EEH_Template::display_template(
-            EE_LIBRARIES . 'payment_methods/templates/payment_details_content.template.php',
+            EE_LIBRARIES.'payment_methods/templates/payment_details_content.template.php',
             array('payment_method' => $this->_pm_instance, 'payment' => $payment),
             true
         );
@@ -783,7 +783,7 @@ 
      */
     public function get_help_tab_name()
     {
-        return 'ee_' . strtolower($this->system_name()) . '_help_tab';
+        return 'ee_'.strtolower($this->system_name()).'_help_tab';
     }
 
     /**
@@ -794,7 +794,7 @@ 
      */
     public function cap_name()
     {
-        return 'ee_payment_method_' . strtolower($this->system_name());
+        return 'ee_payment_method_'.strtolower($this->system_name());
     }
 
     /**
@@ -828,7 +828,7 @@ 
     public function introductory_html()
     {
         return EEH_Template::locate_template(
-            $this->file_folder() . 'templates/' . strtolower($this->system_name()) . '_intro.template.php',
+            $this->file_folder().'templates/'.strtolower($this->system_name()).'_intro.template.php',
             array('pmt_obj' => $this, 'pm_instance' => $this->_pm_instance)
         );
     }

Indentation +810 added lines, -810 removed lines

@@ -21,814 +21,814 @@
  */
 abstract class EE_PMT_Base
 {
-    const onsite = 'on-site';
-    const offsite = 'off-site';
-    const offline = 'off-line';
-
-    /**
-     * @var EE_Payment_Method
-     */
-    protected $_pm_instance = null;
-
-    /**
-     * @var boolean
-     */
-    protected $_requires_https = false;
-
-    /**
-     * @var boolean
-     */
-    protected $_has_billing_form;
-
-    /**
-     * @var EE_Gateway
-     */
-    protected $_gateway = null;
-
-    /**
-     * @var EE_Payment_Method_Form
-     */
-    protected $_settings_form = null;
-
-    /**
-     * @var EE_Form_Section_Proper
-     */
-    protected $_billing_form = null;
-
-    /**
-     * @var boolean
-     */
-    protected $_cache_billing_form = true;
-
-    /**
-     * String of the absolute path to the folder containing this file, with a trailing slash.
-     * eg '/public_html/wp-site/wp-content/plugins/event-espresso/payment_methods/Invoice/'
-     *
-     * @var string
-     */
-    protected $_file_folder = null;
-
-    /**
-     * String to the absolute URL to this file (useful for getting its web-accessible resources
-     * like images, js, or css)
-     *
-     * @var string
-     */
-    protected $_file_url = null;
-
-    /**
-     * Pretty name for the payment method
-     *
-     * @var string
-     */
-    protected $_pretty_name = null;
-
-    /**
-     *
-     * @var string
-     */
-    protected $_default_button_url = null;
-
-    /**
-     *
-     * @var string
-     */
-    protected $_default_description = null;
-
-
-    /**
-     *
-     * @param EE_Payment_Method $pm_instance
-     * @throws EE_Error
-     * @return EE_PMT_Base
-     */
-    public function __construct($pm_instance = null)
-    {
-        if ($pm_instance instanceof EE_Payment_Method) {
-            $this->set_instance($pm_instance);
-        }
-        if ($this->_gateway) {
-            $this->_gateway->set_payment_model(EEM_Payment::instance());
-            $this->_gateway->set_payment_log(EEM_Change_Log::instance());
-            $this->_gateway->set_template_helper(new EEH_Template());
-            $this->_gateway->set_line_item_helper(new EEH_Line_Item());
-            $this->_gateway->set_money_helper(new EEH_Money());
-            $this->_gateway->set_gateway_data_formatter(new GatewayDataFormatter());
-            $this->_gateway->set_unsupported_character_remover(new AsciiOnly());
-            do_action('AHEE__EE_PMT_Base___construct__done_initializing_gateway_class', $this, $this->_gateway);
-        }
-        if (! isset($this->_has_billing_form)) {
-            // by default, On Site gateways have a billing form
-            if ($this->payment_occurs() == EE_PMT_Base::onsite) {
-                $this->set_has_billing_form(true);
-            } else {
-                $this->set_has_billing_form(false);
-            }
-        }
-
-        if (! $this->_pretty_name) {
-            throw new EE_Error(
-                sprintf(
-                    esc_html__(
-                        "You must set the pretty name for the Payment Method Type in the constructor (_pretty_name), and please make it internationalized",
-                        "event_espresso"
-                    )
-                )
-            );
-        }
-        // if the child didn't specify a default button, use the credit card one
-        if ($this->_default_button_url === null) {
-            $this->_default_button_url = EE_PLUGIN_DIR_URL . 'payment_methods/pay-by-credit-card.png';
-        }
-    }
-
-
-    /**
-     * @param boolean $has_billing_form
-     */
-    public function set_has_billing_form($has_billing_form)
-    {
-        $this->_has_billing_form = filter_var($has_billing_form, FILTER_VALIDATE_BOOLEAN);
-    }
-
-
-    /**
-     * sets the file_folder property
-     */
-    protected function _set_file_folder()
-    {
-        $reflector = new ReflectionClass(get_class($this));
-        $fn = $reflector->getFileName();
-        $this->_file_folder = dirname($fn) . '/';
-    }
-
-
-    /**
-     * sets the file URL with a trailing slash for this PMT
-     */
-    protected function _set_file_url()
-    {
-        $plugins_dir_fixed = str_replace('\\', '/', WP_PLUGIN_DIR);
-        $file_folder_fixed = str_replace('\\', '/', $this->file_folder());
-        $file_path = str_replace($plugins_dir_fixed, WP_PLUGIN_URL, $file_folder_fixed);
-        $this->_file_url = set_url_scheme($file_path);
-    }
-
-    /**
-     * Gets the default description on all payment methods of this type
-     *
-     * @return string
-     */
-    public function default_description()
-    {
-        return $this->_default_description;
-    }
-
-
-    /**
-     * Returns the folder containing the PMT child class, with a trailing slash
-     *
-     * @return string
-     */
-    public function file_folder()
-    {
-        if (! $this->_file_folder) {
-            $this->_set_file_folder();
-        }
-        return $this->_file_folder;
-    }
-
-
-    /**
-     * @return string
-     */
-    public function file_url()
-    {
-        if (! $this->_file_url) {
-            $this->_set_file_url();
-        }
-        return $this->_file_url;
-    }
-
-
-    /**
-     * Sets the payment method instance this payment method type is for.
-     * Its important teh payment method instance is set before
-     *
-     * @param EE_Payment_Method $payment_method_instance
-     */
-    public function set_instance($payment_method_instance)
-    {
-        $this->_pm_instance = $payment_method_instance;
-        // if they have already requested the settings form, make sure its
-        // data matches this model object
-        if ($this->_settings_form) {
-            $this->settings_form()->populate_model_obj($payment_method_instance);
-        }
-        if ($this->_gateway && $this->_gateway instanceof EE_Gateway) {
-            $this->_gateway->set_settings($payment_method_instance->settings_array());
-        }
-    }
-
-
-    /**
-     * Gets teh form for displaying to admins where they setup the payment method
-     *
-     * @return EE_Payment_Method_Form
-     */
-    public function settings_form()
-    {
-        if (! $this->_settings_form) {
-            $this->_settings_form = $this->generate_new_settings_form();
-            $this->_settings_form->set_payment_method_type($this);
-            // if we have already assigned a model object to this pmt, make
-            // sure its reflected in teh form we just generated
-            if ($this->_pm_instance) {
-                $this->_settings_form->populate_model_obj($this->_pm_instance);
-            }
-        }
-        return $this->_settings_form;
-    }
-
-
-    /**
-     * Gets the form for all the settings related to this payment method type
-     *
-     * @return EE_Payment_Method_Form
-     */
-    abstract public function generate_new_settings_form();
-
-
-    /**
-     * Sets the form for settings. This may be useful if we have already received
-     * a form submission and have form data it in, and want to use it anytime we're showing
-     * this payment method type's settings form later in the request
-     *
-     * @param EE_Payment_Method_Form $form
-     */
-    public function set_settings_form($form)
-    {
-        $this->_settings_form = $form;
-    }
-
-
-    /**
-     * @return boolean
-     */
-    public function has_billing_form()
-    {
-        return $this->_has_billing_form;
-    }
-
-
-    /**
-     * Gets the form for displaying to attendees where they can enter their billing info
-     * which will be sent to teh gateway (can be null)
-     *
-     * @param \EE_Transaction $transaction
-     * @param array           $extra_args
-     * @return \EE_Billing_Attendee_Info_Form|\EE_Billing_Info_Form|null
-     */
-    public function billing_form(EE_Transaction $transaction = null, $extra_args = array())
-    {
-        // has billing form already been regenerated ? or overwrite cache?
-        if (! $this->_billing_form instanceof EE_Billing_Info_Form || ! $this->_cache_billing_form) {
-            $this->_billing_form = $this->generate_new_billing_form($transaction, $extra_args);
-        }
-        // if we know who the attendee is, and this is a billing form
-        // that uses attendee info, populate it
-        if (
-            apply_filters(
-                'FHEE__populate_billing_form_fields_from_attendee',
-                ($this->_billing_form instanceof EE_Billing_Attendee_Info_Form
-                && $transaction instanceof EE_Transaction
-                && $transaction->primary_registration() instanceof EE_Registration
-                && $transaction->primary_registration()->attendee() instanceof EE_Attendee
-                ),
-                $this->_billing_form,
-                $transaction
-            )
-        ) {
-            $this->_billing_form->populate_from_attendee($transaction->primary_registration()->attendee());
-        }
-        return $this->_billing_form;
-    }
-
-
-    /**
-     * Creates the billing form for this payment method type
-     *
-     * @param \EE_Transaction $transaction
-     * @return \EE_Billing_Info_Form
-     */
-    abstract public function generate_new_billing_form(EE_Transaction $transaction = null);
-
-
-    /**
-     * apply_billing_form_debug_settings
-     * applies debug data to the form
-     *
-     * @param \EE_Billing_Info_Form $billing_form
-     * @return \EE_Billing_Info_Form
-     */
-    public function apply_billing_form_debug_settings(EE_Billing_Info_Form $billing_form)
-    {
-        return $billing_form;
-    }
-
-
-    /**
-     * Sets the billing form for this payment method type. You may want to use this
-     * if you have form
-     *
-     * @param EE_Payment_Method $form
-     */
-    public function set_billing_form($form)
-    {
-        $this->_billing_form = $form;
-    }
-
-
-    /**
-     * Returns whether or not this payment method requires HTTPS to be used
-     *
-     * @return boolean
-     */
-    public function requires_https()
-    {
-        return $this->_requires_https;
-    }
-
-
-    /**
-     *
-     * @param EE_Transaction       $transaction
-     * @param float                $amount
-     * @param EE_Billing_Info_Form $billing_info
-     * @param string               $return_url
-     * @param string               $fail_url
-     * @param string               $method
-     * @param bool                 $by_admin
-     * @return EE_Payment
-     * @throws EE_Error
-     */
-    public function process_payment(
-        EE_Transaction $transaction,
-        $amount = null,
-        $billing_info = null,
-        $return_url = null,
-        $fail_url = '',
-        $method = 'CART',
-        $by_admin = false
-    ) {
-        // @todo: add surcharge for the payment method, if any
-        if ($this->_gateway) {
-            // there is a gateway, so we're going to make a payment object
-            // but wait! do they already have a payment in progress that we thought was failed?
-            $duplicate_properties = array(
-                'STS_ID'               => EEM_Payment::status_id_failed,
-                'TXN_ID'               => $transaction->ID(),
-                'PMD_ID'               => $this->_pm_instance->ID(),
-                'PAY_source'           => $method,
-                'PAY_amount'           => $amount !== null ? $amount : $transaction->remaining(),
-                'PAY_gateway_response' => null,
-            );
-            $payment = EEM_Payment::instance()->get_one(array($duplicate_properties));
-            // if we didn't already have a payment in progress for the same thing,
-            // then we actually want to make a new payment
-            if (! $payment instanceof EE_Payment) {
-                $payment = EE_Payment::new_instance(
-                    array_merge(
-                        $duplicate_properties,
-                        array(
-                            'PAY_timestamp'       => time(),
-                            'PAY_txn_id_chq_nmbr' => null,
-                            'PAY_po_number'       => null,
-                            'PAY_extra_accntng'   => null,
-                            'PAY_details'         => null,
-                        )
-                    )
-                );
-            }
-            // make sure the payment has been saved to show we started it, and so it has an ID should the gateway try to log it
-            $payment->save();
-            $billing_values = $this->_get_billing_values_from_form($billing_info);
-
-            //  Offsite Gateway
-            if ($this->_gateway instanceof EE_Offsite_Gateway) {
-                $payment = $this->_gateway->set_redirection_info(
-                    $payment,
-                    $billing_values,
-                    $return_url,
-                    EE_Config::instance()->core->txn_page_url(
-                        array(
-                            'e_reg_url_link'    => $transaction->primary_registration()->reg_url_link(),
-                            'ee_payment_method' => $this->_pm_instance->slug(),
-                        )
-                    ),
-                    $fail_url
-                );
-                $payment->save();
-                //  Onsite Gateway
-            } elseif ($this->_gateway instanceof EE_Onsite_Gateway) {
-                $payment = $this->_gateway->do_direct_payment($payment, $billing_values);
-                $payment->save();
-            } else {
-                throw new EE_Error(
-                    sprintf(
-                        esc_html__(
-                            'Gateway for payment method type "%s" is "%s", not a subclass of either EE_Offsite_Gateway or EE_Onsite_Gateway, or null (to indicate NO gateway)',
-                            'event_espresso'
-                        ),
-                        get_class($this),
-                        gettype($this->_gateway)
-                    )
-                );
-            }
-        } else {
-            // no gateway provided
-            // there is no payment. Must be an offline gateway
-            // create a payment object anyways, but dont save it
-            $payment = EE_Payment::new_instance(
-                array(
-                    'STS_ID'        => EEM_Payment::status_id_pending,
-                    'TXN_ID'        => $transaction->ID(),
-                    'PMD_ID'        => $transaction->payment_method_ID(),
-                    'PAY_amount'    => 0.00,
-                    'PAY_timestamp' => time(),
-                )
-            );
-        }
-
-        // if there is billing info, clean it and save it now
-        if ($billing_info instanceof EE_Billing_Attendee_Info_Form) {
-            $this->_save_billing_info_to_attendee($billing_info, $transaction);
-        }
-
-        return $payment;
-    }
-
-    /**
-     * Gets the values we want to pass onto the gateway. Normally these
-     * are just the 'pretty' values, but there may be times the data may need
-     * a  little massaging. Proper subsections will become arrays of inputs
-     *
-     * @param EE_Billing_Info_Form $billing_form
-     * @return array
-     */
-    protected function _get_billing_values_from_form($billing_form)
-    {
-        if ($billing_form instanceof EE_Form_Section_Proper) {
-            return $billing_form->input_pretty_values(true);
-        } else {
-            return null;
-        }
-    }
-
-
-    /**
-     * Handles an instant payment notification when the transaction is known (by default).
-     *
-     * @param array          $req_data
-     * @param EE_Transaction $transaction
-     * @return EE_Payment
-     * @throws EE_Error
-     */
-    public function handle_ipn($req_data, $transaction)
-    {
-        $transaction = EEM_Transaction::instance()->ensure_is_obj($transaction);
-        if (! $this->_gateway instanceof EE_Offsite_Gateway) {
-            throw new EE_Error(
-                sprintf(
-                    esc_html__("Could not handle IPN because '%s' is not an offsite gateway", "event_espresso"),
-                    print_r($this->_gateway, true)
-                )
-            );
-        }
-        $payment = $this->_gateway->handle_payment_update($req_data, $transaction);
-        return $payment;
-    }
-
-
-    /**
-     * Saves the billing info onto the attendee of the primary registrant on this transaction, and
-     * cleans it first.
-     *
-     * @param EE_Billing_Attendee_Info_Form $billing_form
-     * @param EE_Transaction                $transaction
-     * @return boolean success
-     */
-    protected function _save_billing_info_to_attendee($billing_form, $transaction)
-    {
-        if (! $transaction || ! $transaction instanceof EE_Transaction) {
-            EE_Error::add_error(
-                esc_html__("Cannot save billing info because no transaction was specified", "event_espresso"),
-                __FILE__,
-                __FUNCTION__,
-                __LINE__
-            );
-            return false;
-        }
-        $primary_reg = $transaction->primary_registration();
-        if (! $primary_reg) {
-            EE_Error::add_error(
-                esc_html__("Cannot save billing info because the transaction has no primary registration", "event_espresso"),
-                __FILE__,
-                __FUNCTION__,
-                __LINE__
-            );
-            return false;
-        }
-        $attendee = $primary_reg->attendee();
-        if (! $attendee) {
-            EE_Error::add_error(
-                esc_html__(
-                    "Cannot save billing info because the transaction's primary registration has no attendee!",
-                    "event_espresso"
-                ),
-                __FILE__,
-                __FUNCTION__,
-                __LINE__
-            );
-            return false;
-        }
-        return $attendee->save_and_clean_billing_info_for_payment_method($billing_form, $transaction->payment_method());
-    }
-
-
-    /**
-     * Gets the payment this IPN is for. Children may often want to
-     * override this to inspect the request
-     *
-     * @param EE_Transaction $transaction
-     * @param array          $req_data
-     * @return EE_Payment
-     */
-    protected function find_payment_for_ipn(EE_Transaction $transaction, $req_data = array())
-    {
-        return $transaction->last_payment();
-    }
-
-
-    /**
-     * In case generic code cannot provide the payment processor with a specific payment method
-     * and transaction, it will try calling this method on each activate payment method.
-     * If the payment method is able to identify the request as being for it, it should fetch
-     * the payment its for and return it. If not, it should throw an EE_Error to indicate it cannot
-     * handle the IPN
-     *
-     * @param array $req_data
-     * @return EE_Payment only if this payment method can find the info its needs from $req_data
-     * and identifies the IPN as being for this payment method (not just fo ra payment method of this type)
-     * @throws EE_Error
-     */
-    public function handle_unclaimed_ipn($req_data = array())
-    {
-        throw new EE_Error(
-            sprintf(esc_html__("Payment Method '%s' cannot handle unclaimed IPNs", "event_espresso"), get_class($this))
-        );
-    }
-
-
-    /**
-     * Logic to be accomplished when the payment attempt is complete.
-     * Most payment methods don't need to do anything at this point; but some, like Mijireh, do.
-     * (Mijireh is an offsite gateway which doesn't send an IPN. So when the user returns to EE from
-     * mijireh, this method needs to be called so the Mijireh PM can ping Mijireh to know the status
-     * of the payment). Fed a transaction because it's always assumed to be the last payment that
-     * we're dealing with. Returns that last payment (if there is one)
-     *
-     * @param EE_Transaction $transaction
-     * @return EE_Payment
-     */
-    public function finalize_payment_for($transaction)
-    {
-        return $transaction->last_payment();
-    }
-
-
-    /**
-     * Whether or not this payment method's gateway supports sending refund requests
-     *
-     * @return boolean
-     */
-    public function supports_sending_refunds()
-    {
-        if ($this->_gateway && $this->_gateway instanceof EE_Gateway) {
-            return $this->_gateway->supports_sending_refunds();
-        } else {
-            return false;
-        }
-    }
-
-
-    /**
-     *
-     * @param EE_Payment $payment
-     * @param array      $refund_info
-     * @throws EE_Error
-     * @return EE_Payment
-     */
-    public function process_refund(EE_Payment $payment, $refund_info = array())
-    {
-        if ($this->_gateway && $this->_gateway instanceof EE_Gateway) {
-            return $this->_gateway->do_direct_refund($payment, $refund_info);
-        } else {
-            throw new EE_Error(
-                sprintf(
-                    esc_html__('Payment Method Type "%s" does not support sending refund requests', 'event_espresso'),
-                    get_class($this)
-                )
-            );
-        }
-    }
-
-
-    /**
-     * Returns one the class's constants onsite,offsite, or offline, depending on this
-     * payment method's gateway.
-     *
-     * @return string
-     * @throws EE_Error
-     */
-    public function payment_occurs()
-    {
-        if (! $this->_gateway) {
-            return EE_PMT_Base::offline;
-        } elseif ($this->_gateway instanceof EE_Onsite_Gateway) {
-            return EE_PMT_Base::onsite;
-        } elseif ($this->_gateway instanceof EE_Offsite_Gateway) {
-            return EE_PMT_Base::offsite;
-        } else {
-            throw new EE_Error(
-                sprintf(
-                    esc_html__(
-                        "Payment method type '%s's gateway isn't an instance of EE_Onsite_Gateway, EE_Offsite_Gateway, or null. It must be one of those",
-                        "event_espresso"
-                    ),
-                    get_class($this)
-                )
-            );
-        }
-    }
-
-
-    /**
-     * For adding any html output ab ove the payment overview.
-     * Many gateways won't want ot display anything, so this function just returns an empty string.
-     * Other gateways may want to override this, such as offline gateways.
-     *
-     * @param EE_Payment $payment
-     * @return string
-     */
-    public function payment_overview_content(EE_Payment $payment)
-    {
-        return EEH_Template::display_template(
-            EE_LIBRARIES . 'payment_methods/templates/payment_details_content.template.php',
-            array('payment_method' => $this->_pm_instance, 'payment' => $payment),
-            true
-        );
-    }
-
-
-    /**
-     * @return array where keys are the help tab name,
-     * values are: array {
-     * @type string $title         i18n name for the help tab
-     * @type string $filename      name of the file located in ./help_tabs/ (ie, in a folder next to this file)
-     * @type array  $template_args any arguments you want passed to the template file while rendering.
-     *                Keys will be variable names and values with be their values.
-     */
-    public function help_tabs_config()
-    {
-        return array();
-    }
-
-
-    /**
-     * The system name for this PMT (eg AIM, Paypal_Pro, Invoice... what gets put into
-     * the payment method's table's PMT_type column)
-     *
-     * @return string
-     */
-    public function system_name()
-    {
-        $classname = get_class($this);
-        return str_replace("EE_PMT_", '', $classname);
-    }
-
-
-    /**
-     * A pretty i18n version of the PMT name. Often the same as the "pretty_name", but you can change it by overriding
-     * this method.
-     * @return string
-     */
-    public function defaultFrontendName()
-    {
-        return $this->pretty_name();
-    }
-
-
-    /**
-     * A pretty i18n version of the PMT name
-     *
-     * @return string
-     */
-    public function pretty_name()
-    {
-        return $this->_pretty_name;
-    }
-
-
-    /**
-     * Gets the default absolute URL to the payment method type's button
-     *
-     * @return string
-     */
-    public function default_button_url()
-    {
-        return $this->_default_button_url;
-    }
-
-
-    /**
-     * Gets the gateway used by this payment method (if any)
-     *
-     * @return EE_Gateway
-     */
-    public function get_gateway()
-    {
-        return $this->_gateway;
-    }
-
-
-    /**
-     * @return string html for the link to a help tab
-     */
-    public function get_help_tab_link()
-    {
-        return EEH_Template::get_help_tab_link(
-            $this->get_help_tab_name(),
-            'espresso_payment_settings',
-            'default'
-        );
-    }
-
-
-    /**
-     * Returns the name of the help tab for this PMT
-     *
-     * @return string
-     */
-    public function get_help_tab_name()
-    {
-        return 'ee_' . strtolower($this->system_name()) . '_help_tab';
-    }
-
-    /**
-     * The name of the wp capability that should be associated with the usage of
-     * this PMT by an admin
-     *
-     * @return string
-     */
-    public function cap_name()
-    {
-        return 'ee_payment_method_' . strtolower($this->system_name());
-    }
-
-    /**
-     * Called by client code to tell the gateway that if it wants to change
-     * the transaction or line items or registrations related to teh payment it already
-     * processed (we think, but possibly not) that now's the time to do it.
-     * It is expected that gateways will store any info they need for this on the PAY_details,
-     * or maybe an extra meta value
-     *
-     * @param EE_Payment $payment
-     * @return void
-     */
-    public function update_txn_based_on_payment($payment)
-    {
-        if ($this->_gateway instanceof EE_Gateway) {
-            $this->_gateway->update_txn_based_on_payment($payment);
-        }
-    }
-
-    /**
-     * Returns a string of HTML describing this payment method type for an admin,
-     * primarily intended for them to read before activating it.
-     * The easiest way to set this is to create a folder 'templates' alongside
-     * your EE_PMT_{System_Name} file, and in it create a file named "{system_name}_intro.template.php".
-     * Eg, if your payment method file is named "EE_PMT_Foo_Bar.pm.php",
-     * then you'd create a file named "templates" in the same folder as it, and name the file
-     * "foo_bar_intro.template.php", and its content will be returned by this method
-     *
-     * @return string
-     */
-    public function introductory_html()
-    {
-        return EEH_Template::locate_template(
-            $this->file_folder() . 'templates/' . strtolower($this->system_name()) . '_intro.template.php',
-            array('pmt_obj' => $this, 'pm_instance' => $this->_pm_instance)
-        );
-    }
+	const onsite = 'on-site';
+	const offsite = 'off-site';
+	const offline = 'off-line';
+
+	/**
+	 * @var EE_Payment_Method
+	 */
+	protected $_pm_instance = null;
+
+	/**
+	 * @var boolean
+	 */
+	protected $_requires_https = false;
+
+	/**
+	 * @var boolean
+	 */
+	protected $_has_billing_form;
+
+	/**
+	 * @var EE_Gateway
+	 */
+	protected $_gateway = null;
+
+	/**
+	 * @var EE_Payment_Method_Form
+	 */
+	protected $_settings_form = null;
+
+	/**
+	 * @var EE_Form_Section_Proper
+	 */
+	protected $_billing_form = null;
+
+	/**
+	 * @var boolean
+	 */
+	protected $_cache_billing_form = true;
+
+	/**
+	 * String of the absolute path to the folder containing this file, with a trailing slash.
+	 * eg '/public_html/wp-site/wp-content/plugins/event-espresso/payment_methods/Invoice/'
+	 *
+	 * @var string
+	 */
+	protected $_file_folder = null;
+
+	/**
+	 * String to the absolute URL to this file (useful for getting its web-accessible resources
+	 * like images, js, or css)
+	 *
+	 * @var string
+	 */
+	protected $_file_url = null;
+
+	/**
+	 * Pretty name for the payment method
+	 *
+	 * @var string
+	 */
+	protected $_pretty_name = null;
+
+	/**
+	 *
+	 * @var string
+	 */
+	protected $_default_button_url = null;
+
+	/**
+	 *
+	 * @var string
+	 */
+	protected $_default_description = null;
+
+
+	/**
+	 *
+	 * @param EE_Payment_Method $pm_instance
+	 * @throws EE_Error
+	 * @return EE_PMT_Base
+	 */
+	public function __construct($pm_instance = null)
+	{
+		if ($pm_instance instanceof EE_Payment_Method) {
+			$this->set_instance($pm_instance);
+		}
+		if ($this->_gateway) {
+			$this->_gateway->set_payment_model(EEM_Payment::instance());
+			$this->_gateway->set_payment_log(EEM_Change_Log::instance());
+			$this->_gateway->set_template_helper(new EEH_Template());
+			$this->_gateway->set_line_item_helper(new EEH_Line_Item());
+			$this->_gateway->set_money_helper(new EEH_Money());
+			$this->_gateway->set_gateway_data_formatter(new GatewayDataFormatter());
+			$this->_gateway->set_unsupported_character_remover(new AsciiOnly());
+			do_action('AHEE__EE_PMT_Base___construct__done_initializing_gateway_class', $this, $this->_gateway);
+		}
+		if (! isset($this->_has_billing_form)) {
+			// by default, On Site gateways have a billing form
+			if ($this->payment_occurs() == EE_PMT_Base::onsite) {
+				$this->set_has_billing_form(true);
+			} else {
+				$this->set_has_billing_form(false);
+			}
+		}
+
+		if (! $this->_pretty_name) {
+			throw new EE_Error(
+				sprintf(
+					esc_html__(
+						"You must set the pretty name for the Payment Method Type in the constructor (_pretty_name), and please make it internationalized",
+						"event_espresso"
+					)
+				)
+			);
+		}
+		// if the child didn't specify a default button, use the credit card one
+		if ($this->_default_button_url === null) {
+			$this->_default_button_url = EE_PLUGIN_DIR_URL . 'payment_methods/pay-by-credit-card.png';
+		}
+	}
+
+
+	/**
+	 * @param boolean $has_billing_form
+	 */
+	public function set_has_billing_form($has_billing_form)
+	{
+		$this->_has_billing_form = filter_var($has_billing_form, FILTER_VALIDATE_BOOLEAN);
+	}
+
+
+	/**
+	 * sets the file_folder property
+	 */
+	protected function _set_file_folder()
+	{
+		$reflector = new ReflectionClass(get_class($this));
+		$fn = $reflector->getFileName();
+		$this->_file_folder = dirname($fn) . '/';
+	}
+
+
+	/**
+	 * sets the file URL with a trailing slash for this PMT
+	 */
+	protected function _set_file_url()
+	{
+		$plugins_dir_fixed = str_replace('\\', '/', WP_PLUGIN_DIR);
+		$file_folder_fixed = str_replace('\\', '/', $this->file_folder());
+		$file_path = str_replace($plugins_dir_fixed, WP_PLUGIN_URL, $file_folder_fixed);
+		$this->_file_url = set_url_scheme($file_path);
+	}
+
+	/**
+	 * Gets the default description on all payment methods of this type
+	 *
+	 * @return string
+	 */
+	public function default_description()
+	{
+		return $this->_default_description;
+	}
+
+
+	/**
+	 * Returns the folder containing the PMT child class, with a trailing slash
+	 *
+	 * @return string
+	 */
+	public function file_folder()
+	{
+		if (! $this->_file_folder) {
+			$this->_set_file_folder();
+		}
+		return $this->_file_folder;
+	}
+
+
+	/**
+	 * @return string
+	 */
+	public function file_url()
+	{
+		if (! $this->_file_url) {
+			$this->_set_file_url();
+		}
+		return $this->_file_url;
+	}
+
+
+	/**
+	 * Sets the payment method instance this payment method type is for.
+	 * Its important teh payment method instance is set before
+	 *
+	 * @param EE_Payment_Method $payment_method_instance
+	 */
+	public function set_instance($payment_method_instance)
+	{
+		$this->_pm_instance = $payment_method_instance;
+		// if they have already requested the settings form, make sure its
+		// data matches this model object
+		if ($this->_settings_form) {
+			$this->settings_form()->populate_model_obj($payment_method_instance);
+		}
+		if ($this->_gateway && $this->_gateway instanceof EE_Gateway) {
+			$this->_gateway->set_settings($payment_method_instance->settings_array());
+		}
+	}
+
+
+	/**
+	 * Gets teh form for displaying to admins where they setup the payment method
+	 *
+	 * @return EE_Payment_Method_Form
+	 */
+	public function settings_form()
+	{
+		if (! $this->_settings_form) {
+			$this->_settings_form = $this->generate_new_settings_form();
+			$this->_settings_form->set_payment_method_type($this);
+			// if we have already assigned a model object to this pmt, make
+			// sure its reflected in teh form we just generated
+			if ($this->_pm_instance) {
+				$this->_settings_form->populate_model_obj($this->_pm_instance);
+			}
+		}
+		return $this->_settings_form;
+	}
+
+
+	/**
+	 * Gets the form for all the settings related to this payment method type
+	 *
+	 * @return EE_Payment_Method_Form
+	 */
+	abstract public function generate_new_settings_form();
+
+
+	/**
+	 * Sets the form for settings. This may be useful if we have already received
+	 * a form submission and have form data it in, and want to use it anytime we're showing
+	 * this payment method type's settings form later in the request
+	 *
+	 * @param EE_Payment_Method_Form $form
+	 */
+	public function set_settings_form($form)
+	{
+		$this->_settings_form = $form;
+	}
+
+
+	/**
+	 * @return boolean
+	 */
+	public function has_billing_form()
+	{
+		return $this->_has_billing_form;
+	}
+
+
+	/**
+	 * Gets the form for displaying to attendees where they can enter their billing info
+	 * which will be sent to teh gateway (can be null)
+	 *
+	 * @param \EE_Transaction $transaction
+	 * @param array           $extra_args
+	 * @return \EE_Billing_Attendee_Info_Form|\EE_Billing_Info_Form|null
+	 */
+	public function billing_form(EE_Transaction $transaction = null, $extra_args = array())
+	{
+		// has billing form already been regenerated ? or overwrite cache?
+		if (! $this->_billing_form instanceof EE_Billing_Info_Form || ! $this->_cache_billing_form) {
+			$this->_billing_form = $this->generate_new_billing_form($transaction, $extra_args);
+		}
+		// if we know who the attendee is, and this is a billing form
+		// that uses attendee info, populate it
+		if (
+			apply_filters(
+				'FHEE__populate_billing_form_fields_from_attendee',
+				($this->_billing_form instanceof EE_Billing_Attendee_Info_Form
+				&& $transaction instanceof EE_Transaction
+				&& $transaction->primary_registration() instanceof EE_Registration
+				&& $transaction->primary_registration()->attendee() instanceof EE_Attendee
+				),
+				$this->_billing_form,
+				$transaction
+			)
+		) {
+			$this->_billing_form->populate_from_attendee($transaction->primary_registration()->attendee());
+		}
+		return $this->_billing_form;
+	}
+
+
+	/**
+	 * Creates the billing form for this payment method type
+	 *
+	 * @param \EE_Transaction $transaction
+	 * @return \EE_Billing_Info_Form
+	 */
+	abstract public function generate_new_billing_form(EE_Transaction $transaction = null);
+
+
+	/**
+	 * apply_billing_form_debug_settings
+	 * applies debug data to the form
+	 *
+	 * @param \EE_Billing_Info_Form $billing_form
+	 * @return \EE_Billing_Info_Form
+	 */
+	public function apply_billing_form_debug_settings(EE_Billing_Info_Form $billing_form)
+	{
+		return $billing_form;
+	}
+
+
+	/**
+	 * Sets the billing form for this payment method type. You may want to use this
+	 * if you have form
+	 *
+	 * @param EE_Payment_Method $form
+	 */
+	public function set_billing_form($form)
+	{
+		$this->_billing_form = $form;
+	}
+
+
+	/**
+	 * Returns whether or not this payment method requires HTTPS to be used
+	 *
+	 * @return boolean
+	 */
+	public function requires_https()
+	{
+		return $this->_requires_https;
+	}
+
+
+	/**
+	 *
+	 * @param EE_Transaction       $transaction
+	 * @param float                $amount
+	 * @param EE_Billing_Info_Form $billing_info
+	 * @param string               $return_url
+	 * @param string               $fail_url
+	 * @param string               $method
+	 * @param bool                 $by_admin
+	 * @return EE_Payment
+	 * @throws EE_Error
+	 */
+	public function process_payment(
+		EE_Transaction $transaction,
+		$amount = null,
+		$billing_info = null,
+		$return_url = null,
+		$fail_url = '',
+		$method = 'CART',
+		$by_admin = false
+	) {
+		// @todo: add surcharge for the payment method, if any
+		if ($this->_gateway) {
+			// there is a gateway, so we're going to make a payment object
+			// but wait! do they already have a payment in progress that we thought was failed?
+			$duplicate_properties = array(
+				'STS_ID'               => EEM_Payment::status_id_failed,
+				'TXN_ID'               => $transaction->ID(),
+				'PMD_ID'               => $this->_pm_instance->ID(),
+				'PAY_source'           => $method,
+				'PAY_amount'           => $amount !== null ? $amount : $transaction->remaining(),
+				'PAY_gateway_response' => null,
+			);
+			$payment = EEM_Payment::instance()->get_one(array($duplicate_properties));
+			// if we didn't already have a payment in progress for the same thing,
+			// then we actually want to make a new payment
+			if (! $payment instanceof EE_Payment) {
+				$payment = EE_Payment::new_instance(
+					array_merge(
+						$duplicate_properties,
+						array(
+							'PAY_timestamp'       => time(),
+							'PAY_txn_id_chq_nmbr' => null,
+							'PAY_po_number'       => null,
+							'PAY_extra_accntng'   => null,
+							'PAY_details'         => null,
+						)
+					)
+				);
+			}
+			// make sure the payment has been saved to show we started it, and so it has an ID should the gateway try to log it
+			$payment->save();
+			$billing_values = $this->_get_billing_values_from_form($billing_info);
+
+			//  Offsite Gateway
+			if ($this->_gateway instanceof EE_Offsite_Gateway) {
+				$payment = $this->_gateway->set_redirection_info(
+					$payment,
+					$billing_values,
+					$return_url,
+					EE_Config::instance()->core->txn_page_url(
+						array(
+							'e_reg_url_link'    => $transaction->primary_registration()->reg_url_link(),
+							'ee_payment_method' => $this->_pm_instance->slug(),
+						)
+					),
+					$fail_url
+				);
+				$payment->save();
+				//  Onsite Gateway
+			} elseif ($this->_gateway instanceof EE_Onsite_Gateway) {
+				$payment = $this->_gateway->do_direct_payment($payment, $billing_values);
+				$payment->save();
+			} else {
+				throw new EE_Error(
+					sprintf(
+						esc_html__(
+							'Gateway for payment method type "%s" is "%s", not a subclass of either EE_Offsite_Gateway or EE_Onsite_Gateway, or null (to indicate NO gateway)',
+							'event_espresso'
+						),
+						get_class($this),
+						gettype($this->_gateway)
+					)
+				);
+			}
+		} else {
+			// no gateway provided
+			// there is no payment. Must be an offline gateway
+			// create a payment object anyways, but dont save it
+			$payment = EE_Payment::new_instance(
+				array(
+					'STS_ID'        => EEM_Payment::status_id_pending,
+					'TXN_ID'        => $transaction->ID(),
+					'PMD_ID'        => $transaction->payment_method_ID(),
+					'PAY_amount'    => 0.00,
+					'PAY_timestamp' => time(),
+				)
+			);
+		}
+
+		// if there is billing info, clean it and save it now
+		if ($billing_info instanceof EE_Billing_Attendee_Info_Form) {
+			$this->_save_billing_info_to_attendee($billing_info, $transaction);
+		}
+
+		return $payment;
+	}
+
+	/**
+	 * Gets the values we want to pass onto the gateway. Normally these
+	 * are just the 'pretty' values, but there may be times the data may need
+	 * a  little massaging. Proper subsections will become arrays of inputs
+	 *
+	 * @param EE_Billing_Info_Form $billing_form
+	 * @return array
+	 */
+	protected function _get_billing_values_from_form($billing_form)
+	{
+		if ($billing_form instanceof EE_Form_Section_Proper) {
+			return $billing_form->input_pretty_values(true);
+		} else {
+			return null;
+		}
+	}
+
+
+	/**
+	 * Handles an instant payment notification when the transaction is known (by default).
+	 *
+	 * @param array          $req_data
+	 * @param EE_Transaction $transaction
+	 * @return EE_Payment
+	 * @throws EE_Error
+	 */
+	public function handle_ipn($req_data, $transaction)
+	{
+		$transaction = EEM_Transaction::instance()->ensure_is_obj($transaction);
+		if (! $this->_gateway instanceof EE_Offsite_Gateway) {
+			throw new EE_Error(
+				sprintf(
+					esc_html__("Could not handle IPN because '%s' is not an offsite gateway", "event_espresso"),
+					print_r($this->_gateway, true)
+				)
+			);
+		}
+		$payment = $this->_gateway->handle_payment_update($req_data, $transaction);
+		return $payment;
+	}
+
+
+	/**
+	 * Saves the billing info onto the attendee of the primary registrant on this transaction, and
+	 * cleans it first.
+	 *
+	 * @param EE_Billing_Attendee_Info_Form $billing_form
+	 * @param EE_Transaction                $transaction
+	 * @return boolean success
+	 */
+	protected function _save_billing_info_to_attendee($billing_form, $transaction)
+	{
+		if (! $transaction || ! $transaction instanceof EE_Transaction) {
+			EE_Error::add_error(
+				esc_html__("Cannot save billing info because no transaction was specified", "event_espresso"),
+				__FILE__,
+				__FUNCTION__,
+				__LINE__
+			);
+			return false;
+		}
+		$primary_reg = $transaction->primary_registration();
+		if (! $primary_reg) {
+			EE_Error::add_error(
+				esc_html__("Cannot save billing info because the transaction has no primary registration", "event_espresso"),
+				__FILE__,
+				__FUNCTION__,
+				__LINE__
+			);
+			return false;
+		}
+		$attendee = $primary_reg->attendee();
+		if (! $attendee) {
+			EE_Error::add_error(
+				esc_html__(
+					"Cannot save billing info because the transaction's primary registration has no attendee!",
+					"event_espresso"
+				),
+				__FILE__,
+				__FUNCTION__,
+				__LINE__
+			);
+			return false;
+		}
+		return $attendee->save_and_clean_billing_info_for_payment_method($billing_form, $transaction->payment_method());
+	}
+
+
+	/**
+	 * Gets the payment this IPN is for. Children may often want to
+	 * override this to inspect the request
+	 *
+	 * @param EE_Transaction $transaction
+	 * @param array          $req_data
+	 * @return EE_Payment
+	 */
+	protected function find_payment_for_ipn(EE_Transaction $transaction, $req_data = array())
+	{
+		return $transaction->last_payment();
+	}
+
+
+	/**
+	 * In case generic code cannot provide the payment processor with a specific payment method
+	 * and transaction, it will try calling this method on each activate payment method.
+	 * If the payment method is able to identify the request as being for it, it should fetch
+	 * the payment its for and return it. If not, it should throw an EE_Error to indicate it cannot
+	 * handle the IPN
+	 *
+	 * @param array $req_data
+	 * @return EE_Payment only if this payment method can find the info its needs from $req_data
+	 * and identifies the IPN as being for this payment method (not just fo ra payment method of this type)
+	 * @throws EE_Error
+	 */
+	public function handle_unclaimed_ipn($req_data = array())
+	{
+		throw new EE_Error(
+			sprintf(esc_html__("Payment Method '%s' cannot handle unclaimed IPNs", "event_espresso"), get_class($this))
+		);
+	}
+
+
+	/**
+	 * Logic to be accomplished when the payment attempt is complete.
+	 * Most payment methods don't need to do anything at this point; but some, like Mijireh, do.
+	 * (Mijireh is an offsite gateway which doesn't send an IPN. So when the user returns to EE from
+	 * mijireh, this method needs to be called so the Mijireh PM can ping Mijireh to know the status
+	 * of the payment). Fed a transaction because it's always assumed to be the last payment that
+	 * we're dealing with. Returns that last payment (if there is one)
+	 *
+	 * @param EE_Transaction $transaction
+	 * @return EE_Payment
+	 */
+	public function finalize_payment_for($transaction)
+	{
+		return $transaction->last_payment();
+	}
+
+
+	/**
+	 * Whether or not this payment method's gateway supports sending refund requests
+	 *
+	 * @return boolean
+	 */
+	public function supports_sending_refunds()
+	{
+		if ($this->_gateway && $this->_gateway instanceof EE_Gateway) {
+			return $this->_gateway->supports_sending_refunds();
+		} else {
+			return false;
+		}
+	}
+
+
+	/**
+	 *
+	 * @param EE_Payment $payment
+	 * @param array      $refund_info
+	 * @throws EE_Error
+	 * @return EE_Payment
+	 */
+	public function process_refund(EE_Payment $payment, $refund_info = array())
+	{
+		if ($this->_gateway && $this->_gateway instanceof EE_Gateway) {
+			return $this->_gateway->do_direct_refund($payment, $refund_info);
+		} else {
+			throw new EE_Error(
+				sprintf(
+					esc_html__('Payment Method Type "%s" does not support sending refund requests', 'event_espresso'),
+					get_class($this)
+				)
+			);
+		}
+	}
+
+
+	/**
+	 * Returns one the class's constants onsite,offsite, or offline, depending on this
+	 * payment method's gateway.
+	 *
+	 * @return string
+	 * @throws EE_Error
+	 */
+	public function payment_occurs()
+	{
+		if (! $this->_gateway) {
+			return EE_PMT_Base::offline;
+		} elseif ($this->_gateway instanceof EE_Onsite_Gateway) {
+			return EE_PMT_Base::onsite;
+		} elseif ($this->_gateway instanceof EE_Offsite_Gateway) {
+			return EE_PMT_Base::offsite;
+		} else {
+			throw new EE_Error(
+				sprintf(
+					esc_html__(
+						"Payment method type '%s's gateway isn't an instance of EE_Onsite_Gateway, EE_Offsite_Gateway, or null. It must be one of those",
+						"event_espresso"
+					),
+					get_class($this)
+				)
+			);
+		}
+	}
+
+
+	/**
+	 * For adding any html output ab ove the payment overview.
+	 * Many gateways won't want ot display anything, so this function just returns an empty string.
+	 * Other gateways may want to override this, such as offline gateways.
+	 *
+	 * @param EE_Payment $payment
+	 * @return string
+	 */
+	public function payment_overview_content(EE_Payment $payment)
+	{
+		return EEH_Template::display_template(
+			EE_LIBRARIES . 'payment_methods/templates/payment_details_content.template.php',
+			array('payment_method' => $this->_pm_instance, 'payment' => $payment),
+			true
+		);
+	}
+
+
+	/**
+	 * @return array where keys are the help tab name,
+	 * values are: array {
+	 * @type string $title         i18n name for the help tab
+	 * @type string $filename      name of the file located in ./help_tabs/ (ie, in a folder next to this file)
+	 * @type array  $template_args any arguments you want passed to the template file while rendering.
+	 *                Keys will be variable names and values with be their values.
+	 */
+	public function help_tabs_config()
+	{
+		return array();
+	}
+
+
+	/**
+	 * The system name for this PMT (eg AIM, Paypal_Pro, Invoice... what gets put into
+	 * the payment method's table's PMT_type column)
+	 *
+	 * @return string
+	 */
+	public function system_name()
+	{
+		$classname = get_class($this);
+		return str_replace("EE_PMT_", '', $classname);
+	}
+
+
+	/**
+	 * A pretty i18n version of the PMT name. Often the same as the "pretty_name", but you can change it by overriding
+	 * this method.
+	 * @return string
+	 */
+	public function defaultFrontendName()
+	{
+		return $this->pretty_name();
+	}
+
+
+	/**
+	 * A pretty i18n version of the PMT name
+	 *
+	 * @return string
+	 */
+	public function pretty_name()
+	{
+		return $this->_pretty_name;
+	}
+
+
+	/**
+	 * Gets the default absolute URL to the payment method type's button
+	 *
+	 * @return string
+	 */
+	public function default_button_url()
+	{
+		return $this->_default_button_url;
+	}
+
+
+	/**
+	 * Gets the gateway used by this payment method (if any)
+	 *
+	 * @return EE_Gateway
+	 */
+	public function get_gateway()
+	{
+		return $this->_gateway;
+	}
+
+
+	/**
+	 * @return string html for the link to a help tab
+	 */
+	public function get_help_tab_link()
+	{
+		return EEH_Template::get_help_tab_link(
+			$this->get_help_tab_name(),
+			'espresso_payment_settings',
+			'default'
+		);
+	}
+
+
+	/**
+	 * Returns the name of the help tab for this PMT
+	 *
+	 * @return string
+	 */
+	public function get_help_tab_name()
+	{
+		return 'ee_' . strtolower($this->system_name()) . '_help_tab';
+	}
+
+	/**
+	 * The name of the wp capability that should be associated with the usage of
+	 * this PMT by an admin
+	 *
+	 * @return string
+	 */
+	public function cap_name()
+	{
+		return 'ee_payment_method_' . strtolower($this->system_name());
+	}
+
+	/**
+	 * Called by client code to tell the gateway that if it wants to change
+	 * the transaction or line items or registrations related to teh payment it already
+	 * processed (we think, but possibly not) that now's the time to do it.
+	 * It is expected that gateways will store any info they need for this on the PAY_details,
+	 * or maybe an extra meta value
+	 *
+	 * @param EE_Payment $payment
+	 * @return void
+	 */
+	public function update_txn_based_on_payment($payment)
+	{
+		if ($this->_gateway instanceof EE_Gateway) {
+			$this->_gateway->update_txn_based_on_payment($payment);
+		}
+	}
+
+	/**
+	 * Returns a string of HTML describing this payment method type for an admin,
+	 * primarily intended for them to read before activating it.
+	 * The easiest way to set this is to create a folder 'templates' alongside
+	 * your EE_PMT_{System_Name} file, and in it create a file named "{system_name}_intro.template.php".
+	 * Eg, if your payment method file is named "EE_PMT_Foo_Bar.pm.php",
+	 * then you'd create a file named "templates" in the same folder as it, and name the file
+	 * "foo_bar_intro.template.php", and its content will be returned by this method
+	 *
+	 * @return string
+	 */
+	public function introductory_html()
+	{
+		return EEH_Template::locate_template(
+			$this->file_folder() . 'templates/' . strtolower($this->system_name()) . '_intro.template.php',
+			array('pmt_obj' => $this, 'pm_instance' => $this->_pm_instance)
+		);
+	}
 }

core/libraries/rest_api/controllers/model/Base.php

Spacing +2 added lines, -2 removed lines

@@ -50,7 +50,7 @@ 
      */
     public function getModelVersionInfo()
     {
-        if (! $this->model_version_info) {
+        if ( ! $this->model_version_info) {
             throw new EE_Error(
                 sprintf(
                     esc_html__(
@@ -95,7 +95,7 @@ 
      */
     protected function validateModel($model_name)
     {
-        if (! $this->getModelVersionInfo()->isModelNameInThisVersion($model_name)) {
+        if ( ! $this->getModelVersionInfo()->isModelNameInThisVersion($model_name)) {
             throw new RestException(
                 'endpoint_parsing_error',
                 sprintf(

Indentation +80 added lines, -80 removed lines

@@ -18,95 +18,95 @@
  */
 class Base extends Controller_Base
 {
-    /**
-     * Holds reference to the model version info, which knows the requested version
-     *
-     * @var ModelVersionInfo
-     */
-    protected $model_version_info;
+	/**
+	 * Holds reference to the model version info, which knows the requested version
+	 *
+	 * @var ModelVersionInfo
+	 */
+	protected $model_version_info;
 
 
 
-    /**
-     * Sets the version the user requested
-     *
-     * @param string $version eg '4.8'
-     */
-    public function setRequestedVersion($version)
-    {
-        parent::setRequestedVersion($version);
-        $this->model_version_info = new ModelVersionInfo($version);
-    }
+	/**
+	 * Sets the version the user requested
+	 *
+	 * @param string $version eg '4.8'
+	 */
+	public function setRequestedVersion($version)
+	{
+		parent::setRequestedVersion($version);
+		$this->model_version_info = new ModelVersionInfo($version);
+	}
 
 
 
-    /**
-     * Gets the object that should be used for getting any info from the models,
-     * because it's takes the requested and current core version into account
-     *
-     * @return \EventEspresso\core\libraries\rest_api\ModelVersionInfo
-     * @throws EE_Error
-     */
-    public function getModelVersionInfo()
-    {
-        if (! $this->model_version_info) {
-            throw new EE_Error(
-                sprintf(
-                    esc_html__(
-                        'Cannot use model version info before setting the requested version in the controller',
-                        'event_espresso'
-                    )
-                )
-            );
-        }
-        return $this->model_version_info;
-    }
+	/**
+	 * Gets the object that should be used for getting any info from the models,
+	 * because it's takes the requested and current core version into account
+	 *
+	 * @return \EventEspresso\core\libraries\rest_api\ModelVersionInfo
+	 * @throws EE_Error
+	 */
+	public function getModelVersionInfo()
+	{
+		if (! $this->model_version_info) {
+			throw new EE_Error(
+				sprintf(
+					esc_html__(
+						'Cannot use model version info before setting the requested version in the controller',
+						'event_espresso'
+					)
+				)
+			);
+		}
+		return $this->model_version_info;
+	}
 
 
 
-    /**
-     * Determines if $object is of one of the classes of $classes. Similar to
-     * in_array(), except this checks if $object is a subclass of the classnames provided
-     * in $classnames
-     *
-     * @param object $object
-     * @param array  $classnames
-     * @return boolean
-     */
-    public function isSubclassOfOne($object, $classnames)
-    {
-        foreach ($classnames as $classname) {
-            if (is_a($object, $classname)) {
-                return true;
-            }
-        }
-        return false;
-    }
+	/**
+	 * Determines if $object is of one of the classes of $classes. Similar to
+	 * in_array(), except this checks if $object is a subclass of the classnames provided
+	 * in $classnames
+	 *
+	 * @param object $object
+	 * @param array  $classnames
+	 * @return boolean
+	 */
+	public function isSubclassOfOne($object, $classnames)
+	{
+		foreach ($classnames as $classname) {
+			if (is_a($object, $classname)) {
+				return true;
+			}
+		}
+		return false;
+	}
 
-    /**
-     * Verifies the model name provided was valid. If so, returns the model (as an object). Otherwise, throws an
-     * exception. Must be called after `setRequestedVersion()`.
-     * @since 4.9.76.p
-     * @param $model_name
-     * @return EEM_Base
-     * @throws EE_Error
-     * @throws RestException
-     */
-    protected function validateModel($model_name)
-    {
-        if (! $this->getModelVersionInfo()->isModelNameInThisVersion($model_name)) {
-            throw new RestException(
-                'endpoint_parsing_error',
-                sprintf(
-                    esc_html__(
-                        'There is no model for endpoint %s. Please contact event espresso support',
-                        'event_espresso'
-                    ),
-                    $model_name
-                )
-            );
-        }
-        return $this->getModelVersionInfo()->loadModel($model_name);
-    }
+	/**
+	 * Verifies the model name provided was valid. If so, returns the model (as an object). Otherwise, throws an
+	 * exception. Must be called after `setRequestedVersion()`.
+	 * @since 4.9.76.p
+	 * @param $model_name
+	 * @return EEM_Base
+	 * @throws EE_Error
+	 * @throws RestException
+	 */
+	protected function validateModel($model_name)
+	{
+		if (! $this->getModelVersionInfo()->isModelNameInThisVersion($model_name)) {
+			throw new RestException(
+				'endpoint_parsing_error',
+				sprintf(
+					esc_html__(
+						'There is no model for endpoint %s. Please contact event espresso support',
+						'event_espresso'
+					),
+					$model_name
+				)
+			);
+		}
+		return $this->getModelVersionInfo()->loadModel($model_name);
+	}
 }
 // End of file Base.php