eventespresso / event-espresso-core

core/domain/services/graphql/connection_resolvers/TicketConnectionResolver.php

Spacing +8 added lines, -8 removed lines

@@ -78,14 +78,14 @@ 
          * Collect the input_fields and sanitize them to prepare them for sending to the Query
          */
         $input_fields = [];
-        if (! empty($this->args['where'])) {
+        if ( ! empty($this->args['where'])) {
             $input_fields = $this->sanitizeInputFields($this->args['where']);
 
             // Use the proper operator.
-            if (! empty($input_fields['Datetime.DTT_ID']) && is_array($input_fields['Datetime.DTT_ID'])) {
+            if ( ! empty($input_fields['Datetime.DTT_ID']) && is_array($input_fields['Datetime.DTT_ID'])) {
                 $input_fields['Datetime.DTT_ID'] = ['IN', $input_fields['Datetime.DTT_ID']];
             }
-            if (! empty($input_fields['Datetime.EVT_ID']) && is_array($input_fields['Datetime.EVT_ID'])) {
+            if ( ! empty($input_fields['Datetime.EVT_ID']) && is_array($input_fields['Datetime.EVT_ID'])) {
                 $input_fields['Datetime.EVT_ID'] = ['IN', $input_fields['Datetime.EVT_ID']];
             }
         }
@@ -100,7 +100,7 @@ 
         /**
          * Merge the input_fields with the default query_args
          */
-        if (! empty($input_fields)) {
+        if ( ! empty($input_fields)) {
             $where_params = array_merge($where_params, $input_fields);
         }
 
@@ -108,16 +108,16 @@ 
 
         $search = isset($this->args['where']) ? $this->getSearchKeywords($this->args['where']) : '';
 
-        if (! empty($search)) {
+        if ( ! empty($search)) {
             // use OR operator to search in any of the fields
             $where_params['OR'] = array(
-                'TKT_name'        => array('LIKE', '%' . $search . '%'),
-                'TKT_description' => array('LIKE', '%' . $search . '%'),
+                'TKT_name'        => array('LIKE', '%'.$search.'%'),
+                'TKT_description' => array('LIKE', '%'.$search.'%'),
             );
         }
 
         // If default tickets should be included.
-        if (! empty($this->args['where']['includeDefaultTickets'])) {
+        if ( ! empty($this->args['where']['includeDefaultTickets'])) {
             /**
              * We need to get each ticket that
              * - satisfies $where_params above

Indentation +174 added lines, -174 removed lines

@@ -15,178 +15,178 @@
  */
 class TicketConnectionResolver extends AbstractConnectionResolver
 {
-    // phpcs:ignore PSR1.Methods.CamelCapsMethodName.NotCamelCaps
-    public function get_loader_name(): string
-    {
-        return 'espresso_ticket';
-    }
-
-    /**
-     * @return EEM_Ticket
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     * @throws ReflectionException
-     */
-    // phpcs:ignore PSR1.Methods.CamelCapsMethodName.NotCamelCaps
-    public function get_query(): EEM_Ticket
-    {
-        return EEM_Ticket::instance();
-    }
-
-
-    /**
-     * Return an array of item IDs from the query
-     *
-     * @return array
-     */
-    // phpcs:ignore PSR1.Methods.CamelCapsMethodName.NotCamelCaps
-    public function get_ids(): array
-    {
-        $results = $this->query->get_col($this->query_args);
-
-        return ! empty($results) ? $results : [];
-    }
-
-
-    /**
-     * Here, we map the args from the input, then we make sure that we're only querying
-     * for IDs. The IDs are then passed down the resolve tree, and deferred resolvers
-     * handle batch resolution of the posts.
-     *
-     * @return array
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws ReflectionException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     */
-    // phpcs:ignore PSR1.Methods.CamelCapsMethodName.NotCamelCaps
-    public function get_query_args(): array
-    {
-        $where_params = ['TKT_deleted' => ['IN', [true, false]]];
-        $query_args   = [];
-
-        $query_args['limit'] = $this->getLimit();
-
-        // Avoid multiple entries by join.
-        $query_args['group_by'] = 'TKT_ID';
-
-        $query_args['default_where_conditions'] = 'minimum';
-
-        /**
-         * Collect the input_fields and sanitize them to prepare them for sending to the Query
-         */
-        $input_fields = [];
-        if (! empty($this->args['where'])) {
-            $input_fields = $this->sanitizeInputFields($this->args['where']);
-
-            // Use the proper operator.
-            if (! empty($input_fields['Datetime.DTT_ID']) && is_array($input_fields['Datetime.DTT_ID'])) {
-                $input_fields['Datetime.DTT_ID'] = ['IN', $input_fields['Datetime.DTT_ID']];
-            }
-            if (! empty($input_fields['Datetime.EVT_ID']) && is_array($input_fields['Datetime.EVT_ID'])) {
-                $input_fields['Datetime.EVT_ID'] = ['IN', $input_fields['Datetime.EVT_ID']];
-            }
-        }
-
-        /**
-         * Determine where we're at in the Graph and adjust the query context appropriately.
-         */
-        if ($this->source instanceof EE_Datetime) {
-            $where_params['Datetime.DTT_ID'] = $this->source->ID();
-        }
-
-        /**
-         * Merge the input_fields with the default query_args
-         */
-        if (! empty($input_fields)) {
-            $where_params = array_merge($where_params, $input_fields);
-        }
-
-        [$query_args, $where_params] = $this->mapOrderbyInputArgs($query_args, $where_params, 'TKT_ID');
-
-        $search = isset($this->args['where']) ? $this->getSearchKeywords($this->args['where']) : '';
-
-        if (! empty($search)) {
-            // use OR operator to search in any of the fields
-            $where_params['OR'] = array(
-                'TKT_name'        => array('LIKE', '%' . $search . '%'),
-                'TKT_description' => array('LIKE', '%' . $search . '%'),
-            );
-        }
-
-        // If default tickets should be included.
-        if (! empty($this->args['where']['includeDefaultTickets'])) {
-            /**
-             * We need to get each ticket that
-             * - satisfies $where_params above
-             * OR
-             * - it's a default ticket
-             */
-            $where_params = [
-                'OR' => [
-                    // use extra OR instead of AND to avoid it getting overridden
-                    'OR' => [
-                        'AND' => [
-                            'TKT_deleted'    => ['IN', [true, false]],
-                            'TKT_is_default' => 1,
-                        ]
-                    ],
-                    'AND' => $where_params,
-                ],
-            ];
-        }
-
-        $where_params = apply_filters(
-            'FHEE__EventEspresso_core_domain_services_graphql_connection_resolvers__ticket_where_params',
-            $where_params,
-            $this->source,
-            $this->args
-        );
-
-        $query_args[] = $where_params;
-
-        /**
-         * Return the $query_args
-         */
-        return apply_filters(
-            'FHEE__EventEspresso_core_domain_services_graphql_connection_resolvers__ticket_query_args',
-            $query_args,
-            $this->source,
-            $this->args
-        );
-    }
-
-
-    /**
-     * This sets up the "allowed" args, and translates the GraphQL-friendly keys to model
-     * friendly keys.
-     *
-     * @param array $where_args
-     * @return array
-     */
-    public function sanitizeInputFields(array $where_args): array
-    {
-        $arg_mapping = [
-            'event'        => 'Datetime.EVT_ID',
-            'eventIn'      => 'Datetime.EVT_ID',
-            'eventIdIn'    => 'Datetime.EVT_ID',
-            'eventId'      => 'Datetime.EVT_ID', // priority.
-            'datetime'     => 'Datetime.DTT_ID',
-            'datetimeIn'   => 'Datetime.DTT_ID',
-            'datetimeIdIn' => 'Datetime.DTT_ID',
-            'datetimeId'   => 'Datetime.DTT_ID', // priority.
-            'isDefault'    => 'TKT_is_default',
-            'isRequired'   => 'TKT_required',
-            'isTaxable'    => 'TKT_taxable',
-            'isTrashed'    => 'TKT_deleted',
-        ];
-        return $this->sanitizeWhereArgsForInputFields(
-            $where_args,
-            $arg_mapping,
-            ['datetime', 'datetimeIn', 'event', 'eventIn']
-        );
-    }
+	// phpcs:ignore PSR1.Methods.CamelCapsMethodName.NotCamelCaps
+	public function get_loader_name(): string
+	{
+		return 'espresso_ticket';
+	}
+
+	/**
+	 * @return EEM_Ticket
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 * @throws ReflectionException
+	 */
+	// phpcs:ignore PSR1.Methods.CamelCapsMethodName.NotCamelCaps
+	public function get_query(): EEM_Ticket
+	{
+		return EEM_Ticket::instance();
+	}
+
+
+	/**
+	 * Return an array of item IDs from the query
+	 *
+	 * @return array
+	 */
+	// phpcs:ignore PSR1.Methods.CamelCapsMethodName.NotCamelCaps
+	public function get_ids(): array
+	{
+		$results = $this->query->get_col($this->query_args);
+
+		return ! empty($results) ? $results : [];
+	}
+
+
+	/**
+	 * Here, we map the args from the input, then we make sure that we're only querying
+	 * for IDs. The IDs are then passed down the resolve tree, and deferred resolvers
+	 * handle batch resolution of the posts.
+	 *
+	 * @return array
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws ReflectionException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 */
+	// phpcs:ignore PSR1.Methods.CamelCapsMethodName.NotCamelCaps
+	public function get_query_args(): array
+	{
+		$where_params = ['TKT_deleted' => ['IN', [true, false]]];
+		$query_args   = [];
+
+		$query_args['limit'] = $this->getLimit();
+
+		// Avoid multiple entries by join.
+		$query_args['group_by'] = 'TKT_ID';
+
+		$query_args['default_where_conditions'] = 'minimum';
+
+		/**
+		 * Collect the input_fields and sanitize them to prepare them for sending to the Query
+		 */
+		$input_fields = [];
+		if (! empty($this->args['where'])) {
+			$input_fields = $this->sanitizeInputFields($this->args['where']);
+
+			// Use the proper operator.
+			if (! empty($input_fields['Datetime.DTT_ID']) && is_array($input_fields['Datetime.DTT_ID'])) {
+				$input_fields['Datetime.DTT_ID'] = ['IN', $input_fields['Datetime.DTT_ID']];
+			}
+			if (! empty($input_fields['Datetime.EVT_ID']) && is_array($input_fields['Datetime.EVT_ID'])) {
+				$input_fields['Datetime.EVT_ID'] = ['IN', $input_fields['Datetime.EVT_ID']];
+			}
+		}
+
+		/**
+		 * Determine where we're at in the Graph and adjust the query context appropriately.
+		 */
+		if ($this->source instanceof EE_Datetime) {
+			$where_params['Datetime.DTT_ID'] = $this->source->ID();
+		}
+
+		/**
+		 * Merge the input_fields with the default query_args
+		 */
+		if (! empty($input_fields)) {
+			$where_params = array_merge($where_params, $input_fields);
+		}
+
+		[$query_args, $where_params] = $this->mapOrderbyInputArgs($query_args, $where_params, 'TKT_ID');
+
+		$search = isset($this->args['where']) ? $this->getSearchKeywords($this->args['where']) : '';
+
+		if (! empty($search)) {
+			// use OR operator to search in any of the fields
+			$where_params['OR'] = array(
+				'TKT_name'        => array('LIKE', '%' . $search . '%'),
+				'TKT_description' => array('LIKE', '%' . $search . '%'),
+			);
+		}
+
+		// If default tickets should be included.
+		if (! empty($this->args['where']['includeDefaultTickets'])) {
+			/**
+			 * We need to get each ticket that
+			 * - satisfies $where_params above
+			 * OR
+			 * - it's a default ticket
+			 */
+			$where_params = [
+				'OR' => [
+					// use extra OR instead of AND to avoid it getting overridden
+					'OR' => [
+						'AND' => [
+							'TKT_deleted'    => ['IN', [true, false]],
+							'TKT_is_default' => 1,
+						]
+					],
+					'AND' => $where_params,
+				],
+			];
+		}
+
+		$where_params = apply_filters(
+			'FHEE__EventEspresso_core_domain_services_graphql_connection_resolvers__ticket_where_params',
+			$where_params,
+			$this->source,
+			$this->args
+		);
+
+		$query_args[] = $where_params;
+
+		/**
+		 * Return the $query_args
+		 */
+		return apply_filters(
+			'FHEE__EventEspresso_core_domain_services_graphql_connection_resolvers__ticket_query_args',
+			$query_args,
+			$this->source,
+			$this->args
+		);
+	}
+
+
+	/**
+	 * This sets up the "allowed" args, and translates the GraphQL-friendly keys to model
+	 * friendly keys.
+	 *
+	 * @param array $where_args
+	 * @return array
+	 */
+	public function sanitizeInputFields(array $where_args): array
+	{
+		$arg_mapping = [
+			'event'        => 'Datetime.EVT_ID',
+			'eventIn'      => 'Datetime.EVT_ID',
+			'eventIdIn'    => 'Datetime.EVT_ID',
+			'eventId'      => 'Datetime.EVT_ID', // priority.
+			'datetime'     => 'Datetime.DTT_ID',
+			'datetimeIn'   => 'Datetime.DTT_ID',
+			'datetimeIdIn' => 'Datetime.DTT_ID',
+			'datetimeId'   => 'Datetime.DTT_ID', // priority.
+			'isDefault'    => 'TKT_is_default',
+			'isRequired'   => 'TKT_required',
+			'isTaxable'    => 'TKT_taxable',
+			'isTrashed'    => 'TKT_deleted',
+		];
+		return $this->sanitizeWhereArgsForInputFields(
+			$where_args,
+			$arg_mapping,
+			['datetime', 'datetimeIn', 'event', 'eventIn']
+		);
+	}
 }

core/domain/services/admin/entities/DefaultPrices.php

Spacing +10 added lines, -10 removed lines

@@ -67,7 +67,7 @@ 
      */
     public function create(EE_Base_Class $entity): array
     {
-        if (! $entity instanceof EE_Ticket) {
+        if ( ! $entity instanceof EE_Ticket) {
             throw new InvalidEntityException($entity, 'EE_Ticket');
         }
         $is_free                   = true;
@@ -91,9 +91,9 @@ 
             $has_base_price,
             $is_free
         );
-        if (! $has_base_price) {
+        if ( ! $has_base_price) {
             $new_base_price                            = $this->createNewBasePrice($entity);
-            $this->new_prices[ $new_base_price->ID() ] = $new_base_price;
+            $this->new_prices[$new_base_price->ID()] = $new_base_price;
         }
         $this->applyTaxes($entity, $is_free);
         $ticket_total = $entity->get_ticket_total_with_taxes(true);
@@ -113,7 +113,7 @@ 
      */
     private function applyTaxes(EE_Ticket $ticket, bool $is_free)
     {
-        if (! $is_free && $ticket->taxable() && ! empty($this->taxes)) {
+        if ( ! $is_free && $ticket->taxable() && ! empty($this->taxes)) {
             foreach ($this->taxes as $tax) {
                 // assign taxes but don't duplicate them because they operate globally
                 $ticket->set_taxable(true);
@@ -162,12 +162,12 @@ 
             $is_base_price = $default_price_clone->is_base_price();
             // add this price to ticket if it is a regular price modifier, ie: NOT a base price,
             // OR if it IS a base price but this ticket does NOT already have a base price
-            if (! $is_base_price || ! $has_base_price) {
+            if ( ! $is_base_price || ! $has_base_price) {
                 $default_price_clone->set('PRC_ID', null);
                 $default_price_clone->set('PRC_is_default', false);
                 $default_price_clone->save();
                 $default_price_clone->_add_relation_to($ticket, 'Ticket');
-                $this->new_prices[ $default_price_clone->ID() ] = $default_price_clone;
+                $this->new_prices[$default_price_clone->ID()] = $default_price_clone;
                 // then recheck that a base price has been set so that we don't add another one
                 $has_base_price = $is_base_price ? true : $has_base_price;
             }
@@ -192,7 +192,7 @@ 
                 ],
             ]
         );
-        if (! $base_price_type instanceof EE_Price_Type) {
+        if ( ! $base_price_type instanceof EE_Price_Type) {
             throw new RuntimeException(
                 esc_html__(
                     'A valid base price type could not be retrieved from the database.',
@@ -219,15 +219,15 @@ 
         $default_prices = [];
         if (is_array($prices)) {
             foreach ($prices as $key => $price) {
-                if (! $price instanceof EE_Price) {
+                if ( ! $price instanceof EE_Price) {
                     throw new InvalidEntityException($price, 'EE_Price');
                 }
                 // grab any taxes but don't do anything just yet
                 if ($price->is_tax()) {
-                    $this->taxes[ $price->ID() ] = $price;
+                    $this->taxes[$price->ID()] = $price;
                     continue;
                 }
-                $default_prices[ $price->ID() ] = $price;
+                $default_prices[$price->ID()] = $price;
             }
         }
         return $default_prices;

Indentation +219 added lines, -219 removed lines

@@ -24,223 +24,223 @@
  */
 class DefaultPrices implements DefaultEntityGeneratorInterface
 {
-    /**
-     * @var EEM_Price
-     */
-    protected $price_model;
-
-    /**
-     * @var EEM_Price_Type
-     */
-    protected $price_type_model;
-
-    /**
-     * @var EE_Price[]
-     */
-    protected $new_prices = [];
-
-    /**
-     * @var EE_Price[]
-     */
-    protected $taxes = [];
-
-
-    /**
-     * @param EEM_Price      $price_model
-     * @param EEM_Price_Type $price_type_model
-     */
-    public function __construct(EEM_Price $price_model, EEM_Price_Type $price_type_model)
-    {
-        $this->price_model      = $price_model;
-        $this->price_type_model = $price_type_model;
-    }
-
-
-    /**
-     * @param EE_Ticket|EE_Base_Class $entity
-     * @return EE_Price[]
-     * @throws EE_Error
-     * @throws InvalidInterfaceException
-     * @throws ReflectionException
-     * @since 5.0.0.p
-     */
-    public function create(EE_Base_Class $entity): array
-    {
-        if (! $entity instanceof EE_Ticket) {
-            throw new InvalidEntityException($entity, 'EE_Ticket');
-        }
-        $is_free                   = true;
-        $has_base_price            = false;
-        $remove_existing_relations = true;
-        // first, let's get all of the default taxes for the site
-        $this->taxes = $this->price_model->getAllDefaultTaxes();
-        // then separate taxes from the other prices for the existing default ticket prices
-        $default_prices = $this->separateTaxesFromOtherPrices($entity->prices());
-        // but if that's empty, then let's get the default global prices
-        if (empty($default_prices)) {
-            $default_global_prices     = $this->price_model->get_all_default_prices();
-            $default_prices            = $this->separateTaxesFromOtherPrices($default_global_prices);
-            $remove_existing_relations = false;
-        }
-        // then clone and apply all of the default prices
-        [$has_base_price, $is_free] = $this->cloneDefaultPrices(
-            $entity,
-            $default_prices,
-            $remove_existing_relations,
-            $has_base_price,
-            $is_free
-        );
-        if (! $has_base_price) {
-            $new_base_price                            = $this->createNewBasePrice($entity);
-            $this->new_prices[ $new_base_price->ID() ] = $new_base_price;
-        }
-        $this->applyTaxes($entity, $is_free);
-        $ticket_total = $entity->get_ticket_total_with_taxes(true);
-        if ($ticket_total !== $entity->ticket_price()) {
-            $entity->set_price($ticket_total);
-            $entity->save();
-        }
-        return $this->new_prices;
-    }
-
-
-    /**
-     * @param EE_Ticket $ticket
-     * @param bool      $is_free
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    private function applyTaxes(EE_Ticket $ticket, bool $is_free)
-    {
-        if (! $is_free && $ticket->taxable() && ! empty($this->taxes)) {
-            foreach ($this->taxes as $tax) {
-                // assign taxes but don't duplicate them because they operate globally
-                $ticket->set_taxable(true);
-                $tax->_add_relation_to($ticket, 'Ticket');
-            }
-        }
-    }
-
-
-    /**
-     * @param EE_Ticket  $ticket
-     * @param EE_Price[] $default_prices
-     * @param bool       $remove_existing_relations
-     * @param bool       $has_base_price
-     * @param bool       $is_free
-     * @return bool[]
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    private function cloneDefaultPrices(
-        EE_Ticket $ticket,
-        array $default_prices,
-        bool $remove_existing_relations,
-        bool $has_base_price,
-        bool $is_free
-    ): array {
-        foreach ($default_prices as $default_price) {
-            // duplicate the default price so that it does not get mutated
-            $default_price_clone = clone $default_price;
-            if ($remove_existing_relations) {
-                $ticket->_remove_relation_to($default_price, 'Price');
-            }
-            if (
-                (
-                    // has non-zero base price
-                    $default_price_clone->is_base_price()
-                    && $default_price_clone->amount() > 0
-                )
-                || (
-                    // or has fixed amount surcharge
-                    $default_price_clone->is_surcharge()
-                    && ! $default_price_clone->is_percent()
-                )
-            ) {
-                $is_free = false;
-            }
-            $is_base_price = $default_price_clone->is_base_price();
-            // add this price to ticket if it is a regular price modifier, ie: NOT a base price,
-            // OR if it IS a base price but this ticket does NOT already have a base price
-            if (! $is_base_price || ! $has_base_price) {
-                $default_price_clone->set('PRC_ID', null);
-                $default_price_clone->set('PRC_is_default', false);
-
-                $order = $default_price_clone->get('PRC_order');
-
-                // enforce base price order to be 1 and 5 if the order is not set for a modifier
-                $order = $is_base_price ? 1 : $order;
-                $order = $order ?? 5;
-
-                $default_price_clone->set('PRC_order', $order);
-
-                $default_price_clone->save();
-                $default_price_clone->_add_relation_to($ticket, 'Ticket');
-                $this->new_prices[ $default_price_clone->ID() ] = $default_price_clone;
-                // then recheck that a base price has been set so that we don't add another one
-                $has_base_price = $is_base_price ? true : $has_base_price;
-            }
-        }
-        return [$has_base_price, $is_free];
-    }
-
-
-    /**
-     * @param EE_Ticket $ticket
-     * @return EE_Price
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    private function createNewBasePrice(EE_Ticket $ticket): EE_Price
-    {
-        $new_base_price  = $this->price_model->get_new_price();
-        $base_price_type = $this->price_type_model->get_one(
-            [
-                [
-                    'PBT_ID' => EEM_Price_Type::base_type_base_price,
-                ],
-            ]
-        );
-        if (! $base_price_type instanceof EE_Price_Type) {
-            throw new RuntimeException(
-                esc_html__(
-                    'A valid base price type could not be retrieved from the database.',
-                    'event_espresso'
-                )
-            );
-        }
-        $new_base_price->set('PRT_ID', $base_price_type->ID());
-        // set base price order to 1
-        $new_base_price->set('PRC_order', 1);
-        $new_base_price->set('PRC_is_default', false);
-        $new_base_price->save();
-        $new_base_price->_add_relation_to($ticket, 'Ticket');
-        return $new_base_price;
-    }
-
-
-    /**
-     * @param array $prices
-     * @return array
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    private function separateTaxesFromOtherPrices(array $prices = []): array
-    {
-        $default_prices = [];
-        if (is_array($prices)) {
-            foreach ($prices as $key => $price) {
-                if (! $price instanceof EE_Price) {
-                    throw new InvalidEntityException($price, 'EE_Price');
-                }
-                // grab any taxes but don't do anything just yet
-                if ($price->is_tax()) {
-                    $this->taxes[ $price->ID() ] = $price;
-                    continue;
-                }
-                $default_prices[ $price->ID() ] = $price;
-            }
-        }
-        return $default_prices;
-    }
+	/**
+	 * @var EEM_Price
+	 */
+	protected $price_model;
+
+	/**
+	 * @var EEM_Price_Type
+	 */
+	protected $price_type_model;
+
+	/**
+	 * @var EE_Price[]
+	 */
+	protected $new_prices = [];
+
+	/**
+	 * @var EE_Price[]
+	 */
+	protected $taxes = [];
+
+
+	/**
+	 * @param EEM_Price      $price_model
+	 * @param EEM_Price_Type $price_type_model
+	 */
+	public function __construct(EEM_Price $price_model, EEM_Price_Type $price_type_model)
+	{
+		$this->price_model      = $price_model;
+		$this->price_type_model = $price_type_model;
+	}
+
+
+	/**
+	 * @param EE_Ticket|EE_Base_Class $entity
+	 * @return EE_Price[]
+	 * @throws EE_Error
+	 * @throws InvalidInterfaceException
+	 * @throws ReflectionException
+	 * @since 5.0.0.p
+	 */
+	public function create(EE_Base_Class $entity): array
+	{
+		if (! $entity instanceof EE_Ticket) {
+			throw new InvalidEntityException($entity, 'EE_Ticket');
+		}
+		$is_free                   = true;
+		$has_base_price            = false;
+		$remove_existing_relations = true;
+		// first, let's get all of the default taxes for the site
+		$this->taxes = $this->price_model->getAllDefaultTaxes();
+		// then separate taxes from the other prices for the existing default ticket prices
+		$default_prices = $this->separateTaxesFromOtherPrices($entity->prices());
+		// but if that's empty, then let's get the default global prices
+		if (empty($default_prices)) {
+			$default_global_prices     = $this->price_model->get_all_default_prices();
+			$default_prices            = $this->separateTaxesFromOtherPrices($default_global_prices);
+			$remove_existing_relations = false;
+		}
+		// then clone and apply all of the default prices
+		[$has_base_price, $is_free] = $this->cloneDefaultPrices(
+			$entity,
+			$default_prices,
+			$remove_existing_relations,
+			$has_base_price,
+			$is_free
+		);
+		if (! $has_base_price) {
+			$new_base_price                            = $this->createNewBasePrice($entity);
+			$this->new_prices[ $new_base_price->ID() ] = $new_base_price;
+		}
+		$this->applyTaxes($entity, $is_free);
+		$ticket_total = $entity->get_ticket_total_with_taxes(true);
+		if ($ticket_total !== $entity->ticket_price()) {
+			$entity->set_price($ticket_total);
+			$entity->save();
+		}
+		return $this->new_prices;
+	}
+
+
+	/**
+	 * @param EE_Ticket $ticket
+	 * @param bool      $is_free
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	private function applyTaxes(EE_Ticket $ticket, bool $is_free)
+	{
+		if (! $is_free && $ticket->taxable() && ! empty($this->taxes)) {
+			foreach ($this->taxes as $tax) {
+				// assign taxes but don't duplicate them because they operate globally
+				$ticket->set_taxable(true);
+				$tax->_add_relation_to($ticket, 'Ticket');
+			}
+		}
+	}
+
+
+	/**
+	 * @param EE_Ticket  $ticket
+	 * @param EE_Price[] $default_prices
+	 * @param bool       $remove_existing_relations
+	 * @param bool       $has_base_price
+	 * @param bool       $is_free
+	 * @return bool[]
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	private function cloneDefaultPrices(
+		EE_Ticket $ticket,
+		array $default_prices,
+		bool $remove_existing_relations,
+		bool $has_base_price,
+		bool $is_free
+	): array {
+		foreach ($default_prices as $default_price) {
+			// duplicate the default price so that it does not get mutated
+			$default_price_clone = clone $default_price;
+			if ($remove_existing_relations) {
+				$ticket->_remove_relation_to($default_price, 'Price');
+			}
+			if (
+				(
+					// has non-zero base price
+					$default_price_clone->is_base_price()
+					&& $default_price_clone->amount() > 0
+				)
+				|| (
+					// or has fixed amount surcharge
+					$default_price_clone->is_surcharge()
+					&& ! $default_price_clone->is_percent()
+				)
+			) {
+				$is_free = false;
+			}
+			$is_base_price = $default_price_clone->is_base_price();
+			// add this price to ticket if it is a regular price modifier, ie: NOT a base price,
+			// OR if it IS a base price but this ticket does NOT already have a base price
+			if (! $is_base_price || ! $has_base_price) {
+				$default_price_clone->set('PRC_ID', null);
+				$default_price_clone->set('PRC_is_default', false);
+
+				$order = $default_price_clone->get('PRC_order');
+
+				// enforce base price order to be 1 and 5 if the order is not set for a modifier
+				$order = $is_base_price ? 1 : $order;
+				$order = $order ?? 5;
+
+				$default_price_clone->set('PRC_order', $order);
+
+				$default_price_clone->save();
+				$default_price_clone->_add_relation_to($ticket, 'Ticket');
+				$this->new_prices[ $default_price_clone->ID() ] = $default_price_clone;
+				// then recheck that a base price has been set so that we don't add another one
+				$has_base_price = $is_base_price ? true : $has_base_price;
+			}
+		}
+		return [$has_base_price, $is_free];
+	}
+
+
+	/**
+	 * @param EE_Ticket $ticket
+	 * @return EE_Price
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	private function createNewBasePrice(EE_Ticket $ticket): EE_Price
+	{
+		$new_base_price  = $this->price_model->get_new_price();
+		$base_price_type = $this->price_type_model->get_one(
+			[
+				[
+					'PBT_ID' => EEM_Price_Type::base_type_base_price,
+				],
+			]
+		);
+		if (! $base_price_type instanceof EE_Price_Type) {
+			throw new RuntimeException(
+				esc_html__(
+					'A valid base price type could not be retrieved from the database.',
+					'event_espresso'
+				)
+			);
+		}
+		$new_base_price->set('PRT_ID', $base_price_type->ID());
+		// set base price order to 1
+		$new_base_price->set('PRC_order', 1);
+		$new_base_price->set('PRC_is_default', false);
+		$new_base_price->save();
+		$new_base_price->_add_relation_to($ticket, 'Ticket');
+		return $new_base_price;
+	}
+
+
+	/**
+	 * @param array $prices
+	 * @return array
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	private function separateTaxesFromOtherPrices(array $prices = []): array
+	{
+		$default_prices = [];
+		if (is_array($prices)) {
+			foreach ($prices as $key => $price) {
+				if (! $price instanceof EE_Price) {
+					throw new InvalidEntityException($price, 'EE_Price');
+				}
+				// grab any taxes but don't do anything just yet
+				if ($price->is_tax()) {
+					$this->taxes[ $price->ID() ] = $price;
+					continue;
+				}
+				$default_prices[ $price->ID() ] = $price;
+			}
+		}
+		return $default_prices;
+	}
 }

core/db_models/EEM_Question_Group.model.php

Spacing +4 added lines, -4 removed lines

@@ -110,13 +110,13 @@
             'WP_User'              => new EE_Belongs_To_Relation(),
         ];
         // this model is generally available for reading
-        $this->_cap_restriction_generators[ EEM_Base::caps_read ]       =
+        $this->_cap_restriction_generators[EEM_Base::caps_read]       =
             new EE_Restriction_Generator_Public();
-        $this->_cap_restriction_generators[ EEM_Base::caps_read_admin ] =
+        $this->_cap_restriction_generators[EEM_Base::caps_read_admin] =
             new EE_Restriction_Generator_Reg_Form('QSG_system');
-        $this->_cap_restriction_generators[ EEM_Base::caps_edit ]       =
+        $this->_cap_restriction_generators[EEM_Base::caps_edit]       =
             new EE_Restriction_Generator_Reg_Form('QSG_system');
-        $this->_cap_restriction_generators[ EEM_Base::caps_delete ]     =
+        $this->_cap_restriction_generators[EEM_Base::caps_delete]     =
             new EE_Restriction_Generator_Reg_Form('QSG_system');
 
         parent::__construct($timezone);

Indentation +125 added lines, -125 removed lines

@@ -9,137 +9,137 @@
  */
 class EEM_Question_Group extends EEM_Soft_Delete_Base
 {
-    const system_personal = 1;
+	const system_personal = 1;
 
-    const system_address  = 2;
+	const system_address  = 2;
 
-    /**
-     * private instance of the EEM_Question_Group object
-     *
-     * @var EEM_Question_Group
-     */
-    protected static $_instance = null;
+	/**
+	 * private instance of the EEM_Question_Group object
+	 *
+	 * @var EEM_Question_Group
+	 */
+	protected static $_instance = null;
 
 
-    /**
-     * EEM_Question_Group constructor.
-     *
-     * @param string|null $timezone
-     * @throws EE_Error
-     */
-    protected function __construct(?string $timezone = '')
-    {
-        $this->singular_item = esc_html__('Question Group', 'event_espresso');
-        $this->plural_item   = esc_html__('Question Groups', 'event_espresso');
+	/**
+	 * EEM_Question_Group constructor.
+	 *
+	 * @param string|null $timezone
+	 * @throws EE_Error
+	 */
+	protected function __construct(?string $timezone = '')
+	{
+		$this->singular_item = esc_html__('Question Group', 'event_espresso');
+		$this->plural_item   = esc_html__('Question Groups', 'event_espresso');
 
-        $this->_tables          = [
-            'Question_Group' => new EE_Primary_Table('esp_question_group', 'QSG_ID'),
-        ];
-        $this->_fields          = [
-            'Question_Group' => [
-                'QSG_ID'              => new EE_Primary_Key_Int_Field(
-                    'QSG_ID',
-                    esc_html__('Question Group ID', 'event_espresso')
-                ),
-                'QSG_deleted'         => new EE_Trashed_Flag_Field(
-                    'QSG_deleted',
-                    esc_html__('Flag indicating this question group was deleted', 'event_espresso'),
-                    false,
-                    false
-                ),
-                'QSG_desc'            => new EE_Post_Content_Field(
-                    'QSG_desc',
-                    esc_html__('Description of Question Group', 'event_espresso'),
-                    true,
-                    ''
-                ),
-                'QSG_identifier'      => new EE_Plain_Text_Field(
-                    'QSG_identifier',
-                    esc_html__('Text ID for question Group', 'event_espresso'),
-                    false,
-                    ''
-                ),
-                'QSG_name'            => new EE_Plain_Text_Field(
-                    'QSG_name',
-                    esc_html__('Question Group Name', 'event_espresso'),
-                    false,
-                    ''
-                ),
-                'QSG_order'           => new EE_Integer_Field(
-                    'QSG_order',
-                    esc_html__('Order in which to show the question group', 'event_espresso'),
-                    true,
-                    0
-                ),
-                'QSG_show_group_desc' => new EE_Boolean_Field(
-                    'QSG_show_group_desc',
-                    esc_html__(
-                        'Flag indicating whether to show the group\s description on the registration page',
-                        'event_espresso'
-                    ),
-                    false,
-                    false
-                ),
-                'QSG_show_group_name' => new EE_Boolean_Field(
-                    'QSG_show_group_name',
-                    esc_html__(
-                        'Flag indicating whether to show the group\'s name on the registration page',
-                        'event_espresso'
-                    ),
-                    false,
-                    true
-                ),
-                'QSG_system'          => new EE_Integer_Field(
-                    'QSG_system',
-                    esc_html__(
-                        'Indicate IF this is a system group and if it is what system group it corresponds to.',
-                        'event_espresso'
-                    ),
-                    false,
-                    0
-                ),
-                'QSG_wp_user'         => new EE_WP_User_Field(
-                    'QSG_wp_user',
-                    esc_html__('Question Group Creator ID', 'event_espresso'),
-                    false
-                ),
-            ],
-        ];
-        $this->_model_relations = [
-            'Event'                => new EE_HABTM_Relation('Event_Question_Group'),
-            'Event_Question_Group' => new EE_Has_Many_Relation(),
-            'Question'             => new EE_HABTM_Relation('Question_Group_Question'),
-            'WP_User'              => new EE_Belongs_To_Relation(),
-        ];
-        // this model is generally available for reading
-        $this->_cap_restriction_generators[ EEM_Base::caps_read ]       =
-            new EE_Restriction_Generator_Public();
-        $this->_cap_restriction_generators[ EEM_Base::caps_read_admin ] =
-            new EE_Restriction_Generator_Reg_Form('QSG_system');
-        $this->_cap_restriction_generators[ EEM_Base::caps_edit ]       =
-            new EE_Restriction_Generator_Reg_Form('QSG_system');
-        $this->_cap_restriction_generators[ EEM_Base::caps_delete ]     =
-            new EE_Restriction_Generator_Reg_Form('QSG_system');
+		$this->_tables          = [
+			'Question_Group' => new EE_Primary_Table('esp_question_group', 'QSG_ID'),
+		];
+		$this->_fields          = [
+			'Question_Group' => [
+				'QSG_ID'              => new EE_Primary_Key_Int_Field(
+					'QSG_ID',
+					esc_html__('Question Group ID', 'event_espresso')
+				),
+				'QSG_deleted'         => new EE_Trashed_Flag_Field(
+					'QSG_deleted',
+					esc_html__('Flag indicating this question group was deleted', 'event_espresso'),
+					false,
+					false
+				),
+				'QSG_desc'            => new EE_Post_Content_Field(
+					'QSG_desc',
+					esc_html__('Description of Question Group', 'event_espresso'),
+					true,
+					''
+				),
+				'QSG_identifier'      => new EE_Plain_Text_Field(
+					'QSG_identifier',
+					esc_html__('Text ID for question Group', 'event_espresso'),
+					false,
+					''
+				),
+				'QSG_name'            => new EE_Plain_Text_Field(
+					'QSG_name',
+					esc_html__('Question Group Name', 'event_espresso'),
+					false,
+					''
+				),
+				'QSG_order'           => new EE_Integer_Field(
+					'QSG_order',
+					esc_html__('Order in which to show the question group', 'event_espresso'),
+					true,
+					0
+				),
+				'QSG_show_group_desc' => new EE_Boolean_Field(
+					'QSG_show_group_desc',
+					esc_html__(
+						'Flag indicating whether to show the group\s description on the registration page',
+						'event_espresso'
+					),
+					false,
+					false
+				),
+				'QSG_show_group_name' => new EE_Boolean_Field(
+					'QSG_show_group_name',
+					esc_html__(
+						'Flag indicating whether to show the group\'s name on the registration page',
+						'event_espresso'
+					),
+					false,
+					true
+				),
+				'QSG_system'          => new EE_Integer_Field(
+					'QSG_system',
+					esc_html__(
+						'Indicate IF this is a system group and if it is what system group it corresponds to.',
+						'event_espresso'
+					),
+					false,
+					0
+				),
+				'QSG_wp_user'         => new EE_WP_User_Field(
+					'QSG_wp_user',
+					esc_html__('Question Group Creator ID', 'event_espresso'),
+					false
+				),
+			],
+		];
+		$this->_model_relations = [
+			'Event'                => new EE_HABTM_Relation('Event_Question_Group'),
+			'Event_Question_Group' => new EE_Has_Many_Relation(),
+			'Question'             => new EE_HABTM_Relation('Question_Group_Question'),
+			'WP_User'              => new EE_Belongs_To_Relation(),
+		];
+		// this model is generally available for reading
+		$this->_cap_restriction_generators[ EEM_Base::caps_read ]       =
+			new EE_Restriction_Generator_Public();
+		$this->_cap_restriction_generators[ EEM_Base::caps_read_admin ] =
+			new EE_Restriction_Generator_Reg_Form('QSG_system');
+		$this->_cap_restriction_generators[ EEM_Base::caps_edit ]       =
+			new EE_Restriction_Generator_Reg_Form('QSG_system');
+		$this->_cap_restriction_generators[ EEM_Base::caps_delete ]     =
+			new EE_Restriction_Generator_Reg_Form('QSG_system');
 
-        parent::__construct($timezone);
-    }
+		parent::__construct($timezone);
+	}
 
 
-    /**
-     * searches the db for the question group with the latest question order and returns that value.
-     *
-     * @return int
-     * @throws EE_Error
-     */
-    public function get_latest_question_group_order(): int
-    {
-        $max = $this->_get_all_wpdb_results(
-            [],
-            ARRAY_A,
-            [
-                'max_order' => ["MAX(QSG_order)", "%d"],
-            ]
-        );
-        return $max[0]['max_order'];
-    }
+	/**
+	 * searches the db for the question group with the latest question order and returns that value.
+	 *
+	 * @return int
+	 * @throws EE_Error
+	 */
+	public function get_latest_question_group_order(): int
+	{
+		$max = $this->_get_all_wpdb_results(
+			[],
+			ARRAY_A,
+			[
+				'max_order' => ["MAX(QSG_order)", "%d"],
+			]
+		);
+		return $max[0]['max_order'];
+	}
 }

core/db_models/EEM_Question_Option.model.php

Spacing +4 added lines, -4 removed lines

@@ -74,13 +74,13 @@
         $this->_model_chain_to_wp_user = 'Question';
 
         // this model is generally available for reading
-        $this->_cap_restriction_generators[ EEM_Base::caps_read ]       =
+        $this->_cap_restriction_generators[EEM_Base::caps_read]       =
             new EE_Restriction_Generator_Public();
-        $this->_cap_restriction_generators[ EEM_Base::caps_read_admin ] =
+        $this->_cap_restriction_generators[EEM_Base::caps_read_admin] =
             new EE_Restriction_Generator_Reg_Form('QSO_system');
-        $this->_cap_restriction_generators[ EEM_Base::caps_edit ]       =
+        $this->_cap_restriction_generators[EEM_Base::caps_edit]       =
             new EE_Restriction_Generator_Reg_Form('QSO_system');
-        $this->_cap_restriction_generators[ EEM_Base::caps_delete ]     =
+        $this->_cap_restriction_generators[EEM_Base::caps_delete]     =
             new EE_Restriction_Generator_Reg_Form('QSO_system');
 
         parent::__construct($timezone);

Indentation +74 added lines, -74 removed lines

@@ -9,84 +9,84 @@
  */
 class EEM_Question_Option extends EEM_Soft_Delete_Base
 {
-    // private instance of the Attendee object
-    protected static $_instance = null;
+	// private instance of the Attendee object
+	protected static $_instance = null;
 
 
-    /**
-     * @param string|null $timezone
-     * @throws EE_Error
-     */
-    protected function __construct(?string $timezone = '')
-    {
-        $this->singular_item = esc_html__('Question Option', 'event_espresso');
-        $this->plural_item   = esc_html__('Question Options', 'event_espresso');
+	/**
+	 * @param string|null $timezone
+	 * @throws EE_Error
+	 */
+	protected function __construct(?string $timezone = '')
+	{
+		$this->singular_item = esc_html__('Question Option', 'event_espresso');
+		$this->plural_item   = esc_html__('Question Options', 'event_espresso');
 
-        $this->_tables          = [
-            'Question_Option' => new EE_Primary_Table('esp_question_option', 'QSO_ID'),
-        ];
-        $this->_fields          = [
-            'Question_Option' => [
-                'QSO_ID'      => new EE_Primary_Key_Int_Field(
-                    'QSO_ID',
-                    esc_html__('Question Option ID', 'event_espresso')
-                ),
-                'QST_ID'      => new EE_Foreign_Key_Int_Field(
-                    'QST_ID',
-                    esc_html__('Question ID', 'event_espresso'),
-                    false,
-                    0,
-                    'Question'
-                ),
-                'QSO_deleted' => new EE_Trashed_Flag_Field(
-                    'QSO_deleted',
-                    esc_html__('Flag indicating Option was trashed', 'event_espresso'),
-                    false,
-                    false
-                ),
-                'QSO_desc'    => new EE_Post_Content_Field(
-                    'QSO_desc',
-                    esc_html__('Question Option Description', 'event_espresso'),
-                    false,
-                    ''
-                ),
-                'QSO_order'   => new EE_Integer_Field(
-                    'QSO_order',
-                    esc_html__('Question Option Order', 'event_espresso'),
-                    false,
-                    0
-                ),
-                'QSO_system'  => new EE_Plain_Text_Field(
-                    'QSO_system',
-                    esc_html__('Internal string ID for question option', 'event_espresso'),
-                    true,
-                    null
-                ),
-                'QSO_value'   => new EE_Plain_Text_Field(
-                    'QSO_value',
-                    esc_html__("Question Option Value", "event_espresso"),
-                    false,
-                    ''
-                ),
-            ],
-        ];
-        $this->_model_relations = [
-            'Question' => new EE_Belongs_To_Relation(),
-        ];
+		$this->_tables          = [
+			'Question_Option' => new EE_Primary_Table('esp_question_option', 'QSO_ID'),
+		];
+		$this->_fields          = [
+			'Question_Option' => [
+				'QSO_ID'      => new EE_Primary_Key_Int_Field(
+					'QSO_ID',
+					esc_html__('Question Option ID', 'event_espresso')
+				),
+				'QST_ID'      => new EE_Foreign_Key_Int_Field(
+					'QST_ID',
+					esc_html__('Question ID', 'event_espresso'),
+					false,
+					0,
+					'Question'
+				),
+				'QSO_deleted' => new EE_Trashed_Flag_Field(
+					'QSO_deleted',
+					esc_html__('Flag indicating Option was trashed', 'event_espresso'),
+					false,
+					false
+				),
+				'QSO_desc'    => new EE_Post_Content_Field(
+					'QSO_desc',
+					esc_html__('Question Option Description', 'event_espresso'),
+					false,
+					''
+				),
+				'QSO_order'   => new EE_Integer_Field(
+					'QSO_order',
+					esc_html__('Question Option Order', 'event_espresso'),
+					false,
+					0
+				),
+				'QSO_system'  => new EE_Plain_Text_Field(
+					'QSO_system',
+					esc_html__('Internal string ID for question option', 'event_espresso'),
+					true,
+					null
+				),
+				'QSO_value'   => new EE_Plain_Text_Field(
+					'QSO_value',
+					esc_html__("Question Option Value", "event_espresso"),
+					false,
+					''
+				),
+			],
+		];
+		$this->_model_relations = [
+			'Question' => new EE_Belongs_To_Relation(),
+		];
 
-        $this->_caps_slug              = 'questions';
-        $this->_model_chain_to_wp_user = 'Question';
+		$this->_caps_slug              = 'questions';
+		$this->_model_chain_to_wp_user = 'Question';
 
-        // this model is generally available for reading
-        $this->_cap_restriction_generators[ EEM_Base::caps_read ]       =
-            new EE_Restriction_Generator_Public();
-        $this->_cap_restriction_generators[ EEM_Base::caps_read_admin ] =
-            new EE_Restriction_Generator_Reg_Form('QSO_system');
-        $this->_cap_restriction_generators[ EEM_Base::caps_edit ]       =
-            new EE_Restriction_Generator_Reg_Form('QSO_system');
-        $this->_cap_restriction_generators[ EEM_Base::caps_delete ]     =
-            new EE_Restriction_Generator_Reg_Form('QSO_system');
+		// this model is generally available for reading
+		$this->_cap_restriction_generators[ EEM_Base::caps_read ]       =
+			new EE_Restriction_Generator_Public();
+		$this->_cap_restriction_generators[ EEM_Base::caps_read_admin ] =
+			new EE_Restriction_Generator_Reg_Form('QSO_system');
+		$this->_cap_restriction_generators[ EEM_Base::caps_edit ]       =
+			new EE_Restriction_Generator_Reg_Form('QSO_system');
+		$this->_cap_restriction_generators[ EEM_Base::caps_delete ]     =
+			new EE_Restriction_Generator_Reg_Form('QSO_system');
 
-        parent::__construct($timezone);
-    }
+		parent::__construct($timezone);
+	}
 }

core/db_models/EEM_Question_Group_Question.model.php

Spacing +4 added lines, -4 removed lines

@@ -61,13 +61,13 @@
         $this->_model_chain_to_wp_user = 'Question_Group';
 
         // this model is generally available for reading
-        $this->_cap_restriction_generators[ EEM_Base::caps_read ]       =
+        $this->_cap_restriction_generators[EEM_Base::caps_read]       =
             new EE_Restriction_Generator_Public();
-        $this->_cap_restriction_generators[ EEM_Base::caps_read_admin ] =
+        $this->_cap_restriction_generators[EEM_Base::caps_read_admin] =
             new EE_Restriction_Generator_Reg_Form('Question_Group.QSG_system');
-        $this->_cap_restriction_generators[ EEM_Base::caps_edit ]       =
+        $this->_cap_restriction_generators[EEM_Base::caps_edit]       =
             new EE_Restriction_Generator_Reg_Form('Question_Group.QSG_system');
-        $this->_cap_restriction_generators[ EEM_Base::caps_delete ]     =
+        $this->_cap_restriction_generators[EEM_Base::caps_delete]     =
             new EE_Restriction_Generator_Reg_Form('Question_Group.QSG_system');
 
         // use the caps for question groups

Indentation +59 added lines, -59 removed lines

@@ -13,68 +13,68 @@
  */
 class EEM_Question_Group_Question extends EEM_Base
 {
-    // private instance of the Attendee object
-    protected static $_instance = null;
+	// private instance of the Attendee object
+	protected static $_instance = null;
 
 
-    /**
-     * @param string|null $timezone
-     * @throws EE_Error
-     */
-    protected function __construct(?string $timezone = '')
-    {
-        $this->singular_item    = esc_html__('Question Group to Question Link', 'event_espresso');
-        $this->plural_item      = esc_html__('Question Group to Question Links', 'event_espresso');
-        $this->_tables          = [
-            'Question_Group_Question' => new EE_Primary_Table('esp_question_group_question', 'QGQ_ID'),
-        ];
-        $this->_fields          = [
-            'Question_Group_Question' => [
-                'QGQ_ID'    => new EE_Primary_Key_Int_Field(
-                    'QGQ_ID',
-                    esc_html__('Question Group to Question Link ID', 'event_espresso')
-                ),
-                'QSG_ID'    => new EE_Foreign_Key_Int_Field(
-                    'QSG_ID',
-                    esc_html__('Question Group ID', 'event_espresso'),
-                    false,
-                    0,
-                    'Question_Group'
-                ),
-                'QST_ID'    => new EE_Foreign_Key_Int_Field(
-                    'QST_ID',
-                    esc_html__('Question Id', 'event_espresso'),
-                    false,
-                    0,
-                    'Question'
-                ),
-                'QGQ_order' => new EE_Integer_Field(
-                    'QGQ_order',
-                    esc_html__('Question Group Question Order', 'event_espresso'),
-                    false,
-                    0
-                ),
-            ],
-        ];
-        $this->_model_relations = [
-            'Question_Group' => new EE_Belongs_To_Relation(),
-            'Question'       => new EE_Belongs_To_Relation(),
-        ];
+	/**
+	 * @param string|null $timezone
+	 * @throws EE_Error
+	 */
+	protected function __construct(?string $timezone = '')
+	{
+		$this->singular_item    = esc_html__('Question Group to Question Link', 'event_espresso');
+		$this->plural_item      = esc_html__('Question Group to Question Links', 'event_espresso');
+		$this->_tables          = [
+			'Question_Group_Question' => new EE_Primary_Table('esp_question_group_question', 'QGQ_ID'),
+		];
+		$this->_fields          = [
+			'Question_Group_Question' => [
+				'QGQ_ID'    => new EE_Primary_Key_Int_Field(
+					'QGQ_ID',
+					esc_html__('Question Group to Question Link ID', 'event_espresso')
+				),
+				'QSG_ID'    => new EE_Foreign_Key_Int_Field(
+					'QSG_ID',
+					esc_html__('Question Group ID', 'event_espresso'),
+					false,
+					0,
+					'Question_Group'
+				),
+				'QST_ID'    => new EE_Foreign_Key_Int_Field(
+					'QST_ID',
+					esc_html__('Question Id', 'event_espresso'),
+					false,
+					0,
+					'Question'
+				),
+				'QGQ_order' => new EE_Integer_Field(
+					'QGQ_order',
+					esc_html__('Question Group Question Order', 'event_espresso'),
+					false,
+					0
+				),
+			],
+		];
+		$this->_model_relations = [
+			'Question_Group' => new EE_Belongs_To_Relation(),
+			'Question'       => new EE_Belongs_To_Relation(),
+		];
 
-        $this->_model_chain_to_wp_user = 'Question_Group';
+		$this->_model_chain_to_wp_user = 'Question_Group';
 
-        // this model is generally available for reading
-        $this->_cap_restriction_generators[ EEM_Base::caps_read ]       =
-            new EE_Restriction_Generator_Public();
-        $this->_cap_restriction_generators[ EEM_Base::caps_read_admin ] =
-            new EE_Restriction_Generator_Reg_Form('Question_Group.QSG_system');
-        $this->_cap_restriction_generators[ EEM_Base::caps_edit ]       =
-            new EE_Restriction_Generator_Reg_Form('Question_Group.QSG_system');
-        $this->_cap_restriction_generators[ EEM_Base::caps_delete ]     =
-            new EE_Restriction_Generator_Reg_Form('Question_Group.QSG_system');
+		// this model is generally available for reading
+		$this->_cap_restriction_generators[ EEM_Base::caps_read ]       =
+			new EE_Restriction_Generator_Public();
+		$this->_cap_restriction_generators[ EEM_Base::caps_read_admin ] =
+			new EE_Restriction_Generator_Reg_Form('Question_Group.QSG_system');
+		$this->_cap_restriction_generators[ EEM_Base::caps_edit ]       =
+			new EE_Restriction_Generator_Reg_Form('Question_Group.QSG_system');
+		$this->_cap_restriction_generators[ EEM_Base::caps_delete ]     =
+			new EE_Restriction_Generator_Reg_Form('Question_Group.QSG_system');
 
-        // use the caps for question groups
-        $this->_caps_slug = 'question_groups';
-        parent::__construct($timezone);
-    }
+		// use the caps for question groups
+		$this->_caps_slug = 'question_groups';
+		parent::__construct($timezone);
+	}
 }

core/db_models/strategies/EE_Restriction_Generator_Base.strategy.php

Spacing +6 added lines, -6 removed lines

@@ -82,7 +82,7 @@ 
      */
     public function model()
     {
-        if (! $this->_model instanceof EEM_Base) {
+        if ( ! $this->_model instanceof EEM_Base) {
             throw new EE_Error(
                 sprintf(
                     esc_html__(
@@ -106,7 +106,7 @@ 
      */
     public function action(): string
     {
-        if (! $this->_action) {
+        if ( ! $this->_action) {
             throw new EE_Error(
                 sprintf(
                     esc_html__(
@@ -260,16 +260,16 @@ 
             || strpos($path_to_event_model, 'Event') !== false
         ) {
             $where_conditions['OR*status'] = [
-                $path_to_event_model . 'status' => $published_value,
+                $path_to_event_model.'status' => $published_value,
                 'AND'                           => [
-                    $path_to_event_model .
+                    $path_to_event_model.
                     'Post_Meta.meta_key'                          => '_previous_event_status',
-                    $path_to_event_model .
+                    $path_to_event_model.
                     'Post_Meta.meta_value'                        => $published_value,
                 ],
             ];
         } else {
-            $where_conditions[ $path_to_event_model . 'status' ] =
+            $where_conditions[$path_to_event_model.'status'] =
                 $published_value;
         }
         return $where_conditions;

Indentation +214 added lines, -214 removed lines

@@ -36,242 +36,242 @@
  */
 abstract class EE_Restriction_Generator_Base
 {
-    /**
-     * One of EEM_Base::valid_cap_contexts()
-     *
-     * @var string
-     */
-    protected $_action;
+	/**
+	 * One of EEM_Base::valid_cap_contexts()
+	 *
+	 * @var string
+	 */
+	protected $_action;
 
-    /**
-     * The restrictions generated by this object. FALSE before any are made.
-     *
-     * @var EE_Default_Where_Conditions[]
-     */
-    protected $_cap_restrictions_generated;
+	/**
+	 * The restrictions generated by this object. FALSE before any are made.
+	 *
+	 * @var EE_Default_Where_Conditions[]
+	 */
+	protected $_cap_restrictions_generated;
 
-    /**
-     * Model for which restrictions are generated
-     *
-     * @var EEM_Base
-     */
-    protected $_model;
+	/**
+	 * Model for which restrictions are generated
+	 *
+	 * @var EEM_Base
+	 */
+	protected $_model;
 
 
-    /**
-     * Puts the last necessary info onto the restriction generator class. This
-     * is usually called by EEM_Base during its constructor, so child classes
-     * don't have to always provide this info.
-     *
-     * @param EEM_Base $model
-     * @param string   $action
-     */
-    public function _construct_finalize(EEM_Base $model, string $action)
-    {
-        $this->_model  = $model;
-        $this->_action = $action;
-    }
+	/**
+	 * Puts the last necessary info onto the restriction generator class. This
+	 * is usually called by EEM_Base during its constructor, so child classes
+	 * don't have to always provide this info.
+	 *
+	 * @param EEM_Base $model
+	 * @param string   $action
+	 */
+	public function _construct_finalize(EEM_Base $model, string $action)
+	{
+		$this->_model  = $model;
+		$this->_action = $action;
+	}
 
 
-    /**
-     * Returns the model set for this restriction generator
-     *
-     * @return EEM_Base|EEM_Soft_Delete_Base
-     * @throws EE_Error
-     */
-    public function model()
-    {
-        if (! $this->_model instanceof EEM_Base) {
-            throw new EE_Error(
-                sprintf(
-                    esc_html__(
-                        'Cannot generate capability restrictions because model has not yet been set on the %s. Please ensure _construct_finalize() was called',
-                        'event_espresso'
-                    ),
-                    get_class($this)
-                )
-            );
-        }
-        return $this->_model;
-    }
+	/**
+	 * Returns the model set for this restriction generator
+	 *
+	 * @return EEM_Base|EEM_Soft_Delete_Base
+	 * @throws EE_Error
+	 */
+	public function model()
+	{
+		if (! $this->_model instanceof EEM_Base) {
+			throw new EE_Error(
+				sprintf(
+					esc_html__(
+						'Cannot generate capability restrictions because model has not yet been set on the %s. Please ensure _construct_finalize() was called',
+						'event_espresso'
+					),
+					get_class($this)
+				)
+			);
+		}
+		return $this->_model;
+	}
 
 
-    /**
-     * Returns the action this restriction generator will generate restrictions
-     * for. It should be one of EEM_Base::valid_cap_contexts()
-     *
-     * @return string
-     * @throws EE_Error
-     */
-    public function action(): string
-    {
-        if (! $this->_action) {
-            throw new EE_Error(
-                sprintf(
-                    esc_html__(
-                        'Cannot generate capability restrictions because model has not yet been set on the %s. Please ensure _construct_finalize() was called',
-                        'event_espresso'
-                    ),
-                    get_class($this)
-                )
-            );
-        }
-        return $this->_action;
-    }
+	/**
+	 * Returns the action this restriction generator will generate restrictions
+	 * for. It should be one of EEM_Base::valid_cap_contexts()
+	 *
+	 * @return string
+	 * @throws EE_Error
+	 */
+	public function action(): string
+	{
+		if (! $this->_action) {
+			throw new EE_Error(
+				sprintf(
+					esc_html__(
+						'Cannot generate capability restrictions because model has not yet been set on the %s. Please ensure _construct_finalize() was called',
+						'event_espresso'
+					),
+					get_class($this)
+				)
+			);
+		}
+		return $this->_action;
+	}
 
 
-    /**
-     * Returns whether or not _construct_finalize() has been called on this
-     * restriction generator object
-     *
-     * @return boolean
-     */
-    public function construction_finalized(): bool
-    {
-        return $this->_model instanceof EEM_Base && $this->_action;
-    }
+	/**
+	 * Returns whether or not _construct_finalize() has been called on this
+	 * restriction generator object
+	 *
+	 * @return boolean
+	 */
+	public function construction_finalized(): bool
+	{
+		return $this->_model instanceof EEM_Base && $this->_action;
+	}
 
 
-    /**
-     * Gets the capability restrictions generated by this object. Caches them in
-     * case they are required for subsequent requests
-     *
-     * @return array @see EEM_Base::_cap_restrictions
-     */
-    public function generate_restrictions(): array
-    {
-        if ($this->_cap_restrictions_generated === null) {
-            $this->_cap_restrictions_generated = apply_filters(
-                'FHEE__EE_Restriction_Generator_Base__generate_restrictions__first_time',
-                $this->_generate_restrictions(),
-                $this
-            );
-        }
-        return apply_filters(
-            'FHEE__EE_Restriction_Generator_Base__generate_restrictions__every_time',
-            $this->_cap_restrictions_generated,
-            $this
-        );
-    }
+	/**
+	 * Gets the capability restrictions generated by this object. Caches them in
+	 * case they are required for subsequent requests
+	 *
+	 * @return array @see EEM_Base::_cap_restrictions
+	 */
+	public function generate_restrictions(): array
+	{
+		if ($this->_cap_restrictions_generated === null) {
+			$this->_cap_restrictions_generated = apply_filters(
+				'FHEE__EE_Restriction_Generator_Base__generate_restrictions__first_time',
+				$this->_generate_restrictions(),
+				$this
+			);
+		}
+		return apply_filters(
+			'FHEE__EE_Restriction_Generator_Base__generate_restrictions__every_time',
+			$this->_cap_restrictions_generated,
+			$this
+		);
+	}
 
 
-    /**
-     * Provided with the model, and using global knowledge about what
-     * capabilities exist, generates an array for use in one of the sub-arrays
-     * in EEM_Base::_cap_restrictions, where keys are capability names, and
-     * values are children of EE_Default_Where_Conditions
-     *
-     * @return EE_Default_Where_Conditions[]|EE_Return_None_Where_Conditions[]
-     * @see EEM_Base::_cap_restrictions
-     */
-    abstract protected function _generate_restrictions(): array;
+	/**
+	 * Provided with the model, and using global knowledge about what
+	 * capabilities exist, generates an array for use in one of the sub-arrays
+	 * in EEM_Base::_cap_restrictions, where keys are capability names, and
+	 * values are children of EE_Default_Where_Conditions
+	 *
+	 * @return EE_Default_Where_Conditions[]|EE_Return_None_Where_Conditions[]
+	 * @see EEM_Base::_cap_restrictions
+	 */
+	abstract protected function _generate_restrictions(): array;
 
 
-    /**
-     * Whether or not this restriction generator has already done its job of
-     * making restrictions and caching them on itself in case its asked later
-     *
-     * @return boolean
-     */
-    public function has_generated_cap_restrictions(): bool
-    {
-        return $this->_cap_restrictions_generated !== null;
-    }
+	/**
+	 * Whether or not this restriction generator has already done its job of
+	 * making restrictions and caching them on itself in case its asked later
+	 *
+	 * @return boolean
+	 */
+	public function has_generated_cap_restrictions(): bool
+	{
+		return $this->_cap_restrictions_generated !== null;
+	}
 
 
-    /**
-     * Given an action like 'edit' generates the cap name based off
-     * the EEM_Base::_cap_slug, which for events would be 'events', to generate
-     * the cap name like 'ee_edit_events'. If a $qualifier is passed,
-     *
-     * @param EEM_Base $model
-     * @param string   $action
-     * @return string
-     */
-    public static function get_cap_name(EEM_Base $model, string $action): string
-    {
-        $prefix = $model->is_wp_core_model() ? '' : 'ee_';
-        $cap_slug = $model->cap_slug();
-        return apply_filters(
-            'FHEE__EE_Restriction_Generator__get_cap_name',
-            "{$prefix}{$action}_{$cap_slug}",
-            $model,
-            $action
-        );
-    }
+	/**
+	 * Given an action like 'edit' generates the cap name based off
+	 * the EEM_Base::_cap_slug, which for events would be 'events', to generate
+	 * the cap name like 'ee_edit_events'. If a $qualifier is passed,
+	 *
+	 * @param EEM_Base $model
+	 * @param string   $action
+	 * @return string
+	 */
+	public static function get_cap_name(EEM_Base $model, string $action): string
+	{
+		$prefix = $model->is_wp_core_model() ? '' : 'ee_';
+		$cap_slug = $model->cap_slug();
+		return apply_filters(
+			'FHEE__EE_Restriction_Generator__get_cap_name',
+			"{$prefix}{$action}_{$cap_slug}",
+			$model,
+			$action
+		);
+	}
 
 
-    /**
-     * Checks if there is a cap for this model and this action
-     *
-     * @param EEM_Base $model
-     * @param string   $action
-     * @return boolean
-     * @throws EE_Error
-     */
-    public static function is_cap(EEM_Base $model, string $action): bool
-    {
-        $caps_for_admin = EE_Registry::instance()->CAP->get_ee_capabilities();
-        return in_array(self::get_cap_name($model, $action), $caps_for_admin);
-    }
+	/**
+	 * Checks if there is a cap for this model and this action
+	 *
+	 * @param EEM_Base $model
+	 * @param string   $action
+	 * @return boolean
+	 * @throws EE_Error
+	 */
+	public static function is_cap(EEM_Base $model, string $action): bool
+	{
+		$caps_for_admin = EE_Registry::instance()->CAP->get_ee_capabilities();
+		return in_array(self::get_cap_name($model, $action), $caps_for_admin);
+	}
 
 
-    /**
-     * Returns the default capability used to determine if the current user can
-     * access something.
-     *
-     * @return string
-     */
-    public static function get_default_restrictions_cap(): string
-    {
-        return apply_filters(
-            'FHEE__EE_Restriction_Generator_Base__default_restrictions_cap',
-            'manage_options'
-        );
-    }
+	/**
+	 * Returns the default capability used to determine if the current user can
+	 * access something.
+	 *
+	 * @return string
+	 */
+	public static function get_default_restrictions_cap(): string
+	{
+		return apply_filters(
+			'FHEE__EE_Restriction_Generator_Base__default_restrictions_cap',
+			'manage_options'
+		);
+	}
 
 
-    /**
-     * Gets WHERE conditions for the query that show the post model is
-     * published, or that it's sold out and it was previously published
-     *
-     * @param array   $where_conditions
-     * @param boolean $check_if_published  if true, will add conditions like
-     *                                     status=publish if false, will add
-     *                                     conditions like status!=private
-     * @param string  $path_to_event_model including the period at the end
-     * @return array
-     * @throws EE_Error
-     */
-    protected function addPublishedPostConditions(
-        $where_conditions = [],
-        $check_if_published = true,
-        $path_to_event_model = ''
-    ): array {
-        if ($check_if_published) {
-            $published_value = 'publish';
-        } else {
-            $published_value = ['!=', 'private'];
-        }
-        // only add a check for the previous event status
-        // if the model is the event or it's related to the event model
-        if (
-            $this->model() instanceof EEM_Event
-            || strpos($path_to_event_model, 'Event') !== false
-        ) {
-            $where_conditions['OR*status'] = [
-                $path_to_event_model . 'status' => $published_value,
-                'AND'                           => [
-                    $path_to_event_model .
-                    'Post_Meta.meta_key'                          => '_previous_event_status',
-                    $path_to_event_model .
-                    'Post_Meta.meta_value'                        => $published_value,
-                ],
-            ];
-        } else {
-            $where_conditions[ $path_to_event_model . 'status' ] =
-                $published_value;
-        }
-        return $where_conditions;
-    }
+	/**
+	 * Gets WHERE conditions for the query that show the post model is
+	 * published, or that it's sold out and it was previously published
+	 *
+	 * @param array   $where_conditions
+	 * @param boolean $check_if_published  if true, will add conditions like
+	 *                                     status=publish if false, will add
+	 *                                     conditions like status!=private
+	 * @param string  $path_to_event_model including the period at the end
+	 * @return array
+	 * @throws EE_Error
+	 */
+	protected function addPublishedPostConditions(
+		$where_conditions = [],
+		$check_if_published = true,
+		$path_to_event_model = ''
+	): array {
+		if ($check_if_published) {
+			$published_value = 'publish';
+		} else {
+			$published_value = ['!=', 'private'];
+		}
+		// only add a check for the previous event status
+		// if the model is the event or it's related to the event model
+		if (
+			$this->model() instanceof EEM_Event
+			|| strpos($path_to_event_model, 'Event') !== false
+		) {
+			$where_conditions['OR*status'] = [
+				$path_to_event_model . 'status' => $published_value,
+				'AND'                           => [
+					$path_to_event_model .
+					'Post_Meta.meta_key'                          => '_previous_event_status',
+					$path_to_event_model .
+					'Post_Meta.meta_value'                        => $published_value,
+				],
+			];
+		} else {
+			$where_conditions[ $path_to_event_model . 'status' ] =
+				$published_value;
+		}
+		return $where_conditions;
+	}
 }

core/db_models/strategies/EE_Restriction_Generator_Meta.strategy.php

Spacing +5 added lines, -5 removed lines

@@ -52,21 +52,21 @@
                 'FHEE__EE_Restriction_Generator_Meta___generate_restrictions__blacklisted_meta_keys',
                 []
             );
-        $conditions            = [
+        $conditions = [
             $this->_key_field_name   => ['NOT_LIKE', "\\\\_%"],
             // each slash is escaped because we are using double quotes, and
             // stripslashes will be called on this because the models assume this is from user input
             $this->_value_field_name => ['NOT_REGEXP', '^[aOs]:[\d]:.*$'],
         ];
-        if (! empty($blacklisted_meta_keys)) {
-            $conditions[ $this->_key_field_name . '*blacklisted' ] =
+        if ( ! empty($blacklisted_meta_keys)) {
+            $conditions[$this->_key_field_name.'*blacklisted'] =
                 ['NOT_IN', $blacklisted_meta_keys];
         }
-        if (! empty($whitelisted_meta_keys)) {
+        if ( ! empty($whitelisted_meta_keys)) {
             $conditions = [
                 'OR*whitelisted-or-normal' => [
                     'AND'                                   => $conditions,
-                    $this->_key_field_name . '*whitelisted' => [
+                    $this->_key_field_name.'*whitelisted' => [
                         'IN',
                         $whitelisted_meta_keys,
                     ],

Indentation +66 added lines, -66 removed lines

@@ -11,75 +11,75 @@
  */
 class EE_Restriction_Generator_Meta extends EE_Restriction_Generator_Base
 {
-    /**
-     * @var string the name of the field containing the meta key
-     */
-    protected $_key_field_name = null;
+	/**
+	 * @var string the name of the field containing the meta key
+	 */
+	protected $_key_field_name = null;
 
-    /**
-     * @var string the name of the field containing the meta value
-     */
-    protected $_value_field_name = null;
+	/**
+	 * @var string the name of the field containing the meta value
+	 */
+	protected $_value_field_name = null;
 
 
-    /**
-     * Accepts the name of the field that indicates whether or not an object is
-     * a "system" one or not
-     *
-     * @param string $key_field_name
-     * @param string $value_field_name
-     */
-    public function __construct(string $key_field_name, string $value_field_name)
-    {
-        $this->_key_field_name   = $key_field_name;
-        $this->_value_field_name = $value_field_name;
-    }
+	/**
+	 * Accepts the name of the field that indicates whether or not an object is
+	 * a "system" one or not
+	 *
+	 * @param string $key_field_name
+	 * @param string $value_field_name
+	 */
+	public function __construct(string $key_field_name, string $value_field_name)
+	{
+		$this->_key_field_name   = $key_field_name;
+		$this->_value_field_name = $value_field_name;
+	}
 
 
-    /**
-     * @return EE_Default_Where_Conditions[]|EE_Return_None_Where_Conditions[]
-     */
-    protected function _generate_restrictions(): array
-    {
-        $whitelisted_meta_keys =
-            apply_filters(
-                'FHEE__EE_Restriction_Generator_Meta___generate_restrictions__whitelisted_meta_keys',
-                []
-            );
-        $blacklisted_meta_keys =
-            apply_filters(
-                'FHEE__EE_Restriction_Generator_Meta___generate_restrictions__blacklisted_meta_keys',
-                []
-            );
-        $conditions            = [
-            $this->_key_field_name   => ['NOT_LIKE', "\\\\_%"],
-            // each slash is escaped because we are using double quotes, and
-            // stripslashes will be called on this because the models assume this is from user input
-            $this->_value_field_name => ['NOT_REGEXP', '^[aOs]:[\d]:.*$'],
-        ];
-        if (! empty($blacklisted_meta_keys)) {
-            $conditions[ $this->_key_field_name . '*blacklisted' ] =
-                ['NOT_IN', $blacklisted_meta_keys];
-        }
-        if (! empty($whitelisted_meta_keys)) {
-            $conditions = [
-                'OR*whitelisted-or-normal' => [
-                    'AND'                                   => $conditions,
-                    $this->_key_field_name . '*whitelisted' => [
-                        'IN',
-                        $whitelisted_meta_keys,
-                    ],
-                ],
-            ];
-        }
-        return [
-            // only allow access to non-protected metas if they're an admin
-            EE_Restriction_Generator_Base::get_default_restrictions_cap() => new EE_Return_None_Where_Conditions(),
-            // don't allow access to protected metas to anyone.
-            // If they want that, don't apply caps to the query
-            'apply-to-all-queries-using-caps' => new EE_Default_Where_Conditions(
-                $conditions
-            ),
-        ];
-    }
+	/**
+	 * @return EE_Default_Where_Conditions[]|EE_Return_None_Where_Conditions[]
+	 */
+	protected function _generate_restrictions(): array
+	{
+		$whitelisted_meta_keys =
+			apply_filters(
+				'FHEE__EE_Restriction_Generator_Meta___generate_restrictions__whitelisted_meta_keys',
+				[]
+			);
+		$blacklisted_meta_keys =
+			apply_filters(
+				'FHEE__EE_Restriction_Generator_Meta___generate_restrictions__blacklisted_meta_keys',
+				[]
+			);
+		$conditions            = [
+			$this->_key_field_name   => ['NOT_LIKE', "\\\\_%"],
+			// each slash is escaped because we are using double quotes, and
+			// stripslashes will be called on this because the models assume this is from user input
+			$this->_value_field_name => ['NOT_REGEXP', '^[aOs]:[\d]:.*$'],
+		];
+		if (! empty($blacklisted_meta_keys)) {
+			$conditions[ $this->_key_field_name . '*blacklisted' ] =
+				['NOT_IN', $blacklisted_meta_keys];
+		}
+		if (! empty($whitelisted_meta_keys)) {
+			$conditions = [
+				'OR*whitelisted-or-normal' => [
+					'AND'                                   => $conditions,
+					$this->_key_field_name . '*whitelisted' => [
+						'IN',
+						$whitelisted_meta_keys,
+					],
+				],
+			];
+		}
+		return [
+			// only allow access to non-protected metas if they're an admin
+			EE_Restriction_Generator_Base::get_default_restrictions_cap() => new EE_Return_None_Where_Conditions(),
+			// don't allow access to protected metas to anyone.
+			// If they want that, don't apply caps to the query
+			'apply-to-all-queries-using-caps' => new EE_Default_Where_Conditions(
+				$conditions
+			),
+		];
+	}
 }

core/db_models/strategies/EE_Restriction_Generator_Taxonomy_Protected.strategy.php

Spacing +4 added lines, -4 removed lines

@@ -45,14 +45,14 @@ 
     protected function _generate_restrictions(): array
     {
         // if there are no standard caps for this model, then allow full access
-        if (! $this->model()->cap_slug()) {
+        if ( ! $this->model()->cap_slug()) {
             return [];
         }
 
         return [
             'ee_manage_event_categories' => new EE_Default_Where_Conditions(
                 [
-                    $this->_path_to_taxonomy_model .
+                    $this->_path_to_taxonomy_model.
                     'taxonomy*no_ee_manage_event_categories' => [
                         '!=',
                         'espresso_event_categories',
@@ -61,7 +61,7 @@ 
             ),
             'ee_manage_venue_categories' => new EE_Default_Where_Conditions(
                 [
-                    $this->_path_to_taxonomy_model .
+                    $this->_path_to_taxonomy_model.
                     'taxonomy*no_ee_manage_venue_categories' => [
                         '!=',
                         'espresso_venue_categories',
@@ -70,7 +70,7 @@ 
             ),
             'ee_manage_event_types'      => new EE_Default_Where_Conditions(
                 [
-                    $this->_path_to_taxonomy_model .
+                    $this->_path_to_taxonomy_model.
                     'taxonomy*ee_manage_event_types' => [
                         '!=',
                         'espresso_event_types'

Indentation +62 added lines, -62 removed lines

@@ -11,71 +11,71 @@
  */
 class EE_Restriction_Generator_Taxonomy_Protected extends EE_Restriction_Generator_Base
 {
-    /**
-     * Model chain/path to taxonomy model,
-     * including the term_taxonomy model itself
-     *
-     * @var string
-     */
-    protected $_path_to_taxonomy_model;
+	/**
+	 * Model chain/path to taxonomy model,
+	 * including the term_taxonomy model itself
+	 *
+	 * @var string
+	 */
+	protected $_path_to_taxonomy_model;
 
 
-    /**
-     * @param string $path_to_taxonomy_model Model chain/path to taxonomy
-     *                                       model, including the term_taxonomy
-     *                                       model itself
-     */
-    public function __construct(string $path_to_taxonomy_model)
-    {
-        if (
-            $path_to_taxonomy_model !== '' &&
-            substr($path_to_taxonomy_model, -1, 1) != '.'
-        ) {
-            $path_to_taxonomy_model .= '.';
-        }
-        $this->_path_to_taxonomy_model = $path_to_taxonomy_model;
-    }
+	/**
+	 * @param string $path_to_taxonomy_model Model chain/path to taxonomy
+	 *                                       model, including the term_taxonomy
+	 *                                       model itself
+	 */
+	public function __construct(string $path_to_taxonomy_model)
+	{
+		if (
+			$path_to_taxonomy_model !== '' &&
+			substr($path_to_taxonomy_model, -1, 1) != '.'
+		) {
+			$path_to_taxonomy_model .= '.';
+		}
+		$this->_path_to_taxonomy_model = $path_to_taxonomy_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 allow full access
-        if (! $this->model()->cap_slug()) {
-            return [];
-        }
+	/**
+	 * @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 allow full access
+		if (! $this->model()->cap_slug()) {
+			return [];
+		}
 
-        return [
-            'ee_manage_event_categories' => new EE_Default_Where_Conditions(
-                [
-                    $this->_path_to_taxonomy_model .
-                    'taxonomy*no_ee_manage_event_categories' => [
-                        '!=',
-                        'espresso_event_categories',
-                    ],
-                ]
-            ),
-            'ee_manage_venue_categories' => new EE_Default_Where_Conditions(
-                [
-                    $this->_path_to_taxonomy_model .
-                    'taxonomy*no_ee_manage_venue_categories' => [
-                        '!=',
-                        'espresso_venue_categories',
-                    ],
-                ]
-            ),
-            'ee_manage_event_types'      => new EE_Default_Where_Conditions(
-                [
-                    $this->_path_to_taxonomy_model .
-                    'taxonomy*ee_manage_event_types' => [
-                        '!=',
-                        'espresso_event_types'
-                    ]
-                ]
-            ),
-        ];
-    }
+		return [
+			'ee_manage_event_categories' => new EE_Default_Where_Conditions(
+				[
+					$this->_path_to_taxonomy_model .
+					'taxonomy*no_ee_manage_event_categories' => [
+						'!=',
+						'espresso_event_categories',
+					],
+				]
+			),
+			'ee_manage_venue_categories' => new EE_Default_Where_Conditions(
+				[
+					$this->_path_to_taxonomy_model .
+					'taxonomy*no_ee_manage_venue_categories' => [
+						'!=',
+						'espresso_venue_categories',
+					],
+				]
+			),
+			'ee_manage_event_types'      => new EE_Default_Where_Conditions(
+				[
+					$this->_path_to_taxonomy_model .
+					'taxonomy*ee_manage_event_types' => [
+						'!=',
+						'espresso_event_types'
+					]
+				]
+			),
+		];
+	}
 }

core/db_models/strategies/EE_Restriction_Generator_Reg_Form.strategy.php

Spacing +7 added lines, -7 removed lines

@@ -40,7 +40,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 [
                 EE_Restriction_Generator_Base::get_default_restrictions_cap(
                 ) => new EE_Return_None_Where_Conditions(),
@@ -57,18 +57,18 @@ 
         // there is also no "ee_delete_system_questions" cap.
         // But folks shouldn't be deleting system questions anyway
         if ($this->action() !== EEM_Base::caps_read) {
-            $restrictions[ EE_Restriction_Generator_Base::get_cap_name(
+            $restrictions[EE_Restriction_Generator_Base::get_cap_name(
                 $this->model(),
-                $this->action() . '_system'
-            ) ] = new EE_Default_Where_Conditions(
+                $this->action().'_system'
+            )] = new EE_Default_Where_Conditions(
                 [
-                    'OR*no_' .
+                    'OR*no_'.
                     EE_Restriction_Generator_Base::get_cap_name(
                         $this->model(),
-                        $this->action() . '_system'
+                        $this->action().'_system'
                     ) => [
                         $this->_system_field_name => ['IN', ['', 0]],
-                        $this->_system_field_name . '*' => ['IS_NULL'],
+                        $this->_system_field_name.'*' => ['IS_NULL'],
                     ],
                 ]
             );

Indentation +58 added lines, -58 removed lines

@@ -12,66 +12,66 @@
  */
 class EE_Restriction_Generator_Reg_Form extends EE_Restriction_Generator_Base
 {
-    /**
-     * @var string  the name of the field that indicates
-     *              whether or not this is a system thing
-     */
-    protected $_system_field_name = null;
+	/**
+	 * @var string  the name of the field that indicates
+	 *              whether or not this is a system thing
+	 */
+	protected $_system_field_name = null;
 
 
-    /**
-     * Accepts the name of the field that indicates
-     * whether or not an object is a "system" one or not
-     *
-     * @param string $system_field_name
-     */
-    public function __construct(string $system_field_name)
-    {
-        $this->_system_field_name = $system_field_name;
-    }
+	/**
+	 * Accepts the name of the field that indicates
+	 * whether or not an object is a "system" one or not
+	 *
+	 * @param string $system_field_name
+	 */
+	public function __construct(string $system_field_name)
+	{
+		$this->_system_field_name = $system_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 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(),
-            ];
-        }
-        $restrictions = [
-            EE_Restriction_Generator_Base::get_cap_name(
-                $this->model(),
-                $this->action()
-            ) => new EE_Return_None_Where_Conditions(),
-        ];
-        // there is no "ee_read_system_questions" cap;
-        // in order to read reg form items you only need "ee_read_{model_name}".
-        // there is also no "ee_delete_system_questions" cap.
-        // But folks shouldn't be deleting system questions anyway
-        if ($this->action() !== EEM_Base::caps_read) {
-            $restrictions[ EE_Restriction_Generator_Base::get_cap_name(
-                $this->model(),
-                $this->action() . '_system'
-            ) ] = new EE_Default_Where_Conditions(
-                [
-                    'OR*no_' .
-                    EE_Restriction_Generator_Base::get_cap_name(
-                        $this->model(),
-                        $this->action() . '_system'
-                    ) => [
-                        $this->_system_field_name => ['IN', ['', 0]],
-                        $this->_system_field_name . '*' => ['IS_NULL'],
-                    ],
-                ]
-            );
-        }
-        return $restrictions;
-    }
+	/**
+	 * @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 [
+				EE_Restriction_Generator_Base::get_default_restrictions_cap(
+				) => new EE_Return_None_Where_Conditions(),
+			];
+		}
+		$restrictions = [
+			EE_Restriction_Generator_Base::get_cap_name(
+				$this->model(),
+				$this->action()
+			) => new EE_Return_None_Where_Conditions(),
+		];
+		// there is no "ee_read_system_questions" cap;
+		// in order to read reg form items you only need "ee_read_{model_name}".
+		// there is also no "ee_delete_system_questions" cap.
+		// But folks shouldn't be deleting system questions anyway
+		if ($this->action() !== EEM_Base::caps_read) {
+			$restrictions[ EE_Restriction_Generator_Base::get_cap_name(
+				$this->model(),
+				$this->action() . '_system'
+			) ] = new EE_Default_Where_Conditions(
+				[
+					'OR*no_' .
+					EE_Restriction_Generator_Base::get_cap_name(
+						$this->model(),
+						$this->action() . '_system'
+					) => [
+						$this->_system_field_name => ['IN', ['', 0]],
+						$this->_system_field_name . '*' => ['IS_NULL'],
+					],
+				]
+			);
+		}
+		return $restrictions;
+	}
 }