PHP Class Airship\Cabin\Hull\Blueprint\CustomPages

Custom web pages
Inheritance: extends BlueprintGear
Afficher le fichier Open project: paragonie/airship Class Usage Examples

Protected Properties

Свойство Type Description
$cabin string

Méthodes publiques

Méthode Description
getDirectoryId ( string $dir, integer $parent, string $cabin = '' ) : integer Get the directory ID for a given path
getLatestVersion ( integer $pageId ) : array Get the latest version of a custom page
getPage ( string $file, integer $directoryId, string $cabin = '' ) : array Get information about a custom page.
getPageById ( integer $pageId ) : array Get information about a custom page.
getParentDir ( array $dirs = [], string $cabin = '' ) : integer Get the parent directory
getParentDirFromStr ( string $dir, string $cabin = '' ) : integer Get the parent directory
getPathFromDirectoryId ( integer $directoryId, string $cabin = '', array $idsEncountered = [] ) : array Get all of the parent directories' URL components
serveRedirect ( string $uri ) : boolean If a redirect exists at this path, serve it.
setCabin ( string $cabin ) : self Set the cabin for this gear

Method Details

getDirectoryId() public méthode

Get the directory ID for a given path
public getDirectoryId ( string $dir, integer $parent, string $cabin = '' ) : integer
$dir string
$parent integer
$cabin string
Résultat integer

getLatestVersion() public méthode

Get the latest version of a custom page
public getLatestVersion ( integer $pageId ) : array
$pageId integer
Résultat array

getPage() public méthode

Get information about a custom page.
public getPage ( string $file, integer $directoryId, string $cabin = '' ) : array
$file string
$directoryId integer
$cabin string
Résultat array

getPageById() public méthode

Get information about a custom page.
public getPageById ( integer $pageId ) : array
$pageId integer
Résultat array

getParentDir() public méthode

Get the parent directory
public getParentDir ( array $dirs = [], string $cabin = '' ) : integer
$dirs array
$cabin string
Résultat integer

getParentDirFromStr() public méthode

Get the parent directory
public getParentDirFromStr ( string $dir, string $cabin = '' ) : integer
$dir string
$cabin string
Résultat integer

getPathFromDirectoryId() public méthode

Get all of the parent directories' URL components
public getPathFromDirectoryId ( integer $directoryId, string $cabin = '', array $idsEncountered = [] ) : array
$directoryId integer
$cabin string
$idsEncountered array Prevent infinite loops
Résultat array

serveRedirect() public méthode

If a redirect exists at this path, serve it.
public serveRedirect ( string $uri ) : boolean
$uri string
Résultat boolean

setCabin() public méthode

Set the cabin for this gear
public setCabin ( string $cabin ) : self
$cabin string
Résultat self

Property Details

$cabin protected_oe property

protected string $cabin
Résultat string