Overview

Packages

  • CONTENIDO
  • Core
    • Authentication
    • Backend
    • Cache
    • CEC
    • Chain
    • ContentType
    • Database
    • Debug
    • Exception
    • Frontend
      • Search
      • URI
      • Util
    • GenericDB
      • Model
    • GUI
      • HTML
    • I18N
    • LayoutHandler
    • Log
    • Security
    • Session
    • Util
    • Validation
    • Versioning
    • XML
  • Module
    • ContentRssCreator
    • ContentSitemapHtml
    • ContentSitemapXml
    • ContentUserForum
    • NavigationTop
    • ScriptCookieDirective
  • mpAutoloaderClassMap
  • None
  • Plugin
    • ContentAllocation
    • CronjobOverview
    • FormAssistant
    • FrontendLogic
    • FrontendUsers
    • Linkchecker
    • ModRewrite
    • Newsletter
    • Repository
      • FrontendNavigation
      • KeywordDensity
    • SearchSolr
    • SmartyWrapper
    • UrlShortener
    • UserForum
    • Workflow
  • PluginManager
  • Setup
    • Form
    • GUI
    • Helper
      • Environment
      • Filesystem
      • MySQL
      • PHP
    • UpgradeJob

Classes

  • cDb
  • cDbDriverAbstract
  • cDbDriverHandler
  • cDbDriverMysql
  • cDbDriverMysqli

Exceptions

  • cDbException
  • Overview
  • Package
  • Class
  • Tree
  • Deprecated
  • Todo

Class cDbDriverMysqli

This class contains functions for database interaction based on MySQLi in CONTENIDO.

Configurable via global $cfg['db']['connection'] configuration as follows:

- host (string) Hostname or ip
- database (string) Database name
- user (string) User name
- password (string) User password
- options (array) Optional, MySQLi options array
- socket (int) Optional, socket
- port (int) Optional, port
- flags (int) Optional, flags
- charset (string) Optional, connection charset
see http://www.php.net/manual/en/mysqli.real-connect.php
cDbDriverAbstract
Extended by cDbDriverMysqli
Package: Core\Database
Copyright: four for business AG <www.4fb.de>
License: http://www.contenido.org/license/LIZENZ.txt
Author: Dominik Ziegler
Located at classes/db/class.db.driver.mysqli.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

cDbDriverAbstract::check()
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

cDbDriverAbstract::connect()
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

cDbDriverAbstract::buildInsert()
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

cDbDriverAbstract::buildUpdate()
public
# query( string $query )

Executes the query.

Executes the query.

Parameters

$query
string
$query The query to execute

See

cDbDriverAbstract::query()
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

cDbDriverAbstract::nextRecord()
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

cDbDriverAbstract::getResultObject()
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

cDbDriverAbstract::affectedRows()
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

cDbDriverAbstract::numRows()
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

cDbDriverAbstract::numFields()
public |cDbDriverMysqli
# free( )

Discard the query result

Discard the query result

Returns

|cDbDriverMysqli
If aggregated handler has no query id, this object is returned, otherwise void.

See

cDbDriverAbstract::free()

Todo

check if $this should be returned
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

cDbDriverAbstract::escape()
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

cDbDriverAbstract::seek()
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:

  • full is false (default):

$result[]: [0]["table"] table name [0]["name"] field name [0]["type"] field type [0]["len"] field length [0]["flags"] field flags

  • full is true

$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

cDbDriverAbstract::getMetaData()
public array
# getTableNames( )

Fetches all table names.

Fetches all table names.

Returns

array

See

cDbDriverAbstract::getTableNames()
public array
# getServerInfo( )

Fetches server information.

Fetches server information.

Returns

array

See

cDbDriverAbstract::getServerInfo()
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

cDbDriverAbstract::getErrorNumber()
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

cDbDriverAbstract::getErrorMessage()
public
# disconnect( )

Closes the connection and frees the query id.

Closes the connection and frees the query id.

See

cDbDriverAbstract::disconnect()
Methods inherited from cDbDriverAbstract
__construct(), getHandler(), setHandler()
Properties summary
protected array $_dataTypes array( 0 => 'decimal', 1 => 'tinyint', 2 => 'smallint', 3 => 'int', 4 => 'float', 5 => 'double', 7 => 'timestamp', 8 => 'bigint', 9 => 'mediumint', 10 => 'date', 11 => 'time', 12 => 'datetime', 13 => 'year', 252 => 'blob', // text, blob, tinyblob,mediumblob, etc... 253 => 'string', // varchar and char 254 => 'enum' )
#

List of data types.

List of data types.

Properties inherited from cDbDriverAbstract
$_dbCfg, $_handler
CMS CONTENIDO 4.9.11 API documentation generated by ApiGen 2.8.0