Form_Query

Class representing a query for forms.

Description

Source

File: src/db-objects/forms/form-query.php

class Form_Query extends Core_Query {

	/**
	 * Sets up the query for retrieving forms.
	 *
	 * @since 1.0.0
	 *
	 * @param string|array $query Array or query string of form query arguments.
	 * @return Form_Collection Collection of forms.
	 */
	public function query( $query ) {
		$query = $this->map_args( $query );

		if ( isset( $query['fields'] ) && 'ids' !== $query['fields'] ) {
			$query['fields'] = '';
		}

		return parent::query( $query );
	}

	/**
	 * Instantiates the internal Core query object.
	 *
	 * @since 1.0.0
	 *
	 * @return object Internal Core query object.
	 */
	protected function instantiate_query_object() {
		return new WP_Query();
	}

	/**
	 * Parses the results of the internal Core query into a collection.
	 *
	 * @since 1.0.0
	 *
	 * @return Form_Collection Results as a collection.
	 */
	protected function parse_results_collection() {
		$ids = $this->original->posts;
		$fields = $this->original->query_vars['fields'];

		if ( 'ids' !== $fields ) {
			$ids = wp_list_pluck( $ids, 'ID' );
			$fields = 'objects';
		}

		return $this->create_collection( $ids, $this->original->found_posts, $fields );
	}

	/**
	 * Returns the fields that are valid to be used in orderby clauses.
	 *
	 * @since 1.0.0
	 *
	 * @return array Array of valid orderby fields.
	 */
	public function get_valid_orderby_fields() {
		$orderby_fields = parent::get_valid_orderby_fields();

		return array_merge( $orderby_fields, array( 'timestamp', 'timestamp_modified' ) );
	}

	/**
	 * Maps form query arguments to regular post query arguments.
	 *
	 * @since 1.0.0
	 *
	 * @param array $args Arguments as `$query_var => $value` pairs.
	 * @return array Mapped arguments.
	 */
	protected function map_args( $args ) {
		if ( is_array( $args['orderby'] ) && ! empty( $args['orderby'] ) ) {
			$args['order'] = array_values( $args['orderby'] )[0];
			$args['orderby'] = array_keys( $args['orderby'] )[0];
		}

		$mapped_args = $args;
		foreach ( $args as $query_var => $value ) {
			switch ( $query_var ) {
				case 'search':
					$mapped_args['s'] = $value;
					unset( $mapped_args['search'] );
					break;
				case 'slug':
					$mapped_args['name'] = $value;
					unset( $mapped_args['slug'] );
					break;
				case 'timestamp':
					unset( $mapped_args['timestamp'] );
					break;
				case 'timestamp_modified':
					unset( $mapped_args['timestamp_modified'] );
					break;
				case 'orderby':
					if ( 'slug' === $value ) {
						$mapped_args[ $query_var ] = 'name';
					} elseif ( 'timestamp' === $value ) {
						$mapped_args[ $query_var ] = 'date';
					} elseif ( 'timestamp_modified' === $value ) {
						$mapped_args[ $query_var ] = 'modified';
					}
					break;
				case 'status':
					$mapped_args[ 'post_' . $query_var ] = $value;
			}
		}

		$mapped_args['post_type'] = $this->manager->get_prefix() . 'form';

		return $mapped_args;
	}
}

Changelog

Changelog
Version Description
1.0.0 Introduced.

Methods