Source for file jDbTools.class.php

Documentation is available at jDbTools.class.php

<?php
/**
* @package jelix
* @subpackage db
* @author Gérald Croes, Laurent Jouanneau
* @contributor Laurent Jouanneau, Gwendal Jouannic, Julien Issler
*
* This class was get originally from the Copix project (CopixDbTools, CopixDbConnection, Copix 2.3dev20050901, http://www.copix.org)
* Some lines of code are still copyrighted 2001-2005 CopixTeam (LGPL licence).
* Initial authors of this Copix classes are Gerald Croes and Laurent Jouanneau,
* and this class was adapted for Jelix by Laurent Jouanneau
*
* @link http://www.jelix.org
* @licence http://www.gnu.org/licenses/lgpl.html GNU Lesser General Public Licence, see LICENCE file
*/
/**
* Description of a field of a table
* @package jelix
* @subpackage db
* @see jDbTools::getFieldList
*/
class jDbFieldProperties {
/**
* native type of the field
* @var string
*/
public $type;
/**
* unified type of the field
* @var string
*/
public $unifiedtype;
/**
* field name
* @var string
*/
public $name;
/**
* says if the field can be null or not
* @var boolean
*/
public $notNull=true;
/**
* says if the field is the primary key
* @var boolean
*/
public $primary=false;
/**
* says if the field is auto incremented
* @var boolean
*/
public $autoIncrement=false;
/**
* default value
* @var string
*/
public $default='';
/**
* says if there is a default value
* @var boolean
*/
public $hasDefault = false;
public $length = 0;
/**
* if there is a sequence
* @var string
*/
public $sequence = false;
public $unsigned = false;
public $minLength = null;
public $maxLength = null;
public $minValue = null;
public $maxValue = null;
}
/**
* Provides utilities methods for a database
* @package jelix
* @subpackage db
*/
abstract class jDbTools {
public $trueValue = '1';
public $falseValue = '0';
/**
* the database connector
* @var jDbConnection
*/
protected $_conn;
/**
* @param jDbConnection $connector the connection to a database
*/
function __construct($connector = null){
$this->_conn = $connector;
}
protected $unifiedToPhp = array(
'boolean'=>'boolean',
'integer'=>'integer',
'float'=>'float',
'double'=>'float',
'numeric'=>'numeric',
'decimal'=>'decimal',
'date'=>'string',
'time'=>'string',
'datetime'=>'string',
'year'=>'string',
'char'=>'string',
'varchar'=>'string',
'text'=>'string',
'blob'=>'string',
'binary'=>'string',
'varbinary'=>'string',
);
protected $typesInfo = array();
/**
* Get informations about the given SQL type
* @param string $nativeType the SQL type
* @return array an array which contains characteristics of the type
* array ( 'nativetype', 'corresponding unifiedtype', minvalue, maxvalue, minlength, maxlength)
* minvalue, maxvalue, minlength, maxlength can be null.
* @since 1.2
*/
public function getTypeInfo($nativeType) {
if(isset($this->typesInfo[$nativeType])) {
$r = $this->typesInfo[$nativeType];
}
else
$r = $this->typesInfo['varchar'];
$r[] = ($nativeType == 'serial' || $nativeType == 'bigserial' || $nativeType == 'autoincrement' || $nativeType == 'bigautoincrement');
return $r;
}
/**
* Return the PHP type corresponding to the given unified type
* @param string $unifiedType
* @return string the php type
* @since 1.2
*/
public function unifiedToPHPType($unifiedType) {
if(isset($this->unifiedToPhp[$unifiedType])) {
return $this->unifiedToPhp[$unifiedType];
}
throw new Exception('bad unified type name:' . $unifiedType);
}
/**
* @param string $unifiedType the unified type name
* @param string $value the value
* @return string the php value corresponding to the type
* @since 1.2
*/
public function stringToPhpValue($unifiedType, $value, $checkNull = false) {
if($checkNull && ($value === null ||strtolower($value)=='null'))
return null;
switch($this->unifiedToPHPType($unifiedType)) {
case 'boolean':
return ($this->getBooleanValue($value) == $this->trueValue);
case 'integer':
return intval($value);
case 'float':
return floatval($value);
case 'numeric':
case 'decimal':
if(is_numeric($value))
return $value;
else
return floatval($value);
default:
return $value;
}
}
/**
* @param string $unifiedType the unified type name
* @param mixed $value the value
* @return string the value which is ready to include a SQL query string
* @since 1.2
*/
public function escapeValue($unifiedType, $value, $checkNull = false, $toPhpSource = false) {
if($checkNull && ($value === null ||strtolower($value)=='null'))
return 'NULL';
switch($this->unifiedToPHPType($unifiedType)) {
case 'boolean':
return $this->getBooleanValue($value);
case 'integer':
return (string)intval($value);
case 'float':
case 'numeric':
case 'decimal':
return jDb::floatToStr($value);
default:
if ($toPhpSource) {
if ($unifiedType == 'varbinary' || $unifiedType == 'binary') {
return '\'.$this->_conn->quote2(\''.str_replace('\'','\\\'',$value).'\',true,true).\'';
}
else if(strpos($value,"'") !== false) {
return '\'.$this->_conn->quote(\''.str_replace('\'','\\\'',$value).'\').\'';
}
else {
return "\\'".$value."\\'";
}
}
elseif ($this->_conn)
return $this->_conn->quote($value);
else
return "'".addslashes($value)."'";
}
}
/**
* @param string|boolean$value a value which is a boolean
* @return string the string value representing a boolean in SQL
* @since 1.2
*/
public function getBooleanValue($value) {
if(is_string($value))
$value = strtolower($value);
if ($value === 'true' || $value === true || intval($value) === 1 || $value === 't' || $value === 'on')
return $this->trueValue;
else
return $this->falseValue;
}
/**
* Rnclose the field name
* @param string $fieldName the field name
* @return string the enclosed field name
* @since 1.2
*/
public function encloseName($fieldName){
return $fieldName;
}
/**
* <teturns the table list
*/
abstract public function getTableList ();
/**
* Retrieve the list of fields of a table
* @param string $tableName the name of the table
* @param string $sequence the sequence used to auto increment the primary key
* @return array keys are field names and values are jDbFieldProperties objects
*/
abstract public function getFieldList ($tableName, $sequence='');
/**
* regular expression to detect comments and end of query
*/
protected $dbmsStyle = array('/^\s*#/', '/;\s*$/');
public function execSQLScript ($file) {
if(!isset($this->_conn->profile['table_prefix']))
$prefix = '';
else
$prefix = $this->_conn->profile['table_prefix'];
$lines = file($file);
$cmdSQL = '';
$nbCmd = 0;
$style = $this->dbmsStyle;
foreach ((array)$lines as $key=>$line) {
if ((!preg_match($style[0],$line))&&(strlen(trim($line))>0)) { // The line isn't empty and isn't a comment
//$line = str_replace("\\'","''",$line);
//$line = str_replace($this->scriptReplaceFrom, $this->scriptReplaceBy,$line);
$cmdSQL.=$line;
if (preg_match($style[1],$line)) {
// If at the last line of the command, execute it
// Cleanup the command from the ending ";" and execute it
$cmdSQL = preg_replace($style[1],'',$cmdSQL);
$cmdSQL = str_replace('%%PREFIX%%', $prefix, $cmdSQL);
$this->_conn->exec ($cmdSQL);
$nbCmd++;
$cmdSQL = '';
}
}
}
return $nbCmd;
}
}

Documentation generated on Mon, 26 Oct 2015 21:53:24 +0100 by phpDocumentor 1.4.3