Joomla! 框架 3.x API » \Joomla\Database\Mysqli\MysqliDriver

链接
自	1.0
包	Joomla 框架

构造函数。

__construct(mixed||string|int options) :

自	1.0

参数

options: array<string|int, mixed>用于配置连接的选项列表

响应

混合

析构函数。

__destruct() :

继承

自	2.0.0

响应

混合

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

__get( name) :

继承已弃用

自	1.4.0
已弃用	3.0 这是一个 B/C 代理，因为 $this->name 以前是公共的

参数

name: string属性的名称。

响应

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

更改数据库的字符集。

alterDbCharacterSet( dbName) : bool|resource

继承

自	2.0.0
抛出	`RuntimeException`

参数

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

响应

bool|resource

根据需要连接到数据库。

connect() :

自	1.0
抛出	`RuntimeException`

响应

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

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

connected() :

自	1.0

响应

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

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

convertUtf8mb4QueryToUtf8( query) :

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

自	1.4.0

参数

query: string要转换的查询

响应

string转换后的查询

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

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

继承

自	2.0.0
抛出	`RuntimeException`

参数

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

响应

bool|resource

创建一个新的 DatabaseQuery 对象。

createQuery() : \Joomla\Database\QueryInterface

继承

自	2.2

响应

QueryInterface

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

decodeBinary(string|resource data) :

继承

自	1.7.0

参数

data: string|resource编码的字符串或资源。

响应

string原始字符串。

断开数据库连接。

disconnect() :

自	1.0

响应

void

分派事件。

dispatchEvent(\Joomla\Event\EventInterface event) :

继承

自	2.0.0

参数

event: EventInterface要分派的事件

响应

void

从数据库中删除表。

dropTable( table,  ifExists = true) :

继承

自	2.0.0
抛出	`RuntimeException`

参数

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

响应

$this

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

escape( text,  extra = false) :

自	1.0

参数

text: string要转义的字符串。
extra: bool可选参数，用于提供额外的转义。

响应

string转义后的字符串。

执行 SQL 语句。

execute() :

继承

自	2.0.0
抛出	`RuntimeException`

响应

bool

内部方法，用于执行无法作为预处理语句运行的查询。

executeUnpreparedQuery( sql) :

自	1.5.0

参数

sql: string要执行的 SQL 语句。

响应

bool

从结果集游标中以数组形式获取一行的方法。

fetchArray() :

继承

自	1.0

响应

mixed结果集中的下一行，或者如果不存在更多行，则为 false。

从结果集游标中以关联数组形式获取一行的方法。

fetchAssoc() :

继承

自	1.0

响应

mixed结果集中的下一行，或者如果不存在更多行，则为 false。

从结果集游标中以对象形式获取一行的方法。

fetchObject() :

继承

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

自	1.0

响应

mixed结果集中的下一行，或者如果不存在更多行，则为 false。

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

freeResult() :

继承

自	1.0

响应

void

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

getAffectedRows() :

继承

自	2.0.0

响应

int先前操作中影响的行数

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

getAlterDbCharacterSet( dbName) :

自	2.0.0

参数

dbName: string数据库名称

响应

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

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

getCollation() : string|bool

自	1.0
抛出	`RuntimeException`

响应

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

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

getConnection() :

继承

自	1.0

响应

resource底层数据库连接资源。

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

getConnectionCollation() : string|bool

自	1.6.0
抛出	`RuntimeException`

响应

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

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

getConnectionEncryption() :

自	2.0.0
抛出	`RuntimeException`

响应

string数据库加密详细信息。

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

getConnectors() : mixed||string|int

继承 static

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

自	1.0

响应

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

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

getCount() :

继承

自	1.0

响应

int

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

getCreateDatabaseQuery(\stdClass options,  utf) :

自	2.0.0

参数

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

响应

string创建数据库的查询

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

getDatabase() :

继承

自	1.0

响应

string

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

getDateFormat() :

继承

自	1.0

响应

string

获取事件分派器。

getDispatcher() : \Joomla\Event\DispatcherInterface

继承

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

响应

DispatcherInterface

获取一个导出器类对象。

getExporter() : \Joomla\Database\DatabaseExporter

继承

自	1.0
抛出	`RuntimeException`

响应

DatabaseExporter一个导出器对象。

获取一个导入器类对象。

getImporter() : \Joomla\Database\DatabaseImporter

继承

自	1.0

响应

DatabaseImporter

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

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

继承 static 已弃用

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

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

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

自	1.0
抛出	`RuntimeException`
已弃用	3.0 使用 DatabaseFactory::getDriver() 代替

参数

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

响应

DatabaseDriver

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

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

继承

自	1.0

参数

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

响应

DatabaseIterator

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

getMinimum() :

自	2.0.0

响应

string

获取查询监视器。

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

继承

自	2.0.0

响应

QueryMonitorInterface|null查询监视器，如果未设置，则为 null。

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

getName() :

继承

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

自	1.4.0

响应

string

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

getNullDate() :

自	2.0.0

响应

string

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

getNumRows() :

继承

自	2.0.0

响应

int返回的行数。

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

getPrefix() :

继承

自	1.0

响应

string公共数据库表前缀。

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

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

继承

自	1.0

参数

new: boolFalse 表示返回当前查询对象，True 表示返回一个新的 DatabaseQuery 对象。$new 参数在 2.2 中已弃用，将在 4.0 中删除，请使用 createQuery() 代替。

响应

DatabaseQuery

获取服务器系列类型。

getServerType() :

继承

如果未设置 $this->serverType，它将尝试从驱动程序名称中猜测服务器系列类型。如果无法做到这一点，则将返回驱动程序名称。

自	1.4.0

响应

string

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

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

自	1.0
抛出	`RuntimeException`

参数

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

响应

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

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

getTableCreate( tables) : mixed||string|int

自	1.0
抛出	`RuntimeException`

参数

tables: mixed表名或表名列表。

响应

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

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

getTableKeys( table) : mixed||string|int

自	1.0
抛出	`RuntimeException`

参数

table: string表的名称。

响应

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

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

getTableList() : mixed||string|int

自	1.0
抛出	`RuntimeException`

响应

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

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

getVersion() :

自	1.0

响应

string数据库连接器版本。

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

hasUTF8mb4Support() :

自	2.0.0

响应

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

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

hasUtfSupport() :

继承

自	1.0

响应

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

检查数据库服务器是否响应。

healthCheck( host,  port = 3306,  initialWaitInSeconds,  intervalWaitInSeconds = 3,  timeoutInSeconds = 1,  retries = 3) :

todo	这可能应该移到父类中。

参数

host: string主机名或 IP 地址。
port: int端口号。可选；默认为 MySQL 默认值。
initialWaitInSeconds: int在 ping 服务器之前等待的秒数。可选；默认为 0 秒。
intervalWaitInSeconds: int在 ping 服务器之间等待的秒数。可选；默认为 3 秒。
timeoutInSeconds: int服务器响应的超时时间（以秒为单位）。可选；默认为 1 秒。
retries: int重试次数。可选；默认为 3。

响应

bool

获取最后 INSERT 语句的自增值的方法。

insertid() :

自	1.0

响应

mixed最后插入行的自增字段的值。如果该值大于最大 int 值，它将返回一个字符串。

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

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

自	2.0.0
抛出	`RuntimeException`

参数

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

响应

bool

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

isConnectionEncryptionSupported() :

自	2.0.0

响应

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

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

isMariaDb() :

自	2.0.0

响应

bool

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

isMinimumVersion() :

继承

自	1.0

响应

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

测试 MySQLi 连接器是否可用。

isSupported() :

static

自	1.0

响应

bool成功为真，否则为假。

获取数据库查询结果集的第一行，作为 ['field_name' => 'row_value'] 的关联数组的方法。

loadAssoc() :

继承

自	1.0
抛出	`RuntimeException`

响应

mixed返回值或查询失败时的 null。

获取数据库查询结果集行的数组的方法，其中每行都是 ['field_name' => 'row_value'] 的关联数组。行数组可以可选地由字段名键控，但默认情况下是按顺序的数字数组。

loadAssocList( key = null,  column = null) :

继承

注意：选择通过非唯一字段名键控结果数组可能会导致不必要的行为，应避免这样做。

自	1.0
抛出	`RuntimeException`

参数

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

响应

mixed返回值或查询失败时的 null。

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

loadColumn( offset) :

继承

自	1.0
抛出	`RuntimeException`

参数

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

响应

mixed返回值或查询失败时的 null。

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

loadObject( class = stdClass::class) :

继承

自	1.0
抛出	`RuntimeException`

参数

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

响应

mixed返回值或查询失败时的 null。

获取数据库查询结果集行的数组的方法，其中每行都是一个对象。对象数组可以可选地由字段名键控，但默认情况下是按顺序的数字数组。

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

继承

注意：选择通过非唯一字段名键控结果数组可能会导致不必要的行为，应避免这样做。

自	1.0
抛出	`RuntimeException`

参数

key: string要键控结果数组的字段的名称。
class: string要用于返回的行对象的类名。

响应

mixed返回值或查询失败时的 null。

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

loadResult() :

继承

自	1.0
抛出	`RuntimeException`

响应

mixed返回值或查询失败时的 null。

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

loadRow() :

继承

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

自	1.0
抛出	`RuntimeException`

响应

mixed返回值或查询失败时的 null。

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

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

继承

注意：选择通过非唯一字段键控结果数组可能会导致不必要的行为，应避免这样做。

自	1.0
抛出	`RuntimeException`

参数

key: string要键控结果数组的字段的名称。

响应

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

锁定数据库中的表。

lockTable( table) :

自	1.0
抛出	`RuntimeException`

参数

table: string要解锁的表的名称。

响应

$this

准备执行 SQL 语句

prepareStatement( query) : \Joomla\Database\StatementInterface

自	2.0.0
抛出	`PrepareStatementFailureException`

参数

query: string要准备的 SQL 查询。

响应

StatementInterface

quote 方法的别名

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

继承

自	1.0

参数

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

响应

string引用的输入字符串。

quoteName 方法的别名

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

继承

自	1.0

参数

name: array<string|int, mixed>|string要括在引号中的标识符名称，或要括在引号中的标识符名称数组。每种类型都支持点表示法名称。
as: 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

参数

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

响应

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

在数据库查询中使用时，将二进制字符串引用到数据库要求。

quoteBinary( data) :

继承

自	1.7.0

参数

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

响应

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

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

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

继承

自	1.0

参数

name: array<string|int, mixed>|string要括在引号中的标识符名称，或要括在引号中的标识符名称数组。每种类型都支持点表示法名称。
as: 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

参数

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

响应

string引用的标识符字符串。

重命名数据库中的表。

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

自	1.0
抛出	`RuntimeException`

参数

oldTable: string要重命名的表的名称
newTable: string表的新的名称。
backup: stringMySQL 不使用。
prefix: stringMySQL 不使用。

响应

$this

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

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

继承

自	1.0

参数

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

响应

string处理后的 SQL 语句。

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

select( database) :

自	1.0
抛出	`RuntimeException`

参数

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

响应

bool如果数据库选择成功，则为真。

数据库服务器是否声称支持 UTF-8 多字节 (utf8mb4) 排序规则？

serverClaimsUtf8mb4Support() :

libmysql 从 5.5.3 开始支持 utf8mb4（与 MySQL 服务器版本相同）。 mysqlnd 从 5.0.9 开始支持 utf8mb4。

自	1.4.0

响应

bool

设置要使用的调度程序。

setDispatcher(\Joomla\Event\DispatcherInterface dispatcher) :

继承

自	1.2.0

参数

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

响应

$this

设置查询监控器。

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

继承

自	2.0.0

参数

monitor: QueryMonitorInterface|null查询监控器。

响应

$this

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

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

继承

自	1.0
抛出	`InvalidArgumentException`

参数

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

响应

$this

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

setUtf() :

自	1.0

响应

bool成功为真。

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

splitSql( sql) : mixed||string|int

继承 static

自	1.0

参数

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

响应

array<string|int, mixed>

提交事务的方法。

transactionCommit( toSavepoint = false) :

自	1.0
抛出	`RuntimeException`

参数

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

响应

void

回滚事务的方法。

transactionRollback( toSavepoint = false) :

自	1.0
抛出	`RuntimeException`

参数

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

响应

void

初始化事务的方法。

transactionStart( asSavepoint = false) :

自	1.0
抛出	`RuntimeException`

参数

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

响应

void

截断表的方法。

truncateTable( table) :

继承

自	1.0
抛出	`RuntimeException`

参数

table: string要截断的表

响应

void

解锁数据库中的表。

unlockTables() :

自	1.0
抛出	`RuntimeException`

响应

$this

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

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

继承

自	1.0
抛出	`RuntimeException`

参数

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

响应

bool成功为真。

Event Dispatcher

继承

自	1.2.0

Type(s)

DispatcherInterface|null

数据库的名称。

继承

自	1.0

Type(s)

string

数据库驱动程序的名称。

自	1.0

Type(s)

string

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

继承

自	1.4.0

Type(s)

string

数据库连接资源。

自	1.0

Type(s)

mysqli

包含可用数据库连接器的列表。

继承 static

自	1.0

Type(s)

array<string|int, mixed>

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

继承

自	1.0

Type(s)

int

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

继承

自	1.0

Type(s)

资源

包含当前查询执行状态

继承

自	2.0.0

Type(s)

bool

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

继承

自	1.0

Type(s)

int

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

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

自	1.0

Type(s)

string

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

自	1.0

Type(s)

string

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

继承

自	1.0

Type(s)

int

在实例化时传递并保存。

继承

自	1.0

Type(s)

array<string|int, mixed>

要执行的当前 SQL 语句。

继承

自	1.0

Type(s)

混合

准备好的语句。

继承

自	2.0.0

Type(s)

StatementInterface

常见的数据库表前缀。

继承

自	1.0

Type(s)

string

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

继承

自	1.0

Type(s)

bool

数据库错误号。

继承

自	1.0

Type(s)

int

数据库错误消息。

继承

自	1.0

Type(s)

string

DatabaseDriver 实例容器。

继承 static 已弃用

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

Type(s)

array<string|int, DatabaseDriver>

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

static

自	1.0

Type(s)

string

当前事务的深度。

继承

自	1.0

Type(s)

int

DatabaseFactory 对象

继承

自	2.0.0

Type(s)

DatabaseFactory

查询监控器对象

继承

自	2.0.0

Type(s)

QueryMonitorInterface

如果数据库引擎支持 UTF-8 多字节 (utf8mb4) 字符编码，则为真。

自	1.4.0

Type(s)

bool

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

自	2.0.0

Type(s)

bool

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

static

自	2.0.0

Type(s)

string