Ubiquity  2.0.3
php rapid development framework
Database Class Reference

Public Member Functions

 __construct ($dbType, $dbName, $serverName="localhost", $port="3306", $user="root", $password="", $options=[], $cache=false)
 Constructor. More...
 
 connect ()
 Creates the PDO instance and realize a safe connection. More...
 
 _connect ()
 
 getDSN ()
 
 query ($sql)
 Executes an SQL statement, returning a result set as a PDOStatement object. More...
 
 prepareAndExecute ($tableName, $condition, $fields, $useCache=NULL)
 
 execute ($sql)
 Execute an SQL statement and return the number of affected rows (INSERT, UPDATE or DELETE) More...
 
 getServerName ()
 
 setServerName ($serverName)
 
 prepareStatement ($sql)
 Prepares a statement for execution and returns a statement object. More...
 
 bindValueFromStatement (\PDOStatement $statement, $parameter, $value)
 Sets $value to $parameter. More...
 
 lastInserId ()
 Returns the last insert id. More...
 
 getTablesName ()
 
 count ($tableName, $condition='')
 Returns the number of records in $tableName that respects the condition passed as a parameter. More...
 
 queryColumn ($query)
 
 isConnected ()
 
 setDbType ($dbType)
 
 ping ()
 
 getPort ()
 
 getDbName ()
 
 getUser ()
 
 getPdoObject ()
 

Static Public Member Functions

static getAvailableDrivers ()
 

Private Member Functions

 getStatement ($sql)
 

Private Attributes

 $dbType
 
 $serverName
 
 $port
 
 $dbName
 
 $user
 
 $password
 
 $pdoObject
 
 $statements = [ ]
 
 $cache
 
 $options
 

Detailed Description

Definition at line 16 of file Database.php.

Constructor & Destructor Documentation

◆ __construct()

__construct (   $dbType,
  $dbName,
  $serverName = "localhost",
  $port = "3306",
  $user = "root",
  $password = "",
  $options = [],
  $cache = false 
)

Constructor.

Parameters
string$dbName
string$serverName
string$port
string$user
string$password
array$options
boolean | string$cache

Definition at line 39 of file Database.php.

Member Function Documentation

◆ _connect()

_connect ( )

Definition at line 75 of file Database.php.

◆ bindValueFromStatement()

bindValueFromStatement ( \PDOStatement  $statement,
  $parameter,
  $value 
)

Sets $value to $parameter.

Parameters
\PDOStatement$statement
String$parameter
mixed$value
Returns
boolean

Definition at line 170 of file Database.php.

◆ connect()

connect ( )

Creates the PDO instance and realize a safe connection.

Returns
boolean true if connection is established

Definition at line 66 of file Database.php.

◆ count()

count (   $tableName,
  $condition = '' 
)

Returns the number of records in $tableName that respects the condition passed as a parameter.

Parameters
string$tableName
string$conditionPartie suivant le WHERE d'une instruction SQL

Definition at line 196 of file Database.php.

◆ execute()

execute (   $sql)

Execute an SQL statement and return the number of affected rows (INSERT, UPDATE or DELETE)

Parameters
string$sql
Returns
int the number of rows that were modified or deleted by the SQL statement you issued

Definition at line 140 of file Database.php.

◆ getAvailableDrivers()

static getAvailableDrivers ( )
static

Definition at line 235 of file Database.php.

◆ getDbName()

getDbName ( )

Definition at line 223 of file Database.php.

◆ getDSN()

getDSN ( )

Definition at line 80 of file Database.php.

◆ getPdoObject()

getPdoObject ( )

Definition at line 231 of file Database.php.

◆ getPort()

getPort ( )

Definition at line 219 of file Database.php.

◆ getServerName()

getServerName ( )

Definition at line 144 of file Database.php.

◆ getStatement()

getStatement (   $sql)
private
Parameters
string$sql
Returns

Definition at line 126 of file Database.php.

◆ getTablesName()

getTablesName ( )

Definition at line 183 of file Database.php.

◆ getUser()

getUser ( )

Definition at line 227 of file Database.php.

◆ isConnected()

isConnected ( )

Definition at line 206 of file Database.php.

◆ lastInserId()

lastInserId ( )

Returns the last insert id.

Returns
integer

Definition at line 179 of file Database.php.

◆ ping()

ping ( )

Definition at line 215 of file Database.php.

◆ prepareAndExecute()

prepareAndExecute (   $tableName,
  $condition,
  $fields,
  $useCache = NULL 
)
Parameters
string$tableName
string$condition
array | string$fields
boolean | null$useCache
Returns
array

Definition at line 102 of file Database.php.

◆ prepareStatement()

prepareStatement (   $sql)

Prepares a statement for execution and returns a statement object.

Parameters
String$sql
Returns

Definition at line 158 of file Database.php.

◆ query()

query (   $sql)

Executes an SQL statement, returning a result set as a PDOStatement object.

Parameters
string$sql
Returns

Definition at line 90 of file Database.php.

◆ queryColumn()

queryColumn (   $query)

Definition at line 202 of file Database.php.

◆ setDbType()

setDbType (   $dbType)

Definition at line 210 of file Database.php.

◆ setServerName()

setServerName (   $serverName)

Definition at line 148 of file Database.php.

Field Documentation

◆ $cache

$cache
private

Definition at line 25 of file Database.php.

◆ $dbName

$dbName
private

Definition at line 20 of file Database.php.

◆ $dbType

$dbType
private

Definition at line 17 of file Database.php.

◆ $options

$options
private

Definition at line 26 of file Database.php.

◆ $password

$password
private

Definition at line 22 of file Database.php.

◆ $pdoObject

$pdoObject
private

Definition at line 23 of file Database.php.

◆ $port

$port
private

Definition at line 19 of file Database.php.

◆ $serverName

$serverName
private

Definition at line 18 of file Database.php.

◆ $statements

$statements = [ ]
private

Definition at line 24 of file Database.php.

◆ $user

$user
private

Definition at line 21 of file Database.php.


The documentation for this class was generated from the following file: