InfoElementContent
in package
implements
ContentAttributesInterface, ContentHeadingAttributeInterface, ContentTextAttributeInterface, ContentGroupIdInterface, JsonSerializable
Class InfoElementContent
This class represents an info element content
Tags
Interfaces, Classes and Traits
- ContentAttributesInterface
- Interface ContentAttributesInterface
- ContentHeadingAttributeInterface
- Interface ContentHeadingAttributeInterface
- ContentTextAttributeInterface
- Interface ContentTextAttributeInterface
- ContentGroupIdInterface
- Interface ContentGroupIdInterface
- JsonSerializable
Table of Contents
- $headings : ContentHeadingCollection
- Localized content headings
- $id : ContentIdentificationInterface
- Content group ID
- $position : string
- Content position
- $status : bool
- Content status
- $texts : ContentHeadingCollection
- Localized content texts
- $titles : ContentTitleCollection
- Localized content titles
- $type : string
- Content type
- __construct() : mixed
- InfoElementContent constructor
- headings() : ContentHeadingCollection
- Return the localized content headings
- id() : ContentIdentificationInterface
- Returns the content group id if set, otherwise null will be returned.
- isActive() : bool
- Return whether the content is active
- jsonSerialize() : mixed
- Specify data which should be serialized to JSON
- position() : string
- Return the content position
- texts() : ContentTextCollection
- Return the localized content texts
- titles() : ContentTitleCollection
- Return the localized content titles
- type() : string
- Return the content type
Properties
$headings
Localized content headings
protected
ContentHeadingCollection
$headings
$id
Content group ID
protected
ContentIdentificationInterface
$id
$position
Content position
protected
string
$position
$status
Content status
protected
bool
$status
$texts
Localized content texts
protected
ContentHeadingCollection
$texts
$titles
Localized content titles
protected
ContentTitleCollection
$titles
$type
Content type
protected
string
$type
Methods
__construct()
InfoElementContent constructor
public
__construct(ContentPositionInterface $elementPosition, ContentStatusInterface $status, ContentTitleCollection $titles, ContentHeadingCollection $headings, ContentTextCollection $texts[, ContentIdentificationInterface $id = null ]) : mixed
Parameters
- $elementPosition : ContentPositionInterface
-
Element position
- $status : ContentStatusInterface
-
Activation status
- $titles : ContentTitleCollection
-
Localized titles
- $headings : ContentHeadingCollection
-
Localized headings
- $texts : ContentTextCollection
-
Localized texts
- $id : ContentIdentificationInterface = null
-
Optional content group ID
Return values
mixed —headings()
Return the localized content headings
public
headings() : ContentHeadingCollection
Return values
ContentHeadingCollection —id()
Returns the content group id if set, otherwise null will be returned.
public
id() : ContentIdentificationInterface
Return values
ContentIdentificationInterface —isActive()
Return whether the content is active
public
isActive() : bool
Return values
bool —jsonSerialize()
Specify data which should be serialized to JSON
public
jsonSerialize() : mixed
Tags
Return values
mixed —data which can be serialized by json_encode, which is a value of any type other than a resource.
position()
Return the content position
public
position() : string
Return values
string —texts()
Return the localized content texts
public
texts() : ContentTextCollection
Return values
ContentTextCollection —titles()
Return the localized content titles
public
titles() : ContentTitleCollection
Return values
ContentTitleCollection —type()
Return the content type
public
type() : string