eventespresso / event-espresso-core

core/db_classes/EE_Payment_Method.class.php

Indentation +639 added lines, -639 removed lines

@@ -13,649 +13,649 @@
  */
 class EE_Payment_Method extends EE_Base_Class
 {
-    /**
-     * Payment Method type object, which has all the info about this type of payment method,
-     * including functions for processing payments, to get settings forms, etc.
-     *
-     * @var EE_PMT_Base|null
-     */
-    protected ?EE_PMT_Base $_type_obj = null;
-
-
-    /**
-     * @param array $props_n_values
-     * @return EE_Payment_Method
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    public static function new_instance($props_n_values = [])
-    {
-        $has_object = parent::_check_for_object($props_n_values, __CLASS__);
-        return $has_object ?: new self($props_n_values, false);
-    }
-
-
-    /**
-     * @param array $props_n_values
-     * @return EE_Payment_Method
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    public static function new_instance_from_db($props_n_values = [])
-    {
-        return new self($props_n_values, true);
-    }
-
-
-
-    /**
-     * Checks if there is a payment method class of the given 'PMD_type', and if so returns the classname.
-     * Otherwise returns a normal EE_Payment_Method
-     *
-     * @param array $props_n_values where 'PMD_type' is a gateway name like 'Paypal_Standard','Invoice',etc (basically
-     *                              the classname minus 'EEPM_')
-     * @return string
-     */
-    // private static function _payment_method_type($props_n_values)
-    // {
-    //     EE_Registry::instance()->load_lib('Payment_Method_Manager');
-    //     $type_string = isset($props_n_values['PMD_type']) ? $props_n_values['PMD_type'] : null;
-    //     if (EE_Payment_Method_Manager::instance()->payment_method_type_exists($type_string)) {
-    //         return 'EEPM_' . $type_string;
-    //     } else {
-    //         return __CLASS__;
-    //     }
-    // }
-
-
-    /**
-     * Gets whether this payment method can be used anywhere at all (ie frontend cart, admin, etc)
-     *
-     * @return int[]|string[]
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    public function active(): array
-    {
-        return array_intersect(array_keys(EEM_Payment_Method::instance()->scopes()), $this->scope());
-    }
-
-
-    /**
-     * Sets this PM as active by making it usable within the CART scope. Offline gateways
-     * are also usable from the admin-scope as well. DOES NOT SAVE it
-     *
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    public function set_active()
-    {
-        $default_scopes = [EEM_Payment_Method::scope_cart];
-        if (
-            $this->type_obj() &&
-            $this->type_obj()->payment_occurs() === EE_PMT_Base::offline
-        ) {
-            $default_scopes[] = EEM_Payment_Method::scope_admin;
-        }
-        $this->set_scope($default_scopes);
-    }
-
-
-    /**
-     * Makes this payment method apply to NO scopes at all. DOES NOT SAVE it.
-     */
-    public function deactivate()
-    {
-        $this->set_scope([]);
-    }
-
-
-    /**
-     * Gets button_url
-     *
-     * @return string
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    public function button_url()
-    {
-        return $this->get('PMD_button_url');
-    }
-
-
-    /**
-     * Sets button_url
-     *
-     * @param string $button_url
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    public function set_button_url($button_url)
-    {
-        $this->set('PMD_button_url', $button_url);
-    }
-
-
-    /**
-     * Gets debug_mode
-     *
-     * @return boolean
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    public function debug_mode(): bool
-    {
-        return (bool) $this->get('PMD_debug_mode');
-    }
-
-
-    /**
-     * Sets debug_mode
-     *
-     * @param boolean $debug_mode
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    public function set_debug_mode($debug_mode)
-    {
-        $this->set('PMD_debug_mode', $debug_mode);
-    }
-
-
-    /**
-     * Gets description
-     *
-     * @return string
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    public function description()
-    {
-        return $this->get('PMD_desc');
-    }
-
-
-    /**
-     * Sets description
-     *
-     * @param string $description
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    public function set_description($description)
-    {
-        $this->set('PMD_desc', $description);
-    }
-
-
-    /**
-     * Gets name
-     *
-     * @return string
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    public function name()
-    {
-        return $this->get('PMD_name');
-    }
-
-
-    /**
-     * Sets name
-     *
-     * @param string $name
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    public function set_name($name)
-    {
-        $this->set('PMD_name', $name);
-    }
-
-
-    /**
-     * Gets open_by_default
-     *
-     * @return boolean
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    public function open_by_default()
-    {
-        return $this->get('PMD_open_by_default');
-    }
-
-
-    /**
-     * Sets open_by_default
-     *
-     * @param boolean $open_by_default
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    public function set_open_by_default($open_by_default)
-    {
-        $this->set('PMD_open_by_default', $open_by_default);
-    }
-
-
-    /**
-     * Gets order
-     *
-     * @return int
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    public function order()
-    {
-        return $this->get('PMD_order');
-    }
-
-
-    /**
-     * Sets order
-     *
-     * @param int $order
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    public function set_order($order)
-    {
-        $this->set('PMD_order', $order);
-    }
-
-
-    /**
-     * Gets slug
-     *
-     * @return string
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    public function slug()
-    {
-        return $this->get('PMD_slug');
-    }
-
-
-    /**
-     * Sets slug
-     *
-     * @param string $slug
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    public function set_slug($slug)
-    {
-        $this->set('PMD_slug', $slug);
-    }
-
-
-    /**
-     * Gets type
-     *
-     * @return string
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    public function type()
-    {
-        return $this->get('PMD_type');
-    }
-
-
-    /**
-     * Sets type
-     *
-     * @param string $type
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    public function set_type($type)
-    {
-        $this->set('PMD_type', $type);
-    }
-
-
-    /**
-     * Gets wp_user
-     *
-     * @return int
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    public function wp_user()
-    {
-        return $this->get('PMD_wp_user');
-    }
-
-
-    /**
-     * Sets wp_user
-     *
-     * @param int $wp_user_id
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    public function set_wp_user($wp_user_id)
-    {
-        $this->set('PMD_wp_user', $wp_user_id);
-    }
-
-
-    /**
-     * Overrides parent so when PMD_type is changed we refresh the _type_obj
-     *
-     * @param string  $field_name
-     * @param mixed   $field_value
-     * @param boolean $use_default
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    public function set($field_name, $field_value, $use_default = false)
-    {
-        if ($field_name === 'PMD_type') {
-            // the type has probably changed, so forget about its old type object
-            $this->_type_obj = null;
-        }
-        parent::set($field_name, $field_value, $use_default);
-    }
-
-
-    /**
-     * Gets admin_name
-     *
-     * @return string
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    public function admin_name()
-    {
-        return $this->get('PMD_admin_name');
-    }
-
-
-    /**
-     * Sets admin_name
-     *
-     * @param string $admin_name
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    public function set_admin_name($admin_name)
-    {
-        $this->set('PMD_admin_name', $admin_name);
-    }
-
-
-    /**
-     * Gets admin_desc
-     *
-     * @return string
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    public function admin_desc()
-    {
-        return $this->get('PMD_admin_desc');
-    }
-
-
-    /**
-     * Sets admin_desc
-     *
-     * @param string $admin_desc
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    public function set_admin_desc($admin_desc)
-    {
-        $this->set('PMD_admin_desc', $admin_desc);
-    }
-
-
-    /**
-     * Gets scope
-     *
-     * @return array
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    public function scope()
-    {
-        return (array) $this->get('PMD_scope');
-    }
-
-
-    /**
-     * Sets scope
-     *
-     * @param array $scope
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    public function set_scope($scope)
-    {
-        $this->set('PMD_scope', (array) $scope);
-    }
-
-
-    /**
-     * Gets the payment method type for this payment method instance
-     *
-     * @return EE_PMT_Base
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    public function type_obj()
-    {
-        if (! $this->_type_obj) {
-            EE_Registry::instance()->load_lib('Payment_Method_Manager');
-            if (EE_Payment_Method_Manager::instance()->payment_method_type_exists($this->type())) {
-                $class_name = EE_Payment_Method_Manager::instance()->payment_method_class_from_type($this->type());
-                if (! class_exists($class_name)) {
-                    throw new EE_Error(
-                        sprintf(
-                            esc_html__(
-                                'An attempt to use the "%1$s" payment method failed, so it was deactivated.%2$sWas the "%1$s" Plugin recently deactivated? It can be reactivated on the %3$sPlugins Admin Page%4$s',
-                                'event_espresso'
-                            ),
-                            $class_name,
-                            '<br />',
-                            '<a href="' . admin_url('plugins.php') . '">',
-                            '</a>'
-                        )
-                    );
-                }
-                $r               = new ReflectionClass($class_name);
-                $this->_type_obj = $r->newInstanceArgs([$this]);
-            } else {
-                throw new EE_Error(
-                    sprintf(
-                        esc_html__(
-                            'A payment method of type "%1$s" does not exist. Only ones existing are: %2$s',
-                            'event_espresso'
-                        ),
-                        $this->type(),
-                        implode(',', EE_Payment_Method_Manager::instance()->payment_method_type_names())
-                    )
-                );
-            }
-        }
-        return $this->_type_obj;
-    }
-
-
-    /**
-     * Returns a simple array of key-value pairs combining the payment method's fields (without the 'PMD_' prefix)
-     * and the extra meta. Mostly used for passing off ot gateways.     *
-     *
-     * @return array
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    public function settings_array()
-    {
-        $fields     = $this->model_field_array();
-        $extra_meta = $this->all_extra_meta_array();
-        // remove the model's prefix from the fields
-        $combined_settings_array = [];
-        foreach ($fields as $key => $value) {
-            if (strpos($key, 'PMD_') === 0) {
-                $key_sans_model_prefix                              = str_replace('PMD_', '', $key);
-                $combined_settings_array [ $key_sans_model_prefix ] = $value;
-            }
-        }
-        $combined_settings_array = array_merge($extra_meta, $combined_settings_array);
-        return $combined_settings_array;
-    }
-
-
-    /**
-     * Gets the HTML for displaying the payment method on a page.
-     *
-     * @param string $url
-     * @param string $css_class
-     * @return string of HTML for displaying the button
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    public function button_html($url = '', $css_class = '')
-    {
-        $payment_occurs = $this->type_obj()->payment_occurs();
-        return '
+	/**
+	 * Payment Method type object, which has all the info about this type of payment method,
+	 * including functions for processing payments, to get settings forms, etc.
+	 *
+	 * @var EE_PMT_Base|null
+	 */
+	protected ?EE_PMT_Base $_type_obj = null;
+
+
+	/**
+	 * @param array $props_n_values
+	 * @return EE_Payment_Method
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	public static function new_instance($props_n_values = [])
+	{
+		$has_object = parent::_check_for_object($props_n_values, __CLASS__);
+		return $has_object ?: new self($props_n_values, false);
+	}
+
+
+	/**
+	 * @param array $props_n_values
+	 * @return EE_Payment_Method
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	public static function new_instance_from_db($props_n_values = [])
+	{
+		return new self($props_n_values, true);
+	}
+
+
+
+	/**
+	 * Checks if there is a payment method class of the given 'PMD_type', and if so returns the classname.
+	 * Otherwise returns a normal EE_Payment_Method
+	 *
+	 * @param array $props_n_values where 'PMD_type' is a gateway name like 'Paypal_Standard','Invoice',etc (basically
+	 *                              the classname minus 'EEPM_')
+	 * @return string
+	 */
+	// private static function _payment_method_type($props_n_values)
+	// {
+	//     EE_Registry::instance()->load_lib('Payment_Method_Manager');
+	//     $type_string = isset($props_n_values['PMD_type']) ? $props_n_values['PMD_type'] : null;
+	//     if (EE_Payment_Method_Manager::instance()->payment_method_type_exists($type_string)) {
+	//         return 'EEPM_' . $type_string;
+	//     } else {
+	//         return __CLASS__;
+	//     }
+	// }
+
+
+	/**
+	 * Gets whether this payment method can be used anywhere at all (ie frontend cart, admin, etc)
+	 *
+	 * @return int[]|string[]
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	public function active(): array
+	{
+		return array_intersect(array_keys(EEM_Payment_Method::instance()->scopes()), $this->scope());
+	}
+
+
+	/**
+	 * Sets this PM as active by making it usable within the CART scope. Offline gateways
+	 * are also usable from the admin-scope as well. DOES NOT SAVE it
+	 *
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	public function set_active()
+	{
+		$default_scopes = [EEM_Payment_Method::scope_cart];
+		if (
+			$this->type_obj() &&
+			$this->type_obj()->payment_occurs() === EE_PMT_Base::offline
+		) {
+			$default_scopes[] = EEM_Payment_Method::scope_admin;
+		}
+		$this->set_scope($default_scopes);
+	}
+
+
+	/**
+	 * Makes this payment method apply to NO scopes at all. DOES NOT SAVE it.
+	 */
+	public function deactivate()
+	{
+		$this->set_scope([]);
+	}
+
+
+	/**
+	 * Gets button_url
+	 *
+	 * @return string
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	public function button_url()
+	{
+		return $this->get('PMD_button_url');
+	}
+
+
+	/**
+	 * Sets button_url
+	 *
+	 * @param string $button_url
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	public function set_button_url($button_url)
+	{
+		$this->set('PMD_button_url', $button_url);
+	}
+
+
+	/**
+	 * Gets debug_mode
+	 *
+	 * @return boolean
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	public function debug_mode(): bool
+	{
+		return (bool) $this->get('PMD_debug_mode');
+	}
+
+
+	/**
+	 * Sets debug_mode
+	 *
+	 * @param boolean $debug_mode
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	public function set_debug_mode($debug_mode)
+	{
+		$this->set('PMD_debug_mode', $debug_mode);
+	}
+
+
+	/**
+	 * Gets description
+	 *
+	 * @return string
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	public function description()
+	{
+		return $this->get('PMD_desc');
+	}
+
+
+	/**
+	 * Sets description
+	 *
+	 * @param string $description
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	public function set_description($description)
+	{
+		$this->set('PMD_desc', $description);
+	}
+
+
+	/**
+	 * Gets name
+	 *
+	 * @return string
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	public function name()
+	{
+		return $this->get('PMD_name');
+	}
+
+
+	/**
+	 * Sets name
+	 *
+	 * @param string $name
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	public function set_name($name)
+	{
+		$this->set('PMD_name', $name);
+	}
+
+
+	/**
+	 * Gets open_by_default
+	 *
+	 * @return boolean
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	public function open_by_default()
+	{
+		return $this->get('PMD_open_by_default');
+	}
+
+
+	/**
+	 * Sets open_by_default
+	 *
+	 * @param boolean $open_by_default
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	public function set_open_by_default($open_by_default)
+	{
+		$this->set('PMD_open_by_default', $open_by_default);
+	}
+
+
+	/**
+	 * Gets order
+	 *
+	 * @return int
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	public function order()
+	{
+		return $this->get('PMD_order');
+	}
+
+
+	/**
+	 * Sets order
+	 *
+	 * @param int $order
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	public function set_order($order)
+	{
+		$this->set('PMD_order', $order);
+	}
+
+
+	/**
+	 * Gets slug
+	 *
+	 * @return string
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	public function slug()
+	{
+		return $this->get('PMD_slug');
+	}
+
+
+	/**
+	 * Sets slug
+	 *
+	 * @param string $slug
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	public function set_slug($slug)
+	{
+		$this->set('PMD_slug', $slug);
+	}
+
+
+	/**
+	 * Gets type
+	 *
+	 * @return string
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	public function type()
+	{
+		return $this->get('PMD_type');
+	}
+
+
+	/**
+	 * Sets type
+	 *
+	 * @param string $type
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	public function set_type($type)
+	{
+		$this->set('PMD_type', $type);
+	}
+
+
+	/**
+	 * Gets wp_user
+	 *
+	 * @return int
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	public function wp_user()
+	{
+		return $this->get('PMD_wp_user');
+	}
+
+
+	/**
+	 * Sets wp_user
+	 *
+	 * @param int $wp_user_id
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	public function set_wp_user($wp_user_id)
+	{
+		$this->set('PMD_wp_user', $wp_user_id);
+	}
+
+
+	/**
+	 * Overrides parent so when PMD_type is changed we refresh the _type_obj
+	 *
+	 * @param string  $field_name
+	 * @param mixed   $field_value
+	 * @param boolean $use_default
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	public function set($field_name, $field_value, $use_default = false)
+	{
+		if ($field_name === 'PMD_type') {
+			// the type has probably changed, so forget about its old type object
+			$this->_type_obj = null;
+		}
+		parent::set($field_name, $field_value, $use_default);
+	}
+
+
+	/**
+	 * Gets admin_name
+	 *
+	 * @return string
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	public function admin_name()
+	{
+		return $this->get('PMD_admin_name');
+	}
+
+
+	/**
+	 * Sets admin_name
+	 *
+	 * @param string $admin_name
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	public function set_admin_name($admin_name)
+	{
+		$this->set('PMD_admin_name', $admin_name);
+	}
+
+
+	/**
+	 * Gets admin_desc
+	 *
+	 * @return string
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	public function admin_desc()
+	{
+		return $this->get('PMD_admin_desc');
+	}
+
+
+	/**
+	 * Sets admin_desc
+	 *
+	 * @param string $admin_desc
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	public function set_admin_desc($admin_desc)
+	{
+		$this->set('PMD_admin_desc', $admin_desc);
+	}
+
+
+	/**
+	 * Gets scope
+	 *
+	 * @return array
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	public function scope()
+	{
+		return (array) $this->get('PMD_scope');
+	}
+
+
+	/**
+	 * Sets scope
+	 *
+	 * @param array $scope
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	public function set_scope($scope)
+	{
+		$this->set('PMD_scope', (array) $scope);
+	}
+
+
+	/**
+	 * Gets the payment method type for this payment method instance
+	 *
+	 * @return EE_PMT_Base
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	public function type_obj()
+	{
+		if (! $this->_type_obj) {
+			EE_Registry::instance()->load_lib('Payment_Method_Manager');
+			if (EE_Payment_Method_Manager::instance()->payment_method_type_exists($this->type())) {
+				$class_name = EE_Payment_Method_Manager::instance()->payment_method_class_from_type($this->type());
+				if (! class_exists($class_name)) {
+					throw new EE_Error(
+						sprintf(
+							esc_html__(
+								'An attempt to use the "%1$s" payment method failed, so it was deactivated.%2$sWas the "%1$s" Plugin recently deactivated? It can be reactivated on the %3$sPlugins Admin Page%4$s',
+								'event_espresso'
+							),
+							$class_name,
+							'<br />',
+							'<a href="' . admin_url('plugins.php') . '">',
+							'</a>'
+						)
+					);
+				}
+				$r               = new ReflectionClass($class_name);
+				$this->_type_obj = $r->newInstanceArgs([$this]);
+			} else {
+				throw new EE_Error(
+					sprintf(
+						esc_html__(
+							'A payment method of type "%1$s" does not exist. Only ones existing are: %2$s',
+							'event_espresso'
+						),
+						$this->type(),
+						implode(',', EE_Payment_Method_Manager::instance()->payment_method_type_names())
+					)
+				);
+			}
+		}
+		return $this->_type_obj;
+	}
+
+
+	/**
+	 * Returns a simple array of key-value pairs combining the payment method's fields (without the 'PMD_' prefix)
+	 * and the extra meta. Mostly used for passing off ot gateways.     *
+	 *
+	 * @return array
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	public function settings_array()
+	{
+		$fields     = $this->model_field_array();
+		$extra_meta = $this->all_extra_meta_array();
+		// remove the model's prefix from the fields
+		$combined_settings_array = [];
+		foreach ($fields as $key => $value) {
+			if (strpos($key, 'PMD_') === 0) {
+				$key_sans_model_prefix                              = str_replace('PMD_', '', $key);
+				$combined_settings_array [ $key_sans_model_prefix ] = $value;
+			}
+		}
+		$combined_settings_array = array_merge($extra_meta, $combined_settings_array);
+		return $combined_settings_array;
+	}
+
+
+	/**
+	 * Gets the HTML for displaying the payment method on a page.
+	 *
+	 * @param string $url
+	 * @param string $css_class
+	 * @return string of HTML for displaying the button
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	public function button_html($url = '', $css_class = '')
+	{
+		$payment_occurs = $this->type_obj()->payment_occurs();
+		return '
 		 <div id="'
-               . $this->slug()
-               . '-payment-option-dv" class="'
-               . $payment_occurs . '-payment-gateway reg-page-payment-option-dv' . $css_class . '">
+			   . $this->slug()
+			   . '-payment-option-dv" class="'
+			   . $payment_occurs . '-payment-gateway reg-page-payment-option-dv' . $css_class . '">
 			<a id="payment-gateway-button-' . $this->slug()
-               . '" class="reg-page-payment-option-lnk" rel="'
-               . $this->slug() . '" href="' . $url . '" >
+			   . '" class="reg-page-payment-option-lnk" rel="'
+			   . $this->slug() . '" href="' . $url . '" >
 				<img src="' . $this->button_url() . '" alt="' . sprintf(
-                   esc_attr__('Pay using %s', 'event_espresso'),
-                   $this->get_pretty('PMD_name', 'form_input')
-               ) . '" />
+				   esc_attr__('Pay using %s', 'event_espresso'),
+				   $this->get_pretty('PMD_name', 'form_input')
+			   ) . '" />
 			</a>
 		</div>
 ';
-    }
-
-
-    /**
-     * Gets all the currencies which are an option for this payment method
-     * (as defined by the gateway and the currently active currencies)
-     *
-     * @return EE_Currency[]
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    public function get_all_usable_currencies()
-    {
-        return EEM_Currency::instance()->get_all_currencies_usable_by($this->type_obj());
-    }
-
-
-    /**
-     * Reports whether or not this payment method can be used for this payment method
-     *
-     * @param string $currency_code currency ID (code)
-     * @return boolean
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    public function usable_for_currency($currency_code)
-    {
-        foreach ($this->get_all_usable_currencies() as $currency_obj) {
-            if ($currency_obj->ID() === $currency_code) {
-                return true;
-            }
-        }
-        return false;
-    }
-
-
-    /**
-     * Returns TRUE if this payment method's gateway is an instance of EE_Onsite_Gateway
-     *
-     * @return bool
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    public function is_on_site()
-    {
-        return $this->type_obj()->payment_occurs() === EE_PMT_Base::onsite;
-    }
-
-
-    /**
-     * Returns TRUE if this payment method's gateway is an instance of EE_Offsite_Gateway
-     *
-     * @return bool
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    public function is_off_site()
-    {
-        return $this->type_obj()->payment_occurs() === EE_PMT_Base::offsite;
-    }
-
-
-    /**
-     * Returns TRUE if this payment method does not utilize a gateway
-     *
-     * @return bool
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    public function is_off_line()
-    {
-        return $this->type_obj()->payment_occurs() === EE_PMT_Base::offline;
-    }
-
-
-    /**
-     * Overrides default __sleep so the object type is NOT cached.
-     * This way we can rely on the normal EE_Payment_Method::type_obj() logic
-     * to load the required classes, and don't need them at the time of unserialization
-     *
-     * @return array
-     */
-    public function __sleep()
-    {
-        $properties = get_object_vars($this);
-        unset($properties['_type_obj']);
-        return array_keys($properties);
-    }
-
-
-    /**
-     * Overrides parent to add some logging for when payment methods get deactivated
-     *
-     * @param array $set_cols_n_values
-     * @return bool|int|string @see EE_Base_Class::save()
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    public function save($set_cols_n_values = [])
-    {
-        $results = parent::save($set_cols_n_values);
-        if ($this->get_original('PMD_scope') !== $this->get('PMD_scope')) {
-            /** @var CurrentPage $current_page */
-            $current_page = LoaderFactory::getLoader()->getShared(CurrentPage::class);
-            EE_Log::instance()->log(
-                __FILE__,
-                __FUNCTION__,
-                sprintf(
-                    esc_html__('Set new scope on payment method %1$s to %2$s from %3$s on URL %4$s', 'event_espresso'),
-                    $this->name(),
-                    serialize($this->get_original('PMD_scope')),
-                    serialize($this->get('PMD_scope')),
-                    $current_page->getPermalink()
-                ),
-                'payment_method_change'
-            );
-        }
-        return $results;
-    }
+	}
+
+
+	/**
+	 * Gets all the currencies which are an option for this payment method
+	 * (as defined by the gateway and the currently active currencies)
+	 *
+	 * @return EE_Currency[]
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	public function get_all_usable_currencies()
+	{
+		return EEM_Currency::instance()->get_all_currencies_usable_by($this->type_obj());
+	}
+
+
+	/**
+	 * Reports whether or not this payment method can be used for this payment method
+	 *
+	 * @param string $currency_code currency ID (code)
+	 * @return boolean
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	public function usable_for_currency($currency_code)
+	{
+		foreach ($this->get_all_usable_currencies() as $currency_obj) {
+			if ($currency_obj->ID() === $currency_code) {
+				return true;
+			}
+		}
+		return false;
+	}
+
+
+	/**
+	 * Returns TRUE if this payment method's gateway is an instance of EE_Onsite_Gateway
+	 *
+	 * @return bool
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	public function is_on_site()
+	{
+		return $this->type_obj()->payment_occurs() === EE_PMT_Base::onsite;
+	}
+
+
+	/**
+	 * Returns TRUE if this payment method's gateway is an instance of EE_Offsite_Gateway
+	 *
+	 * @return bool
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	public function is_off_site()
+	{
+		return $this->type_obj()->payment_occurs() === EE_PMT_Base::offsite;
+	}
+
+
+	/**
+	 * Returns TRUE if this payment method does not utilize a gateway
+	 *
+	 * @return bool
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	public function is_off_line()
+	{
+		return $this->type_obj()->payment_occurs() === EE_PMT_Base::offline;
+	}
+
+
+	/**
+	 * Overrides default __sleep so the object type is NOT cached.
+	 * This way we can rely on the normal EE_Payment_Method::type_obj() logic
+	 * to load the required classes, and don't need them at the time of unserialization
+	 *
+	 * @return array
+	 */
+	public function __sleep()
+	{
+		$properties = get_object_vars($this);
+		unset($properties['_type_obj']);
+		return array_keys($properties);
+	}
+
+
+	/**
+	 * Overrides parent to add some logging for when payment methods get deactivated
+	 *
+	 * @param array $set_cols_n_values
+	 * @return bool|int|string @see EE_Base_Class::save()
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	public function save($set_cols_n_values = [])
+	{
+		$results = parent::save($set_cols_n_values);
+		if ($this->get_original('PMD_scope') !== $this->get('PMD_scope')) {
+			/** @var CurrentPage $current_page */
+			$current_page = LoaderFactory::getLoader()->getShared(CurrentPage::class);
+			EE_Log::instance()->log(
+				__FILE__,
+				__FUNCTION__,
+				sprintf(
+					esc_html__('Set new scope on payment method %1$s to %2$s from %3$s on URL %4$s', 'event_espresso'),
+					$this->name(),
+					serialize($this->get_original('PMD_scope')),
+					serialize($this->get('PMD_scope')),
+					$current_page->getPermalink()
+				),
+				'payment_method_change'
+			);
+		}
+		return $results;
+	}
 }

core/domain/entities/admin/menu/AdminMenuTopLevel.php

Indentation +124 added lines, -124 removed lines

@@ -4,128 +4,128 @@
 
 class AdminMenuTopLevel extends AdminMenuItem
 {
-    public const MENU_PARENT_ACTIVE      = 'espresso_events';
-
-    public const MENU_PARENT_MAINTENANCE = 'espresso_maintenance_settings';
-
-
-    /**
-     * The page to an icon used for this menu.
-     *
-     * @since  4.4.0
-     * @see    http://codex.wordpress.org/Function_Reference/add_menu_page#Parameters
-     *        for what can be set for this property.
-     * @var string
-     */
-    protected string $icon_url = '';
-
-    /**
-     * What position in the main menu order for the WP admin menu this menu item
-     * should show.
-     *
-     * @since  4.4.0
-     * @see    http://codex.wordpress.org/Function_Reference/add_menu_page#Parameters
-     *        for what can be set for this property.
-     * @var integer
-     */
-    protected int $position = 0;
-
-    /**
-     * If included int incoming params, then this class will also register a Sub Menu Admin page with a different
-     * subtitle than the main menu item.
-     *
-     * @since 4.4.0
-     * @var string
-     */
-    protected string $subtitle = '';
-
-
-    public function __construct(array $menu_args)
-    {
-        $this->setIconUrl($menu_args['icon_url'] ?? '');
-        $this->setPosition($menu_args['position'] ?? 0);
-        $this->setSubtitle($menu_args['subtitle'] ?? '');
-        unset($menu_args['icon_url'], $menu_args['position'], $menu_args['subtitle']);
-        parent::__construct(
-            $menu_args,
-            // required args
-            [
-                'menu_label',
-                'menu_slug',
-                'menu_group',
-                'menu_order',
-            ]
-        );
-    }
-
-
-    /**
-     * Uses the proper WP utility for registering a menu page for the main WP pages.
-     */
-    protected function registerMenuItem(): string
-    {
-        return add_menu_page(
-            $this->title(),
-            $this->menuLabel(),
-            $this->capability(),
-            $this->parentSlug(),
-            $this->menuCallback(),
-            $this->iconUrl(),
-            $this->position()
-        );
-    }
-
-
-    /**
-     * @return string
-     */
-    public function iconUrl(): string
-    {
-        return $this->icon_url;
-    }
-
-
-    /**
-     * @param string $icon_url
-     */
-    public function setIconUrl(string $icon_url): void
-    {
-        $this->icon_url = $icon_url;
-    }
-
-
-    /**
-     * @return int
-     */
-    public function position(): int
-    {
-        return $this->position;
-    }
-
-
-    /**
-     * @param int $position
-     */
-    public function setPosition(int $position): void
-    {
-        $this->position = absint($position);
-    }
-
-
-    /**
-     * @return string
-     */
-    public function subtitle(): string
-    {
-        return $this->subtitle;
-    }
-
-
-    /**
-     * @param string $subtitle
-     */
-    public function setSubtitle(string $subtitle): void
-    {
-        $this->subtitle = $subtitle;
-    }
+	public const MENU_PARENT_ACTIVE      = 'espresso_events';
+
+	public const MENU_PARENT_MAINTENANCE = 'espresso_maintenance_settings';
+
+
+	/**
+	 * The page to an icon used for this menu.
+	 *
+	 * @since  4.4.0
+	 * @see    http://codex.wordpress.org/Function_Reference/add_menu_page#Parameters
+	 *        for what can be set for this property.
+	 * @var string
+	 */
+	protected string $icon_url = '';
+
+	/**
+	 * What position in the main menu order for the WP admin menu this menu item
+	 * should show.
+	 *
+	 * @since  4.4.0
+	 * @see    http://codex.wordpress.org/Function_Reference/add_menu_page#Parameters
+	 *        for what can be set for this property.
+	 * @var integer
+	 */
+	protected int $position = 0;
+
+	/**
+	 * If included int incoming params, then this class will also register a Sub Menu Admin page with a different
+	 * subtitle than the main menu item.
+	 *
+	 * @since 4.4.0
+	 * @var string
+	 */
+	protected string $subtitle = '';
+
+
+	public function __construct(array $menu_args)
+	{
+		$this->setIconUrl($menu_args['icon_url'] ?? '');
+		$this->setPosition($menu_args['position'] ?? 0);
+		$this->setSubtitle($menu_args['subtitle'] ?? '');
+		unset($menu_args['icon_url'], $menu_args['position'], $menu_args['subtitle']);
+		parent::__construct(
+			$menu_args,
+			// required args
+			[
+				'menu_label',
+				'menu_slug',
+				'menu_group',
+				'menu_order',
+			]
+		);
+	}
+
+
+	/**
+	 * Uses the proper WP utility for registering a menu page for the main WP pages.
+	 */
+	protected function registerMenuItem(): string
+	{
+		return add_menu_page(
+			$this->title(),
+			$this->menuLabel(),
+			$this->capability(),
+			$this->parentSlug(),
+			$this->menuCallback(),
+			$this->iconUrl(),
+			$this->position()
+		);
+	}
+
+
+	/**
+	 * @return string
+	 */
+	public function iconUrl(): string
+	{
+		return $this->icon_url;
+	}
+
+
+	/**
+	 * @param string $icon_url
+	 */
+	public function setIconUrl(string $icon_url): void
+	{
+		$this->icon_url = $icon_url;
+	}
+
+
+	/**
+	 * @return int
+	 */
+	public function position(): int
+	{
+		return $this->position;
+	}
+
+
+	/**
+	 * @param int $position
+	 */
+	public function setPosition(int $position): void
+	{
+		$this->position = absint($position);
+	}
+
+
+	/**
+	 * @return string
+	 */
+	public function subtitle(): string
+	{
+		return $this->subtitle;
+	}
+
+
+	/**
+	 * @param string $subtitle
+	 */
+	public function setSubtitle(string $subtitle): void
+	{
+		$this->subtitle = $subtitle;
+	}
 }

core/domain/entities/admin/menu/AdminMenuItem.php

Indentation +513 added lines, -513 removed lines

@@ -11,517 +11,517 @@
 
 abstract class AdminMenuItem
 {
-    public const DISPLAY_NONE             = 0;
-
-    public const DISPLAY_BLOG_ONLY        = 1;
-
-    public const DISPLAY_BLOG_AND_NETWORK = 2;
-
-    public const DISPLAY_NETWORK_ONLY     = 3;
-
-    public const TYPE_MENU_TOP            = 'top';
-
-    public const TYPE_MENU_GROUP          = 'group';
-
-    public const TYPE_MENU_SUB_ITEM       = 'sub-item';
-
-
-    /**
-     * What capability is required to access this page.
-     *
-     * @since 4.4.0
-     * @var string
-     */
-    protected string $capability = 'administrator';
-
-    /**
-     * set to TRUE if site is currently in maintenance mode level 2
-     *
-     * @var bool
-     */
-    protected bool $maintenance_mode = false;
-
-    /**
-     * Menu maps can define a parent slug that gets used instead of the main parent slug for the menu when
-     * EE_Maintenance_Mode::STATUS_FULL_SITE is active.
-     *
-     * @var string
-     */
-    public string $maintenance_mode_parent = '';
-
-    /**
-     * The callback for displaying the page that the menu references.
-     *
-     * @since 4.4.0
-     * @var callable|string|null
-     */
-    protected $menu_callback;
-
-    /**
-     * The EE specific group this menu item belongs in (group slug).
-     *
-     * @since 4.4.0
-     * @var string
-     */
-    protected string $menu_group;
-
-    /**
-     * The label for the menu item. (What shows up in the actual menu).
-     *
-     * @since 4.4.0
-     * @var string
-     */
-    protected string $menu_label;
-
-    /**
-     * What order this item should be in the menu.
-     *
-     * @since 4.4.0
-     * @var int
-     */
-    protected int $menu_order;
-
-    /**
-     * What slug should be used to reference this menu item.
-     *
-     * @since 4.4.0
-     * @var string
-     */
-    protected string $menu_slug;
-
-    /**
-     * What menu item is the parent of this menu item.
-     *
-     * @since 4.4.0
-     * @var string
-     */
-    protected string $parent_slug;
-
-    /**
-     * set to TRUE once menu item has been added to generated menu
-     *
-     * @var bool
-     */
-    protected bool $registered = false;
-
-    /**
-     * Whether this item is displayed in the menu or not.
-     * Sometimes an EE Admin Page needs to register itself but is not accessible via the WordPress
-     * admin menu.
-     *
-     * @since 4.4.0
-     * @var int
-     */
-    protected int $show_on_menu = self::DISPLAY_BLOG_ONLY;
-
-    /**
-     * The title for the menu page. (the page the menu links to)
-     *
-     * @since  4.4.0
-     * @var string
-     */
-    protected string $title;
-
-
-    /**
-     * @param array $menu_args            An array of arguments used to setup the menu properties on construct.
-     * @param array $required             An array of keys that should be in the $menu_args,
-     *                                    this is used to validate that the items that should be defined are present.
-     * @return void
-     * @throws DomainException
-     * @throws InvalidArgumentException
-     * @throws OutOfBoundsException
-     */
-    public function __construct(array $menu_args, array $required)
-    {
-        // we don't want this coupling anymore >:(
-        unset($menu_args['admin_init_page'], $required['admin_init_page']);
-        $this->maintenance_mode = MaintenanceStatus::isFullSite();
-
-        // filter all args before processing so plugins can manipulate various settings for menus.
-        $menu_args = apply_filters(
-            'FHEE__EE_Admin_Page_Menu_Map__construct__menu_args',
-            $menu_args,
-            $required,
-            get_class($this)
-        );
-
-        $this->verifyRequired($menu_args, $required);
-        $this->setProperties($menu_args);
-    }
-
-
-    /**
-     * This method should define how the menu page gets added for this particular item
-     * and go ahead and define it.  Note that child classes MUST also return the result of
-     * the function used to register the WordPress admin page (the wp_page_slug string)
-     *
-     * @return string wp_page_slug.
-     * @since  4.4.0
-     */
-    abstract protected function registerMenuItem(): string;
-
-
-    /**
-     * Called by client code to use this menu map for registering a WordPress admin page
-     *
-     * @param boolean $network_admin whether this is being added to the network admin page or not
-     * @since  4.4.0
-     */
-    public function registerAdminMenuItem(bool $network_admin = false): string
-    {
-        $this->registered = true;
-        return $this->displayOnBlogAndNetworkAdmin()
-               || $this->displayOnBlogAdmin($network_admin)
-               || $this->displayOnNetworkAdmin($network_admin)
-            ? $this->registerMenuItem()
-            : '';
-    }
-
-
-    /**
-     * @param array $menu_args
-     * @param array $required
-     * @throws DomainException
-     */
-    private function verifyRequired(array $menu_args, array $required)
-    {
-        // verify that required keys are present in the incoming array.
-        $missing = array_diff($required, array_keys($menu_args));
-
-        if (! empty($missing)) {
-            throw new DomainException(
-                sprintf(
-                    esc_html__(
-                        '%1$s is missing some expected keys in the argument array.  The following keys are missing: %2$s',
-                        'event_espresso'
-                    ),
-                    get_class($this),
-                    implode(', ', $missing)
-                )
-            );
-        }
-
-        if (
-            in_array('admin_init_page', $required, true)
-            && ! (isset($menu_args['admin_init_page']) && $menu_args['admin_init_page'] instanceof EE_Admin_Page_Init)
-        ) {
-            throw new InvalidArgumentException(
-                sprintf(
-                    esc_html__(
-                        'The value for the "admin_init_page" argument must be an instance of an EE_Admin_Page_Init object.  Instead %s was given as the value.',
-                        'event_espresso'
-                    ),
-                    print_r($menu_args['admin_init_page'] ?? null, true)
-                )
-            );
-        }
-    }
-
-
-    /**
-     * @param array $menu_args
-     * @throws InvalidArgumentException
-     * @throws OutOfBoundsException
-     */
-    private function setProperties(array $menu_args)
-    {
-        $menu_args += [
-            'capability'              => 'ee_read_ee',
-            'maintenance_mode_parent' => '',
-            'menu_callback'           => null,
-            'menu_group'              => '',
-            'menu_label'              => '',
-            'menu_order'              => 100,
-            'menu_slug'               => '',
-            'parent_slug'             => AdminMenuTopLevel::MENU_PARENT_ACTIVE,
-            'show_on_menu'            => AdminMenuItem::DISPLAY_NONE,
-            'title'                   => '',
-        ];
-
-        $this->setMenuSlug($menu_args['menu_slug']);
-        $this->setCapability($menu_args['capability']);
-        $this->setMaintenanceModeParent($menu_args['maintenance_mode_parent']);
-        $this->setMenuCallback($menu_args['menu_callback']);
-        $this->setMenuGroup($menu_args['menu_group']);
-        $this->setMenuLabel($menu_args['menu_label']);
-        $this->setMenuOrder($menu_args['menu_order']);
-        $this->setParentSlug($menu_args['parent_slug']);
-        $this->setShowOnMenu($menu_args['show_on_menu']);
-        $this->setTitle($menu_args['title']);
-    }
-
-
-    /**
-     * The capability required for this menu to be displayed to the user.
-     *
-     * @return string
-     */
-    public function capability(): string
-    {
-        return $this->capability;
-    }
-
-
-    /**
-     * @param string $capability
-     */
-    public function setCapability(string $capability): void
-    {
-        $this->capability = $capability;
-        // filter capabilities (both static and dynamic)
-        $this->capability = apply_filters('FHEE_management_capability', $this->capability, null);
-        $this->capability = apply_filters('FHEE_' . $this->menu_slug . '_capability', $this->capability, null);
-    }
-
-
-    public function currentUserHasAccess(): bool
-    {
-        return EE_Capabilities::instance()->current_user_can($this->capability(), $this->menuSlug());
-    }
-
-
-    /**
-     * @param bool $network_admin
-     * @return bool
-     */
-    public function displayOnBlogAdmin(bool $network_admin): bool
-    {
-        return ! $network_admin && $this->show_on_menu === AdminMenuItem::DISPLAY_BLOG_ONLY;
-    }
-
-
-    /**
-     * @return bool
-     */
-    public function displayOnBlogAndNetworkAdmin(): bool
-    {
-        return $this->show_on_menu === AdminMenuItem::DISPLAY_BLOG_AND_NETWORK;
-    }
-
-
-    /**
-     * @param bool $network_admin
-     * @return bool
-     */
-    public function displayOnNetworkAdmin(bool $network_admin): bool
-    {
-        return $network_admin && $this->show_on_menu === AdminMenuItem::DISPLAY_NETWORK_ONLY;
-    }
-
-
-    /**
-     * parent slug to use when site is in full maintenance mode
-     *
-     * @return string
-     */
-    public function maintenanceModeParent(): string
-    {
-        return $this->maintenance_mode_parent;
-    }
-
-
-    /**
-     * @param string $maintenance_mode_parent
-     */
-    public function setMaintenanceModeParent(string $maintenance_mode_parent): void
-    {
-        $this->maintenance_mode_parent = $maintenance_mode_parent;
-    }
-
-
-    /**
-     *  Optional. The function to be called to output the content for this page.
-     *
-     * @return callable|null
-     */
-    public function menuCallback(): ?callable
-    {
-        return $this->menu_callback;
-    }
-
-
-    /**
-     * @param callable|string|null $menu_callback
-     */
-    public function setMenuCallback($menu_callback): void
-    {
-        $this->menu_callback = $menu_callback;
-    }
-
-
-    /**
-     * Slug for menu group that this menu item will appear under
-     *
-     * @return string
-     */
-    public function menuGroup(): string
-    {
-        return $this->menu_group;
-    }
-
-
-    /**
-     * @param string $menu_group
-     */
-    public function setMenuGroup(string $menu_group): void
-    {
-        $this->menu_group = $menu_group;
-    }
-
-
-    /**
-     * The text to be used for the menu.
-     *
-     * @return string
-     */
-    public function menuLabel(): string
-    {
-        return $this->menu_label;
-    }
-
-
-    /**
-     * @param string $menu_label
-     */
-    public function setMenuLabel(string $menu_label): void
-    {
-        $this->menu_label = $menu_label;
-    }
-
-
-    /**
-     * Optional. The position in the menu order this item should appear.
-     *
-     * @return int
-     */
-    public function menuOrder(): int
-    {
-        return $this->menu_order;
-    }
-
-
-    /**
-     * @param int $menu_order
-     */
-    public function setMenuOrder(int $menu_order): void
-    {
-        $this->menu_order = absint($menu_order);
-    }
-
-
-    /**
-     * The slug name to refer to this menu by. Should be unique for this menu
-     *
-     * @return string
-     */
-    public function menuSlug(): string
-    {
-        return $this->menu_slug;
-    }
-
-
-    /**
-     * @param string $menu_slug
-     */
-    public function setMenuSlug(string $menu_slug): void
-    {
-        $this->menu_slug = sanitize_key($menu_slug);
-    }
-
-
-    /**
-     * The slug name for the parent menu (or the file name of a standard WordPress admin page).
-     *
-     * @return string
-     */
-    public function parentSlug(): string
-    {
-        return $this->parent_slug;
-    }
-
-
-    /**
-     * if site is in full maintenance mode,
-     * then parent slug will be swapped with the maintenance_mode_parent if that property has been set
-     *
-     * @param string $parent_slug
-     */
-    public function setParentSlug(string $parent_slug): void
-    {
-        $this->parent_slug = $this->maintenance_mode && $this->maintenance_mode_parent
-            ? $this->maintenance_mode_parent
-            : $parent_slug;
-    }
-
-
-    /**
-     * returns true if menu item has already been registered with WP core
-     *
-     * @return bool
-     */
-    public function isRegistered(): bool
-    {
-        return $this->registered;
-    }
-
-
-    /**
-     * returns TRUE if:
-     * - site is currently NOT in full site maintenance mode
-     * - site IS in full site maintenance mode and menu item has a valid maintenance mode parent
-     *
-     * @return bool
-     */
-    public function showOnMaintenanceModeMenu(): bool
-    {
-        return ! $this->maintenance_mode || $this->maintenanceModeParent() !== '';
-    }
-
-
-    /**
-     * @param int $show_on_menu
-     * @throws DomainException
-     */
-    public function setShowOnMenu(int $show_on_menu): void
-    {
-        $valid_menu_options = [
-            AdminMenuItem::DISPLAY_NONE,
-            AdminMenuItem::DISPLAY_BLOG_ONLY,
-            AdminMenuItem::DISPLAY_BLOG_AND_NETWORK,
-            AdminMenuItem::DISPLAY_NETWORK_ONLY,
-        ];
-        if (! in_array($show_on_menu, $valid_menu_options, true)) {
-            throw new DomainException(
-                sprintf(
-                    esc_html__(
-                        'Invalid "ShowOnMenu" option of "%1$s" supplied. You must use one of the AdminMenuItem::DISPLAY_* constants.',
-                        'event_espresso'
-                    ),
-                    $show_on_menu
-                )
-            );
-        }
-        $this->show_on_menu = $show_on_menu;
-    }
-
-
-    /**
-     * The text to be displayed in the title tags of the page when the menu is selected
-     *
-     * @return string
-     */
-    public function title(): string
-    {
-        return $this->title;
-    }
-
-
-    /**
-     * @param string $title
-     */
-    public function setTitle(string $title): void
-    {
-        $this->title = $title;
-    }
+	public const DISPLAY_NONE             = 0;
+
+	public const DISPLAY_BLOG_ONLY        = 1;
+
+	public const DISPLAY_BLOG_AND_NETWORK = 2;
+
+	public const DISPLAY_NETWORK_ONLY     = 3;
+
+	public const TYPE_MENU_TOP            = 'top';
+
+	public const TYPE_MENU_GROUP          = 'group';
+
+	public const TYPE_MENU_SUB_ITEM       = 'sub-item';
+
+
+	/**
+	 * What capability is required to access this page.
+	 *
+	 * @since 4.4.0
+	 * @var string
+	 */
+	protected string $capability = 'administrator';
+
+	/**
+	 * set to TRUE if site is currently in maintenance mode level 2
+	 *
+	 * @var bool
+	 */
+	protected bool $maintenance_mode = false;
+
+	/**
+	 * Menu maps can define a parent slug that gets used instead of the main parent slug for the menu when
+	 * EE_Maintenance_Mode::STATUS_FULL_SITE is active.
+	 *
+	 * @var string
+	 */
+	public string $maintenance_mode_parent = '';
+
+	/**
+	 * The callback for displaying the page that the menu references.
+	 *
+	 * @since 4.4.0
+	 * @var callable|string|null
+	 */
+	protected $menu_callback;
+
+	/**
+	 * The EE specific group this menu item belongs in (group slug).
+	 *
+	 * @since 4.4.0
+	 * @var string
+	 */
+	protected string $menu_group;
+
+	/**
+	 * The label for the menu item. (What shows up in the actual menu).
+	 *
+	 * @since 4.4.0
+	 * @var string
+	 */
+	protected string $menu_label;
+
+	/**
+	 * What order this item should be in the menu.
+	 *
+	 * @since 4.4.0
+	 * @var int
+	 */
+	protected int $menu_order;
+
+	/**
+	 * What slug should be used to reference this menu item.
+	 *
+	 * @since 4.4.0
+	 * @var string
+	 */
+	protected string $menu_slug;
+
+	/**
+	 * What menu item is the parent of this menu item.
+	 *
+	 * @since 4.4.0
+	 * @var string
+	 */
+	protected string $parent_slug;
+
+	/**
+	 * set to TRUE once menu item has been added to generated menu
+	 *
+	 * @var bool
+	 */
+	protected bool $registered = false;
+
+	/**
+	 * Whether this item is displayed in the menu or not.
+	 * Sometimes an EE Admin Page needs to register itself but is not accessible via the WordPress
+	 * admin menu.
+	 *
+	 * @since 4.4.0
+	 * @var int
+	 */
+	protected int $show_on_menu = self::DISPLAY_BLOG_ONLY;
+
+	/**
+	 * The title for the menu page. (the page the menu links to)
+	 *
+	 * @since  4.4.0
+	 * @var string
+	 */
+	protected string $title;
+
+
+	/**
+	 * @param array $menu_args            An array of arguments used to setup the menu properties on construct.
+	 * @param array $required             An array of keys that should be in the $menu_args,
+	 *                                    this is used to validate that the items that should be defined are present.
+	 * @return void
+	 * @throws DomainException
+	 * @throws InvalidArgumentException
+	 * @throws OutOfBoundsException
+	 */
+	public function __construct(array $menu_args, array $required)
+	{
+		// we don't want this coupling anymore >:(
+		unset($menu_args['admin_init_page'], $required['admin_init_page']);
+		$this->maintenance_mode = MaintenanceStatus::isFullSite();
+
+		// filter all args before processing so plugins can manipulate various settings for menus.
+		$menu_args = apply_filters(
+			'FHEE__EE_Admin_Page_Menu_Map__construct__menu_args',
+			$menu_args,
+			$required,
+			get_class($this)
+		);
+
+		$this->verifyRequired($menu_args, $required);
+		$this->setProperties($menu_args);
+	}
+
+
+	/**
+	 * This method should define how the menu page gets added for this particular item
+	 * and go ahead and define it.  Note that child classes MUST also return the result of
+	 * the function used to register the WordPress admin page (the wp_page_slug string)
+	 *
+	 * @return string wp_page_slug.
+	 * @since  4.4.0
+	 */
+	abstract protected function registerMenuItem(): string;
+
+
+	/**
+	 * Called by client code to use this menu map for registering a WordPress admin page
+	 *
+	 * @param boolean $network_admin whether this is being added to the network admin page or not
+	 * @since  4.4.0
+	 */
+	public function registerAdminMenuItem(bool $network_admin = false): string
+	{
+		$this->registered = true;
+		return $this->displayOnBlogAndNetworkAdmin()
+			   || $this->displayOnBlogAdmin($network_admin)
+			   || $this->displayOnNetworkAdmin($network_admin)
+			? $this->registerMenuItem()
+			: '';
+	}
+
+
+	/**
+	 * @param array $menu_args
+	 * @param array $required
+	 * @throws DomainException
+	 */
+	private function verifyRequired(array $menu_args, array $required)
+	{
+		// verify that required keys are present in the incoming array.
+		$missing = array_diff($required, array_keys($menu_args));
+
+		if (! empty($missing)) {
+			throw new DomainException(
+				sprintf(
+					esc_html__(
+						'%1$s is missing some expected keys in the argument array.  The following keys are missing: %2$s',
+						'event_espresso'
+					),
+					get_class($this),
+					implode(', ', $missing)
+				)
+			);
+		}
+
+		if (
+			in_array('admin_init_page', $required, true)
+			&& ! (isset($menu_args['admin_init_page']) && $menu_args['admin_init_page'] instanceof EE_Admin_Page_Init)
+		) {
+			throw new InvalidArgumentException(
+				sprintf(
+					esc_html__(
+						'The value for the "admin_init_page" argument must be an instance of an EE_Admin_Page_Init object.  Instead %s was given as the value.',
+						'event_espresso'
+					),
+					print_r($menu_args['admin_init_page'] ?? null, true)
+				)
+			);
+		}
+	}
+
+
+	/**
+	 * @param array $menu_args
+	 * @throws InvalidArgumentException
+	 * @throws OutOfBoundsException
+	 */
+	private function setProperties(array $menu_args)
+	{
+		$menu_args += [
+			'capability'              => 'ee_read_ee',
+			'maintenance_mode_parent' => '',
+			'menu_callback'           => null,
+			'menu_group'              => '',
+			'menu_label'              => '',
+			'menu_order'              => 100,
+			'menu_slug'               => '',
+			'parent_slug'             => AdminMenuTopLevel::MENU_PARENT_ACTIVE,
+			'show_on_menu'            => AdminMenuItem::DISPLAY_NONE,
+			'title'                   => '',
+		];
+
+		$this->setMenuSlug($menu_args['menu_slug']);
+		$this->setCapability($menu_args['capability']);
+		$this->setMaintenanceModeParent($menu_args['maintenance_mode_parent']);
+		$this->setMenuCallback($menu_args['menu_callback']);
+		$this->setMenuGroup($menu_args['menu_group']);
+		$this->setMenuLabel($menu_args['menu_label']);
+		$this->setMenuOrder($menu_args['menu_order']);
+		$this->setParentSlug($menu_args['parent_slug']);
+		$this->setShowOnMenu($menu_args['show_on_menu']);
+		$this->setTitle($menu_args['title']);
+	}
+
+
+	/**
+	 * The capability required for this menu to be displayed to the user.
+	 *
+	 * @return string
+	 */
+	public function capability(): string
+	{
+		return $this->capability;
+	}
+
+
+	/**
+	 * @param string $capability
+	 */
+	public function setCapability(string $capability): void
+	{
+		$this->capability = $capability;
+		// filter capabilities (both static and dynamic)
+		$this->capability = apply_filters('FHEE_management_capability', $this->capability, null);
+		$this->capability = apply_filters('FHEE_' . $this->menu_slug . '_capability', $this->capability, null);
+	}
+
+
+	public function currentUserHasAccess(): bool
+	{
+		return EE_Capabilities::instance()->current_user_can($this->capability(), $this->menuSlug());
+	}
+
+
+	/**
+	 * @param bool $network_admin
+	 * @return bool
+	 */
+	public function displayOnBlogAdmin(bool $network_admin): bool
+	{
+		return ! $network_admin && $this->show_on_menu === AdminMenuItem::DISPLAY_BLOG_ONLY;
+	}
+
+
+	/**
+	 * @return bool
+	 */
+	public function displayOnBlogAndNetworkAdmin(): bool
+	{
+		return $this->show_on_menu === AdminMenuItem::DISPLAY_BLOG_AND_NETWORK;
+	}
+
+
+	/**
+	 * @param bool $network_admin
+	 * @return bool
+	 */
+	public function displayOnNetworkAdmin(bool $network_admin): bool
+	{
+		return $network_admin && $this->show_on_menu === AdminMenuItem::DISPLAY_NETWORK_ONLY;
+	}
+
+
+	/**
+	 * parent slug to use when site is in full maintenance mode
+	 *
+	 * @return string
+	 */
+	public function maintenanceModeParent(): string
+	{
+		return $this->maintenance_mode_parent;
+	}
+
+
+	/**
+	 * @param string $maintenance_mode_parent
+	 */
+	public function setMaintenanceModeParent(string $maintenance_mode_parent): void
+	{
+		$this->maintenance_mode_parent = $maintenance_mode_parent;
+	}
+
+
+	/**
+	 *  Optional. The function to be called to output the content for this page.
+	 *
+	 * @return callable|null
+	 */
+	public function menuCallback(): ?callable
+	{
+		return $this->menu_callback;
+	}
+
+
+	/**
+	 * @param callable|string|null $menu_callback
+	 */
+	public function setMenuCallback($menu_callback): void
+	{
+		$this->menu_callback = $menu_callback;
+	}
+
+
+	/**
+	 * Slug for menu group that this menu item will appear under
+	 *
+	 * @return string
+	 */
+	public function menuGroup(): string
+	{
+		return $this->menu_group;
+	}
+
+
+	/**
+	 * @param string $menu_group
+	 */
+	public function setMenuGroup(string $menu_group): void
+	{
+		$this->menu_group = $menu_group;
+	}
+
+
+	/**
+	 * The text to be used for the menu.
+	 *
+	 * @return string
+	 */
+	public function menuLabel(): string
+	{
+		return $this->menu_label;
+	}
+
+
+	/**
+	 * @param string $menu_label
+	 */
+	public function setMenuLabel(string $menu_label): void
+	{
+		$this->menu_label = $menu_label;
+	}
+
+
+	/**
+	 * Optional. The position in the menu order this item should appear.
+	 *
+	 * @return int
+	 */
+	public function menuOrder(): int
+	{
+		return $this->menu_order;
+	}
+
+
+	/**
+	 * @param int $menu_order
+	 */
+	public function setMenuOrder(int $menu_order): void
+	{
+		$this->menu_order = absint($menu_order);
+	}
+
+
+	/**
+	 * The slug name to refer to this menu by. Should be unique for this menu
+	 *
+	 * @return string
+	 */
+	public function menuSlug(): string
+	{
+		return $this->menu_slug;
+	}
+
+
+	/**
+	 * @param string $menu_slug
+	 */
+	public function setMenuSlug(string $menu_slug): void
+	{
+		$this->menu_slug = sanitize_key($menu_slug);
+	}
+
+
+	/**
+	 * The slug name for the parent menu (or the file name of a standard WordPress admin page).
+	 *
+	 * @return string
+	 */
+	public function parentSlug(): string
+	{
+		return $this->parent_slug;
+	}
+
+
+	/**
+	 * if site is in full maintenance mode,
+	 * then parent slug will be swapped with the maintenance_mode_parent if that property has been set
+	 *
+	 * @param string $parent_slug
+	 */
+	public function setParentSlug(string $parent_slug): void
+	{
+		$this->parent_slug = $this->maintenance_mode && $this->maintenance_mode_parent
+			? $this->maintenance_mode_parent
+			: $parent_slug;
+	}
+
+
+	/**
+	 * returns true if menu item has already been registered with WP core
+	 *
+	 * @return bool
+	 */
+	public function isRegistered(): bool
+	{
+		return $this->registered;
+	}
+
+
+	/**
+	 * returns TRUE if:
+	 * - site is currently NOT in full site maintenance mode
+	 * - site IS in full site maintenance mode and menu item has a valid maintenance mode parent
+	 *
+	 * @return bool
+	 */
+	public function showOnMaintenanceModeMenu(): bool
+	{
+		return ! $this->maintenance_mode || $this->maintenanceModeParent() !== '';
+	}
+
+
+	/**
+	 * @param int $show_on_menu
+	 * @throws DomainException
+	 */
+	public function setShowOnMenu(int $show_on_menu): void
+	{
+		$valid_menu_options = [
+			AdminMenuItem::DISPLAY_NONE,
+			AdminMenuItem::DISPLAY_BLOG_ONLY,
+			AdminMenuItem::DISPLAY_BLOG_AND_NETWORK,
+			AdminMenuItem::DISPLAY_NETWORK_ONLY,
+		];
+		if (! in_array($show_on_menu, $valid_menu_options, true)) {
+			throw new DomainException(
+				sprintf(
+					esc_html__(
+						'Invalid "ShowOnMenu" option of "%1$s" supplied. You must use one of the AdminMenuItem::DISPLAY_* constants.',
+						'event_espresso'
+					),
+					$show_on_menu
+				)
+			);
+		}
+		$this->show_on_menu = $show_on_menu;
+	}
+
+
+	/**
+	 * The text to be displayed in the title tags of the page when the menu is selected
+	 *
+	 * @return string
+	 */
+	public function title(): string
+	{
+		return $this->title;
+	}
+
+
+	/**
+	 * @param string $title
+	 */
+	public function setTitle(string $title): void
+	{
+		$this->title = $title;
+	}
 }

Spacing +3 added lines, -3 removed lines

@@ -189,7 +189,7 @@ 
         // verify that required keys are present in the incoming array.
         $missing = array_diff($required, array_keys($menu_args));
 
-        if (! empty($missing)) {
+        if ( ! empty($missing)) {
             throw new DomainException(
                 sprintf(
                     esc_html__(
@@ -271,7 +271,7 @@ 
         $this->capability = $capability;
         // filter capabilities (both static and dynamic)
         $this->capability = apply_filters('FHEE_management_capability', $this->capability, null);
-        $this->capability = apply_filters('FHEE_' . $this->menu_slug . '_capability', $this->capability, null);
+        $this->capability = apply_filters('FHEE_'.$this->menu_slug.'_capability', $this->capability, null);
     }
 
 
@@ -491,7 +491,7 @@ 
             AdminMenuItem::DISPLAY_BLOG_AND_NETWORK,
             AdminMenuItem::DISPLAY_NETWORK_ONLY,
         ];
-        if (! in_array($show_on_menu, $valid_menu_options, true)) {
+        if ( ! in_array($show_on_menu, $valid_menu_options, true)) {
             throw new DomainException(
                 sprintf(
                     esc_html__(

core/domain/entities/admin/menu/AdminMenuGroup.php

Indentation +55 added lines, -55 removed lines

@@ -16,81 +16,81 @@
  */
 class AdminMenuGroup extends AdminMenuItem
 {
-    public const MENU_SLUG_ADDONS     = 'addons';
+	public const MENU_SLUG_ADDONS     = 'addons';
 
-    public const MENU_SLUG_EXTRAS     = 'extras';
+	public const MENU_SLUG_EXTRAS     = 'extras';
 
-    public const MENU_SLUG_MAIN       = 'main';
+	public const MENU_SLUG_MAIN       = 'main';
 
-    public const MENU_SLUG_MANAGEMENT = 'management';
+	public const MENU_SLUG_MANAGEMENT = 'management';
 
-    public const MENU_SLUG_SETTINGS   = 'settings';
+	public const MENU_SLUG_SETTINGS   = 'settings';
 
-    public const MENU_SLUG_TEMPLATES  = 'templates';
+	public const MENU_SLUG_TEMPLATES  = 'templates';
 
-    public const MENU_SLUG_TOOLS      = 'tools';
+	public const MENU_SLUG_TOOLS      = 'tools';
 
 
-    /**
-     * @var AdminMenuItem[]
-     */
-    private array $menu_items = [];
+	/**
+	 * @var AdminMenuItem[]
+	 */
+	private array $menu_items = [];
 
 
-    public function __construct(array $menu_args)
-    {
-        parent::__construct(
-            $menu_args,
-            // required args
-            [
-                'menu_label',
-                'menu_slug',
-                'menu_order',
-                'parent_slug',
-            ]
-        );
-    }
+	public function __construct(array $menu_args)
+	{
+		parent::__construct(
+			$menu_args,
+			// required args
+			[
+				'menu_label',
+				'menu_slug',
+				'menu_order',
+				'parent_slug',
+			]
+		);
+	}
 
 
-    public function addMenuItem(AdminMenuItem $menu_item): void
-    {
-        $this->menu_items[ $menu_item->menuSlug() ] = $menu_item;
-    }
+	public function addMenuItem(AdminMenuItem $menu_item): void
+	{
+		$this->menu_items[ $menu_item->menuSlug() ] = $menu_item;
+	}
 
 
-    public function getMenuItems(): array
-    {
-        return $this->menu_items;
-    }
+	public function getMenuItems(): array
+	{
+		return $this->menu_items;
+	}
 
 
-    public function hasNoMenuItems(): bool
-    {
-        return empty($this->menu_items);
-    }
+	public function hasNoMenuItems(): bool
+	{
+		return empty($this->menu_items);
+	}
 
 
-    public function setMenuItems(array $menu_items): void
-    {
-        $this->menu_items = $menu_items;
-    }
+	public function setMenuItems(array $menu_items): void
+	{
+		$this->menu_items = $menu_items;
+	}
 
 
-    protected function registerMenuItem(): string
-    {
-        return add_submenu_page(
-            $this->parentSlug(),
-            $this->menuLabel(),
-            $this->groupLink(),
-            $this->capability(),
-            $this->menuSlug(),
-            '__return_false'
-        );
-    }
+	protected function registerMenuItem(): string
+	{
+		return add_submenu_page(
+			$this->parentSlug(),
+			$this->menuLabel(),
+			$this->groupLink(),
+			$this->capability(),
+			$this->menuSlug(),
+			'__return_false'
+		);
+	}
 
 
-    protected function groupLink(): string
-    {
-        return '<span class="ee_menu_group"  onclick="return false;">' . $this->menuLabel() . '</span>';
-    }
+	protected function groupLink(): string
+	{
+		return '<span class="ee_menu_group"  onclick="return false;">' . $this->menuLabel() . '</span>';
+	}
 }

Spacing +2 added lines, -2 removed lines

@@ -54,7 +54,7 @@ 
 
     public function addMenuItem(AdminMenuItem $menu_item): void
     {
-        $this->menu_items[ $menu_item->menuSlug() ] = $menu_item;
+        $this->menu_items[$menu_item->menuSlug()] = $menu_item;
     }
 
 
@@ -91,6 +91,6 @@ 
 
     protected function groupLink(): string
     {
-        return '<span class="ee_menu_group"  onclick="return false;">' . $this->menuLabel() . '</span>';
+        return '<span class="ee_menu_group"  onclick="return false;">'.$this->menuLabel().'</span>';
     }
 }

core/domain/entities/admin/menu/AdminMenuSubItem.php

Indentation +11 added lines, -11 removed lines

@@ -4,15 +4,15 @@
 
 class AdminMenuSubItem extends AdminMenuTopLevel
 {
-    protected function registerMenuItem(): string
-    {
-        return add_submenu_page(
-            $this->parentSlug(),
-            $this->title(),
-            $this->menuLabel(),
-            $this->capability(),
-            $this->menuSlug(),
-            $this->menuCallback()
-        ) ?: '';
-    }
+	protected function registerMenuItem(): string
+	{
+		return add_submenu_page(
+			$this->parentSlug(),
+			$this->title(),
+			$this->menuLabel(),
+			$this->capability(),
+			$this->menuSlug(),
+			$this->menuCallback()
+		) ?: '';
+	}
 }

core/domain/entities/config/legacy/EE_Registration_Config.php

Indentation +353 added lines, -353 removed lines

@@ -8,360 +8,360 @@
  */
 class EE_Registration_Config extends EE_Config_Base
 {
-    /**
-     * Default registration status
-     *
-     * @var string $default_STS_ID
-     * eg 'RPP'
-     */
-    public $default_STS_ID = RegStatus::PENDING_PAYMENT;
-
-    /**
-     * For new events, this will be the default value for the maximum number of tickets (equivalent to maximum number of
-     * registrations)
-     *
-     * @var int
-     */
-    public $default_maximum_number_of_tickets = 10;
-
-    /**
-     * level of validation to apply to email addresses
-     *
-     * @var string $email_validation_level
-     * options: 'basic', 'wp_default', 'i18n', 'i18n_dns'
-     */
-    public $email_validation_level = 'wp_default';
-
-    /**
-     * whether to show alternate payment options during the reg process if payment status is pending
-     *
-     * @var bool $show_pending_payment_options
-     */
-    public $show_pending_payment_options = true;
-
-    /**
-     * an array of SPCO reg steps where:
-     *        the keys denotes the reg step order
-     *        each element consists of an array with the following elements:
-     *            "file_path" => the file path to the EE_SPCO_Reg_Step class
-     *            "class_name" => the specific EE_SPCO_Reg_Step child class name
-     *            "slug" => the URL param used to trigger the reg step
-     *
-     * @var array $reg_steps
-     */
-    public $reg_steps = [];
-
-    /**
-     * Whether registration confirmation should be the last page of SPCO
-     *
-     * @var bool $reg_confirmation_last
-     */
-    public $reg_confirmation_last = false;
-
-    /**
-     * Whether to enable the EE Bot Trap
-     *
-     * @var bool $use_bot_trap
-     */
-    public $use_bot_trap = true;
-
-    /**
-     * Whether to encrypt some data sent by the EE Bot Trap
-     *
-     * @var bool $use_encryption
-     */
-    public $use_encryption = true;
-
-    /**
-     * Whether to use ReCaptcha
-     *
-     * @var bool $use_captcha
-     */
-    public $use_captcha = false;
-
-    /**
-     * ReCaptcha Theme
-     *
-     * @var string $recaptcha_theme
-     *    options: 'dark', 'light', 'invisible'
-     */
-    public $recaptcha_theme = 'light';
-
-    /**
-     * ReCaptcha Badge - determines the position of the reCAPTCHA badge if using Invisible ReCaptcha.
-     *
-     * @var string $recaptcha_badge
-     *    options: 'bottomright', 'bottomleft', 'inline'
-     */
-    public $recaptcha_badge = 'bottomleft';
-
-    /**
-     * ReCaptcha Type
-     *
-     * @var string $recaptcha_type
-     *    options: 'audio', 'image'
-     */
-    public $recaptcha_type = 'image';
-
-    /**
-     * ReCaptcha language
-     *
-     * @var string $recaptcha_language
-     * eg 'en'
-     */
-    public $recaptcha_language = 'en';
-
-    /**
-     * ReCaptcha public key
-     *
-     * @var string|null $recaptcha_publickey
-     */
-    public $recaptcha_publickey = null;
-
-    /**
-     * ReCaptcha private key
-     *
-     * @var string|null $recaptcha_privatekey
-     */
-    public $recaptcha_privatekey = null;
-
-    /**
-     * array of form names protected by ReCaptcha
-     *
-     * @var array $recaptcha_protected_forms
-     */
-    public $recaptcha_protected_forms = [];
-
-    /**
-     * ReCaptcha width
-     *
-     * @var int $recaptcha_width
-     * @deprecated
-     */
-    public $recaptcha_width = 500;
-
-    /**
-     * Whether invalid attempts to directly access the registration checkout page should be tracked.
-     *
-     * @var bool $track_invalid_checkout_access
-     */
-    protected $track_invalid_checkout_access = true;
-
-    /**
-     * Whether to show the privacy policy consent checkbox
-     *
-     * @var bool
-     */
-    public $consent_checkbox_enabled = false;
-
-    /**
-     * Label text to show on the checkbox
-     *
-     * @var string
-     */
-    public $consent_checkbox_label_text = '';
-
-    /*
+	/**
+	 * Default registration status
+	 *
+	 * @var string $default_STS_ID
+	 * eg 'RPP'
+	 */
+	public $default_STS_ID = RegStatus::PENDING_PAYMENT;
+
+	/**
+	 * For new events, this will be the default value for the maximum number of tickets (equivalent to maximum number of
+	 * registrations)
+	 *
+	 * @var int
+	 */
+	public $default_maximum_number_of_tickets = 10;
+
+	/**
+	 * level of validation to apply to email addresses
+	 *
+	 * @var string $email_validation_level
+	 * options: 'basic', 'wp_default', 'i18n', 'i18n_dns'
+	 */
+	public $email_validation_level = 'wp_default';
+
+	/**
+	 * whether to show alternate payment options during the reg process if payment status is pending
+	 *
+	 * @var bool $show_pending_payment_options
+	 */
+	public $show_pending_payment_options = true;
+
+	/**
+	 * an array of SPCO reg steps where:
+	 *        the keys denotes the reg step order
+	 *        each element consists of an array with the following elements:
+	 *            "file_path" => the file path to the EE_SPCO_Reg_Step class
+	 *            "class_name" => the specific EE_SPCO_Reg_Step child class name
+	 *            "slug" => the URL param used to trigger the reg step
+	 *
+	 * @var array $reg_steps
+	 */
+	public $reg_steps = [];
+
+	/**
+	 * Whether registration confirmation should be the last page of SPCO
+	 *
+	 * @var bool $reg_confirmation_last
+	 */
+	public $reg_confirmation_last = false;
+
+	/**
+	 * Whether to enable the EE Bot Trap
+	 *
+	 * @var bool $use_bot_trap
+	 */
+	public $use_bot_trap = true;
+
+	/**
+	 * Whether to encrypt some data sent by the EE Bot Trap
+	 *
+	 * @var bool $use_encryption
+	 */
+	public $use_encryption = true;
+
+	/**
+	 * Whether to use ReCaptcha
+	 *
+	 * @var bool $use_captcha
+	 */
+	public $use_captcha = false;
+
+	/**
+	 * ReCaptcha Theme
+	 *
+	 * @var string $recaptcha_theme
+	 *    options: 'dark', 'light', 'invisible'
+	 */
+	public $recaptcha_theme = 'light';
+
+	/**
+	 * ReCaptcha Badge - determines the position of the reCAPTCHA badge if using Invisible ReCaptcha.
+	 *
+	 * @var string $recaptcha_badge
+	 *    options: 'bottomright', 'bottomleft', 'inline'
+	 */
+	public $recaptcha_badge = 'bottomleft';
+
+	/**
+	 * ReCaptcha Type
+	 *
+	 * @var string $recaptcha_type
+	 *    options: 'audio', 'image'
+	 */
+	public $recaptcha_type = 'image';
+
+	/**
+	 * ReCaptcha language
+	 *
+	 * @var string $recaptcha_language
+	 * eg 'en'
+	 */
+	public $recaptcha_language = 'en';
+
+	/**
+	 * ReCaptcha public key
+	 *
+	 * @var string|null $recaptcha_publickey
+	 */
+	public $recaptcha_publickey = null;
+
+	/**
+	 * ReCaptcha private key
+	 *
+	 * @var string|null $recaptcha_privatekey
+	 */
+	public $recaptcha_privatekey = null;
+
+	/**
+	 * array of form names protected by ReCaptcha
+	 *
+	 * @var array $recaptcha_protected_forms
+	 */
+	public $recaptcha_protected_forms = [];
+
+	/**
+	 * ReCaptcha width
+	 *
+	 * @var int $recaptcha_width
+	 * @deprecated
+	 */
+	public $recaptcha_width = 500;
+
+	/**
+	 * Whether invalid attempts to directly access the registration checkout page should be tracked.
+	 *
+	 * @var bool $track_invalid_checkout_access
+	 */
+	protected $track_invalid_checkout_access = true;
+
+	/**
+	 * Whether to show the privacy policy consent checkbox
+	 *
+	 * @var bool
+	 */
+	public $consent_checkbox_enabled = false;
+
+	/**
+	 * Label text to show on the checkbox
+	 *
+	 * @var string
+	 */
+	public $consent_checkbox_label_text = '';
+
+	/*
      * String describing how long to keep payment logs. Passed into DateTime constructor
      * @var string
      */
-    public $gateway_log_lifespan = '7 days';
-
-    /**
-     * Enable copy attendee info at form
-     *
-     * @var bool $enable_copy_attendee
-     */
-    protected $copy_attendee_info = true;
-
-    /**
-     * @var bool|int|string|null $skip_reg_confirmation
-     * @deprecated
-     */
-    public $skip_reg_confirmation;
-
-    private bool $use_session_countdown = false;
-
-
-    public function __construct()
-    {
-    }
-
-
-    /**
-     * This is called by the config loader and hooks are initialized AFTER the config has been populated.
-     *
-     * @since 4.8.8.rc.019
-     */
-    public function do_hooks()
-    {
-        add_action('AHEE__EE_Config___load_core_config__end', [$this, 'set_default_reg_status_on_EEM_Event']);
-        add_action('AHEE__EE_Config___load_core_config__end', [$this, 'set_default_max_ticket_on_EEM_Event']);
-        add_action('AHEE__EE_System__load_core_configuration__complete', [$this, 'setDefaultCheckboxLabelText']);
-    }
-
-
-    /**
-     * Hooked into `AHEE__EE_Config___load_core_config__end` to ensure the default for the
-     * EVT_default_registration_status field matches the config setting for default_STS_ID.
-     *
-     * @throws EE_Error
-     */
-    public function set_default_reg_status_on_EEM_Event()
-    {
-        EEM_Event::set_default_reg_status($this->default_STS_ID);
-    }
-
-
-    /**
-     * Hooked into `AHEE__EE_Config___load_core_config__end` to ensure the default for the EVT_additional_limit field
-     * for Events matches the config setting for default_maximum_number_of_tickets
-     */
-    public function set_default_max_ticket_on_EEM_Event()
-    {
-        EEM_Event::set_default_additional_limit($this->default_maximum_number_of_tickets);
-    }
-
-
-    /**
-     * Sets the default consent checkbox text. This needs to be done a bit later than when EE_Registration_Config is
-     * constructed because that happens before we can get the privacy policy page's permalink.
-     */
-    public function setDefaultCheckboxLabelText()
-    {
-        if (
-            $this->getConsentCheckboxLabelText() === null
-            || $this->getConsentCheckboxLabelText() === ''
-        ) {
-            $opening_a_tag = '';
-            $closing_a_tag = '';
-            if (function_exists('get_privacy_policy_url')) {
-                $privacy_page_url = get_privacy_policy_url();
-                if (! empty($privacy_page_url)) {
-                    $opening_a_tag = '<a href="' . $privacy_page_url . '" target="_blank">';
-                    $closing_a_tag = '</a>';
-                }
-            }
-
-            $loader     = LoaderFactory::getLoader();
-            /** @var EE_Organization_Config $org_config */
-            $org_config = $loader->getShared('EE_Organization_Config');
-
-            $this->setConsentCheckboxLabelText(
-                sprintf(
-                    esc_html__(
-                        'I consent to %1$s storing and using my personal information, according to their %2$sprivacy policy%3$s.',
-                        'event_espresso'
-                    ),
-                    $org_config->name,
-                    $opening_a_tag,
-                    $closing_a_tag
-                )
-            );
-        }
-    }
-
-
-    /**
-     * @return bool
-     */
-    public function track_invalid_checkout_access(): bool
-    {
-        return (bool) $this->track_invalid_checkout_access;
-    }
-
-
-    /**
-     * @param bool $track_invalid_checkout_access
-     */
-    public function set_track_invalid_checkout_access($track_invalid_checkout_access)
-    {
-        $this->track_invalid_checkout_access = (bool) filter_var($track_invalid_checkout_access, FILTER_VALIDATE_BOOL);
-    }
-
-
-    /**
-     * @return bool
-     */
-    public function copyAttendeeInfo(): bool
-    {
-        return (bool) $this->copy_attendee_info;
-    }
-
-
-    /**
-     * @param bool $copy_attendee_info
-     */
-    public function setCopyAttendeeInfo($copy_attendee_info)
-    {
-        $this->copy_attendee_info = (bool) filter_var($copy_attendee_info, FILTER_VALIDATE_BOOL);
-    }
-
-
-    /**
-     * Gets the options to make available for the gateway log lifespan
-     *
-     * @return array
-     */
-    public function gatewayLogLifespanOptions(): array
-    {
-        return (array) apply_filters(
-            'FHEE_EE_Admin_Config__gatewayLogLifespanOptions',
-            [
-                '1 second' => esc_html__('Don\'t Log At All', 'event_espresso'),
-                '1 day'    => esc_html__('1 Day', 'event_espresso'),
-                '7 days'   => esc_html__('7 Days', 'event_espresso'),
-                '14 days'  => esc_html__('14 Days', 'event_espresso'),
-                '30 days'  => esc_html__('30 Days', 'event_espresso'),
-            ]
-        );
-    }
-
-
-    /**
-     * @return bool
-     */
-    public function isConsentCheckboxEnabled(): bool
-    {
-        return (bool) $this->consent_checkbox_enabled;
-    }
-
-
-    /**
-     * @param bool $consent_checkbox_enabled
-     */
-    public function setConsentCheckboxEnabled($consent_checkbox_enabled)
-    {
-        $this->consent_checkbox_enabled = (bool) filter_var($consent_checkbox_enabled, FILTER_VALIDATE_BOOL);
-    }
-
-
-    /**
-     * @return string
-     */
-    public function getConsentCheckboxLabelText(): string
-    {
-        return (string) $this->consent_checkbox_label_text;
-    }
-
-
-    /**
-     * @param string $consent_checkbox_label_text
-     */
-    public function setConsentCheckboxLabelText($consent_checkbox_label_text)
-    {
-        $this->consent_checkbox_label_text = (string) $consent_checkbox_label_text;
-    }
-
-
-    public function useSessionCountdown(): bool
-    {
-        return $this->use_session_countdown;
-    }
-
-
-    public function setUseSessionCountdown(bool $use_session_countdown): void
-    {
-        $this->use_session_countdown = $use_session_countdown;
-    }
+	public $gateway_log_lifespan = '7 days';
+
+	/**
+	 * Enable copy attendee info at form
+	 *
+	 * @var bool $enable_copy_attendee
+	 */
+	protected $copy_attendee_info = true;
+
+	/**
+	 * @var bool|int|string|null $skip_reg_confirmation
+	 * @deprecated
+	 */
+	public $skip_reg_confirmation;
+
+	private bool $use_session_countdown = false;
+
+
+	public function __construct()
+	{
+	}
+
+
+	/**
+	 * This is called by the config loader and hooks are initialized AFTER the config has been populated.
+	 *
+	 * @since 4.8.8.rc.019
+	 */
+	public function do_hooks()
+	{
+		add_action('AHEE__EE_Config___load_core_config__end', [$this, 'set_default_reg_status_on_EEM_Event']);
+		add_action('AHEE__EE_Config___load_core_config__end', [$this, 'set_default_max_ticket_on_EEM_Event']);
+		add_action('AHEE__EE_System__load_core_configuration__complete', [$this, 'setDefaultCheckboxLabelText']);
+	}
+
+
+	/**
+	 * Hooked into `AHEE__EE_Config___load_core_config__end` to ensure the default for the
+	 * EVT_default_registration_status field matches the config setting for default_STS_ID.
+	 *
+	 * @throws EE_Error
+	 */
+	public function set_default_reg_status_on_EEM_Event()
+	{
+		EEM_Event::set_default_reg_status($this->default_STS_ID);
+	}
+
+
+	/**
+	 * Hooked into `AHEE__EE_Config___load_core_config__end` to ensure the default for the EVT_additional_limit field
+	 * for Events matches the config setting for default_maximum_number_of_tickets
+	 */
+	public function set_default_max_ticket_on_EEM_Event()
+	{
+		EEM_Event::set_default_additional_limit($this->default_maximum_number_of_tickets);
+	}
+
+
+	/**
+	 * Sets the default consent checkbox text. This needs to be done a bit later than when EE_Registration_Config is
+	 * constructed because that happens before we can get the privacy policy page's permalink.
+	 */
+	public function setDefaultCheckboxLabelText()
+	{
+		if (
+			$this->getConsentCheckboxLabelText() === null
+			|| $this->getConsentCheckboxLabelText() === ''
+		) {
+			$opening_a_tag = '';
+			$closing_a_tag = '';
+			if (function_exists('get_privacy_policy_url')) {
+				$privacy_page_url = get_privacy_policy_url();
+				if (! empty($privacy_page_url)) {
+					$opening_a_tag = '<a href="' . $privacy_page_url . '" target="_blank">';
+					$closing_a_tag = '</a>';
+				}
+			}
+
+			$loader     = LoaderFactory::getLoader();
+			/** @var EE_Organization_Config $org_config */
+			$org_config = $loader->getShared('EE_Organization_Config');
+
+			$this->setConsentCheckboxLabelText(
+				sprintf(
+					esc_html__(
+						'I consent to %1$s storing and using my personal information, according to their %2$sprivacy policy%3$s.',
+						'event_espresso'
+					),
+					$org_config->name,
+					$opening_a_tag,
+					$closing_a_tag
+				)
+			);
+		}
+	}
+
+
+	/**
+	 * @return bool
+	 */
+	public function track_invalid_checkout_access(): bool
+	{
+		return (bool) $this->track_invalid_checkout_access;
+	}
+
+
+	/**
+	 * @param bool $track_invalid_checkout_access
+	 */
+	public function set_track_invalid_checkout_access($track_invalid_checkout_access)
+	{
+		$this->track_invalid_checkout_access = (bool) filter_var($track_invalid_checkout_access, FILTER_VALIDATE_BOOL);
+	}
+
+
+	/**
+	 * @return bool
+	 */
+	public function copyAttendeeInfo(): bool
+	{
+		return (bool) $this->copy_attendee_info;
+	}
+
+
+	/**
+	 * @param bool $copy_attendee_info
+	 */
+	public function setCopyAttendeeInfo($copy_attendee_info)
+	{
+		$this->copy_attendee_info = (bool) filter_var($copy_attendee_info, FILTER_VALIDATE_BOOL);
+	}
+
+
+	/**
+	 * Gets the options to make available for the gateway log lifespan
+	 *
+	 * @return array
+	 */
+	public function gatewayLogLifespanOptions(): array
+	{
+		return (array) apply_filters(
+			'FHEE_EE_Admin_Config__gatewayLogLifespanOptions',
+			[
+				'1 second' => esc_html__('Don\'t Log At All', 'event_espresso'),
+				'1 day'    => esc_html__('1 Day', 'event_espresso'),
+				'7 days'   => esc_html__('7 Days', 'event_espresso'),
+				'14 days'  => esc_html__('14 Days', 'event_espresso'),
+				'30 days'  => esc_html__('30 Days', 'event_espresso'),
+			]
+		);
+	}
+
+
+	/**
+	 * @return bool
+	 */
+	public function isConsentCheckboxEnabled(): bool
+	{
+		return (bool) $this->consent_checkbox_enabled;
+	}
+
+
+	/**
+	 * @param bool $consent_checkbox_enabled
+	 */
+	public function setConsentCheckboxEnabled($consent_checkbox_enabled)
+	{
+		$this->consent_checkbox_enabled = (bool) filter_var($consent_checkbox_enabled, FILTER_VALIDATE_BOOL);
+	}
+
+
+	/**
+	 * @return string
+	 */
+	public function getConsentCheckboxLabelText(): string
+	{
+		return (string) $this->consent_checkbox_label_text;
+	}
+
+
+	/**
+	 * @param string $consent_checkbox_label_text
+	 */
+	public function setConsentCheckboxLabelText($consent_checkbox_label_text)
+	{
+		$this->consent_checkbox_label_text = (string) $consent_checkbox_label_text;
+	}
+
+
+	public function useSessionCountdown(): bool
+	{
+		return $this->use_session_countdown;
+	}
+
+
+	public function setUseSessionCountdown(bool $use_session_countdown): void
+	{
+		$this->use_session_countdown = $use_session_countdown;
+	}
 }

core/domain/entities/routing/handlers/admin/ActivationRequests.php

Indentation +43 added lines, -43 removed lines

@@ -16,51 +16,51 @@
  */
 class ActivationRequests extends PrimaryRoute
 {
-    /**
-     * returns true if the current request matches this route
-     *
-     * @return bool
-     * @since   5.0.0.p
-     */
-    public function matchesCurrentRequest(): bool
-    {
-        return $this->request->isActivation();
-    }
+	/**
+	 * returns true if the current request matches this route
+	 *
+	 * @return bool
+	 * @since   5.0.0.p
+	 */
+	public function matchesCurrentRequest(): bool
+	{
+		return $this->request->isActivation();
+	}
 
 
-    /**
-     * @since 5.0.0.p
-     */
-    protected function registerDependencies()
-    {
-        $this->dependency_map->registerDependencies(
-            'EventEspresso\core\domain\entities\routing\handlers\admin\AdminRoute',
-            AdminRoute::getDefaultDependencies()
-        );
-        $this->dependency_map->registerDependencies(
-            'EventEspresso\core\domain\entities\routing\handlers\admin\WordPressPluginsPage',
-            AdminRoute::getDefaultDependencies()
-        );
-        $this->dependency_map->registerDependencies(
-            'EventEspresso\core\domain\services\licensing\LicenseKeyActivationRoute',
-            Route::getDefaultDependencies()
-        );
-    }
+	/**
+	 * @since 5.0.0.p
+	 */
+	protected function registerDependencies()
+	{
+		$this->dependency_map->registerDependencies(
+			'EventEspresso\core\domain\entities\routing\handlers\admin\AdminRoute',
+			AdminRoute::getDefaultDependencies()
+		);
+		$this->dependency_map->registerDependencies(
+			'EventEspresso\core\domain\entities\routing\handlers\admin\WordPressPluginsPage',
+			AdminRoute::getDefaultDependencies()
+		);
+		$this->dependency_map->registerDependencies(
+			'EventEspresso\core\domain\services\licensing\LicenseKeyActivationRoute',
+			Route::getDefaultDependencies()
+		);
+	}
 
 
-    /**
-     * implements logic required to run during request
-     *
-     * @return bool
-     * @since   5.0.0.p
-     */
-    protected function requestHandler(): bool
-    {
-        $this->setRouteRequestType(PrimaryRoute::ROUTE_REQUEST_TYPE_ACTIVATION);
-        /** @var Textdomain $textdomain */
-        $textdomain = $this->loader->getShared(Textdomain::class);
-        add_action('init', [$textdomain, 'loadTranslationsForLocaleOnActivation'], 0);
-        add_action('admin_init', [$textdomain, 'deleteLegacyTextDomainOption'], 99);
-        return true;
-    }
+	/**
+	 * implements logic required to run during request
+	 *
+	 * @return bool
+	 * @since   5.0.0.p
+	 */
+	protected function requestHandler(): bool
+	{
+		$this->setRouteRequestType(PrimaryRoute::ROUTE_REQUEST_TYPE_ACTIVATION);
+		/** @var Textdomain $textdomain */
+		$textdomain = $this->loader->getShared(Textdomain::class);
+		add_action('init', [$textdomain, 'loadTranslationsForLocaleOnActivation'], 0);
+		add_action('admin_init', [$textdomain, 'deleteLegacyTextDomainOption'], 99);
+		return true;
+	}
 }

core/domain/values/Version.php

Indentation +265 added lines, -265 removed lines

@@ -15,269 +15,269 @@
  */
 class Version
 {
-    const RELEASE_TYPE_RC    = 'rc';
-
-    const RELEASE_TYPE_BETA  = 'beta';
-
-    const RELEASE_TYPE_DECAF = 'decaf';
-
-    const RELEASE_TYPE_PROD  = 'p';
-
-
-    private int $major;
-
-    private int $minor;
-
-    private int $patch;
-
-    private int $build;
-
-
-    /**
-     * Version constructor.
-     *
-     * @param int    $major
-     * @param int    $minor
-     * @param int    $patch
-     * @param int|string|null $build_or_release
-     * @param int|null    $build
-     * @throws InvalidDataTypeException
-     * @throws InvalidArgumentException
-     */
-    public function __construct(
-        int $major,
-        int $minor,
-        int $patch,
-        $build_or_release = 0,
-        ?int $build = null
-    ) {
-        $this->setMajor($major);
-        $this->setMinor($minor);
-        $this->setPatch($patch);
-        $build = $build ?? $build_or_release;
-        $this->setBuild($build);
-    }
-
-
-    /**
-     * @param string $version_string
-     * @return Version
-     * @throws InvalidArgumentException
-     */
-    public static function fromString(string $version_string): Version
-    {
-        $version_string = trim($version_string);
-        // compare incoming version string against the lowest possible valid version
-        if (version_compare($version_string, '0.0.1.dev.001', '<')) {
-            throw new InvalidArgumentException(
-                sprintf(
-                    esc_html__('"%1$s" is not a valid version string', 'event_espresso'),
-                    $version_string
-                )
-            );
-        }
-        // break apart incoming version string
-        $version_parts = explode('.', $version_string);
-        // remove any non-numeric parts
-        $version_parts = array_filter($version_parts, 'is_numeric');
-        // reindex the array so that the keys are sequential
-        $version_parts = array_values($version_parts);
-        // verify that version string at least contains {major}.{minor}.{patch}
-        if (count($version_parts) < 3) {
-            throw new InvalidArgumentException(
-                sprintf(
-                    esc_html__(
-                        'At minimum, a version string needs to be in a "{major}.{minor}.{patch}" format, therefore "%1$s" is not valid',
-                        'event_espresso'
-                    ),
-                    $version_string
-                )
-            );
-        }
-        if (isset($version_parts[4])) {
-            // if there are more than 4 parts, then the version string includes the old "release" part
-            $build = $version_parts[4];
-            $version_parts[3] = $build;
-            unset($version_parts[4]);
-        }
-        // add defaults for missing pieces
-        $version_parts += ['0', '0', '0', '000'];
-        ksort($version_parts, SORT_NUMERIC);
-        $version_parts = array_map('trim', $version_parts);
-        // reassign to individual variables
-        [$major, $minor, $patch, $build] = $version_parts;
-        return new Version(
-            (int) $major,
-            (int) $minor,
-            (int) $patch,
-            (int) $build
-        );
-    }
-
-
-    /**
-     * @return int
-     */
-    public function major(): int
-    {
-        return $this->major;
-    }
-
-
-    /**
-     * @param int|string $major
-     * @throws InvalidDataTypeException
-     */
-    private function setMajor($major)
-    {
-        if (! is_int($major)) {
-            throw new InvalidDataTypeException(
-                '$major',
-                $major,
-                'integer'
-            );
-        }
-        $this->major = absint($major);
-    }
-
-
-    /**
-     * @return int
-     */
-    public function minor(): int
-    {
-        return $this->minor;
-    }
-
-
-    /**
-     * @param int|string $minor
-     * @throws InvalidDataTypeException
-     */
-    private function setMinor($minor)
-    {
-        if (! is_int($minor)) {
-            throw new InvalidDataTypeException(
-                '$minor',
-                $minor,
-                'integer'
-            );
-        }
-        $this->minor = absint($minor);
-    }
-
-
-    /**
-     * @return int
-     */
-    public function patch(): int
-    {
-        return $this->patch;
-    }
-
-
-    /**
-     * @param int|string $patch
-     * @throws InvalidDataTypeException
-     */
-    private function setPatch($patch)
-    {
-        if (! is_int($patch)) {
-            throw new InvalidDataTypeException(
-                '$patch',
-                $patch,
-                'integer'
-            );
-        }
-        $this->patch = absint($patch);
-    }
-
-
-    /**
-     * @return string
-     */
-    public function release(): string
-    {
-        return '';
-    }
-
-
-    /**
-     * @return int
-     */
-    public function build(): int
-    {
-        return $this->build;
-    }
-
-
-    /**
-     * @param int|string $build
-     * @throws InvalidDataTypeException
-     */
-    private function setBuild($build)
-    {
-        if (! is_int($build)) {
-            throw new InvalidDataTypeException(
-                '$build',
-                $build,
-                'integer'
-            );
-        }
-        $this->build = absint($build);
-    }
-
-
-    /**
-     * @param Version $other_version
-     * @return int
-     */
-    public function compare(Version $other_version): int
-    {
-        return version_compare((string) $this, (string) $other_version);
-    }
-
-
-    /**
-     * @param Version $other_version
-     * @return bool
-     */
-    public function equals(Version $other_version): bool
-    {
-        return version_compare((string) $this, (string) $other_version, '==');
-    }
-
-
-    /**
-     * @param Version $other_version
-     * @return bool
-     */
-    public function newerThan(Version $other_version): bool
-    {
-        return version_compare((string) $this, (string) $other_version, '>');
-    }
-
-
-    /**
-     * @param Version $other_version
-     * @return bool
-     */
-    public function olderThan(Version $other_version): bool
-    {
-        return version_compare((string) $this, (string) $other_version, '<');
-    }
-
-
-    /**
-     * @return string
-     */
-    public function __toString()
-    {
-        $version_string = "$this->major.$this->minor.$this->patch";
-        // if the build number is not 0, then append it to the version string
-        $version_string .= $this->build
-            ? '.' . str_pad($this->build, 3, '0', STR_PAD_LEFT)
-            : '';
-        return $version_string;
-    }
+	const RELEASE_TYPE_RC    = 'rc';
+
+	const RELEASE_TYPE_BETA  = 'beta';
+
+	const RELEASE_TYPE_DECAF = 'decaf';
+
+	const RELEASE_TYPE_PROD  = 'p';
+
+
+	private int $major;
+
+	private int $minor;
+
+	private int $patch;
+
+	private int $build;
+
+
+	/**
+	 * Version constructor.
+	 *
+	 * @param int    $major
+	 * @param int    $minor
+	 * @param int    $patch
+	 * @param int|string|null $build_or_release
+	 * @param int|null    $build
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidArgumentException
+	 */
+	public function __construct(
+		int $major,
+		int $minor,
+		int $patch,
+		$build_or_release = 0,
+		?int $build = null
+	) {
+		$this->setMajor($major);
+		$this->setMinor($minor);
+		$this->setPatch($patch);
+		$build = $build ?? $build_or_release;
+		$this->setBuild($build);
+	}
+
+
+	/**
+	 * @param string $version_string
+	 * @return Version
+	 * @throws InvalidArgumentException
+	 */
+	public static function fromString(string $version_string): Version
+	{
+		$version_string = trim($version_string);
+		// compare incoming version string against the lowest possible valid version
+		if (version_compare($version_string, '0.0.1.dev.001', '<')) {
+			throw new InvalidArgumentException(
+				sprintf(
+					esc_html__('"%1$s" is not a valid version string', 'event_espresso'),
+					$version_string
+				)
+			);
+		}
+		// break apart incoming version string
+		$version_parts = explode('.', $version_string);
+		// remove any non-numeric parts
+		$version_parts = array_filter($version_parts, 'is_numeric');
+		// reindex the array so that the keys are sequential
+		$version_parts = array_values($version_parts);
+		// verify that version string at least contains {major}.{minor}.{patch}
+		if (count($version_parts) < 3) {
+			throw new InvalidArgumentException(
+				sprintf(
+					esc_html__(
+						'At minimum, a version string needs to be in a "{major}.{minor}.{patch}" format, therefore "%1$s" is not valid',
+						'event_espresso'
+					),
+					$version_string
+				)
+			);
+		}
+		if (isset($version_parts[4])) {
+			// if there are more than 4 parts, then the version string includes the old "release" part
+			$build = $version_parts[4];
+			$version_parts[3] = $build;
+			unset($version_parts[4]);
+		}
+		// add defaults for missing pieces
+		$version_parts += ['0', '0', '0', '000'];
+		ksort($version_parts, SORT_NUMERIC);
+		$version_parts = array_map('trim', $version_parts);
+		// reassign to individual variables
+		[$major, $minor, $patch, $build] = $version_parts;
+		return new Version(
+			(int) $major,
+			(int) $minor,
+			(int) $patch,
+			(int) $build
+		);
+	}
+
+
+	/**
+	 * @return int
+	 */
+	public function major(): int
+	{
+		return $this->major;
+	}
+
+
+	/**
+	 * @param int|string $major
+	 * @throws InvalidDataTypeException
+	 */
+	private function setMajor($major)
+	{
+		if (! is_int($major)) {
+			throw new InvalidDataTypeException(
+				'$major',
+				$major,
+				'integer'
+			);
+		}
+		$this->major = absint($major);
+	}
+
+
+	/**
+	 * @return int
+	 */
+	public function minor(): int
+	{
+		return $this->minor;
+	}
+
+
+	/**
+	 * @param int|string $minor
+	 * @throws InvalidDataTypeException
+	 */
+	private function setMinor($minor)
+	{
+		if (! is_int($minor)) {
+			throw new InvalidDataTypeException(
+				'$minor',
+				$minor,
+				'integer'
+			);
+		}
+		$this->minor = absint($minor);
+	}
+
+
+	/**
+	 * @return int
+	 */
+	public function patch(): int
+	{
+		return $this->patch;
+	}
+
+
+	/**
+	 * @param int|string $patch
+	 * @throws InvalidDataTypeException
+	 */
+	private function setPatch($patch)
+	{
+		if (! is_int($patch)) {
+			throw new InvalidDataTypeException(
+				'$patch',
+				$patch,
+				'integer'
+			);
+		}
+		$this->patch = absint($patch);
+	}
+
+
+	/**
+	 * @return string
+	 */
+	public function release(): string
+	{
+		return '';
+	}
+
+
+	/**
+	 * @return int
+	 */
+	public function build(): int
+	{
+		return $this->build;
+	}
+
+
+	/**
+	 * @param int|string $build
+	 * @throws InvalidDataTypeException
+	 */
+	private function setBuild($build)
+	{
+		if (! is_int($build)) {
+			throw new InvalidDataTypeException(
+				'$build',
+				$build,
+				'integer'
+			);
+		}
+		$this->build = absint($build);
+	}
+
+
+	/**
+	 * @param Version $other_version
+	 * @return int
+	 */
+	public function compare(Version $other_version): int
+	{
+		return version_compare((string) $this, (string) $other_version);
+	}
+
+
+	/**
+	 * @param Version $other_version
+	 * @return bool
+	 */
+	public function equals(Version $other_version): bool
+	{
+		return version_compare((string) $this, (string) $other_version, '==');
+	}
+
+
+	/**
+	 * @param Version $other_version
+	 * @return bool
+	 */
+	public function newerThan(Version $other_version): bool
+	{
+		return version_compare((string) $this, (string) $other_version, '>');
+	}
+
+
+	/**
+	 * @param Version $other_version
+	 * @return bool
+	 */
+	public function olderThan(Version $other_version): bool
+	{
+		return version_compare((string) $this, (string) $other_version, '<');
+	}
+
+
+	/**
+	 * @return string
+	 */
+	public function __toString()
+	{
+		$version_string = "$this->major.$this->minor.$this->patch";
+		// if the build number is not 0, then append it to the version string
+		$version_string .= $this->build
+			? '.' . str_pad($this->build, 3, '0', STR_PAD_LEFT)
+			: '';
+		return $version_string;
+	}
 }

Spacing +5 added lines, -5 removed lines

@@ -130,7 +130,7 @@ 
      */
     private function setMajor($major)
     {
-        if (! is_int($major)) {
+        if ( ! is_int($major)) {
             throw new InvalidDataTypeException(
                 '$major',
                 $major,
@@ -156,7 +156,7 @@ 
      */
     private function setMinor($minor)
     {
-        if (! is_int($minor)) {
+        if ( ! is_int($minor)) {
             throw new InvalidDataTypeException(
                 '$minor',
                 $minor,
@@ -182,7 +182,7 @@ 
      */
     private function setPatch($patch)
     {
-        if (! is_int($patch)) {
+        if ( ! is_int($patch)) {
             throw new InvalidDataTypeException(
                 '$patch',
                 $patch,
@@ -217,7 +217,7 @@ 
      */
     private function setBuild($build)
     {
-        if (! is_int($build)) {
+        if ( ! is_int($build)) {
             throw new InvalidDataTypeException(
                 '$build',
                 $build,
@@ -276,7 +276,7 @@ 
         $version_string = "$this->major.$this->minor.$this->patch";
         // if the build number is not 0, then append it to the version string
         $version_string .= $this->build
-            ? '.' . str_pad($this->build, 3, '0', STR_PAD_LEFT)
+            ? '.'.str_pad($this->build, 3, '0', STR_PAD_LEFT)
             : '';
         return $version_string;
     }

core/domain/services/admin/menu/AdminMenuManager.php

Indentation +437 added lines, -437 removed lines

@@ -15,441 +15,441 @@
 
 class AdminMenuManager
 {
-    /**
-     * Default: null - defaults to below Comments
-     *
-     * 5 - below Posts
-     * 10 - below Media
-     * 15 - below Links
-     * 20 - below Pages
-     * 25 - below comments
-     * 60 - below first separator
-     * 65 - below Plugins
-     * 70 - below Users
-     * 75 - below Tools
-     * 80 - below Settings
-     * 100 - below second separator
-     */
-    const DEFAULT_MENU_POSITION = 100;
-
-
-    /**
-     * @var AdminMenuItem[]
-     */
-    private array $menu_items = [];
-
-    /**
-     * objects for page_init objects detected and loaded
-     *
-     * @var EE_Admin_Page_Init[]
-     */
-    private array $installed_pages = [];
-
-    /**
-     * set to TRUE if site is currently in maintenance mode level 2
-     *
-     * @var bool
-     */
-    protected bool $maintenance_mode = false;
-
-    /**
-     * same values used by AdminMenuManager::DEFAULT_MENU_POSITION
-     *
-     * @var int
-     */
-    private int $menu_position;
-
-    /**
-     * @var AdminMenuItem
-     */
-    private AdminMenuItem $top_level_menu_item;
-
-
-    public function __construct()
-    {
-    }
-
-
-    public function initialize()
-    {
-        $this->maintenance_mode = MaintenanceStatus::isFullSite();
-        $this->menu_position    = apply_filters(
-            'FHEE__EventEspresso_core_domain_services_admin_menu_AdminMenuManager__initialize__menu_position',
-            AdminMenuManager::DEFAULT_MENU_POSITION,
-            $this->maintenance_mode
-        );
-        $this->addTopLevelMenuItem();
-        $this->initializeMenuGroups();
-        add_action('admin_menu', [$this, 'generateAdminMenu']);
-        add_action('network_admin_menu', [$this, 'generateNetworkAdminMenu']);
-        add_filter('custom_menu_order', '__return_true');
-        add_filter('menu_order', [$this, 'reorderAdminMenu']);
-    }
-
-
-    /**
-     * adds the top level menu item that everything else descends from.
-     * changes depending on whether site is in full maintenance mode or not
-     *
-     * @return void
-     */
-    private function addTopLevelMenuItem()
-    {
-        $this->top_level_menu_item = $this->maintenance_mode
-            ? $this->instantiateAdminMenu(
-                [
-                    'menu_slug'    => AdminMenuTopLevel::MENU_PARENT_MAINTENANCE,
-                    'menu_label'   => esc_html__('Event Espresso', 'event_espresso'),
-                    'capability'   => 'manage_options',
-                    'menu_group'   => AdminMenuGroup::MENU_SLUG_MAIN,
-                    'menu_order'   => 10,
-                    'menu_type'    => AdminMenuItem::TYPE_MENU_TOP,
-                    'parent_slug'  => AdminMenuTopLevel::MENU_PARENT_MAINTENANCE,
-                    'show_on_menu' => AdminMenuItem::DISPLAY_BLOG_ONLY,
-                ]
-            )
-            : $this->instantiateAdminMenu(
-                [
-                    'menu_slug'    => AdminMenuTopLevel::MENU_PARENT_ACTIVE,
-                    'menu_label'   => esc_html__('Event Espresso', 'event_espresso'),
-                    'capability'   => 'ee_read_events',
-                    'menu_group'   => AdminMenuGroup::MENU_SLUG_MAIN,
-                    'menu_order'   => 10,
-                    'menu_type'    => AdminMenuItem::TYPE_MENU_TOP,
-                    'parent_slug'  => AdminMenuTopLevel::MENU_PARENT_ACTIVE,
-                    'show_on_menu' => AdminMenuItem::DISPLAY_BLOG_ONLY,
-                ]
-            );
-    }
-
-
-    /**
-     * sets the filterable _admin_menu_groups property (list of various "groupings" within the EE admin menu array)
-     *
-     * @return void
-     */
-    private function initializeMenuGroups()
-    {
-        $this->menu_items = apply_filters(
-            'FHEE__EE_Admin_Page_Loader___set_menu_groups__admin_menu_groups',
-            [
-                AdminMenuGroup::MENU_SLUG_MAIN       => $this->instantiateAdminMenu(
-                    [
-                        'menu_slug'               => AdminMenuGroup::MENU_SLUG_MAIN,
-                        'menu_label'              => esc_html__('Main', 'event_espresso'),
-                        'capability'              => $this->maintenance_mode ? 'manage_options' : 'ee_read_ee',
-                        'maintenance_mode_parent' => AdminMenuTopLevel::MENU_PARENT_MAINTENANCE,
-                        'menu_order'              => 0,
-                        'parent_slug'             => AdminMenuTopLevel::MENU_PARENT_ACTIVE,
-                        'show_on_menu'            => AdminMenuItem::DISPLAY_NONE,
-                    ]
-                ),
-                AdminMenuGroup::MENU_SLUG_MANAGEMENT => $this->instantiateAdminMenu(
-                    [
-                        'menu_slug'    => AdminMenuGroup::MENU_SLUG_MANAGEMENT,
-                        'menu_label'   => esc_html__('Management', 'event_espresso'),
-                        'capability'   => 'ee_read_ee',
-                        'menu_order'   => 10,
-                        'parent_slug'  => AdminMenuTopLevel::MENU_PARENT_ACTIVE,
-                        'show_on_menu' => AdminMenuItem::DISPLAY_BLOG_ONLY,
-                    ]
-                ),
-                AdminMenuGroup::MENU_SLUG_ADDONS     => $this->instantiateAdminMenu(
-                    [
-                        'menu_slug'    => AdminMenuGroup::MENU_SLUG_ADDONS,
-                        'menu_label'   => esc_html__('Add-ons', 'event_espresso'),
-                        'capability'   => 'ee_read_ee',
-                        'menu_order'   => 20,
-                        'parent_slug'  => AdminMenuTopLevel::MENU_PARENT_ACTIVE,
-                        'show_on_menu' => AdminMenuItem::DISPLAY_BLOG_AND_NETWORK,
-                    ]
-                ),
-                AdminMenuGroup::MENU_SLUG_SETTINGS   => $this->instantiateAdminMenu(
-                    [
-                        'menu_slug'    => AdminMenuGroup::MENU_SLUG_SETTINGS,
-                        'menu_label'   => esc_html__('Settings', 'event_espresso'),
-                        'capability'   => 'ee_read_ee',
-                        'menu_order'   => 30,
-                        'parent_slug'  => AdminMenuTopLevel::MENU_PARENT_ACTIVE,
-                        'show_on_menu' => AdminMenuItem::DISPLAY_BLOG_ONLY,
-                    ]
-                ),
-                AdminMenuGroup::MENU_SLUG_TEMPLATES  => $this->instantiateAdminMenu(
-                    [
-                        'menu_slug'    => AdminMenuGroup::MENU_SLUG_TEMPLATES,
-                        'menu_label'   => esc_html__('Templates', 'event_espresso'),
-                        'capability'   => 'ee_read_ee',
-                        'menu_order'   => 40,
-                        'parent_slug'  => AdminMenuTopLevel::MENU_PARENT_ACTIVE,
-                        'show_on_menu' => AdminMenuItem::DISPLAY_BLOG_ONLY,
-                    ]
-                ),
-                AdminMenuGroup::MENU_SLUG_EXTRAS     => $this->instantiateAdminMenu(
-                    [
-                        'menu_slug'               => AdminMenuGroup::MENU_SLUG_EXTRAS,
-                        'menu_label'              => esc_html__('Extras', 'event_espresso'),
-                        'capability'              => 'ee_read_ee',
-                        'maintenance_mode_parent' => AdminMenuTopLevel::MENU_PARENT_MAINTENANCE,
-                        'menu_order'              => 50,
-                        'parent_slug'             => AdminMenuTopLevel::MENU_PARENT_ACTIVE,
-                        'show_on_menu'            => AdminMenuItem::DISPLAY_BLOG_AND_NETWORK,
-                    ]
-                ),
-                AdminMenuGroup::MENU_SLUG_TOOLS      => $this->instantiateAdminMenu(
-                    [
-                        'menu_slug'    => AdminMenuGroup::MENU_SLUG_TOOLS,
-                        'menu_label'   => esc_html__('Tools', 'event_espresso'),
-                        'capability'   => 'ee_read_ee',
-                        'menu_order'   => 60,
-                        'parent_slug'  => AdminMenuTopLevel::MENU_PARENT_ACTIVE,
-                        'show_on_menu' => AdminMenuItem::DISPLAY_BLOG_ONLY,
-                    ]
-                ),
-            ]
-        );
-    }
-
-
-    /**
-     * adds an AdminMenuItem
-     *
-     * @param AdminMenuItem $admin_menu_item
-     * @return AdminMenuItem
-     */
-    public function addAdminMenuItem(AdminMenuItem $admin_menu_item): AdminMenuItem
-    {
-        // get the menu group that this menu item belongs to and then add it
-        $admin_group = $this->getMenuGroup($admin_menu_item);
-        $admin_group->addMenuItem($admin_menu_item);
-        return $admin_menu_item;
-    }
-
-
-    /**
-     * instantiates and returns the appropriate AdminMenuItem for the provided EE_Admin_Page_Init
-     *
-     * @param EE_Admin_Page_Init $admin_page_init
-     * @return AdminMenuItem
-     */
-    public function getAdminMenu(EE_Admin_Page_Init $admin_page_init): AdminMenuItem
-    {
-        // see if admin page init is using new classes
-        $menu_properties = $admin_page_init->getMenuProperties();
-        if (empty($menu_properties)) {
-            // no? ok then if admin menu doesn't already exist, set up the admin menu item the old way
-            if (! $admin_page_init->adminMenu() instanceof AdminMenuItem) {
-                $admin_page_init->setupLegacyAdminMenuItem();
-            }
-        } else {
-            // adding the admin page init callback here means the menu doesn't have to cart that object around
-            $menu_properties['menu_callback'] = [$admin_page_init, 'initialize_admin_page'];
-            if (! $admin_page_init->adminMenu() instanceof AdminMenuItem) {
-                // if admin menu doesn't already exist, then instantiate a new one
-                $admin_page_init->setAdminMenu($this->instantiateAdminMenu($menu_properties));
-            }
-        }
-        $admin_menu = $admin_page_init->adminMenu();
-        if (! $admin_menu instanceof AdminMenuItem) {
-            throw new DomainException(esc_html__('Invalid AdminMenuItem', 'event_espresso'));
-        }
-        if (! is_callable($admin_menu->menuCallback())) {
-            $admin_menu->setMenuCallback([$admin_page_init, 'initialize_admin_page']);
-        }
-        // get the menu group that this menu item belongs to and then add it
-        $admin_group = $this->getMenuGroup($admin_menu);
-        $admin_group->addMenuItem($admin_menu);
-        return $admin_menu;
-    }
-
-
-    /**
-     * @param array $menu_properties
-     * @return AdminMenuItem|null
-     */
-    private function instantiateAdminMenu(array $menu_properties): ?AdminMenuItem
-    {
-        $type = $menu_properties['menu_type'] ?? AdminMenuItem::TYPE_MENU_GROUP;
-        unset($menu_properties['menu_type']);
-        switch ($type) {
-            case AdminMenuItem::TYPE_MENU_GROUP:
-                unset($menu_properties['menu_callback']);
-                return new AdminMenuGroup($menu_properties);
-            case AdminMenuItem::TYPE_MENU_TOP:
-                return new AdminMenuTopLevel($menu_properties);
-            case AdminMenuItem::TYPE_MENU_SUB_ITEM:
-                return new AdminMenuSubItem($menu_properties);
-        }
-        return null;
-    }
-
-
-    /**
-     * @param AdminMenuItem $admin_menu
-     * @return AdminMenuGroup
-     * @throws DomainException
-     * @throws OutOfRangeException
-     */
-    private function getMenuGroup(AdminMenuItem $admin_menu): AdminMenuGroup
-    {
-        if (! isset($this->menu_items[ $admin_menu->menuGroup() ])) {
-            throw new OutOfRangeException(esc_html__('AdminMenuGroup does not exist', 'event_espresso'));
-        }
-        $admin_group = $this->menu_items[ $admin_menu->menuGroup() ];
-        if (! $admin_group instanceof AdminMenuGroup) {
-            throw new DomainException(esc_html__('Invalid AdminMenuGroup found', 'event_espresso'));
-        }
-        return $admin_group;
-    }
-
-
-    /**
-     * set_network_menus
-     * This method sets up the menus for network EE Admin Pages.
-     * Almost identical to EE_Admin_Page_Loader::set_menus() except pages
-     * are only added to the menu map if they are intended for the admin menu
-     *
-     * @return void
-     * @throws DomainException
-     */
-    public function generateNetworkAdminMenu()
-    {
-        $this->generateAdminMenu(true);
-    }
-
-
-    /**
-     * This method sets up the menus for EE Admin Pages
-     *
-     * @return void
-     * @throws DomainException
-     */
-    public function generateAdminMenu(bool $network_admin = false)
-    {
-        $admin_menu = $this->sortMenu($this->menu_items);
-        $this->top_level_menu_item->registerAdminMenuItem($network_admin);
-        $this->registerAdminMenu($admin_menu, $network_admin);
-    }
-
-
-    /**
-     * @param AdminMenuItem[] $admin_menu
-     * @param bool  $network_admin
-     */
-    private function registerAdminMenu(array $admin_menu, bool $network_admin)
-    {
-        foreach ($admin_menu as $menu_item) {
-            if ($this->skipMenuItem($menu_item)) {
-                continue;
-            }
-            try {
-                $wp_page_slug    = $menu_item->registerAdminMenuItem($network_admin);
-                $admin_init_page = $this->installed_pages[ $menu_item->menuSlug() ] ?? null;
-                if ($wp_page_slug && $admin_init_page instanceof EE_Admin_Page_Init) {
-                    $admin_init_page->setWpPageSlug($wp_page_slug);
-                    $admin_init_page->set_page_dependencies($wp_page_slug);
-                }
-                if ($menu_item instanceof AdminMenuGroup) {
-                    $this->registerAdminMenu($menu_item->getMenuItems(), $network_admin);
-                }
-            } catch (Exception $e) {
-                EE_Error::add_error($e->getMessage(), $e->getFile(), __FUNCTION__, $e->getLine());
-            }
-        }
-    }
-
-
-    /**
-     * returns TRUE if any of the following conditions is met:
-     * - menu item is NOT an instanceof AdminMenuItem
-     * - menu item has already been registered
-     * - menu item should not be shown when site is in full maintenance mode
-     * - current user does not have the required access permission
-     * - menu item is a group but has no sub items
-     *
-     * @param AdminMenuItem|null $menu_item
-     * @return bool
-     */
-    private function skipMenuItem(?AdminMenuItem $menu_item): bool
-    {
-        return ! $menu_item instanceof AdminMenuItem
-            || $menu_item->isRegistered()
-            || ! $menu_item->showOnMaintenanceModeMenu()
-            || ! $menu_item->currentUserHasAccess()
-            || (
-                $menu_item instanceof AdminMenuGroup
-                && $menu_item->hasNoMenuItems()
-            );
-    }
-
-
-    /**
-     * @param EE_Admin_Page_Init[] $installed_pages
-     */
-    public function setInstalledPages(array $installed_pages): void
-    {
-        $this->installed_pages = $installed_pages;
-    }
-
-
-    /**
-     * Recursively sort menu groups and their sub items
-     *
-     * @return AdminMenuItem[]
-     * @throws DomainException
-     */
-    public function sortMenu(array $admin_menu): array
-    {
-        foreach ($admin_menu as $menu_group) {
-            if (! $menu_group instanceof AdminMenuItem) {
-                throw new DomainException(esc_html__('Invalid AdminMenuItem', 'event_espresso'));
-            }
-            if ($menu_group instanceof AdminMenuGroup) {
-                // sort sub items
-                $menu_items = $this->sortMenu($menu_group->getMenuItems());
-                $menu_group->setMenuItems($menu_items);
-            }
-        }
-        // sort incoming array AFTER it's been looped through and elements have been validated
-        usort($admin_menu, [$this, 'sortMenuItems']);
-        return $admin_menu;
-    }
-
-
-    /**
-     *  sort sub menu items
-     *
-     * @param AdminMenuItem $a menu_item
-     * @param AdminMenuItem $b being compared to
-     * @return int    sort order
-     */
-    private function sortMenuItems(AdminMenuItem $a, AdminMenuItem $b): int
-    {
-        if ($a->menuOrder() === $b->menuOrder()) {
-            return 0;
-        }
-        return $a->menuOrder() < $b->menuOrder() ? -1 : 1;
-    }
-
-
-    /**
-     * Moves the Event Espresso admin menu to the position set by $this->menu_position
-     *
-     * @param array $menu_order
-     * @return array
-     */
-    public function reorderAdminMenu(array $menu_order): array
-    {
-        $menu_slug     = $this->maintenance_mode
-            ? AdminMenuTopLevel::MENU_PARENT_MAINTENANCE
-            : AdminMenuTopLevel::MENU_PARENT_ACTIVE;
-        $current_index = array_search($menu_slug, $menu_order);
-        if ($current_index === false) {
-            return $menu_order;
-        }
-        // chop out the espresso admin menu if found
-        $espresso_menu = array_splice($menu_order, $current_index, 1);
-        // reinsert at position set by $this->menu_position
-        array_splice($menu_order, $this->menu_position, 0, $espresso_menu);
-        return $menu_order;
-    }
+	/**
+	 * Default: null - defaults to below Comments
+	 *
+	 * 5 - below Posts
+	 * 10 - below Media
+	 * 15 - below Links
+	 * 20 - below Pages
+	 * 25 - below comments
+	 * 60 - below first separator
+	 * 65 - below Plugins
+	 * 70 - below Users
+	 * 75 - below Tools
+	 * 80 - below Settings
+	 * 100 - below second separator
+	 */
+	const DEFAULT_MENU_POSITION = 100;
+
+
+	/**
+	 * @var AdminMenuItem[]
+	 */
+	private array $menu_items = [];
+
+	/**
+	 * objects for page_init objects detected and loaded
+	 *
+	 * @var EE_Admin_Page_Init[]
+	 */
+	private array $installed_pages = [];
+
+	/**
+	 * set to TRUE if site is currently in maintenance mode level 2
+	 *
+	 * @var bool
+	 */
+	protected bool $maintenance_mode = false;
+
+	/**
+	 * same values used by AdminMenuManager::DEFAULT_MENU_POSITION
+	 *
+	 * @var int
+	 */
+	private int $menu_position;
+
+	/**
+	 * @var AdminMenuItem
+	 */
+	private AdminMenuItem $top_level_menu_item;
+
+
+	public function __construct()
+	{
+	}
+
+
+	public function initialize()
+	{
+		$this->maintenance_mode = MaintenanceStatus::isFullSite();
+		$this->menu_position    = apply_filters(
+			'FHEE__EventEspresso_core_domain_services_admin_menu_AdminMenuManager__initialize__menu_position',
+			AdminMenuManager::DEFAULT_MENU_POSITION,
+			$this->maintenance_mode
+		);
+		$this->addTopLevelMenuItem();
+		$this->initializeMenuGroups();
+		add_action('admin_menu', [$this, 'generateAdminMenu']);
+		add_action('network_admin_menu', [$this, 'generateNetworkAdminMenu']);
+		add_filter('custom_menu_order', '__return_true');
+		add_filter('menu_order', [$this, 'reorderAdminMenu']);
+	}
+
+
+	/**
+	 * adds the top level menu item that everything else descends from.
+	 * changes depending on whether site is in full maintenance mode or not
+	 *
+	 * @return void
+	 */
+	private function addTopLevelMenuItem()
+	{
+		$this->top_level_menu_item = $this->maintenance_mode
+			? $this->instantiateAdminMenu(
+				[
+					'menu_slug'    => AdminMenuTopLevel::MENU_PARENT_MAINTENANCE,
+					'menu_label'   => esc_html__('Event Espresso', 'event_espresso'),
+					'capability'   => 'manage_options',
+					'menu_group'   => AdminMenuGroup::MENU_SLUG_MAIN,
+					'menu_order'   => 10,
+					'menu_type'    => AdminMenuItem::TYPE_MENU_TOP,
+					'parent_slug'  => AdminMenuTopLevel::MENU_PARENT_MAINTENANCE,
+					'show_on_menu' => AdminMenuItem::DISPLAY_BLOG_ONLY,
+				]
+			)
+			: $this->instantiateAdminMenu(
+				[
+					'menu_slug'    => AdminMenuTopLevel::MENU_PARENT_ACTIVE,
+					'menu_label'   => esc_html__('Event Espresso', 'event_espresso'),
+					'capability'   => 'ee_read_events',
+					'menu_group'   => AdminMenuGroup::MENU_SLUG_MAIN,
+					'menu_order'   => 10,
+					'menu_type'    => AdminMenuItem::TYPE_MENU_TOP,
+					'parent_slug'  => AdminMenuTopLevel::MENU_PARENT_ACTIVE,
+					'show_on_menu' => AdminMenuItem::DISPLAY_BLOG_ONLY,
+				]
+			);
+	}
+
+
+	/**
+	 * sets the filterable _admin_menu_groups property (list of various "groupings" within the EE admin menu array)
+	 *
+	 * @return void
+	 */
+	private function initializeMenuGroups()
+	{
+		$this->menu_items = apply_filters(
+			'FHEE__EE_Admin_Page_Loader___set_menu_groups__admin_menu_groups',
+			[
+				AdminMenuGroup::MENU_SLUG_MAIN       => $this->instantiateAdminMenu(
+					[
+						'menu_slug'               => AdminMenuGroup::MENU_SLUG_MAIN,
+						'menu_label'              => esc_html__('Main', 'event_espresso'),
+						'capability'              => $this->maintenance_mode ? 'manage_options' : 'ee_read_ee',
+						'maintenance_mode_parent' => AdminMenuTopLevel::MENU_PARENT_MAINTENANCE,
+						'menu_order'              => 0,
+						'parent_slug'             => AdminMenuTopLevel::MENU_PARENT_ACTIVE,
+						'show_on_menu'            => AdminMenuItem::DISPLAY_NONE,
+					]
+				),
+				AdminMenuGroup::MENU_SLUG_MANAGEMENT => $this->instantiateAdminMenu(
+					[
+						'menu_slug'    => AdminMenuGroup::MENU_SLUG_MANAGEMENT,
+						'menu_label'   => esc_html__('Management', 'event_espresso'),
+						'capability'   => 'ee_read_ee',
+						'menu_order'   => 10,
+						'parent_slug'  => AdminMenuTopLevel::MENU_PARENT_ACTIVE,
+						'show_on_menu' => AdminMenuItem::DISPLAY_BLOG_ONLY,
+					]
+				),
+				AdminMenuGroup::MENU_SLUG_ADDONS     => $this->instantiateAdminMenu(
+					[
+						'menu_slug'    => AdminMenuGroup::MENU_SLUG_ADDONS,
+						'menu_label'   => esc_html__('Add-ons', 'event_espresso'),
+						'capability'   => 'ee_read_ee',
+						'menu_order'   => 20,
+						'parent_slug'  => AdminMenuTopLevel::MENU_PARENT_ACTIVE,
+						'show_on_menu' => AdminMenuItem::DISPLAY_BLOG_AND_NETWORK,
+					]
+				),
+				AdminMenuGroup::MENU_SLUG_SETTINGS   => $this->instantiateAdminMenu(
+					[
+						'menu_slug'    => AdminMenuGroup::MENU_SLUG_SETTINGS,
+						'menu_label'   => esc_html__('Settings', 'event_espresso'),
+						'capability'   => 'ee_read_ee',
+						'menu_order'   => 30,
+						'parent_slug'  => AdminMenuTopLevel::MENU_PARENT_ACTIVE,
+						'show_on_menu' => AdminMenuItem::DISPLAY_BLOG_ONLY,
+					]
+				),
+				AdminMenuGroup::MENU_SLUG_TEMPLATES  => $this->instantiateAdminMenu(
+					[
+						'menu_slug'    => AdminMenuGroup::MENU_SLUG_TEMPLATES,
+						'menu_label'   => esc_html__('Templates', 'event_espresso'),
+						'capability'   => 'ee_read_ee',
+						'menu_order'   => 40,
+						'parent_slug'  => AdminMenuTopLevel::MENU_PARENT_ACTIVE,
+						'show_on_menu' => AdminMenuItem::DISPLAY_BLOG_ONLY,
+					]
+				),
+				AdminMenuGroup::MENU_SLUG_EXTRAS     => $this->instantiateAdminMenu(
+					[
+						'menu_slug'               => AdminMenuGroup::MENU_SLUG_EXTRAS,
+						'menu_label'              => esc_html__('Extras', 'event_espresso'),
+						'capability'              => 'ee_read_ee',
+						'maintenance_mode_parent' => AdminMenuTopLevel::MENU_PARENT_MAINTENANCE,
+						'menu_order'              => 50,
+						'parent_slug'             => AdminMenuTopLevel::MENU_PARENT_ACTIVE,
+						'show_on_menu'            => AdminMenuItem::DISPLAY_BLOG_AND_NETWORK,
+					]
+				),
+				AdminMenuGroup::MENU_SLUG_TOOLS      => $this->instantiateAdminMenu(
+					[
+						'menu_slug'    => AdminMenuGroup::MENU_SLUG_TOOLS,
+						'menu_label'   => esc_html__('Tools', 'event_espresso'),
+						'capability'   => 'ee_read_ee',
+						'menu_order'   => 60,
+						'parent_slug'  => AdminMenuTopLevel::MENU_PARENT_ACTIVE,
+						'show_on_menu' => AdminMenuItem::DISPLAY_BLOG_ONLY,
+					]
+				),
+			]
+		);
+	}
+
+
+	/**
+	 * adds an AdminMenuItem
+	 *
+	 * @param AdminMenuItem $admin_menu_item
+	 * @return AdminMenuItem
+	 */
+	public function addAdminMenuItem(AdminMenuItem $admin_menu_item): AdminMenuItem
+	{
+		// get the menu group that this menu item belongs to and then add it
+		$admin_group = $this->getMenuGroup($admin_menu_item);
+		$admin_group->addMenuItem($admin_menu_item);
+		return $admin_menu_item;
+	}
+
+
+	/**
+	 * instantiates and returns the appropriate AdminMenuItem for the provided EE_Admin_Page_Init
+	 *
+	 * @param EE_Admin_Page_Init $admin_page_init
+	 * @return AdminMenuItem
+	 */
+	public function getAdminMenu(EE_Admin_Page_Init $admin_page_init): AdminMenuItem
+	{
+		// see if admin page init is using new classes
+		$menu_properties = $admin_page_init->getMenuProperties();
+		if (empty($menu_properties)) {
+			// no? ok then if admin menu doesn't already exist, set up the admin menu item the old way
+			if (! $admin_page_init->adminMenu() instanceof AdminMenuItem) {
+				$admin_page_init->setupLegacyAdminMenuItem();
+			}
+		} else {
+			// adding the admin page init callback here means the menu doesn't have to cart that object around
+			$menu_properties['menu_callback'] = [$admin_page_init, 'initialize_admin_page'];
+			if (! $admin_page_init->adminMenu() instanceof AdminMenuItem) {
+				// if admin menu doesn't already exist, then instantiate a new one
+				$admin_page_init->setAdminMenu($this->instantiateAdminMenu($menu_properties));
+			}
+		}
+		$admin_menu = $admin_page_init->adminMenu();
+		if (! $admin_menu instanceof AdminMenuItem) {
+			throw new DomainException(esc_html__('Invalid AdminMenuItem', 'event_espresso'));
+		}
+		if (! is_callable($admin_menu->menuCallback())) {
+			$admin_menu->setMenuCallback([$admin_page_init, 'initialize_admin_page']);
+		}
+		// get the menu group that this menu item belongs to and then add it
+		$admin_group = $this->getMenuGroup($admin_menu);
+		$admin_group->addMenuItem($admin_menu);
+		return $admin_menu;
+	}
+
+
+	/**
+	 * @param array $menu_properties
+	 * @return AdminMenuItem|null
+	 */
+	private function instantiateAdminMenu(array $menu_properties): ?AdminMenuItem
+	{
+		$type = $menu_properties['menu_type'] ?? AdminMenuItem::TYPE_MENU_GROUP;
+		unset($menu_properties['menu_type']);
+		switch ($type) {
+			case AdminMenuItem::TYPE_MENU_GROUP:
+				unset($menu_properties['menu_callback']);
+				return new AdminMenuGroup($menu_properties);
+			case AdminMenuItem::TYPE_MENU_TOP:
+				return new AdminMenuTopLevel($menu_properties);
+			case AdminMenuItem::TYPE_MENU_SUB_ITEM:
+				return new AdminMenuSubItem($menu_properties);
+		}
+		return null;
+	}
+
+
+	/**
+	 * @param AdminMenuItem $admin_menu
+	 * @return AdminMenuGroup
+	 * @throws DomainException
+	 * @throws OutOfRangeException
+	 */
+	private function getMenuGroup(AdminMenuItem $admin_menu): AdminMenuGroup
+	{
+		if (! isset($this->menu_items[ $admin_menu->menuGroup() ])) {
+			throw new OutOfRangeException(esc_html__('AdminMenuGroup does not exist', 'event_espresso'));
+		}
+		$admin_group = $this->menu_items[ $admin_menu->menuGroup() ];
+		if (! $admin_group instanceof AdminMenuGroup) {
+			throw new DomainException(esc_html__('Invalid AdminMenuGroup found', 'event_espresso'));
+		}
+		return $admin_group;
+	}
+
+
+	/**
+	 * set_network_menus
+	 * This method sets up the menus for network EE Admin Pages.
+	 * Almost identical to EE_Admin_Page_Loader::set_menus() except pages
+	 * are only added to the menu map if they are intended for the admin menu
+	 *
+	 * @return void
+	 * @throws DomainException
+	 */
+	public function generateNetworkAdminMenu()
+	{
+		$this->generateAdminMenu(true);
+	}
+
+
+	/**
+	 * This method sets up the menus for EE Admin Pages
+	 *
+	 * @return void
+	 * @throws DomainException
+	 */
+	public function generateAdminMenu(bool $network_admin = false)
+	{
+		$admin_menu = $this->sortMenu($this->menu_items);
+		$this->top_level_menu_item->registerAdminMenuItem($network_admin);
+		$this->registerAdminMenu($admin_menu, $network_admin);
+	}
+
+
+	/**
+	 * @param AdminMenuItem[] $admin_menu
+	 * @param bool  $network_admin
+	 */
+	private function registerAdminMenu(array $admin_menu, bool $network_admin)
+	{
+		foreach ($admin_menu as $menu_item) {
+			if ($this->skipMenuItem($menu_item)) {
+				continue;
+			}
+			try {
+				$wp_page_slug    = $menu_item->registerAdminMenuItem($network_admin);
+				$admin_init_page = $this->installed_pages[ $menu_item->menuSlug() ] ?? null;
+				if ($wp_page_slug && $admin_init_page instanceof EE_Admin_Page_Init) {
+					$admin_init_page->setWpPageSlug($wp_page_slug);
+					$admin_init_page->set_page_dependencies($wp_page_slug);
+				}
+				if ($menu_item instanceof AdminMenuGroup) {
+					$this->registerAdminMenu($menu_item->getMenuItems(), $network_admin);
+				}
+			} catch (Exception $e) {
+				EE_Error::add_error($e->getMessage(), $e->getFile(), __FUNCTION__, $e->getLine());
+			}
+		}
+	}
+
+
+	/**
+	 * returns TRUE if any of the following conditions is met:
+	 * - menu item is NOT an instanceof AdminMenuItem
+	 * - menu item has already been registered
+	 * - menu item should not be shown when site is in full maintenance mode
+	 * - current user does not have the required access permission
+	 * - menu item is a group but has no sub items
+	 *
+	 * @param AdminMenuItem|null $menu_item
+	 * @return bool
+	 */
+	private function skipMenuItem(?AdminMenuItem $menu_item): bool
+	{
+		return ! $menu_item instanceof AdminMenuItem
+			|| $menu_item->isRegistered()
+			|| ! $menu_item->showOnMaintenanceModeMenu()
+			|| ! $menu_item->currentUserHasAccess()
+			|| (
+				$menu_item instanceof AdminMenuGroup
+				&& $menu_item->hasNoMenuItems()
+			);
+	}
+
+
+	/**
+	 * @param EE_Admin_Page_Init[] $installed_pages
+	 */
+	public function setInstalledPages(array $installed_pages): void
+	{
+		$this->installed_pages = $installed_pages;
+	}
+
+
+	/**
+	 * Recursively sort menu groups and their sub items
+	 *
+	 * @return AdminMenuItem[]
+	 * @throws DomainException
+	 */
+	public function sortMenu(array $admin_menu): array
+	{
+		foreach ($admin_menu as $menu_group) {
+			if (! $menu_group instanceof AdminMenuItem) {
+				throw new DomainException(esc_html__('Invalid AdminMenuItem', 'event_espresso'));
+			}
+			if ($menu_group instanceof AdminMenuGroup) {
+				// sort sub items
+				$menu_items = $this->sortMenu($menu_group->getMenuItems());
+				$menu_group->setMenuItems($menu_items);
+			}
+		}
+		// sort incoming array AFTER it's been looped through and elements have been validated
+		usort($admin_menu, [$this, 'sortMenuItems']);
+		return $admin_menu;
+	}
+
+
+	/**
+	 *  sort sub menu items
+	 *
+	 * @param AdminMenuItem $a menu_item
+	 * @param AdminMenuItem $b being compared to
+	 * @return int    sort order
+	 */
+	private function sortMenuItems(AdminMenuItem $a, AdminMenuItem $b): int
+	{
+		if ($a->menuOrder() === $b->menuOrder()) {
+			return 0;
+		}
+		return $a->menuOrder() < $b->menuOrder() ? -1 : 1;
+	}
+
+
+	/**
+	 * Moves the Event Espresso admin menu to the position set by $this->menu_position
+	 *
+	 * @param array $menu_order
+	 * @return array
+	 */
+	public function reorderAdminMenu(array $menu_order): array
+	{
+		$menu_slug     = $this->maintenance_mode
+			? AdminMenuTopLevel::MENU_PARENT_MAINTENANCE
+			: AdminMenuTopLevel::MENU_PARENT_ACTIVE;
+		$current_index = array_search($menu_slug, $menu_order);
+		if ($current_index === false) {
+			return $menu_order;
+		}
+		// chop out the espresso admin menu if found
+		$espresso_menu = array_splice($menu_order, $current_index, 1);
+		// reinsert at position set by $this->menu_position
+		array_splice($menu_order, $this->menu_position, 0, $espresso_menu);
+		return $menu_order;
+	}
 }

Spacing +9 added lines, -9 removed lines

@@ -237,22 +237,22 @@ 
         $menu_properties = $admin_page_init->getMenuProperties();
         if (empty($menu_properties)) {
             // no? ok then if admin menu doesn't already exist, set up the admin menu item the old way
-            if (! $admin_page_init->adminMenu() instanceof AdminMenuItem) {
+            if ( ! $admin_page_init->adminMenu() instanceof AdminMenuItem) {
                 $admin_page_init->setupLegacyAdminMenuItem();
             }
         } else {
             // adding the admin page init callback here means the menu doesn't have to cart that object around
             $menu_properties['menu_callback'] = [$admin_page_init, 'initialize_admin_page'];
-            if (! $admin_page_init->adminMenu() instanceof AdminMenuItem) {
+            if ( ! $admin_page_init->adminMenu() instanceof AdminMenuItem) {
                 // if admin menu doesn't already exist, then instantiate a new one
                 $admin_page_init->setAdminMenu($this->instantiateAdminMenu($menu_properties));
             }
         }
         $admin_menu = $admin_page_init->adminMenu();
-        if (! $admin_menu instanceof AdminMenuItem) {
+        if ( ! $admin_menu instanceof AdminMenuItem) {
             throw new DomainException(esc_html__('Invalid AdminMenuItem', 'event_espresso'));
         }
-        if (! is_callable($admin_menu->menuCallback())) {
+        if ( ! is_callable($admin_menu->menuCallback())) {
             $admin_menu->setMenuCallback([$admin_page_init, 'initialize_admin_page']);
         }
         // get the menu group that this menu item belongs to and then add it
@@ -291,11 +291,11 @@ 
      */
     private function getMenuGroup(AdminMenuItem $admin_menu): AdminMenuGroup
     {
-        if (! isset($this->menu_items[ $admin_menu->menuGroup() ])) {
+        if ( ! isset($this->menu_items[$admin_menu->menuGroup()])) {
             throw new OutOfRangeException(esc_html__('AdminMenuGroup does not exist', 'event_espresso'));
         }
-        $admin_group = $this->menu_items[ $admin_menu->menuGroup() ];
-        if (! $admin_group instanceof AdminMenuGroup) {
+        $admin_group = $this->menu_items[$admin_menu->menuGroup()];
+        if ( ! $admin_group instanceof AdminMenuGroup) {
             throw new DomainException(esc_html__('Invalid AdminMenuGroup found', 'event_espresso'));
         }
         return $admin_group;
@@ -343,7 +343,7 @@ 
             }
             try {
                 $wp_page_slug    = $menu_item->registerAdminMenuItem($network_admin);
-                $admin_init_page = $this->installed_pages[ $menu_item->menuSlug() ] ?? null;
+                $admin_init_page = $this->installed_pages[$menu_item->menuSlug()] ?? null;
                 if ($wp_page_slug && $admin_init_page instanceof EE_Admin_Page_Init) {
                     $admin_init_page->setWpPageSlug($wp_page_slug);
                     $admin_init_page->set_page_dependencies($wp_page_slug);
@@ -400,7 +400,7 @@ 
     public function sortMenu(array $admin_menu): array
     {
         foreach ($admin_menu as $menu_group) {
-            if (! $menu_group instanceof AdminMenuItem) {
+            if ( ! $menu_group instanceof AdminMenuItem) {
                 throw new DomainException(esc_html__('Invalid AdminMenuItem', 'event_espresso'));
             }
             if ($menu_group instanceof AdminMenuGroup) {