Arikaim CMS

Db
in package

Manage database connections

Table of Contents

Properties

$config  : array<string|int, mixed>
Database config
$pdoOptions  : array<string|int, mixed>
PDO options
$capsule  : Manager
Capsule manager object

Methods

__construct()  : mixed
Constructor
checkConnection()  : bool
Verify db connection
createDb()  : bool
Create database
getCapsule()  : Capsule
Return capsule object
getConstraints()  : mixed|false
Get constraint references for column
getDatabaseManager()  : DatabaseManager
Get DatabaseManager
getDatabaseName()  : string|null
Get database name
getInfo()  : array<string|int, mixed>
Get database info
getRelationsMap()  : array<string|int, mixed>|null
Get relations morph map
getRowFormat()  : string|false
Get row format
has()  : bool
Check if database exist
init()  : bool
Create db connection and boot Eloquent
initConnection()  : bool
Init db connection
initSchemaConnection()  : Connection
Add db schema conneciton
isValidConnection()  : bool
Return true if conneciton is valid
isValidPdoConnection()  : bool
Return true if connection is valid
reboot()  : bool
Reboot connection
testConnection()  : bool
Test db connection

Properties

$config

Database config

protected array<string|int, mixed> $config

$pdoOptions

PDO options

protected array<string|int, mixed> $pdoOptions = [\PDO::ATTR_CASE => \PDO::CASE_NATURAL, \PDO::ATTR_ERRMODE => \PDO::ERRMODE_EXCEPTION, \PDO::ATTR_ORACLE_NULLS => \PDO::NULL_NATURAL, \PDO::ATTR_STRINGIFY_FETCHES => false, \PDO::ATTR_EMULATE_PREPARES => false]

$capsule

Capsule manager object

private Manager $capsule

Methods

__construct()

Constructor

public __construct(array<string|int, mixed> $config[, array<string|int, mixed> $relations = [] ]) : mixed
Parameters
$config : array<string|int, mixed>
$relations : array<string|int, mixed> = []

checkConnection()

Verify db connection

public static checkConnection(object $connection) : bool
Parameters
$connection : object
Return values
bool

createDb()

Create database

public createDb(string $databaseName[, string|null $charset = null ][, string|null $collation = null ]) : bool
Parameters
$databaseName : string
$charset : string|null = null
$collation : string|null = null
Return values
bool

getCapsule()

Return capsule object

public getCapsule() : Capsule
Return values
Capsule

getConstraints()

Get constraint references for column

public getConstraints(string|null $tableName[, string|null $columnName = null ]) : mixed|false
Parameters
$tableName : string|null
$columnName : string|null = null
Return values
mixed|false

getDatabaseManager()

Get DatabaseManager

public getDatabaseManager() : DatabaseManager
Return values
DatabaseManager

getDatabaseName()

Get database name

public getDatabaseName() : string|null
Return values
string|null

getInfo()

Get database info

public getInfo() : array<string|int, mixed>
Return values
array<string|int, mixed>

getRelationsMap()

Get relations morph map

public getRelationsMap() : array<string|int, mixed>|null
Return values
array<string|int, mixed>|null

getRowFormat()

Get row format

public getRowFormat(string $tableName) : string|false
Parameters
$tableName : string
Return values
string|false

has()

Check if database exist

public has(string $databaseName) : bool
Parameters
$databaseName : string
Return values
bool

init()

Create db connection and boot Eloquent

public init(array<string|int, mixed> $config) : bool
Parameters
$config : array<string|int, mixed>
Return values
bool

initConnection()

Init db connection

public initConnection(array<string|int, mixed> $config[, string $name = 'default' ]) : bool
Parameters
$config : array<string|int, mixed>
$name : string = 'default'
Return values
bool

initSchemaConnection()

Add db schema conneciton

public initSchemaConnection([array<string|int, mixed>|null $config = null ]) : Connection
Parameters
$config : array<string|int, mixed>|null = null
Return values
Connection

isValidConnection()

Return true if conneciton is valid

public isValidConnection([string|null $name = null ]) : bool
Parameters
$name : string|null = null
Return values
bool

isValidPdoConnection()

Return true if connection is valid

public isValidPdoConnection([array<string|int, mixed>|null $config = null ]) : bool
Parameters
$config : array<string|int, mixed>|null = null
Return values
bool

reboot()

Reboot connection

public reboot([array<string|int, mixed>|null $config = null ]) : bool
Parameters
$config : array<string|int, mixed>|null = null
Return values
bool

testConnection()

Test db connection

public testConnection(array<string|int, mixed> $config) : bool
Parameters
$config : array<string|int, mixed>
Return values
bool 

        

        
    




    

    

                                

                

                                
    

        On this page

        
    


                

                            

            

    

        

            
Search results