WordPress/wp-includes/class-wp-object-query.php

<?php
/**
 * WordPress Query class.
 *
 * Abstract class for handling advanced queries
 *
 * @package WordPress
 * @since 3.1.0
 */
class WP_Object_Query {

	/**
	 * Query vars, after parsing
	 *
	 * @since 3.1.0
	 * @access public
	 * @var array
	 */
	var $query_vars;

	/**
	 * Retrieve query variable.
	 *
	 * @since 3.1.0
	 * @access public
	 *
	 * @param string $query_var Query variable key.
	 * @return mixed
	 */
	function get( $query_var ) {
		if ( isset( $this->query_vars[$query_var] ) )
			return $this->query_vars[$query_var];

		return '';
	}

	/**
	 * Set query variable.
	 *
	 * @since 3.1.0
	 * @access public
	 *
	 * @param string $query_var Query variable key.
	 * @param mixed $value Query variable value.
	 */
	function set( $query_var, $value ) {
		$this->query_vars[ $query_var ] = $value;
	}

	/*
	 * Populates the $meta_query property
	 *
	 * @access protected
	 * @since 3.1.0
	 *
	 * @param array $qv The query variables
	 */
	function parse_meta_query( &$qv ) {
		$meta_query = array();

		// Simple query needs to be first for orderby=meta_value to work correctly
		foreach ( array( 'key', 'value', 'compare', 'type' ) as $key ) {
			if ( !empty( $qv[ "meta_$key" ] ) )
				$meta_query[0][ $key ] = $qv[ "meta_$key" ];
		}

		if ( !empty( $qv['meta_query'] ) && is_array( $qv['meta_query'] ) ) {
			$meta_query = array_merge( $meta_query, $qv['meta_query'] );
		}

		$qv['meta_query'] = $meta_query;
	}

	/*
	 * Used internally to generate an SQL string for searching across multiple meta key = value pairs
	 *
	 * @access protected
	 * @since 3.1.0
	 *
	 * @param array $meta_query List of metadata queries. A single query is an associative array:
	 * - 'key' string The meta key
	 * - 'value' string|array The meta value
	 * - 'compare' (optional) string How to compare the key to the value.
	 *		Possible values: '=', '!=', '>', '>=', '<', '<=', 'LIKE', 'NOT LIKE', 'IN', 'NOT IN', 'BETWEEN', 'NOT BETWEEN'.
	 *		Default: '='
	 * - 'type' string (optional) The type of the value.
	 *		Possible values: 'NUMERIC', 'BINARY', 'CHAR', 'DATE', 'DATETIME', 'DECIMAL', 'SIGNED', 'TIME', 'UNSIGNED'.
	 *		Default: 'CHAR'
	 *
	 * @param string $meta_type
	 * @param string $primary_table
	 * @param string $primary_id_column
	 * @return array( $join_sql, $where_sql )
	 */
	function get_meta_sql( $meta_query, $meta_type, $primary_table, $primary_id_column ) {
		global $wpdb;

		if ( ! $meta_table = _get_meta_table( $meta_type ) )
			return false;

		$meta_id_column = esc_sql( $meta_type . '_id' );

		$clauses = array();

		$join = '';
		$where = '';
		$i = 0;
		foreach ( $meta_query as $q ) {
			$meta_key = isset( $q['key'] ) ? trim( $q['key'] ) : '';
			$meta_value = isset( $q['value'] ) ? $q['value'] : '';
			$meta_compare = isset( $q['compare'] ) ? strtoupper( $q['compare'] ) : '=';
			$meta_type = isset( $q['type'] ) ? strtoupper( $q['type'] ) : 'CHAR';

			if ( ! in_array( $meta_compare, array( '=', '!=', '>', '>=', '<', '<=', 'LIKE', 'NOT LIKE', 'IN', 'NOT IN', 'BETWEEN', 'NOT BETWEEN' ) ) )
				$meta_compare = '=';

			if ( 'NUMERIC' == $meta_type )
				$meta_type = 'SIGNED';
			elseif ( ! in_array( $meta_type, array( 'BINARY', 'CHAR', 'DATE', 'DATETIME', 'DECIMAL', 'SIGNED', 'TIME', 'UNSIGNED' ) ) )
				$meta_type = 'CHAR';

			if ( empty( $meta_key ) && empty( $meta_value ) )
				continue;

			$alias = $i ? 'mt' . $i : $meta_table;

			$join .= "\nINNER JOIN $meta_table";
			$join .= $i ? " AS $alias" : '';
			$join .= " ON ($primary_table.$primary_id_column = $alias.$meta_id_column)";

			$i++;

			if ( !empty( $meta_key ) )
				$where .= $wpdb->prepare( " AND $alias.meta_key = %s", $meta_key );

			if ( in_array( $meta_compare, array( 'IN', 'NOT IN', 'BETWEEN', 'NOT BETWEEN' ) ) ) {
				if ( ! is_array( $meta_value ) )
					$meta_value = preg_split( '/[,\s]+/', $meta_value );
			} else {
				$meta_value = trim( $meta_value );
			}

			if ( empty( $meta_value ) )
				continue;

			if ( 'IN' == substr( $meta_compare, -2) ) {
				$meta_field_types = substr( str_repeat( ',%s', count( $meta_value ) ), 1 );
				$meta_compare_string = "($meta_field_types)";
				unset( $meta_field_types );
			} elseif ( 'BETWEEN' == substr( $meta_compare, -7) ) {
				$meta_value = array_slice( $meta_value, 0, 2 );
				$meta_compare_string = '%s AND %s';
			} elseif ( 'LIKE' == substr( $meta_compare, -4 ) ) {
				$meta_value = '%' . like_escape( $meta_value ) . '%';
				$meta_compare_string = '%s';
			} else {
				$meta_compare_string = '%s';
			}
			$where .= $wpdb->prepare( " AND CAST($alias.meta_value AS {$meta_type}) {$meta_compare} {$meta_compare_string}", $meta_value );

			unset( $meta_compare_string );
		}

		return apply_filters( 'get_meta_sql', compact( 'join', 'where' ), $meta_query, $meta_type, $primary_table, $primary_id_column );
	}

	/*
	 * Used internally to generate an SQL string for searching across multiple taxonomies
	 *
	 * @access protected
	 * @since 3.1.0
	 *
	 * @param array $tax_query List of taxonomy queries. A single taxonomy query is an associative array:
	 * - 'taxonomy' string|array The taxonomy being queried
	 * - 'terms' string|array The list of terms
	 * - 'field' string (optional) Which term field is being used.
	 *		Possible values: 'term_id', 'slug' or 'name'
	 *		Default: 'slug'
	 * - 'operator' string (optional)
	 *		Possible values: 'IN' and 'NOT IN'.
	 *		Default: 'IN'
	 * - 'include_children' bool (optional) Whether to include child terms.
	 *		Default: true
	 *
	 * @param string $object_id_column
	 * @return string
	 */
	function get_tax_sql( $tax_query, $object_id_column ) {
		global $wpdb;

		$sql = array();
		foreach ( $tax_query as $query ) {
			if ( !isset( $query['include_children'] ) )
				$query['include_children'] = true;

			$query['do_query'] = false;

			$sql_single = get_objects_in_term( $query['terms'], $query['taxonomy'], $query );

			if ( empty( $sql_single ) )
				return ' AND 0 = 1';

			$sql[] = $sql_single;
		}

		if ( 1 == count( $sql ) ) {
			$ids = $wpdb->get_col( $sql[0] );
		} else {
			$r = "SELECT object_id FROM $wpdb->term_relationships WHERE 1=1";
			foreach ( $sql as $query )
				$r .= " AND object_id IN ($query)";

			$ids = $wpdb->get_col( $r );
		}

		if ( !empty( $ids ) )
			return " AND $object_id_column IN(" . implode( ', ', $ids ) . ")";
		else
			return ' AND 0 = 1';
	}

	/*
	 * Used internally to generate an SQL string for searching across multiple columns
	 *
	 * @access protected
	 * @since 3.1.0
	 *
	 * @param string $string
	 * @param array $cols
	 * @param bool $wild Whether to allow trailing wildcard searches. Default is false.
	 * @return string
	 */
	function get_search_sql( $string, $cols, $wild = false ) {
		$string = esc_sql( $string );

		$searches = array();
		$wild_char = ( $wild ) ? '%' : '';
		foreach ( $cols as $col ) {
			if ( 'ID' == $col )
				$searches[] = "$col = '$string'";
			else
				$searches[] = "$col LIKE '$string$wild_char'";
		}

		return ' AND (' . implode(' OR ', $searches) . ')';
	}
}

?>