Heratio Framework API Reference

Propel
in package

Propel ORM Shim — Standalone replacement for Propel 1.4.

Provides the Propel static API that AtoM code calls, backed by Laravel's database connection. This allows code using Propel::getConnection() to work without the full Propel ORM.

Shimmed methods: Propel::getConnection() → Returns Laravel's PDO Propel::isInit() → true when Laravel Capsule is booted Propel::initialize() → no-op (Capsule handles init) Propel::setConfiguration() → no-op Propel::setDefaultDB() → no-op Propel::configure() → no-op Propel::getDatabaseMap() → returns stub DatabaseMap Propel::close() → no-op

NOT shimmed (not needed in standalone mode): Propel::getDB() → Propel adapter (unused in AHG code) Propel::getPeer() → Propel peer (unused in AHG code)

Table of Contents

Methods

close()  : void
Close all connections (no-op in standalone — Capsule manages lifecycle).
configure()  : void
Configure Propel (no-op in standalone).
getConnection()  : PDO
Get a PDO connection from Laravel Capsule.
getDatabaseMap()  : mixed
Get the database map (stub).
initialize()  : void
Initialize Propel (no-op in standalone — Capsule handles this).
isInit()  : bool
Check whether the ORM layer is initialized.
markInitialized()  : void
Mark as initialized (used by PropelBridge when it boots real Propel).
setConfiguration()  : void
Set Propel configuration (no-op in standalone).
setDefaultDB()  : void
Set default database name (no-op in standalone).

Methods

close()

Close all connections (no-op in standalone — Capsule manages lifecycle).

public static close() : void

configure()

Configure Propel (no-op in standalone).

public static configure([string $configFile = null ]) : void
Parameters
$configFile : string = null

getConnection()

Get a PDO connection from Laravel Capsule.

public static getConnection([string|null $name = null ]) : PDO
Parameters
$name : string|null = null

Connection name (ignored — single DB)

Return values
PDO

getDatabaseMap()

Get the database map (stub).

public static getDatabaseMap([mixed $name = null ]) : mixed

Only used by CsvImportCommand for schema introspection. Returns a minimal stub that provides getTable().

Parameters
$name : mixed = null

initialize()

Initialize Propel (no-op in standalone — Capsule handles this).

public static initialize() : void

isInit()

Check whether the ORM layer is initialized.

public static isInit() : bool
Return values
bool

markInitialized()

Mark as initialized (used by PropelBridge when it boots real Propel).

public static markInitialized() : void

setConfiguration()

Set Propel configuration (no-op in standalone).

public static setConfiguration(mixed $config) : void
Parameters
$config : mixed

setDefaultDB()

Set default database name (no-op in standalone).

public static setDefaultDB(string $name) : void
Parameters
$name : string

        
On this page

Search results