Abstract methods for interfacing with the database. More...

Inheritance diagram for Elgg\Database\Repository:

Public Member Functions
	__construct (array $options=[])
	Constructor. More...

	__get ($name)
	{} More...

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

	__unset ($name)
	{} More...

	__isset ($name)
	{} More...

	count ()
	Count rows. More...

	calculate ($function, $property, $property_type=null)
	Apply numeric calculation to a column. More...

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

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

	execute ()
	Apply correct execution method based on calculation, count or other criteria. 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...

Static Public Member Functions
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
QueryOptions	$options

Detailed Description

Abstract methods for interfacing with the database.

Definition at line 15 of file Repository.php.

Constructor & Destructor Documentation

◆ __construct()

Elgg\Database\Repository::__construct ( array $options = [] )

Constructor.

Parameters

array $options ege* options

Reimplemented in Elgg\Database\River.

Definition at line 24 of file Repository.php.

Member Function Documentation

◆ __get()

Elgg\Database\Repository::__get ( $name )

{}

Definition at line 31 of file Repository.php.

◆ __isset()

Elgg\Database\Repository::__isset ( $name )

{}

Definition at line 56 of file Repository.php.

◆ __set()

Elgg\Database\Repository::__set	(	$name,
		$value
	)

{}

Definition at line 42 of file Repository.php.

◆ __unset()

Elgg\Database\Repository::__unset ( $name )

{}

Definition at line 49 of file Repository.php.

◆ batch()

Elgg\Database\Repository::batch	(	$limit = `null`,
		$offset = `null`,
		$callback = `null`
	)

Fetch rows as an ElggBatch.

Parameters

int	$limit	Number of rows to fetch
int	$offset	Index of the first row
callable \| false	$callback	Callback function to run database rows through

Returns: \ElggBatch

Definition at line 120 of file Repository.php.

◆ calculate()

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

abstract

Apply numeric calculation to a column.

Parameters

string	$function	Calculation, e.g. max, min, avg
string	$property	Property name
string	$property_type	Property type

Returns: int|float

Reimplemented in Elgg\Database\Relationships, Elgg\Database\Metadata, Elgg\Database\Entities, Elgg\Database\Annotations, and Elgg\Database\River.

◆ count()

Elgg\Database\Repository::count ( )

abstract

Count rows.

Returns: int

Reimplemented in Elgg\Database\River, Elgg\Database\Relationships, Elgg\Database\Metadata, Elgg\Database\Entities, and Elgg\Database\Annotations.

◆ execute()

Elgg\Database\Repository::execute ( )

abstract

Apply correct execution method based on calculation, count or other criteria.

Returns: mixed

Reimplemented in Elgg\Database\River, Elgg\Database\Relationships, Elgg\Database\Metadata, Elgg\Database\Entities, and Elgg\Database\Annotations.

◆ expandInto()

Elgg\Database\Repository::expandInto	(	QueryBuilder	$qb,
			$table_alias = `null`
	)

Extend query builder with select, group_by, having and order_by clauses from $options.

Parameters

QueryBuilder	$qb	Query builder
string	$table_alias	Table alias

Returns: void

Definition at line 247 of file Repository.php.

◆ filter()

Elgg\Database\Repository::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.

Parameters

\Closure $closure Filter

Returns: static

Definition at line 155 of file Repository.php.

◆ find()

static Elgg\Database\Repository::find ( array $options = [] )

static

Build and execute a new query from an array of legacy options.

Parameters

array $options Options

Returns: \ElggData[]|int|mixed

Reimplemented in Elgg\Database\River.

Definition at line 107 of file Repository.php.

◆ get()

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

abstract

Fetch rows.

Parameters

int	$limit	Number of rows to fetch
int	$offset	Index of the first row
callable \| false	$callback	Callback function to run database rows through

Returns: \ElggData[]|false

Reimplemented in Elgg\Database\River, Elgg\Database\Relationships, Elgg\Database\Metadata, Elgg\Database\Entities, and Elgg\Database\Annotations.

◆ groupBy()

Elgg\Database\Repository::groupBy ( $expression )

Add GROUP BY.

Parameters

string $expression Group by

Returns: static

Definition at line 206 of file Repository.php.

◆ having()

Elgg\Database\Repository::having ( $expression )

Add HAVING.

Parameters

string $expression Having

Returns: static

Definition at line 219 of file Repository.php.

◆ join()

Elgg\Database\Repository::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.

Parameters

string	$joined_table	Name of the table (with or without dbprefix)
string	$joined_alias	Alias of the joined table If not set, the alias will be assigned automatically
string	$join_column	Base column, e.g. 'n_table.entity_guid' This value is NOT a query parameter and will not be sanitized
string	$comparison	Comparison operator, e.g. '=', 'not like' etc
mixed	$values	Comparison value(s)
string	$type	Type of the comparison value(s), e.g. ELGG_VALUE_STRING, ELGG_VALUE_INT
bool	$case_sensitive	Use case sensitive comparison for string values

Returns: static

Definition at line 190 of file Repository.php.

◆ orderBy()

Elgg\Database\Repository::orderBy	(	$expression,
		$direction
	)

Add ORDER BY.

Parameters

string	$expression	Column/calculation
string	$direction	Direction

Returns: static

Definition at line 233 of file Repository.php.

◆ select()

Elgg\Database\Repository::select ( $expression )

Add SELECT.

Parameters

mixed $expression Select

Returns: static

Definition at line 168 of file Repository.php.

◆ with()

static Elgg\Database\Repository::with ( array $options = [] )

static

Constructs a new.

Parameters

array $options ege* options

Returns: static

Definition at line 67 of file Repository.php.

Member Data Documentation

◆ $options

QueryOptions Elgg\Database\Repository::$options

protected

Definition at line 17 of file Repository.php.

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

engine/classes/Elgg/Database/Repository.php

Public Member Functions

Static Public Member Functions

Protected Attributes

Detailed Description

Constructor & Destructor Documentation

◆ __construct()

Member Function Documentation

◆ __get()

◆ __isset()

◆ __set()

◆ __unset()

◆ batch()

◆ calculate()

◆ count()

◆ execute()

◆ expandInto()

◆ filter()

◆ find()

◆ get()

◆ groupBy()

◆ having()

◆ join()

◆ orderBy()

◆ select()

◆ with()

Member Data Documentation

◆ $options