Elgg\Database\Repository Class Reference

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...
	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 } More...
	filter (\Closure $closure)
	{} More...
	select ($expression)
	{Add SELECT. Parameters mixed $expression Select Returns static } More...
	join ($joined_table, $joined_alias=null, $x=null, $comparison=null, $y=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 $x 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 $y Comparison value(s) string $type Type of the comparison value(s), e.g. ELGG_VALUE_STRING, ELGG_VALUE_INT bool $case_sensitive Use case senstivie comparison for string values Returns static } More...
	groupBy ($expression)
	{Add GROUP BY. Parameters string $expression Group by Returns static } More...
	having ($expression)
	{Add HAVING. Parameters string $expression Having Returns static } More...
	orderBy ($expression, $direction)
	{Add ORDER BY. Parameters string $expression Column/calculation string $direction Direction Returns static } More...
	expandInto (QueryBuilder $qb, $table_alias=null)
	Extend query builder with select, group_by, having and order_by clauses from $options. More...
Public Member Functions inherited from Elgg\Database\QueryExecuting
	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...
	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...

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
	$options

Detailed Description

Abstract methods for interfacing with the database.

Definition at line 16 of file Repository.php.

Constructor & Destructor Documentation

Elgg\Database\Repository::__construct

(

array

$options = []

)

Constructor.

Parameters

array

$options

ege* options

Definition at line 28 of file Repository.php.

Member Function Documentation

Elgg\Database\Repository::__get

(

$name

)

{}

Definition at line 35 of file Repository.php.

Elgg\Database\Repository::__isset

(

$name

)

{}

Definition at line 62 of file Repository.php.

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

{}

Definition at line 48 of file Repository.php.

Elgg\Database\Repository::__unset

(

$name

)

{}

Definition at line 55 of file Repository.php.

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

}

Implements Elgg\Database\QueryExecuting.

Definition at line 97 of file Repository.php.

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 181 of file Repository.php.

Elgg\Database\Repository::filter

(

\Closure

$closure

)

{}

Definition at line 119 of file Repository.php.

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

[]|int|mixed

Definition at line 86 of file Repository.php.

Elgg\Database\Repository::groupBy

(

$expression

)

{Add GROUP BY.

Parameters

string

$expression

Group by

Returns

static

}

Implements Elgg\Database\QueryExecuting.

Definition at line 149 of file Repository.php.

Elgg\Database\Repository::having

(

$expression

)

{Add HAVING.

Parameters

string

$expression

Having

Returns

static

}

Implements Elgg\Database\QueryExecuting.

Definition at line 158 of file Repository.php.

Elgg\Database\Repository::join	(		$joined_table,
			$joined_alias = null,
			$x = null,
			$comparison = null,
			$y = 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	$x	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	$y	Comparison value(s)
string	$type	Type of the comparison value(s), e.g. ELGG_VALUE_STRING, ELGG_VALUE_INT
bool	$case_sensitive	Use case senstivie comparison for string values

Returns

static

}

Implements Elgg\Database\QueryExecuting.

Definition at line 137 of file Repository.php.

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

{Add ORDER BY.

Parameters

string	$expression	Column/calculation
string	$direction	Direction

Returns

static

}

Implements Elgg\Database\QueryExecuting.

Definition at line 167 of file Repository.php.

Elgg\Database\Repository::select

(

$expression

)

{Add SELECT.

Parameters

mixed

$expression

Select

Returns

static

}

Implements Elgg\Database\QueryExecuting.

Definition at line 128 of file Repository.php.

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

static

Constructs a new.

Parameters

array

$options

ege* options

Returns

static

Definition at line 73 of file Repository.php.

Member Data Documentation

Elgg\Database\Repository::$options

protected

Definition at line 21 of file Repository.php.

---

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

• engine/classes/Elgg/Database/Repository.php