This class contains functions for database interaction based on MySQL in
CONTENIDO.
Configurable via global $cfg['db']['connection'] configuration as
follows:
- host (string) Hostname or ip (with port, e.g. "example.com:3307")
- database (string) Database name
- user (string) User name
- password (string) User password
- charset (string) Optional, connection charset
see http://php.net/manual/en/function.mysql-connect.php
Methods summary
public
boolean
|
#
check( )
Abstract method for checking database driver base functions. If this check
fails, the database connection will not be established.
Abstract method for checking database driver base functions. If this check
fails, the database connection will not be established.
Returns
boolean
See
|
public
object|resource|integer|null
|
#
connect( )
Connects to the database.
Connects to the database.
Returns
object|resource|integer|null
value depends on used driver and is NULL in case of an error
See
|
public
string
|
#
buildInsert( string $tableName, array $fields )
Builds a insert query. String values in passed fields parameter will be
escaped automatically.
Builds a insert query. String values in passed fields parameter will be
escaped automatically.
Parameters
- $tableName
string
$tableName The table name- $fields
array
$fields Associative array of fields to insert Returns
string
The INSERT SQL query
See
|
public
string
|
#
buildUpdate( string $tableName, array $fields, array $whereClauses )
Builds a update query. String values in passed fields and whereClauses
parameter will be escaped automatically.
Builds a update query. String values in passed fields and whereClauses
parameter will be escaped automatically.
Parameters
- $tableName
string
$tableName The table name- $fields
array
$fields Assoziative array of fields to update- $whereClauses
array
$whereClauses Assoziative array of field in where clause. Multiple entries will
be concatenated with AND. Returns
string
The UPDATE query
See
|
public
|
#
query( string $query )
Executes the query.
Parameters
- $query
string
$statement The query to execute See
|
public
integer
|
#
nextRecord( )
Moves the result to the next record, if exists and returns the status of the
movement
Moves the result to the next record, if exists and returns the status of the
movement
Returns
integer
Flag about move status 1 on success or 0
See
|
public
Ambigous
|
#
getResultObject( string $className = NULL )
This method returns the current result set as object or NULL if no result set
is left. If optional param $className is set, the result object is an instance
of class $className.
This method returns the current result set as object or NULL if no result set
is left. If optional param $className is set, the result object is an instance
of class $className.
Parameters
- $className
string
$className [optional] Returns
Ambigous
<NULL, object, false>
See
|
public
integer
|
#
affectedRows( )
Returns number of affected rows from last executed query (update, delete)
Returns number of affected rows from last executed query (update, delete)
Returns
integer
Number of affected rows
See
|
public
integer
|
#
numRows( )
Returns the number of rows from last executed select query.
Returns the number of rows from last executed select query.
Returns
integer
The number of rows from last select query result
See
|
public
integer
|
#
numFields( )
Returns the number of fields (columns) from current record set
Returns the number of fields (columns) from current record set
Returns
integer
Number of fields
See
|
public
|
#
free( )
Discard the query result
See
|
public
string
|
#
escape( string $string )
Escape string for using in SQL-Statement.
Escape string for using in SQL-Statement.
Parameters
- $string
string
$string The string to escape Returns
string
Escaped string
See
|
public
integer
|
#
seek( integer $pos = 0 )
Moves the cursor (position inside current result sets).
Moves the cursor (position inside current result sets).
Parameters
- $pos
integer
$pos [optional] The positon to move to inside the current result set Returns
integer
See
|
public
array
|
#
getMetaData( string $tableName, boolean $full = false )
Parses the table structure and generates metadata from it.
Parses the table structure and generates metadata from it.
Due to compatibility problems with table we changed the behavior of
metadata(). Depending on $full, metadata returns the following values:
$result[]: [0]["table"] table name [0]["name"] field name [0]["type"] field
type [0]["len"] field length [0]["flags"] field flags
$result[]: ["num_fields"] number of metadata records [0]["table"] table name
[0]["name"] field name [0]["type"] field type [0]["len"] field length
[0]["flags"] field flags ["meta"][field name] index of field named "field name"
This last one could be used if you have a field name, but no index. Test: if
(isset($result['meta']['myfield'])) { ...
Parameters
- $tableName
string
$tableName The table to get metadata or empty string to retrieve metadata of all
tables.- $full
boolean
$full [optional] Flag to load full metadata. Returns
array
Depends on used database and on parameter $full
See
|
public
array
|
|
public
array
|
#
getServerInfo( )
Fetches server information.
Fetches server information.
Returns
array
See
|
public
integer
|
#
getErrorNumber( )
Returns error code of last occured error by using databases interface.
Returns error code of last occured error by using databases interface.
Returns
integer
See
|
public
string
|
#
getErrorMessage( )
Returns error message of last occured error by using databases interface.
Returns error message of last occured error by using databases interface.
Returns
string
See
|
public
|
#
disconnect( )
Closes the connection and frees the query id.
Closes the connection and frees the query id.
See
|
cDbDriverMysql