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

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