Changeset 10253 for trunk/src/bp-activity/classes/class-bp-activity-query.php

Timestamp:

10/12/2015 05:45:14 AM (11 years ago)

Author:

tw2113

Message:

Further documentation cleanup for Activity Component.

See #6396.

File:

• trunk/src/bp-activity/classes/class-bp-activity-query.php (modified) (11 diffs)

trunk/src/bp-activity/classes/class-bp-activity-query.php

@@ -7 +7 @@
  */
 
-// Exit if accessed directly
+// Exit if accessed directly.
 defined( 'ABSPATH' ) || exit;
 
@@ -57 +57 @@
          * @param array $query {
          *     Array of query clauses.
-         *
          *     @type array {
          *         @type string $column   Required. The column to query against. Basically, any DB column in the main
@@ -88 +87 @@
          * @param string $alias An existing table alias that is compatible with the current query clause.
          *                      Default: 'a'. BP_Activity_Activity::get() uses 'a', so we default to that.
-         *
          * @return string SQL fragment to append to the main WHERE clause.
          */
@@ -98 +96 @@
                 $sql = $this->get_sql_clauses();
 
-                // we only need the 'where' clause
+                // We only need the 'where' clause.
                 //
-                // also trim trailing "AND" clause from parent BP_Recursive_Query class
-                // since it's not necessary for our needs
+                // Also trim trailing "AND" clause from parent BP_Recursive_Query class
+                // since it's not necessary for our needs.
                 return preg_replace( '/^\sAND/', '', $sql['where'] );
         }
@@ -112 +110 @@
          * @param  array $clause       Array of arguments belonging to the clause.
          * @param  array $parent_query Parent query to which the clause belongs.
-         *
          * @return array {
          *     @type array $where Array of subclauses for the WHERE statement.
@@ -138 +135 @@
                 }
 
-                // default 'compare' to '=' if no valid operator is found
+                // Default 'compare' to '=' if no valid operator is found.
                 if ( ! in_array( $clause['compare'], array(
                         '=', '!=', '>', '>=', '<', '<=',
@@ -156 +153 @@
                 $where = '';
 
-                // value.
+                // Value.
                 if ( isset( $clause['value'] ) ) {
                         if ( in_array( $compare, array( 'IN', 'NOT IN', 'BETWEEN', 'NOT BETWEEN' ) ) ) {
@@ -164 +161 @@
                         }
 
-                        // tinyint
+                        // Tinyint.
                         if ( ! empty( $column ) && true === in_array( $column, array( 'hide_sitewide', 'is_spam' ) ) ) {
                                 $sql_chunks['where'][] = $wpdb->prepare( "{$alias}{$column} = %d", $value );
@@ -170 +167 @@
                         } else {
                                 switch ( $compare ) {
-                                        // IN uses different syntax
+                                        // IN uses different syntax.
                                         case 'IN' :
                                         case 'NOT IN' :
@@ -223 +220 @@
          *
          * @param array $query Clause to check.
-         *
          * @return bool
          */
@@ -239 +235 @@
          *
          * @param string $column The user-supplied column name.
-         *
          * @return string A validated column name value.
          */