Elgg\Database\Clauses\AnnotationWhereClause Class Reference

Builds queries for matching annotations against their properties. More...

Inheritance diagram for Elgg\Database\Clauses\AnnotationWhereClause:

Public Member Functions
	prepare (QueryBuilder $qb, $table_alias=null)
	{{Build an expression and/or apply it to an instance of query builder. Parameters QueryBuilder $qb Query builder string $table_alias Table alias Returns CompositeExpression|null|string }} More...
Public Member Functions inherited from Elgg\Database\Clauses\WhereClause
	__construct ($expr=null)
	Constructor. More...

Static Public Member Functions
static	factory (array $attributes)
	Build a new AnnotationWhereClause. More...

Public Attributes
	$ids
	$entity_guids
	$owner_guids
	$access_ids
	$names
	$values
	$created_after
	$created_before
string	$comparison = '='
string	$value_type = ELGG_VALUE_STRING
bool	$case_sensitive = true
string	$sort_by_direction = null
string	$sort_by_calculation = null
bool	$ignore_access = null
int	$viewer_guid = null
Public Attributes inherited from Elgg\Database\Clauses\WhereClause
	$expr

Additional Inherited Members
Protected Member Functions inherited from Elgg\Database\Clauses\Clause
	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

Builds queries for matching annotations against their properties.

Definition at line 11 of file AnnotationWhereClause.php.

Member Function Documentation

factory()

static Elgg\Database\Clauses\AnnotationWhereClause::factory ( array  $attributes )

static

Build a new AnnotationWhereClause.

Parameters

array

$attributes

parameters for clause

Returns

static

Since

6.3

Definition at line 127 of file AnnotationWhereClause.php.

prepare()

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

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

Parameters

QueryBuilder	$qb	Query builder
string	$table_alias	Table alias

Returns

CompositeExpression|null|string

}}

Exceptions

DomainException

Reimplemented from Elgg\Database\Clauses\WhereClause.

Definition at line 71 of file AnnotationWhereClause.php.

Member Data Documentation

$access_ids

Elgg\Database\Clauses\AnnotationWhereClause::$access_ids

Definition at line 31 of file AnnotationWhereClause.php.

$case_sensitive

bool Elgg\Database\Clauses\AnnotationWhereClause::$case_sensitive = true

Definition at line 57 of file AnnotationWhereClause.php.

$comparison

string Elgg\Database\Clauses\AnnotationWhereClause::$comparison = '='

Definition at line 53 of file AnnotationWhereClause.php.

$created_after

Elgg\Database\Clauses\AnnotationWhereClause::$created_after

Definition at line 46 of file AnnotationWhereClause.php.

$created_before

Elgg\Database\Clauses\AnnotationWhereClause::$created_before

Definition at line 51 of file AnnotationWhereClause.php.

$entity_guids

Elgg\Database\Clauses\AnnotationWhereClause::$entity_guids

Definition at line 21 of file AnnotationWhereClause.php.

$ids

Elgg\Database\Clauses\AnnotationWhereClause::$ids

Definition at line 16 of file AnnotationWhereClause.php.

$ignore_access

bool Elgg\Database\Clauses\AnnotationWhereClause::$ignore_access = null

Definition at line 63 of file AnnotationWhereClause.php.

$names

Elgg\Database\Clauses\AnnotationWhereClause::$names

Definition at line 36 of file AnnotationWhereClause.php.

$owner_guids

Elgg\Database\Clauses\AnnotationWhereClause::$owner_guids

Definition at line 26 of file AnnotationWhereClause.php.

$sort_by_calculation

string Elgg\Database\Clauses\AnnotationWhereClause::$sort_by_calculation = null

Definition at line 61 of file AnnotationWhereClause.php.

$sort_by_direction

string Elgg\Database\Clauses\AnnotationWhereClause::$sort_by_direction = null

Definition at line 59 of file AnnotationWhereClause.php.

$value_type

string Elgg\Database\Clauses\AnnotationWhereClause::$value_type = ELGG_VALUE_STRING

Definition at line 55 of file AnnotationWhereClause.php.

$values

Elgg\Database\Clauses\AnnotationWhereClause::$values

Definition at line 41 of file AnnotationWhereClause.php.

$viewer_guid

int Elgg\Database\Clauses\AnnotationWhereClause::$viewer_guid = null

Definition at line 65 of file AnnotationWhereClause.php.

---

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

• engine/classes/Elgg/Database/Clauses/AnnotationWhereClause.php