Changeset 10163 for trunk/src/bp-xprofile/classes/class-bp-xprofile-meta-query.php

Timestamp:

10/01/2015 04:18:13 AM (10 years ago)

Author:

tw2113

Message:

First pass of documentation cleanup for the XProfile Component.

See #6406.

File:

• trunk/src/bp-xprofile/classes/class-bp-xprofile-meta-query.php (modified) (9 diffs)

trunk/src/bp-xprofile/classes/class-bp-xprofile-meta-query.php

@@ -1 +1 @@
 <?php
 /**
- * BuddyPress XProfile Classes
+ * BuddyPress XProfile Classes.
  *
  * @package BuddyPress
@@ -33 +33 @@
      *
      * @param array $query Meta query arguments.
+     *
      * @return bool Whether the query clause is a first-order clause.
      */
@@ -45 +46 @@
      * @access public
      *
-     * @param array $qv The query variables
+     * @param array $qv The query variables.
      */
     public function parse_query_vars( $qv ) {
@@ -68 +69 @@
         }
 
-        // BP_XProfile_Query sets 'object_type' = '' by default
+        // BP_XProfile_Query sets 'object_type' = '' by default.
         if ( isset( $qv[ 'object_type' ] ) && ( '' !== $qv[ 'object_type' ] ) && ( ! is_array( $qv[ 'object_type' ] ) || $qv[ 'object_type' ] ) ) {
             $meta_query[0]['object'] = $qv[ 'object_type' ];
@@ -102 +103 @@
      * @param string $primary_id_column ID column for the filtered object in $primary_table.
      * @param object $context           Optional. The main query object.
+     *
      * @return array {
      *     Array containing JOIN and WHERE SQL clauses to append to the main query.
@@ -161 +163 @@
      * @param string $clause_key   Optional. The array key used to name the clause in the original `$meta_query`
      *                             parameters. If not provided, a key will be generated automatically.
+     *
      * @return array {
      *     Array containing JOIN and WHERE SQL clauses to append to a first-order query.
@@ -246 +249 @@
 
         // Next, build the WHERE clause.
-
-        // meta_key.
+        // Meta_key.
         if ( array_key_exists( 'key', $clause ) ) {
             if ( 'NOT EXISTS' === $meta_compare ) {
@@ -256 +258 @@
         }
 
-        // meta_value.
+        // Meta_value.
         if ( array_key_exists( 'value', $clause ) ) {
             $meta_value = $clause['value'];
@@ -309 +311 @@
         }
 
-        // object_type.
+        // Object_type.
         if ( array_key_exists( 'object', $clause ) ) {
             $object_type = $clause['object'];