Elgg  Version 3.0
Public Member Functions | Static Public Member Functions | Protected Member Functions | List of all members
Elgg\Database\River Class Reference

River repository contains methods for fetching/counting river items. More...

Inheritance diagram for Elgg\Database\River:
Elgg\Database\Repository Elgg\Database\QueryExecuting

Public Member Functions

 __construct (array $options=[])
 {} More...
 
 count ()
 {Count rows.
Returns
int
} More...
 
 calculate ($function, $property, $property_type= 'annotation')
 Performs a mathematical calculation on river annotations. More...
 
 get ($limit=null, $offset=null, $callback=null)
 Fetch river items. More...
 
 execute ()
 Execute the query resolving calculation, count and/or batch options. More...
 
 buildEntityClauses ($qb)
 Add subject, object and target clauses Make sure all three are accessible by the user. 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.
Parameters
int$limitNumber of rows to fetch
int$offsetIndex of the first row
callable | false$callbackCallback function to run database rows through
Returns
ElggBatch
} More...
 
 filter (\Closure $closure)
 {} More...
 
 select ($expression)
 {Add SELECT.
Parameters
mixed$expressionSelect
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_tableName of the table (with or without dbprefix)
string$joined_aliasAlias of the joined table If not set, the alias will be assigned automatically
string$xBase column, e.g. 'n_table.entity_guid' This value is NOT a query parameter and will not be sanitized
string$comparisonComparison operator, e.g. '=', 'not like' etc
mixed$yComparison value(s)
string$typeType of the comparison value(s), e.g. ELGG_VALUE_STRING, ELGG_VALUE_INT
bool$case_sensitiveUse case senstivie comparison for string values
Returns
static
} More...
 
 groupBy ($expression)
 {Add GROUP BY.
Parameters
string$expressionGroup by
Returns
static
} More...
 
 having ($expression)
 {Add HAVING.
Parameters
string$expressionHaving
Returns
static
} More...
 
 orderBy ($expression, $direction)
 {Add ORDER BY.
Parameters
string$expressionColumn/calculation
string$directionDirection
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
 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 find (array $options=[])
 Build and execute a new query from an array of legacy options. More...
 
- 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 Member Functions

 buildQuery (QueryBuilder $qb)
 Build a database query. More...
 
 buildRiverClause (QueryBuilder $qb)
 Process river properties. 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

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

Detailed Description

River repository contains methods for fetching/counting river items.

API IN FLUX Do not access the methods directly, use elgg_get_river() instead

Definition at line 22 of file River.php.

Constructor & Destructor Documentation

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

{}

Definition at line 27 of file River.php.

Member Function Documentation

Elgg\Database\River::buildEntityClauses (   $qb)

Add subject, object and target clauses Make sure all three are accessible by the user.

Parameters
QueryBuilder$qbQuery builder
Returns
CompositeExpression|mixed|null|string

Definition at line 276 of file River.php.

Elgg\Database\River::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$qbQuery builder
AnnotationWhereClause[]$clauses Where clauses
string$booleanMerge boolean
Returns
CompositeExpression|string

Definition at line 321 of file River.php.

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

Process relationship pairs.

Parameters
QueryBuilder$qbQuery builder
RelationshipWhereClause[]$clauses Where clauses
string$booleanMerge boolean
Returns
CompositeExpression|string

Definition at line 359 of file River.php.

Elgg\Database\River::buildQuery ( QueryBuilder  $qb)
protected

Build a database query.

Parameters
QueryBuilder$qb
Returns
QueryBuilder

Definition at line 221 of file River.php.

Elgg\Database\River::buildRiverClause ( QueryBuilder  $qb)
protected

Process river properties.

Parameters
QueryBuilder$qbQuery builder
Returns
CompositeExpression|mixed|null|string

Definition at line 254 of file River.php.

Elgg\Database\River::calculate (   $function,
  $property,
  $property_type = 'annotation' 
)

Performs a mathematical calculation on river annotations.

Parameters
string$functionValid numeric function
string$propertyProperty name
string$property_type'annotation'
Returns
int|float
Exceptions
InvalidParameterException

Implements Elgg\Database\QueryExecuting.

Definition at line 101 of file River.php.

Elgg\Database\River::count ( )

{Count rows.

Returns
int
}

Implements Elgg\Database\QueryExecuting.

Definition at line 74 of file River.php.

Elgg\Database\River::execute ( )

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

Returns
array|[]|ElggEntity[]|false|int
Exceptions

Implements Elgg\Database\QueryExecuting.

Definition at line 194 of file River.php.

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

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

Parameters
array$optionsOptions
Returns
ElggRiverItem[]|int|mixed

Definition at line 67 of file River.php.

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

Fetch river items.

Parameters
int$limitLimit
int$offsetOffset
callable$callbackCustom callback
Returns
ElggEntity[]
Exceptions

Implements Elgg\Database\QueryExecuting.

Definition at line 142 of file River.php.


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