Entities repository contains methods for fetching entities from database or performing calculations on entity properties. More...

Inheritance diagram for Elgg\Database\Entities:

Public Member Functions
	count ()
	{Count rows. Returns int } More...

	calculate ($function, $property, $property_type=null)
	Performs a mathematical calculation on a set of entity properties. More...

	get ($limit=null, $offset=null, $callback=null)
	Fetch entities. More...

	getDates ()
	Returns a list of months in which entities were updated or created. More...

	execute ()
	Execute the query resolving calculation, count and/or batch options. More...

Public Member Functions inherited from Elgg\Database\Repository
	__construct (array $options=[])
	Constructor. More...

	__get ($name)
	{} More...

	__set ($name, $value)
	{} More...

	__unset ($name)
	{} More...

	__isset ($name)
	{} More...

	batch ($limit=null, $offset=null, $callback=null)
	Fetch rows as an ElggBatch. More...

	filter (\Closure $closure)
	Filter query prior to execution Callback function will receive QueryBuilder as the first argument and table alias as a second Callback function can either mutate the instance of the QueryBuilder or return a composition expression that will be appended to AND where statements. More...

	select ($expression)
	Add SELECT. More...

	join ($joined_table, $joined_alias=null, $join_column=null, $comparison=null, $values=null, $type=null, $case_sensitive=null)
	Add JOIN clause Join a database table on an $x to $y comparison. More...

	groupBy ($expression)
	Add GROUP BY. More...

	having ($expression)
	Add HAVING. More...

	orderBy ($expression, $direction)
	Add ORDER BY. More...

	expandInto (QueryBuilder $qb, $table_alias=null)
	Extend query builder with select, group_by, having and order_by clauses from $options. More...

Protected Member Functions
	buildQuery (QueryBuilder $qb)
	Build a database query. More...

	buildEntityClause (QueryBuilder $qb)
	Process entity attribute wheres Applies entity attribute constrains on the selected entities table. More...

	buildPairedMetadataClause (QueryBuilder $qb, $clauses, $boolean='AND')
	Process metadata name value pairs Joins the metadata table on entity guid in the entities table and applies metadata where clauses. More...

	buildPairedAnnotationClause (QueryBuilder $qb, $clauses, $boolean='AND')
	Process annotation name value pairs Joins the annotation table on entity guid in the entities table and applies annotation where clauses. More...

	buildPairedRelationshipClause (QueryBuilder $qb, $clauses, $boolean='AND')
	Process relationship pairs. More...

Additional Inherited Members
Static Public Member Functions inherited from Elgg\Database\Repository
static	with (array $options=[])
	Constructs a new. More...

static	find (array $options=[])
	Build and execute a new query from an array of legacy options. More...

Protected Attributes inherited from Elgg\Database\Repository
QueryOptions	$options

Detailed Description

Entities repository contains methods for fetching entities from database or performing calculations on entity properties.

Definition at line 19 of file Entities.php.

Member Function Documentation

◆ buildEntityClause()

Elgg\Database\Entities::buildEntityClause ( QueryBuilder $qb )

protected

Process entity attribute wheres Applies entity attribute constrains on the selected entities table.

Parameters

QueryBuilder $qb Query builder

Returns: \Closure|CompositeExpression|mixed|null|string

Definition at line 249 of file Entities.php.

◆ buildPairedAnnotationClause()

Elgg\Database\Entities::buildPairedAnnotationClause	(	QueryBuilder	$qb,
			$clauses,
			$boolean = `'AND'`
	)

protected

Process annotation name value pairs Joins the annotation table on entity guid in the entities table and applies annotation where clauses.

Parameters

QueryBuilder	$qb	Query builder
AnnotationWhereClause[]	$clauses	Where clauses
string	$boolean	Merge boolean

Returns: CompositeExpression|string

Definition at line 291 of file Entities.php.

◆ buildPairedMetadataClause()

Elgg\Database\Entities::buildPairedMetadataClause	(	QueryBuilder	$qb,
			$clauses,
			$boolean = `'AND'`
	)

protected

Process metadata name value pairs Joins the metadata table on entity guid in the entities table and applies metadata where clauses.

Parameters

QueryBuilder	$qb	Query builder
MetadataWhereClause[]	$clauses	Where clauses
string	$boolean	Merge boolean

Returns: CompositeExpression|string

Definition at line 263 of file Entities.php.

◆ buildPairedRelationshipClause()

Elgg\Database\Entities::buildPairedRelationshipClause	(	QueryBuilder	$qb,
			$clauses,
			$boolean = `'AND'`
	)

protected

Process relationship pairs.

Parameters

QueryBuilder	$qb	Query builder
RelationshipWhereClause[]	$clauses	Where clauses
string	$boolean	Merge boolean

Returns: CompositeExpression|string

Definition at line 316 of file Entities.php.

◆ buildQuery()

Elgg\Database\Entities::buildQuery ( QueryBuilder $qb )

protected

Build a database query.

Parameters

QueryBuilder $qb the Elgg QueryBuilder

Returns: QueryBuilder

Definition at line 215 of file Entities.php.

◆ calculate()

Elgg\Database\Entities::calculate	(	$function,
		$property,
		$property_type = `null`
	)

Performs a mathematical calculation on a set of entity properties.

Parameters

string	$function	Valid numeric function
string	$property	Property name
string	$property_type	'attribute'\|'metadata'\|'annotation'

Returns: string

Exceptions

DomainException

Reimplemented from Elgg\Database\Repository.

Definition at line 51 of file Entities.php.

◆ count()

Elgg\Database\Entities::count ( )

{Count rows.

Returns: int

}

Reimplemented from Elgg\Database\Repository.

Definition at line 24 of file Entities.php.

◆ execute()

Elgg\Database\Entities::execute ( )

Execute the query resolving calculation, count and/or batch options.

Returns: array|\ElggData[]|\ElggEntity[]|int|\ElggBatch

Exceptions

LogicException

Reimplemented from Elgg\Database\Repository.

Definition at line 180 of file Entities.php.

◆ get()

Elgg\Database\Entities::get	(	$limit = `null`,
		$offset = `null`,
		$callback = `null`
	)

Fetch entities.

Parameters

int	$limit	Limit
int	$offset	Offset
callable	$callback	Custom callback

Returns: \ElggEntity[]

Reimplemented from Elgg\Database\Repository.

Definition at line 103 of file Entities.php.

◆ getDates()

Elgg\Database\Entities::getDates ( )

Returns a list of months in which entities were updated or created.

@tip Use this to generate a list of archives by month for when entities were added or updated.

Warning: Months are returned in the form YYYYMM.

Returns: array An array months as YYYYMM

Definition at line 149 of file Entities.php.

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

engine/classes/Elgg/Database/Entities.php

Public Member Functions

Protected Member Functions

Additional Inherited Members

Detailed Description

Member Function Documentation

◆ buildEntityClause()

◆ buildPairedAnnotationClause()

◆ buildPairedMetadataClause()

◆ buildPairedRelationshipClause()

◆ buildQuery()

◆ calculate()

◆ count()

◆ execute()

◆ get()

◆ getDates()