Container_Query

Class representing a query for containers.

Description

Source

File: src/db-objects/containers/container-query.php

class Container_Query extends Query {
	/**
	 * Constructor.
	 *
	 * Sets the manager instance and assigns the defaults.
	 *
	 * @since 1.0.0
	 *
	 * @param Container_Manager $manager The manager instance for the model query.
	 */
	public function __construct( $manager ) {
		parent::__construct( $manager );

		$this->query_var_defaults['orderby'] = array( 'sort' => 'ASC' );
		$this->query_var_defaults['form_id'] = '';
		$this->query_var_defaults['sort']    = '';
	}

	/**
	 * Parses the SQL where clause.
	 *
	 * @since 1.0.0
	 *
	 * @return array Array with the first element being the array of SQL where clauses and the second
	 *               being the array of arguments for those where clauses.
	 */
	protected function parse_where() {
		list( $where, $args ) = parent::parse_where();

		list( $where, $args ) = $this->parse_default_where_field( $where, $args, 'form_id', 'form_id', '%d', 'absint', true );

		if ( '' !== $this->query_vars['sort'] ) {
			$table_name = $this->manager->get_table_name();

			if ( is_array( $this->query_vars['sort'] ) ) {
				if ( isset( $this->query_vars['sort']['greater_than'] ) ) {
					if ( ! empty( $this->query_vars['sort']['inclusive'] ) ) {
						$where['sort_greater_than'] = "%{$table_name}%.sort >= %d";
					} else {
						$where['sort_greater_than'] = "%{$table_name}%.sort > %d";
					}
					$args[] = absint( $this->query_vars['sort']['greater_than'] );
				}

				if ( isset( $this->query_vars['sort']['lower_than'] ) ) {
					if ( ! empty( $this->query_vars['sort']['inclusive'] ) ) {
						$where['sort_lower_than'] = "%{$table_name}%.sort <= %d";
					} else {
						$where['sort_lower_than'] = "%{$table_name}%.sort < %d";
					}
					$args[] = absint( $this->query_vars['sort']['lower_than'] );
				}
			} else {
				$where['sort'] = "%{$table_name}%.sort = %d";
				$args[] = absint( $this->query_vars['sort'] );
			}
		}

		return array( $where, $args );
	}

	/**
	 * 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( 'sort' ) );
	}
}

Changelog

Changelog
Version Description
1.0.0 Introduced.

Methods