Automattic\WooCommerce\Internal\RestApi\Routes\V4

AbstractCollectionQuery{} │ abstract │ WC 1.0

AbstractCollectionQuery class.

No Hooks.

Usage

$AbstractCollectionQuery = new AbstractCollectionQuery();
// use class methods

Methods

1. public get_query_args( WP_REST_Request $request )
2. public get_query_results( array $query_args, WP_REST_Request $request )
3. public get_query_schema()

AbstractCollectionQuery{} AbstractCollectionQuery{} code ^{WC 10.4.3}

abstract class AbstractCollectionQuery {
	/**
	 * Operator constants for easy access.
	 */
	const OPERATOR_IS                    = 'is';
	const OPERATOR_IS_NOT                = 'isNot';
	const OPERATOR_LESS_THAN             = 'lessThan';
	const OPERATOR_GREATER_THAN          = 'greaterThan';
	const OPERATOR_LESS_THAN_OR_EQUAL    = 'lessThanOrEqual';
	const OPERATOR_GREATER_THAN_OR_EQUAL = 'greaterThanOrEqual';
	const OPERATOR_BETWEEN               = 'between';

	/**
	 * Array of operators for validation.
	 */
	const OPERATORS = array(
		self::OPERATOR_IS,
		self::OPERATOR_IS_NOT,
		self::OPERATOR_LESS_THAN,
		self::OPERATOR_GREATER_THAN,
		self::OPERATOR_LESS_THAN_OR_EQUAL,
		self::OPERATOR_GREATER_THAN_OR_EQUAL,
		self::OPERATOR_BETWEEN,
	);

	/**
	 * Get query schema for collection.
	 *
	 * @return array
	 */
	abstract public function get_query_schema(): array;

	/**
	 * Prepares query args.
	 *
	 * @param WP_REST_Request $request The request object.
	 * @return array
	 */
	abstract public function get_query_args( WP_REST_Request $request ): array;

	/**
	 * Get results of the query.
	 *
	 * @param array           $query_args The query arguments.
	 * @param WP_REST_Request $request The request object.
	 * @return array
	 */
	abstract public function get_query_results( array $query_args, WP_REST_Request $request ): array;
}