FuzeWorks/Core
FuzeWorks
/
Core
1
0
Fork 0
Code Issues 9 Pull Requests Packages Releases Activity

Added documentation to Database class.

This commit is contained in:
Abel Hoogeveen 2016-05-21 22:11:21 +02:00
parent d3391ddaa0
commit 3284246fcf
2 changed files with 74 additions and 113 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

58
Application/class.init.php
View File

@ -1,58 +0,0 @@
<?php
/**
* FuzeWorks.
*
* The FuzeWorks MVC PHP FrameWork
*
* Copyright (C) 2015 TechFuze
*
* This program is free software: you can redistribute it and/or modify
* it under the terms of the GNU General Public License as published by
* the Free Software Foundation, either version 3 of the License, or
* (at your option) any later version.
*
* This program is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU General Public License for more details.
*
* You should have received a copy of the GNU General Public License
* along with this program. If not, see <http://www.gnu.org/licenses/>.
*
* @author TechFuze
* @copyright Copyright (c) 2013 - 2016, Techfuze. (http://techfuze.net)
* @copyright Copyright (c) 1996 - 2015, Free Software Foundation, Inc. (http://www.fsf.org/)
* @license http://opensource.org/licenses/GPL-3.0 GPLv3 License
*
* @link http://fuzeworks.techfuze.net
* @since Version 0.0.1
*
* @version Version 0.0.1
*/
namespace Application;
use FuzeWorks\Bus;
/**
* Class init.
*
* This class will be loaded before the a controller is loaded. Handy to do some we-need-to-do-this-all-the-time-things like setting locales or importing functions.
* Can also be used to authenticate users and provide all views with sessionData.
* Will only be loaded if the default callable is used.
*
* @author Abel Hoogeveen <abel@techfuze.net>
* @copyright Copyright (c) 2013 - 2016, Techfuze. (http://techfuze.net)
*/
class Init extends Bus
{
/**
* Constructor.
*
* @param \FuzeWorks\Core $core Pointer to core class
*/
public function __construct(&$core)
{
parent::__construct($core);
}
}

129
Core/System/class.database.php
View File

@ -34,23 +34,58 @@ namespace FuzeWorks;
use FW_DB;
/**
* Database Class.
*
* @todo Add documentation
* @todo Implement Logger
*
* @author Abel Hoogeveen <abel@techfuze.net>
* @copyright Copyright (c) 2013 - 2016, Techfuze. (http://techfuze.net)
* Database loading class
*
* Loads databases, forges and utilities in a standardized manner.
*
* @author TechFuze <contact@techfuze.net>
* @copyright (c) 2013 - 2014, TechFuze. (https://techfuze.net)
*
*/
class Database
{
public static $defaultDB = null;
public static $defaultForge = null;
public static $defaultUtil = null;
public static $databasePaths = array('Application'.DS.'Database', 'Core'.DS.'Database');
/**
* The default database forge.
* @var type FW_DB|null
*/
protected static $defaultDB = null;
/**
* The default database forge.
* @var type FW_DB_forge|null
*/
protected static $defaultForge = null;
/**
* The default database utility.
* @var type FW_DB_utility|null
*/
protected static $defaultUtil = null;
/**
* Retrieve a database using a DSN or the default configuration.
*
* If a string is provided like this: 'dbdriver://username:password@hostname/database',
* the string will be interpreted and converted into a database connection parameter array.
*
* If a string is provided with a name, like this: 'default' the 'default' connection from the
* configuration file will be loaded. If no string is provided the default database will be loaded.
*
* If the $newInstance is a true boolean, a new instance will be loaded instead of loading the
* default one. $newInstance will also make sure that the loaded database is not default one.
* This behaviour will be changed in the future.
*
* @todo Change $newInstance behaviour related to self::$defaultDB
*
* If $queryBuilder = false is provided, the database will load without a queryBuilder.
* By default the queryBuilder will load.
*
* @param string $parameters
* @param bool $newInstance
* @param bool $queryBuilder
* @return type FW_DB
*/
public static function get($parameters = '', $newInstance = false, $queryBuilder = null)
{
if (!$newInstance && is_object(self::$defaultDB) && ! empty(self::$defaultDB->conn_id))
@ -69,7 +104,18 @@ class Database
return self::$defaultDB = DB($parameters, $queryBuilder);
}
}
/**
* Retrieves a database forge from the provided or default database.
*
* If no database is provided, the default database will be used.
* @todo Change $newInstance behaviour with default instances.
*
*
* @param FW_DB $database
* @param bool $newInstance
* @return FW_DB_forge
*/
public static function getForge($database = null, $newInstance = false)
{
// First check if we're talking about the default forge and that one is already set
@ -112,7 +158,18 @@ class Database
return self::$defaultForge = new $class($database);
}
}
/**
* Retrieves a database utility from the provided or default database.
*
* If no database is provided, the default database will be used.
* @todo Change $newInstance behaviour with default instances.
*
*
* @param FW_DB $database
* @param bool $newInstance
* @return FW_DB_utility
*/
public static function getUtil($database = null, $newInstance = false)
{
// First check if we're talking about the default util and that one is already set
@ -141,42 +198,4 @@ class Database
return self::$defaultUtil = new $class($database);
}
}
public static function addDatabasePath($directory)
{
if (!in_array($directory, self::$databasePaths))
{
self::$databasePaths[] = $directory;
}
}
public static function removeDatabasePath($directory)
{
if (($key = array_search($directory, self::$databasePaths)) !== false)
{
unset(self::$databasePaths[$key]);
}
}
public static function getDatabasePaths()
{
return self::$databasePaths;
}
}
}