@@ -11,23 +11,19 @@ class PhpBURN_Configuration { */ if(empty($options['database'])) { - throw new PhpBURN_Exception(PhpBURN_Message::EMPTY_DATABASE); - return; + PhpBURN_Message::output('[!Empty database into configuration!]',PhpBURN_Message::EXCEPTION); } if(empty($options['user'])) { - throw new PhpBURN_Exception(PhpBURN_Message::EMPTY_DATABASE_USER); - return; + PhpBURN_Message::output('[!Empty database user into configuration!]',PhpBURN_Message::EXCEPTION); } if(empty($options['password'])) { - throw new PhpBURN_Exception(PhpBURN_Message::EMPTY_DATABASE_PASSWORD); - return; + PhpBURN_Message::output('[!Empty password into configuration!]',PhpBURN_Message::EXCEPTION); } if(empty($options['class_path'])) { - throw new PhpBURN_Exception(PhpBURN_Message::EMPTY_CLASSPATH); - return; + PhpBURN_Message::output('[!Empty class_path into configuration!]',PhpBURN_Message::EXCEPTION); } /** @@ -35,18 +31,18 @@ class PhpBURN_Configuration { */ if(empty($options['dialect'])) { - PhpBURN_Logs::debug(PhpBURN_Message::EMPTY_DIALECT); + PhpBURN_Message::output('[!Empty dialect into configuration!]',PhpBURN_Message::WARNING); $options['dialect'] = 'MySQL'; } if(empty($options['port'])) { - PhpBURN_Logs::debug(PhpBURN_Message::EMPTY_DATABASE_PORT); + PhpBURN_Message::output('[!Empty database port into configuration!]',PhpBURN_Message::WARNING); $options['port'] = '3306'; } if(empty($options['host'])) { - PhpBURN_Logs::debug(PhpBURN_Message::EMPTY_DATABASE_HOST); + PhpBURN_Message::output('[!Empty database host into configuration!]',PhpBURN_Message::WARNING); $options['host'] = 'localhost'; } @@ -64,6 +60,12 @@ class PhpBURN_Configuration { } } + /** + * Gets the config about a specific package + * + * @param String $package + * @return Array + */ public function getConfig($package = null) { if($package == null) { return self::$options; app/libs/Configuration.php @@ -1,8 +1,29 @@ <?php +/** + * ConnectionManager Class + * + * This class manage the conection for each package. + * Can be used by many ways but by default its better if you simply do not mess around ;) let the application work for you. + * + * @author Kléderson Bueno <klederson@klederson.com> + * @version 0.1a + * + */ class PhpBURN_ConnectionManager { + /** + * This variable storage in runtime all dialects for each kind of package. For more details + * @see getConnection() + * @var Array + */ private static $connections = array(); + /** + * Creates a new Connector or retreive the existing one based on the Configuration. + * + * @param PhpBURN_ConfigurationItem $config + * @return PhpBURN_Connection + */ public function create(PhpBURN_ConfigurationItem &$config) { $conn = self::getConnection($config->package); if(!$conn) { @@ -33,6 +54,13 @@ class PhpBURN_ConnectionManager return $conn; } + /** + * Retreive the current connector for each package + * + * @param String $package + * @return PhpBURN_Connection + * @return Boolean + */ public function getConnection($package = null) { if(!isset(self::$connections[$package])) { return false; @@ -41,6 +69,12 @@ class PhpBURN_ConnectionManager } } + /** + * Discover the correspondent class for the Connection + * + * @param String $dialect + * @return PhpBURN_Connection + */ private function getConnectionClass($dialect = null) { $dialect = $dialect = null ? "MySQL" : $dialect; app/libs/ConnectionManager.php @@ -1,9 +1,11 @@ <?php /** - * All phpBurn classes should extend thi + * All phpBurn models should extend this class + * It is the main responsable for the Magic. * * @author Kléderson Bueno <klederson@klederson.com> - * @version 0.37 + * @version 0.4a + * @abstract */ abstract class PhpBURN_Core implements IPhpBurn { /* The structure of the constants follow the concept @@ -65,6 +67,10 @@ abstract class PhpBURN_Core implements IPhpBurn { */ public $_multiMap = false; + /** + * PHP magic method that automaticaly executes when a new instance of this class is been created + * Also here we configure the basics for the well work of PhpBURN Models + */ public function __construct() { if(!isset($this->_tablename) || !isset($this->_package)) { throw new PhpBURN_Exeption(PhpBURN_Message::EMPTY_PACKAGEORTABLE); @@ -98,6 +104,10 @@ abstract class PhpBURN_Core implements IPhpBurn { $this->_initialize(); } + /** + * PHP Magic method that starts when you initialize a class/model + * It also starts the conection between the model and the database + */ final private function _initialize() { //Opening the database connection for this object $this->getConnection()->connect(); @@ -130,10 +140,9 @@ abstract class PhpBURN_Core implements IPhpBurn { * @version 0.1a * * @param Integer $type - * @param Mixed $opt * @return String */ - public function _getQUERY( $type = self::QUERY_SELECT, $opt = null ) + public function _getQUERY( $type = self::QUERY_SELECT) { switch($type) { @@ -154,11 +163,14 @@ abstract class PhpBURN_Core implements IPhpBurn { case self::QUERY_MULTI_INSERT; return null; + + default: + return $this->getDialect()->getCurrentQuery(); } + //Outputs the error message $msg = "[!Unsuported SQL type!]: $type"; PhpBURN_Message::output($msg, PhpBURN_Message::ERROR); - exit(); } /** @@ -182,18 +194,50 @@ abstract class PhpBURN_Core implements IPhpBurn { $this->_join[$tableName]['type'] = $joinType; } + /** + * Just a hook for join() method, it automaticaly creates a LEFT JOIN into the SELECT query of your model + * + * @param String $tableName + * @param String $fieldLeft + * @param String $fieldRight + * @param String $operator + */ public function joinLeft($tableName, $fieldLeft = null, $fieldRight = null, $operator = '=') { $this->join($tableName, $fieldLeft = null, $fieldRight = null, $operator = '=', $joinType = 'LEFT JOIN'); } + /** + * Just a hook for join() method, it automaticaly creates a RIGHT JOIN into the SELECT query of your model + * + * @param String $tableName + * @param String $fieldLeft + * @param String $fieldRight + * @param String $operator + */ public function joinRight($tableName, $fieldLeft = null, $fieldRight = null, $operator = '=') { $this->join($tableName, $fieldLeft = null, $fieldRight = null, $operator = '=', $joinType = 'RIGHT JOIN'); } + /** + * Just a hook for join() method, it automaticaly creates a INNER JOIN into the SELECT query of your model + * + * @param String $tableName + * @param String $fieldLeft + * @param String $fieldRight + * @param String $operator + */ public function joinInner($tableName, $fieldLeft = null, $fieldRight = null, $operator = '=') { $this->join($tableName, $fieldLeft = null, $fieldRight = null, $operator = '=', $joinType = 'INNER JOIN'); } + /** + * Just a hook for join() method, it automaticaly creates a OUTTER JOIN into the SELECT query of your model + * + * @param String $tableName + * @param String $fieldLeft + * @param String $fieldRight + * @param String $operator + */ public function joinOutter($tableName, $fieldLeft = null, $fieldRight = null, $operator = '=') { $this->join($tableName, $fieldLeft = null, $fieldRight = null, $operator = '=', $joinType = 'OUTTER JOIN'); } @@ -221,14 +265,26 @@ abstract class PhpBURN_Core implements IPhpBurn { return true; } + /** + * This defines WHERE clauses to your model if override is true it cleanup all old wheres + * + * @param String $conditions + * @param Boolean $override + */ public function where($conditions, $override = false) { if($override == true) { - //unset($this->_where); + unset($this->_where); $this->_where = array(); } array_push($this->_where, $conditions); } + /** + * This method create SELECT method for your call + * + * @param String $field + * @param String $alias + */ public function select($field, $alias = null) { $alias = $alias == null ? $field : $alias; array_push($this->_select, array('value'=>$field, 'alias'=>$alias)); @@ -321,33 +377,75 @@ abstract class PhpBURN_Core implements IPhpBurn { $this->getMap()->setFieldValue($key,$value); } } + return $result; } - + /** + * (non-PHPdoc) + * @see app/libs/IPhpBurn#get() + */ public function get($pk = null) { $this->find($pk); $this->fetch(); } + /** + * (non-PHPdoc) + * @see app/libs/IPhpBurn#save() + */ public function save() { $this->getDialect()->save(); } + /** + * (non-PHPdoc) + * @see app/libs/IPhpBurn#delete() + */ public function delete($pk = null) { $this->getDialect()->delete($pk); } + /** + * (non-PHPdoc) + * @see app/libs/IPhpBurn#order() + */ public function order() { } + /** + * (non-PHPdoc) + * @see app/libs/IPhpBurn#limit() + */ public function limit($offset = null, $limit = null) { $this->_limit = $limit == null ? $offset : $offset . ',' . $limit; } // Relationships functions + + /** + * This method gets a relationship of the model based on mapping informations + * + * @param String $name + * @param String $linkWhere + * @param Integer $offset + * @param Integer $limit + * @return PhpBURN_Core + */ + public function getRelationship($name, $linkWhere = null, $offset = null, $limit = null) { + return self::_getLink($name, $linkWhere, $offset, $limit); + } + /** + * This method gets a relationship of the model based on mapping informations + * + * @param String $name + * @param String $linkWhere + * @param Integer $offset + * @param Integer $limit + * @return PhpBURN_Core + */ public function _getLink($name, $linkWhere = null, $offset = null, $limit = null) { //Cheking if the link existis $fieldInfo = $this->getMap()->getRelationShip($name, true); @@ -434,14 +532,23 @@ abstract class PhpBURN_Core implements IPhpBurn { /** - * It puts a WHERE clause when you want to get a link with specific caracteristics + * It puts a WHERE clause when you want to get a relationship with specific caracteristics. + * If override is true then cleanup old stuff. + * + * FOR RELATIONSHIPS ONLY + * + * @example + * <code> + * $model->_linkWhere('album_id','> 10'); + * $model->getRelationship('albums'); + * </code> * * @author Kléderson Bueno <klederson@klederson.com> * @version 0.1b * - * @param $linkName - * @param $conditions - * @param $override + * @param String $linkName + * @param String $conditions + * @param Boolean $override */ public function _linkWhere($linkName, $conditions, $override = false) { if($override == true) { @@ -539,6 +646,11 @@ abstract class PhpBURN_Core implements IPhpBurn { return PhpBURN_ConnectionManager::create(PhpBURN_Configuration::getConfig($this->_package)); } + /** + * This method convert all mapped informationg (including cascating relatioinships) into a array to better manage it into views or anything you want to. + * + * @return Array + */ public function toArray() { $return = array(); foreach($this->getMap()->fields as $fieldName => $info) { app/libs/Core.php @@ -1,29 +1,60 @@ <?php +/** + * DialectManager Class + * + * This class manage the dialects for each package. + * Can be used by many ways but by default its better if you simply do not mess around ;) let the application work for you. + * + * @author Kléderson Bueno <klederson@klederson.com> + * @version 0.1a + * + */ class PhpBURN_DialectManager { + /** + * This variable storage in runtime all dialects for each kind of package. For more details + * @see getDialect() + * @var Array + */ private static $dialects = array(); + /** + * Creates a new Dialect or retreive the existing one based on the Model and Configuration. + * + * @param PhpBURN_ConfigurationItem $config + * @param PhpBURN_Core $obj + * @return PhpBURN_Dialect + */ public function create(PhpBURN_ConfigurationItem $config,PhpBURN_Core $obj) { $dialect = self::getDialect($config->dialect); - if(!$dialect) { - //Create a new dialect - + if(!$dialect) { //Loads the interface for dialect uses PhpBURN::load('Dialect.IDialect'); +// Loads the correspondent dialect based on config if(PhpBURN::load("Dialect.$config->dialect") != "error") { $className = self::getDialectClass($config->dialect); + +// Instance the dialect $dialectClass = new $className($obj); $dialect = self::$dialects[$config->package] = $dialectClass; + unset($dialectClass); } else { - exit(); + PhpBURN_Message::output('[!Cannot find dialect!]: ' . $config->dialect, PhpBURN_Message::EXCEPTION); } } return $dialect; } + /** + * Retreive the current dialect for each package + * + * @param String $package + * @return PhpBURN_Dialect + * @return Booelan + */ public function getDialect($package = null) { if(!isset(self::$dialects[$package])) { return false; @@ -31,7 +62,13 @@ class PhpBURN_DialectManager return self::$dialects[$package]; } } - + + /** + * Discover the correspondent class for the Dialect + * + * @param String $dialect + * @return unknown_type + */ private function getDialectClass($dialect = null) { $dialect = $dialect = null ? "MySQL" : $dialect; app/libs/DialectManager.php @@ -2,6 +2,10 @@ interface IPhpBurn { public function get(); + public function find(); + + public function fetch(); + public function save(); public function delete(); app/libs/IPhpBurn.php @@ -1,8 +1,21 @@ <?php PhpBURN::load('Mapping.Map'); +/** + * This class manage the map controller. + * It is the main responsable for create and delegate the maps into the models. + * Can be used by many ways but by default its better if you simply do not mess around ;) let the application work for you. + * + * @author Kléderson Bueno <klederson@klederson.com> + * @version 0.1a + */ class PhpBURN_Mapping { + /** + * This variable storage in runtime all maps for each kind of model. For more details + * @see getMapping() + * @var Array + */ private static $mapping = array(); /** @@ -10,7 +23,7 @@ class PhpBURN_Mapping * If the map already exists it just return it ( caching ) * * @param PhpBURN_Core $modelObj - * @return unknown + * @return PhpBURN_Map */ public function create(PhpBURN_Core &$modelObj,$fromMulti = false) { $mapObj = self::getMapping(get_class($modelObj)); @@ -24,7 +37,6 @@ class PhpBURN_Mapping $mapObj = new PhpBURN_Map($modelObj); self::addMap($modelObj,$mapObj); - /* if(count($parentMaps) > 0 && $fromMulti != false) { //Prepare multi-map item @@ -57,7 +69,13 @@ class PhpBURN_Mapping return $mapObj; } - + + /** + * It verify if the model is a Child of other model + * + * @param PhpBURN_Core $modelObj + * @return Boolean + */ private function isChild(PhpBURN_Core &$modelObj) { if(get_parent_class($modelObj) != 'PhpBURN_Core') { return true; app/libs/Mapping.php @@ -323,10 +323,11 @@ class PhpBURN_Map implements IMap { } /** - * This sets the value in a field based in name, value and mappinginfo + * This sets the value in a field based in name, value and Mapping Info * * @param String $field * @param unknown_type $value + * @access public */ public function setFieldValue($field,$value) { $fields = new ArrayObject($this->fields); @@ -335,7 +336,7 @@ class PhpBURN_Map implements IMap { PhpBURN_Message::output("[!This field doesn't exist in the Mapping!]: <strong>". get_class($this->modelObj) ."->$field </strong>", PhpBURN_Message::WARNING); } - $this->fields[$field]['#value'] = $value; + $this->fields[$field]['#value'] = $this->getModel()->$field = $value; $this->getFieldValue($field); } app/libs/Mapping/Map.php @@ -1,13 +1,4 @@ <?php -/** - * This class manages all internal messages into the system - * from the LOG messages until EXCEPTIONS throught files, - * browser, database or even FirePHP - * - * @author Kléderson Bueno <klederson@klederson.com> - * @version 0.1a - */ - //Loading needed libs PhpBURN::load('Extras.Views.Views'); @@ -16,6 +7,14 @@ if(SYS_USE_FIREPHP == true) { PhpBURN::load('FirePHPCore.fb'); } +/** + * This class manages all internal messages into the system + * from the LOG messages until EXCEPTIONS throught files, + * browser, database or even FirePHP + * + * @author Kléderson Bueno <klederson@klederson.com> + * @version 0.1a + */ class PhpBURN_Message { /* MODE */ @@ -44,6 +43,11 @@ class PhpBURN_Message { */ public $databaseModel; + /** + * Turn the Message system on and set the mode + * + * @param Integer $mode + */ public function setMode($mode = self::BROWSER) { self::$mode = $mode; } @@ -57,20 +61,27 @@ class PhpBURN_Message { self::$databaseModel = $databaseModel; } + /** + * Defines the name for the log file + * + * @param String $name + */ public function setFileName($name) { self::$fileName = $name; } + public function setMessageLevel($level = self::NOTICE) { self::$messageLevel = $level; } /** - * Main function of Messaging System - * @param $originalMessage - * @param $mode - * @param $type - * @return unknown_type + * Main function of Messaging System. It outputs a message based on the mode defined. + * + * @param String $originalMessage + * @param String $type + * @return String + * @return Boolean */ public function output($originalMessage, $type = self::NOTICE) { if(self::$mode == null) { app/libs/Message.php @@ -17,6 +17,9 @@ define('PHPBURN_INCLUDE_PATH', dirname(__FILE__), true); abstract class PhpBURN { /** * This method loads internals classes as Configuration, Exceptions, Connection, etc. + * + * @author Kléderson Bueno <klederson@klederson.com> + * @access public */ public static function load() { $args = func_get_args(); @@ -39,8 +42,17 @@ abstract class PhpBURN { /** * This method loads model(s) from packages - * @example PhpBURN::import('package.Model'); - * @example PhpBURN::import('package.subpackage.SubModel'); + * + * @example + * <code> + * PhpBURN::import('package.Model'); + * </code> + * @example + * <code> + * PhpBURN::import('package.subpackage.SubModel'); + * </code> + * + * @access public */ public static function import() { $args = func_get_args(); @@ -69,7 +81,8 @@ abstract class PhpBURN { * PhpBURN::loadXMLMapping('phpburn.super.model.Users'); * Will look for phpburn directory / super / model / mapping / Users.xml * - * @return unknown + * @return String + * @return Boolean */ public static function loadXMLMapping() { $args = func_get_args(); app/phpBurn.php @@ -10,7 +10,7 @@ $config = new PhpBURN_Configuration($thisConfig); //Importing the package file PhpBURN::import('webinsys.Users'); - +/* //Instanciate the object $user = new Users(); @@ -52,10 +52,11 @@ while($user->fetch()) { print "<br/><br/>"; } print "</pre>"; - +*/ $user2 = new Users(); -$user2->name = "Oi"; -$user2->find(); +$user2->get(2); + +print_r($user2->toArray()); print "<hr>Memory Usage: "; print memory_get_usage()/1024 . " Kb"; example_application/sandbox.php 818da4d360d25709322d1361d392f6baa99ecb13 Klederson Bueno klederson@klederson.com http://github.com/klederson/phpburn/commit/a17b05556d462abea3e85536eb1fbd207c2c9b95 a17b05556d462abea3e85536eb1fbd207c2c9b95 2009-07-03T14:52:06-07:00 2009-07-03T14:52:06-07:00 Added some inCode documentation for methods classes and stuff 951100a0a447f663f9d4985c9de8b8f91997049e Klederson Bueno klederson@klederson.com