eventespresso / event-espresso-core

core/db_models/EEM_WP_User.model.php

Spacing +3 added lines, -3 removed lines

@@ -112,10 +112,10 @@
         ];
         $this->_wp_core_model = true;
         $this->_caps_slug = 'users';
-        $this->_cap_contexts_to_cap_action_map[ EEM_Base::caps_read ] = 'list';
-        $this->_cap_contexts_to_cap_action_map[ EEM_Base::caps_read_admin ] = 'list';
+        $this->_cap_contexts_to_cap_action_map[EEM_Base::caps_read] = 'list';
+        $this->_cap_contexts_to_cap_action_map[EEM_Base::caps_read_admin] = 'list';
         foreach ($this->_cap_contexts_to_cap_action_map as $context => $action) {
-            $this->_cap_restriction_generators[ $context ] = new EE_Restriction_Generator_WP_User();
+            $this->_cap_restriction_generators[$context] = new EE_Restriction_Generator_WP_User();
         }
         // @todo: account for create_users controls whether they can create users at all
         parent::__construct($timezone);

Indentation +123 added lines, -123 removed lines

@@ -12,133 +12,133 @@
  */
 class EEM_WP_User extends EEM_Base
 {
-    /**
-     * private instance of the EEM_WP_User object
-     *
-     * @type EEM_WP_User
-     */
-    protected static $_instance;
+	/**
+	 * private instance of the EEM_WP_User object
+	 *
+	 * @type EEM_WP_User
+	 */
+	protected static $_instance;
 
 
-    /**
-     *    constructor
-     *
-     * @param null              $timezone
-     * @param ModelFieldFactory $model_field_factory
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     */
-    protected function __construct($timezone, ModelFieldFactory $model_field_factory)
-    {
-        $this->singular_item = esc_html__('WP_User', 'event_espresso');
-        $this->plural_item = esc_html__('WP_Users', 'event_espresso');
-        global $wpdb;
-        $this->_tables = array(
-            'WP_User' => new EE_Primary_Table($wpdb->users, 'ID', true),
-        );
-        $this->_fields = array(
-            'WP_User' => array(
-                'ID'                  => $model_field_factory->createPrimaryKeyIntField(
-                    'ID',
-                    esc_html__('WP_User ID', 'event_espresso')
-                ),
-                'user_login'          => $model_field_factory->createPlainTextField(
-                    'user_login',
-                    esc_html__('User Login', 'event_espresso'),
-                    false
-                ),
-                'user_pass'           => $model_field_factory->createPlainTextField(
-                    'user_pass',
-                    esc_html__('User Password', 'event_espresso'),
-                    false
-                ),
-                'user_nicename'       => $model_field_factory->createPlainTextField(
-                    'user_nicename',
-                    esc_html__(' User Nice Name', 'event_espresso'),
-                    false
-                ),
-                'user_email'          => $model_field_factory->createEmailField(
-                    'user_email',
-                    esc_html__('User Email', 'event_espresso'),
-                    false,
-                    null
-                ),
-                'user_registered'     => $model_field_factory->createDatetimeField(
-                    'user_registered',
-                    esc_html__('Date User Registered', 'event_espresso'),
-                    $timezone
-                ),
-                'user_activation_key' => $model_field_factory->createPlainTextField(
-                    'user_activation_key',
-                    esc_html__('User Activation Key', 'event_espresso'),
-                    false
-                ),
-                'user_status'         => $model_field_factory->createIntegerField(
-                    'user_status',
-                    esc_html__('User Status', 'event_espresso')
-                ),
-                'display_name'        => $model_field_factory->createPlainTextField(
-                    'display_name',
-                    esc_html__('Display Name', 'event_espresso'),
-                    false
-                ),
-            ),
-        );
-        $this->_model_relations = array(
-            'Attendee'       => new EE_Has_Many_Relation(),
-            // all models are related to the change log
-            // 'Change_Log'     => new EE_Has_Many_Relation(),
-            'Event'          => new EE_Has_Many_Relation(),
-            'Message'        => new EE_Has_Many_Relation(),
-            'Payment_Method' => new EE_Has_Many_Relation(),
-            'Price'          => new EE_Has_Many_Relation(),
-            'Price_Type'     => new EE_Has_Many_Relation(),
-            'Question'       => new EE_Has_Many_Relation(),
-            'Question_Group' => new EE_Has_Many_Relation(),
-            'Ticket'         => new EE_Has_Many_Relation(),
-            'Venue'          => new EE_Has_Many_Relation(),
-        );
-        $this->foreign_key_aliases = [
-            'Event.EVT_wp_user'          => 'WP_User.ID',
-            'Payment_Method.PMD_wp_user' => 'WP_User.ID',
-            'Price.PRC_wp_user'          => 'WP_User.ID',
-            'Price_Type.PRT_wp_user'     => 'WP_User.ID',
-            'Question.QST_wp_user'       => 'WP_User.ID',
-            'Question_Group.QSG_wp_user' => 'WP_User.ID',
-            'Ticket.VNU_wp_user'         => 'WP_User.ID',
-            'Venue.TKT_wp_user'          => 'WP_User.ID',
-        ];
-        $this->_wp_core_model = true;
-        $this->_caps_slug = 'users';
-        $this->_cap_contexts_to_cap_action_map[ EEM_Base::caps_read ] = 'list';
-        $this->_cap_contexts_to_cap_action_map[ EEM_Base::caps_read_admin ] = 'list';
-        foreach ($this->_cap_contexts_to_cap_action_map as $context => $action) {
-            $this->_cap_restriction_generators[ $context ] = new EE_Restriction_Generator_WP_User();
-        }
-        // @todo: account for create_users controls whether they can create users at all
-        parent::__construct($timezone);
-    }
+	/**
+	 *    constructor
+	 *
+	 * @param null              $timezone
+	 * @param ModelFieldFactory $model_field_factory
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 */
+	protected function __construct($timezone, ModelFieldFactory $model_field_factory)
+	{
+		$this->singular_item = esc_html__('WP_User', 'event_espresso');
+		$this->plural_item = esc_html__('WP_Users', 'event_espresso');
+		global $wpdb;
+		$this->_tables = array(
+			'WP_User' => new EE_Primary_Table($wpdb->users, 'ID', true),
+		);
+		$this->_fields = array(
+			'WP_User' => array(
+				'ID'                  => $model_field_factory->createPrimaryKeyIntField(
+					'ID',
+					esc_html__('WP_User ID', 'event_espresso')
+				),
+				'user_login'          => $model_field_factory->createPlainTextField(
+					'user_login',
+					esc_html__('User Login', 'event_espresso'),
+					false
+				),
+				'user_pass'           => $model_field_factory->createPlainTextField(
+					'user_pass',
+					esc_html__('User Password', 'event_espresso'),
+					false
+				),
+				'user_nicename'       => $model_field_factory->createPlainTextField(
+					'user_nicename',
+					esc_html__(' User Nice Name', 'event_espresso'),
+					false
+				),
+				'user_email'          => $model_field_factory->createEmailField(
+					'user_email',
+					esc_html__('User Email', 'event_espresso'),
+					false,
+					null
+				),
+				'user_registered'     => $model_field_factory->createDatetimeField(
+					'user_registered',
+					esc_html__('Date User Registered', 'event_espresso'),
+					$timezone
+				),
+				'user_activation_key' => $model_field_factory->createPlainTextField(
+					'user_activation_key',
+					esc_html__('User Activation Key', 'event_espresso'),
+					false
+				),
+				'user_status'         => $model_field_factory->createIntegerField(
+					'user_status',
+					esc_html__('User Status', 'event_espresso')
+				),
+				'display_name'        => $model_field_factory->createPlainTextField(
+					'display_name',
+					esc_html__('Display Name', 'event_espresso'),
+					false
+				),
+			),
+		);
+		$this->_model_relations = array(
+			'Attendee'       => new EE_Has_Many_Relation(),
+			// all models are related to the change log
+			// 'Change_Log'     => new EE_Has_Many_Relation(),
+			'Event'          => new EE_Has_Many_Relation(),
+			'Message'        => new EE_Has_Many_Relation(),
+			'Payment_Method' => new EE_Has_Many_Relation(),
+			'Price'          => new EE_Has_Many_Relation(),
+			'Price_Type'     => new EE_Has_Many_Relation(),
+			'Question'       => new EE_Has_Many_Relation(),
+			'Question_Group' => new EE_Has_Many_Relation(),
+			'Ticket'         => new EE_Has_Many_Relation(),
+			'Venue'          => new EE_Has_Many_Relation(),
+		);
+		$this->foreign_key_aliases = [
+			'Event.EVT_wp_user'          => 'WP_User.ID',
+			'Payment_Method.PMD_wp_user' => 'WP_User.ID',
+			'Price.PRC_wp_user'          => 'WP_User.ID',
+			'Price_Type.PRT_wp_user'     => 'WP_User.ID',
+			'Question.QST_wp_user'       => 'WP_User.ID',
+			'Question_Group.QSG_wp_user' => 'WP_User.ID',
+			'Ticket.VNU_wp_user'         => 'WP_User.ID',
+			'Venue.TKT_wp_user'          => 'WP_User.ID',
+		];
+		$this->_wp_core_model = true;
+		$this->_caps_slug = 'users';
+		$this->_cap_contexts_to_cap_action_map[ EEM_Base::caps_read ] = 'list';
+		$this->_cap_contexts_to_cap_action_map[ EEM_Base::caps_read_admin ] = 'list';
+		foreach ($this->_cap_contexts_to_cap_action_map as $context => $action) {
+			$this->_cap_restriction_generators[ $context ] = new EE_Restriction_Generator_WP_User();
+		}
+		// @todo: account for create_users controls whether they can create users at all
+		parent::__construct($timezone);
+	}
 
 
-    /**
-     * We don't need a foreign key to the WP_User model, we just need its primary key
-     *
-     * @return string
-     * @throws EE_Error
-     */
-    public function wp_user_field_name()
-    {
-        return $this->primary_key_name();
-    }
+	/**
+	 * We don't need a foreign key to the WP_User model, we just need its primary key
+	 *
+	 * @return string
+	 * @throws EE_Error
+	 */
+	public function wp_user_field_name()
+	{
+		return $this->primary_key_name();
+	}
 
 
-    /**
-     * This WP_User model IS owned, even though it doesn't have a foreign key to itself
-     *
-     * @return boolean
-     */
-    public function is_owned()
-    {
-        return true;
-    }
+	/**
+	 * This WP_User model IS owned, even though it doesn't have a foreign key to itself
+	 *
+	 * @return boolean
+	 */
+	public function is_owned()
+	{
+		return true;
+	}
 }

core/db_models/EEM_Payment_Method.model.php

Spacing +6 added lines, -6 removed lines

@@ -170,7 +170,7 @@ 
     public function is_valid_scope($scope)
     {
         $scopes = $this->scopes();
-        if (isset($scopes[ $scope ])) {
+        if (isset($scopes[$scope])) {
             return true;
         }
         return false;
@@ -187,7 +187,7 @@ 
      */
     public function get_all_active($scope = null, $query_params = [])
     {
-        if (! isset($query_params['order_by']) && ! isset($query_params['order'])) {
+        if ( ! isset($query_params['order_by']) && ! isset($query_params['order'])) {
             $query_params['order_by'] = ['PMD_order' => 'ASC', 'PMD_ID' => 'ASC'];
         }
         return $this->get_all($this->_get_query_params_for_all_active($scope, $query_params));
@@ -235,7 +235,7 @@ 
         $count = 0;
         foreach ($this->scopes() as $scope_name => $desc) {
             $count++;
-            $acceptable_scopes[ 'PMD_scope*' . $count ] = ['LIKE', '%' . $scope_name . '%'];
+            $acceptable_scopes['PMD_scope*'.$count] = ['LIKE', '%'.$scope_name.'%'];
         }
         return array_replace_recursive([['OR*active_scope' => $acceptable_scopes]], $query_params);
     }
@@ -391,7 +391,7 @@ 
         $usable_payment_methods = [];
         foreach ($payment_methods as $key => $payment_method) {
             if (EE_Payment_Method_Manager::instance()->payment_method_type_exists($payment_method->type())) {
-                $usable_payment_methods[ $key ] = $payment_method;
+                $usable_payment_methods[$key] = $payment_method;
                 // some payment methods enqueue their scripts in EE_PMT_*::__construct
                 // which is kinda a no-no (just because it's being constructed doesn't mean we need to enqueue
                 // its scripts). but for backwards-compat we should continue to do that
@@ -405,7 +405,7 @@ 
                     $payment_method
                 );
                 new PersistentAdminNotice(
-                    'auto-deactivated-' . $payment_method->type(),
+                    'auto-deactivated-'.$payment_method->type(),
                     sprintf(
                         esc_html__(
                             'The payment method %1$s was automatically deactivated because it appears its associated Event Espresso Addon was recently deactivated.%2$sIt can be reactivated on the %3$sPlugins admin page%4$s, then you can reactivate the payment method.',
@@ -413,7 +413,7 @@ 
                         ),
                         $payment_method->admin_name(),
                         '<br />',
-                        '<a href="' . admin_url('plugins.php') . '">',
+                        '<a href="'.admin_url('plugins.php').'">',
                         '</a>'
                     ),
                     true

Indentation +452 added lines, -452 removed lines

@@ -16,456 +16,456 @@
  */
 class EEM_Payment_Method extends EEM_Base
 {
-    const scope_cart = 'CART';
-
-    const scope_admin = 'ADMIN';
-
-    const scope_api = 'API';
-
-    /**
-     * @type EEM_Payment_Method
-     */
-    protected static $_instance = null;
-
-
-    /**
-     * private constructor to prevent direct creation
-     *
-     * @param null $timezone
-     * @throws EE_Error
-     */
-    protected function __construct($timezone = null)
-    {
-        $this->singular_item = esc_html__('Payment Method', 'event_espresso');
-        $this->plural_item = esc_html__('Payment Methods', 'event_espresso');
-        $this->_tables = [
-            'Payment_Method' => new EE_Primary_Table('esp_payment_method', 'PMD_ID'),
-        ];
-        $this->_fields = [
-            'Payment_Method' => [
-                'PMD_ID'              => new EE_Primary_Key_Int_Field(
-                    'PMD_ID',
-                    esc_html__('ID', 'event_espresso')
-                ),
-                'PMD_type'            => new EE_Plain_Text_Field(
-                    'PMD_type',
-                    esc_html__('Payment Method Type', 'event_espresso'),
-                    false,
-                    'Admin_Only'
-                ),
-                'PMD_name'            => new EE_Plain_Text_Field(
-                    'PMD_name',
-                    esc_html__('Name', 'event_espresso'),
-                    false
-                ),
-                'PMD_desc'            => new EE_Post_Content_Field(
-                    'PMD_desc',
-                    esc_html__('Description', 'event_espresso'),
-                    false,
-                    ''
-                ),
-                'PMD_admin_name'      => new EE_Plain_Text_Field(
-                    'PMD_admin_name',
-                    esc_html__('Admin-Only Name', 'event_espresso'),
-                    true
-                ),
-                'PMD_admin_desc'      => new EE_Post_Content_Field(
-                    'PMD_admin_desc',
-                    esc_html__('Admin-Only Description', 'event_espresso'),
-                    true
-                ),
-                'PMD_slug'            => new EE_Slug_Field(
-                    'PMD_slug',
-                    esc_html__('Slug', 'event_espresso'),
-                    false
-                ),
-                'PMD_order'           => new EE_Integer_Field(
-                    'PMD_order',
-                    esc_html__('Order', 'event_espresso'),
-                    false,
-                    0
-                ),
-                'PMD_debug_mode'      => new EE_Boolean_Field(
-                    'PMD_debug_mode',
-                    esc_html__('Debug Mode On?', 'event_espresso'),
-                    false,
-                    false
-                ),
-                'PMD_wp_user'         => new EE_WP_User_Field(
-                    'PMD_wp_user',
-                    esc_html__('Payment Method Creator ID', 'event_espresso'),
-                    false
-                ),
-                'PMD_open_by_default' => new EE_Boolean_Field(
-                    'PMD_open_by_default',
-                    esc_html__('Open by Default?', 'event_espresso'),
-                    false,
-                    false
-                ),
-                'PMD_button_url'      => new EE_Plain_Text_Field(
-                    'PMD_button_url',
-                    esc_html__('Button URL', 'event_espresso'),
-                    true,
-                    ''
-                ),
-                'PMD_scope'           => new EE_Serialized_Text_Field(
-                    'PMD_scope',
-                    esc_html__('Usable From?', 'event_espresso'),
-                    false,
-                    []// possible values currently are 'CART','ADMIN','API'
-                ),
-            ],
-        ];
-        $this->_model_relations = [
-            'Payment'     => new EE_Has_Many_Relation(),
-            'Currency'    => new EE_HABTM_Relation('Currency_Payment_Method'),
-            'Transaction' => new EE_Has_Many_Relation(),
-            'WP_User'     => new EE_Belongs_To_Relation(),
-        ];
-        parent::__construct($timezone);
-    }
-
-
-    /**
-     * Gets one by the slug provided
-     *
-     * @param string $slug
-     * @return EE_Base_Class|EE_Payment_Method|EE_Soft_Delete_Base_Class|NULL
-     * @throws EE_Error
-     */
-    public function get_one_by_slug($slug)
-    {
-        return $this->get_one([['PMD_slug' => $slug]]);
-    }
-
-
-    /**
-     * Gets all the acceptable scopes for payment methods.
-     * Keys are their names as store din the DB, and values are nice names for displaying them
-     *
-     * @return array
-     */
-    public function scopes()
-    {
-        return apply_filters(
-            'FHEE__EEM_Payment_Method__scopes',
-            [
-                EEM_Payment_Method::scope_cart  => esc_html__('Front-end Registration Page', 'event_espresso'),
-                EEM_Payment_Method::scope_admin => esc_html__(
-                    'Admin Registration Page (no online processing)',
-                    'event_espresso'
-                ),
-            ]
-        );
-    }
-
-
-    /**
-     * Determines if this is an valid scope
-     *
-     * @param string $scope like one of EEM_Payment_Method::instance()->scopes()
-     * @return boolean
-     */
-    public function is_valid_scope($scope)
-    {
-        $scopes = $this->scopes();
-        if (isset($scopes[ $scope ])) {
-            return true;
-        }
-        return false;
-    }
-
-
-    /**
-     * Gets all active payment methods
-     *
-     * @param string $scope one of
-     * @param array  $query_params
-     * @return EE_Base_Class[]|EE_Payment_Method[]
-     * @throws EE_Error
-     */
-    public function get_all_active($scope = null, $query_params = [])
-    {
-        if (! isset($query_params['order_by']) && ! isset($query_params['order'])) {
-            $query_params['order_by'] = ['PMD_order' => 'ASC', 'PMD_ID' => 'ASC'];
-        }
-        return $this->get_all($this->_get_query_params_for_all_active($scope, $query_params));
-    }
-
-
-    /**
-     * Counts all active gateways in the specified scope
-     *
-     * @param string $scope one of EEM_Payment_Method::scope_*
-     * @param array  $query_params
-     * @return int
-     * @throws EE_Error
-     */
-    public function count_active($scope = null, $query_params = [])
-    {
-        return $this->count($this->_get_query_params_for_all_active($scope, $query_params));
-    }
-
-
-    /**
-     * Creates the $query_params that can be passed into any EEM_Payment_Method as their $query_params
-     * argument to get all active for a given scope
-     *
-     * @param string $scope one of the constants EEM_Payment_Method::scope_*
-     * @param array  $query_params
-     * @return array
-     * @throws EE_Error
-     * @see https://github.com/eventespresso/event-espresso-core/tree/master/docs/G--Model-System/model-query-params.md
-     */
-    protected function _get_query_params_for_all_active($scope = null, $query_params = [])
-    {
-        if ($scope) {
-            if ($this->is_valid_scope($scope)) {
-                return array_replace_recursive([['PMD_scope' => ['LIKE', "%$scope%"]]], $query_params);
-            }
-            throw new EE_Error(
-                sprintf(
-                    esc_html__("'%s' is not a valid scope for a payment method", 'event_espresso'),
-                    $scope
-                )
-            );
-        }
-        $acceptable_scopes = [];
-        $count = 0;
-        foreach ($this->scopes() as $scope_name => $desc) {
-            $count++;
-            $acceptable_scopes[ 'PMD_scope*' . $count ] = ['LIKE', '%' . $scope_name . '%'];
-        }
-        return array_replace_recursive([['OR*active_scope' => $acceptable_scopes]], $query_params);
-    }
-
-
-    /**
-     * Creates the $query_params that can be passed into any EEM_Payment_Method as their $query_params
-     * argument to get all active for a given scope
-     *
-     * @param string $scope one of the constants EEM_Payment_Method::scope_*
-     * @param array  $query_params
-     * @return array
-     * @throws EE_Error
-     * @see https://github.com/eventespresso/event-espresso-core/tree/master/docs/G--Model-System/model-query-params.md
-     */
-    public function get_query_params_for_all_active($scope = null, $query_params = [])
-    {
-        return $this->_get_query_params_for_all_active($scope, $query_params);
-    }
-
-
-    /**
-     * Gets one active payment method. see @get_all_active for documentation
-     *
-     * @param string $scope
-     * @param array  $query_params
-     * @return EE_Base_Class|EE_Payment_Method|EE_Soft_Delete_Base_Class|NULL
-     * @throws EE_Error
-     */
-    public function get_one_active($scope = null, $query_params = [])
-    {
-        return $this->get_one($this->_get_query_params_for_all_active($scope, $query_params));
-    }
-
-
-    /**
-     * Gets one payment method of that type, regardless of whether its active or not
-     *
-     * @param string $type
-     * @return EE_Base_Class|EE_Payment_Method|EE_Soft_Delete_Base_Class|NULL
-     * @throws EE_Error
-     */
-    public function get_one_of_type($type)
-    {
-        return $this->get_one([['PMD_type' => $type]]);
-    }
-
-
-    /**
-     * Overrides parent ot also check by the slug
-     *
-     * @param string|int|EE_Payment_Method $base_class_obj_or_id
-     * @param boolean                      $ensure_is_in_db
-     * @return EE_Base_Class|EE_Payment_Method|EE_Soft_Delete_Base_Class|int|string
-     * @throws EE_Error
-     * @see EEM_Base::ensure_is_obj()
-     */
-    public function ensure_is_obj($base_class_obj_or_id, $ensure_is_in_db = false)
-    {
-        // first: check if it's a slug
-        if (is_string($base_class_obj_or_id)) {
-            $obj = $this->get_one_by_slug($base_class_obj_or_id);
-            if ($obj) {
-                return $obj;
-            }
-        }
-        // ok so it wasn't a slug we were passed. try the usual then (ie, it's an object or an ID)
-        try {
-            return parent::ensure_is_obj($base_class_obj_or_id, $ensure_is_in_db);
-        } catch (EE_Error $e) {
-            // handle it outside the catch
-        }
-        throw new EE_Error(
-            sprintf(
-                esc_html__("'%s' is neither a Payment Method ID, slug, nor object.", 'event_espresso'),
-                $base_class_obj_or_id
-            )
-        );
-    }
-
-
-    /**
-     * Gets the ID of this object, or if its a string finds the object's id
-     * associated with that slug
-     *
-     * @param mixed $base_obj_or_id_or_slug
-     * @return int
-     * @throws EE_Error
-     */
-    public function ensure_is_ID($base_obj_or_id_or_slug)
-    {
-        if (is_string($base_obj_or_id_or_slug)) {
-            // assume it's a slug
-            $base_obj_or_id_or_slug = $this->get_one_by_slug($base_obj_or_id_or_slug);
-        }
-        return parent::ensure_is_ID($base_obj_or_id_or_slug);
-    }
-
-
-    /**
-     * Verifies the button urls on all the passed payment methods have a valid button url.
-     * If not, resets them to their default.
-     *
-     * @param EE_Payment_Method[] $payment_methods if NULL, defaults to all payment methods active in the cart
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    public function verify_button_urls($payment_methods = null)
-    {
-        $payment_methods = is_array($payment_methods)
-            ? $payment_methods
-            : $this->get_all_active(EEM_Payment_Method::scope_cart);
-        foreach ($payment_methods as $payment_method) {
-            try {
-                // If there is really no button URL at all, or if the button URLs still point to decaf folder even
-                // though this is a caffeinated install, reset it to the default.
-                $current_button_url = $payment_method->button_url();
-                if (
-                    empty($current_button_url)
-                    || (
-                        strpos($current_button_url, 'decaf') !== false
-                        && strpos($payment_method->type_obj()->default_button_url(), 'decaf') === false
-                    )
-                ) {
-                    $payment_method->save(
-                        [
-                            'PMD_button_url' => $payment_method->type_obj()->default_button_url(),
-                        ]
-                    );
-                }
-            } catch (EE_Error $e) {
-                $payment_method->deactivate();
-            }
-        }
-    }
-
-
-    /**
-     * Overrides parent to not only turn wpdb results into EE_Payment_Method objects,
-     * but also verifies the payment method type of each is a usable object. If not,
-     * deactivate it, sets a notification, and deactivates it
-     *
-     * @param array $rows
-     * @return EE_Payment_Method[]
-     * @throws EE_Error
-     * @throws InvalidDataTypeException
-     * @throws ReflectionException
-     */
-    protected function _create_objects($rows = [])
-    {
-        EE_Registry::instance()->load_lib('Payment_Method_Manager');
-        $payment_methods = parent::_create_objects($rows);
-        /* @var $payment_methods EE_Payment_Method[] */
-        $usable_payment_methods = [];
-        foreach ($payment_methods as $key => $payment_method) {
-            if (EE_Payment_Method_Manager::instance()->payment_method_type_exists($payment_method->type())) {
-                $usable_payment_methods[ $key ] = $payment_method;
-                // some payment methods enqueue their scripts in EE_PMT_*::__construct
-                // which is kinda a no-no (just because it's being constructed doesn't mean we need to enqueue
-                // its scripts). but for backwards-compat we should continue to do that
-                $payment_method->type_obj();
-            } elseif ($payment_method->active()) {
-                // only deactivate and notify the admin if the payment is active somewhere
-                $payment_method->deactivate();
-                $payment_method->save();
-                do_action(
-                    'AHEE__EEM_Payment_Method___create_objects_auto_deactivated_payment_method',
-                    $payment_method
-                );
-                new PersistentAdminNotice(
-                    'auto-deactivated-' . $payment_method->type(),
-                    sprintf(
-                        esc_html__(
-                            'The payment method %1$s was automatically deactivated because it appears its associated Event Espresso Addon was recently deactivated.%2$sIt can be reactivated on the %3$sPlugins admin page%4$s, then you can reactivate the payment method.',
-                            'event_espresso'
-                        ),
-                        $payment_method->admin_name(),
-                        '<br />',
-                        '<a href="' . admin_url('plugins.php') . '">',
-                        '</a>'
-                    ),
-                    true
-                );
-            }
-        }
-        return $usable_payment_methods;
-    }
-
-
-    /**
-     * Gets all the payment methods which can be used for transaction
-     * (according to the relations between payment methods and events, and
-     * the currencies used for the transaction and their relation to payment methods)
-     *
-     * @param EE_Transaction $transaction
-     * @param string         $scope @see EEM_Payment_Method::get_all_for_events
-     * @return EE_Payment_Method[]
-     * @throws EE_Error
-     */
-    public function get_all_for_transaction($transaction, $scope)
-    {
-        // give addons a chance to override what payment methods are chosen based on the transaction
-        return apply_filters(
-            'FHEE__EEM_Payment_Method__get_all_for_transaction__payment_methods',
-            $this->get_all_active($scope, ['group_by' => 'PMD_type']),
-            $transaction,
-            $scope
-        );
-    }
-
-
-    /**
-     * Returns the payment method used for the last payment made for a registration.
-     * Note: if an offline payment method was selected on the related transaction then this will have no payment
-     * methods returned. It will ONLY return a payment method for a PAYMENT recorded against the registration.
-     *
-     * @param EE_Registration|int $registration_or_reg_id Either the EE_Registration object or the id for the
-     *                                                    registration.
-     * @return EE_Payment|null
-     * @throws EE_Error
-     */
-    public function get_last_used_for_registration($registration_or_reg_id)
-    {
-        $registration_id = EEM_Registration::instance()->ensure_is_ID($registration_or_reg_id);
-
-        $query_params = [
-            0          => [
-                'Payment.Registration.REG_ID' => $registration_id,
-            ],
-            'order_by' => ['Payment.PAY_ID' => 'DESC'],
-        ];
-        return $this->get_one($query_params);
-    }
+	const scope_cart = 'CART';
+
+	const scope_admin = 'ADMIN';
+
+	const scope_api = 'API';
+
+	/**
+	 * @type EEM_Payment_Method
+	 */
+	protected static $_instance = null;
+
+
+	/**
+	 * private constructor to prevent direct creation
+	 *
+	 * @param null $timezone
+	 * @throws EE_Error
+	 */
+	protected function __construct($timezone = null)
+	{
+		$this->singular_item = esc_html__('Payment Method', 'event_espresso');
+		$this->plural_item = esc_html__('Payment Methods', 'event_espresso');
+		$this->_tables = [
+			'Payment_Method' => new EE_Primary_Table('esp_payment_method', 'PMD_ID'),
+		];
+		$this->_fields = [
+			'Payment_Method' => [
+				'PMD_ID'              => new EE_Primary_Key_Int_Field(
+					'PMD_ID',
+					esc_html__('ID', 'event_espresso')
+				),
+				'PMD_type'            => new EE_Plain_Text_Field(
+					'PMD_type',
+					esc_html__('Payment Method Type', 'event_espresso'),
+					false,
+					'Admin_Only'
+				),
+				'PMD_name'            => new EE_Plain_Text_Field(
+					'PMD_name',
+					esc_html__('Name', 'event_espresso'),
+					false
+				),
+				'PMD_desc'            => new EE_Post_Content_Field(
+					'PMD_desc',
+					esc_html__('Description', 'event_espresso'),
+					false,
+					''
+				),
+				'PMD_admin_name'      => new EE_Plain_Text_Field(
+					'PMD_admin_name',
+					esc_html__('Admin-Only Name', 'event_espresso'),
+					true
+				),
+				'PMD_admin_desc'      => new EE_Post_Content_Field(
+					'PMD_admin_desc',
+					esc_html__('Admin-Only Description', 'event_espresso'),
+					true
+				),
+				'PMD_slug'            => new EE_Slug_Field(
+					'PMD_slug',
+					esc_html__('Slug', 'event_espresso'),
+					false
+				),
+				'PMD_order'           => new EE_Integer_Field(
+					'PMD_order',
+					esc_html__('Order', 'event_espresso'),
+					false,
+					0
+				),
+				'PMD_debug_mode'      => new EE_Boolean_Field(
+					'PMD_debug_mode',
+					esc_html__('Debug Mode On?', 'event_espresso'),
+					false,
+					false
+				),
+				'PMD_wp_user'         => new EE_WP_User_Field(
+					'PMD_wp_user',
+					esc_html__('Payment Method Creator ID', 'event_espresso'),
+					false
+				),
+				'PMD_open_by_default' => new EE_Boolean_Field(
+					'PMD_open_by_default',
+					esc_html__('Open by Default?', 'event_espresso'),
+					false,
+					false
+				),
+				'PMD_button_url'      => new EE_Plain_Text_Field(
+					'PMD_button_url',
+					esc_html__('Button URL', 'event_espresso'),
+					true,
+					''
+				),
+				'PMD_scope'           => new EE_Serialized_Text_Field(
+					'PMD_scope',
+					esc_html__('Usable From?', 'event_espresso'),
+					false,
+					[]// possible values currently are 'CART','ADMIN','API'
+				),
+			],
+		];
+		$this->_model_relations = [
+			'Payment'     => new EE_Has_Many_Relation(),
+			'Currency'    => new EE_HABTM_Relation('Currency_Payment_Method'),
+			'Transaction' => new EE_Has_Many_Relation(),
+			'WP_User'     => new EE_Belongs_To_Relation(),
+		];
+		parent::__construct($timezone);
+	}
+
+
+	/**
+	 * Gets one by the slug provided
+	 *
+	 * @param string $slug
+	 * @return EE_Base_Class|EE_Payment_Method|EE_Soft_Delete_Base_Class|NULL
+	 * @throws EE_Error
+	 */
+	public function get_one_by_slug($slug)
+	{
+		return $this->get_one([['PMD_slug' => $slug]]);
+	}
+
+
+	/**
+	 * Gets all the acceptable scopes for payment methods.
+	 * Keys are their names as store din the DB, and values are nice names for displaying them
+	 *
+	 * @return array
+	 */
+	public function scopes()
+	{
+		return apply_filters(
+			'FHEE__EEM_Payment_Method__scopes',
+			[
+				EEM_Payment_Method::scope_cart  => esc_html__('Front-end Registration Page', 'event_espresso'),
+				EEM_Payment_Method::scope_admin => esc_html__(
+					'Admin Registration Page (no online processing)',
+					'event_espresso'
+				),
+			]
+		);
+	}
+
+
+	/**
+	 * Determines if this is an valid scope
+	 *
+	 * @param string $scope like one of EEM_Payment_Method::instance()->scopes()
+	 * @return boolean
+	 */
+	public function is_valid_scope($scope)
+	{
+		$scopes = $this->scopes();
+		if (isset($scopes[ $scope ])) {
+			return true;
+		}
+		return false;
+	}
+
+
+	/**
+	 * Gets all active payment methods
+	 *
+	 * @param string $scope one of
+	 * @param array  $query_params
+	 * @return EE_Base_Class[]|EE_Payment_Method[]
+	 * @throws EE_Error
+	 */
+	public function get_all_active($scope = null, $query_params = [])
+	{
+		if (! isset($query_params['order_by']) && ! isset($query_params['order'])) {
+			$query_params['order_by'] = ['PMD_order' => 'ASC', 'PMD_ID' => 'ASC'];
+		}
+		return $this->get_all($this->_get_query_params_for_all_active($scope, $query_params));
+	}
+
+
+	/**
+	 * Counts all active gateways in the specified scope
+	 *
+	 * @param string $scope one of EEM_Payment_Method::scope_*
+	 * @param array  $query_params
+	 * @return int
+	 * @throws EE_Error
+	 */
+	public function count_active($scope = null, $query_params = [])
+	{
+		return $this->count($this->_get_query_params_for_all_active($scope, $query_params));
+	}
+
+
+	/**
+	 * Creates the $query_params that can be passed into any EEM_Payment_Method as their $query_params
+	 * argument to get all active for a given scope
+	 *
+	 * @param string $scope one of the constants EEM_Payment_Method::scope_*
+	 * @param array  $query_params
+	 * @return array
+	 * @throws EE_Error
+	 * @see https://github.com/eventespresso/event-espresso-core/tree/master/docs/G--Model-System/model-query-params.md
+	 */
+	protected function _get_query_params_for_all_active($scope = null, $query_params = [])
+	{
+		if ($scope) {
+			if ($this->is_valid_scope($scope)) {
+				return array_replace_recursive([['PMD_scope' => ['LIKE', "%$scope%"]]], $query_params);
+			}
+			throw new EE_Error(
+				sprintf(
+					esc_html__("'%s' is not a valid scope for a payment method", 'event_espresso'),
+					$scope
+				)
+			);
+		}
+		$acceptable_scopes = [];
+		$count = 0;
+		foreach ($this->scopes() as $scope_name => $desc) {
+			$count++;
+			$acceptable_scopes[ 'PMD_scope*' . $count ] = ['LIKE', '%' . $scope_name . '%'];
+		}
+		return array_replace_recursive([['OR*active_scope' => $acceptable_scopes]], $query_params);
+	}
+
+
+	/**
+	 * Creates the $query_params that can be passed into any EEM_Payment_Method as their $query_params
+	 * argument to get all active for a given scope
+	 *
+	 * @param string $scope one of the constants EEM_Payment_Method::scope_*
+	 * @param array  $query_params
+	 * @return array
+	 * @throws EE_Error
+	 * @see https://github.com/eventespresso/event-espresso-core/tree/master/docs/G--Model-System/model-query-params.md
+	 */
+	public function get_query_params_for_all_active($scope = null, $query_params = [])
+	{
+		return $this->_get_query_params_for_all_active($scope, $query_params);
+	}
+
+
+	/**
+	 * Gets one active payment method. see @get_all_active for documentation
+	 *
+	 * @param string $scope
+	 * @param array  $query_params
+	 * @return EE_Base_Class|EE_Payment_Method|EE_Soft_Delete_Base_Class|NULL
+	 * @throws EE_Error
+	 */
+	public function get_one_active($scope = null, $query_params = [])
+	{
+		return $this->get_one($this->_get_query_params_for_all_active($scope, $query_params));
+	}
+
+
+	/**
+	 * Gets one payment method of that type, regardless of whether its active or not
+	 *
+	 * @param string $type
+	 * @return EE_Base_Class|EE_Payment_Method|EE_Soft_Delete_Base_Class|NULL
+	 * @throws EE_Error
+	 */
+	public function get_one_of_type($type)
+	{
+		return $this->get_one([['PMD_type' => $type]]);
+	}
+
+
+	/**
+	 * Overrides parent ot also check by the slug
+	 *
+	 * @param string|int|EE_Payment_Method $base_class_obj_or_id
+	 * @param boolean                      $ensure_is_in_db
+	 * @return EE_Base_Class|EE_Payment_Method|EE_Soft_Delete_Base_Class|int|string
+	 * @throws EE_Error
+	 * @see EEM_Base::ensure_is_obj()
+	 */
+	public function ensure_is_obj($base_class_obj_or_id, $ensure_is_in_db = false)
+	{
+		// first: check if it's a slug
+		if (is_string($base_class_obj_or_id)) {
+			$obj = $this->get_one_by_slug($base_class_obj_or_id);
+			if ($obj) {
+				return $obj;
+			}
+		}
+		// ok so it wasn't a slug we were passed. try the usual then (ie, it's an object or an ID)
+		try {
+			return parent::ensure_is_obj($base_class_obj_or_id, $ensure_is_in_db);
+		} catch (EE_Error $e) {
+			// handle it outside the catch
+		}
+		throw new EE_Error(
+			sprintf(
+				esc_html__("'%s' is neither a Payment Method ID, slug, nor object.", 'event_espresso'),
+				$base_class_obj_or_id
+			)
+		);
+	}
+
+
+	/**
+	 * Gets the ID of this object, or if its a string finds the object's id
+	 * associated with that slug
+	 *
+	 * @param mixed $base_obj_or_id_or_slug
+	 * @return int
+	 * @throws EE_Error
+	 */
+	public function ensure_is_ID($base_obj_or_id_or_slug)
+	{
+		if (is_string($base_obj_or_id_or_slug)) {
+			// assume it's a slug
+			$base_obj_or_id_or_slug = $this->get_one_by_slug($base_obj_or_id_or_slug);
+		}
+		return parent::ensure_is_ID($base_obj_or_id_or_slug);
+	}
+
+
+	/**
+	 * Verifies the button urls on all the passed payment methods have a valid button url.
+	 * If not, resets them to their default.
+	 *
+	 * @param EE_Payment_Method[] $payment_methods if NULL, defaults to all payment methods active in the cart
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	public function verify_button_urls($payment_methods = null)
+	{
+		$payment_methods = is_array($payment_methods)
+			? $payment_methods
+			: $this->get_all_active(EEM_Payment_Method::scope_cart);
+		foreach ($payment_methods as $payment_method) {
+			try {
+				// If there is really no button URL at all, or if the button URLs still point to decaf folder even
+				// though this is a caffeinated install, reset it to the default.
+				$current_button_url = $payment_method->button_url();
+				if (
+					empty($current_button_url)
+					|| (
+						strpos($current_button_url, 'decaf') !== false
+						&& strpos($payment_method->type_obj()->default_button_url(), 'decaf') === false
+					)
+				) {
+					$payment_method->save(
+						[
+							'PMD_button_url' => $payment_method->type_obj()->default_button_url(),
+						]
+					);
+				}
+			} catch (EE_Error $e) {
+				$payment_method->deactivate();
+			}
+		}
+	}
+
+
+	/**
+	 * Overrides parent to not only turn wpdb results into EE_Payment_Method objects,
+	 * but also verifies the payment method type of each is a usable object. If not,
+	 * deactivate it, sets a notification, and deactivates it
+	 *
+	 * @param array $rows
+	 * @return EE_Payment_Method[]
+	 * @throws EE_Error
+	 * @throws InvalidDataTypeException
+	 * @throws ReflectionException
+	 */
+	protected function _create_objects($rows = [])
+	{
+		EE_Registry::instance()->load_lib('Payment_Method_Manager');
+		$payment_methods = parent::_create_objects($rows);
+		/* @var $payment_methods EE_Payment_Method[] */
+		$usable_payment_methods = [];
+		foreach ($payment_methods as $key => $payment_method) {
+			if (EE_Payment_Method_Manager::instance()->payment_method_type_exists($payment_method->type())) {
+				$usable_payment_methods[ $key ] = $payment_method;
+				// some payment methods enqueue their scripts in EE_PMT_*::__construct
+				// which is kinda a no-no (just because it's being constructed doesn't mean we need to enqueue
+				// its scripts). but for backwards-compat we should continue to do that
+				$payment_method->type_obj();
+			} elseif ($payment_method->active()) {
+				// only deactivate and notify the admin if the payment is active somewhere
+				$payment_method->deactivate();
+				$payment_method->save();
+				do_action(
+					'AHEE__EEM_Payment_Method___create_objects_auto_deactivated_payment_method',
+					$payment_method
+				);
+				new PersistentAdminNotice(
+					'auto-deactivated-' . $payment_method->type(),
+					sprintf(
+						esc_html__(
+							'The payment method %1$s was automatically deactivated because it appears its associated Event Espresso Addon was recently deactivated.%2$sIt can be reactivated on the %3$sPlugins admin page%4$s, then you can reactivate the payment method.',
+							'event_espresso'
+						),
+						$payment_method->admin_name(),
+						'<br />',
+						'<a href="' . admin_url('plugins.php') . '">',
+						'</a>'
+					),
+					true
+				);
+			}
+		}
+		return $usable_payment_methods;
+	}
+
+
+	/**
+	 * Gets all the payment methods which can be used for transaction
+	 * (according to the relations between payment methods and events, and
+	 * the currencies used for the transaction and their relation to payment methods)
+	 *
+	 * @param EE_Transaction $transaction
+	 * @param string         $scope @see EEM_Payment_Method::get_all_for_events
+	 * @return EE_Payment_Method[]
+	 * @throws EE_Error
+	 */
+	public function get_all_for_transaction($transaction, $scope)
+	{
+		// give addons a chance to override what payment methods are chosen based on the transaction
+		return apply_filters(
+			'FHEE__EEM_Payment_Method__get_all_for_transaction__payment_methods',
+			$this->get_all_active($scope, ['group_by' => 'PMD_type']),
+			$transaction,
+			$scope
+		);
+	}
+
+
+	/**
+	 * Returns the payment method used for the last payment made for a registration.
+	 * Note: if an offline payment method was selected on the related transaction then this will have no payment
+	 * methods returned. It will ONLY return a payment method for a PAYMENT recorded against the registration.
+	 *
+	 * @param EE_Registration|int $registration_or_reg_id Either the EE_Registration object or the id for the
+	 *                                                    registration.
+	 * @return EE_Payment|null
+	 * @throws EE_Error
+	 */
+	public function get_last_used_for_registration($registration_or_reg_id)
+	{
+		$registration_id = EEM_Registration::instance()->ensure_is_ID($registration_or_reg_id);
+
+		$query_params = [
+			0          => [
+				'Payment.Registration.REG_ID' => $registration_id,
+			],
+			'order_by' => ['Payment.PAY_ID' => 'DESC'],
+		];
+		return $this->get_one($query_params);
+	}
 }

core/db_models/EEM_Event_Message_Template.model.php

Spacing +6 added lines, -6 removed lines

@@ -57,16 +57,16 @@ 
             'Message_Template_Group' => new EE_Belongs_To_Relation(),
         ];
         $path_to_event = 'Event';
-        $this->_cap_restriction_generators[ EEM_Base::caps_read ] = new EE_Restriction_Generator_Event_Related_Public(
+        $this->_cap_restriction_generators[EEM_Base::caps_read] = new EE_Restriction_Generator_Event_Related_Public(
             $path_to_event
         );
-        $this->_cap_restriction_generators[ EEM_Base::caps_read_admin ] = new EE_Restriction_Generator_Event_Related_Protected(
+        $this->_cap_restriction_generators[EEM_Base::caps_read_admin] = new EE_Restriction_Generator_Event_Related_Protected(
             $path_to_event
         );
-        $this->_cap_restriction_generators[ EEM_Base::caps_edit ] = new EE_Restriction_Generator_Event_Related_Protected(
+        $this->_cap_restriction_generators[EEM_Base::caps_edit] = new EE_Restriction_Generator_Event_Related_Protected(
             $path_to_event
         );
-        $this->_cap_restriction_generators[ EEM_Base::caps_delete ] = new EE_Restriction_Generator_Event_Related_Protected(
+        $this->_cap_restriction_generators[EEM_Base::caps_delete] = new EE_Restriction_Generator_Event_Related_Protected(
             $path_to_event,
             EEM_Base::caps_edit
         );
@@ -115,10 +115,10 @@ 
         }
 
         $where = [];
-        if (! empty($GRP_IDs)) {
+        if ( ! empty($GRP_IDs)) {
             $where['GRP_ID'] = ['IN', (array) $GRP_IDs];
         }
-        if (! empty($EVT_IDs)) {
+        if ( ! empty($EVT_IDs)) {
             $where['EVT_ID'] = ['IN', (array) $EVT_IDs];
         }
 

Indentation +103 added lines, -103 removed lines

@@ -11,116 +11,116 @@
  */
 class EEM_Event_Message_Template extends EEM_Base
 {
-    // private instance of the EEM_Event_Message_Template object
-    protected static $_instance = null;
+	// private instance of the EEM_Event_Message_Template object
+	protected static $_instance = null;
 
 
-    /**
-     * protected constructor to prevent direct creation
-     *
-     * @param null $timezone
-     * @throws EE_Error
-     */
-    protected function __construct($timezone = null)
-    {
-        $this->singular_item = esc_html__('Event Message Template', 'event_espresso');
-        $this->plural_item = esc_html__('Event Message Templates', 'event_espresso');
+	/**
+	 * protected constructor to prevent direct creation
+	 *
+	 * @param null $timezone
+	 * @throws EE_Error
+	 */
+	protected function __construct($timezone = null)
+	{
+		$this->singular_item = esc_html__('Event Message Template', 'event_espresso');
+		$this->plural_item = esc_html__('Event Message Templates', 'event_espresso');
 
-        $this->_tables = [
-            'Event_Message_Template' => new EE_Primary_Table('esp_event_message_template', 'EMT_ID'),
-        ];
-        $this->_fields = [
-            'Event_Message_Template' => [
-                'EMT_ID' => new EE_Primary_Key_Int_Field(
-                    'EMT_ID',
-                    esc_html__('Event Message Template ID', 'event_espresso')
-                ),
-                'EVT_ID' => new EE_Foreign_Key_Int_Field(
-                    'EVT_ID',
-                    esc_html__('The ID to the Event', 'event_espresso'),
-                    false,
-                    0,
-                    'Event'
-                ),
-                'GRP_ID' => new EE_Foreign_Key_Int_Field(
-                    'GRP_ID',
-                    esc_html__('The ID to the Message Template Group', 'event_espresso'),
-                    false,
-                    0,
-                    'Message_Template_Group'
-                ),
-            ],
-        ];
-        $this->_model_relations = [
-            'Event'                  => new EE_Belongs_To_Relation(),
-            'Message_Template_Group' => new EE_Belongs_To_Relation(),
-        ];
-        $path_to_event = 'Event';
-        $this->_cap_restriction_generators[ EEM_Base::caps_read ] = new EE_Restriction_Generator_Event_Related_Public(
-            $path_to_event
-        );
-        $this->_cap_restriction_generators[ EEM_Base::caps_read_admin ] = new EE_Restriction_Generator_Event_Related_Protected(
-            $path_to_event
-        );
-        $this->_cap_restriction_generators[ EEM_Base::caps_edit ] = new EE_Restriction_Generator_Event_Related_Protected(
-            $path_to_event
-        );
-        $this->_cap_restriction_generators[ EEM_Base::caps_delete ] = new EE_Restriction_Generator_Event_Related_Protected(
-            $path_to_event,
-            EEM_Base::caps_edit
-        );
-        parent::__construct($timezone);
-    }
+		$this->_tables = [
+			'Event_Message_Template' => new EE_Primary_Table('esp_event_message_template', 'EMT_ID'),
+		];
+		$this->_fields = [
+			'Event_Message_Template' => [
+				'EMT_ID' => new EE_Primary_Key_Int_Field(
+					'EMT_ID',
+					esc_html__('Event Message Template ID', 'event_espresso')
+				),
+				'EVT_ID' => new EE_Foreign_Key_Int_Field(
+					'EVT_ID',
+					esc_html__('The ID to the Event', 'event_espresso'),
+					false,
+					0,
+					'Event'
+				),
+				'GRP_ID' => new EE_Foreign_Key_Int_Field(
+					'GRP_ID',
+					esc_html__('The ID to the Message Template Group', 'event_espresso'),
+					false,
+					0,
+					'Message_Template_Group'
+				),
+			],
+		];
+		$this->_model_relations = [
+			'Event'                  => new EE_Belongs_To_Relation(),
+			'Message_Template_Group' => new EE_Belongs_To_Relation(),
+		];
+		$path_to_event = 'Event';
+		$this->_cap_restriction_generators[ EEM_Base::caps_read ] = new EE_Restriction_Generator_Event_Related_Public(
+			$path_to_event
+		);
+		$this->_cap_restriction_generators[ EEM_Base::caps_read_admin ] = new EE_Restriction_Generator_Event_Related_Protected(
+			$path_to_event
+		);
+		$this->_cap_restriction_generators[ EEM_Base::caps_edit ] = new EE_Restriction_Generator_Event_Related_Protected(
+			$path_to_event
+		);
+		$this->_cap_restriction_generators[ EEM_Base::caps_delete ] = new EE_Restriction_Generator_Event_Related_Protected(
+			$path_to_event,
+			EEM_Base::caps_edit
+		);
+		parent::__construct($timezone);
+	}
 
 
-    /**
-     * helper method to simply return an array of event ids for events attached to the given
-     * message template group.
-     *
-     * @param int $GRP_ID The MTP group we want attached events for.
-     * @return  array               An array of event ids.
-     * @throws EE_Error
-     * @since 4.3.0
-     */
-    public function get_attached_event_ids($GRP_ID)
-    {
-        $event_ids = $this->_get_all_wpdb_results([['GRP_ID' => $GRP_ID]], ARRAY_N, 'EVT_ID');
-        $event_ids = call_user_func_array('array_merge', $event_ids);
-        return $event_ids;
-    }
+	/**
+	 * helper method to simply return an array of event ids for events attached to the given
+	 * message template group.
+	 *
+	 * @param int $GRP_ID The MTP group we want attached events for.
+	 * @return  array               An array of event ids.
+	 * @throws EE_Error
+	 * @since 4.3.0
+	 */
+	public function get_attached_event_ids($GRP_ID)
+	{
+		$event_ids = $this->_get_all_wpdb_results([['GRP_ID' => $GRP_ID]], ARRAY_N, 'EVT_ID');
+		$event_ids = call_user_func_array('array_merge', $event_ids);
+		return $event_ids;
+	}
 
 
-    /**
-     * helper method for clearing event/group relations for the given event ids and grp ids.
-     *
-     * @param array $GRP_IDs An array of GRP_IDs. Optional. If empty then there must be EVT IDs.
-     * @param array $EVT_IDs An array of EVT_IDs.  Optional. If empty then there must be GRP IDs.
-     * @return int             How many rows were deleted.
-     * @throws EE_Error
-     * @throws EE_Error
-     */
-    public function delete_event_group_relations($GRP_IDs = [], $EVT_IDs = [])
-    {
-        if (empty($GRP_IDs) && empty($EVT_IDs)) {
-            throw new EE_Error(
-                sprintf(
-                    esc_html__(
-                        '%s requires either an array of GRP_IDs or EVT_IDs or both, but both cannot be empty.',
-                        'event_espresso'
-                    ),
-                    __METHOD__
-                )
-            );
-        }
+	/**
+	 * helper method for clearing event/group relations for the given event ids and grp ids.
+	 *
+	 * @param array $GRP_IDs An array of GRP_IDs. Optional. If empty then there must be EVT IDs.
+	 * @param array $EVT_IDs An array of EVT_IDs.  Optional. If empty then there must be GRP IDs.
+	 * @return int             How many rows were deleted.
+	 * @throws EE_Error
+	 * @throws EE_Error
+	 */
+	public function delete_event_group_relations($GRP_IDs = [], $EVT_IDs = [])
+	{
+		if (empty($GRP_IDs) && empty($EVT_IDs)) {
+			throw new EE_Error(
+				sprintf(
+					esc_html__(
+						'%s requires either an array of GRP_IDs or EVT_IDs or both, but both cannot be empty.',
+						'event_espresso'
+					),
+					__METHOD__
+				)
+			);
+		}
 
-        $where = [];
-        if (! empty($GRP_IDs)) {
-            $where['GRP_ID'] = ['IN', (array) $GRP_IDs];
-        }
-        if (! empty($EVT_IDs)) {
-            $where['EVT_ID'] = ['IN', (array) $EVT_IDs];
-        }
+		$where = [];
+		if (! empty($GRP_IDs)) {
+			$where['GRP_ID'] = ['IN', (array) $GRP_IDs];
+		}
+		if (! empty($EVT_IDs)) {
+			$where['EVT_ID'] = ['IN', (array) $EVT_IDs];
+		}
 
-        return $this->delete([$where], false);
-    }
+		return $this->delete([$where], false);
+	}
 }

espresso.php

Spacing +6 added lines, -6 removed lines

@@ -38,7 +38,7 @@ 
  * @since           4.0
  */
 if (function_exists('espresso_version')) {
-    if (! function_exists('espresso_duplicate_plugin_error')) {
+    if ( ! function_exists('espresso_duplicate_plugin_error')) {
         /**
          *    espresso_duplicate_plugin_error
          *    displays if more than one version of EE is activated at the same time
@@ -62,7 +62,7 @@ 
     add_action('admin_notices', 'espresso_duplicate_plugin_error', 1);
 } else {
     define('EE_MIN_PHP_VER_REQUIRED', '5.6.2');
-    if (! version_compare(PHP_VERSION, EE_MIN_PHP_VER_REQUIRED, '>=')) {
+    if ( ! version_compare(PHP_VERSION, EE_MIN_PHP_VER_REQUIRED, '>=')) {
         /**
          * espresso_minimum_php_version_error
          *
@@ -116,11 +116,11 @@ 
 
         register_activation_hook(EVENT_ESPRESSO_MAIN_FILE, 'espresso_plugin_activation');
 
-        require_once __DIR__ . '/core/bootstrap_espresso.php';
+        require_once __DIR__.'/core/bootstrap_espresso.php';
         bootstrap_espresso();
     }
 }
-if (! function_exists('espresso_deactivate_plugin')) {
+if ( ! function_exists('espresso_deactivate_plugin')) {
     /**
      *    deactivate_plugin
      * usage:  espresso_deactivate_plugin( plugin_basename( __FILE__ ));
@@ -131,8 +131,8 @@ 
      */
     function espresso_deactivate_plugin($plugin_basename = '')
     {
-        if (! function_exists('deactivate_plugins')) {
-            require_once ABSPATH . 'wp-admin/includes/plugin.php';
+        if ( ! function_exists('deactivate_plugins')) {
+            require_once ABSPATH.'wp-admin/includes/plugin.php';
         }
         unset($_GET['activate'], $_REQUEST['activate']);
         deactivate_plugins($plugin_basename);

Indentation +80 added lines, -80 removed lines

@@ -38,103 +38,103 @@
  * @since           4.0
  */
 if (function_exists('espresso_version')) {
-    if (! function_exists('espresso_duplicate_plugin_error')) {
-        /**
-         *    espresso_duplicate_plugin_error
-         *    displays if more than one version of EE is activated at the same time
-         */
-        function espresso_duplicate_plugin_error()
-        {
-            ?>
+	if (! function_exists('espresso_duplicate_plugin_error')) {
+		/**
+		 *    espresso_duplicate_plugin_error
+		 *    displays if more than one version of EE is activated at the same time
+		 */
+		function espresso_duplicate_plugin_error()
+		{
+			?>
             <div class="error">
                 <p>
                     <?php
-                    echo esc_html__(
-                        'Can not run multiple versions of Event Espresso! One version has been automatically deactivated. Please verify that you have the correct version you want still active.',
-                        'event_espresso'
-                    ); ?>
+					echo esc_html__(
+						'Can not run multiple versions of Event Espresso! One version has been automatically deactivated. Please verify that you have the correct version you want still active.',
+						'event_espresso'
+					); ?>
                 </p>
             </div>
             <?php
-            espresso_deactivate_plugin(plugin_basename(__FILE__));
-        }
-    }
-    add_action('admin_notices', 'espresso_duplicate_plugin_error', 1);
+			espresso_deactivate_plugin(plugin_basename(__FILE__));
+		}
+	}
+	add_action('admin_notices', 'espresso_duplicate_plugin_error', 1);
 } else {
-    define('EE_MIN_PHP_VER_REQUIRED', '5.6.2');
-    if (! version_compare(PHP_VERSION, EE_MIN_PHP_VER_REQUIRED, '>=')) {
-        /**
-         * espresso_minimum_php_version_error
-         *
-         * @return void
-         */
-        function espresso_minimum_php_version_error()
-        {
-            ?>
+	define('EE_MIN_PHP_VER_REQUIRED', '5.6.2');
+	if (! version_compare(PHP_VERSION, EE_MIN_PHP_VER_REQUIRED, '>=')) {
+		/**
+		 * espresso_minimum_php_version_error
+		 *
+		 * @return void
+		 */
+		function espresso_minimum_php_version_error()
+		{
+			?>
             <div class="error">
                 <p>
                     <?php
-                    printf(
-                        esc_html__(
-                            'We\'re sorry, but Event Espresso requires PHP version %1$s or greater in order to operate. You are currently running version %2$s.%3$sIn order to update your version of PHP, you will need to contact your current hosting provider.%3$sFor information on stable PHP versions, please go to %4$s.',
-                            'event_espresso'
-                        ),
-                        EE_MIN_PHP_VER_REQUIRED,
-                        PHP_VERSION,
-                        '<br/>',
-                        '<a href="http://php.net/downloads.php">http://php.net/downloads.php</a>'
-                    );
-                    ?>
+					printf(
+						esc_html__(
+							'We\'re sorry, but Event Espresso requires PHP version %1$s or greater in order to operate. You are currently running version %2$s.%3$sIn order to update your version of PHP, you will need to contact your current hosting provider.%3$sFor information on stable PHP versions, please go to %4$s.',
+							'event_espresso'
+						),
+						EE_MIN_PHP_VER_REQUIRED,
+						PHP_VERSION,
+						'<br/>',
+						'<a href="http://php.net/downloads.php">http://php.net/downloads.php</a>'
+					);
+					?>
                 </p>
             </div>
             <?php
-            espresso_deactivate_plugin(plugin_basename(__FILE__));
-        }
+			espresso_deactivate_plugin(plugin_basename(__FILE__));
+		}
 
-        add_action('admin_notices', 'espresso_minimum_php_version_error', 1);
-    } else {
-        define('EVENT_ESPRESSO_MAIN_FILE', __FILE__);
-        /**
-         * espresso_version
-         * Returns the plugin version
-         *
-         * @return string
-         */
-        function espresso_version()
-        {
-            return apply_filters('FHEE__espresso__espresso_version', '4.10.39.rc.007');
-        }
+		add_action('admin_notices', 'espresso_minimum_php_version_error', 1);
+	} else {
+		define('EVENT_ESPRESSO_MAIN_FILE', __FILE__);
+		/**
+		 * espresso_version
+		 * Returns the plugin version
+		 *
+		 * @return string
+		 */
+		function espresso_version()
+		{
+			return apply_filters('FHEE__espresso__espresso_version', '4.10.39.rc.007');
+		}
 
-        /**
-         * espresso_plugin_activation
-         * adds a wp-option to indicate that EE has been activated via the WP admin plugins page
-         */
-        function espresso_plugin_activation()
-        {
-            update_option('ee_espresso_activation', true);
-        }
+		/**
+		 * espresso_plugin_activation
+		 * adds a wp-option to indicate that EE has been activated via the WP admin plugins page
+		 */
+		function espresso_plugin_activation()
+		{
+			update_option('ee_espresso_activation', true);
+		}
 
-        register_activation_hook(EVENT_ESPRESSO_MAIN_FILE, 'espresso_plugin_activation');
+		register_activation_hook(EVENT_ESPRESSO_MAIN_FILE, 'espresso_plugin_activation');
 
-        require_once __DIR__ . '/core/bootstrap_espresso.php';
-        bootstrap_espresso();
-    }
+		require_once __DIR__ . '/core/bootstrap_espresso.php';
+		bootstrap_espresso();
+	}
 }
 if (! function_exists('espresso_deactivate_plugin')) {
-    /**
-     *    deactivate_plugin
-     * usage:  espresso_deactivate_plugin( plugin_basename( __FILE__ ));
-     *
-     * @access public
-     * @param string $plugin_basename - the results of plugin_basename( __FILE__ ) for the plugin's main file
-     * @return    void
-     */
-    function espresso_deactivate_plugin($plugin_basename = '')
-    {
-        if (! function_exists('deactivate_plugins')) {
-            require_once ABSPATH . 'wp-admin/includes/plugin.php';
-        }
-        unset($_GET['activate'], $_REQUEST['activate']);
-        deactivate_plugins($plugin_basename);
-    }
+	/**
+	 *    deactivate_plugin
+	 * usage:  espresso_deactivate_plugin( plugin_basename( __FILE__ ));
+	 *
+	 * @access public
+	 * @param string $plugin_basename - the results of plugin_basename( __FILE__ ) for the plugin's main file
+	 * @return    void
+	 */
+	function espresso_deactivate_plugin($plugin_basename = '')
+	{
+		if (! function_exists('deactivate_plugins')) {
+			require_once ABSPATH . 'wp-admin/includes/plugin.php';
+		}
+		unset($_GET['activate'], $_REQUEST['activate']);
+		deactivate_plugins($plugin_basename);
+	}
 }
\ No newline at end of file

core/domain/EnqueueAssetsInterface.php

Indentation +35 added lines, -35 removed lines

@@ -4,45 +4,45 @@
 interface EnqueueAssetsInterface
 {
 
-    /**
-     * a place to register scripts and stylesheets with WordPress core
-     * IMPORTANT !!!
-     * ALL JavaScript files need to be registered for loading in the footer
-     * by setting the 5th parameter of wp_register_script() to ` true `
-     *
-     * @return void
-     */
-    public function registerScriptsAndStylesheets();
+	/**
+	 * a place to register scripts and stylesheets with WordPress core
+	 * IMPORTANT !!!
+	 * ALL JavaScript files need to be registered for loading in the footer
+	 * by setting the 5th parameter of wp_register_script() to ` true `
+	 *
+	 * @return void
+	 */
+	public function registerScriptsAndStylesheets();
 
-    /**
-     * a place to enqueue previously registered stylesheets
-     * this will be called during the wp_enqueue_scripts hook for frontend requests
-     *
-     * @return void
-     */
-    public function enqueueStylesheets();
+	/**
+	 * a place to enqueue previously registered stylesheets
+	 * this will be called during the wp_enqueue_scripts hook for frontend requests
+	 *
+	 * @return void
+	 */
+	public function enqueueStylesheets();
 
-    /**
-     * a place to enqueue previously registered stylesheets
-     * this will be called during the admin_enqueue_scripts hook for admin requests
-     *
-     * @return void
-     */
-    public function enqueueAdminStylesheets();
+	/**
+	 * a place to enqueue previously registered stylesheets
+	 * this will be called during the admin_enqueue_scripts hook for admin requests
+	 *
+	 * @return void
+	 */
+	public function enqueueAdminStylesheets();
 
-    /**
-     * a place to enqueue previously registered scripts for frontend requests
-     *
-     * @return void
-     */
-    public function enqueueScripts();
+	/**
+	 * a place to enqueue previously registered scripts for frontend requests
+	 *
+	 * @return void
+	 */
+	public function enqueueScripts();
 
-    /**
-     * a place to enqueue previously registered scripts for admin requests
-     *
-     * @return void
-     */
-    public function enqueueAdminScripts();
+	/**
+	 * a place to enqueue previously registered scripts for admin requests
+	 *
+	 * @return void
+	 */
+	public function enqueueAdminScripts();
 }
 // End of file EnqueueAssetsInterface.php
 // Location: EventEspresso\core\domain/EnqueueAssetsInterface.php

admin_pages/messages/help_tabs/messages_overview_types.help_tab.php

Indentation +18 added lines, -18 removed lines

@@ -1,15 +1,15 @@ 
 <p><strong><?php esc_html_e('Message Types', 'event_espresso'); ?></strong></p>
 <p>
     <?php
-    printf(
-        esc_html__(
-            'Messages are email notifications that are sent out by Event Espresso. Message Types are the %1$skinds%2$s of messages that get delivered.  They can be thought of as the "type" of package that is being delivered by the messenger. For example, Event Espresso comes with two Message Types attached to the Email Messenger:',
-            'event_espresso'
-        ),
-        '<em>',
-        '</em>'
-    );
-    ?>
+	printf(
+		esc_html__(
+			'Messages are email notifications that are sent out by Event Espresso. Message Types are the %1$skinds%2$s of messages that get delivered.  They can be thought of as the "type" of package that is being delivered by the messenger. For example, Event Espresso comes with two Message Types attached to the Email Messenger:',
+			'event_espresso'
+		),
+		'<em>',
+		'</em>'
+	);
+	?>
 </p>
 <ul>
     <li>
@@ -24,20 +24,20 @@ 
 <p><strong><?php esc_html_e('Contexts', 'event_espresso'); ?></strong></p>
 <p>
     <?php esc_html_e(
-        'Each Message Type (kind of message) has different contexts. Contexts are dynamic and typically represent recipients (individuals receiving email notifications). For example, when the Registration Confirmation message type is triggered, it will send out a message to the following recipients: Event Administrator, Primary Registrant, and Additional Registrants. On the other hand, the Payment Message Type has only two recipients: Event Administrator and Primary Registrant.',
-        'event_espresso'
-    ); ?>
+		'Each Message Type (kind of message) has different contexts. Contexts are dynamic and typically represent recipients (individuals receiving email notifications). For example, when the Registration Confirmation message type is triggered, it will send out a message to the following recipients: Event Administrator, Primary Registrant, and Additional Registrants. On the other hand, the Payment Message Type has only two recipients: Event Administrator and Primary Registrant.',
+		'event_espresso'
+	); ?>
 </p>
 <p>
     <?php esc_html_e(
-        'A message context can be deactivated by removing a recipient from the "TO" field. This will set the field to blank and you can save changes. Deactivated message contexts will appear in grey when viewed in the Messages Overview tab. To re-activate a message context, go to that message context and setup a recipient (using one of the available shortcodes) and save changes. This will reactivate the message context and it will appear as blue in the Messages Overview tab.',
-        'event_espresso'
-    ); ?>
+		'A message context can be deactivated by removing a recipient from the "TO" field. This will set the field to blank and you can save changes. Deactivated message contexts will appear in grey when viewed in the Messages Overview tab. To re-activate a message context, go to that message context and setup a recipient (using one of the available shortcodes) and save changes. This will reactivate the message context and it will appear as blue in the Messages Overview tab.',
+		'event_espresso'
+	); ?>
 </p>
 <p><strong><?php esc_html_e('Activation / Deactivation of Message Types', 'event_espresso'); ?></strong></p>
 <p>
     <?php esc_html_e(
-        'When a new install of Event Espresso is activated, all message types will be activated except for those for Cancelled and Declined registrations. The message types for Cancelled and Declined registrations can be easily activated through the Settings tab for Messages. Deactivating and re-activating Event Espresso will keep the current settings saved.',
-        'event_espresso'
-    ); ?>
+		'When a new install of Event Espresso is activated, all message types will be activated except for those for Cancelled and Declined registrations. The message types for Cancelled and Declined registrations can be easily activated through the Settings tab for Messages. Deactivating and re-activating Event Espresso will keep the current settings saved.',
+		'event_espresso'
+	); ?>
 </p>

admin_pages/payments/help_tabs/payment_methods_overview.help_tab.php

Spacing +1 added lines, -1 removed lines

@@ -53,7 +53,7 @@
                 'The URL of the button image for this payment method in the registration process. You may use any uploaded image on your website (click %s next to the field to select). If left blank, the default button image will be used.',
                 'event_espresso'
             ),
-            '<img src="' . admin_url('images/media-button-image.gif') . '">'
+            '<img src="'.admin_url('images/media-button-image.gif').'">'
         );
         ?>
     </li>

Indentation +37 added lines, -37 removed lines

@@ -12,62 +12,62 @@ 
         <strong><?php esc_html_e('Name', 'event_espresso'); ?></strong>
         <br>
         <?php esc_html_e(
-            'The name of the payment method as customers see it in the registration form, in emails, in receipts, etc.',
-            'event_espresso'
-        ); ?>
+			'The name of the payment method as customers see it in the registration form, in emails, in receipts, etc.',
+			'event_espresso'
+		); ?>
     </li>
     <li>
         <strong><?php esc_html_e('Description', 'event_espresso'); ?></strong>
         <br />
         <?php esc_html_e(
-            'The description of how to use the payment method as customers will see it. This is mostly only seen during registration.',
-            'event_espresso'
-        ); ?>
+			'The description of how to use the payment method as customers will see it. This is mostly only seen during registration.',
+			'event_espresso'
+		); ?>
     </li>
     <li>
         <strong><?php esc_html_e('Admin-Only Name', 'event_espresso'); ?></strong>
         <br />
         <?php esc_html_e(
-            'The name of the payment method as seen internally by site administrators and staff.',
-            'event_espresso'
-        ); ?>
+			'The name of the payment method as seen internally by site administrators and staff.',
+			'event_espresso'
+		); ?>
     </li>
     <li>
         <strong><?php esc_html_e('Admin-Only Description', 'event_espresso'); ?></strong>
         <br />
         <?php esc_html_e(
-            'The description of the payment method as seen internally by site administrators and staff.',
-            'event_espresso'
-        ); ?>
+			'The description of the payment method as seen internally by site administrators and staff.',
+			'event_espresso'
+		); ?>
     </li>
     <li>
         <strong><?php esc_html_e('Debug (sandbox) Mode', 'event_espresso'); ?></strong>
         <br />
         <?php esc_html_e(
-            'Many payment methods have a debug/sandbox mode where payments are not processed but are only simulated. This is helpful when setup and debugging.',
-            'event_espresso'
-        ); ?>
+			'Many payment methods have a debug/sandbox mode where payments are not processed but are only simulated. This is helpful when setup and debugging.',
+			'event_espresso'
+		); ?>
     </li>
     <li>
         <strong><?php esc_html_e('Open by Default', 'event_espresso'); ?></strong>
         <br />
         <?php esc_html_e(
-            'If checked, this payment method will be selected by default (assuming no other valid payment methods are also marked as open by default.)',
-            'event_espresso'
-        ); ?>
+			'If checked, this payment method will be selected by default (assuming no other valid payment methods are also marked as open by default.)',
+			'event_espresso'
+		); ?>
     </li>
     <li>
         <strong><?php esc_html_e('Button URL', 'event_espresso'); ?></strong>
         <br />
         <?php
-        printf(
-            esc_html__(
-                'The URL of the button image for this payment method in the registration process. You may use any uploaded image on your website (click %s next to the field to select). If left blank, the default button image will be used.',
-                'event_espresso'
-            ),
-            '<img src="' . admin_url('images/media-button-image.gif') . '">'
-        );
-        ?>
+		printf(
+			esc_html__(
+				'The URL of the button image for this payment method in the registration process. You may use any uploaded image on your website (click %s next to the field to select). If left blank, the default button image will be used.',
+				'event_espresso'
+			),
+			'<img src="' . admin_url('images/media-button-image.gif') . '">'
+		);
+		?>
     </li>
     <li><strong><?php esc_html_e('Usable From', 'event_espresso'); ?></strong>
         <br />
@@ -75,15 +75,15 @@ 
         <ul>
             <li>
                 <?php esc_html_e(
-                    'Front-end Registration Page: the payment method will appear as an option during the normal registration process to customers and they can use it to process payments.',
-                    'event_espresso'
-                ); ?>
+					'Front-end Registration Page: the payment method will appear as an option during the normal registration process to customers and they can use it to process payments.',
+					'event_espresso'
+				); ?>
             </li>
             <li>
                 <?php esc_html_e(
-                    'Admin Registration Page: when recording payments made from the transaction admin page, the payment method will appear as an option. Note: currently payments can only be RECORDED from the admin, they cannot be PROCESSED.',
-                    'event_espresso'
-                ); ?>
+					'Admin Registration Page: when recording payments made from the transaction admin page, the payment method will appear as an option. Note: currently payments can only be RECORDED from the admin, they cannot be PROCESSED.',
+					'event_espresso'
+				); ?>
             </li>
         </ul>
     </li>
@@ -91,14 +91,14 @@ 
 <strong><?php esc_html_e('Recommendations', 'event_espresso'); ?></strong>
 <br />
 <?php esc_html_e(
-    'To learn more about the options on this page, take a look at the different tabs that appear on the left side of the page.',
-    'event_espresso'
+	'To learn more about the options on this page, take a look at the different tabs that appear on the left side of the page.',
+	'event_espresso'
 ); ?>
 <p>
     <strong><?php esc_html_e('Screen Options', 'event_espresso'); ?></strong>
     <br />
     <?php esc_html_e(
-        'You can customize the information that is shown on this page by toggling the Screen Options tab. Then you can add or remove checkmarks to hide or show certain content.',
-        'event_espresso'
-    ); ?>
+		'You can customize the information that is shown on this page by toggling the Screen Options tab. Then you can add or remove checkmarks to hide or show certain content.',
+		'event_espresso'
+	); ?>
 </p>
\ No newline at end of file

core/libraries/shortcodes/EE_Datetime_List_Shortcodes.lib.php

Spacing +2 added lines, -2 removed lines

@@ -168,7 +168,7 @@ 
     private function _get_datetimes_from_event(EE_Event $event)
     {
         return isset($this->_extra_data['data']->events)
-            ? $this->_extra_data['data']->events[ $event->ID() ]['dtt_objs']
+            ? $this->_extra_data['data']->events[$event->ID()]['dtt_objs']
             : [];
     }
 
@@ -182,7 +182,7 @@ 
     private function _get_datetimes_from_ticket(EE_Ticket $ticket)
     {
         return isset($this->_extra_data['data']->tickets)
-            ? $this->_extra_data['data']->tickets[ $ticket->ID() ]['dtt_objs']
+            ? $this->_extra_data['data']->tickets[$ticket->ID()]['dtt_objs']
             : [];
     }
 }

Indentation +164 added lines, -164 removed lines

@@ -18,168 +18,168 @@
  */
 class EE_Datetime_List_Shortcodes extends EE_Shortcodes
 {
-    protected function _init_props()
-    {
-        $this->label       = esc_html__('Datetime List Shortcodes', 'event_espresso');
-        $this->description = esc_html__('All shortcodes specific to datetime lists', 'event_espresso');
-        $this->_shortcodes = [
-            '[DATETIME_LIST]' => esc_html__(
-                'Will output a list of datetimes according to the layout specified in the datetime list field.',
-                'event_espresso'
-            ),
-        ];
-    }
-
-
-    /**
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    protected function _parser($shortcode)
-    {
-        switch ($shortcode) {
-            case '[DATETIME_LIST]':
-                return $this->_get_datetime_list();
-        }
-        return '';
-    }
-
-
-    /**
-     * figure out what the incoming data is and then return the appropriate parsed value.
-     *
-     * @return string
-     * @throws EE_Error
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    private function _get_datetime_list()
-    {
-        $this->_validate_list_requirements();
-
-        if ($this->_data['data'] instanceof EE_Ticket) {
-            return $this->_get_datetime_list_for_ticket();
-        }
-        if ($this->_data['data'] instanceof EE_Event) {
-            return $this->_get_datetime_list_for_event();
-        }
-        if (
-            $this->_data['data'] instanceof EE_Messages_Addressee
-            && $this->_data['data']->reg_obj instanceof EE_Registration
-        ) {
-            return $this->_get_datetime_list_for_registration();
-        }
-        // prevent recursive loop
-        return '';
-    }
-
-
-    /**
-     * return parsed list of datetimes for an event
-     *
-     * @return string
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    private function _get_datetime_list_for_event()
-    {
-        $event            = $this->_data['data'];
-        $valid_shortcodes = ['datetime', 'attendee'];
-        $template         = is_array($this->_data['template']) && isset($this->_data['template']['datetime_list'])
-            ? $this->_data['template']['datetime_list']
-            : $this->_extra_data['template']['datetime_list'];
-
-        // here we're setting up the datetimes for the datetime list template for THIS event.
-        $dtt_parsed = '';
-        $datetimes  = $this->_get_datetimes_from_event($event);
-
-        // each datetime in this case should be an datetime object.
-        foreach ($datetimes as $datetime) {
-            $dtt_parsed .= $this->_shortcode_helper->parse_datetime_list_template(
-                $template,
-                $datetime,
-                $valid_shortcodes,
-                $this->_extra_data
-            );
-        }
-
-        return $dtt_parsed;
-    }
-
-
-    /**
-     * return parsed list of datetimes for an ticket
-     *
-     * @return string
-     * @throws EE_Error
-     */
-    private function _get_datetime_list_for_ticket()
-    {
-        $valid_shortcodes = ['datetime', 'attendee'];
-
-        $template = is_array($this->_data['template']) && isset($this->_data['template']['datetime_list'])
-            ? $this->_data['template']['datetime_list']
-            : $this->_extra_data['template']['datetime_list'];
-        $ticket   = $this->_data['data'];
-
-        // here we're setting up the datetimes for the datetime list template for THIS ticket.
-        $dtt_parsed = '';
-        $datetimes  = $this->_get_datetimes_from_ticket($ticket);
-
-        // each datetime in this case should be an datetime object.
-        foreach ($datetimes as $datetime) {
-            $dtt_parsed .= $this->_shortcode_helper->parse_datetime_list_template(
-                $template,
-                $datetime,
-                $valid_shortcodes,
-                $this->_extra_data
-            );
-        }
-
-        return $dtt_parsed;
-    }
-
-
-    /**
-     * return parsed list of datetimes from a given registration.
-     *
-     * @return string
-     * @throws EE_Error
-     * @throws EE_Error
-     */
-    private function _get_datetime_list_for_registration()
-    {
-        $registration = $this->_data['data']->reg_obj;
-
-        // now let's just get the ticket, set $this->_data['data'] to the ticket and then call _get_datetime_list_for__ticket();
-        $this->_data['data'] = $registration->ticket();
-        return $this->_get_datetime_list_for_ticket();
-    }
-
-
-    /**
-     * @param EE_Event $event
-     * @return array|mixed
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    private function _get_datetimes_from_event(EE_Event $event)
-    {
-        return isset($this->_extra_data['data']->events)
-            ? $this->_extra_data['data']->events[ $event->ID() ]['dtt_objs']
-            : [];
-    }
-
-
-    /**
-     * @param EE_Ticket $ticket
-     * @return array|mixed
-     * @throws EE_Error
-     */
-    private function _get_datetimes_from_ticket(EE_Ticket $ticket)
-    {
-        return isset($this->_extra_data['data']->tickets)
-            ? $this->_extra_data['data']->tickets[ $ticket->ID() ]['dtt_objs']
-            : [];
-    }
+	protected function _init_props()
+	{
+		$this->label       = esc_html__('Datetime List Shortcodes', 'event_espresso');
+		$this->description = esc_html__('All shortcodes specific to datetime lists', 'event_espresso');
+		$this->_shortcodes = [
+			'[DATETIME_LIST]' => esc_html__(
+				'Will output a list of datetimes according to the layout specified in the datetime list field.',
+				'event_espresso'
+			),
+		];
+	}
+
+
+	/**
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	protected function _parser($shortcode)
+	{
+		switch ($shortcode) {
+			case '[DATETIME_LIST]':
+				return $this->_get_datetime_list();
+		}
+		return '';
+	}
+
+
+	/**
+	 * figure out what the incoming data is and then return the appropriate parsed value.
+	 *
+	 * @return string
+	 * @throws EE_Error
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	private function _get_datetime_list()
+	{
+		$this->_validate_list_requirements();
+
+		if ($this->_data['data'] instanceof EE_Ticket) {
+			return $this->_get_datetime_list_for_ticket();
+		}
+		if ($this->_data['data'] instanceof EE_Event) {
+			return $this->_get_datetime_list_for_event();
+		}
+		if (
+			$this->_data['data'] instanceof EE_Messages_Addressee
+			&& $this->_data['data']->reg_obj instanceof EE_Registration
+		) {
+			return $this->_get_datetime_list_for_registration();
+		}
+		// prevent recursive loop
+		return '';
+	}
+
+
+	/**
+	 * return parsed list of datetimes for an event
+	 *
+	 * @return string
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	private function _get_datetime_list_for_event()
+	{
+		$event            = $this->_data['data'];
+		$valid_shortcodes = ['datetime', 'attendee'];
+		$template         = is_array($this->_data['template']) && isset($this->_data['template']['datetime_list'])
+			? $this->_data['template']['datetime_list']
+			: $this->_extra_data['template']['datetime_list'];
+
+		// here we're setting up the datetimes for the datetime list template for THIS event.
+		$dtt_parsed = '';
+		$datetimes  = $this->_get_datetimes_from_event($event);
+
+		// each datetime in this case should be an datetime object.
+		foreach ($datetimes as $datetime) {
+			$dtt_parsed .= $this->_shortcode_helper->parse_datetime_list_template(
+				$template,
+				$datetime,
+				$valid_shortcodes,
+				$this->_extra_data
+			);
+		}
+
+		return $dtt_parsed;
+	}
+
+
+	/**
+	 * return parsed list of datetimes for an ticket
+	 *
+	 * @return string
+	 * @throws EE_Error
+	 */
+	private function _get_datetime_list_for_ticket()
+	{
+		$valid_shortcodes = ['datetime', 'attendee'];
+
+		$template = is_array($this->_data['template']) && isset($this->_data['template']['datetime_list'])
+			? $this->_data['template']['datetime_list']
+			: $this->_extra_data['template']['datetime_list'];
+		$ticket   = $this->_data['data'];
+
+		// here we're setting up the datetimes for the datetime list template for THIS ticket.
+		$dtt_parsed = '';
+		$datetimes  = $this->_get_datetimes_from_ticket($ticket);
+
+		// each datetime in this case should be an datetime object.
+		foreach ($datetimes as $datetime) {
+			$dtt_parsed .= $this->_shortcode_helper->parse_datetime_list_template(
+				$template,
+				$datetime,
+				$valid_shortcodes,
+				$this->_extra_data
+			);
+		}
+
+		return $dtt_parsed;
+	}
+
+
+	/**
+	 * return parsed list of datetimes from a given registration.
+	 *
+	 * @return string
+	 * @throws EE_Error
+	 * @throws EE_Error
+	 */
+	private function _get_datetime_list_for_registration()
+	{
+		$registration = $this->_data['data']->reg_obj;
+
+		// now let's just get the ticket, set $this->_data['data'] to the ticket and then call _get_datetime_list_for__ticket();
+		$this->_data['data'] = $registration->ticket();
+		return $this->_get_datetime_list_for_ticket();
+	}
+
+
+	/**
+	 * @param EE_Event $event
+	 * @return array|mixed
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	private function _get_datetimes_from_event(EE_Event $event)
+	{
+		return isset($this->_extra_data['data']->events)
+			? $this->_extra_data['data']->events[ $event->ID() ]['dtt_objs']
+			: [];
+	}
+
+
+	/**
+	 * @param EE_Ticket $ticket
+	 * @return array|mixed
+	 * @throws EE_Error
+	 */
+	private function _get_datetimes_from_ticket(EE_Ticket $ticket)
+	{
+		return isset($this->_extra_data['data']->tickets)
+			? $this->_extra_data['data']->tickets[ $ticket->ID() ]['dtt_objs']
+			: [];
+	}
 }

core/libraries/shortcodes/EE_Ticket_List_Shortcodes.lib.php

Spacing +2 added lines, -2 removed lines

@@ -202,7 +202,7 @@ 
     private function _get_tickets_from_event(EE_Event $event)
     {
         return isset($this->_extra_data['data']->events)
-            ? $this->_extra_data['data']->events[ $event->ID() ]['tkt_objs']
+            ? $this->_extra_data['data']->events[$event->ID()]['tkt_objs']
             : [];
     }
 
@@ -216,7 +216,7 @@ 
     private function _get_ticket_list_from_registration(EE_Registration $registration)
     {
         return isset($this->_extra_data['data']->registrations)
-            ? [$this->_extra_data['data']->registrations[ $registration->ID() ]['tkt_obj']]
+            ? [$this->_extra_data['data']->registrations[$registration->ID()]['tkt_obj']]
             : [];
     }
 }

Indentation +204 added lines, -204 removed lines

@@ -18,208 +18,208 @@
  */
 class EE_Ticket_List_Shortcodes extends EE_Shortcodes
 {
-    public function __construct()
-    {
-        parent::__construct();
-    }
-
-
-    protected function _init_props()
-    {
-        $this->label       = esc_html__('Ticket List Shortcodes', 'event_espresso');
-        $this->description = esc_html__('All shortcodes specific to ticket lists', 'event_espresso');
-        $this->_shortcodes = [
-            '[TICKET_LIST]' => esc_html__('Will output a list of tickets', 'event_espresso'),
-        ];
-    }
-
-
-    /**
-     * @param string $shortcode
-     * @return string
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    protected function _parser($shortcode)
-    {
-        switch ($shortcode) {
-            case '[TICKET_LIST]':
-                return $this->_get_ticket_list();
-        }
-        return '';
-    }
-
-
-    /**
-     * figure out what the incoming data is and then return the appropriate parsed value.
-     *
-     * @return string
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    private function _get_ticket_list()
-    {
-        $this->_validate_list_requirements();
-
-        if ($this->_data['data'] instanceof EE_Messages_Addressee) {
-            return $this->_get_ticket_list_for_main();
-        }
-        if ($this->_data['data'] instanceof EE_Registration) {
-            return $this->_get_ticket_list_for_attendee();
-        }
-        if ($this->_data['data'] instanceof EE_Event) {
-            return $this->_get_ticket_list_for_event();
-        }
-        // prevent recursive loop
-        return '';
-    }
-
-
-    /**
-     * This returns the parsed ticket list for main template;
-     */
-    private function _get_ticket_list_for_main()
-    {
-        $valid_shortcodes = [
-            'ticket',
-            'event_list',
-            'attendee_list',
-            'datetime_list',
-            'attendee',
-            'line_item_list',
-            'primary_registration_details',
-            'recipient_details',
-        ];
-        $template         = $this->_data['template'];
-        $data             = $this->_data['data'];
-        $ticket_list      = '';
-
-
-        // now we need to loop through the ticket list and send data to the EE_Parser helper.
-        foreach ($data->tickets as $ticket) {
-            $ticket_list .= $this->_shortcode_helper->parse_ticket_list_template(
-                $template,
-                $ticket['ticket'],
-                $valid_shortcodes,
-                $this->_extra_data
-            );
-        }
-
-        return $ticket_list;
-    }
-
-
-    /**
-     * return parsed list of tickets for an event
-     *
-     * @return string
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    private function _get_ticket_list_for_event()
-    {
-        $valid_shortcodes = [
-            'ticket',
-            'attendee_list',
-            'datetime_list',
-            'attendee',
-            'venue',
-            'line_item_list',
-            'primary_registration_details',
-            'recipient_details',
-        ];
-        $template         = is_array($this->_data['template']) && isset($this->_data['template']['ticket_list'])
-            ? $this->_data['template']['ticket_list']
-            : $this->_extra_data['template']['ticket_list'];
-        $event            = $this->_data['data'];
-
-        // let's remove any existing [EVENT_LIST] shortcodes from the ticket list template so that we don't get recursion.
-        $template = str_replace('[EVENT_LIST]', '', $template);
-
-        // here we're setting up the tickets for the ticket list template for THIS event.
-        $tkt_parsed = '';
-        $tickets    = $this->_get_tickets_from_event($event);
-
-        // each ticket in this case should be an ticket object.
-        foreach ($tickets as $ticket) {
-            $tkt_parsed .= $this->_shortcode_helper->parse_ticket_list_template(
-                $template,
-                $ticket,
-                $valid_shortcodes,
-                $this->_extra_data
-            );
-        }
-
-        return $tkt_parsed;
-    }
-
-
-    /**
-     * return parsed list of tickets for an attendee
-     *
-     * @return string
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    private function _get_ticket_list_for_attendee()
-    {
-        $valid_shortcodes = [
-            'ticket',
-            'event_list',
-            'datetime_list',
-            'attendee',
-            'primary_registration_details',
-            'recipient_details',
-        ];
-
-        $template     = is_array($this->_data['template']) && isset($this->_data['template']['ticket_list'])
-            ? $this->_data['template']['ticket_list']
-            : $this->_extra_data['template']['ticket_list'];
-        $registration = $this->_data['data'];
-
-        // let's remove any existing [ATTENDEE_LIST] shortcode from the ticket list template so that we don't get recursion.
-        $template = str_replace('[ATTENDEE_LIST]', '', $template);
-
-        // here we're setting up the tickets for the ticket list template for THIS attendee.
-        $tkt_parsed = '';
-        $tickets    = $this->_get_ticket_list_from_registration($registration);
-
-        // each ticket in this case should be an ticket object.
-        foreach ($tickets as $ticket) {
-            $tkt_parsed .= $this->_shortcode_helper->parse_ticket_list_template(
-                $template,
-                $ticket,
-                $valid_shortcodes,
-                $this->_extra_data
-            );
-        }
-
-        return $tkt_parsed;
-    }
-
-
-    /**
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    private function _get_tickets_from_event(EE_Event $event)
-    {
-        return isset($this->_extra_data['data']->events)
-            ? $this->_extra_data['data']->events[ $event->ID() ]['tkt_objs']
-            : [];
-    }
-
-
-    /**
-     * @param EE_Registration $registration
-     * @return array
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    private function _get_ticket_list_from_registration(EE_Registration $registration)
-    {
-        return isset($this->_extra_data['data']->registrations)
-            ? [$this->_extra_data['data']->registrations[ $registration->ID() ]['tkt_obj']]
-            : [];
-    }
+	public function __construct()
+	{
+		parent::__construct();
+	}
+
+
+	protected function _init_props()
+	{
+		$this->label       = esc_html__('Ticket List Shortcodes', 'event_espresso');
+		$this->description = esc_html__('All shortcodes specific to ticket lists', 'event_espresso');
+		$this->_shortcodes = [
+			'[TICKET_LIST]' => esc_html__('Will output a list of tickets', 'event_espresso'),
+		];
+	}
+
+
+	/**
+	 * @param string $shortcode
+	 * @return string
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	protected function _parser($shortcode)
+	{
+		switch ($shortcode) {
+			case '[TICKET_LIST]':
+				return $this->_get_ticket_list();
+		}
+		return '';
+	}
+
+
+	/**
+	 * figure out what the incoming data is and then return the appropriate parsed value.
+	 *
+	 * @return string
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	private function _get_ticket_list()
+	{
+		$this->_validate_list_requirements();
+
+		if ($this->_data['data'] instanceof EE_Messages_Addressee) {
+			return $this->_get_ticket_list_for_main();
+		}
+		if ($this->_data['data'] instanceof EE_Registration) {
+			return $this->_get_ticket_list_for_attendee();
+		}
+		if ($this->_data['data'] instanceof EE_Event) {
+			return $this->_get_ticket_list_for_event();
+		}
+		// prevent recursive loop
+		return '';
+	}
+
+
+	/**
+	 * This returns the parsed ticket list for main template;
+	 */
+	private function _get_ticket_list_for_main()
+	{
+		$valid_shortcodes = [
+			'ticket',
+			'event_list',
+			'attendee_list',
+			'datetime_list',
+			'attendee',
+			'line_item_list',
+			'primary_registration_details',
+			'recipient_details',
+		];
+		$template         = $this->_data['template'];
+		$data             = $this->_data['data'];
+		$ticket_list      = '';
+
+
+		// now we need to loop through the ticket list and send data to the EE_Parser helper.
+		foreach ($data->tickets as $ticket) {
+			$ticket_list .= $this->_shortcode_helper->parse_ticket_list_template(
+				$template,
+				$ticket['ticket'],
+				$valid_shortcodes,
+				$this->_extra_data
+			);
+		}
+
+		return $ticket_list;
+	}
+
+
+	/**
+	 * return parsed list of tickets for an event
+	 *
+	 * @return string
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	private function _get_ticket_list_for_event()
+	{
+		$valid_shortcodes = [
+			'ticket',
+			'attendee_list',
+			'datetime_list',
+			'attendee',
+			'venue',
+			'line_item_list',
+			'primary_registration_details',
+			'recipient_details',
+		];
+		$template         = is_array($this->_data['template']) && isset($this->_data['template']['ticket_list'])
+			? $this->_data['template']['ticket_list']
+			: $this->_extra_data['template']['ticket_list'];
+		$event            = $this->_data['data'];
+
+		// let's remove any existing [EVENT_LIST] shortcodes from the ticket list template so that we don't get recursion.
+		$template = str_replace('[EVENT_LIST]', '', $template);
+
+		// here we're setting up the tickets for the ticket list template for THIS event.
+		$tkt_parsed = '';
+		$tickets    = $this->_get_tickets_from_event($event);
+
+		// each ticket in this case should be an ticket object.
+		foreach ($tickets as $ticket) {
+			$tkt_parsed .= $this->_shortcode_helper->parse_ticket_list_template(
+				$template,
+				$ticket,
+				$valid_shortcodes,
+				$this->_extra_data
+			);
+		}
+
+		return $tkt_parsed;
+	}
+
+
+	/**
+	 * return parsed list of tickets for an attendee
+	 *
+	 * @return string
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	private function _get_ticket_list_for_attendee()
+	{
+		$valid_shortcodes = [
+			'ticket',
+			'event_list',
+			'datetime_list',
+			'attendee',
+			'primary_registration_details',
+			'recipient_details',
+		];
+
+		$template     = is_array($this->_data['template']) && isset($this->_data['template']['ticket_list'])
+			? $this->_data['template']['ticket_list']
+			: $this->_extra_data['template']['ticket_list'];
+		$registration = $this->_data['data'];
+
+		// let's remove any existing [ATTENDEE_LIST] shortcode from the ticket list template so that we don't get recursion.
+		$template = str_replace('[ATTENDEE_LIST]', '', $template);
+
+		// here we're setting up the tickets for the ticket list template for THIS attendee.
+		$tkt_parsed = '';
+		$tickets    = $this->_get_ticket_list_from_registration($registration);
+
+		// each ticket in this case should be an ticket object.
+		foreach ($tickets as $ticket) {
+			$tkt_parsed .= $this->_shortcode_helper->parse_ticket_list_template(
+				$template,
+				$ticket,
+				$valid_shortcodes,
+				$this->_extra_data
+			);
+		}
+
+		return $tkt_parsed;
+	}
+
+
+	/**
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	private function _get_tickets_from_event(EE_Event $event)
+	{
+		return isset($this->_extra_data['data']->events)
+			? $this->_extra_data['data']->events[ $event->ID() ]['tkt_objs']
+			: [];
+	}
+
+
+	/**
+	 * @param EE_Registration $registration
+	 * @return array
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	private function _get_ticket_list_from_registration(EE_Registration $registration)
+	{
+		return isset($this->_extra_data['data']->registrations)
+			? [$this->_extra_data['data']->registrations[ $registration->ID() ]['tkt_obj']]
+			: [];
+	}
 }