joshtronic/pickles
1
0
Fork 0
Code Issues 8 Pull requests Projects Releases Packages Wiki Activity Actions

Reworked Database stuff to be Datastore stuff

Browse source 
Wanted a generic grouping for all datastores so there's a place for memcached and redis.
This commit is contained in:
Josh Sherman 2013-02-26 10:15:52 -05:00
parent df0ef6d959
commit ebd0018473
12 changed files with 170 additions and 180 deletions
Download patch file Download diff file Expand all files Collapse all files

37
classes/Database.php → classes/Datastore.php
View file

@ -1,7 +1,7 @@
<?php
/**
* Database Class File for PICKLES
* Datastore Class File for PICKLES
*
* PHP version 5
*
@ -9,26 +9,24 @@
* Redistribution of these files must retain the above copyright notice.
*
* @author Josh Sherman <pickles@joshtronic.com>
* @copyright Copyright 2007-2012, Josh Sherman
* @copyright Copyright 2007-2013, Josh Sherman
* @license http://www.opensource.org/licenses/mit-license.html
* @package PICKLES
* @link https://github.com/joshtronic/pickles
*/
/**
* Database Factory
* Datastore Factory
*
* Generic class to simplify connecting to a database. All database objects
* should be created by this class to future proof against any internal changes
* to PICKLES.
* Generic class to simplify connecting to a datastore.
*/
class Database extends Object
class Datastore extends Object
{
/**
* Constructor
*
* Attempts to get an instance of the passed database type or attempts to
* use a default specified in the config.
* Attempts to get an instance of the passed datastore name or attempts
* to use a default specified in the config.
*
* @param string $name optional name of the connection to use
*/
@ -36,16 +34,17 @@ class Database extends Object
{
parent::__construct();
return Database::getInstance($name);
return Datastore::getInstance($name);
}
/**
* Get Instance
*
* Looks up the datasource using the passed name and gets an instance of
* it. Allows for easy sharing of certain classes within the system to
* avoid the extra overhead of creating new objects each time. Also avoids
* the hassle of passing around variables (yeah I know, very global-ish)
* Looks up the datasource using the passed name and gets an instance
* of it. Allows for easy sharing of certain classes within the system
* to avoid the extra overhead of creating new objects each time. Also
* avoids the hassle of passing around variables (yeah I know, very
* global-ish, don't just me).
*
* @static
* @param string $name name of the datasource
@ -85,7 +84,7 @@ class Database extends Object
$datasource['driver'] = strtolower($datasource['driver']);
if (!isset(self::$instances['Database'][$name]))
if (!isset(self::$instances[$name]))
{
// Checks the driver is legit and scrubs the name
switch ($datasource['driver'])
@ -99,8 +98,8 @@ class Database extends Object
break;
}
// Instantiates our database class
$class = 'Database_' . $class;
// Instantiates our datastore class
$class = 'Datastore_' . $class;
$instance = new $class();
// Sets our database parameters
@ -116,11 +115,11 @@ class Database extends Object
// Caches the instance for possible reuse later
if (isset($instance))
{
self::$instances['Database'][$name] = $instance;
self::$instances[$name] = $instance;
}
// Returns the instance
return self::$instances['Database'][$name];
return self::$instances[$name];
}
}

43
classes/Database/Common.php → classes/Datastore/Common.php
View file

@ -1,7 +1,7 @@
<?php
/**
* Common Database Class File for PICKLES
* Common Datastore Class File for PICKLES
*
* PHP version 5
*
@ -9,19 +9,19 @@
* Redistribution of these files must retain the above copyright notice.
*
* @author Josh Sherman <pickles@joshtronic.com>
* @copyright Copyright 2007-2012, Josh Sherman
* @copyright Copyright 2007-2013, Josh Sherman
* @license http://www.opensource.org/licenses/mit-license.html
* @package PICKLES
* @link https://github.com/joshtronic/pickles
*/
/**
* Common Database Abstraction Layer
* Common Datastore Abstraction Layer
*
* Parent class that our database driver classes should be extending. Contains
* basic functionality for instantiation and interfacing.
* Parent class that our datastore classes should be extending.
* Contains basic functionality for instantiation and interfacing.
*/
abstract class Database_Common extends Object
abstract class Datastore_Common extends Object
{
/**
* Driver
@ -66,9 +66,9 @@ abstract class Database_Common extends Object
public $password = null;
/**
* Database name for the server
* Database name (or number) for the server
*
* @var string
* @var string or integer
*/
public $database = null;
@ -94,30 +94,9 @@ abstract class Database_Common extends Object
public $results = null;
/**
* Constructor
*/
public function __construct()
{
parent::__construct();
// Checks the driver is set and available
if ($this->driver == null)
{
throw new Exception('Driver name is not set');
}
else
{
if (extension_loaded($this->driver) == false)
{
throw new Exception('Driver "' . $this->driver . '" is not loaded');
}
}
}
/**
* Open Database Connection
* Open Connection
*
* Establishes a connection to the MySQL database based on the configuration
* Establishes a connection to the datastore based on the configuration
* options that are available in the Config object.
*
* @abstract
@ -126,7 +105,7 @@ abstract class Database_Common extends Object
abstract public function open();
/**
* Close Database Connection
* Close Connection
*
* Sets the connection to null regardless of state.
*

0
classes/Datastore/Memcached.php Normal file
View file

23
classes/Database/PDO/Common.php → classes/Datastore/PDO/Common.php
View file

@ -20,7 +20,7 @@
*
* Parent class for any of our database classes that use PDO.
*/
class Database_PDO_Common extends Database_Common
class Datastore_PDO_Common extends Datastore_Common
{
/**
* DSN format
@ -49,6 +49,19 @@ class Database_PDO_Common extends Database_Common
{
parent::__construct();
// Checks the driver is set and available
if ($this->driver == null)
{
throw new Exception('Driver name is not set');
}
else
{
if (extension_loaded($this->driver) == false)
{
throw new Exception('Driver "' . $this->driver . '" is not loaded');
}
}
// Checks that the prefix is set
if ($this->dsn == null)
{
@ -68,8 +81,8 @@ class Database_PDO_Common extends Database_Common
/**
* Opens database connection
*
* Establishes a connection to the database based on the set configuration
* options.
* Establishes a connection to the database based on the set
* configuration options.
*
* @return boolean true on success, throws an exception overwise
*/
@ -125,8 +138,8 @@ class Database_PDO_Common extends Database_Common
/**
* Executes an SQL Statement
*
* Executes a standard or prepared query based on passed parameters. All
* queries are logged to a file as well as timed and logged in the
* Executes a standard or prepared query based on passed parameters.
* All queries are logged to a file as well as timed and logged in the
* execution time is over 1 second.
*
* @param string $sql statement to execute

4
classes/Database/PDO/MySQL.php → classes/Datastore/PDO/MySQL.php
View file

@ -9,7 +9,7 @@
* Redistribution of these files must retain the above copyright notice.
*
* @author Josh Sherman <pickles@joshtronic.com>
* @copyright Copyright 2007-2012, Josh Sherman
* @copyright Copyright 2007-2013, Josh Sherman
* @license http://www.opensource.org/licenses/mit-license.html
* @package PICKLES
* @link https://github.com/joshtronic/pickles
@ -18,7 +18,7 @@
/**
* MySQL Database Abstraction Layer
*/
class Database_PDO_MySQL extends Database_PDO_Common
class Datastore_PDO_MySQL extends Datastore_PDO_Common
{
/**
* Driver

2
classes/Database/PDO/PostgreSQL.php → classes/Datastore/PDO/PostgreSQL.php
View file

@ -18,7 +18,7 @@
/**
* PostgreSQL Database Abstraction Layer
*/
class Database_PDO_PostgreSQL extends Database_PDO_Common
class Datastore_PDO_PostgreSQL extends Datastore_PDO_Common
{
/**
* Driver

2
classes/Database/PDO/SQLite.php → classes/Datastore/PDO/SQLite.php
View file

@ -18,7 +18,7 @@
/**
* SQLite Database Abstraction Layer
*/
class Database_PDO_SQLite extends Database_PDO_Common
class Datastore_PDO_SQLite extends Datastore_PDO_Common
{
/**
* Driver

0
classes/Datastore/Redis.php Normal file
View file

2
classes/Model.php
View file

@ -310,7 +310,7 @@ class Model extends Object
parent::__construct();
// Gets an instance of the database and check which it is
$this->db = Database::getInstance();
$this->db = Datastore::getInstance();
$this->use_cache = $this->db->cache;
$this->mysql = ($this->db->driver == 'pdo_mysql');
$this->postgresql = ($this->db->driver == 'pdo_pgsql');

60
classes/Module.php
View file

@ -9,7 +9,7 @@
* Redistribution of these files must retain the above copyright notice.
*
* @author Josh Sherman <pickles@joshtronic.com>
* @copyright Copyright 2007-2012, Josh Sherman
* @copyright Copyright 2007-2013, Josh Sherman
* @license http://www.opensource.org/licenses/mit-license.html
* @package PICKLES
* @link https://github.com/joshtronic/pickles
@ -18,12 +18,13 @@
/**
* Module Class
*
* This is a parent class that all PICKLES modules should be extending. Each
* module can specify it's own meta data and whether or not a user must be
* properly authenticated to view the page. Currently any pages without a
* template are treated as pages being requested via AJAX and the return will
* be JSON encoded. In the future this may need to be changed out for logic
* that allows the requested module to specify what display type(s) it can use.
* This is a parent class that all PICKLES modules should be extending.
* Each module can specify it's own meta data and whether or not a user
* must be properly authenticated to view the page. Currently any pages
* without a template are treated as pages being requested via AJAX and the
* return will be JSON encoded. In the future this may need to be changed
* out for logic that allows the requested module to specify what display
* type(s) it can use.
*/
class Module extends Object
{
@ -126,9 +127,9 @@ class Module extends Object
/**
* Hash
*
* Whether or not to validate the security hash. Boolean true will indicate
* using the name of the module as the hash, a string value will use the
* value instead.
* Whether or not to validate the security hash. Boolean true will
* indicate using the name of the module as the hash, a string value
* will use the value instead.
*
* @access protected
* @var string or boolean, null by default
@ -149,9 +150,10 @@ class Module extends Object
/**
* Default Template
*
* Defaults to null but could be set to any valid template basename. The
* value is overwritten by the config value if not set by the module. The
* display engine determines what the file extension should be.
* Defaults to null but could be set to any valid template basename.
* The value is overwritten by the config value if not set by the
* module. The display engine determines what the file extension should
* be.
*
* @access protected
* @var string, 'index' by default
@ -163,8 +165,8 @@ class Module extends Object
*
* Array that is returned to the template in the case of the module not
* returning anything itself. This is somewhat of a one way trip as you
* cannot get the variable unless you reference the return array explicitly
* $this->return['variable']
* cannot get the variable unless you reference the return array
* explicitly $this->return['variable']
*
* @access protected
* @var array
@ -175,9 +177,10 @@ class Module extends Object
* Constructor
*
* The constructor does nothing by default but can be passed a boolean
* variable to tell it to automatically run the __default() method. This is
* typically used when a module is called outside of the scope of the
* controller (the registration page calls the login page in this manner.
* variable to tell it to automatically run the __default() method.
* This is typically used when a module is called outside of the scope
* of the controller (the registration page calls the login page in
* this manner).
*
* @param boolean $autorun optional flag to autorun __default()
*/
@ -186,7 +189,7 @@ class Module extends Object
parent::__construct();
$this->cache = Cache::getInstance();
$this->db = Database::getInstance();
$this->db = Datastore::getInstance();
if ($autorun === true)
{
@ -198,10 +201,10 @@ class Module extends Object
* Default "Magic" Method
*
* This function is overloaded by the module. The __default() method is
* where you want to place any code that needs to be executed at runtime.
* The reason the code isn't in the constructor is because the module must
* be instantiated before the code is executed so that the controller
* script is aware of the authentication requirements.
* where you want to place any code that needs to be executed at
* runtime. The reason the code isn't in the constructor is because the
* module must be instantiated before the code is executed so that the
* controller script is aware of the authentication requirements.
*/
public function __default()
{
@ -211,9 +214,10 @@ class Module extends Object
/**
* Magic Setter Method
*
* Places the variables that are being modified in the return array that is
* returned if nothing is returned by the module itself. This also prohibits
* the direct modification of module variables which could cause issues.
* Places the variables that are being modified in the return array
* that is returned if nothing is returned by the module itself. This
* also prohibits the direct modification of module variables which
* could cause issues.
*
* @param string $name name of the variable to be set
* @param mixed $value value of the variable to be set
@ -226,8 +230,8 @@ class Module extends Object
/**
* Magic Getter Method
*
* Attempts to load the module variable. If it's not set, will attempt to
* load from the config.
* Attempts to load the module variable. If it's not set, will attempt
* to load from the config.
*
* @param string $name name of the variable requested
* @return mixed value of the variable or boolean false

2
classes/Session.php
View file

@ -179,7 +179,7 @@ class Session extends Object
$this->table = $table;
// Gets a database instance
$this->db = Database::getInstance($this->datasource);
$this->db = Datastore::getInstance($this->datasource);
// Initializes the session
$this->initialize();