Methods summary
public
Charcoal\Ui\UiItemInterface
|
#
setType( string|null $type )
Set the UI item type.
Parameters
Returns
Throws
InvalidArgumentException If the type is not a string.
|
public
string
|
#
type( )
Retrieve the UI item type.
Retrieve the UI item type.
Returns
string
|
public
Charcoal\Ui\UiItemInterface
|
#
setTemplate( string $template )
Set the UI item's template.
Set the UI item's template.
Usually, a path to a file containing the template to be rendered.
Parameters
- $template
- A template (identifier).
Returns
Throws
InvalidArgumentException If the template is not a string.
|
public
string
|
#
template( )
Retrieve the UI item's template.
Retrieve the UI item's template.
Returns
string If unset, returns the UI item type.
|
public
Charcoal\Ui\UiItemInterface
|
#
setTitle( mixed $title )
Set the UI item's title.
Parameters
Returns
|
public
Charcoal\Translator\Translation|null
|
#
title( )
Retrieve the title.
Returns
Charcoal\Translator\Translation|null
|
public
Charcoal\Ui\UiItemInterface
|
#
setSubtitle( mixed $subtitle )
Set the UI item's sub-title.
Set the UI item's sub-title.
Parameters
Returns
|
public
Charcoal\Translator\Translation|null
|
#
subtitle( )
Retrieve the sub-title.
Returns
Charcoal\Translator\Translation|null
|
public
Charcoal\Ui\UiItemInterface
|
#
setDescription( mixed $description )
Set the UI item's description.
Set the UI item's description.
Parameters
- $description
- A description.
Returns
|
public
Charcoal\Translator\Translation|null
|
#
description( )
Retrieve the description.
Retrieve the description.
Returns
Charcoal\Translator\Translation|null
|
public
Charcoal\Ui\UiItemInterface
|
#
setNotes( mixed $notes )
Set notes about the UI item.
Set notes about the UI item.
Parameters
Returns
|
public
Charcoal\Translator\Translation|null
|
#
notes( )
Retrieve the notes.
Returns
Charcoal\Translator\Translation|null
|
public
Charcoal\Ui\UiItemInterface
|
#
setShowTitle( boolean $show )
Show/hide the UI item's title.
Show/hide the UI item's title.
Parameters
- $show
- Show (TRUE) or hide (FALSE) the title.
Returns
|
public
boolean
|
#
showTitle( )
Determine if the title is to be displayed.
Determine if the title is to be displayed.
Returns
boolean If TRUE or unset, check if there is a title.
|
public
Charcoal\Ui\UiItemInterface
|
#
setShowSubtitle( boolean $show )
Show/hide the UI item's sub-title.
Show/hide the UI item's sub-title.
Parameters
- $show
- Show (TRUE) or hide (FALSE) the sub-title.
Returns
|
public
boolean
|
#
showSubtitle( )
Determine if the sub-title is to be displayed.
Determine if the sub-title is to be displayed.
Returns
boolean If TRUE or unset, check if there is a sub-title.
|
public
Charcoal\Ui\UiItemInterface
|
#
setShowDescription( boolean $show )
Show/hide the UI item's description.
Show/hide the UI item's description.
Parameters
- $show
- Show (TRUE) or hide (FALSE) the description.
Returns
|
public
boolean
|
#
showDescription( )
Determine if the description is to be displayed.
Determine if the description is to be displayed.
Returns
boolean If TRUE or unset, check if there is a description.
|
public
Charcoal\Ui\UiItemInterface
|
#
setShowNotes( boolean $show )
Show/hide the UI item's notes.
Show/hide the UI item's notes.
Parameters
- $show
- Show (TRUE) or hide (FALSE) the notes.
Returns
|
public
boolean
|
#
showNotes( )
Determine if the notes is to be displayed.
Determine if the notes is to be displayed.
Returns
boolean If TRUE or unset, check if there are notes.
|
public
string
|
#
icon( )
Retrieve the path to the item's icon.
Retrieve the path to the item's icon.
Returns
string
|
public
Charcoal\Ui\UiItemInterface
|
#
setIcon( string $icon )
Set the path to the item's icon associated with the object.
Set the path to the item's icon associated with the object.
Parameters
- $icon
- A path to an image.
Returns
|
abstract protected
Charcoal\Translator\Translator
|
|