GrimaDB Class Reference

Shared access to the database for GrimaUser and GrimaInstitution. More...

Inheritance diagram for GrimaDB:

Public Member Functions
	offsetExists ($offset)
	offsetGet ($offset)
	offsetSet ($offset, $value)
	offsetUnset ($offset)
	getIterator ()

Static Public Member Functions
static	init ()
static	isEmpty ()
static	isStateless ()
static	getInstitutions ()

Protected Member Functions
	getPasswordAlgorithm ()

Static Protected Member Functions
static	getDb ()

Private Attributes
	$info

Static Private Attributes
static	$db = false

Detailed Description

Shared access to the database for GrimaUser and GrimaInstitution.

Definition at line 4662 of file grima-lib.php.

Member Function Documentation

getDb()

static GrimaDB::getDb ( )

staticprotected

Definition at line 4695 of file grima-lib.php.

    {

        if (!self::$db) {

            try {

                $db_url = getenvWithFileFallbackAndDefault('DATABASE_URL', '');

                $db_user = getenvWithFileFallbackAndDefault('DATABASE_USER', '');

                $db_pass = getenvWithFileFallbackAndDefault('DATABASE_PASS', '');

                if ($db_user && $db_pass) {

                    self::$db = new PDO($db_url, $db_user, $db_pass);

                } else {

                    self::$db = new PDO($db_url);

                }

                if (!tableExists(self::$db, "institutions")) {

                    self::$db->exec("CREATE TABLE institutions ( institution VARCHAR(100) PRIMARY KEY, apikey VARCHAR(100), server VARCHAR(100) )");

                }

                if (!tableExists(self::$db, "users")) {

                    self::$db->exec("CREATE TABLE users ( institution VARCHAR(100), username VARCHAR(100), password VARCHAR(255), isAdmin INTEGER )");

                }

            } catch (Exception $e) {

                self::$db = 'stateless';

            }

        }

        return self::$db;

    }

References $db, getenvWithFileFallbackAndDefault(), and tableExists().

Referenced by GrimaInstitution\addToDB(), GrimaUser\addToDB(), GrimaUser\deleteFromDB(), getInstitutions(), init(), isEmpty(), isStateless(), GrimaUser\LookupUser(), GrimaUser\RenameUser(), GrimaUser\ResetPassword(), and GrimaUser\updateDB().

getInstitutions()

static GrimaDB::getInstitutions ( )

static

Definition at line 4725 of file grima-lib.php.

    {

        $ret = array();

        try {

            $db = self::getDb();

            if ($db === 'stateless') {

                return $ret;

            }

            $result = $db->query('SELECT institution FROM institutions');

            foreach ($result as $row) {

                $ret[] = $row['institution'];

            }

        } catch (Exception $e) {

        }

        return $ret;

    }

References $db, and getDb().

Referenced by GrimaFormField\__construct().

getIterator()

GrimaDB::getIterator

(

)

Definition at line 4762 of file grima-lib.php.

    {

        return new ArrayIterator($this->info);

    }

getPasswordAlgorithm()

GrimaDB::getPasswordAlgorithm ( )

protected

Definition at line 4720 of file grima-lib.php.

    {

        return defined("PASSWORD_ARGON2I") ? constant("PASSWORD_ARGON2I") : PASSWORD_DEFAULT;

    }

Referenced by GrimaUser\addToDB(), and GrimaUser\updateDB().

init()

static GrimaDB::init ( )

static

Definition at line 4668 of file grima-lib.php.

    {

        return self::getDb();

    }

References getDb().

isEmpty()

static GrimaDB::isEmpty ( )

static

Definition at line 4673 of file grima-lib.php.

    {

        $db = self::getDb();

        if ($db === 'stateless') {

            return true;

        }

        $result = $db->query('SELECT COUNT(*) as c FROM institutions');

        if ($result) {

            foreach ($result as $row) {

                if ($row['c']>0) { return false;

                }

            }

        }

        return true;

    }

References $db, and getDb().

isStateless()

static GrimaDB::isStateless ( )

static

Definition at line 4689 of file grima-lib.php.

    {

        $db = self::getDb();

        return $db === 'stateless';

    }

References $db, and getDb().

offsetExists()

GrimaDB::offsetExists

(

$offset

)

Definition at line 4742 of file grima-lib.php.

    {

        return isset($this->info[$offset]);

    }

offsetGet()

GrimaDB::offsetGet

(

$offset

)

Definition at line 4747 of file grima-lib.php.

    {

        return isset($this->info[$offset]) ? $this->info[$offset] : '';

    }

offsetSet()

GrimaDB::offsetSet	(		$offset,
			$value
	)

Definition at line 4752 of file grima-lib.php.

    {

        $this->info[$offset] = $value;

    }

offsetUnset()

GrimaDB::offsetUnset

(

$offset

)

Definition at line 4757 of file grima-lib.php.

    {

        unset($this->info[$offset]);

    }

Member Data Documentation

$db

GrimaDB::$db = false

staticprivate

Definition at line 4665 of file grima-lib.php.

Referenced by GrimaInstitution\addToDB(), GrimaUser\addToDB(), GrimaUser\deleteFromDB(), getDb(), getInstitutions(), isEmpty(), isStateless(), GrimaUser\LookupUser(), GrimaUser\RenameUser(), GrimaUser\ResetPassword(), and GrimaUser\updateDB().

$info

GrimaDB::$info

private

Definition at line 4666 of file grima-lib.php.

---

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

• grimas/grima-lib.php