Graphe d'héritage de MysqlDriver:

Fonctions membres publiques
	__construct (array $options)

	connect ()

	convertUtf8mb4QueryToUtf8 ($query)

	select ($database)

	getAlterDbCharacterSet ($dbName)

	getCollation ()

	getConnectionCollation ()

	getConnectionEncryption ()

	isConnectionEncryptionSupported ()

	getTableCreate ($tables)

	getTableColumns ($table, $typeOnly=true)

	getTableKeys ($table)

	getTableList ()

	getVersion ()

	getMinimum ()

	getNullDate ()

	hasUTF8mb4Support ()

	isMariaDb ()

	lockTable ($table)

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

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

	escape ($text, $extra=false)

	unlockTables ()

	transactionCommit ($toSavepoint=false)

	transactionRollback ($toSavepoint=false)

	transactionStart ($asSavepoint=false)

Fonctions membres publiques hérités de PdoDriver
	__construct (array $options)

	__destruct ()

	connect ()

	escape ($text, $extra=false)

	execute ()

	getOption ($key)

	getVersion ()

	getConnectedQuery ()

	setOption ($key, $value)

	connected ()

	insertid ()

	select ($database)

	setUtf ()

	transactionCommit ($toSavepoint=false)

	transactionRollback ($toSavepoint=false)

	transactionStart ($asSavepoint=false)

	__sleep ()

	__wakeup ()

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 PdoDriver
static	isSupported ()

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

static	splitSql ($sql)

Champs de données
	$name = 'mysql'

Champs de données hérités de PdoDriver
	$name = 'pdo'

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

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

Fonctions membres protégées hérités de PdoDriver
	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
	$nameQuote = '`'

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

	$utf8mb4 = false

	$mariadb = false

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

	$nameQuote = "'"

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

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'

static	$defaultCipherSuite

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

static	$instances = []

static	$dbMinimum

Description détaillée

MySQL database driver supporting PDO based connections

1.0

Documentation des constructeurs et destructeur

◆ __construct()

__construct ( array $options )

Constructor.

Paramètres

array $options Array of database options with keys: host, user, password, database, select.

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, et Symfony\Contracts\Service\__construct().

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 $key, $value, DatabaseDriver\getConnection(), MysqlDriver\getVersion(), et null.

Référencé par MysqlDriver\escape(), MysqlDriver\getTableColumns(), MysqlDriver\getTableCreate(), MysqlDriver\getTableKeys(), MysqlDriver\getTableList(), MysqlDriver\getVersion(), MysqlDriver\isConnectionEncryptionSupported(), MysqlDriver\isMariaDb(), MysqlDriver\transactionCommit(), MysqlDriver\transactionRollback(), et MysqlDriver\transactionStart().

◆ 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.

◆ escape()

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

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

Oracle escaping reference: http://www.orafaq.com/wiki/SQL_FAQ#How_does_one_escape_special_characters_when_writing_SQL_queries.3F

SQLite escaping notes: http://www.sqlite.org/faq.html#q14

Method body is as implemented by the Zend Framework

Note: Using query objects with bound variables is preferable to the below.

Paramètres

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

Renvoie: string The escaped string.

Depuis: 1.0

Implémente DatabaseInterface.

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

◆ 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

◆ 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.

◆ 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.

◆ 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.

◆ 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 MysqlDriver\$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, MysqlDriver\connect(), DatabaseDriver\quoteName(), et DatabaseDriver\setQuery().

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

◆ getTableCreate()

getTableCreate ( $tables )

Shows the table CREATE statement that creates the given tables.

Paramètres

array | string $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, MysqlDriver\connect(), 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 MysqlDriver\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 MysqlDriver\connect(), et DatabaseDriver\setQuery().

◆ getVersion()

getVersion ( )

Get the version of the database connector.

Renvoie: string The database connector version.

Depuis: 2.0.0

Implémente DatabaseInterface.

Références $version, MysqlDriver\connect(), et PdoDriver\getOption().

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

◆ 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 MysqlDriver\$utf8mb4.

◆ 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(), MysqlDriver\getTableColumns(), PdoDriver\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 MysqlDriver\connect(), et DatabaseDriver\setQuery().

◆ isMariaDb()

isMariaDb ( )

Determine if the database engine is MariaDB.

Renvoie: boolean

Depuis: 2.0.0

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

◆ isSupported()

static isSupported ( )

static

Test to see if the MySQL connector is available.

Renvoie: boolean True on success, false otherwise.

Depuis: 1.0

Implémente DatabaseInterface.

Référencé par Database\register().

◆ 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, DatabaseDriver\quoteName(), et DatabaseDriver\setQuery().

◆ 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, DatabaseDriver\quoteName(), 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

Depuis: 1.0

Exceptions

Implémente DatabaseInterface.

◆ 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 MysqlDriver\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 MysqlDriver\connect(), PdoDriver\execute(), DatabaseDriver\quoteName(), et DatabaseDriver\setQuery().

◆ 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, MysqlDriver\connect(), PdoDriver\execute(), DatabaseDriver\quoteName(), et DatabaseDriver\setQuery().

◆ unlockTables()

unlockTables ( )

Unlocks tables in the database.

Renvoie: $this

Depuis: 1.0

Exceptions

Implémente DatabaseInterface.

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

Documentation des champs

◆ $dbMinimum

$dbMinimum = '5.6'

staticprotected

◆ $dbMinMariadb

$dbMinMariadb = '10.0'

staticprotected

◆ $defaultCipherSuite

$defaultCipherSuite

staticprotected

Valeur initiale :

= [
                'AES128-GCM-SHA256',
                'AES256-GCM-SHA384',
                'AES128-CBC-SHA256',
                'AES256-CBC-SHA384',
                'DES-CBC3-SHA',
        ]

◆ $mariadb

$mariadb = false

protected

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

◆ $name

$name = 'mysql'

◆ $nameQuote

$nameQuote = '`'

protected

◆ $nullDate

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

protected

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

◆ $utf8mb4

$utf8mb4 = false

protected

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

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

MysqlDriver.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

Description détaillée

Documentation des constructeurs et destructeur

◆ __construct()

Documentation des fonctions membres

◆ connect()

◆ convertUtf8mb4QueryToUtf8()

◆ escape()

◆ getAlterDbCharacterSet()

◆ getCollation()

◆ getConnectionCollation()

◆ getConnectionEncryption()

◆ getCreateDatabaseQuery()

◆ getMinimum()

◆ getNullDate()

◆ getTableColumns()

◆ getTableCreate()

◆ getTableKeys()

◆ getTableList()

◆ getVersion()

◆ hasUTF8mb4Support()

◆ insertObject()

◆ isConnectionEncryptionSupported()

◆ isMariaDb()

◆ isSupported()

◆ lockTable()

◆ renameTable()

◆ select()

◆ transactionCommit()

◆ transactionRollback()

◆ transactionStart()

◆ unlockTables()

Documentation des champs

◆ $dbMinimum

◆ $dbMinMariadb

◆ $defaultCipherSuite

◆ $mariadb

◆ $name

◆ $nameQuote

◆ $nullDate

◆ $utf8mb4