The Elgg database. More...

Public Member Functions
	__construct (DbConfig $config, QueryCache $query_cache)
	Constructor. More...

	resetConnections (DbConfig $config)
	Reset the connections with new credentials. More...

	getConnection ($type)
	Gets (if required, also creates) a DB connection. More...

	setupConnections ()
	Establish database connections. More...

	connect ($type="readwrite")
	Establish a connection to the database server. More...

	getData ($query, $callback=null, array $params=[])
	Retrieve rows from the database. More...

	getDataRow ($query, $callback=null, array $params=[])
	Retrieve a single row from the database. More...

	insertData ($query, array $params=[])
	Insert a row into the database. More...

	updateData ($query, $get_num_rows=false, array $params=[])
	Update the database. More...

	deleteData ($query, array $params=[])
	Delete data from the database. More...

	trackQuery ($query, array $params, callable $callback)
	Tracks the query count and timers for a given query. More...

	runSqlScript ($scriptlocation)
	Runs a full database script from disk. More...

	registerDelayedQuery ($query, $type, $callback=null, array $params=[])
	Queue a query for execution upon shutdown. More...

	executeDelayedQueries ()
	Trigger all queries that were registered as "delayed" queries. More...

	enableQueryCache ()
	Enable the query cache. More...

	disableQueryCache ()
	Disable the query cache. More...

	getQueryCount ()
	Get the number of queries made to the database. More...

	sanitizeInt ($value, $signed=true)
	Sanitizes an integer value for use in a query. More...

	sanitizeString ($value)
	Sanitizes a string for use in a query. More...

	getServerVersion ($type)
	Get the server version number. More...

	__get ($name)
	Handle magic property reads. More...

	__set ($name, $value)
	Handle magic property writes. More...

Public Attributes
const	DELAYED_QUERY = 'q'

const	DELAYED_TYPE = 't'

const	DELAYED_HANDLER = 'h'

const	DELAYED_PARAMS = 'p'

Protected Member Functions
	fingerprintCallback ($callback)
	Get a string that uniquely identifies a callback during the current request. More...

	getResults ($query, $callback=null, $single=false, array $params=[])
	Handles queries that return results, running the results through a an optional callback function. More...

	executeQuery ($query, Connection $connection, array $params=[])
	Execute a query. More...

Protected Attributes
	$query_cache

	$delayed_queries = []

Detailed Description

The Elgg database.

Definition at line 21 of file Database.php.

Constructor & Destructor Documentation

Elgg\Database::__construct	(	DbConfig	$config,
		QueryCache	$query_cache
	)

Constructor.

Parameters

DbConfig	$config	DB configuration
QueryCache	$query_cache	Query Cache

Definition at line 72 of file Database.php.

Member Function Documentation

Elgg\Database::__get ( $name )

Handle magic property reads.

Parameters

string $name Property name

Returns: mixed

Definition at line 715 of file Database.php.

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

Handle magic property writes.

Parameters

string	$name	Property name
mixed	$value	Value

Returns: void

Definition at line 730 of file Database.php.

Elgg\Database::connect ( $type = "readwrite" )

Establish a connection to the database server.

Connect to the database server and use the Elgg database for a particular database link

Parameters

string $type The type of database connection. "read", "write", or "readwrite".

Returns: void

Exceptions

Definition at line 141 of file Database.php.

Elgg\Database::deleteData	(		$query,
		array	$params = `[]`
	)

Delete data from the database.

Note: Altering the DB invalidates all queries in query cache.

Parameters

QueryBuilder \| string	$query	The SQL query to run
array	$params	Query params. E.g. [1, 'steve'] or [':id' => 1, ':name' => 'steve']

Returns: int The number of affected rows

Exceptions

Definition at line 290 of file Database.php.

Elgg\Database::disableQueryCache ( )

Disable the query cache.

This is useful for special scripts that pull large amounts of data back in single queries.

Returns: void

Definition at line 641 of file Database.php.

Elgg\Database::enableQueryCache ( )

Enable the query cache.

This does not take precedence over the setting.

Returns: void

Definition at line 629 of file Database.php.

Elgg\Database::executeDelayedQueries ( )

Trigger all queries that were registered as "delayed" queries.

This is called by the system automatically on shutdown.

Returns: void

Definition at line 597 of file Database.php.

Elgg\Database::executeQuery	(		$query,
		Connection	$connection,
		array	$params = `[]`
	)

protected

Execute a query.

$query is executed via Connection::query. If there is an SQL error, a DatabaseException is thrown.

Parameters

QueryBuilder \| string	$query	The query
Connection	$connection	The DB connection
array	$params	Query params. E.g. [1, 'steve'] or [':id' => 1, ':name' => 'steve']

Returns: Statement|int The result of the query

Exceptions

Definition at line 422 of file Database.php.

Elgg\Database::fingerprintCallback ( $callback )

protected

Get a string that uniquely identifies a callback during the current request.

This is used to cache queries whose results were transformed by the callback. If the callback involves object method calls of the same class, different instances will return different values.

Parameters

callable $callback The callable value to fingerprint

Returns: string A string that is unique for each callable passed in

Since: 1.9.4

Definition at line 320 of file Database.php.

Elgg\Database::getConnection ( $type )

Gets (if required, also creates) a DB connection.

Parameters

string $type The type of link we want: "read", "write" or "readwrite".

Returns: Connection

Exceptions

Definition at line 102 of file Database.php.

Elgg\Database::getData	(		$query,
			$callback = `null`,
		array	$params = `[]`
	)

Retrieve rows from the database.

Queries are executed with Elgg\Database::executeQuery()andresultsareretrievedwith@link\PDO::fetchObject().Ifacallbackfunction$callbackisdefined,eachrowwillbepassedasasingleargumentto$callback.Ifnocallbackfunctionisdefined,theentireresultsetisreturnedasanarray.@paramQueryBuilder|string$queryThequerybeingpassed.@paramcallable$callbackOptionally,thenameofafunctiontocallbacktooneachrow@paramarray$paramsQueryparams.E.g.[1,'steve']or[':id'=>1,':name'=>'steve']@returnarrayAnarrayofdatabaseresultobjectsorcallbackfunctionresults.Ifthequeryreturnednothing,anemptyarray.@throws\DatabaseException

Definition at line 191 of file Database.php.

Elgg\Database::getDataRow	(		$query,
			$callback = `null`,
		array	$params = `[]`
	)

Retrieve a single row from the database.

Similar to Elgg\Database::getData()butreturnsonlythefirstrowmatched.Ifacallbackfunction$callbackisspecified,therowwillbepassedastheonlyargumentto$callback.@paramQueryBuilder|string$queryThequerytoexecute.@paramcallable$callbackAcallbackfunctiontoapplytotherow@paramarray$paramsQueryparams.E.g.[1,'steve']or[':id'=>1,':name'=>'steve']@returnmixedAsingledatabaseresultobjectortheresultofthecallbackfunction.@throws\DatabaseException

Definition at line 209 of file Database.php.

Elgg\Database::getQueryCount ( )

Get the number of queries made to the database.

Returns: int

Definition at line 650 of file Database.php.

Elgg\Database::getResults	(		$query,
			$callback = `null`,
			$single = `false`,
		array	$params = `[]`
	)

protected

Handles queries that return results, running the results through a an optional callback function.

This is for R queries (from CRUD).

Parameters

QueryBuilder \| string	$query	The select query to execute
callable	$callback	An optional callback function to run on each row
bool	$single	Return only a single result?
array	$params	Query params. E.g. [1, 'steve'] or [':id' => 1, ':name' => 'steve']

Returns: array An array of database result objects or callback function results. If the query returned nothing, an empty array.

Exceptions

Definition at line 350 of file Database.php.

Elgg\Database::getServerVersion ( $type )

Get the server version number.

Parameters

string $type Connection type (Config constants, e.g. Config::READ_WRITE)

Returns: string Empty if version cannot be determined

Definition at line 700 of file Database.php.

Elgg\Database::insertData	(		$query,
		array	$params = `[]`
	)

Insert a row into the database.

Note: Altering the DB invalidates all queries in the query cache.

Parameters

QueryBuilder \| string	$query	The query to execute.
array	$params	Query params. E.g. [1, 'steve'] or [':id' => 1, ':name' => 'steve']

Returns: int|false The database id of the inserted row if a AUTO_INCREMENT field is defined, 0 if not, and false on failure.

Exceptions

Definition at line 225 of file Database.php.

Elgg\Database::registerDelayedQuery	(		$query,
			$type,
			$callback = `null`,
		array	$params = `[]`
	)

Queue a query for execution upon shutdown.

You can specify a callback if you care about the result. This function will always be passed a .

Parameters

string	$query	The query to execute
string	$type	The query type ('read' or 'write')
callable	$callback	A callback function to pass the results array to
array	$params	Query params. E.g. [1, 'steve'] or [':id' => 1, ':name' => 'steve']

Returns: boolean Whether registering was successful

Definition at line 575 of file Database.php.

Elgg\Database::resetConnections ( DbConfig $config )

Reset the connections with new credentials.

Parameters

DbConfig $config DB config

Returns: void

Definition at line 85 of file Database.php.

Elgg\Database::runSqlScript ( $scriptlocation )

Runs a full database script from disk.

The file specified should be a standard SQL file as created by mysqldump or similar. Statements must be terminated with ; and a newline character (
or
).

The special string 'prefix_' is replaced with the database prefix as defined in ->tablePrefix.

Warning: Only single line comments are supported. A comment must start with '– ' or '# ', where the comment sign is at the very beginning of each line.; Errors do not halt execution of the script. If a line generates an error, the error message is saved and the next line is executed. After the file is run, any errors are displayed as a DatabaseException

Parameters

string $scriptlocation The full path to the script

Returns: void

Exceptions

Definition at line 525 of file Database.php.

Elgg\Database::sanitizeInt	(	$value,
		$signed = `true`
	)

Sanitizes an integer value for use in a query.

Parameters

int	$value	Value to sanitize
bool	$signed	Whether negative values are allowed (default: true)

Returns: int

Definition at line 662 of file Database.php.

Elgg\Database::sanitizeString ( $value )

Sanitizes a string for use in a query.

Parameters

string $value Value to escape

Returns: string

Exceptions

Definition at line 682 of file Database.php.

Elgg\Database::setupConnections ( )

Establish database connections.

If the configuration has been set up for multiple read/write databases, set those links up separately; otherwise just create the one database link.

Returns: void

Exceptions

Definition at line 122 of file Database.php.

Elgg\Database::trackQuery	(		$query,
		array	$params,
		callable	$callback
	)

Tracks the query count and timers for a given query.

Parameters

QueryBuilder \| string	$query	The query
array	$params	Optional query params
callable	$callback	Callback to execyte during query execution

Returns: mixed

Definition at line 466 of file Database.php.

Elgg\Database::updateData	(		$query,
			$get_num_rows = `false`,
		array	$params = `[]`
	)

Update the database.

Note: Altering the DB invalidates all queries in the query cache.; WARNING! update_data() has the 2nd and 3rd arguments reversed.

Parameters

QueryBuilder \| string	$query	The query to run.
bool	$get_num_rows	Return the number of rows affected (default: false).
array	$params	Query params. E.g. [1, 'steve'] or [':id' => 1, ':name' => 'steve']

Returns: bool|int

Exceptions

Definition at line 258 of file Database.php.

Member Data Documentation

Elgg\Database::$delayed_queries = []

protected

Definition at line 59 of file Database.php.

Elgg\Database::$query_cache

protected

Definition at line 50 of file Database.php.

const Elgg\Database::DELAYED_HANDLER = 'h'

Definition at line 27 of file Database.php.

const Elgg\Database::DELAYED_PARAMS = 'p'

Definition at line 28 of file Database.php.

const Elgg\Database::DELAYED_QUERY = 'q'

Definition at line 25 of file Database.php.

const Elgg\Database::DELAYED_TYPE = 't'

Definition at line 26 of file Database.php.

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

engine/classes/Elgg/Database.php

Public Member Functions

Public Attributes

Protected Member Functions

Protected Attributes

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation