Elgg  Version 4.x
Public Member Functions | Protected Member Functions | List of all members
Elgg\Database\Clauses\Clause Class Reference

Interface that allows resolving statements and/or extending query builder. More...

Inheritance diagram for Elgg\Database\Clauses\Clause:
Elgg\Database\Clauses\ComparisonClause Elgg\Database\Clauses\GroupByClause Elgg\Database\Clauses\HavingClause Elgg\Database\Clauses\JoinClause Elgg\Database\Clauses\OrderByClause Elgg\Database\Clauses\SelectClause Elgg\Database\Clauses\WhereClause Elgg\Database\Clauses\EntitySortByClause Elgg\Database\Clauses\AccessWhereClause Elgg\Database\Clauses\AnnotationWhereClause Elgg\Database\Clauses\AttributeWhereClause Elgg\Database\Clauses\EntityWhereClause Elgg\Database\Clauses\MetadataWhereClause Elgg\Database\Clauses\PrivateSettingWhereClause Elgg\Database\Clauses\RelationshipWhereClause Elgg\Database\Clauses\RiverWhereClause Elgg\Database\Clauses\TypeSubtypeWhereClause

Public Member Functions

 prepare (QueryBuilder $qb, $table_alias=null)
 Build an expression and/or apply it to an instance of query builder. More...
 

Protected Member Functions

 isCallable ($callback)
 Check if a clause expression is callable. More...
 
 call ($callback, QueryBuilder $qb, $table_alias=null)
 Call the expression for the clause. More...
 
 callJoin ($callback, QueryBuilder $qb, $joined_alias, $table_alias=null)
 Call the expression for a join clause. More...
 

Detailed Description

Interface that allows resolving statements and/or extending query builder.

Definition at line 14 of file Clause.php.

Member Function Documentation

Elgg\Database\Clauses\Clause::call (   $callback,
QueryBuilder  $qb,
  $table_alias = null 
)
protected

Call the expression for the clause.

Parameters
mixed$callbackthe clause callable expression
QueryBuilder$qbthe current query builder
string$table_aliasthe main table alias
Returns
false|mixed

Definition at line 48 of file Clause.php.

Elgg\Database\Clauses\Clause::callJoin (   $callback,
QueryBuilder  $qb,
  $joined_alias,
  $table_alias = null 
)
protected

Call the expression for a join clause.

Parameters
mixed$callbackthe clause callable expression
QueryBuilder$qbthe current query builder
string$joined_aliasthe joined table alias
string$table_aliasthe main table alias
Returns
false|mixed

Definition at line 72 of file Clause.php.

Elgg\Database\Clauses\Clause::isCallable (   $callback)
protected

Check if a clause expression is callable.

Parameters
mixed$callbackthe clause callable expression
Returns
bool

Definition at line 35 of file Clause.php.

Elgg\Database\Clauses\Clause::prepare ( QueryBuilder  $qb,
  $table_alias = null 
)
abstract

Build an expression and/or apply it to an instance of query builder.

Parameters
QueryBuilder$qbQuery builder
string$table_aliasTable alias
Returns
CompositeExpression|null|string

The documentation for this class was generated from the following file: