PHP Class Jarves\Configuration\Plugin

Inheritance: extends Model
Datei anzeigen Open project: jarves/jarves Class Usage Examples

Protected Properties

Property Type Description
$attributes
$controller string The controller php class name or service id.
$id string
$label string
$options Field[]
$preview boolean If the controller for examples has requirements in queryString its not possible, but the plugin could use a additional preview method (listing() => listingPreview()) that does not have the requirement.
$routes Route[]

Public Methods

Method Description
addOption ( Field $field = null )
addRoute ( Route $route )
getController ( ) : string
getId ( ) : string
getLabel ( ) : string
getOption ( string $id ) : Field
getOptions ( ) : Field[]
getRoutes ( ) : Route[]
isPreview ( ) : boolean
setController ( string $controller )
setId ( string $id )
setLabel ( string $label )
setOptions ( array $options = null )
setPreview ( boolean $preview )
setRoutes ( array $routes = null )

Method Details

addOption() public method

public addOption ( Field $field = null )
$field Field

addRoute() public method

public addRoute ( Route $route )
$route Route

getController() public method

public getController ( ) : string
return string

getId() public method

public getId ( ) : string
return string

getLabel() public method

public getLabel ( ) : string
return string

getOption() public method

public getOption ( string $id ) : Field
$id string
return Field

getOptions() public method

public getOptions ( ) : Field[]
return Field[]

getRoutes() public method

public getRoutes ( ) : Route[]
return Route[]

isPreview() public method

public isPreview ( ) : boolean
return boolean

setController() public method

public setController ( string $controller )
$controller string

setId() public method

public setId ( string $id )
$id string

setLabel() public method

public setLabel ( string $label )
$label string

setOptions() public method

public setOptions ( array $options = null )
$options array

setPreview() public method

public setPreview ( boolean $preview )
$preview boolean

setRoutes() public method

public setRoutes ( array $routes = null )
$routes array

Property Details

$attributes protected_oe property

protected $attributes

$controller protected_oe property

The controller php class name or service id.
protected string $controller
return string

$id protected_oe property

protected string $id
return string

$label protected_oe property

protected string $label
return string

$options protected_oe property

protected Field[],Jarves\Configuration $options
return Field[]

$preview protected_oe property

If the controller for examples has requirements in queryString its not possible, but the plugin could use a additional preview method (listing() => listingPreview()) that does not have the requirement.
protected bool $preview
return boolean

$routes protected_oe property

protected Route[],Jarves\Configuration $routes
return Route[]