dbHandler Class Reference

handling database connection and queries More...

Inheritance diagram for dbHandler:

Public Member Functions
	__construct ()
	takes care of basic db handling More...
	query ($query)
	function queries sqlite More...
	exec ($query)
	function executes sqlite More...
	getActiveArchiveRules ()
	getActiveSenders ()
	getConfigValue ($varname)
	getPersonalVariables ()
	getActiveSubjects ()
	getActiveRecipients ()
	writeLog ($oldName, $newName, $content, $log)
	open ()
	opens database connection or creates file is not found More...
	update ()
	checks if the database schema needs to be updated More...
	close ()
	closes database connection More...
Public Member Functions inherited from ppyrd
	__construct ($db)
	constructor More...
	checkCliVsWebserver ()
	output ($string, $debug=0)
	outputs string More...

Public Attributes
	$db
Public Attributes inherited from ppyrd
	$db

Detailed Description

handling database connection and queries

Author

Till Witt

Bug:

no error handling implemented yet

database handler

Definition at line 15 of file dbHandler.php.

Constructor & Destructor Documentation

dbHandler::__construct

(

)

takes care of basic db handling

Definition at line 29 of file dbHandler.php.

                                      {
        // connects or creates sqlite db file
        $this->open();

        // updating table model
        $this->update();

        //$this->alterTableAddColumns("testtable", "createdDate", " TEXT");
        //$this->alterTableDropColumns("testtable", "createdDate,modifiedDate,publishedDate");

        } // End constructor

Member Function Documentation

dbHandler::close

(

)

closes database connection

Definition at line 194 of file dbHandler.php.

        {

            $res = $this->db->close();
            unset($this->db);
        }

dbHandler::exec

(

$query

)

function executes sqlite

Parameters

string

$query

to execute

Returns

pointer to db results

Definition at line 64 of file dbHandler.php.

        {
                $result = $this->db->exec($query);
                if (!$result) {
                        // the query failed
                        $this->output("There was an error in query: $query");
                        $this->output(
                            $this->db->lastErrorMsg());
                }
                return $result;
        }

dbHandler::getActiveArchiveRules

(

)

gets active ruleset

Definition at line 79 of file dbHandler.php.

        {
            return $this->query("SELECT * FROM rule_archive WHERE isActive = 1");
        }

dbHandler::getActiveRecipients

(

)

gets active recipients

Definition at line 129 of file dbHandler.php.

        {
            return $this->query("SELECT * FROM rule_recipients WHERE isActive = 1");
        }

dbHandler::getActiveSenders

(

)

gets active senders

Definition at line 87 of file dbHandler.php.

        {
            return $this->query("SELECT * FROM rule_senders WHERE isActive = 1");
        }

dbHandler::getActiveSubjects

(

)

gets active subjects

Definition at line 121 of file dbHandler.php.

        {
            return $this->query("SELECT * FROM rule_subjects WHERE isActive = 1");
        }

dbHandler::getConfigValue

(

$varname

)

gets config values

Parameters

string

$varname

to query

Returns

string containing variable value or -1 for error

Definition at line 97 of file dbHandler.php.

        {
                $results = $this->query("SELECT * FROM config WHERE configVariable = '$varname'");
                if ($results == false)
                    return false;
                $row = $results->fetchArray();
                return $row['configValue'];
        }

dbHandler::getPersonalVariables

(

)

gets all personal variables

Parameters

none

Returns

link to query

Definition at line 112 of file dbHandler.php.

        {
            return $this->query("SELECT * FROM rule_personalInfo WHERE isActive = 1");
        }

dbHandler::open

(

)

opens database connection or creates file is not found

Definition at line 151 of file dbHandler.php.

        {
            $this->db = new SQLite3("/data/database/paperyard.sqlite");
            $this->db->busyTimeout(15000);
        // WAL mode has better control over concurrency.
        // Source: https://www.sqlite.org/wal.html
            $this->db->exec('PRAGMA journal_mode = wal;');
        }

dbHandler::query

(

$query

)

function queries sqlite

Parameters

string

$query

to execute

Returns

pointer to db results

Definition at line 47 of file dbHandler.php.

        {
            $result = $this->db->query($query);
            if (!$result) {
                    // the query failed
                    $this->output("There was an error in query: $query");
                    $this->output($this->db->lastErrorMsg());
                    return false;
            }
            return $result;
        }

dbHandler::update

(

)

checks if the database schema needs to be updated

Bug:

more error handling needed?

Definition at line 163 of file dbHandler.php.

        {

            $this->output("looking for DB updates");

            // changing to sqlite update directory
            chdir("/www/updates/sqlite/");

            // getting all .sql files
            $updates = glob("*.sql");

            // checking each file
            foreach($updates as $update){
                $dbversion = $this->getConfigValue("databaseVersion");
                if ($dbversion == false)
                    $dbversion = 0;
                $version = str_replace(".sql", "", $update);
                // really only execute next one - if that fails no further updates shall be attempted
                if ($version == $dbversion+1) {
                    $this->output ("applying " . $update);
                    $this->output("found update script:" . $version);
                    $sql = file_get_contents ($update);
                    $this->exec($sql);
                }
            }
        }

dbHandler::writeLog	(		$oldName,
			$newName,
			$content,
			$log
	)

writes to logs

Parameters

string	$oldName	name of the old file
string	$newName	of the file
string	$content	of the file
string	$log	message

Definition at line 141 of file dbHandler.php.

        {
            $safe = SQLite3::escapeString($content);
            $this->exec("INSERT INTO logs (oldFileName, newFileName, fileContent, log) VALUES ('$oldName', '$newName', '$safe', '$log');");
        }

Member Data Documentation

dbHandler::$db

Definition at line 24 of file dbHandler.php.

---

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

• paperyard/paperyard/backend/dbHandler.php