Index Documentation

SqliteConnectionInfo
in package
implements DbConnectionInfo

Represents information about a SQLite Client.

Table of Contents

Interfaces

DbConnectionInfo
Base type for database connection info.

Methods

__construct()  : SqliteConnectionInfo
Creates a new SqliteConnectionInfo instance.
createMemory()  : SqliteConnectionInfo
Creates a connection info instance for an in-memory database.
createPath()  : SqliteConnectionInfo
Creates a connection info instance with a path.
createTemp()  : SqliteConnectionInfo
Creates a connection info instance for a database stored in a temporary file.
getEncryptionKey()  : string
Returns the key to use for encryption of the database.
getFileName()  : string
Gets the path of the SQLite database.
shouldCreate()  : bool
Returns whether the SQLite database should be created if it does not exist.
shouldReadOnly()  : bool
Returns whether the SQLite database should be opened read-only.

Methods

__construct()

Creates a new SqliteConnectionInfo instance.

public __construct(string $fileName, string $encryptionKey, bool $readOnly, bool $create) : SqliteConnectionInfo
Parameters
$fileName : string

Path to the SQLite database.

$encryptionKey : string

Key to encrypt the database with.

$readOnly : bool

Set to true if the database should be opened read-only.

$create : bool

Set to true to create the database if it does not exist.

Return values
SqliteConnectionInfo —

Information to create an SQLite database client.

createMemory()

Creates a connection info instance for an in-memory database.

public static createMemory([string $encryptionKey = '' ]) : SqliteConnectionInfo
Parameters
$encryptionKey : string = ''

Key to encrypt the database with.

Return values
SqliteConnectionInfo —

Information to create an SQLite database client.

createPath()

Creates a connection info instance with a path.

public static createPath(string $path[, string $encryptionKey = '' ][, bool $readOnly = false ][, bool $create = true ]) : SqliteConnectionInfo
Parameters
$path : string

Path to the SQLite database.

$encryptionKey : string = ''

Key to encrypt the database with.

$readOnly : bool = false

Set to true if the database should be opened read-only.

$create : bool = true

Set to true to create the database if it does not exist.

Return values
SqliteConnectionInfo —

Information to create an SQLite database client.

createTemp()

Creates a connection info instance for a database stored in a temporary file.

public static createTemp([string $encryptionKey = '' ]) : SqliteConnectionInfo
Parameters
$encryptionKey : string = ''

Key to encrypt the database with.

Return values
SqliteConnectionInfo —

Information to create an SQLite database client.

getEncryptionKey()

Returns the key to use for encryption of the database.

public getEncryptionKey() : string
Return values
string —

Encryption key.

getFileName()

Gets the path of the SQLite database.

public getFileName() : string
Return values
string

shouldCreate()

Returns whether the SQLite database should be created if it does not exist.

public shouldCreate() : bool
Return values
bool —

true if the database should be created, false if not.

shouldReadOnly()

Returns whether the SQLite database should be opened read-only.

public shouldReadOnly() : bool
Return values
bool —

true if the database should be opened read-only, false if not.


        

        
    




    

    

                                

                

                                
    

        On this page

        
    


                

                            

            

    

        

            
Search results