Graphe d'héritage de FOFDatabaseDriverMysqli:

Fonctions membres publiques
	__construct ($options)

	__destruct ()

	connect ()

	disconnect ()

	escape ($text, $extra=false)

	connected ()

	dropTable ($tableName, $ifExists=true)

	getAffectedRows ()

	getCollation ()

	getConnectionCollation ()

	getNumRows ($cursor=null)

	getTableCreate ($tables)

	getTableColumns ($table, $typeOnly=true)

	getTableKeys ($table)

	getTableList ()

	getVersion ()

	insertid ()

	lockTable ($table)

	execute ()

	renameTable ($oldTable, $newTable, $backup=null, $prefix=null)

	select ($database)

	setUtf ()

	transactionCommit ($toSavepoint=false)

	transactionRollback ($toSavepoint=false)

	transactionStart ($asSavepoint=false)

	unlockTables ()

Fonctions membres publiques hérités de FOFDatabaseDriver
	__call ($method, $args)

	__construct ($options)

	alterDbCharacterSet ($dbName)

	alterTableCharacterSet ($tableName, $rethrow=false)

	connect ()

	connected ()

	createDatabase ($options, $utf=true)

	disconnect ()

	addDisconnectHandler ($callable)

	dropTable ($table, $ifExists=true)

	escape ($text, $extra=false)

	getAffectedRows ()

	getAlterDbCharacterSet ($dbName)

	getAlterTableCharacterSet ($tableName)

	convertUtf8mb4QueryToUtf8 ($query)

	getCollation ()

	getConnectionCollation ()

	getConnection ()

	getCount ()

	getDateFormat ()

	getLog ()

	getTimings ()

	getCallStacks ()

	getMinimum ()

	getNullDate ()

	getNumRows ($cursor=null)

	getPrefix ()

	getExporter ()

	getImporter ()

	getName ()

	getServerType ()

	getQuery ($new=false)

	getIterator ($column=null, $class='stdClass')

	getTableColumns ($table, $typeOnly=true)

	getTableCreate ($tables)

	getTableKeys ($tables)

	getTableList ()

	getUTFSupport ()

	hasUTFSupport ()

	hasUTF8mb4Support ()

	getVersion ()

	insertid ()

	insertObject ($table, &$object, $key=null)

	isMinimumVersion ()

	loadAssoc ()

	loadAssocList ($key=null, $column=null)

	loadColumn ($offset=0)

	loadNextObject ($class='stdClass')

	loadNextRow ()

	loadObject ($class='stdClass')

	loadObjectList ($key='', $class='stdClass')

	loadResult ()

	loadRow ()

	loadRowList ($key=null)

	lockTable ($tableName)

	quote ($text, $escape=true)

	quoteName ($name, $as=null)

	replacePrefix ($sql, $prefix='#__')

	renameTable ($oldTable, $newTable, $backup=null, $prefix=null)

	select ($database)

	setDebug ($level)

	setQuery ($query, $offset=0, $limit=0)

	setUtf ()

	transactionCommit ($toSavepoint=false)

	transactionRollback ($toSavepoint=false)

	transactionStart ($asSavepoint=false)

	truncateTable ($table)

	updateObject ($table, &$object, $key, $nulls=false)

	execute ()

	unlockTables ()

Fonctions membres publiques hérités de FOFDatabase
	query ()

	getErrorMsg ($escaped=false)

	getErrorNum ()

	stderr ($showSQL=false)

Fonctions membres publiques statiques
static	isSupported ()

Fonctions membres publiques statiques hérités de FOFDatabaseDriver
static	getConnectors ()

static	getInstance ($options=array())

static	splitSql ($sql)

Fonctions membres publiques statiques hérités de FOFDatabase
static	getConnectors ()

static	getInstance ($options=array())

static	splitSql ($query)

static	test ()

Champs de données
	$name = 'mysqli'

	$serverType = 'mysql'

Champs de données hérités de FOFDatabaseDriver
	$name

	$serverType

Fonctions membres protégées
	fetchArray ($cursor=null)

	fetchAssoc ($cursor=null)

	fetchObject ($cursor=null, $class='stdClass')

	freeResult ($cursor=null)

	getErrorNumber ()

	getErrorMessage ($query)

Fonctions membres protégées hérités de FOFDatabaseDriver
	fetchArray ($cursor=null)

	fetchAssoc ($cursor=null)

	fetchObject ($cursor=null, $class='stdClass')

	freeResult ($cursor=null)

	getCreateDatabaseQuery ($options, $utf)

	getDatabase ()

	quoteNameStr ($strArr)

Attributs protégés
	$connection

	$nameQuote = '`'

	$nullDate = '0000-00-00 00:00:00'

Attributs protégés hérités de FOFDatabaseDriver
	$connection

	$count = 0

	$cursor

	$debug = false

	$limit = 0

	$log = array()

	$timings = array()

	$callStacks = array()

	$nameQuote

	$nullDate

	$offset = 0

	$options

	$sql

	$tablePrefix

	$utf = true

	$utf8mb4 = false

	$errorNum = 0

	$errorMsg

	$transactionDepth = 0

	$disconnectHandlers = array()

Attributs protégés statiques
static	$dbMinimum = '5.0.4'

Attributs protégés statiques hérités de FOFDatabaseDriver
static	$instances = array()

static	$dbMinimum

Fonctions membres privées
	hasProfiling ()

	serverClaimsUtf8mb4Support ()

Description détaillée

MySQLi database driver

Voir également: http://php.net/manual/en/book.mysqli.php

Depuis: 12.1

Documentation des constructeurs et destructeur

◆ __construct()

__construct ( $options )

Constructor.

Paramètres

array $options List of options used to configure the connection

Depuis: 12.1

Références $options, et null.

◆ __destruct()

__destruct ( )

Destructor.

Depuis: 12.1

Documentation des fonctions membres

◆ connect()

connect ( )

Connects to the database if needed.

Renvoie: void Returns void if the database connected successfully.

Depuis: 12.1

Exceptions

RuntimeException

Références elseif, et null.

◆ connected()

connected ( )

Determines if the connection to the server is active.

Renvoie: boolean True if connected to the database engine.

Depuis: 12.1

◆ disconnect()

disconnect ( )

Disconnects the database.

Renvoie: void

Depuis: 12.1

Références null.

◆ dropTable()

dropTable	(	$tableName,
		$ifExists = `true`
	)

Drops a table from the database.

Paramètres

string	$tableName	The name of the database table to drop.
boolean	$ifExists	Optionally specify that the table must exist before it is dropped.

Renvoie: FOFDatabaseDriverMysqli Returns this object to support chaining.

Depuis: 12.2

Exceptions

RuntimeException

Références $query.

◆ escape()

escape	(	$text,
		$extra = `false`
	)

Method to escape a string for usage in an SQL statement.

Paramètres

string	$text	The string to be escaped.
boolean	$extra	Optional parameter to provide extra escaping.

Renvoie: string The escaped string.

Depuis: 12.1

Références $text.

◆ execute()

execute ( )

Execute the SQL statement.

Renvoie: mixed A database cursor resource on success, boolean false on failure.

Depuis: 12.1

Exceptions

RuntimeException

Références $limit, $query, et null.

◆ fetchArray()

fetchArray ( $cursor = null )

protected

Method to fetch a row from the result set cursor as an array.

Paramètres

mixed $cursor The optional result set cursor from which to fetch the row.

Renvoie: mixed Either the next row from the result set or false if there are no more rows.

Depuis: 12.1

◆ fetchAssoc()

fetchAssoc ( $cursor = null )

protected

Method to fetch a row from the result set cursor as an associative array.

Paramètres

mixed $cursor The optional result set cursor from which to fetch the row.

Renvoie: mixed Either the next row from the result set or false if there are no more rows.

Depuis: 12.1

◆ fetchObject()

fetchObject	(	$cursor = `null`,
		$class = `'stdClass'`
	)

protected

Method to fetch a row from the result set cursor as an object.

Paramètres

mixed	$cursor	The optional result set cursor from which to fetch the row.
string	$class	The class name to use for the returned row object.

Renvoie: mixed Either the next row from the result set or false if there are no more rows.

Depuis: 12.1

Références $class.

◆ freeResult()

freeResult ( $cursor = null )

protected

Method to free up the memory used for the result set.

Paramètres

mixed $cursor The optional result set cursor from which to fetch the row.

Renvoie: void

Depuis: 12.1

Références null.

◆ getAffectedRows()

getAffectedRows ( )

Get the number of affected rows by the last INSERT, UPDATE, REPLACE or DELETE for the previous executed SQL statement.

Renvoie: integer The number of affected rows.

Depuis: 12.1

◆ getCollation()

getCollation ( )

Method to get the database collation.

Renvoie: mixed The collation in use by the database (string) or boolean false if not supported.

Depuis: 12.2

Exceptions

RuntimeException

◆ getConnectionCollation()

getConnectionCollation ( )

Method to get the database connection collation, as reported by the driver. If the connector doesn't support reporting this value please return an empty string.

Renvoie: string

◆ getErrorMessage()

getErrorMessage ( $query )

protected

Return the actual SQL Error message

Paramètres

string $query The SQL Query that fails

Renvoie: string The SQL Error message

Depuis: 3.4.6

Références $query.

◆ getErrorNumber()

getErrorNumber ( )

protected

Return the actual SQL Error number

Renvoie: integer The SQL Error number

Depuis: 3.4.6

◆ getNumRows()

getNumRows ( $cursor = null )

Get the number of returned rows for the previous executed SQL statement. This command is only valid for statements like SELECT or SHOW that return an actual result set. To retrieve the number of rows affected by a INSERT, UPDATE, REPLACE or DELETE query, use getAffectedRows().

Paramètres

resource $cursor An optional database cursor resource to extract the row count from.

Renvoie: integer The number of returned rows.

Depuis: 12.1

◆ getTableColumns()

getTableColumns	(	$table,
		$typeOnly = `true`
	)

Retrieves field information about a given table.

Paramètres

string	$table	The name of the database table.
boolean	$typeOnly	True to only return field types.

Renvoie: array An array of fields for the database table.

Depuis: 12.2

Exceptions

RuntimeException

Références $field, et $fields.

◆ getTableCreate()

getTableCreate ( $tables )

Shows the table CREATE statement that creates the given tables.

Paramètres

mixed $tables A table name or a list of table names.

Renvoie: array A list of the create SQL for the tables.

Depuis: 12.1

Exceptions

RuntimeException

Références $row.

◆ getTableKeys()

getTableKeys ( $table )

Get the details list of keys for a table.

Paramètres

string $table The name of the table.

Renvoie: array An array of the column specification for the table.

Depuis: 12.2

Exceptions

RuntimeException

◆ getTableList()

getTableList ( )

Method to get an array of all tables in the database.

Renvoie: array An array of all the tables in the database.

Depuis: 12.2

Exceptions

RuntimeException

◆ getVersion()

getVersion ( )

Get the version of the database connector.

Renvoie: string The database connector version.

Depuis: 12.1

◆ hasProfiling()

hasProfiling ( )

private

Internal function to check if profiling is available

Renvoie: boolean

Depuis: 3.1.3

Références $row.

◆ insertid()

insertid ( )

Method to get the auto-incremented value from the last INSERT statement.

Renvoie: mixed The value of the auto-increment field from the last inserted row. If the value is greater than maximal int value, it will return a string.

Depuis: 12.1

◆ isSupported()

static isSupported ( )

static

Test to see if the MySQL connector is available.

Renvoie: boolean True on success, false otherwise.

Depuis: 12.1

Implémente JDatabaseInterface.

Référencé par FOFDatabaseDriver\getInstance().

◆ lockTable()

lockTable ( $table )

Locks a table in the database.

Paramètres

string $table The name of the table to unlock.

Renvoie: FOFDatabaseDriverMysqli Returns this object to support chaining.

Depuis: 12.2

Exceptions

RuntimeException

◆ renameTable()

renameTable	(	$oldTable,
		$newTable,
		$backup = `null`,
		$prefix = `null`
	)

Renames a table in the database.

Paramètres

string	$oldTable	The name of the table to be renamed
string	$newTable	The new name for the table.
string	$backup	Not used by MySQL.
string	$prefix	Not used by MySQL.

Renvoie: FOFDatabaseDriverMysqli Returns this object to support chaining.

Depuis: 12.2

Exceptions

RuntimeException

◆ select()

select ( $database )

Select a database for use.

Paramètres

string $database The name of the database to select for use.

Renvoie: boolean True if the database was successfully selected.

Depuis: 12.1

Exceptions

RuntimeException

◆ serverClaimsUtf8mb4Support()

serverClaimsUtf8mb4Support ( )

private

Does the database server claim to have support for UTF-8 Multibyte (utf8mb4) collation?

libmysql supports utf8mb4 since 5.5.3 (same version as the MySQL server). mysqlnd supports utf8mb4 since 5.0.9.

Renvoie: boolean

Depuis: CMS 3.5.0

◆ setUtf()

setUtf ( )

Set the connection to use UTF-8 character encoding.

Renvoie: boolean True on success.

Depuis: 12.1

If I could not set the utf8mb4 charset then the server doesn't support utf8mb4 despite claiming otherwise. This happens on old MySQL server versions (less than 5.5.3) using the mysqlnd PHP driver. Since mysqlnd masks the server version and reports only its own we can not be sure if the server actually does support UTF-8 Multibyte (i.e. it's MySQL 5.5.3 or later). Since the utf8mb4 charset is undefined in this case we catch the error and determine that utf8mb4 is not supported!

◆ transactionCommit()

transactionCommit ( $toSavepoint = false )

Method to commit a transaction.

Paramètres

boolean $toSavepoint If true, commit to the last savepoint.

Renvoie: void

Depuis: 12.2

Exceptions

RuntimeException

◆ transactionRollback()

transactionRollback ( $toSavepoint = false )

Method to roll back a transaction.

Paramètres

boolean $toSavepoint If true, rollback to the last savepoint.

Renvoie: void

Depuis: 12.2

Exceptions

RuntimeException

◆ transactionStart()

transactionStart ( $asSavepoint = false )

Method to initialize a transaction.

Paramètres

boolean $asSavepoint If true and a transaction is already active, a savepoint will be created.

Renvoie: void

Depuis: 12.2

Exceptions

RuntimeException

◆ unlockTables()

unlockTables ( )

Unlocks tables in the database.

Renvoie: FOFDatabaseDriverMysqli Returns this object to support chaining.

Depuis: 12.1

Exceptions

RuntimeException

Documentation des champs

◆ $connection

$connection

protected

◆ $dbMinimum

$dbMinimum = '5.0.4'

staticprotected

◆ $name

$name = 'mysqli'

◆ $nameQuote

$nameQuote = '`'

protected

◆ $nullDate

$nullDate = '0000-00-00 00:00:00'

protected

◆ $serverType

$serverType = 'mysql'

La documentation de cette classe a été générée à partir du fichier suivant :

fof/database/driver/mysqli.php

Fonctions membres publiques

Fonctions membres publiques statiques

Champs de données

Fonctions membres protégées

Attributs protégés

Attributs protégés statiques

Fonctions membres privées

Description détaillée

Documentation des constructeurs et destructeur

◆ __construct()

◆ __destruct()

Documentation des fonctions membres

◆ connect()

◆ connected()

◆ disconnect()

◆ dropTable()

◆ escape()

◆ execute()

◆ fetchArray()

◆ fetchAssoc()

◆ fetchObject()

◆ freeResult()

◆ getAffectedRows()

◆ getCollation()

◆ getConnectionCollation()

◆ getErrorMessage()

◆ getErrorNumber()

◆ getNumRows()

◆ getTableColumns()

◆ getTableCreate()

◆ getTableKeys()

◆ getTableList()

◆ getVersion()

◆ hasProfiling()

◆ insertid()

◆ isSupported()

◆ lockTable()

◆ renameTable()

◆ select()

◆ serverClaimsUtf8mb4Support()

◆ setUtf()

◆ transactionCommit()

◆ transactionRollback()

◆ transactionStart()

◆ unlockTables()

Documentation des champs

◆ $connection

◆ $dbMinimum

◆ $name

◆ $nameQuote

◆ $nullDate

◆ $serverType