PHP Class Airship\Engine\Gadgets

This abstract class simply contains some methods useful for Gadget development
Show file Open project: paragonie/airship Class Usage Examples

Public Methods

Method Description
injectRoutes ( array $injected = [] ) Inject one or more routes to the current Cabin's autopilot route list
loadCargo ( string $name, string $source ) Store cargo to be rendered into a template
loadMigration ( string $key ) : Airship\Engine\Security\Migration\MigrationInterface Find a migration class
registerMigration ( string $key, Airship\Engine\Security\Migration\MigrationInterface $migration ) Register a migration class
setBaseTemplate ( string $path ) Set the base template
unloadCargo ( string $name, integer $offset ) : array Render the contents of a cargo (placeholder)
unloadNextCargo ( string $name ) : array Render the contents of the next cargo (placeholder)

Method Details

injectRoutes() public static method

Inject one or more routes to the current Cabin's autopilot route list
public static injectRoutes ( array $injected = [] )
$injected array

loadCargo() public static method

Store cargo to be rendered into a template
public static loadCargo ( string $name, string $source )
$name string
$source string File path (can be within phar://)

loadMigration() public static method

Find a migration class
public static loadMigration ( string $key ) : Airship\Engine\Security\Migration\MigrationInterface
$key string
return Airship\Engine\Security\Migration\MigrationInterface

registerMigration() public static method

Register a migration class
public static registerMigration ( string $key, Airship\Engine\Security\Migration\MigrationInterface $migration )
$key string
$migration Airship\Engine\Security\Migration\MigrationInterface

setBaseTemplate() public static method

Set the base template
public static setBaseTemplate ( string $path )
$path string

unloadCargo() public static method

Render the contents of a cargo (placeholder)
public static unloadCargo ( string $name, integer $offset ) : array
$name string
$offset integer
return array

unloadNextCargo() public static method

Render the contents of the next cargo (placeholder)
public static unloadNextCargo ( string $name ) : array
$name string
return array