SimpleSAML\Database Class Reference

Collaboration diagram for SimpleSAML\Database:

Public Member Functions
	applyPrefix ($table)
	This function simply applies the table prefix to a supplied table name. More...
	write ($stmt, $params=array())
	This executes queries directly on the master. More...
	read ($stmt, $params=array())
	This executes queries on a database server that is determined by this::getSlave(). More...
	getLastError ()
	Return an array with information about the last operation performed in the database. More...

Static Public Member Functions
static	getInstance ($altConfig=null)
	Retrieves the current database instance. More...

Private Member Functions
	__construct ($config)
	Private constructor that restricts instantiation to getInstance(). More...
	connect ($dsn, $username, $password, $options)
	This function connects to a database. More...
	getSlave ()
	This function randomly selects a slave database server to query. More...
	query ($db, $stmt, $params)
	This function queries the database. More...
	exec ($db, $stmt)
	This function queries the database without using a prepared statement. More...

Static Private Member Functions
static	generateInstanceId ($config)
	Generate an Instance ID based on the database configuration. More...

Private Attributes
	$dbMaster
	PDO Object for the Master database server. More...
	$dbSlaves = array()
	Array of PDO Objects for configured database slaves. More...
	$tablePrefix
	Prefix to apply to the tables. More...
	$lastError
	Array with information on the last error occurred. More...

Static Private Attributes
static	$instance = array()
	This variable holds the instance of the session - Singleton approach. More...

Detailed Description

Definition at line 19 of file Database.php.

Constructor & Destructor Documentation

__construct()

SimpleSAML\Database::__construct (   $config )

private

Private constructor that restricts instantiation to getInstance().

Parameters

\SimpleSAML_Configuration

$config

Instance of the SimpleSAML_Configuration class

Definition at line 76 of file Database.php.

References $config.

    {
        $driverOptions = $config->getArray('database.driver_options', array());
        if ($config->getBoolean('database.persistent', true)) {
            $driverOptions = array(\PDO::ATTR_PERSISTENT => true);
        }

        // connect to the master
        $this->dbMaster = $this->connect(
            $config->getString('database.dsn'),
            $config->getString('database.username', null),
            $config->getString('database.password', null),
            $driverOptions
        );

        // connect to any configured slaves
        $slaves = $config->getArray('database.slaves', array());
        foreach ($slaves as $slave) {
            array_push(
                $this->dbSlaves,
                $this->connect(
                    $slave['dsn'],
                    $slave['username'],
                    $slave['password'],
                    $driverOptions
                )
            );
        }

        $this->tablePrefix = $config->getString('database.prefix', '');
    }

Member Function Documentation

applyPrefix()

SimpleSAML\Database::applyPrefix

(

$table

)

This function simply applies the table prefix to a supplied table name.

Parameters

string

$table

Table to apply prefix to, if configured

Returns

string Table with configured prefix

Definition at line 181 of file Database.php.

    {
        return $this->tablePrefix.$table;
    }

connect()

SimpleSAML\Database::connect (   $dsn,   $username,   $password,   $options  )

private

This function connects to a database.

Parameters

string	$dsn	Database connection string
string	$username	SQL user
string	$password	SQL password
array	$options	PDO options

Exceptions

Definition at line 144 of file Database.php.

References $dsn, PHPMailer\PHPMailer\$options, and $password.

    {
        try {
            $db = new \PDO($dsn, $username, $password, $options);
            $db->setAttribute(\PDO::ATTR_ERRMODE, \PDO::ERRMODE_EXCEPTION);

            return $db;
        } catch (\PDOException $e) {
            throw new \Exception("Database error: ".$e->getMessage());
        }
    }

exec()

SimpleSAML\Database::exec (   $db,   $stmt  )

private

This function queries the database without using a prepared statement.

Parameters

\PDO	$db	PDO object to use
string	$stmt	An SQL statement to execute, previously escaped.

Exceptions

Definition at line 233 of file Database.php.

References $stmt.

    {
        assert(is_object($db));
        assert(is_string($stmt));

        try {
            return $db->exec($stmt);
        } catch (\PDOException $e) {
            $this->lastError = $db->errorInfo();
            throw new \Exception("Database error: ".$e->getMessage());
        }
    }

generateInstanceId()

static SimpleSAML\Database::generateInstanceId (   $config )

staticprivate

Generate an Instance ID based on the database configuration.

Parameters

\SimpleSAML_Configuration

$config

Configuration class

Returns

string $instanceId

Definition at line 116 of file Database.php.

References $config.

    {
        $assembledConfig = array(
            'master' => array(
                'database.dsn'        => $config->getString('database.dsn'),
                'database.username'   => $config->getString('database.username', null),
                'database.password'   => $config->getString('database.password', null),
                'database.prefix'     => $config->getString('database.prefix', ''),
                'database.persistent' => $config->getBoolean('database.persistent', false),
            ),
            'slaves' => $config->getArray('database.slaves', array()),
        );

        return sha1(serialize($assembledConfig));
    }

getInstance()

static SimpleSAML\Database::getInstance (   $altConfig = null )

static

Retrieves the current database instance.

Will create a new one if there isn't an existing connection.

Parameters

\SimpleSAML_Configuration

$altConfig

Optional: Instance of a SimpleSAML_Configuration class

Returns

The shared database connection.

Definition at line 55 of file Database.php.

References $config, and SimpleSAML_Configuration\getInstance().

Referenced by SimpleSAML_Metadata_MetaDataStorageHandlerPdo\__construct().

    {
        $config = ($altConfig) ? $altConfig : \SimpleSAML_Configuration::getInstance();
        $instanceId = self::generateInstanceId($config);

        // check if we already have initialized the session
        if (isset(self::$instance[$instanceId])) {
            return self::$instance[$instanceId];
        }

        // create a new session
        self::$instance[$instanceId] = new Database($config);
        return self::$instance[$instanceId];
    }

Here is the call graph for this function:

Here is the caller graph for this function:

getLastError()

SimpleSAML\Database::getLastError

(

)

Return an array with information about the last operation performed in the database.

Returns

array The array with error information.

Definition at line 289 of file Database.php.

    {
        return $this->lastError;
    }

getSlave()

SimpleSAML\Database::getSlave ( )

private

This function randomly selects a slave database server to query.

In the event no slaves are configured, it will return the master.

Returns

object

Definition at line 163 of file Database.php.

    {
        if (count($this->dbSlaves) > 0) {
            $slaveId = rand(0, count($this->dbSlaves) - 1);
            return $this->dbSlaves[$slaveId];
        } else {
            return $this->dbMaster;
        }
    }

query()

SimpleSAML\Database::query (   $db,   $stmt,   $params  )

private

This function queries the database.

Parameters

\PDO	$db	PDO object to use
string	$stmt	Prepared SQL statement
array	$params	Parameters

Exceptions

Definition at line 197 of file Database.php.

References PHPMailer\PHPMailer\$params, $query, and $stmt.

    {
        assert(is_object($db));
        assert(is_string($stmt));
        assert(is_array($params));

        try {
            $query = $db->prepare($stmt);

            foreach ($params as $param => $value) {
                if (is_array($value)) {
                    $query->bindValue(":$param", $value[0], ($value[1]) ? $value[1] : \PDO::PARAM_STR);
                } else {
                    $query->bindValue(":$param", $value, \PDO::PARAM_STR);
                }
            }

            $query->execute();

            return $query;
        } catch (\PDOException $e) {
            $this->lastError = $db->errorInfo();
            throw new \Exception("Database error: ".$e->getMessage());
        }
    }

read()

SimpleSAML\Database::read	(		$stmt,
			$params = array()
	)

This executes queries on a database server that is determined by this::getSlave().

Parameters

string	$stmt	Prepared SQL statement
array	$params	Parameters

Returns

object

Definition at line 276 of file Database.php.

References PHPMailer\PHPMailer\$params, and $stmt.

    {
        $db = $this->getSlave();

        return $this->query($db, $stmt, $params);
    }

write()

SimpleSAML\Database::write	(		$stmt,
			$params = array()
	)

This executes queries directly on the master.

Parameters

string	$stmt	Prepared SQL statement
array	$params	Parameters

Returns

int The number of rows affected by the query.

Definition at line 255 of file Database.php.

References PHPMailer\PHPMailer\$params, and $stmt.

    {
        $db = $this->dbMaster;

        if (is_array($params)) {
            $obj = $this->query($db, $stmt, $params);
            return $obj->rowCount();
        } else {
            return $this->exec($db, $stmt);
        }
    }

Field Documentation

$dbMaster

SimpleSAML\Database::$dbMaster

private

PDO Object for the Master database server.

Definition at line 30 of file Database.php.

$dbSlaves

SimpleSAML\Database::$dbSlaves = array()

private

Array of PDO Objects for configured database slaves.

Definition at line 35 of file Database.php.

$instance

SimpleSAML\Database::$instance = array()

staticprivate

This variable holds the instance of the session - Singleton approach.

Definition at line 25 of file Database.php.

$lastError

SimpleSAML\Database::$lastError

private

Array with information on the last error occurred.

Definition at line 45 of file Database.php.

$tablePrefix

SimpleSAML\Database::$tablePrefix

private

Prefix to apply to the tables.

Definition at line 40 of file Database.php.

---

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

• libs/composer/vendor/simplesamlphp/simplesamlphp/lib/SimpleSAML/Database.php