Public Member Functions
	__construct (\Elgg\Database\Config $config,\Elgg\Logger $logger)
	Constructor. More...

	getLink ($type)
	Gets (if required, also creates) a database link resource. More...

	setupConnections ()
	Establish database connections. More...

	establishLink ($dblinkname="readwrite")
	Establish a connection to the database server. More...

	getData ($query, $callback= '')
	Retrieve rows from the database. More...

	getDataRow ($query, $callback= '')
	Retrieve a single row from the database. More...

	insertData ($query)
	Insert a row into the database. More...

	updateData ($query, $getNumRows=false)
	Update the database. More...

	deleteData ($query)
	Delete data from the database. More...

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

	executeQuery ($query, $dblink)
	Execute a query. More...

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

	registerDelayedQuery ($query, $type, $handler="")
	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...

	assertInstalled ()
	Test that the Elgg database is installed. More...

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

	getTablePrefix ()
	Get the prefix for Elgg's tables. 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...

Public Attributes
global	$ELGG_PLUGINS_PROVIDES_CACHE

global	$SUBTYPE_CACHE
	Cache subtypes and related class names. More...

	$SUBTYPE_CACHE = null

global	$USERNAME_TO_GUID_MAP_CACHE

	$USERNAME_TO_GUID_MAP_CACHE = array()

Protected Member Functions
	getResults ($query, $callback=null, $single=false)
	Handles queries that return results, running the results through a an optional callback function. More...

	invalidateQueryCache ()
	Invalidate the query cache. More...

Detailed Description

Definition at line 15 of file Database.php.

Constructor & Destructor Documentation

Elgg\Database::__construct	(	\Elgg\Database\Config	$config,
		\Elgg\Logger	$logger
	)

Constructor.

Parameters

\Elgg\Database\Config	$config	Database configuration
\Elgg\Logger	$logger	The logger

Definition at line 76 of file Database.php.

Member Function Documentation

Elgg\Database::assertInstalled ( )

Test that the Elgg database is installed.

Returns: void

Exceptions

Definition at line 582 of file Database.php.

Elgg\Database::deleteData ( $query )

Delete data from the database.

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

Parameters

string $query The SQL query to run

Returns: int|false The number of affected rows or false on failure

Exceptions

Definition at line 262 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 560 of file Database.php.

Elgg\Database::enableQueryCache ( )

Enable the query cache.

This does not take precedence over the setting.

Returns: void

Definition at line 545 of file Database.php.

Elgg\Database::establishLink ( $dblinkname = "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 $dblinkname The type of database connection. Used to identify the resource: "read", "write", or "readwrite".

Returns: void

Exceptions

Definition at line 139 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 private

Definition at line 513 of file Database.php.

Elgg\Database::executeQuery	(	$query,
		$dblink
	)

Execute a query.

$query is executed via mysql_query(). If there is an SQL error, a DatabaseException is thrown.

Parameters

string	$query	The query
resource	$dblink	The DB link

Returns: resource|bool The result of mysql_query()

Exceptions

Definition at line 391 of file Database.php.

Elgg\Database::fingerprintCallback ( $callback )

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 private

Definition at line 290 of file Database.php.

Elgg\Database::getData	(	$query,
		$callback = `''`
	)

Retrieve rows from the database.

Queries are executed with Elgg\Database::executeQuery()andresultsareretrievedwith@linkmysql_fetch_object().Ifacallbackfunction$callbackisdefined,eachrowwillbepassedasasingleargumentto$callback.Ifnocallbackfunctionisdefined,theentireresultsetisreturnedasanarray.@parammixed$queryThequerybeingpassed.@paramstring$callbackOptionally,thenameofafunctiontocallbacktooneachrow@returnarrayAnarrayofdatabaseresultobjectsorcallbackfunctionresults.Ifthequeryreturnednothing,anemptyarray.@throws\DatabaseException

Definition at line 175 of file Database.php.

Elgg\Database::getDataRow	(	$query,
		$callback = `''`
	)

Retrieve a single row from the database.

Similar to Elgg\Database::getData()butreturnsonlythefirstrowmatched.Ifacallbackfunction$callbackisspecified,therowwillbepassedastheonlyargumentto$callback.@parammixed$queryThequerytoexecute.@paramstring$callbackAcallbackfunction@returnmixedAsingledatabaseresultobjectortheresultofthecallbackfunction.@throws\DatabaseException

Definition at line 192 of file Database.php.

Elgg\Database::getLink ( $type )

Gets (if required, also creates) a database link resource.

The database link resources are created by Elgg\Database::setupConnections(),whichiscalledifnolinksexist.@paramstring$typeThetypeoflinkwewant:"read","write"or"readwrite".@returnresourceDatabaselink@throws\DatabaseException\xrefitemtodo13.

Definition at line 98 of file Database.php.

Elgg\Database::getQueryCount ( )

Get the number of queries made to the database.

Returns: int

Definition at line 606 of file Database.php.

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

protected

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

This is for R queries (from CRUD).

Parameters

string	$query	The select query to execute
string	$callback	An optional callback function to run on each row
bool	$single	Return only a single result?

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

Exceptions

Definition at line 319 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

Definition at line 661 of file Database.php.

Elgg\Database::getTablePrefix ( )

Get the prefix for Elgg's tables.

Returns: string

Definition at line 615 of file Database.php.

Elgg\Database::insertData ( $query )

Insert a row into the database.

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

Parameters

mixed $query The query to execute.

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 207 of file Database.php.

Elgg\Database::invalidateQueryCache ( )

protected

Invalidate the query cache.

Returns: void

Definition at line 569 of file Database.php.

Elgg\Database::registerDelayedQuery	(	$query,
		$type,
		$handler = `""`
	)

Queue a query for execution upon shutdown.

You can specify a handler function if you care about the result. This function will accept the raw result from mysql_query().

Parameters

string	$query	The query to execute
string	$type	The query type ('read' or 'write')
string	$handler	A callback function to pass the results array to

Returns: boolean Whether registering was successful.

Definition at line 487 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 436 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 626 of file Database.php.

Elgg\Database::sanitizeString ( $value )

Sanitizes a string for use in a query.

Parameters

string $value Value to escape

Returns: string

Definition at line 644 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 118 of file Database.php.

Elgg\Database::updateData	(	$query,
		$getNumRows = `false`
	)

Update the database.

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

Parameters

string	$query	The query to run.
bool	$getNumRows	Return the number of rows affected (default: false)

Returns: bool|int

Exceptions

Definition at line 233 of file Database.php.

Member Data Documentation

global Elgg\Database::$ELGG_PLUGINS_PROVIDES_CACHE

Definition at line 10 of file Plugins.php.

global Elgg\Database::$SUBTYPE_CACHE

Cache subtypes and related class names.

array|null $SUBTYPE_CACHE array once populated from DB, initially null private

Definition at line 10 of file SubtypeTable.php.

Elgg\Database::$SUBTYPE_CACHE = null

Definition at line 11 of file SubtypeTable.php.

global Elgg\Database::$USERNAME_TO_GUID_MAP_CACHE

Definition at line 9 of file UsersTable.php.

Elgg\Database::$USERNAME_TO_GUID_MAP_CACHE = array()

Definition at line 10 of file UsersTable.php.

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

engine/classes/Elgg/Database.php
engine/classes/Elgg/Database/Plugins.php
engine/classes/Elgg/Database/SubtypeTable.php
engine/classes/Elgg/Database/UsersTable.php

Public Member Functions

Public Attributes

Protected Member Functions

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation