Joomla CMS  4.2.2
Documentation des API du CMS Joomla en version 4.2.2
Référence de la classe SqliteDriver
+ Graphe d'héritage de SqliteDriver:

Fonctions membres publiques

 __destruct ()
 
 alterDbCharacterSet ($dbName)
 
 connect ()
 
 createDatabase ($options, $utf=true)
 
 escape ($text, $extra=false)
 
 getCollation ()
 
 getConnectionCollation ()
 
 getConnectionEncryption ()
 
 isConnectionEncryptionSupported ()
 
 getTableCreate ($tables)
 
 getTableColumns ($table, $typeOnly=true)
 
 getTableKeys ($table)
 
 getTableList ()
 
 getVersion ()
 
 select ($database)
 
 setUtf ()
 
 lockTable ($table)
 
 renameTable ($oldTable, $newTable, $backup=null, $prefix=null)
 
 truncateTable ($table)
 
 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 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 = 'sqlite'
 
- Champs de données hérités de PdoDriver
 $name = 'pdo'
 
- Champs de données hérités de DatabaseDriver
 $serverType
 

Attributs protégés

 $nameQuote = '`'
 
- 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
 

Membres hérités additionnels

- 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 statiques hérités de DatabaseDriver
static $connectors = []
 
static $instances = []
 
static $dbMinimum
 

Description détaillée

SQLite database driver supporting PDO based connections

1.0

Documentation des constructeurs et destructeur

◆ __destruct()

__destruct ( )

Destructor.

Depuis
1.0

Références DatabaseDriver\disconnect().

Documentation des fonctions membres

◆ alterDbCharacterSet()

alterDbCharacterSet (   $dbName)

Alter database's character set.

Paramètres
string$dbNameThe database name that will be altered
Renvoie
boolean|resource
Depuis
2.0.0
Exceptions

◆ connect()

connect ( )

Connects to the database if needed.

Renvoie
void Returns void if the database connected successfully.
Depuis
2.0.0
Exceptions
RuntimeException

Implémente DatabaseInterface.

Références null.

Référencé par SqliteDriver\getTableColumns(), SqliteDriver\getTableCreate(), SqliteDriver\getTableKeys(), SqliteDriver\getTableList(), SqliteDriver\getVersion(), SqliteDriver\select(), SqliteDriver\setUtf(), SqliteDriver\transactionCommit(), SqliteDriver\transactionRollback(), et SqliteDriver\transactionStart().

◆ createDatabase()

createDatabase (   $options,
  $utf = true 
)

Create a new database using information from $options object.

Paramètres
\stdClass$optionsObject used to pass user and database name to database driver. This object must have "db_name" and "db_user" set.
boolean$utfTrue if the database supports the UTF-8 character set.
Renvoie
boolean|resource
Depuis
2.0.0
Exceptions

Implémente DatabaseInterface.

◆ escape()

escape (   $text,
  $extra = false 
)

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

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

Paramètres
string$textThe string to be escaped.
boolean$extraUnused optional parameter to provide extra escaping.
Renvoie
string The escaped string.
Depuis
1.0

Implémente DatabaseInterface.

Références $text.

◆ 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 or boolean false if not supported.
Depuis
1.0

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.

◆ getTableColumns()

getTableColumns (   $table,
  $typeOnly = true 
)

Retrieves field information about a given table.

Paramètres
string$tableThe name of the database table.
boolean$typeOnlyTrue 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 $columns, $field, $fields, SqliteDriver\connect(), PdoDriver\getOption(), PdoDriver\setOption(), et DatabaseDriver\setQuery().

◆ getTableCreate()

getTableCreate (   $tables)

Shows the table CREATE statement that creates the given tables.

Note: Doesn't appear to have support in SQLite

Paramètres
mixed$tablesA 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 SqliteDriver\connect().

◆ getTableKeys()

getTableKeys (   $table)

Get the details list of keys for a table.

Paramètres
string$tableThe 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 $rows, SqliteDriver\connect(), PdoDriver\getOption(), PdoDriver\setOption(), et DatabaseDriver\setQuery().

◆ getTableList()

getTableList ( )

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

Renvoie
array An array of all the tables in the database.
Depuis
1.0
Exceptions

Implémente DatabaseInterface.

Références $query, $type, SqliteDriver\connect(), DatabaseDriver\getQuery(), 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 SqliteDriver\connect(), 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.

◆ isSupported()

static isSupported ( )
static

Test to see if the PDO ODBC 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$tableThe name of the table to unlock.
Renvoie
$this
Depuis
1.0
Exceptions

Implémente DatabaseInterface.

Références $this.

◆ renameTable()

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

Renames a table in the database.

Paramètres
string$oldTableThe name of the table to be renamed
string$newTableThe new name for the table.
string$backupNot used by Sqlite.
string$prefixNot used by Sqlite.
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$databaseThe 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 SqliteDriver\connect().

◆ setUtf()

setUtf ( )

Set the connection to use UTF-8 character encoding.

Returns false automatically for the Oracle driver since you can only set the character set when the connection is created.

Renvoie
boolean True on success.
Depuis
1.0

Références SqliteDriver\connect().

◆ transactionCommit()

transactionCommit (   $toSavepoint = false)

Method to commit a transaction.

Paramètres
boolean$toSavepointIf true, commit to the last savepoint.
Renvoie
void
Depuis
1.0
Exceptions

Implémente DatabaseInterface.

Références SqliteDriver\connect().

◆ transactionRollback()

transactionRollback (   $toSavepoint = false)

Method to roll back a transaction.

Paramètres
boolean$toSavepointIf true, rollback to the last savepoint.
Renvoie
void
Depuis
1.0
Exceptions

Implémente DatabaseInterface.

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

◆ transactionStart()

transactionStart (   $asSavepoint = false)

Method to initialize a transaction.

Paramètres
boolean$asSavepointIf 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, SqliteDriver\connect(), DatabaseDriver\quoteName(), et DatabaseDriver\setQuery().

◆ truncateTable()

truncateTable (   $table)

Method to truncate a table.

Paramètres
string$tableThe table to truncate
Renvoie
void
Depuis
1.2.1
Exceptions

Implémente DatabaseInterface.

Références 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.

Documentation des champs

◆ $name

$name = 'sqlite'

◆ $nameQuote

$nameQuote = '`'
protected

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