PHP Class Airship\Cabin\Hull\Landing\CustomPages

Custom page handler.
Inheritance: extends LandingGear
Show file Open project: paragonie/airship

Protected Properties

Property Type Description
$cabin string
$pages Airship\Cabin\Hull\Blueprint\CustomPages

Public Methods

Method Description
airshipLand ( ) This function is called after the dependencies have been injected by AutoPilot. Think of it as a user-land constructor.
routeNotFound ( $args ) : void This interrupts requests if all else fails.

Protected Methods

Method Description
render ( array $latest ) : string Render a custom page
serveCustomPage ( string $file, array $dirs = [] ) : boolean Public API entry point for serving a custom page
serveFile ( string $file, integer $directoryId ) : boolean Serve a file
serveLatestVersion ( array $page ) : boolean Server the latest version of a custom page.

Method Details

airshipLand() public method

This function is called after the dependencies have been injected by AutoPilot. Think of it as a user-land constructor.
public airshipLand ( )

render() protected method

Render a custom page
protected render ( array $latest ) : string
$latest array
return string

routeNotFound() public method

This interrupts requests if all else fails.
public routeNotFound ( $args ) : void
$args
return void

serveCustomPage() protected method

Public API entry point for serving a custom page
protected serveCustomPage ( string $file, array $dirs = [] ) : boolean
$file string
$dirs array
return boolean

serveFile() protected method

Serve a file
protected serveFile ( string $file, integer $directoryId ) : boolean
$file string
$directoryId integer
return boolean

serveLatestVersion() protected method

Server the latest version of a custom page.
protected serveLatestVersion ( array $page ) : boolean
$page array
return boolean

Property Details

$cabin protected property

protected string $cabin
return string

$pages protected property

protected CustomPages,Airship\Cabin\Hull\Blueprint $pages
return Airship\Cabin\Hull\Blueprint\CustomPages