PluginEventContent
in package
Table of Contents
Constants
Properties
- $_content : mixed
- $_cssClass : mixed
- $_cssId : mixed
Methods
- __construct() : mixed
- addContent() : mixed
- Add to existing content, by default append but optionally prepend it
- addCssClass() : PluginEventContent
- Add a css class to use for this content
- cleanContent() : PluginEventContent
- Clears exisiting content
- getContent() : mixed
- getCssClass() : mixed
- getCssId() : mixed
- hasContent() : mixed
- setContent() : PluginEventContent
- Replace existing content
- setCssClass() : PluginEventContent
- Set the css class to use for this content
- setCssId() : PluginEventContent
- Set the css id to use for this content
Constants
APPEND
public
mixed
APPEND
= 'append'
PREPEND
public
mixed
PREPEND
= 'prepend'
Properties
$_content
protected
mixed
$_content
= null
$_cssClass
protected
mixed
$_cssClass
= array('pluginblock' => 'pluginblock')
$_cssId
protected
mixed
$_cssId
= ''
Methods
__construct()
public
__construct([string $content = null ][, string $cssClass = null ][, string $id = null ]) : mixed
Parameters
- $content : string = null
- $cssClass : string = null
- $id : string = null
addContent()
Add to existing content, by default append but optionally prepend it
public
addContent([string $content = '' ][, string $placement = self::APPEND ]) : mixed
Parameters
- $content : string = ''
- $placement : string = self::APPEND
-
append or prepend
addCssClass()
Add a css class to use for this content
public
addCssClass(string $cssClass) : PluginEventContent
Parameters
- $cssClass : string
Return values
PluginEventContentcleanContent()
Clears exisiting content
public
cleanContent() : PluginEventContent
Return values
PluginEventContentgetContent()
public
getContent() : mixed
getCssClass()
public
getCssClass() : mixed
getCssId()
public
getCssId() : mixed
hasContent()
public
hasContent() : mixed
setContent()
Replace existing content
public
setContent([string $content = '' ]) : PluginEventContent
Parameters
- $content : string = ''
Return values
PluginEventContentsetCssClass()
Set the css class to use for this content
public
setCssClass(string $cssClass) : PluginEventContent
Parameters
- $cssClass : string
Return values
PluginEventContentsetCssId()
Set the css id to use for this content
public
setCssId(string $id) : PluginEventContent
Parameters
- $id : string