Source for file jDb.class.php

Documentation is available at jDb.class.php

<?php
/**
* @package jelix
* @subpackage db
* @author Laurent Jouanneau
* @contributor Yannick Le Guédart, Laurent Raufaste, Julien Issler
*
* API ideas of this class were get originally from the Copix project (CopixDbFactory, Copix 2.3dev20050901, http://www.copix.org)
* No lines of code are copyrighted by CopixTeam
*
* @link http://www.jelix.org
* @licence http://www.gnu.org/licenses/lgpl.html GNU Lesser General Public Licence, see LICENCE file
*/
/**
*
*/
require(JELIX_LIB_PATH.'db/jDbConnection.class.php');
require(JELIX_LIB_PATH.'db/jDbResultSet.class.php');
/**
* class that handles a sql query for a logger
*/
class jSQLLogMessage extends jLogMessage {
protected $startTime = 0;
protected $endTime = 0;
protected $trace = array();
public function __construct($message) {
$this->category = 'sql';
$this->message = $message;
$this->startTime = microtime(true);
$this->trace = debug_backtrace();
array_shift($this->trace); // remove the current __construct call
}
public function endQuery() {
$this->endTime = microtime(true);
}
public function getTrace() {
return $this->trace;
}
public function getTime() {
return $this->endTime - $this->startTime;
}
public function getDao() {
foreach ($this->trace as $t) {
if (isset($t['class'])) {
$dao = '';
$class = $t['class'];
if ($class == 'jDaoFactoryBase') {
if (isset($t['object'])) {
$class = get_class($t['object']);
}
else {
$class = 'jDaoFactoryBase';
$dao = 'unknow dao, jDaoFactoryBase';
}
}
if(preg_match('/^cDao_(.+)_Jx_(.+)_Jx_(.+)$/', $class, $m)) {
$dao = $m[1].'~'.$m[2];
}
if ($dao && isset($t['function'])) {
$dao.= '::'.$t['function'].'()';
}
if($dao)
return $dao;
}
}
return '';
}
public function getFormatedMessage() {
$message = $this->message."\n".$this->getTime().'ms';
$dao = $this->getDao();
if ($dao)
$message.=', from dao:'.$dao."\n";
$traceLog="";
foreach($this->trace as $k=>$t){
$traceLog.="\n\t$k\t".(isset($t['class'])?$t['class'].$t['type']:'').$t['function']."()\t";
$traceLog.=(isset($t['file'])?$t['file']:'[php]').' : '.(isset($t['line'])?$t['line']:'');
}
return $message.$traceLog;
}
}
/**
* factory for database connector and other db utilities
* @package jelix
* @subpackage db
*/
class jDb {
/**
* return a database connector. It uses a temporay pool of connection to reuse
* currently opened connections.
*
* @param string $name profile name to use. if empty, use the default one
* @return jDbConnection the connector
*/
public static function getConnection ($name = '') {
return jProfiles::getOrStoreInPool('jdb', $name, array('jDb', '_createConnector'));
}
/**
* create a new jDbWidget
* @param string $name profile name to use. if empty, use the default one
* @return jDbWidget
*/
public static function getDbWidget ($name = null) {
$dbw = new jDbWidget(self::getConnection($name));
return $dbw;
}
/**
* instancy a jDbTools object. Use jDbConnection::tools() instead.
* @param string $name profile name to use. if empty, use the default one
* @return jDbTools
* @deprecated since 1.2
*/
public static function getTools ($name = null) {
$cnx = self::getConnection ($name);
return $cnx->tools();
}
/**
* load properties of a connector profile
*
* a profile is a section in the profiles.ini.php file
*
* the given name can be a profile name (it should correspond to a section name
* in the ini file), or an alias of a profile. An alias is a parameter name
* in the global section of the ini file, and the value of this parameter
* should be a profile name.
*
* @param string $name profile name or alias of a profile name. if empty, use the default profile
* @param boolean $noDefault if true and if the profile doesn't exist, throw an error instead of getting the default profile
* @return array properties
* @deprecated use jProfiles::get instead
*/
public static function getProfile ($name='', $noDefault = false) {
return jProfiles::get('jdb', $name, $noDefault);
}
/**
* call it to test a profile (during an install for example)
* @param array $profile profile properties
* @return boolean true if properties are ok
*/
public function testProfile ($profile) {
try {
self::_createConnector ($profile);
$ok = true;
}
catch(Exception $e) {
$ok = false;
}
return $ok;
}
/**
* create a connector. internal use (callback method for jProfiles)
* @param array $profile profile properties
* @return jDbConnection|jDbPDOConnection database connector
*/
public static function _createConnector ($profile) {
if ($profile['driver'] == 'pdo' || (isset($profile['usepdo']) && $profile['usepdo'])) {
$dbh = new jDbPDOConnection($profile);
return $dbh;
}
else {
$dbh = jApp::loadPlugin($profile['driver'], 'db', '.dbconnection.php', $profile['driver'].'DbConnection', $profile);
if (is_null($dbh))
throw new jException('jelix~db.error.driver.notfound', $profile['driver']);
return $dbh;
}
}
/**
* create a temporary new profile
* @param string $name the name of the profile
* @param array|string$params parameters of the profile. key=parameter name, value=parameter value.
* same kind of parameters we found in profiles.ini.php
* we can also indicate a name of an other profile, to create an alias
* @deprecated since 1.3, use jProfiles::createVirtualProfile instead
*/
public static function createVirtualProfile ($name, $params) {
jProfiles::createVirtualProfile('jdb',$name, $params);
}
/**
* clear the loaded profiles to force to reload the db profiles file.
* WARNING: it closes all opened connections !
* @since 1.2
* @deprecated since 1.3, use jProfiles::clear instead
*/
public static function clearProfiles() {
jProfiles::clear();
}
/**
* perform a convertion float to str. It takes care about the decimal separator
* which should be a '.' for SQL. Because when doing a native convertion float->str,
* PHP uses the local decimal separator, and so, we don't want that.
* @since 1.1.11
*/
public static function floatToStr($value) {
if (is_float($value)) // this is a float
return rtrim(sprintf('%.20F', $value), '0'); // %F to not format with the local decimal separator
else if (is_integer($value))
return sprintf('%d', $value);
// this is probably a string, so we expect that it contains a numerical value
// is_numeric is true if the separator is ok for SQL
// (is_numeric doesn't accept thousand separators nor other character than '.' as decimal separator)
else if (is_numeric($value))
return $value;
// we probably have a malformed float number here
// if so, floatval will ignore all character after an invalid character (a ',' for example)
// no warning, no exception here, to keep the same behavior of previous Jelix version
// in order to no break stable applications.
// FIXME: do a warning in next versions (> 1.2)
return (string)(floatval($value));
}
}

Documentation generated on Mon, 19 Sep 2011 14:12:25 +0200 by phpDocumentor 1.4.3