Heratio Framework API Reference

DatabaseBootstrap
in package

Database bootstrap for Laravel Query Builder.

Replaces Propel Criteria with modern, fluent query interface.

Tags
author

Johan Pieterse johan@theahg.co.za

Table of Contents

Methods

getCapsule()  : Manager|null
Get the Capsule instance.
getConnectionInfo()  : array<string|int, mixed>
Get connection info for debugging.
initialize()  : void
Initialize Laravel Query Builder using AtoM's database credentials.
initializeFromAtom()  : void
Initialize from AtoM's databases.yml configuration.
testConnection()  : bool
Test database connection.

Methods

getCapsule()

Get the Capsule instance.

public static getCapsule() : Manager|null

Returns the instance from either this class or bootstrap.php initialization.

Return values
Manager|null

getConnectionInfo()

Get connection info for debugging.

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

initialize()

Initialize Laravel Query Builder using AtoM's database credentials.

public static initialize(array<string|int, mixed> $config) : void
Parameters
$config : array<string|int, mixed>

initializeFromAtom()

Initialize from AtoM's databases.yml configuration.

public static initializeFromAtom([string $environment = 'all' ]) : void
Parameters
$environment : string = 'all'

testConnection()

Test database connection.

public static testConnection() : bool
Return values
bool

        
On this page

Search results