PHP Class Airship\Cabin\Bridge\Landing\Cabins

Inheritance: extends LoggedInUsersOnly
Show file Open project: paragonie/airship

Public Methods

Method Description
cabinMenu ( string $cabinName = '' )
index ( )
manage ( string $cabinName = '' ) Update Cabin configuration

Protected Methods

Method Description
ensureCabinLinkExists ( string $cabin ) : boolean Ensure that a cabin link exists
getCabinsMotifs ( string $cabin ) : array Get all of the motifs that belong to a particular cabin
loadJSONConfigFile ( string $cabin, string $name, string $ds = DIRECTORY_SEPARATOR ) : array Load a JSON configuration file
saveSettings ( string $cabinName, array $cabins = [], array $post = [] ) : boolean Attempt to save the user-provided cabin configuration
setTemplateExtraData ( string $cabin ) Set the cabin links

Method Details

cabinMenu() public method

public cabinMenu ( string $cabinName = '' )
$cabinName string

ensureCabinLinkExists() protected method

Ensure that a cabin link exists
protected ensureCabinLinkExists ( string $cabin ) : boolean
$cabin string
return boolean

getCabinsMotifs() protected method

Get all of the motifs that belong to a particular cabin
protected getCabinsMotifs ( string $cabin ) : array
$cabin string
return array

index() public method

public index ( )

loadJSONConfigFile() protected method

Load a JSON configuration file
protected loadJSONConfigFile ( string $cabin, string $name, string $ds = DIRECTORY_SEPARATOR ) : array
$cabin string
$name string
$ds string
return array

manage() public method

Update Cabin configuration
public manage ( string $cabinName = '' )
$cabinName string

saveSettings() protected method

Attempt to save the user-provided cabin configuration
protected saveSettings ( string $cabinName, array $cabins = [], array $post = [] ) : boolean
$cabinName string
$cabins array
$post array
return boolean

setTemplateExtraData() protected method

Set the cabin links
protected setTemplateExtraData ( string $cabin )
$cabin string