[ Index ]

PHP Cross Reference of BuddyPress

title

Body

[close]

/src/bp-activity/classes/ -> class-bp-activity-query.php (summary)

BuddyPress Activity Classes

File Size: 247 lines (7 kb)
Included or required:0 times
Referenced: 0 times
Includes or requires: 0 files

Defines 1 class

BP_Activity_Query:: (5 methods):
  __construct()
  get_sql()
  get_sql_for_clause()
  is_first_order_clause()
  validate_column()


Class: BP_Activity_Query  - X-Ref

Class for generating the WHERE SQL clause for advanced activity fetching.

This is notably used in {@link BP_Activity_Activity::get()} with the
'filter_query' parameter.

__construct( $query = array()   X-Ref
Constructor.

since: 2.2.0
param: array $query {

get_sql( $alias = 'a' )   X-Ref
Generates WHERE SQL clause to be appended to a main query.

since: 2.2.0
return: string SQL fragment to append to the main WHERE clause.
param: string $alias An existing table alias that is compatible with the current query clause.

get_sql_for_clause( $clause, $parent_query )   X-Ref
Generate WHERE clauses for a first-order clause.

since: 2.2.0
return: array {
param: array $clause       Array of arguments belonging to the clause.
param: array $parent_query Parent query to which the clause belongs.

is_first_order_clause( $query )   X-Ref
Determine whether a clause is first-order.

since: 2.2.0
return: bool
param: array $query Clause to check.

validate_column( $column = '' )   X-Ref
Validates a column name parameter.

Column names are checked against a whitelist of known tables.
See {@link BP_Activity_Query::db_tables}.

since: 2.2.0
return: string A validated column name value.
param: string $column The user-supplied column name.



Generated: Sat Sep 21 01:01:46 2019 Cross-referenced by PHPXref 0.7.1