Graphe d'héritage de MysqliDriver:

Fonctions membres publiques
	__construct (array $options)

	connect ()

	convertUtf8mb4QueryToUtf8 ($query)

	disconnect ()

	escape ($text, $extra=false)

	connected ()

	getAlterDbCharacterSet ($dbName)

	getCollation ()

	getConnectionCollation ()

	getConnectionEncryption ()

	isConnectionEncryptionSupported ()

	getTableCreate ($tables)

	getTableColumns ($table, $typeOnly=true)

	getTableKeys ($table)

	getTableList ()

	getVersion ()

	getMinimum ()

	hasUTF8mb4Support ()

	isMariaDb ()

	insertid ()

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

	lockTable ($table)

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

	select ($database)

	setUtf ()

	transactionCommit ($toSavepoint=false)

	transactionRollback ($toSavepoint=false)

	transactionStart ($asSavepoint=false)

	unlockTables ()

	getNullDate ()

Fonctions membres publiques hérités de DatabaseDriver
	__get ($name)

	__construct (array $options)

	__destruct ()

	alterDbCharacterSet ($dbName)

	createDatabase ($options, $utf=true)

	disconnect ()

	dropTable ($table, $ifExists=true)

	execute ()

	getAffectedRows ()

	getConnection ()

	getCount ()

	getDateFormat ()

	getMinimum ()

	getName ()

	getNumRows ()

	getServerType ()

	getNullDate ()

	getPrefix ()

	getExporter ()

	getImporter ()

	getQuery ($new=false)

	getIterator ($column=null, $class=\stdClass::class)

	getTableCreate ($tables)

	hasUtfSupport ()

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

	isMinimumVersion ()

	loadAssoc ()

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

	loadColumn ($offset=0)

	loadObject ($class=\stdClass::class)

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

	loadResult ()

	loadRow ()

	loadRowList ($key=null)

	q ($text, $escape=true)

	quote ($text, $escape=true)

	quoteBinary ($data)

	decodeBinary ($data)

	qn ($name, $as=null)

	quoteName ($name, $as=null)

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

	getMonitor ()

	setMonitor (QueryMonitorInterface $monitor=null)

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

	setUtf ()

	truncateTable ($table)

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

Fonctions membres publiques hérités de DispatcherAwareInterface
	setDispatcher (DispatcherInterface $dispatcher)

Fonctions membres publiques hérités de UTF8MB4SupportInterface
	hasUtf8mb4Support ()

Fonctions membres publiques statiques
static	isSupported ()

Fonctions membres publiques statiques hérités de DatabaseDriver
static	getInstance (array $options=[])

static	splitSql ($sql)

Champs de données
	$name = 'mysqli'

Champs de données hérités de DatabaseDriver
	$serverType

Fonctions membres protégées
	getCreateDatabaseQuery ($options, $utf)

	executeUnpreparedQuery ($sql)

	prepareStatement (string $query)

Fonctions membres protégées hérités de DatabaseDriver
	dispatchEvent (EventInterface $event)

	fetchArray ()

	fetchAssoc ()

	fetchObject ()

	freeResult ()

	getAlterDbCharacterSet ($dbName)

	getCreateDatabaseQuery ($options, $utf)

	getDatabase ()

	prepareStatement (string $query)

	quoteNameString ($name, $asSinglePart=false)

	quoteNameStr ($strArr)

Attributs protégés
	$connection

	$nameQuote = '`'

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

	$utf8mb4 = false

	$mariadb = false

Attributs protégés hérités de DatabaseDriver
	$name

	$connection

	$count = 0

	$cursor

	$executed = false

	$limit = 0

	$nameQuote

	$nullDate

	$offset = 0

	$options

	$sql

	$statement

	$tablePrefix

	$utf = true

	$errorNum = 0

	$errorMsg

	$transactionDepth = 0

	$factory

	$monitor

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

static	$dbMinMariadb = '10.0'

Attributs protégés statiques hérités de DatabaseDriver
static	$connectors = []

static	$instances = []

static	$dbMinimum

Fonctions membres privées
	serverClaimsUtf8mb4Support ()

Description détaillée

MySQLi Database Driver

1.0

Documentation des constructeurs et destructeur

◆ __construct()

__construct ( array $options )

Constructor.

Paramètres

array $options List of options used to configure the connection

Depuis: 1.0

sql_mode to MySql 5.7.8+ default strict mode minus ONLY_FULL_GROUP_BY

https://dev.mysql.com/doc/relnotes/mysql/5.7/en/news-5-7-8.html#mysqld-5-7-8-sql-mode

Références DatabaseDriver\$options, Symfony\Contracts\Service\__construct(), et null.

Documentation des fonctions membres

◆ connect()

connect ( )

Connects to the database if needed.

Renvoie: void Returns void if the database connected successfully.

Depuis: 1.0

Exceptions

Implémente DatabaseInterface.

Références $this, elseif, null, et MysqliDriver\select().

◆ connected()

connected ( )

Determines if the connection to the server is active.

Renvoie: boolean True if connected to the database engine.

Depuis: 1.0

Implémente DatabaseInterface.

Référencé par MysqliDriver\executeUnpreparedQuery().

◆ convertUtf8mb4QueryToUtf8()

convertUtf8mb4QueryToUtf8 ( $query )

Automatically downgrade a CREATE TABLE or ALTER TABLE query from utf8mb4 (UTF-8 Multibyte) to plain utf8.

Used when the server doesn't support UTF-8 Multibyte.

Paramètres

string $query The query to convert

Renvoie: string The converted query

Depuis: 1.4.0

Implémente UTF8MB4SupportInterface.

Références $query.

◆ disconnect()

disconnect ( )

Disconnects the database.

Renvoie: void

Depuis: 1.0

Implémente DatabaseInterface.

◆ 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: 1.0

Implémente DatabaseInterface.

Références $result, $text, et MysqliDriver\connect().

Référencé par MysqliDriver\getTableColumns(), et MysqliDriver\getTableCreate().

◆ executeUnpreparedQuery()

executeUnpreparedQuery ( $sql )

protected

Internal method to execute queries which cannot be run as prepared statements.

Paramètres

string $sql SQL statement to execute.

Renvoie: boolean

Depuis: 1.5.0

Références DatabaseDriver\$cursor, DatabaseDriver\$errorMsg, DatabaseDriver\$errorNum, DatabaseDriver\$sql, MysqliDriver\connect(), MysqliDriver\connected(), DatabaseDriver\freeResult(), et null.

Référencé par MysqliDriver\lockTable(), MysqliDriver\transactionRollback(), et MysqliDriver\unlockTables().

◆ getAlterDbCharacterSet()

getAlterDbCharacterSet ( $dbName )

Return the query string to alter the database character set.

Paramètres

string $dbName The database name

Renvoie: string The query that alter the database query string

Depuis: 2.0.0

Références DatabaseDriver\quoteName().

◆ getCollation()

getCollation ( )

Method to get the database collation in use by sampling a text field of a table in the database.

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

Depuis: 1.0

Exceptions

Implémente DatabaseInterface.

Références MysqliDriver\connect(), et DatabaseDriver\setQuery().

◆ getConnectionCollation()

getConnectionCollation ( )

Method to get the database connection collation in use by sampling a text field of a table in the database.

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

Depuis: 1.6.0

Exceptions

Implémente DatabaseInterface.

Références MysqliDriver\connect(), et DatabaseDriver\setQuery().

◆ getConnectionEncryption()

getConnectionEncryption ( )

Method to get the database encryption details (cipher and protocol) in use.

Renvoie: string The database encryption details.

Depuis: 2.0.0

Exceptions

Implémente DatabaseInterface.

Références MysqliDriver\connect(), et DatabaseDriver\setQuery().

◆ getCreateDatabaseQuery()

getCreateDatabaseQuery	(	$options,
		$utf
	)

protected

Return the query string to create new Database.

Paramètres

stdClass	$options	Object used to pass user and database name to database driver. This object must have "db_name" and "db_user" set.
boolean	$utf	True if the database supports the UTF-8 character set.

Renvoie: string The query that creates database

Depuis: 2.0.0

Références DatabaseDriver\$options, DatabaseDriver\$utf, et DatabaseDriver\quoteName().

◆ getMinimum()

getMinimum ( )

Get the minimum supported database version.

Renvoie: string

Depuis: 2.0.0

Implémente DatabaseInterface.

◆ getNullDate()

getNullDate ( )

Get the null or zero representation of a timestamp for the database driver.

Renvoie: string

Depuis: 2.0.0

Implémente DatabaseInterface.

Références MysqliDriver\$nullDate.

◆ 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: 1.0

Exceptions

Implémente DatabaseInterface.

Références $field, $fields, $result, MysqliDriver\connect(), MysqliDriver\escape(), DatabaseDriver\quoteName(), et DatabaseDriver\setQuery().

Référencé par MysqliDriver\insertObject().

◆ 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: 1.0

Exceptions

Références $result, MysqliDriver\connect(), MysqliDriver\escape(), DatabaseDriver\quoteName(), et DatabaseDriver\setQuery().

◆ 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: 1.0

Exceptions

Implémente DatabaseInterface.

Références MysqliDriver\connect(), DatabaseDriver\quoteName(), et DatabaseDriver\setQuery().

◆ 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: 1.0

Exceptions

Implémente DatabaseInterface.

Références MysqliDriver\connect(), et DatabaseDriver\setQuery().

◆ getVersion()

getVersion ( )

Get the version of the database connector.

Renvoie: string The database connector version.

Depuis: 1.0

Implémente DatabaseInterface.

Références MysqliDriver\connect().

Référencé par MysqliDriver\serverClaimsUtf8mb4Support().

◆ hasUTF8mb4Support()

hasUTF8mb4Support ( )

Determine whether the database engine support the UTF-8 Multibyte (utf8mb4) character encoding.

Renvoie: boolean True if the database engine supports UTF-8 Multibyte.

Depuis: 2.0.0

Références MysqliDriver\$utf8mb4.

◆ 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: 1.0

Implémente DatabaseInterface.

Références MysqliDriver\connect().

Référencé par MysqliDriver\insertObject().

◆ insertObject()

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

Inserts a row into a table based on an object's properties.

Paramètres

string	$table	The name of the database table to insert into.
object	$object	A reference to an object whose public properties match the table fields.
string	$key	The name of the primary key. If provided the object property is updated.

Renvoie: boolean

Depuis: 2.0.0

Exceptions

Implémente DatabaseInterface.

Références $fields, $id, $key, $query, DatabaseDriver\getQuery(), MysqliDriver\getTableColumns(), MysqliDriver\insertid(), null, DatabaseDriver\quote(), DatabaseDriver\quoteName(), et DatabaseDriver\setQuery().

◆ isConnectionEncryptionSupported()

isConnectionEncryptionSupported ( )

Method to test if the database TLS connections encryption are supported.

Renvoie: boolean Whether the database supports TLS connections encryption.

Depuis: 2.0.0

Implémente DatabaseInterface.

Références MysqliDriver\connect(), et DatabaseDriver\setQuery().

◆ isMariaDb()

isMariaDb ( )

Determine if the database engine is MariaDB.

Renvoie: boolean

Depuis: 2.0.0

Références MysqliDriver\$mariadb, et MysqliDriver\connect().

◆ isSupported()

static isSupported ( )

static

Test to see if the MySQLi connector is available.

Renvoie: boolean True on success, false otherwise.

Depuis: 1.0

Implémente DatabaseInterface.

◆ lockTable()

lockTable ( $table )

Locks a table in the database.

Paramètres

string $table The name of the table to unlock.

Renvoie: $this

Depuis: 1.0

Exceptions

Implémente DatabaseInterface.

Références $this, MysqliDriver\executeUnpreparedQuery(), DatabaseDriver\quoteName(), et DatabaseDriver\replacePrefix().

◆ prepareStatement()

prepareStatement ( string $query )

protected

Prepares a SQL statement for execution

Paramètres

string $query The SQL query to be prepared.

Renvoie: StatementInterface

Depuis: 2.0.0

Exceptions

PrepareStatementFailureException

Références $query.

◆ 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: $this

Depuis: 1.0

Exceptions

Implémente DatabaseInterface.

Références $this, et DatabaseDriver\setQuery().

◆ 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: 1.0

Exceptions

Implémente DatabaseInterface.

Références DatabaseDriver\$database, et MysqliDriver\connect().

Référencé par MysqliDriver\connect().

◆ 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: 1.4.0

Références MysqliDriver\getVersion().

◆ setUtf()

setUtf ( )

Set the connection to use UTF-8 character encoding.

Renvoie: boolean True on success.

Depuis: 1.0

Références $result, et MysqliDriver\connect().

◆ transactionCommit()

transactionCommit ( $toSavepoint = false )

Method to commit a transaction.

Paramètres

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

Renvoie: void

Depuis: 1.0

Exceptions

Implémente DatabaseInterface.

Références MysqliDriver\connect().

◆ transactionRollback()

transactionRollback ( $toSavepoint = false )

Method to roll back a transaction.

Paramètres

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

Renvoie: void

Depuis: 1.0

Exceptions

Implémente DatabaseInterface.

Références MysqliDriver\connect(), MysqliDriver\executeUnpreparedQuery(), et DatabaseDriver\quoteName().

◆ 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: 1.0

Exceptions

Implémente DatabaseInterface.

Références DatabaseDriver\$transactionDepth, et MysqliDriver\connect().

◆ unlockTables()

unlockTables ( )

Unlocks tables in the database.

Renvoie: $this

Depuis: 1.0

Exceptions

Implémente DatabaseInterface.

Références $this, et MysqliDriver\executeUnpreparedQuery().

Documentation des champs

◆ $connection

$connection

protected

◆ $dbMinimum

$dbMinimum = '5.6'

staticprotected

◆ $dbMinMariadb

$dbMinMariadb = '10.0'

staticprotected

◆ $mariadb

$mariadb = false

protected

Référencé par MysqliDriver\isMariaDb().

◆ $name

$name = 'mysqli'

◆ $nameQuote

$nameQuote = '`'

protected

◆ $nullDate

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

protected

Référencé par MysqliDriver\getNullDate().

◆ $utf8mb4

$utf8mb4 = false

protected

Référencé par MysqliDriver\hasUTF8mb4Support().

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

MysqliDriver.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()

Documentation des fonctions membres

◆ connect()

◆ connected()

◆ convertUtf8mb4QueryToUtf8()

◆ disconnect()

◆ escape()

◆ executeUnpreparedQuery()

◆ getAlterDbCharacterSet()

◆ getCollation()

◆ getConnectionCollation()

◆ getConnectionEncryption()

◆ getCreateDatabaseQuery()

◆ getMinimum()

◆ getNullDate()

◆ getTableColumns()

◆ getTableCreate()

◆ getTableKeys()

◆ getTableList()

◆ getVersion()

◆ hasUTF8mb4Support()

◆ insertid()

◆ insertObject()

◆ isConnectionEncryptionSupported()

◆ isMariaDb()

◆ isSupported()

◆ lockTable()

◆ prepareStatement()

◆ renameTable()

◆ select()

◆ serverClaimsUtf8mb4Support()

◆ setUtf()

◆ transactionCommit()

◆ transactionRollback()

◆ transactionStart()

◆ unlockTables()

Documentation des champs

◆ $connection

◆ $dbMinimum

◆ $dbMinMariadb

◆ $mariadb

◆ $name

◆ $nameQuote

◆ $nullDate

◆ $utf8mb4