PHP Class Sulu\Component\Content\Compat\Property

Inheritance: implements Sulu\Component\Content\Compat\PropertyInterface, implements JsonSerializable
Show file Open project: sulu/sulu Class Usage Examples

Protected Properties

Property Type Description
$propertyValue Sulu\Component\Content\Document\Structure\PropertyValue Constructor.

Public Methods

Method Description
__clone ( )
__construct ( $name, $metaData, $contentTypeName, $mandatory = false, $multilingual = true, $maxOccurs = 1, $minOccurs = 1, $params = [], $tags = [], $col = null )
__get ( $property ) magic getter for twig templates.
addTag ( PropertyTag $tag ) : PropertyTag add a property tag.
getColspan ( ) : string returns column span.
getContentTypeName ( ) : string returns name of content type.
getInfoText ( string $languageCode ) : string returns infoText of property.
getIsBlock ( ) : boolean returns TRUE if property is a block.
getIsMultiple ( ) : boolean returns TRUE if property is multiple.
getMandatory ( ) : boolean returns field is mandatory.
getMaxOccurs ( ) : integer return max occurs.
getMetadata ( ) : Metadata
getMinOccurs ( ) : integer return min occurs.
getMultilingual ( ) : boolean returns field is multilingual.
getName ( ) : string returns name of template.
getParams ( ) : array parameter of property.
getPlaceholder ( string $languageCode ) : string returns placeholder of property.
getStructure ( ) : Sulu\Component\Content\Compat\StructureInterface returns structure.
getTag ( string $tagName ) : PropertyTag returns tag with given name.
getTags ( ) : PropertyTag[] returns tags defined in xml.
getTitle ( string $languageCode ) : string returns title of property.
getValue ( ) : mixed gets the value from property.
hasTag ( $tagName ) : boolean return true if a tag with the given name exists.
isMandatory ( ) : boolean returns mandatory.
isMultilingual ( ) : boolean returns multilingual.
jsonSerialize ( )
setPropertyValue ( PropertyValue $propertyValue )
setStructure ( Sulu\Component\Content\Compat\StructureInterface $structure )
setValue ( mixed $value ) sets the value from property.
setValueByReference ( &$value )
toArray ( $depth = null )

Method Details

__clone() public method

public __clone ( )

__construct() public method

public __construct ( $name, $metaData, $contentTypeName, $mandatory = false, $multilingual = true, $maxOccurs = 1, $minOccurs = 1, $params = [], $tags = [], $col = null )

__get() public method

magic getter for twig templates.
public __get ( $property )
$property

addTag() public method

add a property tag.
public addTag ( PropertyTag $tag ) : PropertyTag
$tag PropertyTag
return PropertyTag

getColspan() public method

returns column span.
public getColspan ( ) : string
return string

getContentTypeName() public method

returns name of content type.
public getContentTypeName ( ) : string
return string

getInfoText() public method

returns infoText of property.
public getInfoText ( string $languageCode ) : string
$languageCode string
return string

getIsBlock() public method

returns TRUE if property is a block.
public getIsBlock ( ) : boolean
return boolean

getIsMultiple() public method

returns TRUE if property is multiple.
public getIsMultiple ( ) : boolean
return boolean

getMandatory() public method

returns field is mandatory.
public getMandatory ( ) : boolean
return boolean

getMaxOccurs() public method

return max occurs.
public getMaxOccurs ( ) : integer
return integer

getMetadata() public method

public getMetadata ( ) : Metadata
return Metadata

getMinOccurs() public method

return min occurs.
public getMinOccurs ( ) : integer
return integer

getMultilingual() public method

returns field is multilingual.
public getMultilingual ( ) : boolean
return boolean

getName() public method

returns name of template.
public getName ( ) : string
return string

getParams() public method

parameter of property.
public getParams ( ) : array
return array

getPlaceholder() public method

returns placeholder of property.
public getPlaceholder ( string $languageCode ) : string
$languageCode string
return string

getStructure() public method

returns structure.
public getStructure ( ) : Sulu\Component\Content\Compat\StructureInterface
return Sulu\Component\Content\Compat\StructureInterface

getTag() public method

returns tag with given name.
public getTag ( string $tagName ) : PropertyTag
$tagName string
return PropertyTag

getTags() public method

returns tags defined in xml.
public getTags ( ) : PropertyTag[]
return PropertyTag[]

getTitle() public method

returns title of property.
public getTitle ( string $languageCode ) : string
$languageCode string
return string

getValue() public method

gets the value from property.
public getValue ( ) : mixed
return mixed

hasTag() public method

return true if a tag with the given name exists.
public hasTag ( $tagName ) : boolean
return boolean

isMandatory() public method

returns mandatory.
public isMandatory ( ) : boolean
return boolean

isMultilingual() public method

returns multilingual.
public isMultilingual ( ) : boolean
return boolean

jsonSerialize() public method

public jsonSerialize ( )

setPropertyValue() public method

public setPropertyValue ( PropertyValue $propertyValue )
$propertyValue Sulu\Component\Content\Document\Structure\PropertyValue

setStructure() public method

public setStructure ( Sulu\Component\Content\Compat\StructureInterface $structure )
$structure Sulu\Component\Content\Compat\StructureInterface

setValue() public method

sets the value from property.
public setValue ( mixed $value )
$value mixed

setValueByReference() public method

public setValueByReference ( &$value )

toArray() public method

public toArray ( $depth = null )

Property Details

$propertyValue protected property

Constructor.
protected PropertyValue,Sulu\Component\Content\Document\Structure $propertyValue
return Sulu\Component\Content\Document\Structure\PropertyValue