eventespresso / event-espresso-core

core/db_models/strategies/EE_Restriction_Generator_Global.strategy.php

Spacing +5 added lines, -5 removed lines

@@ -48,7 +48,7 @@ 
     {
         // if there are no standard caps for this model, then for now
         // all we know is if they need the default cap to access this
-        if (! $this->model()->cap_slug()) {
+        if ( ! $this->model()->cap_slug()) {
             return [
                 EE_Restriction_Generator_Base::get_default_restrictions_cap(
                 ) => new EE_Return_None_Where_Conditions(),
@@ -61,14 +61,14 @@ 
             ) => new EE_Return_None_Where_Conditions(),
             EE_Restriction_Generator_Base::get_cap_name(
                 $this->model(),
-                $this->action() . '_others'
+                $this->action().'_others'
             ) => new EE_Default_Where_Conditions(
                 [
                     // I need to be the owner, or it must be a global item
-                    'OR*no_' .
+                    'OR*no_'.
                     EE_Restriction_Generator_Base::get_cap_name(
                         $this->model(),
-                        $this->action() . '_others'
+                        $this->action().'_others'
                     ) => [
                         EE_QUERY_PLACEHOLDER_USER_FIELD_NAME => EE_QUERY_PLACEHOLDER_CURRENT_USER,
                         $this->_global_field_name            => true,
@@ -77,7 +77,7 @@ 
             ),
             EE_Restriction_Generator_Base::get_cap_name(
                 $this->model(),
-                $this->action() . '_global'
+                $this->action().'_global'
             ) => new EE_Default_Where_Conditions(
                 [
                     // it mustn't be global

Indentation +62 added lines, -62 removed lines

@@ -19,70 +19,70 @@
  */
 class EE_Restriction_Generator_Global extends EE_Restriction_Generator_Base
 {
-    /**
-     * name of the model field that indicates whether or not a model object is
-     * "global"
-     *
-     * @var string
-     */
-    protected $_global_field_name;
+	/**
+	 * name of the model field that indicates whether or not a model object is
+	 * "global"
+	 *
+	 * @var string
+	 */
+	protected $_global_field_name;
 
 
-    /**
-     * @param string $global_field_name name of the model field that indicates
-     *                                  whether or not a model object is
-     *                                  "global"
-     */
-    public function __construct(string $global_field_name)
-    {
-        $this->_global_field_name = $global_field_name;
-    }
+	/**
+	 * @param string $global_field_name name of the model field that indicates
+	 *                                  whether or not a model object is
+	 *                                  "global"
+	 */
+	public function __construct(string $global_field_name)
+	{
+		$this->_global_field_name = $global_field_name;
+	}
 
 
-    /**
-     * @return EE_Default_Where_Conditions[]|EE_Return_None_Where_Conditions[]
-     * @throws EE_Error
-     */
-    protected function _generate_restrictions(): array
-    {
-        // if there are no standard caps for this model, then for now
-        // all we know is if they need the default cap to access this
-        if (! $this->model()->cap_slug()) {
-            return [
-                EE_Restriction_Generator_Base::get_default_restrictions_cap(
-                ) => new EE_Return_None_Where_Conditions(),
-            ];
-        }
-        return [
-            EE_Restriction_Generator_Base::get_cap_name(
-                $this->model(),
-                $this->action()
-            ) => new EE_Return_None_Where_Conditions(),
-            EE_Restriction_Generator_Base::get_cap_name(
-                $this->model(),
-                $this->action() . '_others'
-            ) => new EE_Default_Where_Conditions(
-                [
-                    // I need to be the owner, or it must be a global item
-                    'OR*no_' .
-                    EE_Restriction_Generator_Base::get_cap_name(
-                        $this->model(),
-                        $this->action() . '_others'
-                    ) => [
-                        EE_QUERY_PLACEHOLDER_USER_FIELD_NAME => EE_QUERY_PLACEHOLDER_CURRENT_USER,
-                        $this->_global_field_name            => true,
-                    ],
-                ]
-            ),
-            EE_Restriction_Generator_Base::get_cap_name(
-                $this->model(),
-                $this->action() . '_global'
-            ) => new EE_Default_Where_Conditions(
-                [
-                    // it mustn't be global
-                    $this->_global_field_name => false,
-                ]
-            ),
-        ];
-    }
+	/**
+	 * @return EE_Default_Where_Conditions[]|EE_Return_None_Where_Conditions[]
+	 * @throws EE_Error
+	 */
+	protected function _generate_restrictions(): array
+	{
+		// if there are no standard caps for this model, then for now
+		// all we know is if they need the default cap to access this
+		if (! $this->model()->cap_slug()) {
+			return [
+				EE_Restriction_Generator_Base::get_default_restrictions_cap(
+				) => new EE_Return_None_Where_Conditions(),
+			];
+		}
+		return [
+			EE_Restriction_Generator_Base::get_cap_name(
+				$this->model(),
+				$this->action()
+			) => new EE_Return_None_Where_Conditions(),
+			EE_Restriction_Generator_Base::get_cap_name(
+				$this->model(),
+				$this->action() . '_others'
+			) => new EE_Default_Where_Conditions(
+				[
+					// I need to be the owner, or it must be a global item
+					'OR*no_' .
+					EE_Restriction_Generator_Base::get_cap_name(
+						$this->model(),
+						$this->action() . '_others'
+					) => [
+						EE_QUERY_PLACEHOLDER_USER_FIELD_NAME => EE_QUERY_PLACEHOLDER_CURRENT_USER,
+						$this->_global_field_name            => true,
+					],
+				]
+			),
+			EE_Restriction_Generator_Base::get_cap_name(
+				$this->model(),
+				$this->action() . '_global'
+			) => new EE_Default_Where_Conditions(
+				[
+					// it mustn't be global
+					$this->_global_field_name => false,
+				]
+			),
+		];
+	}
 }

core/db_models/strategies/EE_Restriction_Generator_Event_Related_Public.strategy.php

Spacing +9 added lines, -9 removed lines

@@ -44,7 +44,7 @@ 
     {
         // if there are no standard caps for this model, then for now
         // all we know if they need the default cap to access this
-        if (! $this->model()->cap_slug()) {
+        if ( ! $this->model()->cap_slug()) {
             return [
                 self::get_default_restrictions_cap() => new EE_Return_None_Where_Conditions(),
             ];
@@ -67,15 +67,15 @@ 
             // they can't access others' non-default items
             self::get_cap_name(
                 $event_model,
-                $this->action() . '_others'
+                $this->action().'_others'
             ) => new EE_Default_Where_Conditions(
                 [
-                    'OR*' . self::get_cap_name(
+                    'OR*'.self::get_cap_name(
                         $event_model,
-                        $this->action() . '_others'
+                        $this->action().'_others'
                     ) => $this->addPublishedPostConditions(
                         [
-                            $this->_path_to_event_model . 'EVT_wp_user' => EE_QUERY_PLACEHOLDER_CURRENT_USER,
+                            $this->_path_to_event_model.'EVT_wp_user' => EE_QUERY_PLACEHOLDER_CURRENT_USER,
                         ],
                         true,
                         $this->_path_to_event_model
@@ -84,14 +84,14 @@ 
             ),
             // if they have basic and others, but not private,
             // they can't access others' private non-default items
-            self::get_cap_name($event_model, $this->action() . '_private') => new EE_Default_Where_Conditions(
+            self::get_cap_name($event_model, $this->action().'_private') => new EE_Default_Where_Conditions(
                 [
-                    'OR*no_' . self::get_cap_name(
+                    'OR*no_'.self::get_cap_name(
                         $event_model,
-                        $this->action() . '_private'
+                        $this->action().'_private'
                     ) => $this->addPublishedPostConditions(
                         [
-                            $this->_path_to_event_model . 'EVT_wp_user' => EE_QUERY_PLACEHOLDER_CURRENT_USER,
+                            $this->_path_to_event_model.'EVT_wp_user' => EE_QUERY_PLACEHOLDER_CURRENT_USER,
                         ],
                         false,
                         $this->_path_to_event_model

Indentation +81 added lines, -81 removed lines

@@ -13,90 +13,90 @@
  */
 class EE_Restriction_Generator_Event_Related_Public extends EE_Restriction_Generator_Base
 {
-    /**
-     * Path to the event model from the model this restriction generator will
-     * be applied to; including the event model itself. Eg
-     * "Ticket.Datetime.Event"
-     *
-     * @var string
-     */
-    protected $_path_to_event_model;
+	/**
+	 * Path to the event model from the model this restriction generator will
+	 * be applied to; including the event model itself. Eg
+	 * "Ticket.Datetime.Event"
+	 *
+	 * @var string
+	 */
+	protected $_path_to_event_model;
 
 
-    /**
-     * @param string $path_to_event_model
-     */
-    public function __construct(string $path_to_event_model)
-    {
-        if (substr($path_to_event_model, -1, 1) != '.') {
-            $path_to_event_model .= '.';
-        }
-        $this->_path_to_event_model = $path_to_event_model;
-    }
+	/**
+	 * @param string $path_to_event_model
+	 */
+	public function __construct(string $path_to_event_model)
+	{
+		if (substr($path_to_event_model, -1, 1) != '.') {
+			$path_to_event_model .= '.';
+		}
+		$this->_path_to_event_model = $path_to_event_model;
+	}
 
 
-    /**
-     * @return EE_Default_Where_Conditions[]|EE_Return_None_Where_Conditions[]
-     * @throws EE_Error
-     */
-    protected function _generate_restrictions(): array
-    {
-        // if there are no standard caps for this model, then for now
-        // all we know if they need the default cap to access this
-        if (! $this->model()->cap_slug()) {
-            return [
-                self::get_default_restrictions_cap() => new EE_Return_None_Where_Conditions(),
-            ];
-        }
+	/**
+	 * @return EE_Default_Where_Conditions[]|EE_Return_None_Where_Conditions[]
+	 * @throws EE_Error
+	 */
+	protected function _generate_restrictions(): array
+	{
+		// if there are no standard caps for this model, then for now
+		// all we know if they need the default cap to access this
+		if (! $this->model()->cap_slug()) {
+			return [
+				self::get_default_restrictions_cap() => new EE_Return_None_Where_Conditions(),
+			];
+		}
 
-        $event_model = EEM_Event::instance();
-        return [
-            // first: basically access to non-defaults is essentially
-            // controlled by which events are accessible
-            // if they don't have the basic event cap,
-            // they can only read things for published events
-            self::get_cap_name($event_model, $this->action()) => new EE_Default_Where_Conditions(
-                $this->addPublishedPostConditions(
-                    [],
-                    true,
-                    $this->_path_to_event_model
-                )
-            ),
-            // if they don't have the others event cap,
-            // they can't access others' non-default items
-            self::get_cap_name(
-                $event_model,
-                $this->action() . '_others'
-            ) => new EE_Default_Where_Conditions(
-                [
-                    'OR*' . self::get_cap_name(
-                        $event_model,
-                        $this->action() . '_others'
-                    ) => $this->addPublishedPostConditions(
-                        [
-                            $this->_path_to_event_model . 'EVT_wp_user' => EE_QUERY_PLACEHOLDER_CURRENT_USER,
-                        ],
-                        true,
-                        $this->_path_to_event_model
-                    ),
-                ]
-            ),
-            // if they have basic and others, but not private,
-            // they can't access others' private non-default items
-            self::get_cap_name($event_model, $this->action() . '_private') => new EE_Default_Where_Conditions(
-                [
-                    'OR*no_' . self::get_cap_name(
-                        $event_model,
-                        $this->action() . '_private'
-                    ) => $this->addPublishedPostConditions(
-                        [
-                            $this->_path_to_event_model . 'EVT_wp_user' => EE_QUERY_PLACEHOLDER_CURRENT_USER,
-                        ],
-                        false,
-                        $this->_path_to_event_model
-                    ),
-                ]
-            ),
-        ];
-    }
+		$event_model = EEM_Event::instance();
+		return [
+			// first: basically access to non-defaults is essentially
+			// controlled by which events are accessible
+			// if they don't have the basic event cap,
+			// they can only read things for published events
+			self::get_cap_name($event_model, $this->action()) => new EE_Default_Where_Conditions(
+				$this->addPublishedPostConditions(
+					[],
+					true,
+					$this->_path_to_event_model
+				)
+			),
+			// if they don't have the others event cap,
+			// they can't access others' non-default items
+			self::get_cap_name(
+				$event_model,
+				$this->action() . '_others'
+			) => new EE_Default_Where_Conditions(
+				[
+					'OR*' . self::get_cap_name(
+						$event_model,
+						$this->action() . '_others'
+					) => $this->addPublishedPostConditions(
+						[
+							$this->_path_to_event_model . 'EVT_wp_user' => EE_QUERY_PLACEHOLDER_CURRENT_USER,
+						],
+						true,
+						$this->_path_to_event_model
+					),
+				]
+			),
+			// if they have basic and others, but not private,
+			// they can't access others' private non-default items
+			self::get_cap_name($event_model, $this->action() . '_private') => new EE_Default_Where_Conditions(
+				[
+					'OR*no_' . self::get_cap_name(
+						$event_model,
+						$this->action() . '_private'
+					) => $this->addPublishedPostConditions(
+						[
+							$this->_path_to_event_model . 'EVT_wp_user' => EE_QUERY_PLACEHOLDER_CURRENT_USER,
+						],
+						false,
+						$this->_path_to_event_model
+					),
+				]
+			),
+		];
+	}
 }

core/db_models/strategies/EE_Restriction_Generator_Default_Public.strategy.php

Spacing +17 added lines, -17 removed lines

@@ -63,7 +63,7 @@ 
     {
         // if there are no standard caps for this model, then for now all we know
         // if they need the default cap to access this
-        if (! $this->model()->cap_slug()) {
+        if ( ! $this->model()->cap_slug()) {
             return [
                 self::get_default_restrictions_cap(
                 ) => new EE_Return_None_Where_Conditions(),
@@ -82,7 +82,7 @@ 
                 $this->action()
             ) => new EE_Default_Where_Conditions(
                 [
-                    'OR*no_' .
+                    'OR*no_'.
                     EE_Restriction_Generator_Base::get_cap_name(
                         $event_model,
                         $this->action()
@@ -100,16 +100,16 @@ 
             // others' that are for published events, or defaults
             EE_Restriction_Generator_Base::get_cap_name(
                 $event_model,
-                $this->action() . '_others'
+                $this->action().'_others'
             ) => new EE_Default_Where_Conditions(
                 [
-                    'OR*no_' .
+                    'OR*no_'.
                     EE_Restriction_Generator_Base::get_cap_name(
                         $event_model,
-                        $this->action() . '_others'
+                        $this->action().'_others'
                     ) => $this->addPublishedPostConditions(
                         [
-                            $this->_path_to_event_model . 'EVT_wp_user' => EE_QUERY_PLACEHOLDER_CURRENT_USER,
+                            $this->_path_to_event_model.'EVT_wp_user' => EE_QUERY_PLACEHOLDER_CURRENT_USER,
                             $this->_default_field_name                  => true,
                         ],
                         true,
@@ -122,16 +122,16 @@ 
             // and others' that aren't private
             EE_Restriction_Generator_Base::get_cap_name(
                 $event_model,
-                $this->action() . '_private'
+                $this->action().'_private'
             ) => new EE_Default_Where_Conditions(
                 [
-                    'OR*no_' .
+                    'OR*no_'.
                     EE_Restriction_Generator_Base::get_cap_name(
                         $event_model,
-                        $this->action() . '_private'
+                        $this->action().'_private'
                     ) => $this->addPublishedPostConditions(
                         [
-                            $this->_path_to_event_model . 'EVT_wp_user' => EE_QUERY_PLACEHOLDER_CURRENT_USER,
+                            $this->_path_to_event_model.'EVT_wp_user' => EE_QUERY_PLACEHOLDER_CURRENT_USER,
                             $this->_default_field_name                  => true,
                         ],
                         false,
@@ -145,7 +145,7 @@ 
             // restrict access to only non-default items
             EE_Restriction_Generator_Base::get_cap_name(
                 $this->model(),
-                $this->action() . '_default'
+                $this->action().'_default'
             ) => new EE_Default_Where_Conditions(
                 [$this->_default_field_name => false]
             ),
@@ -153,24 +153,24 @@ 
         if (
             EE_Restriction_Generator_Base::is_cap(
                 $this->model(),
-                $this->action() . '_others_default'
+                $this->action().'_others_default'
             )
         ) {
             // if they don't have the "others" default capability,
             // restrict access to only their default ones, and non-default ones
-            $restrictions[ EE_Restriction_Generator_Base::get_cap_name(
+            $restrictions[EE_Restriction_Generator_Base::get_cap_name(
                 $this->model(),
-                $this->action() . '_others_default'
-            ) ] = new EE_Default_Where_Conditions(
+                $this->action().'_others_default'
+            )] = new EE_Default_Where_Conditions(
                 [
                     // if they don't have the others default cap,
                     // they can't access others default items
                     // (but they can access their own default items,
                     // and non-default items)
-                    'OR*no_' .
+                    'OR*no_'.
                     EE_Restriction_Generator_Base::get_cap_name(
                         $this->model(),
-                        $this->action() . '_others_default'
+                        $this->action().'_others_default'
                     ) => [
                         'AND'                      => [
                             EE_QUERY_PLACEHOLDER_USER_FIELD_NAME => EE_QUERY_PLACEHOLDER_CURRENT_USER,

Indentation +161 added lines, -161 removed lines

@@ -14,172 +14,172 @@
  */
 class EE_Restriction_Generator_Default_Public extends EE_Restriction_Generator_Base
 {
-    /**
-     * Name of the field on this model (or a related model, including the model
-     * chain to it) that is a boolean indicating whether or not a model object
-     * is considered "Default" or not
-     *
-     * @var string
-     */
-    protected $_default_field_name;
+	/**
+	 * Name of the field on this model (or a related model, including the model
+	 * chain to it) that is a boolean indicating whether or not a model object
+	 * is considered "Default" or not
+	 *
+	 * @var string
+	 */
+	protected $_default_field_name;
 
-    /**
-     * The model chain to follow to get to the event model, including the event
-     * model itself. Eg 'Ticket.Datetime.Event'
-     *
-     * @var string
-     */
-    protected $_path_to_event_model;
+	/**
+	 * The model chain to follow to get to the event model, including the event
+	 * model itself. Eg 'Ticket.Datetime.Event'
+	 *
+	 * @var string
+	 */
+	protected $_path_to_event_model;
 
 
-    /**
-     * @param string $default_field_name  the name of the field Name of the
-     *                                    field on this model (or a related
-     *                                    model, including the model chain to
-     *                                    it) that is a boolean indicating
-     *                                    whether or not a model object is
-     *                                    considered "Default" or not
-     * @param string $path_to_event_model The model chain to follow to get to
-     *                                    the event model, including the event
-     *                                    model itself. Eg
-     *                                    'Ticket.Datetime.Event'
-     */
-    public function __construct(string $default_field_name, string $path_to_event_model)
-    {
-        $this->_default_field_name = $default_field_name;
-        if (substr($path_to_event_model, -1, 1) != '.') {
-            $path_to_event_model .= '.';
-        }
-        $this->_path_to_event_model = $path_to_event_model;
-    }
+	/**
+	 * @param string $default_field_name  the name of the field Name of the
+	 *                                    field on this model (or a related
+	 *                                    model, including the model chain to
+	 *                                    it) that is a boolean indicating
+	 *                                    whether or not a model object is
+	 *                                    considered "Default" or not
+	 * @param string $path_to_event_model The model chain to follow to get to
+	 *                                    the event model, including the event
+	 *                                    model itself. Eg
+	 *                                    'Ticket.Datetime.Event'
+	 */
+	public function __construct(string $default_field_name, string $path_to_event_model)
+	{
+		$this->_default_field_name = $default_field_name;
+		if (substr($path_to_event_model, -1, 1) != '.') {
+			$path_to_event_model .= '.';
+		}
+		$this->_path_to_event_model = $path_to_event_model;
+	}
 
 
-    /**
-     * @return EE_Default_Where_Conditions[]|EE_Return_None_Where_Conditions[]
-     * @throws EE_Error
-     */
-    protected function _generate_restrictions(): array
-    {
-        // if there are no standard caps for this model, then for now all we know
-        // if they need the default cap to access this
-        if (! $this->model()->cap_slug()) {
-            return [
-                self::get_default_restrictions_cap(
-                ) => new EE_Return_None_Where_Conditions(),
-            ];
-        }
+	/**
+	 * @return EE_Default_Where_Conditions[]|EE_Return_None_Where_Conditions[]
+	 * @throws EE_Error
+	 */
+	protected function _generate_restrictions(): array
+	{
+		// if there are no standard caps for this model, then for now all we know
+		// if they need the default cap to access this
+		if (! $this->model()->cap_slug()) {
+			return [
+				self::get_default_restrictions_cap(
+				) => new EE_Return_None_Where_Conditions(),
+			];
+		}
 
-        $event_model = EEM_Event::instance();
+		$event_model = EEM_Event::instance();
 
-        $restrictions = [
-            // first: basically access to non-defaults is essentially
-            // controlled by which events are accessible
-            // if they don't have the basic event cap,
-            // they can't access ANY non-default items
-            EE_Restriction_Generator_Base::get_cap_name(
-                $event_model,
-                $this->action()
-            ) => new EE_Default_Where_Conditions(
-                [
-                    'OR*no_' .
-                    EE_Restriction_Generator_Base::get_cap_name(
-                        $event_model,
-                        $this->action()
-                    ) => $this->addPublishedPostConditions(
-                        [
-                            $this->_default_field_name => true,
-                        ],
-                        true,
-                        $this->_path_to_event_model
-                    ),
-                ]
-            ),
-            // if they don't have the others event cap,
-            // they can only access their own,
-            // others' that are for published events, or defaults
-            EE_Restriction_Generator_Base::get_cap_name(
-                $event_model,
-                $this->action() . '_others'
-            ) => new EE_Default_Where_Conditions(
-                [
-                    'OR*no_' .
-                    EE_Restriction_Generator_Base::get_cap_name(
-                        $event_model,
-                        $this->action() . '_others'
-                    ) => $this->addPublishedPostConditions(
-                        [
-                            $this->_path_to_event_model . 'EVT_wp_user' => EE_QUERY_PLACEHOLDER_CURRENT_USER,
-                            $this->_default_field_name                  => true,
-                        ],
-                        true,
-                        $this->_path_to_event_model
-                    ),
-                ]
-            ),
-            // if they have basic and others, but not private,
-            // they can access default, their own,
-            // and others' that aren't private
-            EE_Restriction_Generator_Base::get_cap_name(
-                $event_model,
-                $this->action() . '_private'
-            ) => new EE_Default_Where_Conditions(
-                [
-                    'OR*no_' .
-                    EE_Restriction_Generator_Base::get_cap_name(
-                        $event_model,
-                        $this->action() . '_private'
-                    ) => $this->addPublishedPostConditions(
-                        [
-                            $this->_path_to_event_model . 'EVT_wp_user' => EE_QUERY_PLACEHOLDER_CURRENT_USER,
-                            $this->_default_field_name                  => true,
-                        ],
-                        false,
-                        $this->_path_to_event_model
-                    ),
-                ]
-            ),
-            // second: access to defaults is controlled
-            // by the default capabilities
-            // if they don't have the basic default capability,
-            // restrict access to only non-default items
-            EE_Restriction_Generator_Base::get_cap_name(
-                $this->model(),
-                $this->action() . '_default'
-            ) => new EE_Default_Where_Conditions(
-                [$this->_default_field_name => false]
-            ),
-        ];
-        if (
-            EE_Restriction_Generator_Base::is_cap(
-                $this->model(),
-                $this->action() . '_others_default'
-            )
-        ) {
-            // if they don't have the "others" default capability,
-            // restrict access to only their default ones, and non-default ones
-            $restrictions[ EE_Restriction_Generator_Base::get_cap_name(
-                $this->model(),
-                $this->action() . '_others_default'
-            ) ] = new EE_Default_Where_Conditions(
-                [
-                    // if they don't have the others default cap,
-                    // they can't access others default items
-                    // (but they can access their own default items,
-                    // and non-default items)
-                    'OR*no_' .
-                    EE_Restriction_Generator_Base::get_cap_name(
-                        $this->model(),
-                        $this->action() . '_others_default'
-                    ) => [
-                        'AND'                      => [
-                            EE_QUERY_PLACEHOLDER_USER_FIELD_NAME => EE_QUERY_PLACEHOLDER_CURRENT_USER,
-                            $this->_default_field_name           => true
-                        ],
-                        $this->_default_field_name => false
-                    ]
-                ]
-            );
-        }
-        return $restrictions;
-    }
+		$restrictions = [
+			// first: basically access to non-defaults is essentially
+			// controlled by which events are accessible
+			// if they don't have the basic event cap,
+			// they can't access ANY non-default items
+			EE_Restriction_Generator_Base::get_cap_name(
+				$event_model,
+				$this->action()
+			) => new EE_Default_Where_Conditions(
+				[
+					'OR*no_' .
+					EE_Restriction_Generator_Base::get_cap_name(
+						$event_model,
+						$this->action()
+					) => $this->addPublishedPostConditions(
+						[
+							$this->_default_field_name => true,
+						],
+						true,
+						$this->_path_to_event_model
+					),
+				]
+			),
+			// if they don't have the others event cap,
+			// they can only access their own,
+			// others' that are for published events, or defaults
+			EE_Restriction_Generator_Base::get_cap_name(
+				$event_model,
+				$this->action() . '_others'
+			) => new EE_Default_Where_Conditions(
+				[
+					'OR*no_' .
+					EE_Restriction_Generator_Base::get_cap_name(
+						$event_model,
+						$this->action() . '_others'
+					) => $this->addPublishedPostConditions(
+						[
+							$this->_path_to_event_model . 'EVT_wp_user' => EE_QUERY_PLACEHOLDER_CURRENT_USER,
+							$this->_default_field_name                  => true,
+						],
+						true,
+						$this->_path_to_event_model
+					),
+				]
+			),
+			// if they have basic and others, but not private,
+			// they can access default, their own,
+			// and others' that aren't private
+			EE_Restriction_Generator_Base::get_cap_name(
+				$event_model,
+				$this->action() . '_private'
+			) => new EE_Default_Where_Conditions(
+				[
+					'OR*no_' .
+					EE_Restriction_Generator_Base::get_cap_name(
+						$event_model,
+						$this->action() . '_private'
+					) => $this->addPublishedPostConditions(
+						[
+							$this->_path_to_event_model . 'EVT_wp_user' => EE_QUERY_PLACEHOLDER_CURRENT_USER,
+							$this->_default_field_name                  => true,
+						],
+						false,
+						$this->_path_to_event_model
+					),
+				]
+			),
+			// second: access to defaults is controlled
+			// by the default capabilities
+			// if they don't have the basic default capability,
+			// restrict access to only non-default items
+			EE_Restriction_Generator_Base::get_cap_name(
+				$this->model(),
+				$this->action() . '_default'
+			) => new EE_Default_Where_Conditions(
+				[$this->_default_field_name => false]
+			),
+		];
+		if (
+			EE_Restriction_Generator_Base::is_cap(
+				$this->model(),
+				$this->action() . '_others_default'
+			)
+		) {
+			// if they don't have the "others" default capability,
+			// restrict access to only their default ones, and non-default ones
+			$restrictions[ EE_Restriction_Generator_Base::get_cap_name(
+				$this->model(),
+				$this->action() . '_others_default'
+			) ] = new EE_Default_Where_Conditions(
+				[
+					// if they don't have the others default cap,
+					// they can't access others default items
+					// (but they can access their own default items,
+					// and non-default items)
+					'OR*no_' .
+					EE_Restriction_Generator_Base::get_cap_name(
+						$this->model(),
+						$this->action() . '_others_default'
+					) => [
+						'AND'                      => [
+							EE_QUERY_PLACEHOLDER_USER_FIELD_NAME => EE_QUERY_PLACEHOLDER_CURRENT_USER,
+							$this->_default_field_name           => true
+						],
+						$this->_default_field_name => false
+					]
+				]
+			);
+		}
+		return $restrictions;
+	}
 }

core/db_models/strategies/EE_Restriction_Generator_Event_Related_Protected.strategy.php

Spacing +7 added lines, -7 removed lines

@@ -89,7 +89,7 @@ 
     {
         // if there are no standard caps for this model, then for now
         // all we know if they need the default cap to access this
-        if (! $this->model()->cap_slug()) {
+        if ( ! $this->model()->cap_slug()) {
             return [
                 self::get_default_restrictions_cap(
                 ) => new EE_Return_None_Where_Conditions(),
@@ -110,26 +110,26 @@ 
             // they can't access others' non-default items
             EE_Restriction_Generator_Base::get_cap_name(
                 $event_model,
-                $this->action_for_event() . '_others'
+                $this->action_for_event().'_others'
             ) => new EE_Default_Where_Conditions(
                 [
-                    $this->_path_to_event_model . 'EVT_wp_user' => EE_QUERY_PLACEHOLDER_CURRENT_USER,
+                    $this->_path_to_event_model.'EVT_wp_user' => EE_QUERY_PLACEHOLDER_CURRENT_USER,
                 ]
             ),
             // if they have basic and others, but not private,
             // they can't access others' private non-default items
             EE_Restriction_Generator_Base::get_cap_name(
                 $event_model,
-                $this->action_for_event() . '_private'
+                $this->action_for_event().'_private'
             ) => new EE_Default_Where_Conditions(
                 [
-                    'OR*no_' .
+                    'OR*no_'.
                     EE_Restriction_Generator_Base::get_cap_name(
                         $event_model,
-                        $this->action_for_event() . '_private'
+                        $this->action_for_event().'_private'
                     ) => $this->addPublishedPostConditions(
                         [
-                            $this->_path_to_event_model . 'EVT_wp_user' => EE_QUERY_PLACEHOLDER_CURRENT_USER,
+                            $this->_path_to_event_model.'EVT_wp_user' => EE_QUERY_PLACEHOLDER_CURRENT_USER,
                         ],
                         false,
                         $this->_path_to_event_model

Indentation +116 added lines, -116 removed lines

@@ -13,128 +13,128 @@
  */
 class EE_Restriction_Generator_Event_Related_Protected extends EE_Restriction_Generator_Base
 {
-    /**
-     * Path to the event model from the model this restriction generator will
-     * be applied to; including the event model itself. Eg
-     * "Ticket.Datetime.Event"
-     *
-     * @var string
-     */
-    protected $_path_to_event_model = null;
+	/**
+	 * Path to the event model from the model this restriction generator will
+	 * be applied to; including the event model itself. Eg
+	 * "Ticket.Datetime.Event"
+	 *
+	 * @var string
+	 */
+	protected $_path_to_event_model = null;
 
-    /**
-     * Capability context on event model when creating restrictions.
-     * Eg, although we may want capability restrictions relating to deleting
-     * datetimes, they don't need to be able to DELETE EVENTS, they just need
-     * to be able to EDIT EVENTS in order to DELETE DATETIMES.
-     *
-     * @var string one of EEM_Base::valid_cap_contexts()
-     */
-    protected $_cap_context_on_event_model = null;
+	/**
+	 * Capability context on event model when creating restrictions.
+	 * Eg, although we may want capability restrictions relating to deleting
+	 * datetimes, they don't need to be able to DELETE EVENTS, they just need
+	 * to be able to EDIT EVENTS in order to DELETE DATETIMES.
+	 *
+	 * @var string one of EEM_Base::valid_cap_contexts()
+	 */
+	protected $_cap_context_on_event_model = null;
 
 
-    /**
-     * @param string $path_to_event_model
-     * @param string $cap_context_on_event_model capability context on event
-     *                                           model when creating
-     *                                           restrictions. Eg, although we
-     *                                           may want capability
-     *                                           restrictions relating to
-     *                                           deleting datetimes, they don't
-     *                                           need to be able to DELETE
-     *                                           EVENTS, they just need to be
-     *                                           able to EDIT EVENTS in order
-     *                                           to DELETE DATETIMES. If none
-     *                                           if provided, assumed to be the
-     *                                           same as on the primary model.
-     */
-    public function __construct(
-        string $path_to_event_model,
-        string $cap_context_on_event_model = ''
-    ) {
-        if (substr($path_to_event_model, -1, 1) != '.') {
-            $path_to_event_model .= '.';
-        }
-        $this->_path_to_event_model = $path_to_event_model;
-        $this->_cap_context_on_event_model = $cap_context_on_event_model;
-    }
+	/**
+	 * @param string $path_to_event_model
+	 * @param string $cap_context_on_event_model capability context on event
+	 *                                           model when creating
+	 *                                           restrictions. Eg, although we
+	 *                                           may want capability
+	 *                                           restrictions relating to
+	 *                                           deleting datetimes, they don't
+	 *                                           need to be able to DELETE
+	 *                                           EVENTS, they just need to be
+	 *                                           able to EDIT EVENTS in order
+	 *                                           to DELETE DATETIMES. If none
+	 *                                           if provided, assumed to be the
+	 *                                           same as on the primary model.
+	 */
+	public function __construct(
+		string $path_to_event_model,
+		string $cap_context_on_event_model = ''
+	) {
+		if (substr($path_to_event_model, -1, 1) != '.') {
+			$path_to_event_model .= '.';
+		}
+		$this->_path_to_event_model = $path_to_event_model;
+		$this->_cap_context_on_event_model = $cap_context_on_event_model;
+	}
 
 
-    /**
-     * Returns `$this->_cap_context_on_event_model`, the relevant action
-     * ("read",
-     * "read_admin", "edit" or "delete") for the EVENT related to this model.
-     *
-     * @return string one of EEM_Base::valid_cap_contexts()
-     * @throws EE_Error
-     * @see EE_Restriction_Generator_Event_Related_Protected::__construct()
-     */
-    protected function action_for_event(): ?string
-    {
-        if ($this->_cap_context_on_event_model) {
-            return $this->_cap_context_on_event_model;
-        } else {
-            return $this->action();
-        }
-    }
+	/**
+	 * Returns `$this->_cap_context_on_event_model`, the relevant action
+	 * ("read",
+	 * "read_admin", "edit" or "delete") for the EVENT related to this model.
+	 *
+	 * @return string one of EEM_Base::valid_cap_contexts()
+	 * @throws EE_Error
+	 * @see EE_Restriction_Generator_Event_Related_Protected::__construct()
+	 */
+	protected function action_for_event(): ?string
+	{
+		if ($this->_cap_context_on_event_model) {
+			return $this->_cap_context_on_event_model;
+		} else {
+			return $this->action();
+		}
+	}
 
 
-    /**
-     * @return EE_Default_Where_Conditions[]|EE_Return_None_Where_Conditions[]
-     * @throws EE_Error
-     * @throws EE_Error
-     */
-    protected function _generate_restrictions(): array
-    {
-        // if there are no standard caps for this model, then for now
-        // all we know if they need the default cap to access this
-        if (! $this->model()->cap_slug()) {
-            return [
-                self::get_default_restrictions_cap(
-                ) => new EE_Return_None_Where_Conditions(),
-            ];
-        }
+	/**
+	 * @return EE_Default_Where_Conditions[]|EE_Return_None_Where_Conditions[]
+	 * @throws EE_Error
+	 * @throws EE_Error
+	 */
+	protected function _generate_restrictions(): array
+	{
+		// if there are no standard caps for this model, then for now
+		// all we know if they need the default cap to access this
+		if (! $this->model()->cap_slug()) {
+			return [
+				self::get_default_restrictions_cap(
+				) => new EE_Return_None_Where_Conditions(),
+			];
+		}
 
-        $event_model = EEM_Event::instance();
-        return [
-            // first: basically access to non-defaults is essentially
-            // controlled by which events are accessible
-            // if they don't have the basic event cap,
-            // they can't access ANY non-default items
-            EE_Restriction_Generator_Base::get_cap_name(
-                $event_model,
-                $this->action_for_event()
-            ) => new EE_Return_None_Where_Conditions(),
-            // if they don't have the others event cap,
-            // they can't access others' non-default items
-            EE_Restriction_Generator_Base::get_cap_name(
-                $event_model,
-                $this->action_for_event() . '_others'
-            ) => new EE_Default_Where_Conditions(
-                [
-                    $this->_path_to_event_model . 'EVT_wp_user' => EE_QUERY_PLACEHOLDER_CURRENT_USER,
-                ]
-            ),
-            // if they have basic and others, but not private,
-            // they can't access others' private non-default items
-            EE_Restriction_Generator_Base::get_cap_name(
-                $event_model,
-                $this->action_for_event() . '_private'
-            ) => new EE_Default_Where_Conditions(
-                [
-                    'OR*no_' .
-                    EE_Restriction_Generator_Base::get_cap_name(
-                        $event_model,
-                        $this->action_for_event() . '_private'
-                    ) => $this->addPublishedPostConditions(
-                        [
-                            $this->_path_to_event_model . 'EVT_wp_user' => EE_QUERY_PLACEHOLDER_CURRENT_USER,
-                        ],
-                        false,
-                        $this->_path_to_event_model
-                    )
-                ]
-            ),
-        ];
-    }
+		$event_model = EEM_Event::instance();
+		return [
+			// first: basically access to non-defaults is essentially
+			// controlled by which events are accessible
+			// if they don't have the basic event cap,
+			// they can't access ANY non-default items
+			EE_Restriction_Generator_Base::get_cap_name(
+				$event_model,
+				$this->action_for_event()
+			) => new EE_Return_None_Where_Conditions(),
+			// if they don't have the others event cap,
+			// they can't access others' non-default items
+			EE_Restriction_Generator_Base::get_cap_name(
+				$event_model,
+				$this->action_for_event() . '_others'
+			) => new EE_Default_Where_Conditions(
+				[
+					$this->_path_to_event_model . 'EVT_wp_user' => EE_QUERY_PLACEHOLDER_CURRENT_USER,
+				]
+			),
+			// if they have basic and others, but not private,
+			// they can't access others' private non-default items
+			EE_Restriction_Generator_Base::get_cap_name(
+				$event_model,
+				$this->action_for_event() . '_private'
+			) => new EE_Default_Where_Conditions(
+				[
+					'OR*no_' .
+					EE_Restriction_Generator_Base::get_cap_name(
+						$event_model,
+						$this->action_for_event() . '_private'
+					) => $this->addPublishedPostConditions(
+						[
+							$this->_path_to_event_model . 'EVT_wp_user' => EE_QUERY_PLACEHOLDER_CURRENT_USER,
+						],
+						false,
+						$this->_path_to_event_model
+					)
+				]
+			),
+		];
+	}
 }

core/db_classes/EE_Payment.class.php

Spacing +8 added lines, -8 removed lines

@@ -296,7 +296,7 @@ 
      */
     public function timestamp($dt_frmt = '', $tm_frmt = '')
     {
-        return $this->get_i18n_datetime('PAY_timestamp', trim($dt_frmt . ' ' . $tm_frmt));
+        return $this->get_i18n_datetime('PAY_timestamp', trim($dt_frmt.' '.$tm_frmt));
     }
 
 
@@ -481,7 +481,7 @@ 
                     : '';
                 break;
         }
-        return $icon . $status[ $this->STS_ID() ];
+        return $icon.$status[$this->STS_ID()];
     }
 
 
@@ -627,7 +627,7 @@ 
     public function redirect_form($inside_form_html = null)
     {
         $redirect_url = $this->redirect_url();
-        if (! empty($redirect_url)) {
+        if ( ! empty($redirect_url)) {
             // what ? no inner form content?
             if ($inside_form_html === null) {
                 $inside_form_html = EEH_HTML::p(
@@ -657,7 +657,7 @@ 
                 $get_params = null;
                 parse_str($querystring, $get_params);
                 $inside_form_html .= $this->_args_as_inputs($get_params);
-                $redirect_url = str_replace('?' . $querystring, '', $redirect_url);
+                $redirect_url = str_replace('?'.$querystring, '', $redirect_url);
             }
             $form = EEH_HTML::nl(1)
                     . '<form method="'
@@ -665,9 +665,9 @@ 
                     . '" name="gateway_form" action="'
                     . $redirect_url
                     . '">';
-            $form .= EEH_HTML::nl(1) . $this->redirect_args_as_inputs();
+            $form .= EEH_HTML::nl(1).$this->redirect_args_as_inputs();
             $form .= $inside_form_html;
-            $form .= EEH_HTML::nl(-1) . '</form>' . EEH_HTML::nl(-1);
+            $form .= EEH_HTML::nl(-1).'</form>'.EEH_HTML::nl(-1);
             return $form;
         } else {
             return null;
@@ -725,8 +725,8 @@ 
             return $html;
         }
         return EEH_HTML::nl()
-            . '<input type="hidden" name="' . $name . '"'
-            . ' value="' . esc_attr($value) . '"/>';
+            . '<input type="hidden" name="'.$name.'"'
+            . ' value="'.esc_attr($value).'"/>';
     }
 
 

Indentation +870 added lines, -870 removed lines

@@ -11,874 +11,874 @@
  */
 class EE_Payment extends EE_Base_Class implements EEI_Payment
 {
-    /**
-     * @param array  $props_n_values          incoming values
-     * @param string $timezone                incoming timezone (if not set the timezone set for the website will be
-     *                                        used.)
-     * @param array  $date_formats            incoming date_formats in an array where the first value is the
-     *                                        date_format and the second value is the time format
-     * @return EE_Payment
-     * @throws EE_Error|ReflectionException
-     */
-    public static function new_instance($props_n_values = array(), $timezone = null, $date_formats = array())
-    {
-        $has_object = parent::_check_for_object($props_n_values, __CLASS__, $timezone, $date_formats);
-        return $has_object ? $has_object : new self($props_n_values, false, $timezone, $date_formats);
-    }
-
-
-    /**
-     * @param array  $props_n_values  incoming values from the database
-     * @param string $timezone        incoming timezone as set by the model.  If not set the timezone for
-     *                                the website will be used.
-     * @return EE_Payment
-     * @throws EE_Error
-     */
-    public static function new_instance_from_db($props_n_values = array(), $timezone = null)
-    {
-        return new self($props_n_values, true, $timezone);
-    }
-
-
-    /**
-     * Set Transaction ID
-     *
-     * @access public
-     * @param int $TXN_ID
-     * @throws EE_Error
-     */
-    public function set_transaction_id($TXN_ID = 0)
-    {
-        $this->set('TXN_ID', $TXN_ID);
-    }
-
-
-    /**
-     * Gets the transaction related to this payment
-     *
-     * @return EE_Transaction
-     * @throws EE_Error
-     */
-    public function transaction()
-    {
-        return $this->get_first_related('Transaction');
-    }
-
-
-    /**
-     * Set Status
-     *
-     * @access public
-     * @param string $STS_ID
-     * @throws EE_Error
-     */
-    public function set_status($STS_ID = '')
-    {
-        $this->set('STS_ID', $STS_ID);
-    }
-
-
-    /**
-     * Set Payment Timestamp
-     *
-     * @access public
-     * @param int $timestamp
-     * @throws EE_Error
-     */
-    public function set_timestamp($timestamp = 0)
-    {
-        $this->set('PAY_timestamp', $timestamp);
-    }
-
-
-    /**
-     * Set Payment Method
-     *
-     * @access public
-     * @param string $PAY_source
-     * @throws EE_Error
-     */
-    public function set_source($PAY_source = '')
-    {
-        $this->set('PAY_source', $PAY_source);
-    }
-
-
-    /**
-     * Set Payment Amount
-     *
-     * @access public
-     * @param float $amount
-     * @throws EE_Error
-     */
-    public function set_amount($amount = 0.00)
-    {
-        $this->set('PAY_amount', (float) $amount);
-    }
-
-
-    /**
-     * Set Payment Gateway Response
-     *
-     * @access public
-     * @param string $gateway_response
-     * @throws EE_Error
-     */
-    public function set_gateway_response($gateway_response = '')
-    {
-        $this->set('PAY_gateway_response', $gateway_response);
-    }
-
-
-    /**
-     * Returns the name of the payment method used on this payment (previously known merely as 'gateway')
-     * but since 4.6.0, payment methods are models and the payment keeps a foreign key to the payment method
-     * used on it
-     *
-     * @return string
-     * @throws EE_Error
-     * @deprecated
-     */
-    public function gateway()
-    {
-        EE_Error::doing_it_wrong(
-            'EE_Payment::gateway',
-            esc_html__(
-                'The method EE_Payment::gateway() has been deprecated. Consider instead using EE_Payment::payment_method()->name()',
-                'event_espresso'
-            ),
-            '4.6.0'
-        );
-        return $this->payment_method() ? $this->payment_method()->name() : esc_html__('Unknown', 'event_espresso');
-    }
-
-
-    /**
-     * Set Gateway Transaction ID
-     *
-     * @access public
-     * @param string $txn_id_chq_nmbr
-     * @throws EE_Error
-     */
-    public function set_txn_id_chq_nmbr($txn_id_chq_nmbr = '')
-    {
-        $this->set('PAY_txn_id_chq_nmbr', $txn_id_chq_nmbr);
-    }
-
-
-    /**
-     * Set Purchase Order Number
-     *
-     * @access public
-     * @param string $po_number
-     * @throws EE_Error
-     */
-    public function set_po_number($po_number = '')
-    {
-        $this->set('PAY_po_number', $po_number);
-    }
-
-
-    /**
-     * Set Extra Accounting Field
-     *
-     * @access public
-     * @param string $extra_accntng
-     * @throws EE_Error
-     */
-    public function set_extra_accntng($extra_accntng = '')
-    {
-        $this->set('PAY_extra_accntng', $extra_accntng);
-    }
-
-
-    /**
-     * Set Payment made via admin flag
-     *
-     * @access public
-     * @param bool $via_admin
-     * @throws EE_Error
-     */
-    public function set_payment_made_via_admin($via_admin = false)
-    {
-        if ($via_admin) {
-            $this->set('PAY_source', EEM_Payment_Method::scope_admin);
-        } else {
-            $this->set('PAY_source', EEM_Payment_Method::scope_cart);
-        }
-    }
-
-
-    /**
-     * Set Payment Details
-     *
-     * @access public
-     * @param string|array $details
-     * @throws EE_Error
-     */
-    public function set_details($details = '')
-    {
-        if (is_array($details)) {
-            array_walk_recursive($details, array($this, '_strip_all_tags_within_array'));
-        } else {
-            $details = wp_strip_all_tags($details);
-        }
-        $this->set('PAY_details', $details);
-    }
-
-
-    /**
-     * Sets redirect_url
-     *
-     * @param string $redirect_url
-     * @throws EE_Error
-     */
-    public function set_redirect_url($redirect_url)
-    {
-        $this->set('PAY_redirect_url', $redirect_url);
-    }
-
-
-    /**
-     * Sets redirect_args
-     *
-     * @param array $redirect_args
-     * @throws EE_Error
-     */
-    public function set_redirect_args($redirect_args)
-    {
-        $this->set('PAY_redirect_args', $redirect_args);
-    }
-
-
-    /**
-     * get Payment Transaction ID
-     *
-     * @access public
-     * @throws EE_Error
-     */
-    public function TXN_ID()
-    {
-        return $this->get('TXN_ID');
-    }
-
-
-    /**
-     * get Payment Status
-     *
-     * @access public
-     * @throws EE_Error
-     */
-    public function status()
-    {
-        return $this->get('STS_ID');
-    }
-
-
-    /**
-     * get Payment Status
-     *
-     * @access public
-     * @throws EE_Error
-     */
-    public function STS_ID()
-    {
-        return $this->get('STS_ID');
-    }
-
-
-    /**
-     * get Payment Timestamp
-     *
-     * @access public
-     * @param string $dt_frmt
-     * @param string $tm_frmt
-     * @return string
-     * @throws EE_Error
-     */
-    public function timestamp($dt_frmt = '', $tm_frmt = '')
-    {
-        return $this->get_i18n_datetime('PAY_timestamp', trim($dt_frmt . ' ' . $tm_frmt));
-    }
-
-
-    /**
-     * get Payment Source
-     *
-     * @access public
-     * @throws EE_Error
-     */
-    public function source()
-    {
-        return $this->get('PAY_source');
-    }
-
-
-    /**
-     * get Payment Amount
-     *
-     * @access public
-     * @return float
-     * @throws EE_Error
-     */
-    public function amount()
-    {
-        return (float) $this->get('PAY_amount');
-    }
-
-
-    /**
-     * @return mixed
-     * @throws EE_Error
-     */
-    public function amount_no_code()
-    {
-        return $this->get_pretty('PAY_amount', 'no_currency_code');
-    }
-
-
-    /**
-     * get Payment Gateway Response
-     *
-     * @access public
-     * @throws EE_Error
-     */
-    public function gateway_response()
-    {
-        return $this->get('PAY_gateway_response');
-    }
-
-
-    /**
-     * get Payment Gateway Transaction ID
-     *
-     * @access public
-     * @throws EE_Error
-     */
-    public function txn_id_chq_nmbr()
-    {
-        return $this->get('PAY_txn_id_chq_nmbr');
-    }
-
-
-    /**
-     * get Purchase Order Number
-     *
-     * @access public
-     * @throws EE_Error
-     */
-    public function po_number()
-    {
-        return $this->get('PAY_po_number');
-    }
-
-
-    /**
-     * get Extra Accounting Field
-     *
-     * @access public
-     * @throws EE_Error
-     */
-    public function extra_accntng()
-    {
-        return $this->get('PAY_extra_accntng');
-    }
-
-
-    /**
-     * get Payment made via admin source
-     *
-     * @access public
-     * @throws EE_Error
-     */
-    public function payment_made_via_admin()
-    {
-        return ($this->get('PAY_source') === EEM_Payment_Method::scope_admin);
-    }
-
-
-    /**
-     * get Payment Details
-     *
-     * @access public
-     * @throws EE_Error
-     */
-    public function details()
-    {
-        return $this->get('PAY_details');
-    }
-
-
-    /**
-     * Gets redirect_url
-     *
-     * @return string
-     * @throws EE_Error
-     */
-    public function redirect_url()
-    {
-        return $this->get('PAY_redirect_url');
-    }
-
-
-    /**
-     * Gets redirect_args
-     *
-     * @return array
-     * @throws EE_Error
-     */
-    public function redirect_args()
-    {
-        return $this->get('PAY_redirect_args');
-    }
-
-
-    /**
-     * echoes $this->pretty_status()
-     *
-     * @param bool $show_icons
-     * @return void
-     * @throws EE_Error
-     */
-    public function e_pretty_status($show_icons = false)
-    {
-        echo wp_kses($this->pretty_status($show_icons), AllowedTags::getAllowedTags());
-    }
-
-
-    /**
-     * returns a pretty version of the status, good for displaying to users
-     *
-     * @param bool $show_icons
-     * @return string
-     * @throws EE_Error
-     */
-    public function pretty_status($show_icons = false)
-    {
-        $status = EEM_Status::instance()->localized_status(
-            array($this->STS_ID() => esc_html__('unknown', 'event_espresso')),
-            false,
-            'sentence'
-        );
-        $icon = '';
-        switch ($this->STS_ID()) {
-            case EEM_Payment::status_id_approved:
-                $icon = $show_icons
-                    ? '<span class="dashicons dashicons-yes ee-icon-size-24 green-text"></span>'
-                    : '';
-                break;
-            case EEM_Payment::status_id_pending:
-                $icon = $show_icons
-                    ? '<span class="dashicons dashicons-clock ee-icon-size-16 orange-text"></span>'
-                    : '';
-                break;
-            case EEM_Payment::status_id_cancelled:
-                $icon = $show_icons
-                    ? '<span class="dashicons dashicons-no ee-icon-size-16 lt-grey-text"></span>'
-                    : '';
-                break;
-            case EEM_Payment::status_id_declined:
-                $icon = $show_icons
-                    ? '<span class="dashicons dashicons-no ee-icon-size-16 red-text"></span>'
-                    : '';
-                break;
-        }
-        return $icon . $status[ $this->STS_ID() ];
-    }
-
-
-    /**
-     * For determining the status of the payment
-     *
-     * @return boolean whether the payment is approved or not
-     * @throws EE_Error
-     */
-    public function is_approved()
-    {
-        return $this->status_is(EEM_Payment::status_id_approved);
-    }
-
-
-    /**
-     * Generally determines if the status of this payment equals
-     * the $STS_ID string
-     *
-     * @param string $STS_ID an ID from the esp_status table/
-     *                       one of the status_id_* on the EEM_Payment model
-     * @return boolean whether the status of this payment equals the status id
-     * @throws EE_Error
-     */
-    protected function status_is($STS_ID)
-    {
-        return $STS_ID === $this->STS_ID() ? true : false;
-    }
-
-
-    /**
-     * For determining the status of the payment
-     *
-     * @return boolean whether the payment is pending or not
-     * @throws EE_Error
-     */
-    public function is_pending()
-    {
-        return $this->status_is(EEM_Payment::status_id_pending);
-    }
-
-
-    /**
-     * For determining the status of the payment
-     *
-     * @return boolean
-     * @throws EE_Error
-     */
-    public function is_cancelled()
-    {
-        return $this->status_is(EEM_Payment::status_id_cancelled);
-    }
-
-
-    /**
-     * For determining the status of the payment
-     *
-     * @return boolean
-     * @throws EE_Error
-     */
-    public function is_declined()
-    {
-        return $this->status_is(EEM_Payment::status_id_declined);
-    }
-
-
-    /**
-     * For determining the status of the payment
-     *
-     * @return boolean
-     * @throws EE_Error
-     */
-    public function is_failed()
-    {
-        return $this->status_is(EEM_Payment::status_id_failed);
-    }
-
-
-    /**
-     * For determining if the payment is actually a refund ( ie: has a negative value )
-     *
-     * @return boolean
-     * @throws EE_Error
-     */
-    public function is_a_refund()
-    {
-        return $this->amount() < 0 ? true : false;
-    }
-
-
-    /**
-     * Get the status object of this object
-     *
-     * @return EE_Status
-     * @throws EE_Error
-     */
-    public function status_obj()
-    {
-        return $this->get_first_related('Status');
-    }
-
-
-    /**
-     * Gets all the extra meta info on this payment
-     *
-     * @param array $query_params @see https://github.com/eventespresso/event-espresso-core/tree/master/docs/G--Model-System/model-query-params.md
-     * @return EE_Extra_Meta
-     * @throws EE_Error
-     */
-    public function extra_meta($query_params = array())
-    {
-        return $this->get_many_related('Extra_Meta', $query_params);
-    }
-
-
-    /**
-     * Gets the last-used payment method on this transaction
-     * (we COULD just use the last-made payment, but some payment methods, namely
-     * offline ones, dont' create payments)
-     *
-     * @return EE_Payment_Method
-     * @throws EE_Error
-     */
-    public function payment_method()
-    {
-        return $this->get_first_related('Payment_Method');
-    }
-
-
-    /**
-     * Gets the HTML for redirecting the user to an offsite gateway
-     * You can pass it special content to put inside the form, or use
-     * the default inner content (or possibly generate this all yourself using
-     * redirect_url() and redirect_args() or redirect_args_as_inputs()).
-     * Creates a POST request by default, but if no redirect args are specified, creates a GET request instead
-     * (and any querystring variables in the redirect_url are converted into html inputs
-     * so browsers submit them properly)
-     *
-     * @param string $inside_form_html
-     * @return string html
-     * @throws EE_Error
-     */
-    public function redirect_form($inside_form_html = null)
-    {
-        $redirect_url = $this->redirect_url();
-        if (! empty($redirect_url)) {
-            // what ? no inner form content?
-            if ($inside_form_html === null) {
-                $inside_form_html = EEH_HTML::p(
-                    sprintf(
-                        esc_html__(
-                            'If you are not automatically redirected to the payment website within 10 seconds... %1$s %2$s Click Here %3$s',
-                            'event_espresso'
-                        ),
-                        EEH_HTML::br(2),
-                        '<input type="submit" value="',
-                        '">'
-                    ),
-                    '',
-                    '',
-                    'text-align:center;'
-                );
-            }
-            $method = apply_filters(
-                'FHEE__EE_Payment__redirect_form__method',
-                $this->redirect_args() ? 'POST' : 'GET',
-                $this
-            );
-            // if it's a GET request, we need to remove all the GET params in the querystring
-            // and put them into the form instead
-            if ($method === 'GET') {
-                $querystring = parse_url($redirect_url, PHP_URL_QUERY);
-                $get_params = null;
-                parse_str($querystring, $get_params);
-                $inside_form_html .= $this->_args_as_inputs($get_params);
-                $redirect_url = str_replace('?' . $querystring, '', $redirect_url);
-            }
-            $form = EEH_HTML::nl(1)
-                    . '<form method="'
-                    . $method
-                    . '" name="gateway_form" action="'
-                    . $redirect_url
-                    . '">';
-            $form .= EEH_HTML::nl(1) . $this->redirect_args_as_inputs();
-            $form .= $inside_form_html;
-            $form .= EEH_HTML::nl(-1) . '</form>' . EEH_HTML::nl(-1);
-            return $form;
-        } else {
-            return null;
-        }
-    }
-
-
-    /**
-     * Changes all the name-value pairs of the redirect args into html inputs
-     * and returns the html as a string
-     *
-     * @return string
-     * @throws EE_Error
-     */
-    public function redirect_args_as_inputs()
-    {
-        return $this->_args_as_inputs($this->redirect_args());
-    }
-
-
-    /**
-     * Converts a 2d array of key-value pairs into html hidden inputs
-     * and returns the string of html
-     *
-     * @param array $args key-value pairs
-     * @return string
-     */
-    protected function _args_as_inputs($args)
-    {
-        $html = '';
-        if ($args !== null && is_array($args)) {
-            foreach ($args as $name => $value) {
-                $html .= $this->generateInput($name, $value);
-            }
-        }
-        return $html;
-    }
-
-    /**
-     * Converts either a single name and value or array of values into html hidden inputs
-     * and returns the string of html
-     *
-     * @param string $name
-     * @param string|array $value
-     * @return string
-     */
-    private function generateInput($name, $value)
-    {
-        if (is_array($value)) {
-            $html = '';
-            $name = "{$name}[]";
-            foreach ($value as $array_value) {
-                $html .= $this->generateInput($name, $array_value);
-            }
-            return $html;
-        }
-        return EEH_HTML::nl()
-            . '<input type="hidden" name="' . $name . '"'
-            . ' value="' . esc_attr($value) . '"/>';
-    }
-
-
-    /**
-     * Returns the currency of the payment.
-     * (At the time of writing, this will always be the currency in the configuration;
-     * however in the future it is anticipated that this will be stored on the payment
-     * object itself)
-     *
-     * @return string for the currency code
-     */
-    public function currency_code()
-    {
-        return EE_Config::instance()->currency->code;
-    }
-
-
-    /**
-     * apply wp_strip_all_tags to all elements within an array
-     *
-     * @access private
-     * @param mixed $item
-     */
-    private function _strip_all_tags_within_array(&$item)
-    {
-        if (is_object($item)) {
-            $item = (array) $item;
-        }
-        if (is_array($item)) {
-            array_walk_recursive($item, array($this, '_strip_all_tags_within_array'));
-        } else {
-            $item = wp_strip_all_tags((string) $item);
-        }
-    }
-
-
-    /**
-     * Returns TRUE is this payment was set to approved during this request (or
-     * is approved and was created during this request). False otherwise.
-     *
-     * @return boolean
-     * @throws EE_Error
-     */
-    public function just_approved()
-    {
-        $original_status = EEH_Array::is_set(
-            $this->_props_n_values_provided_in_constructor,
-            'STS_ID',
-            $this->get_model()->field_settings_for('STS_ID')->get_default_value()
-        );
-        $current_status = $this->status();
-        if (
-            $original_status !== EEM_Payment::status_id_approved
-            && $current_status === EEM_Payment::status_id_approved
-        ) {
-            return true;
-        } else {
-            return false;
-        }
-    }
-
-
-    /**
-     * Overrides parents' get_pretty() function just for legacy reasons
-     * (to allow ticket https://events.codebasehq.com/projects/event-espresso/tickets/7420)
-     *
-     * @param string $field_name
-     * @param string $extra_cache_ref This allows the user to specify an extra cache ref for the given property
-     *                                (in cases where the same property may be used for different outputs
-     *                                - i.e. datetime, money etc.)
-     * @return mixed
-     * @throws EE_Error
-     */
-    public function get_pretty($field_name, $extra_cache_ref = null)
-    {
-        if ($field_name === 'PAY_gateway') {
-            return $this->payment_method() ? $this->payment_method()->name() : esc_html__('Unknown', 'event_espresso');
-        }
-        return $this->_get_cached_property($field_name, true, $extra_cache_ref);
-    }
-
-
-    /**
-     * Gets details regarding which registrations this payment was applied to
-     *
-     * @param array $query_params @see https://github.com/eventespresso/event-espresso-core/tree/master/docs/G--Model-System/model-query-params.md
-     * @return EE_Registration_Payment[]
-     * @throws EE_Error
-     */
-    public function registration_payments($query_params = array())
-    {
-        return $this->get_many_related('Registration_Payment', $query_params);
-    }
-
-
-    /**
-     * Gets the first event for this payment (it's possible that it could be for multiple)
-     *
-     * @return EE_Event|null
-     */
-    public function get_first_event()
-    {
-        $transaction = $this->transaction();
-        if ($transaction instanceof EE_Transaction) {
-            $primary_registrant = $transaction->primary_registration();
-            if ($primary_registrant instanceof EE_Registration) {
-                return $primary_registrant->event_obj();
-            }
-        }
-        return null;
-    }
-
-
-    /**
-     * Gets the name of the first event for which is being paid
-     *
-     * @return string
-     */
-    public function get_first_event_name()
-    {
-        $event = $this->get_first_event();
-        return $event instanceof EE_Event ? $event->name() : esc_html__('Event', 'event_espresso');
-    }
-
-
-    /**
-     * Returns the payment's transaction's primary registration
-     *
-     * @return EE_Registration|null
-     */
-    public function get_primary_registration()
-    {
-        if ($this->transaction() instanceof EE_Transaction) {
-            return $this->transaction()->primary_registration();
-        }
-        return null;
-    }
-
-
-    /**
-     * Gets the payment's transaction's primary registration's attendee, or null
-     *
-     * @return EE_Attendee|null
-     */
-    public function get_primary_attendee()
-    {
-        $primary_reg = $this->get_primary_registration();
-        if ($primary_reg instanceof EE_Registration) {
-            return $primary_reg->attendee();
-        }
-        return null;
-    }
+	/**
+	 * @param array  $props_n_values          incoming values
+	 * @param string $timezone                incoming timezone (if not set the timezone set for the website will be
+	 *                                        used.)
+	 * @param array  $date_formats            incoming date_formats in an array where the first value is the
+	 *                                        date_format and the second value is the time format
+	 * @return EE_Payment
+	 * @throws EE_Error|ReflectionException
+	 */
+	public static function new_instance($props_n_values = array(), $timezone = null, $date_formats = array())
+	{
+		$has_object = parent::_check_for_object($props_n_values, __CLASS__, $timezone, $date_formats);
+		return $has_object ? $has_object : new self($props_n_values, false, $timezone, $date_formats);
+	}
+
+
+	/**
+	 * @param array  $props_n_values  incoming values from the database
+	 * @param string $timezone        incoming timezone as set by the model.  If not set the timezone for
+	 *                                the website will be used.
+	 * @return EE_Payment
+	 * @throws EE_Error
+	 */
+	public static function new_instance_from_db($props_n_values = array(), $timezone = null)
+	{
+		return new self($props_n_values, true, $timezone);
+	}
+
+
+	/**
+	 * Set Transaction ID
+	 *
+	 * @access public
+	 * @param int $TXN_ID
+	 * @throws EE_Error
+	 */
+	public function set_transaction_id($TXN_ID = 0)
+	{
+		$this->set('TXN_ID', $TXN_ID);
+	}
+
+
+	/**
+	 * Gets the transaction related to this payment
+	 *
+	 * @return EE_Transaction
+	 * @throws EE_Error
+	 */
+	public function transaction()
+	{
+		return $this->get_first_related('Transaction');
+	}
+
+
+	/**
+	 * Set Status
+	 *
+	 * @access public
+	 * @param string $STS_ID
+	 * @throws EE_Error
+	 */
+	public function set_status($STS_ID = '')
+	{
+		$this->set('STS_ID', $STS_ID);
+	}
+
+
+	/**
+	 * Set Payment Timestamp
+	 *
+	 * @access public
+	 * @param int $timestamp
+	 * @throws EE_Error
+	 */
+	public function set_timestamp($timestamp = 0)
+	{
+		$this->set('PAY_timestamp', $timestamp);
+	}
+
+
+	/**
+	 * Set Payment Method
+	 *
+	 * @access public
+	 * @param string $PAY_source
+	 * @throws EE_Error
+	 */
+	public function set_source($PAY_source = '')
+	{
+		$this->set('PAY_source', $PAY_source);
+	}
+
+
+	/**
+	 * Set Payment Amount
+	 *
+	 * @access public
+	 * @param float $amount
+	 * @throws EE_Error
+	 */
+	public function set_amount($amount = 0.00)
+	{
+		$this->set('PAY_amount', (float) $amount);
+	}
+
+
+	/**
+	 * Set Payment Gateway Response
+	 *
+	 * @access public
+	 * @param string $gateway_response
+	 * @throws EE_Error
+	 */
+	public function set_gateway_response($gateway_response = '')
+	{
+		$this->set('PAY_gateway_response', $gateway_response);
+	}
+
+
+	/**
+	 * Returns the name of the payment method used on this payment (previously known merely as 'gateway')
+	 * but since 4.6.0, payment methods are models and the payment keeps a foreign key to the payment method
+	 * used on it
+	 *
+	 * @return string
+	 * @throws EE_Error
+	 * @deprecated
+	 */
+	public function gateway()
+	{
+		EE_Error::doing_it_wrong(
+			'EE_Payment::gateway',
+			esc_html__(
+				'The method EE_Payment::gateway() has been deprecated. Consider instead using EE_Payment::payment_method()->name()',
+				'event_espresso'
+			),
+			'4.6.0'
+		);
+		return $this->payment_method() ? $this->payment_method()->name() : esc_html__('Unknown', 'event_espresso');
+	}
+
+
+	/**
+	 * Set Gateway Transaction ID
+	 *
+	 * @access public
+	 * @param string $txn_id_chq_nmbr
+	 * @throws EE_Error
+	 */
+	public function set_txn_id_chq_nmbr($txn_id_chq_nmbr = '')
+	{
+		$this->set('PAY_txn_id_chq_nmbr', $txn_id_chq_nmbr);
+	}
+
+
+	/**
+	 * Set Purchase Order Number
+	 *
+	 * @access public
+	 * @param string $po_number
+	 * @throws EE_Error
+	 */
+	public function set_po_number($po_number = '')
+	{
+		$this->set('PAY_po_number', $po_number);
+	}
+
+
+	/**
+	 * Set Extra Accounting Field
+	 *
+	 * @access public
+	 * @param string $extra_accntng
+	 * @throws EE_Error
+	 */
+	public function set_extra_accntng($extra_accntng = '')
+	{
+		$this->set('PAY_extra_accntng', $extra_accntng);
+	}
+
+
+	/**
+	 * Set Payment made via admin flag
+	 *
+	 * @access public
+	 * @param bool $via_admin
+	 * @throws EE_Error
+	 */
+	public function set_payment_made_via_admin($via_admin = false)
+	{
+		if ($via_admin) {
+			$this->set('PAY_source', EEM_Payment_Method::scope_admin);
+		} else {
+			$this->set('PAY_source', EEM_Payment_Method::scope_cart);
+		}
+	}
+
+
+	/**
+	 * Set Payment Details
+	 *
+	 * @access public
+	 * @param string|array $details
+	 * @throws EE_Error
+	 */
+	public function set_details($details = '')
+	{
+		if (is_array($details)) {
+			array_walk_recursive($details, array($this, '_strip_all_tags_within_array'));
+		} else {
+			$details = wp_strip_all_tags($details);
+		}
+		$this->set('PAY_details', $details);
+	}
+
+
+	/**
+	 * Sets redirect_url
+	 *
+	 * @param string $redirect_url
+	 * @throws EE_Error
+	 */
+	public function set_redirect_url($redirect_url)
+	{
+		$this->set('PAY_redirect_url', $redirect_url);
+	}
+
+
+	/**
+	 * Sets redirect_args
+	 *
+	 * @param array $redirect_args
+	 * @throws EE_Error
+	 */
+	public function set_redirect_args($redirect_args)
+	{
+		$this->set('PAY_redirect_args', $redirect_args);
+	}
+
+
+	/**
+	 * get Payment Transaction ID
+	 *
+	 * @access public
+	 * @throws EE_Error
+	 */
+	public function TXN_ID()
+	{
+		return $this->get('TXN_ID');
+	}
+
+
+	/**
+	 * get Payment Status
+	 *
+	 * @access public
+	 * @throws EE_Error
+	 */
+	public function status()
+	{
+		return $this->get('STS_ID');
+	}
+
+
+	/**
+	 * get Payment Status
+	 *
+	 * @access public
+	 * @throws EE_Error
+	 */
+	public function STS_ID()
+	{
+		return $this->get('STS_ID');
+	}
+
+
+	/**
+	 * get Payment Timestamp
+	 *
+	 * @access public
+	 * @param string $dt_frmt
+	 * @param string $tm_frmt
+	 * @return string
+	 * @throws EE_Error
+	 */
+	public function timestamp($dt_frmt = '', $tm_frmt = '')
+	{
+		return $this->get_i18n_datetime('PAY_timestamp', trim($dt_frmt . ' ' . $tm_frmt));
+	}
+
+
+	/**
+	 * get Payment Source
+	 *
+	 * @access public
+	 * @throws EE_Error
+	 */
+	public function source()
+	{
+		return $this->get('PAY_source');
+	}
+
+
+	/**
+	 * get Payment Amount
+	 *
+	 * @access public
+	 * @return float
+	 * @throws EE_Error
+	 */
+	public function amount()
+	{
+		return (float) $this->get('PAY_amount');
+	}
+
+
+	/**
+	 * @return mixed
+	 * @throws EE_Error
+	 */
+	public function amount_no_code()
+	{
+		return $this->get_pretty('PAY_amount', 'no_currency_code');
+	}
+
+
+	/**
+	 * get Payment Gateway Response
+	 *
+	 * @access public
+	 * @throws EE_Error
+	 */
+	public function gateway_response()
+	{
+		return $this->get('PAY_gateway_response');
+	}
+
+
+	/**
+	 * get Payment Gateway Transaction ID
+	 *
+	 * @access public
+	 * @throws EE_Error
+	 */
+	public function txn_id_chq_nmbr()
+	{
+		return $this->get('PAY_txn_id_chq_nmbr');
+	}
+
+
+	/**
+	 * get Purchase Order Number
+	 *
+	 * @access public
+	 * @throws EE_Error
+	 */
+	public function po_number()
+	{
+		return $this->get('PAY_po_number');
+	}
+
+
+	/**
+	 * get Extra Accounting Field
+	 *
+	 * @access public
+	 * @throws EE_Error
+	 */
+	public function extra_accntng()
+	{
+		return $this->get('PAY_extra_accntng');
+	}
+
+
+	/**
+	 * get Payment made via admin source
+	 *
+	 * @access public
+	 * @throws EE_Error
+	 */
+	public function payment_made_via_admin()
+	{
+		return ($this->get('PAY_source') === EEM_Payment_Method::scope_admin);
+	}
+
+
+	/**
+	 * get Payment Details
+	 *
+	 * @access public
+	 * @throws EE_Error
+	 */
+	public function details()
+	{
+		return $this->get('PAY_details');
+	}
+
+
+	/**
+	 * Gets redirect_url
+	 *
+	 * @return string
+	 * @throws EE_Error
+	 */
+	public function redirect_url()
+	{
+		return $this->get('PAY_redirect_url');
+	}
+
+
+	/**
+	 * Gets redirect_args
+	 *
+	 * @return array
+	 * @throws EE_Error
+	 */
+	public function redirect_args()
+	{
+		return $this->get('PAY_redirect_args');
+	}
+
+
+	/**
+	 * echoes $this->pretty_status()
+	 *
+	 * @param bool $show_icons
+	 * @return void
+	 * @throws EE_Error
+	 */
+	public function e_pretty_status($show_icons = false)
+	{
+		echo wp_kses($this->pretty_status($show_icons), AllowedTags::getAllowedTags());
+	}
+
+
+	/**
+	 * returns a pretty version of the status, good for displaying to users
+	 *
+	 * @param bool $show_icons
+	 * @return string
+	 * @throws EE_Error
+	 */
+	public function pretty_status($show_icons = false)
+	{
+		$status = EEM_Status::instance()->localized_status(
+			array($this->STS_ID() => esc_html__('unknown', 'event_espresso')),
+			false,
+			'sentence'
+		);
+		$icon = '';
+		switch ($this->STS_ID()) {
+			case EEM_Payment::status_id_approved:
+				$icon = $show_icons
+					? '<span class="dashicons dashicons-yes ee-icon-size-24 green-text"></span>'
+					: '';
+				break;
+			case EEM_Payment::status_id_pending:
+				$icon = $show_icons
+					? '<span class="dashicons dashicons-clock ee-icon-size-16 orange-text"></span>'
+					: '';
+				break;
+			case EEM_Payment::status_id_cancelled:
+				$icon = $show_icons
+					? '<span class="dashicons dashicons-no ee-icon-size-16 lt-grey-text"></span>'
+					: '';
+				break;
+			case EEM_Payment::status_id_declined:
+				$icon = $show_icons
+					? '<span class="dashicons dashicons-no ee-icon-size-16 red-text"></span>'
+					: '';
+				break;
+		}
+		return $icon . $status[ $this->STS_ID() ];
+	}
+
+
+	/**
+	 * For determining the status of the payment
+	 *
+	 * @return boolean whether the payment is approved or not
+	 * @throws EE_Error
+	 */
+	public function is_approved()
+	{
+		return $this->status_is(EEM_Payment::status_id_approved);
+	}
+
+
+	/**
+	 * Generally determines if the status of this payment equals
+	 * the $STS_ID string
+	 *
+	 * @param string $STS_ID an ID from the esp_status table/
+	 *                       one of the status_id_* on the EEM_Payment model
+	 * @return boolean whether the status of this payment equals the status id
+	 * @throws EE_Error
+	 */
+	protected function status_is($STS_ID)
+	{
+		return $STS_ID === $this->STS_ID() ? true : false;
+	}
+
+
+	/**
+	 * For determining the status of the payment
+	 *
+	 * @return boolean whether the payment is pending or not
+	 * @throws EE_Error
+	 */
+	public function is_pending()
+	{
+		return $this->status_is(EEM_Payment::status_id_pending);
+	}
+
+
+	/**
+	 * For determining the status of the payment
+	 *
+	 * @return boolean
+	 * @throws EE_Error
+	 */
+	public function is_cancelled()
+	{
+		return $this->status_is(EEM_Payment::status_id_cancelled);
+	}
+
+
+	/**
+	 * For determining the status of the payment
+	 *
+	 * @return boolean
+	 * @throws EE_Error
+	 */
+	public function is_declined()
+	{
+		return $this->status_is(EEM_Payment::status_id_declined);
+	}
+
+
+	/**
+	 * For determining the status of the payment
+	 *
+	 * @return boolean
+	 * @throws EE_Error
+	 */
+	public function is_failed()
+	{
+		return $this->status_is(EEM_Payment::status_id_failed);
+	}
+
+
+	/**
+	 * For determining if the payment is actually a refund ( ie: has a negative value )
+	 *
+	 * @return boolean
+	 * @throws EE_Error
+	 */
+	public function is_a_refund()
+	{
+		return $this->amount() < 0 ? true : false;
+	}
+
+
+	/**
+	 * Get the status object of this object
+	 *
+	 * @return EE_Status
+	 * @throws EE_Error
+	 */
+	public function status_obj()
+	{
+		return $this->get_first_related('Status');
+	}
+
+
+	/**
+	 * Gets all the extra meta info on this payment
+	 *
+	 * @param array $query_params @see https://github.com/eventespresso/event-espresso-core/tree/master/docs/G--Model-System/model-query-params.md
+	 * @return EE_Extra_Meta
+	 * @throws EE_Error
+	 */
+	public function extra_meta($query_params = array())
+	{
+		return $this->get_many_related('Extra_Meta', $query_params);
+	}
+
+
+	/**
+	 * Gets the last-used payment method on this transaction
+	 * (we COULD just use the last-made payment, but some payment methods, namely
+	 * offline ones, dont' create payments)
+	 *
+	 * @return EE_Payment_Method
+	 * @throws EE_Error
+	 */
+	public function payment_method()
+	{
+		return $this->get_first_related('Payment_Method');
+	}
+
+
+	/**
+	 * Gets the HTML for redirecting the user to an offsite gateway
+	 * You can pass it special content to put inside the form, or use
+	 * the default inner content (or possibly generate this all yourself using
+	 * redirect_url() and redirect_args() or redirect_args_as_inputs()).
+	 * Creates a POST request by default, but if no redirect args are specified, creates a GET request instead
+	 * (and any querystring variables in the redirect_url are converted into html inputs
+	 * so browsers submit them properly)
+	 *
+	 * @param string $inside_form_html
+	 * @return string html
+	 * @throws EE_Error
+	 */
+	public function redirect_form($inside_form_html = null)
+	{
+		$redirect_url = $this->redirect_url();
+		if (! empty($redirect_url)) {
+			// what ? no inner form content?
+			if ($inside_form_html === null) {
+				$inside_form_html = EEH_HTML::p(
+					sprintf(
+						esc_html__(
+							'If you are not automatically redirected to the payment website within 10 seconds... %1$s %2$s Click Here %3$s',
+							'event_espresso'
+						),
+						EEH_HTML::br(2),
+						'<input type="submit" value="',
+						'">'
+					),
+					'',
+					'',
+					'text-align:center;'
+				);
+			}
+			$method = apply_filters(
+				'FHEE__EE_Payment__redirect_form__method',
+				$this->redirect_args() ? 'POST' : 'GET',
+				$this
+			);
+			// if it's a GET request, we need to remove all the GET params in the querystring
+			// and put them into the form instead
+			if ($method === 'GET') {
+				$querystring = parse_url($redirect_url, PHP_URL_QUERY);
+				$get_params = null;
+				parse_str($querystring, $get_params);
+				$inside_form_html .= $this->_args_as_inputs($get_params);
+				$redirect_url = str_replace('?' . $querystring, '', $redirect_url);
+			}
+			$form = EEH_HTML::nl(1)
+					. '<form method="'
+					. $method
+					. '" name="gateway_form" action="'
+					. $redirect_url
+					. '">';
+			$form .= EEH_HTML::nl(1) . $this->redirect_args_as_inputs();
+			$form .= $inside_form_html;
+			$form .= EEH_HTML::nl(-1) . '</form>' . EEH_HTML::nl(-1);
+			return $form;
+		} else {
+			return null;
+		}
+	}
+
+
+	/**
+	 * Changes all the name-value pairs of the redirect args into html inputs
+	 * and returns the html as a string
+	 *
+	 * @return string
+	 * @throws EE_Error
+	 */
+	public function redirect_args_as_inputs()
+	{
+		return $this->_args_as_inputs($this->redirect_args());
+	}
+
+
+	/**
+	 * Converts a 2d array of key-value pairs into html hidden inputs
+	 * and returns the string of html
+	 *
+	 * @param array $args key-value pairs
+	 * @return string
+	 */
+	protected function _args_as_inputs($args)
+	{
+		$html = '';
+		if ($args !== null && is_array($args)) {
+			foreach ($args as $name => $value) {
+				$html .= $this->generateInput($name, $value);
+			}
+		}
+		return $html;
+	}
+
+	/**
+	 * Converts either a single name and value or array of values into html hidden inputs
+	 * and returns the string of html
+	 *
+	 * @param string $name
+	 * @param string|array $value
+	 * @return string
+	 */
+	private function generateInput($name, $value)
+	{
+		if (is_array($value)) {
+			$html = '';
+			$name = "{$name}[]";
+			foreach ($value as $array_value) {
+				$html .= $this->generateInput($name, $array_value);
+			}
+			return $html;
+		}
+		return EEH_HTML::nl()
+			. '<input type="hidden" name="' . $name . '"'
+			. ' value="' . esc_attr($value) . '"/>';
+	}
+
+
+	/**
+	 * Returns the currency of the payment.
+	 * (At the time of writing, this will always be the currency in the configuration;
+	 * however in the future it is anticipated that this will be stored on the payment
+	 * object itself)
+	 *
+	 * @return string for the currency code
+	 */
+	public function currency_code()
+	{
+		return EE_Config::instance()->currency->code;
+	}
+
+
+	/**
+	 * apply wp_strip_all_tags to all elements within an array
+	 *
+	 * @access private
+	 * @param mixed $item
+	 */
+	private function _strip_all_tags_within_array(&$item)
+	{
+		if (is_object($item)) {
+			$item = (array) $item;
+		}
+		if (is_array($item)) {
+			array_walk_recursive($item, array($this, '_strip_all_tags_within_array'));
+		} else {
+			$item = wp_strip_all_tags((string) $item);
+		}
+	}
+
+
+	/**
+	 * Returns TRUE is this payment was set to approved during this request (or
+	 * is approved and was created during this request). False otherwise.
+	 *
+	 * @return boolean
+	 * @throws EE_Error
+	 */
+	public function just_approved()
+	{
+		$original_status = EEH_Array::is_set(
+			$this->_props_n_values_provided_in_constructor,
+			'STS_ID',
+			$this->get_model()->field_settings_for('STS_ID')->get_default_value()
+		);
+		$current_status = $this->status();
+		if (
+			$original_status !== EEM_Payment::status_id_approved
+			&& $current_status === EEM_Payment::status_id_approved
+		) {
+			return true;
+		} else {
+			return false;
+		}
+	}
+
+
+	/**
+	 * Overrides parents' get_pretty() function just for legacy reasons
+	 * (to allow ticket https://events.codebasehq.com/projects/event-espresso/tickets/7420)
+	 *
+	 * @param string $field_name
+	 * @param string $extra_cache_ref This allows the user to specify an extra cache ref for the given property
+	 *                                (in cases where the same property may be used for different outputs
+	 *                                - i.e. datetime, money etc.)
+	 * @return mixed
+	 * @throws EE_Error
+	 */
+	public function get_pretty($field_name, $extra_cache_ref = null)
+	{
+		if ($field_name === 'PAY_gateway') {
+			return $this->payment_method() ? $this->payment_method()->name() : esc_html__('Unknown', 'event_espresso');
+		}
+		return $this->_get_cached_property($field_name, true, $extra_cache_ref);
+	}
+
+
+	/**
+	 * Gets details regarding which registrations this payment was applied to
+	 *
+	 * @param array $query_params @see https://github.com/eventespresso/event-espresso-core/tree/master/docs/G--Model-System/model-query-params.md
+	 * @return EE_Registration_Payment[]
+	 * @throws EE_Error
+	 */
+	public function registration_payments($query_params = array())
+	{
+		return $this->get_many_related('Registration_Payment', $query_params);
+	}
+
+
+	/**
+	 * Gets the first event for this payment (it's possible that it could be for multiple)
+	 *
+	 * @return EE_Event|null
+	 */
+	public function get_first_event()
+	{
+		$transaction = $this->transaction();
+		if ($transaction instanceof EE_Transaction) {
+			$primary_registrant = $transaction->primary_registration();
+			if ($primary_registrant instanceof EE_Registration) {
+				return $primary_registrant->event_obj();
+			}
+		}
+		return null;
+	}
+
+
+	/**
+	 * Gets the name of the first event for which is being paid
+	 *
+	 * @return string
+	 */
+	public function get_first_event_name()
+	{
+		$event = $this->get_first_event();
+		return $event instanceof EE_Event ? $event->name() : esc_html__('Event', 'event_espresso');
+	}
+
+
+	/**
+	 * Returns the payment's transaction's primary registration
+	 *
+	 * @return EE_Registration|null
+	 */
+	public function get_primary_registration()
+	{
+		if ($this->transaction() instanceof EE_Transaction) {
+			return $this->transaction()->primary_registration();
+		}
+		return null;
+	}
+
+
+	/**
+	 * Gets the payment's transaction's primary registration's attendee, or null
+	 *
+	 * @return EE_Attendee|null
+	 */
+	public function get_primary_attendee()
+	{
+		$primary_reg = $this->get_primary_registration();
+		if ($primary_reg instanceof EE_Registration) {
+			return $primary_reg->attendee();
+		}
+		return null;
+	}
 }

core/db_classes/EE_Payment_Method.class.php

Spacing +8 added lines, -8 removed lines

@@ -445,11 +445,11 @@ 
      */
     public function type_obj()
     {
-        if (! $this->_type_obj) {
+        if ( ! $this->_type_obj) {
             EE_Registry::instance()->load_lib('Payment_Method_Manager');
             if (EE_Payment_Method_Manager::instance()->payment_method_type_exists($this->type())) {
                 $class_name = EE_Payment_Method_Manager::instance()->payment_method_class_from_type($this->type());
-                if (! class_exists($class_name)) {
+                if ( ! class_exists($class_name)) {
                     throw new EE_Error(
                         sprintf(
                             esc_html__(
@@ -458,7 +458,7 @@ 
                             ),
                             $class_name,
                             '<br />',
-                            '<a href="' . admin_url('plugins.php') . '">',
+                            '<a href="'.admin_url('plugins.php').'">',
                             '</a>'
                         )
                     );
@@ -499,7 +499,7 @@ 
         foreach ($fields as $key => $value) {
             if (strpos($key, 'PMD_') === 0) {
                 $key_sans_model_prefix = str_replace('PMD_', '', $key);
-                $combined_settings_array [ $key_sans_model_prefix ] = $value;
+                $combined_settings_array [$key_sans_model_prefix] = $value;
             }
         }
         $combined_settings_array = array_merge($extra_meta, $combined_settings_array);
@@ -522,14 +522,14 @@ 
 		 <div id="'
                . $this->slug()
                . '-payment-option-dv" class="'
-               . $payment_occurs . '-payment-gateway reg-page-payment-option-dv' . $css_class . '">
+               . $payment_occurs.'-payment-gateway reg-page-payment-option-dv'.$css_class.'">
 			<a id="payment-gateway-button-' . $this->slug()
                . '" class="reg-page-payment-option-lnk" rel="'
-               . $this->slug() . '" href="' . $url . '" >
-				<img src="' . $this->button_url() . '" alt="' . sprintf(
+               . $this->slug().'" href="'.$url.'" >
+				<img src="' . $this->button_url().'" alt="'.sprintf(
                    esc_attr__('Pay using %s', 'event_espresso'),
                    $this->get_pretty('PMD_name', 'form_input')
-               ) . '" />
+               ).'" />
 			</a>
 		</div>
 ';

Indentation +572 added lines, -572 removed lines

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

core/domain/services/graphql/enums/TicketVisibilityEnum.php

Spacing +1 added lines, -1 removed lines

@@ -22,7 +22,7 @@
      */
     public function __construct()
     {
-        $this->setName($this->namespace . 'TicketVisibilityEnum');
+        $this->setName($this->namespace.'TicketVisibilityEnum');
         $this->setDescription(esc_html__('Where the ticket can be viewed throughout the UI', 'event_espresso'));
         parent::__construct();
     }

Indentation +18 added lines, -18 removed lines

@@ -17,24 +17,24 @@
  */
 class TicketVisibilityEnum extends EnumBase
 {
-    /**
-     * TicketVisibilityEnum constructor.
-     */
-    public function __construct()
-    {
-        $this->setName($this->namespace . 'TicketVisibilityEnum');
-        $this->setDescription(esc_html__('Where the ticket can be viewed throughout the UI', 'event_espresso'));
-        parent::__construct();
-    }
+	/**
+	 * TicketVisibilityEnum constructor.
+	 */
+	public function __construct()
+	{
+		$this->setName($this->namespace . 'TicketVisibilityEnum');
+		$this->setDescription(esc_html__('Where the ticket can be viewed throughout the UI', 'event_espresso'));
+		parent::__construct();
+	}
 
 
-    /**
-     * @return array
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    protected function getValues(): array
-    {
-        return EEM_Ticket::instance()->getTicketVisibilityValues();
-    }
+	/**
+	 * @return array
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	protected function getValues(): array
+	{
+		return EEM_Ticket::instance()->getTicketVisibilityValues();
+	}
 }

core/domain/services/graphql/data/mutations/TicketMutation.php

Spacing +9 added lines, -9 removed lines

@@ -35,7 +35,7 @@ 
     {
         $args = [];
 
-        if (! empty($input['datetimes'])) {
+        if ( ! empty($input['datetimes'])) {
             $args['datetimes'] = array_map('sanitize_text_field', (array) $input['datetimes']);
         }
 
@@ -43,7 +43,7 @@ 
             $args['TKT_description'] = wp_kses_post($input['description']);
         }
 
-        if (! empty($input['endDate'])) {
+        if ( ! empty($input['endDate'])) {
             $args['TKT_end_date'] = new DateTime(sanitize_text_field($input['endDate']));
         }
 
@@ -79,9 +79,9 @@ 
             $args['TKT_order'] = (int) $input['order'];
         }
 
-        if (! empty($input['parent'])) {
+        if ( ! empty($input['parent'])) {
             $parts = Relay::fromGlobalId(sanitize_text_field($input['parent']));
-            $args['TKT_parent'] = (! empty($parts['id']) && is_int($parts['id'])) ? $parts['id'] : null;
+            $args['TKT_parent'] = ( ! empty($parts['id']) && is_int($parts['id'])) ? $parts['id'] : null;
         }
 
         // price can be 0
@@ -114,7 +114,7 @@ 
             $args['TKT_sold'] = (int) $input['sold'];
         }
 
-        if (! empty($input['startDate'])) {
+        if ( ! empty($input['startDate'])) {
             $args['TKT_start_date'] = new DateTime(sanitize_text_field($input['startDate']));
         }
 
@@ -122,9 +122,9 @@ 
             $args['TKT_uses'] = (int) $input['uses'];
         }
 
-        if (! empty($input['wpUser'])) {
+        if ( ! empty($input['wpUser'])) {
             $parts = Relay::fromGlobalId(sanitize_text_field($input['wpUser']));
-            $args['TKT_wp_user'] = (! empty($parts['id']) && is_int($parts['id'])) ? $parts['id'] : null;
+            $args['TKT_wp_user'] = ( ! empty($parts['id']) && is_int($parts['id'])) ? $parts['id'] : null;
         }
 
         if (array_key_exists('visibility', $input)) {
@@ -159,7 +159,7 @@ 
         // @todo replace loop with single query
         foreach ($datetimes as $ID) {
             $parts = Relay::fromGlobalId($ID);
-            if (! empty($parts['id']) && absint($parts['id'])) {
+            if ( ! empty($parts['id']) && absint($parts['id'])) {
                 $entity->_add_relation_to(
                     $parts['id'],
                     $relationName
@@ -189,7 +189,7 @@ 
         // @todo replace loop with single query
         foreach ($prices as $ID) {
             $parts = Relay::fromGlobalId($ID);
-            if (! empty($parts['id']) && absint($parts['id'])) {
+            if ( ! empty($parts['id']) && absint($parts['id'])) {
                 $entity->_add_relation_to(
                     $parts['id'],
                     $relationName

Indentation +191 added lines, -191 removed lines

@@ -22,195 +22,195 @@
  */
 class TicketMutation
 {
-    /**
-     * Maps the GraphQL input to a format that the model functions can use
-     *
-     * @param array $input Data coming from the GraphQL mutation query input
-     * @return array
-     * @throws Exception
-     */
-    public static function prepareFields(array $input): array
-    {
-        $args = [];
-
-        if (! empty($input['datetimes'])) {
-            $args['datetimes'] = array_map('sanitize_text_field', (array) $input['datetimes']);
-        }
-
-        if (isset($input['description'])) {
-            $args['TKT_description'] = wp_kses_post($input['description']);
-        }
-
-        if (! empty($input['endDate'])) {
-            $args['TKT_end_date'] = new DateTime(sanitize_text_field($input['endDate']));
-        }
-
-        if (array_key_exists('isDefault', $input)) {
-            $args['TKT_is_default'] = (bool) $input['isDefault'];
-        }
-
-        if (array_key_exists('isRequired', $input)) {
-            $args['TKT_required'] = (bool) $input['isRequired'];
-        }
-
-        if (array_key_exists('isTaxable', $input)) {
-            $args['TKT_taxable'] = (bool) $input['isTaxable'];
-        }
-
-        if (array_key_exists('isTrashed', $input)) {
-            $args['TKT_deleted'] = (bool) $input['isTrashed'];
-        }
-
-        if (array_key_exists('max', $input)) {
-            $args['TKT_max'] = (int) $input['max'];
-        }
-
-        if (array_key_exists('min', $input)) {
-            $args['TKT_min'] = (int) $input['min'];
-        }
-
-        if (isset($input['name'])) {
-            $args['TKT_name'] = sanitize_text_field($input['name']);
-        }
-
-        if (array_key_exists('order', $input)) {
-            $args['TKT_order'] = (int) $input['order'];
-        }
-
-        if (! empty($input['parent'])) {
-            $parts = Relay::fromGlobalId(sanitize_text_field($input['parent']));
-            $args['TKT_parent'] = (! empty($parts['id']) && is_int($parts['id'])) ? $parts['id'] : null;
-        }
-
-        // price can be 0
-        if (array_key_exists('price', $input)) {
-            $args['TKT_price'] = (float) $input['price'];
-        }
-
-        // prices can be an empty array when all prices are deleted
-        if (array_key_exists('prices', $input) && is_array($input['prices'])) {
-            $args['prices'] = array_map('sanitize_text_field', $input['prices']);
-        }
-
-        if (array_key_exists('quantity', $input)) {
-            $args['TKT_qty'] = (int) $input['quantity'];
-        }
-
-        if (array_key_exists('reserved', $input)) {
-            $args['TKT_reserved'] = (int) $input['reserved'];
-        }
-
-        if (array_key_exists('reverseCalculate', $input)) {
-            $args['TKT_reverse_calculate'] = (bool) $input['reverseCalculate'];
-        }
-
-        if (array_key_exists('row', $input)) {
-            $args['TKT_row'] = (int) $input['row'];
-        }
-
-        if (array_key_exists('sold', $input)) {
-            $args['TKT_sold'] = (int) $input['sold'];
-        }
-
-        if (! empty($input['startDate'])) {
-            $args['TKT_start_date'] = new DateTime(sanitize_text_field($input['startDate']));
-        }
-
-        if (array_key_exists('uses', $input)) {
-            $args['TKT_uses'] = (int) $input['uses'];
-        }
-
-        if (! empty($input['wpUser'])) {
-            $parts = Relay::fromGlobalId(sanitize_text_field($input['wpUser']));
-            $args['TKT_wp_user'] = (! empty($parts['id']) && is_int($parts['id'])) ? $parts['id'] : null;
-        }
-
-        if (array_key_exists('visibility', $input)) {
-            $args['TKT_visibility'] = (int) $input['visibility'];
-        }
-
-        return apply_filters(
-            'FHEE__EventEspresso_core_domain_services_graphql_data_mutations__ticket_args',
-            $args,
-            $input
-        );
-    }
-
-
-    /**
-     * Sets the related datetimes for the given ticket.
-     *
-     * @param EE_Ticket $entity    The Ticket instance.
-     * @param array     $datetimes Array of datetime IDs to relate.
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     * @throws ReflectionException
-     */
-    public static function setRelatedDatetimes(EE_Ticket $entity, array $datetimes)
-    {
-        $relationName = 'Datetime';
-        // Remove all the existing related datetimes
-
-        $entity->_remove_relations($relationName);
-        // @todo replace loop with single query
-        foreach ($datetimes as $ID) {
-            $parts = Relay::fromGlobalId($ID);
-            if (! empty($parts['id']) && absint($parts['id'])) {
-                $entity->_add_relation_to(
-                    $parts['id'],
-                    $relationName
-                );
-            }
-        }
-    }
-
-
-    /**
-     * Sets the related prices for the given ticket.
-     *
-     * @param EE_Ticket $entity The Ticket instance.
-     * @param array     $prices Array of entity IDs to relate.
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     * @throws ReflectionException
-     */
-    public static function setRelatedPrices(EE_Ticket $entity, array $prices)
-    {
-        $relationName = 'Price';
-        // Remove all the existing related entities
-        $entity->_remove_relations($relationName);
-
-        // @todo replace loop with single query
-        foreach ($prices as $ID) {
-            $parts = Relay::fromGlobalId($ID);
-            if (! empty($parts['id']) && absint($parts['id'])) {
-                $entity->_add_relation_to(
-                    $parts['id'],
-                    $relationName
-                );
-            }
-        }
-    }
-
-
-    /**
-     * @param EE_Ticket  $ticket_entity
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     * @throws ReflectionException
-     */
-    public static function addDefaultPrices(EE_Ticket $ticket_entity)
-    {
-        /** @var DefaultPrices $default_prices */
-        $default_prices = LoaderFactory::getLoader()->getShared(
-            'EventEspresso\core\domain\services\admin\entities\DefaultPrices'
-        );
-        $default_prices->create($ticket_entity);
-    }
+	/**
+	 * Maps the GraphQL input to a format that the model functions can use
+	 *
+	 * @param array $input Data coming from the GraphQL mutation query input
+	 * @return array
+	 * @throws Exception
+	 */
+	public static function prepareFields(array $input): array
+	{
+		$args = [];
+
+		if (! empty($input['datetimes'])) {
+			$args['datetimes'] = array_map('sanitize_text_field', (array) $input['datetimes']);
+		}
+
+		if (isset($input['description'])) {
+			$args['TKT_description'] = wp_kses_post($input['description']);
+		}
+
+		if (! empty($input['endDate'])) {
+			$args['TKT_end_date'] = new DateTime(sanitize_text_field($input['endDate']));
+		}
+
+		if (array_key_exists('isDefault', $input)) {
+			$args['TKT_is_default'] = (bool) $input['isDefault'];
+		}
+
+		if (array_key_exists('isRequired', $input)) {
+			$args['TKT_required'] = (bool) $input['isRequired'];
+		}
+
+		if (array_key_exists('isTaxable', $input)) {
+			$args['TKT_taxable'] = (bool) $input['isTaxable'];
+		}
+
+		if (array_key_exists('isTrashed', $input)) {
+			$args['TKT_deleted'] = (bool) $input['isTrashed'];
+		}
+
+		if (array_key_exists('max', $input)) {
+			$args['TKT_max'] = (int) $input['max'];
+		}
+
+		if (array_key_exists('min', $input)) {
+			$args['TKT_min'] = (int) $input['min'];
+		}
+
+		if (isset($input['name'])) {
+			$args['TKT_name'] = sanitize_text_field($input['name']);
+		}
+
+		if (array_key_exists('order', $input)) {
+			$args['TKT_order'] = (int) $input['order'];
+		}
+
+		if (! empty($input['parent'])) {
+			$parts = Relay::fromGlobalId(sanitize_text_field($input['parent']));
+			$args['TKT_parent'] = (! empty($parts['id']) && is_int($parts['id'])) ? $parts['id'] : null;
+		}
+
+		// price can be 0
+		if (array_key_exists('price', $input)) {
+			$args['TKT_price'] = (float) $input['price'];
+		}
+
+		// prices can be an empty array when all prices are deleted
+		if (array_key_exists('prices', $input) && is_array($input['prices'])) {
+			$args['prices'] = array_map('sanitize_text_field', $input['prices']);
+		}
+
+		if (array_key_exists('quantity', $input)) {
+			$args['TKT_qty'] = (int) $input['quantity'];
+		}
+
+		if (array_key_exists('reserved', $input)) {
+			$args['TKT_reserved'] = (int) $input['reserved'];
+		}
+
+		if (array_key_exists('reverseCalculate', $input)) {
+			$args['TKT_reverse_calculate'] = (bool) $input['reverseCalculate'];
+		}
+
+		if (array_key_exists('row', $input)) {
+			$args['TKT_row'] = (int) $input['row'];
+		}
+
+		if (array_key_exists('sold', $input)) {
+			$args['TKT_sold'] = (int) $input['sold'];
+		}
+
+		if (! empty($input['startDate'])) {
+			$args['TKT_start_date'] = new DateTime(sanitize_text_field($input['startDate']));
+		}
+
+		if (array_key_exists('uses', $input)) {
+			$args['TKT_uses'] = (int) $input['uses'];
+		}
+
+		if (! empty($input['wpUser'])) {
+			$parts = Relay::fromGlobalId(sanitize_text_field($input['wpUser']));
+			$args['TKT_wp_user'] = (! empty($parts['id']) && is_int($parts['id'])) ? $parts['id'] : null;
+		}
+
+		if (array_key_exists('visibility', $input)) {
+			$args['TKT_visibility'] = (int) $input['visibility'];
+		}
+
+		return apply_filters(
+			'FHEE__EventEspresso_core_domain_services_graphql_data_mutations__ticket_args',
+			$args,
+			$input
+		);
+	}
+
+
+	/**
+	 * Sets the related datetimes for the given ticket.
+	 *
+	 * @param EE_Ticket $entity    The Ticket instance.
+	 * @param array     $datetimes Array of datetime IDs to relate.
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 * @throws ReflectionException
+	 */
+	public static function setRelatedDatetimes(EE_Ticket $entity, array $datetimes)
+	{
+		$relationName = 'Datetime';
+		// Remove all the existing related datetimes
+
+		$entity->_remove_relations($relationName);
+		// @todo replace loop with single query
+		foreach ($datetimes as $ID) {
+			$parts = Relay::fromGlobalId($ID);
+			if (! empty($parts['id']) && absint($parts['id'])) {
+				$entity->_add_relation_to(
+					$parts['id'],
+					$relationName
+				);
+			}
+		}
+	}
+
+
+	/**
+	 * Sets the related prices for the given ticket.
+	 *
+	 * @param EE_Ticket $entity The Ticket instance.
+	 * @param array     $prices Array of entity IDs to relate.
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 * @throws ReflectionException
+	 */
+	public static function setRelatedPrices(EE_Ticket $entity, array $prices)
+	{
+		$relationName = 'Price';
+		// Remove all the existing related entities
+		$entity->_remove_relations($relationName);
+
+		// @todo replace loop with single query
+		foreach ($prices as $ID) {
+			$parts = Relay::fromGlobalId($ID);
+			if (! empty($parts['id']) && absint($parts['id'])) {
+				$entity->_add_relation_to(
+					$parts['id'],
+					$relationName
+				);
+			}
+		}
+	}
+
+
+	/**
+	 * @param EE_Ticket  $ticket_entity
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 * @throws ReflectionException
+	 */
+	public static function addDefaultPrices(EE_Ticket $ticket_entity)
+	{
+		/** @var DefaultPrices $default_prices */
+		$default_prices = LoaderFactory::getLoader()->getShared(
+			'EventEspresso\core\domain\services\admin\entities\DefaultPrices'
+		);
+		$default_prices->create($ticket_entity);
+	}
 }

core/domain/entities/users/CurrentUser.php

Spacing +1 added lines, -1 removed lines

@@ -50,7 +50,7 @@
 
     public function setCurrentUser(): void
     {
-        if (! $this->current_user instanceof WP_User) {
+        if ( ! $this->current_user instanceof WP_User) {
             $this->current_user = wp_get_current_user();
             $event_manager_roles    = array_keys($this->event_managers->roles());
             $current_user_roles     = $this->current_user->roles;

Indentation +74 added lines, -74 removed lines

@@ -13,78 +13,78 @@
  */
 class CurrentUser
 {
-    /**
-     * @var WP_User
-     */
-    private $current_user;
-
-    /**
-     * @var boolean
-     */
-    private $is_event_manager = false;
-
-    /**
-     * @var boolean
-     */
-    private $is_logged_in = false;
-
-
-    /**
-     * @var EventManagers
-     */
-    private $event_managers;
-
-
-    /**
-     * CurrentUser constructor.
-     *
-     * @param EventManagers $event_managers
-     */
-    public function __construct(EventManagers $event_managers)
-    {
-        $this->event_managers = $event_managers;
-        $this->setCurrentUser();
-    }
-
-
-    public function setCurrentUser(): void
-    {
-        if (! $this->current_user instanceof WP_User) {
-            $this->current_user = wp_get_current_user();
-            $event_manager_roles    = array_keys($this->event_managers->roles());
-            $current_user_roles     = $this->current_user->roles;
-            $this->is_event_manager = ! empty(array_intersect($event_manager_roles, $current_user_roles));
-            $this->is_logged_in     = $this->current_user->exists();
-        }
-    }
-
-
-    /**
-     * @return WP_User
-     */
-    public function currentUser(): ?WP_User
-    {
-        $this->setCurrentUser();
-        return $this->current_user;
-    }
-
-
-    /**
-     * @return bool
-     */
-    public function isEventManager(): bool
-    {
-        $this->setCurrentUser();
-        return $this->is_event_manager;
-    }
-
-
-    /**
-     * @return bool
-     */
-    public function isLoggedIn(): bool
-    {
-        $this->setCurrentUser();
-        return $this->is_logged_in;
-    }
+	/**
+	 * @var WP_User
+	 */
+	private $current_user;
+
+	/**
+	 * @var boolean
+	 */
+	private $is_event_manager = false;
+
+	/**
+	 * @var boolean
+	 */
+	private $is_logged_in = false;
+
+
+	/**
+	 * @var EventManagers
+	 */
+	private $event_managers;
+
+
+	/**
+	 * CurrentUser constructor.
+	 *
+	 * @param EventManagers $event_managers
+	 */
+	public function __construct(EventManagers $event_managers)
+	{
+		$this->event_managers = $event_managers;
+		$this->setCurrentUser();
+	}
+
+
+	public function setCurrentUser(): void
+	{
+		if (! $this->current_user instanceof WP_User) {
+			$this->current_user = wp_get_current_user();
+			$event_manager_roles    = array_keys($this->event_managers->roles());
+			$current_user_roles     = $this->current_user->roles;
+			$this->is_event_manager = ! empty(array_intersect($event_manager_roles, $current_user_roles));
+			$this->is_logged_in     = $this->current_user->exists();
+		}
+	}
+
+
+	/**
+	 * @return WP_User
+	 */
+	public function currentUser(): ?WP_User
+	{
+		$this->setCurrentUser();
+		return $this->current_user;
+	}
+
+
+	/**
+	 * @return bool
+	 */
+	public function isEventManager(): bool
+	{
+		$this->setCurrentUser();
+		return $this->is_event_manager;
+	}
+
+
+	/**
+	 * @return bool
+	 */
+	public function isLoggedIn(): bool
+	{
+		$this->setCurrentUser();
+		return $this->is_logged_in;
+	}
 }