PDODBConnection Class Reference

PDO Database connection object. More...

Inheritance diagram for PDODBConnection:

Public Member Functions
	connect_server ($host='localhost', $login='', $pwd='', $driver='')
	disconnect_server ()
	get_serverVersion ()
	select_database ($name)
	create_database ($name, $charset='utf8')
	database_exists ($name)
	dump_database ($file=false)
	get_databaseSize ()
	get_databaseSummary ()
	get_tableList ()
	create_table ($name, $fields, $charset='utf8', $autoId=true, $primaryKeys=array('id'))
	execute_query ($sql='', $resName='defaultRes')
	execute_multiQueries ($sql='', $resName='defaultRes')
	get_queryGeneratedId ($resName='defaultRes')
	get_queryDataLine ($resName='defaultRes')
	get_queryNumDataLine ($resName='defaultRes')
	get_queryError ($resName='defaultRes')
	get_queryAffectedRows ($resName='defaultRes')
	get_queryFieldCount ($resName='defaultRes')
	get_queryFieldType ($fIndex=0, $resName='defaultRes')
	close_ressource ($resName='defaultRes')
	escape_string ($string)
Public Member Functions inherited from CDBConnection
	__construct ()
	is_connectionActive ()
	check_status ($name)
	get_insertExtra ()

Private Member Functions
	get_compatibleType ($type='default')

Additional Inherited Members
Protected Member Functions inherited from CDBConnection
	get_resName ()
Protected Attributes inherited from CDBConnection
	$active = false
	CDBConnection status. More...
	$connection = null
	CDBConnection database ressource. More...
	$queryRes = array()
	Query ressources. More...
	$dbName = null
	Name of the database. More...

Detailed Description

PDO Database connection object.

Engine / Object Library

Author

CaMykS Team camyk.nosp@m.s.co.nosp@m.ntact.nosp@m.@gma.nosp@m.il.co.nosp@m.m

Version

1.0.1

Date

Creation: Sep 2014

Modification: Sep 2020

Copyright

2014 - 2020 CaMykS Team

Note

This program is distributed as is - WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. PDODBConnection class.

Member Function Documentation

connect_server()

PDODBConnection::connect_server	(		$host = 'localhost',
			$login = '',
			$pwd = '',
			$driver = ''
	)

Connect to server.

Parameters

string	$host
string	$login
string	$pwd
string	$driver

Returns

boolean success

Reimplemented from CDBConnection.

disconnect_server()

PDODBConnection::disconnect_server

(

)

Close server connection.

Returns

boolean success

Reimplemented from CDBConnection.

get_serverVersion()

PDODBConnection::get_serverVersion

(

)

Return database engine version.

Returns

string

Reimplemented from CDBConnection.

select_database()

PDODBConnection::select_database

(

$name

)

Select database.

Parameters

string

$name

the database name

Returns

boolean

Reimplemented from CDBConnection.

create_database()

PDODBConnection::create_database	(		$name,
			$charset = 'utf8'
	)

Create a database.

Parameters

string	$name
string	$charset

Returns

boolean

Reimplemented from CDBConnection.

database_exists()

PDODBConnection::database_exists

(

$name

)

Check if a base exists.

Parameters

string

$name

Returns

boolean

Reimplemented from CDBConnection.

dump_database()

PDODBConnection::dump_database

(

$file = false

)

Dump database.

Parameters

mixed

$file

Returns

mixed

Reimplemented from CDBConnection.

get_databaseSize()

PDODBConnection::get_databaseSize

(

)

Return database size.

Returns

integer

Reimplemented from CDBConnection.

get_databaseSummary()

PDODBConnection::get_databaseSummary

(

)

Return database information summary.

Returns

array

Reimplemented from CDBConnection.

get_tableList()

PDODBConnection::get_tableList

(

)

Return available table list.

Returns

array

Reimplemented from CDBConnection.

create_table()

PDODBConnection::create_table	(		$name,
			$fields,
			$charset = 'utf8',
			$autoId = true,
			$primaryKeys = array('id')
	)

Create a table in the database.

Parameters

string	$name
array	$fields
string	$charset
boolean	$autoId
array	$primaryKeys

Returns

boolean success

Reimplemented from CDBConnection.

execute_query()

PDODBConnection::execute_query	(		$sql = '',
			$resName = 'defaultRes'
	)

Execute query.

Parameters

string	$sql
string	$resName

Returns

boolean success

Reimplemented from CDBConnection.

execute_multiQueries()

PDODBConnection::execute_multiQueries	(		$sql = '',
			$resName = 'defaultRes'
	)

Execute multiple queries at once.

Parameters

string	$sql
string	$resName

Returns

boolean success

Reimplemented from CDBConnection.

get_queryGeneratedId()

PDODBConnection::get_queryGeneratedId

(

$resName = 'defaultRes'

)

Return id generated by last query.

Parameters

string

$resName

Returns

integer

Reimplemented from CDBConnection.

get_queryDataLine()

PDODBConnection::get_queryDataLine

(

$resName = 'defaultRes'

)

Return next query data line.

Parameters

string

$resName

Returns

array

Reimplemented from CDBConnection.

get_queryNumDataLine()

PDODBConnection::get_queryNumDataLine

(

$resName = 'defaultRes'

)

Return next query data line with numeric indexes.

Parameters

string

$resName

Returns

array

Reimplemented from CDBConnection.

get_queryError()

PDODBConnection::get_queryError

(

$resName = 'defaultRes'

)

Return latest query error.

Parameters

string

$resName

Returns

string

Reimplemented from CDBConnection.

get_queryAffectedRows()

PDODBConnection::get_queryAffectedRows

(

$resName = 'defaultRes'

)

Return latest query affected rows.

Parameters

string

$resName

Returns

integer

Reimplemented from CDBConnection.

get_queryFieldCount()

PDODBConnection::get_queryFieldCount

(

$resName = 'defaultRes'

)

Return latest query field count.

Parameters

string

$resName

Returns

integer

Reimplemented from CDBConnection.

get_queryFieldType()

PDODBConnection::get_queryFieldType	(		$fIndex = 0,
			$resName = 'defaultRes'
	)

Return latest query field type.

Parameters

integer	$fIndex
string	$resName

Returns

string

Reimplemented from CDBConnection.

close_ressource()

PDODBConnection::close_ressource

(

$resName = 'defaultRes'

)

Close ressource.

Parameters

string

$resName

Returns

boolean result

Reimplemented from CDBConnection.

escape_string()

PDODBConnection::escape_string

(

$string

)

Return escaped string.

Parameters

string

$string

Returns

string

Reimplemented from CDBConnection.

get_compatibleType()

PDODBConnection::get_compatibleType (   $type = 'default' )

private

Return mysql compatible type from given type.

Parameters

integer

$type

Returns

string

MySQL can return : var_string longlong newdecimal geometry

SQLLite may return :

---

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

• CaMykS/engine/lib/object/PDODBConnection.php.inc