Changeset 16854

Timestamp:

12/10/2010 08:20:46 AM (14 years ago)

Author:

scribu

Message:

Inline docs for WP_Tax_Query. See #15752

Location:

trunk/wp-includes

Files:

• query.php (modified) (2 diffs)
• taxonomy.php (modified) (4 diffs)

trunk/wp-includes/query.php

@@ -1472 +1472 @@
 
     /*
-     * Parses various taxonomy related query vars and sets the appropriate query flags
+     * Parses various taxonomy related query vars and sets the appropriate query flags.
      *
      * @access protected
@@ -1478 +1478 @@
      *
      * @param array &$q The query variables
-     * @return array tax query
+     * @return WP_Tax_Query
      */
     function parse_tax_query( &$q ) {

trunk/wp-includes/taxonomy.php

@@ -507 +507 @@
 
 /*
- * Given a taxonomy query, generates SQL to be appended to a main query
+ * Given a taxonomy query, generates SQL to be appended to a main query.
  *
  * @since 3.1.0
  *
- * @param array $tax_query List of taxonomy queries. A single taxonomy query is an associative array:
- * - 'taxonomy' string 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: 'term_id'
- * - 'operator' string (optional)
- *      Possible values: 'IN' and 'NOT IN'.
- *      Default: 'IN'
- * - 'include_children' bool (optional) Whether to include child terms.
- *      Default: true
- *
+ * @see WP_Tax_Query
+ *
+ * @param array $tax_query A compact tax query
  * @param string $primary_table
  * @param string $primary_id_column
@@ -532 +523 @@
 }
 
+/**
+ * Container class for a multiple taxonomy query.
+ *
+ * @since 3.1.0
+ */
 class WP_Tax_Query {
-    var $relation = '';
+
+    /**
+     * List of taxonomy queries. A single taxonomy query is an associative array:
+     * - 'taxonomy' string 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: 'term_id'
+     * - 'operator' string (optional)
+     *      Possible values: 'IN' and 'NOT IN'.
+     *      Default: 'IN'
+     * - 'include_children' bool (optional) Whether to include child terms.
+     *      Default: true
+     *
+     * @since 3.1.0
+     * @access public
+     * @var array
+     */
     var $queries = array();
 
-    function WP_Tax_Query( &$tax_query ) {
+    /**
+     * The relation between the queries. Can be one of 'AND' or 'OR'.
+     *
+     * @since 3.1.0
+     * @access public
+     * @var string
+     */
+    var $relation;
+
+    /**
+     * PHP4 type constructor.
+     *
+     * Parses a compact tax query and sets defaults.
+     *
+     * @since 3.1.0
+     * @access public
+     *
+     * @param array $tax_query A compact tax query:
+     *  array(
+     *    'relation' => 'OR',
+     *    array(
+     *      'taxonomy' => 'tax1',
+     *      'terms' => array( 'term1', 'term2' ),
+     *      'field' => 'slug',
+     *    ),
+     *    array(
+     *      'taxonomy' => 'tax2',
+     *      'terms' => array( 'term-a', 'term-b' ),
+     *      'field' => 'slug',
+     *    ),
+     *  )
+     *
+     * @return WP_Tax_Query
+     */
+    function WP_Tax_Query( $tax_query ) {
         if ( isset( $tax_query['relation'] ) && strtoupper( $tax_query['relation'] ) == 'OR' ) {
             $this->relation = 'OR';
@@ -563 +610 @@
     }
 
+    /**
+     * Generates SQL clauses to be appended to a main query.
+     *
+     * @since 3.1.0
+     * @access public
+     *
+     * @param string $primary_table
+     * @param string $primary_id_column
+     * @return array
+     */
     function get_sql( $primary_table, $primary_id_column ) {
         global $wpdb;
@@ -641 +698 @@
     }
 
+    /**
+     * Transforms a list of terms, from one field to another.
+     *
+     * @since 3.1.0
+     * @access private
+     *
+     * @param array &$terms The list of terms
+     * @param string $taxonomy The taxonomy of the terms
+     * @param string $field The initial field
+     * @param string $resulting_field The resulting field    
+     */
     function _transform_terms( &$terms, $taxonomy, $field, $resulting_field ) {
         global $wpdb;