eventespresso / event-espresso-core

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

Indentation +166 added lines, -166 removed lines

@@ -16,170 +16,170 @@
  */
 class CountryConnectionResolver extends AbstractConnectionResolver
 {
-    // phpcs:ignore PSR1.Methods.CamelCapsMethodName.NotCamelCaps
-    public function get_loader_name(): string
-    {
-        return 'espresso_country';
-    }
-
-    /**
-     * @return EEM_Country
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     * @throws ReflectionException
-     */
-    // phpcs:ignore PSR1.Methods.CamelCapsMethodName.NotCamelCaps
-    public function get_query(): EEM_Country
-    {
-        return EEM_Country::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 : [];
-    }
-
-    /**
-     * Get_query_amount
-     *
-     * Returns the max between what was requested and what is defined as the $max_query_amount to
-     * ensure that queries don't exceed unwanted limits when querying data.
-     *
-     * @return int
-     * @throws Exception
-     */
-    // phpcs:ignore PSR1.Methods.CamelCapsMethodName.NotCamelCaps
-    public function get_query_amount()
-    {
-        // Override the default limit (100) for countries
-        return 500;
-    }
-
-
-    /**
-     * 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 InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     */
-    // phpcs:ignore PSR1.Methods.CamelCapsMethodName.NotCamelCaps
-    public function get_query_args(): array
-    {
-        $where_params = [];
-        $query_args   = [];
-
-        $query_args['limit'] = $this->getLimit();
-
-        // Avoid multiple entries by join.
-        $query_args['group_by'] = 'CNT_ISO';
-
-        $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']);
-
-            // Since we do not have any falsy values in query params
-            // Lets get rid of empty values
-            $input_fields = array_filter($input_fields);
-
-            // Use the proper operator.
-            if (! empty($input_fields['CNT_ISO']) && is_array($input_fields['CNT_ISO'])) {
-                $input_fields['CNT_ISO'] = ['IN', $input_fields['CNT_ISO']];
-            }
-            if (! empty($input_fields['CNT_ISO3']) && is_array($input_fields['CNT_ISO3'])) {
-                $input_fields['CNT_ISO3'] = ['IN', $input_fields['CNT_ISO3']];
-            }
-        }
-
-        /**
-         * Merge the input_fields with the default query_args
-         */
-        if (! empty($input_fields)) {
-            $where_params = array_merge($where_params, $input_fields);
-        }
-
-        // limit to active countries by default.
-        if (!isset($this->args['where']['activeOnly']) || $this->args['where']['activeOnly']) {
-            $where_params['CNT_active'] = true;
-        }
-
-        [$query_args, $where_params] = $this->mapOrderbyInputArgs($query_args, $where_params, 'CNT_ISO');
-
-        if (empty($query_args['order_by'])) {
-            // set order_by to 'name' by default
-            $query_args['order_by'] = [
-                'CNT_name' => 'ASC',
-            ];
-        }
-
-        $search = $this->getSearchKeywords($this->args['where']);
-
-        if (! empty($search)) {
-            // use OR operator to search in any of the fields
-            $where_params['OR'] = array(
-                'CNT_name' => array('LIKE', '%' . $search . '%'),
-                'CNT_ISO'  => array('LIKE', '%' . $search . '%'),
-            );
-        }
-
-        $where_params = apply_filters(
-            'FHEE__EventEspresso_core_domain_services_graphql_connection_resolvers__country_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__country_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 = [
-            'isoIn'  => 'CNT_ISO',
-            'in'     => 'CNT_ISO',
-            'iso3In' => 'CNT_ISO3',
-        ];
-        return $this->sanitizeWhereArgsForInputFields(
-            $where_args,
-            $arg_mapping,
-            ['in']
-        );
-    }
+	// phpcs:ignore PSR1.Methods.CamelCapsMethodName.NotCamelCaps
+	public function get_loader_name(): string
+	{
+		return 'espresso_country';
+	}
+
+	/**
+	 * @return EEM_Country
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 * @throws ReflectionException
+	 */
+	// phpcs:ignore PSR1.Methods.CamelCapsMethodName.NotCamelCaps
+	public function get_query(): EEM_Country
+	{
+		return EEM_Country::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 : [];
+	}
+
+	/**
+	 * Get_query_amount
+	 *
+	 * Returns the max between what was requested and what is defined as the $max_query_amount to
+	 * ensure that queries don't exceed unwanted limits when querying data.
+	 *
+	 * @return int
+	 * @throws Exception
+	 */
+	// phpcs:ignore PSR1.Methods.CamelCapsMethodName.NotCamelCaps
+	public function get_query_amount()
+	{
+		// Override the default limit (100) for countries
+		return 500;
+	}
+
+
+	/**
+	 * 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 InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 */
+	// phpcs:ignore PSR1.Methods.CamelCapsMethodName.NotCamelCaps
+	public function get_query_args(): array
+	{
+		$where_params = [];
+		$query_args   = [];
+
+		$query_args['limit'] = $this->getLimit();
+
+		// Avoid multiple entries by join.
+		$query_args['group_by'] = 'CNT_ISO';
+
+		$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']);
+
+			// Since we do not have any falsy values in query params
+			// Lets get rid of empty values
+			$input_fields = array_filter($input_fields);
+
+			// Use the proper operator.
+			if (! empty($input_fields['CNT_ISO']) && is_array($input_fields['CNT_ISO'])) {
+				$input_fields['CNT_ISO'] = ['IN', $input_fields['CNT_ISO']];
+			}
+			if (! empty($input_fields['CNT_ISO3']) && is_array($input_fields['CNT_ISO3'])) {
+				$input_fields['CNT_ISO3'] = ['IN', $input_fields['CNT_ISO3']];
+			}
+		}
+
+		/**
+		 * Merge the input_fields with the default query_args
+		 */
+		if (! empty($input_fields)) {
+			$where_params = array_merge($where_params, $input_fields);
+		}
+
+		// limit to active countries by default.
+		if (!isset($this->args['where']['activeOnly']) || $this->args['where']['activeOnly']) {
+			$where_params['CNT_active'] = true;
+		}
+
+		[$query_args, $where_params] = $this->mapOrderbyInputArgs($query_args, $where_params, 'CNT_ISO');
+
+		if (empty($query_args['order_by'])) {
+			// set order_by to 'name' by default
+			$query_args['order_by'] = [
+				'CNT_name' => 'ASC',
+			];
+		}
+
+		$search = $this->getSearchKeywords($this->args['where']);
+
+		if (! empty($search)) {
+			// use OR operator to search in any of the fields
+			$where_params['OR'] = array(
+				'CNT_name' => array('LIKE', '%' . $search . '%'),
+				'CNT_ISO'  => array('LIKE', '%' . $search . '%'),
+			);
+		}
+
+		$where_params = apply_filters(
+			'FHEE__EventEspresso_core_domain_services_graphql_connection_resolvers__country_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__country_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 = [
+			'isoIn'  => 'CNT_ISO',
+			'in'     => 'CNT_ISO',
+			'iso3In' => 'CNT_ISO3',
+		];
+		return $this->sanitizeWhereArgsForInputFields(
+			$where_args,
+			$arg_mapping,
+			['in']
+		);
+	}
 }

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

Indentation +170 added lines, -170 removed lines

@@ -19,174 +19,174 @@
  */
 abstract class AbstractConnectionResolver extends WPGraphQLConnectionResolver
 {
-    const MAX_QUERY_LIMIT = 250;
-
-    /**
-     * @var Utilities
-     */
-    private $utilities;
-
-
-    /**
-     * @return Utilities
-     */
-    public function getUtilities(): Utilities
-    {
-        if (! $this->utilities instanceof Utilities) {
-            $this->utilities = LoaderFactory::getLoader()->getShared(Utilities::class);
-        }
-        return $this->utilities;
-    }
-
-    /**
-     * Determine whether the Query should execute. If it's determined that the query should
-     * not be run based on context such as, but not limited to, who the user is, where in the
-     * ResolveTree the Query is, the relation to the node the Query is connected to, etc
-     * Return false to prevent the query from executing.
-     *
-     * @return bool
-     */
-    // phpcs:ignore PSR1.Methods.CamelCapsMethodName.NotCamelCaps
-    public function should_execute(): bool
-    {
-        return $this->should_execute;
-    }
-
-
-    /**
-     * Set limit the highest value of first and last, with a (filterable) max of 500
-     *
-     * @return int
-     */
-    protected function getLimit(): int
-    {
-        $first = ! empty($this->args['first'])
-            ? absint($this->args['first'])
-            : null;
-        $last  = ! empty($this->args['last'])
-            ? absint($this->args['last'])
-            : null;
-
-        $limit = min(
-            max($first, $last, self::MAX_QUERY_LIMIT),
-            $this->query_amount
-        );
-        $limit++;
-        return $limit;
-    }
-
-    // /**
-    //  * Get_amount_requested
-    //  *
-    //  * This checks the $args to determine the amount requested
-    //  *
-    //  * @return int|null
-    //  * @throws Exception
-    //  */
-    // // phpcs:ignore PSR1.Methods.CamelCapsMethodName.NotCamelCaps
-    // public function get_amount_requested(): ?int
-    // {
-    //     $amount_requested = parent::get_amount_requested();
-    //
-    //     /**
-    //      * If both first & last are used in the input args, throw an exception as that won't
-    //      * work properly
-    //      */
-    //     if (empty($this->args['first']) && empty($this->args['last']) && $amount_requested === ConnectionsManager::MAX_AMOUNT_REQUESTED) {
-    //         return ConnectionsManager::MAX_AMOUNT_REQUESTED; // default.
-    //     }
-    //
-    //     return $amount_requested;
-    // }
-
-    /**
-     * Determine whether or not the the offset is valid, i.e the entity corresponding to the
-     * offset exists. Offset is equivalent to entity ID. So this function is equivalent to
-     * checking if the entity with the given ID exists.
-     *
-     * @param int $offset The ID of the node used for the cursor offset
-     * @return bool
-     */
-    // phpcs:ignore PSR1.Methods.CamelCapsMethodName.NotCamelCaps
-    public function is_valid_offset($offset): bool
-    {
-        $entity = $this->get_query()->get_one_by_ID($offset);
-
-        return $entity instanceof EE_Base_Class;
-    }
-
-    /**
-     * Validates Model.
-     *
-     * @param array $model Entity node.
-     * @return bool
-     */
-    // phpcs:ignore PSR1.Methods.CamelCapsMethodName.NotCamelCaps
-    protected function is_valid_model($model): bool
-    {
-        return $model instanceof EE_Base_Class;
-    }
-
-
-    /**
-     * This sets up the "allowed" args, and translates the GraphQL-friendly keys to model
-     * friendly keys.
-     *
-     * @param array  $query_args
-     * @param array  $where_params
-     * @param string $primary_key
-     * @return array
-     */
-    protected function mapOrderbyInputArgs(array $query_args, array $where_params, string $primary_key): array
-    {
-        // ID of the current offset
-        $offset = $this->get_offset();
-        /**
-         * Map the orderby inputArgs to the WP_Query
-         */
-        if (! empty($this->args['where']['orderby']) && is_array($this->args['where']['orderby'])) {
-            $query_args['order_by'] = [];
-            foreach ($this->args['where']['orderby'] as $orderby_input) {
-                $query_args['order_by'][ $orderby_input['field'] ] = $orderby_input['order'];
-            }
-        } elseif ($offset) {
-            $compare = $this->args['last'] ? '<' : '>';
-            $where_params[ $primary_key ] = [$compare, $offset];
-        }
-        return [$query_args, $where_params];
-    }
-
-
-    /**
-     * This sets up the "allowed" args, and translates the GraphQL-friendly keys to model
-     * friendly keys.
-     *
-     * @param array $where_args
-     * @param array $arg_mapping
-     * @param array $id_fields The fields to convert from global IDs to DB IDs.
-     * @return array
-     */
-    protected function sanitizeWhereArgsForInputFields(array $where_args, array $arg_mapping, array $id_fields = []): array
-    {
-        $query_args = $this->getUtilities()->sanitizeWhereArgs($where_args, $arg_mapping, $id_fields);
-        return ! empty($query_args) && is_array($query_args)
-            ? $query_args
-            : [];
-    }
-
-
-    /**
-     * This returns the sanitized "search" keywords from where_args
-     *
-     * @param array $where_args
-     * @return string
-     */
-    protected function getSearchKeywords(array $where_args): string
-    {
-        $search = '';
-        if (! empty($where_args['search'])) {
-            $search = sanitize_text_field($where_args['search']);
-        }
-        return esc_sql($search);
-    }
+	const MAX_QUERY_LIMIT = 250;
+
+	/**
+	 * @var Utilities
+	 */
+	private $utilities;
+
+
+	/**
+	 * @return Utilities
+	 */
+	public function getUtilities(): Utilities
+	{
+		if (! $this->utilities instanceof Utilities) {
+			$this->utilities = LoaderFactory::getLoader()->getShared(Utilities::class);
+		}
+		return $this->utilities;
+	}
+
+	/**
+	 * Determine whether the Query should execute. If it's determined that the query should
+	 * not be run based on context such as, but not limited to, who the user is, where in the
+	 * ResolveTree the Query is, the relation to the node the Query is connected to, etc
+	 * Return false to prevent the query from executing.
+	 *
+	 * @return bool
+	 */
+	// phpcs:ignore PSR1.Methods.CamelCapsMethodName.NotCamelCaps
+	public function should_execute(): bool
+	{
+		return $this->should_execute;
+	}
+
+
+	/**
+	 * Set limit the highest value of first and last, with a (filterable) max of 500
+	 *
+	 * @return int
+	 */
+	protected function getLimit(): int
+	{
+		$first = ! empty($this->args['first'])
+			? absint($this->args['first'])
+			: null;
+		$last  = ! empty($this->args['last'])
+			? absint($this->args['last'])
+			: null;
+
+		$limit = min(
+			max($first, $last, self::MAX_QUERY_LIMIT),
+			$this->query_amount
+		);
+		$limit++;
+		return $limit;
+	}
+
+	// /**
+	//  * Get_amount_requested
+	//  *
+	//  * This checks the $args to determine the amount requested
+	//  *
+	//  * @return int|null
+	//  * @throws Exception
+	//  */
+	// // phpcs:ignore PSR1.Methods.CamelCapsMethodName.NotCamelCaps
+	// public function get_amount_requested(): ?int
+	// {
+	//     $amount_requested = parent::get_amount_requested();
+	//
+	//     /**
+	//      * If both first & last are used in the input args, throw an exception as that won't
+	//      * work properly
+	//      */
+	//     if (empty($this->args['first']) && empty($this->args['last']) && $amount_requested === ConnectionsManager::MAX_AMOUNT_REQUESTED) {
+	//         return ConnectionsManager::MAX_AMOUNT_REQUESTED; // default.
+	//     }
+	//
+	//     return $amount_requested;
+	// }
+
+	/**
+	 * Determine whether or not the the offset is valid, i.e the entity corresponding to the
+	 * offset exists. Offset is equivalent to entity ID. So this function is equivalent to
+	 * checking if the entity with the given ID exists.
+	 *
+	 * @param int $offset The ID of the node used for the cursor offset
+	 * @return bool
+	 */
+	// phpcs:ignore PSR1.Methods.CamelCapsMethodName.NotCamelCaps
+	public function is_valid_offset($offset): bool
+	{
+		$entity = $this->get_query()->get_one_by_ID($offset);
+
+		return $entity instanceof EE_Base_Class;
+	}
+
+	/**
+	 * Validates Model.
+	 *
+	 * @param array $model Entity node.
+	 * @return bool
+	 */
+	// phpcs:ignore PSR1.Methods.CamelCapsMethodName.NotCamelCaps
+	protected function is_valid_model($model): bool
+	{
+		return $model instanceof EE_Base_Class;
+	}
+
+
+	/**
+	 * This sets up the "allowed" args, and translates the GraphQL-friendly keys to model
+	 * friendly keys.
+	 *
+	 * @param array  $query_args
+	 * @param array  $where_params
+	 * @param string $primary_key
+	 * @return array
+	 */
+	protected function mapOrderbyInputArgs(array $query_args, array $where_params, string $primary_key): array
+	{
+		// ID of the current offset
+		$offset = $this->get_offset();
+		/**
+		 * Map the orderby inputArgs to the WP_Query
+		 */
+		if (! empty($this->args['where']['orderby']) && is_array($this->args['where']['orderby'])) {
+			$query_args['order_by'] = [];
+			foreach ($this->args['where']['orderby'] as $orderby_input) {
+				$query_args['order_by'][ $orderby_input['field'] ] = $orderby_input['order'];
+			}
+		} elseif ($offset) {
+			$compare = $this->args['last'] ? '<' : '>';
+			$where_params[ $primary_key ] = [$compare, $offset];
+		}
+		return [$query_args, $where_params];
+	}
+
+
+	/**
+	 * This sets up the "allowed" args, and translates the GraphQL-friendly keys to model
+	 * friendly keys.
+	 *
+	 * @param array $where_args
+	 * @param array $arg_mapping
+	 * @param array $id_fields The fields to convert from global IDs to DB IDs.
+	 * @return array
+	 */
+	protected function sanitizeWhereArgsForInputFields(array $where_args, array $arg_mapping, array $id_fields = []): array
+	{
+		$query_args = $this->getUtilities()->sanitizeWhereArgs($where_args, $arg_mapping, $id_fields);
+		return ! empty($query_args) && is_array($query_args)
+			? $query_args
+			: [];
+	}
+
+
+	/**
+	 * This returns the sanitized "search" keywords from where_args
+	 *
+	 * @param array $where_args
+	 * @return string
+	 */
+	protected function getSearchKeywords(array $where_args): string
+	{
+		$search = '';
+		if (! empty($where_args['search'])) {
+			$search = sanitize_text_field($where_args['search']);
+		}
+		return esc_sql($search);
+	}
 }

core/services/graphql/ConnectionsManager.php

Indentation +42 added lines, -42 removed lines

@@ -17,58 +17,58 @@
  */
 class ConnectionsManager implements GQLManagerInterface
 {
-    const MAX_AMOUNT_REQUESTED = 250;
+	const MAX_AMOUNT_REQUESTED = 250;
 
-    const MAX_QUERY_AMOUNT = 250;
+	const MAX_QUERY_AMOUNT = 250;
 
 
-    /**
-     * @var ConnectionCollection|ConnectionInterface[] $connections
-     */
-    private $connections;
+	/**
+	 * @var ConnectionCollection|ConnectionInterface[] $connections
+	 */
+	private $connections;
 
 
-    /**
-     * ConnectionsManager constructor.
-     *
-     * @param ConnectionCollection|ConnectionInterface[] $connections
-     */
-    public function __construct(ConnectionCollection $connections)
-    {
-        $this->connections = $connections;
-    }
+	/**
+	 * ConnectionsManager constructor.
+	 *
+	 * @param ConnectionCollection|ConnectionInterface[] $connections
+	 */
+	public function __construct(ConnectionCollection $connections)
+	{
+		$this->connections = $connections;
+	}
 
 
-    /**
-     * @throws CollectionDetailsException
-     * @throws CollectionLoaderException
-     * @since $VID:$
-     */
-    public function init()
-    {
-        $this->connections->loadConnections();
-        add_action('graphql_register_types', [$this, 'registerConnections'], 20);
-        add_filter('graphql_connection_amount_requested', [$this, 'setMaxAmountRequested']);
-        add_filter('graphql_connection_max_query_amount', [$this, 'setMaxQueryAmount']);
-    }
+	/**
+	 * @throws CollectionDetailsException
+	 * @throws CollectionLoaderException
+	 * @since $VID:$
+	 */
+	public function init()
+	{
+		$this->connections->loadConnections();
+		add_action('graphql_register_types', [$this, 'registerConnections'], 20);
+		add_filter('graphql_connection_amount_requested', [$this, 'setMaxAmountRequested']);
+		add_filter('graphql_connection_max_query_amount', [$this, 'setMaxQueryAmount']);
+	}
 
 
-    public function registerConnections()
-    {
-        // loop through the collection of types and register their fields
-        foreach ($this->connections as $connection) {
-            register_graphql_connection($connection->config());
-        }
-    }
+	public function registerConnections()
+	{
+		// loop through the collection of types and register their fields
+		foreach ($this->connections as $connection) {
+			register_graphql_connection($connection->config());
+		}
+	}
 
 
-    public function setMaxAmountRequested(): int
-    {
-        return ConnectionsManager::MAX_AMOUNT_REQUESTED;
-    }
+	public function setMaxAmountRequested(): int
+	{
+		return ConnectionsManager::MAX_AMOUNT_REQUESTED;
+	}
 
-    public function setMaxQueryAmount(): int
-    {
-        return ConnectionsManager::MAX_QUERY_AMOUNT;
-    }
+	public function setMaxQueryAmount(): int
+	{
+		return ConnectionsManager::MAX_QUERY_AMOUNT;
+	}
 }