Joomla! 框架 3.x API » \Joomla\Database\Mysql\MysqlDriver

链接
自	1.0
包	Joomla 框架

构造函数。

__construct(mixed||string|int options) :

自	1.0

参数

选项: array<string|int, mixed>数据库选项数组，键为：主机、用户、密码、数据库、选择。

响应

混合

析构函数。

__destruct() :

继承

自	1.0

响应

混合

用于访问数据库驱动程序属性的魔术方法。

__get( name) :

继承已弃用

自	1.4.0
已弃用	3.0 由于 $this->name 之前是公有的，因此这是一个向后兼容的代理

参数

名称: string属性的名称。

响应

mixed如果属性名称有效，则为一个值，否则为 null。

PDO 不支持序列化

__sleep() : mixed||string|int

继承

自	1.0

响应

array<string|int, mixed>

序列化后唤醒

__wakeup() :

继承

自	1.0

响应

无效

更改数据库的字符集。

alterDbCharacterSet( dbName) : bool|resource

继承

自	2.0.0
抛出	`运行时异常`

参数

dbName: string将被更改的数据库名称

响应

布尔值|资源

根据需要连接到数据库。

connect() :

自	1.0
抛出	`运行时异常`

响应

void如果数据库连接成功，则返回 void。

确定与服务器的连接是否处于活动状态。

connected() :

继承

自	1.0
抛出	`逻辑异常`

响应

bool如果已连接到数据库引擎，则为 True。

自动将 CREATE TABLE 或 ALTER TABLE 查询从 utf8mb4（UTF-8 多字节）降级到普通 utf8。

convertUtf8mb4QueryToUtf8( query) :

当服务器不支持 UTF-8 多字节时使用。

自	1.4.0

参数

查询: string要转换的查询

响应

string转换后的查询

使用 $options 对象中的信息创建一个新的数据库。

createDatabase(\stdClass options,  utf = true) : bool|resource

继承

自	2.0.0
抛出	`运行时异常`

参数

选项: stdClass用于将用户和数据库名称传递给数据库驱动程序的对象。此对象必须设置“db_name”和“db_user”。
utf: bool如果数据库支持 UTF-8 字符集，则为 True。

响应

布尔值|资源

创建一个新的 DatabaseQuery 对象。

createQuery() : \Joomla\Database\QueryInterface

继承

自	2.2

响应

QueryInterface

用原始字符串替换表示二进制字段的特殊占位符。

decodeBinary(string|resource data) :

继承

自	1.7.0

参数

数据: string|resource编码字符串或资源。

响应

string原始字符串。

断开数据库连接。

disconnect() :

继承

自	2.0.0

响应

无效

分派事件。

dispatchEvent(\Joomla\Event\EventInterface event) :

继承

自	2.0.0

参数

事件: EventInterface要分派的事件

响应

无效

从数据库中删除一个表。

dropTable( table,  ifExists = true) :

继承

自	2.0.0
抛出	`运行时异常`

参数

表: string要删除的数据库表的名称。
ifExists: bool可选地指定表必须存在才能被删除。

响应

$this

用于转义 SQL 语句中使用的字符串的方法。

escape( text,  extra = false) :

Oracle 转义参考：http://www.orafaq.com/wiki/SQL_FAQ#How_does_one_escape_special_characters_when_writing_SQL_queries.3F

SQLite 转义说明：http://www.sqlite.org/faq.html#q14

方法体与 Zend Framework 中实现的一样

注意：使用具有绑定变量的查询对象优于以下方法。

自	1.0

参数

文本: string要转义的字符串。
额外: bool未使用的可选参数，用于提供额外的转义。

响应

string转义后的字符串。

执行 SQL 语句。

execute() :

继承

自

1.0

抛出

异常

运行时异常

响应

布尔值

用于从结果集游标中获取一行作为数组的方法。

fetchArray() :

继承

自	1.0

响应

mixed结果集中的下一行，如果不再有行，则为 false。

用于从结果集游标中获取一行作为关联数组的方法。

fetchAssoc() :

继承

自	1.0

响应

mixed结果集中的下一行，如果不再有行，则为 false。

用于从结果集游标中获取一行作为对象的方法。

fetchObject() :

继承

注意，应在使用 StatementInterface::setFetchMode() 调用此方法之前配置提取模式。

自	1.0

响应

mixed结果集中的下一行，如果不再有行，则为 false。

用于释放结果集使用的内存的方法。

freeResult() :

继承

自	1.0

响应

无效

获取先前执行的 SQL 语句受影响的行数。

getAffectedRows() :

继承

自	2.0.0

响应

int先前操作中受影响的行数

返回用于更改数据库字符集的查询字符串。

getAlterDbCharacterSet( dbName) :

自	2.0.0

参数

dbName: string数据库名称

响应

string更改数据库查询字符串的查询

用于通过对数据库中表中的文本字段进行采样来获取数据库正在使用的排序规则的方法。

getCollation() : string|bool

自	1.0
抛出	`运行时异常`

响应

string|bool数据库正在使用的排序规则（字符串）或布尔值 false（如果不受支持）。

获取要运行并验证数据库是否可操作的查询。

getConnectedQuery() :

继承

自	1.0

响应

string用于检查数据库运行状况的查询。

提供对底层数据库连接的访问的方法。

getConnection() :

继承

自	1.0

响应

resource底层数据库连接资源。

用于通过对数据库中表中的文本字段进行采样来获取数据库连接正在使用的排序规则的方法。

getConnectionCollation() : string|bool

自	1.6.0
抛出	`运行时异常`

响应

string|bool数据库连接正在使用的排序规则（字符串）或布尔值 false（如果不受支持）。

用于获取正在使用的数据库加密详细信息（密码和协议）的方法。

getConnectionEncryption() :

自	2.0.0
抛出	`运行时异常`

响应

string数据库加密详细信息。

获取可用数据库连接器的列表。

getConnectors() : mixed||string|int

继承静态

此列表将仅填充类存在的连接器，并且环境支持其使用。这使我们能够拥有大量连接器类，这些类能够自我识别是否能够在给定系统上使用。

自	1.0

响应

array<string|int, mixed>可用数据库连接器的数组。

获取数据库驱动程序执行的 SQL 语句总数。

getCount() :

继承

自	1.0

响应

整数

返回用于创建新数据库的查询字符串。

getCreateDatabaseQuery(\stdClass options,  utf) :

自	2.0.0

参数

选项: stdClass用于将用户和数据库名称传递给数据库驱动程序的对象。此对象必须设置“db_name”和“db_user”。
utf: bool如果数据库支持 UTF-8 字符集，则为 True。

响应

string创建数据库的查询

获取此连接使用的数据库的名称。

getDatabase() :

继承

自	1.0

响应

字符串

返回与数据库驱动程序兼容的 PHP date() 函数日期格式。

getDateFormat() :

继承

自	1.0

响应

字符串

获取事件分派器。

getDispatcher() : \Joomla\Event\DispatcherInterface

继承

自	1.2.0
抛出	`UnexpectedValueException`如果未设置分派器，则可能会抛出。

响应

DispatcherInterface

获取导出器类对象。

getExporter() : \Joomla\Database\DatabaseExporter

继承

自	1.0
抛出	`运行时异常`

响应

DatabaseExporter导出器对象。

获取导入器类对象。

getImporter() : \Joomla\Database\DatabaseImporter

继承

自	1.0

响应

DatabaseImporter

用于根据给定选项返回 DatabaseDriver 实例的方法。

getInstance(mixed||string|int options = []) : \Joomla\Database\DatabaseDriver

继承静态已弃用

有三个全局选项，其余选项特定于数据库驱动程序。

'driver' 选项定义了用于连接的 DatabaseDriver 类 - 默认值为 'mysqli'。
'database' 选项确定要用于连接的数据库。
'select' 选项确定连接器是否应自动选择选定的数据库。

实例对于给定的选项是唯一的，并且仅当将唯一的选项数组传递到方法中时才会创建新对象。这确保我们不会最终获得不必要的数据库连接资源。

自	1.0
抛出	`运行时异常`
已弃用	3.0 使用 DatabaseFactory::getDriver() 代替

参数

选项: array<string|int, mixed>要传递给数据库驱动程序的参数。

响应

DatabaseDriver

获取当前查询的新迭代器。

getIterator( column = null,  class = stdClass::class) : \Joomla\Database\DatabaseIterator

继承

自	1.0

参数

列: string用作迭代器键的可选列。
类: string返回的对象的类。

响应

DatabaseIterator

获取最低支持的数据库版本。

getMinimum() :

自	2.0.0

响应

字符串

获取查询监视器。

getMonitor() : \Joomla\Database\QueryMonitorInterface|null

继承

自	2.0.0

响应

QueryMonitorInterface|null查询监视器或 null（如果未设置）。

获取数据库驱动程序的名称。

getName() :

继承

如果未设置 $this->name，它将尝试从类名中猜测驱动程序名称。

自	1.4.0

响应

字符串

获取数据库驱动程序的时间戳的 null 或零表示形式。

getNullDate() :

自	2.0.0

响应

字符串

获取先前执行的 SQL 语句返回的行数。

getNumRows() :

继承

自	2.0.0

响应

int返回的行数。

检索 PDO 数据库连接属性 https://php.ac.cn/manual/en/pdo.getattribute.php

getOption( key) :

继承

用法: $db->getOption(PDO::ATTR_CASE);

自	1.0

参数

键: mixedPDO::ATTR_* 常量之一

响应

混合

获取数据库驱动程序的公共表前缀。

getPrefix() :

继承

自	1.0

响应

string公共数据库表前缀。

获取当前查询对象或一个新的 DatabaseQuery 对象。

getQuery( new = false) : \Joomla\Database\DatabaseQuery

继承

自	1.0

参数

新建: bool如果为 False，则返回当前查询对象；如果为 True，则返回一个新的 DatabaseQuery 对象。$new 参数在 2.2 中已弃用，将在 4.0 中移除，请改用 createQuery()。

响应

DatabaseQuery

获取服务器族类型。

getServerType() :

继承

如果 $this->serverType 未设置，则会尝试从驱动程序名称中猜测服务器族类型。如果无法实现，则会返回驱动程序名称。

自	1.4.0

响应

字符串

检索关于给定表的字段信息。

getTableColumns( table,  typeOnly = true) : mixed||string|int

自	1.0
抛出	`运行时异常`

参数

表: string数据库表名称。
仅类型: bool如果为 True，则仅返回字段类型。

响应

array<string|int, mixed>数据库表的字段数组。

显示创建给定表的表 CREATE 语句。

getTableCreate(array|string tables) : mixed||string|int

自	1.0
抛出	`运行时异常`

参数

表: array<string|int, mixed>|string表名或表名列表。

响应

array<string|int, mixed>表的创建 SQL 列表。

获取表的键详细信息列表。

getTableKeys( table) : mixed||string|int

自	1.0
抛出	`运行时异常`

参数

表: string表名称。

响应

array<string|int, mixed>表的列规范数组。

获取数据库中所有表数组的方法。

getTableList() : mixed||string|int

自	1.0
抛出	`运行时异常`

响应

array<string|int, mixed>数据库中所有表的数组。

获取数据库连接器的版本。

getVersion() :

自	2.0.0

响应

string数据库连接器版本。

确定数据库引擎是否支持 UTF-8 多字节 (utf8mb4) 字符编码。

hasUTF8mb4Support() :

自	2.0.0

响应

bool如果数据库引擎支持 UTF-8 多字节，则为 True。

确定数据库引擎是否支持 UTF-8 字符编码。

hasUtfSupport() :

继承

自	1.0

响应

bool如果数据库引擎支持 UTF-8 字符编码，则为 True。

获取上次 INSERT 语句的自增值的方法。

insertid() :

继承

自	1.0

响应

string上次插入行的自增字段的值。

根据对象的属性将一行插入表中。

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

自	2.0.0
抛出	`运行时异常`

参数

表: string要插入到的数据库表名称。
对象: object对对象的引用，其公共属性与表字段匹配。
键: string主键名称。如果提供，则更新对象属性。

响应

布尔值

测试数据库 TLS 连接加密是否受支持的方法。

isConnectionEncryptionSupported() :

自	2.0.0

响应

bool数据库是否支持 TLS 连接加密。

确定数据库引擎是否为 MariaDB。

isMariaDb() :

自	2.0.0

响应

布尔值

检查已安装的数据库版本是否受数据库驱动程序支持的方法

isMinimumVersion() :

继承

自	1.0

响应

bool如果数据库版本受支持，则为 True

测试 MySQL 连接器是否可用。

isSupported() :

静态

自	1.0

响应

bool成功时为 True，否则为 False。

获取数据库查询结果集的第一行作为关联数组 ['字段名' => '行值'] 的方法。

loadAssoc() :

继承

自	1.0
抛出	`运行时异常`

响应

mixed返回值，如果查询失败则为 null。

获取数据库查询结果集行数组的方法，其中每一行都是 ['字段名' => '行值'] 的关联数组。行数组可以选择以字段名称为键，但默认为顺序数字数组。

loadAssocList( key = null,  column = null) :

继承

注意：选择以非唯一字段名称为键的结果数组会导致意外行为，应避免。

自	1.0
抛出	`运行时异常`

参数

键: string要为其键入结果数组的字段名称。
列: string可选的列名。结果数组中将只包含此列值，而不是整行。

响应

mixed返回值，如果查询失败则为 null。

获取数据库查询结果集中每一行的 $offset 字段的值数组的方法。

loadColumn( offset) :

继承

自	1.0
抛出	`运行时异常`

参数

偏移量: int用于构建结果数组的行偏移量。

响应

mixed返回值，如果查询失败则为 null。

获取数据库查询结果集的第一行作为对象的方法。

loadObject( class = stdClass::class) :

继承

自	1.0
抛出	`运行时异常`

参数

类: string要用于返回的行对象的类名。

响应

mixed返回值，如果查询失败则为 null。

获取数据库查询结果集行数组的方法，其中每一行都是一个对象。对象数组可以选择以字段名称为键，但默认为顺序数字数组。

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

继承

注意：选择以非唯一字段名称为键的结果数组会导致意外行为，应避免。

自	1.0
抛出	`运行时异常`

参数

键: string要为其键入结果数组的字段名称。
类: string要用于返回的行对象的类名。

响应

mixed返回值，如果查询失败则为 null。

获取数据库查询结果集的第一行的第一个字段的方法。

loadResult() :

继承

自	1.0
抛出	`运行时异常`

响应

mixed返回值，如果查询失败则为 null。

获取数据库查询结果集的第一行作为数组的方法。

loadRow() :

继承

列按数字索引，因此结果集中的第一列可以通过 $row[0] 等访问。

自	1.0
抛出	`运行时异常`

响应

mixed返回值，如果查询失败则为 null。

获取数据库查询结果集行数组的方法，其中每一行都是一个数组。对象数组可以选择以字段偏移量为键，但默认为顺序数字数组。

loadRowList( key = null) : mixed||string|int

继承

注意：选择以非唯一字段为键的结果数组会导致意外行为，应避免。

自	1.0
抛出	`运行时异常`

参数

键: string要为其键入结果数组的字段名称。

响应

array<string|int, mixed>结果数组。

锁定数据库中的表。

lockTable( table) :

自	1.0
抛出	`运行时异常`

参数

表: string要解锁的表名称。

响应

$this

准备执行 SQL 语句

prepareStatement( query) : \Joomla\Database\StatementInterface

继承

自	2.0.0
抛出	`PrepareStatementFailureException`

参数

查询: string要准备的 SQL 查询。

响应

StatementInterface

quote 方法的别名

q(array|string text,  escape = true) :

继承

自	1.0

参数

文本: array<string|int, mixed>|string要引用的字符串或字符串数组。
escape: boolTrue（默认值）表示转义字符串，False 表示保持不变。

响应

string引用的输入字符串。

quoteName 方法的别名

qn(array|string name, array|string as = null) : array|string

继承

自	1.0

参数

名称: array<string|int, mixed>|string要包含在引号中的标识符名称，或要包含在引号中的标识符名称数组。每种类型都支持点分隔符名称。
作为: array<string|int, mixed>|string与 $name 关联的 AS 查询部分。它可以是字符串或数组，在后者情况下，它必须与 $name 的长度相同；如果为 null，则字符串或数组元素将没有任何 AS 部分。

响应

array<string|int, mixed>|string引用的名称，与 $name 类型相同。

引用并可选地转义字符串以满足数据库查询的数据库要求。

quote(array|string text,  escape = true) : array|string

继承

自	1.0

参数

文本: array<string|int, mixed>|string要引用的字符串或字符串数组。
escape: boolTrue（默认值）表示转义字符串，False 表示保持不变。

响应

array<string|int, mixed>|string引用的输入字符串。

引用二进制字符串以满足数据库查询的数据库要求。

quoteBinary( data) :

继承

自	1.7.0

参数

数据: string要引用的二进制字符串。

响应

string引用的二进制输入字符串。

将 SQL 语句标识符名称（如列、表或数据库名称）包含在引号中，以防止注入风险和保留字冲突。

quoteName(array|string name, array|string as = null) : array|string

继承

自	1.0

参数

名称: array<string|int, mixed>|string要包含在引号中的标识符名称，或要包含在引号中的标识符名称数组。每种类型都支持点分隔符名称。
作为: array<string|int, mixed>|string与 $name 关联的 AS 查询部分。它可以是字符串或数组，在后者情况下，它必须与 $name 的长度相同；如果为 null，则字符串或数组元素将没有任何 AS 部分。

响应

array<string|int, mixed>|string引用的名称，与 $name 类型相同。

引用来自 quoteName 调用的字符串。

quoteNameStr(mixed||string|int strArr) :

继承已弃用

自	1.0
已弃用	2.0 使用 quoteNameString 代替

参数

strArr: array<string|int, mixed>来自 quoteName 点爆炸的字符串数组。

响应

string引用的部分的点分隔字符串。

引用来自 quoteName 调用的字符串。

quoteNameString( name,  asSinglePart = false) :

继承

自	1.7.0

参数

名称: string要引用的标识符名称。
作为单个部分: bool将名称视为标识符的单个部分。

响应

string引用的标识符字符串。

重命名数据库中的表。

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

自	1.0
抛出	`运行时异常`

参数

旧表: string要重命名的表名称
新表: string表的新的名称。
备份: stringMySQL 未使用。
前缀: stringMySQL 未使用。

响应

$this

此函数用配置的表前缀替换字符串标识符。

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

继承

自	1.0

参数

sql: string要准备的 SQL 语句。
前缀: string表前缀。

响应

string已处理的 SQL 语句。

选择一个数据库以供使用。

select( database) :

自	1.0
抛出	`运行时异常`

参数

数据库: string要选择以供使用的数据库名称。

响应

布尔值

设置要使用的调度程序。

setDispatcher(\Joomla\Event\DispatcherInterface dispatcher) :

继承

自	1.2.0

参数

调度程序: DispatcherInterface要使用的调度程序。

响应

$this

设置查询监视器。

setMonitor(\Joomla\Database\QueryMonitorInterface|null monitor = null) :

继承

自	2.0.0

参数

监视器: QueryMonitorInterface|null查询监视器。

响应

$this

在 PDO 数据库句柄上设置属性。

setOption( key,  value) :

继承

https://php.ac.cn/manual/en/pdo.setattribute.php

用法: $db->setOption(PDO::ATTR_CASE, PDO::CASE_UPPER);

自	1.0

参数

键: intPDO::ATTR_* 常量之一
值: mixed与特定属性键相关的 PDO 常量之一。

响应

布尔值

设置 SQL 语句字符串以供以后执行。

setQuery(string|\Joomla\Database\QueryInterface query,  offset,  limit) :

继承

自	1.0
抛出	`InvalidArgumentException`

参数

查询: string|QueryInterface要设置的 SQL 语句，可以是 Query 对象或字符串。
偏移量: int要设置的受影响行偏移量。{@deprecated 请改用 LimitableInterface::setLimit()}
限制: int要设置的最大受影响行数。{@deprecated 请改用 LimitableInterface::setLimit()}

响应

$this

将连接设置为使用 UTF-8 字符编码。

setUtf() :

继承

自	1.0

响应

bool成功时为 True。

将多个查询的字符串拆分为单个查询的数组。

splitSql( sql) : mixed||string|int

继承静态

自	1.0

参数

sql: string要拆分为单个查询的输入 SQL 字符串。

响应

array<string|int, mixed>

提交事务的方法。

transactionCommit( toSavepoint = false) :

自	1.0
抛出	`运行时异常`

参数

保存点: bool如果为 True，则提交到最后一个保存点。

响应

无效

回滚事务的方法。

transactionRollback( toSavepoint = false) :

自	1.0
抛出	`运行时异常`

参数

保存点: bool如果为 True，则回滚到最后一个保存点。

响应

无效

初始化事务的方法。

transactionStart( asSavepoint = false) :

自	1.0
抛出	`运行时异常`

参数

作为保存点: bool如果为 True 且事务已处于活动状态，则将创建一个保存点。

响应

无效

截断表的方法。

truncateTable( table) :

继承

自	1.0
抛出	`运行时异常`

参数

表: string要截断的表

响应

无效

解锁数据库中的表。

unlockTables() :

自	1.0
抛出	`运行时异常`

响应

$this

根据对象的属性更新表中的一行。

updateObject( table,  &object, array|string key,  nulls = false) :

继承

自	1.0
抛出	`运行时异常`

参数

表: string要更新的数据库表名称。
对象: object对对象的引用，其公共属性与表字段匹配。
键: array<string|int, mixed>|string主键名称。
空值: bool如果为 True，则更新空字段；如果为 False，则忽略它们。

响应

bool成功时为 True。

事件调度程序

继承

自	1.2.0

类型(s)

DispatcherInterface|null

数据库名称。

继承

自	1.0

类型(s)

字符串

数据库驱动程序名称。

自	1.0

类型(s)

字符串

此驱动程序支持的数据库服务器族的类型。

继承

自	1.4.0

类型(s)

字符串

数据库连接资源。

继承

自	1.0

类型(s)

PDO

保存可用数据库连接器的列表。

继承静态

自	1.0

类型(s)

array<string|int, mixed>

数据库驱动程序执行的 SQL 语句数。

继承

自	1.0

类型(s)

整数

上次查询的数据库连接游标。

继承

自	1.0

类型(s)

资源

包含当前查询执行状态

继承

自	2.0.0

类型(s)

布尔值

当前SQL语句受影响的行数限制。

继承

自	1.0

类型(s)

整数

用于引用SQL语句名称（例如表名或字段名等）的字符。

如果是一个单字符字符串，则在引用的名称的两侧使用相同的字符，否则第一个字符将用作起始引号，第二个字符将用作结束引号。

自	1.0

类型(s)

字符串

数据库驱动程序的时间戳的空值或零表示。

自	1.0

类型(s)

字符串

要应用于当前SQL语句的受影响行偏移量。

继承

自	1.0

类型(s)

整数

在实例化时传入并保存。

继承

自	1.0

类型(s)

array<string|int, mixed>

要执行的当前SQL语句。

继承

自	1.0

类型(s)

混合

预处理语句。

继承

自	2.0.0

类型(s)

StatementInterface

公共数据库表前缀。

继承

自	1.0

类型(s)

字符串

如果数据库引擎支持UTF-8字符编码，则为True。

继承

自	1.0

类型(s)

布尔值

数据库错误号。

继承

自	1.0

类型(s)

整数

数据库错误消息。

继承

自	1.0

类型(s)

字符串

DatabaseDriver实例容器。

继承静态已弃用

自	1.0
已弃用	3.0 将不再支持单例存储。

类型(s)

array<string|int, DatabaseDriver>

最低支持的数据库版本。

静态

自	1.0

类型(s)

字符串

当前事务的深度。

继承

自	1.0

类型(s)

整数

DatabaseFactory对象

继承

自	2.0.0

类型(s)

DatabaseFactory

查询监控器对象

继承

自	2.0.0

类型(s)

QueryMonitorInterface

如果数据库引擎支持UTF-8多字节（utf8mb4）字符编码，则为True。

自	1.4.0

类型(s)

布尔值

如果数据库引擎是MariaDB，则为True。

自	2.0.0

类型(s)

布尔值

最低支持的MariaDB数据库版本。

静态

自	2.0.0

类型(s)

字符串

TLS连接的默认密码套件。

静态

自	2.0.0

类型(s)

array<string|int, mixed>

默认字符集。

自	2.0.0

类型(s)

字符串