Skip to:
Content

BuddyPress.org


Ignore:
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:
1 edited

Legend:

Unmodified
Added
Removed

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

    r10142 r10163  
    11<?php
    22/**
    3  * BuddyPress XProfile Classes
     3 * BuddyPress XProfile Classes.
    44 *
    55 * @package BuddyPress
    … …  
    77 */
    88
    9 // Exit if accessed directly
     9// Exit if accessed directly.
    1010defined( 'ABSPATH' ) || exit;
    1111
    … …  
    1616 */
    1717class BP_XProfile_Query {
     18
    1819    /**
    1920     * Array of xprofile queries.
    … …  
    9697     * @access public
    9798     *
    98      * @param  array $queries Array of query clauses.
     99     * @param array $queries Array of query clauses.
     100     *
    99101     * @return array Sanitized array of query clauses.
    100102     */
    … …  
    164166     *
    165167     * @param  array $query XProfile query arguments.
     168     *
    166169     * @return bool  Whether the query clause is a first-order clause.
    167170     */
    … …  
    176179     * @access public
    177180     *
    178      * @param  string $type MySQL type to cast `value`.
     181     * @param string $type MySQL type to cast `value`.
     182     *
    179183     * @return string MySQL type.
    180184     */
    … …  
    238242     * @param  array $query Query to parse.
    239243     * @param  int   $depth Optional. Number of tree levels deep we currently are. Used to calculate indentation.
     244     *
    240245     * @return array {
    241246     *     Array containing JOIN and WHERE SQL clauses to append to a single query array.
    … …  
    319324     * @param string $primary_table     Database table where the object being filtered is stored (eg wp_users).
    320325     * @param string $primary_id_column ID column for the filtered object in $primary_table.
     326     *
    321327     * @return array {
    322328     *     Array containing JOIN and WHERE SQL clauses to append to the main query.
    … …  
    354360     * @param array $clause       Query clause.
    355361     * @param array $parent_query Parent query array.
     362     *
    356363     * @return array {
    357364     *     Array containing JOIN and WHERE SQL clauses to append to a first-order query.
    … …  
    422429        $where = '';
    423430
    424         // field_id.
     431        // Field_id.
    425432        if ( array_key_exists( 'field', $clause ) ) {
    426433            // Convert field name to ID if necessary.
    … …  
    437444        }
    438445
    439         // value.
     446        // Value.
    440447        if ( array_key_exists( 'value', $clause ) ) {
    441448            $field_value = $clause['value'];
    … …  
    502509     * @access protected
    503510     *
    504      * @param  array       $clause       Query clause.
    505      * @param  array       $parent_query Parent query of $clause.
     511     * @param array $clause       Query clause.
     512     * @param array $parent_query Parent query of $clause.
     513     *
    506514     * @return string|bool Table alias if found, otherwise false.
    507515     */
Note: See TracChangeset for help on using the changeset viewer.