Core_Xml_Entity
extends Core_Servant_Properties
in package
XML entity
Tags
Table of Contents
Properties
- $_allowedProperties : array<string|int, mixed>
- Allowed object properties
- $_attributes : array<string|int, mixed>
- Attributes
- $_childrenEntities : array<string|int, mixed>
- Children entities
- $_propertiesValues : array<string|int, mixed>
- Properties values
- $_unlimitedProperties : bool
- Object has unlimited number of properties
- $_xmlTags : array<string|int, mixed>
- External XML tags for entity.
Methods
- __construct() : mixed
- Constructor.
- addAllowedProperties() : self
- Add additional allowed properties
- addAllowedProperty() : self
- Add additional allowed property
- addAttribute() : self
- Add attribute
- addEntities() : self
- Add children entities
- addEntity() : self
- Add a children entity
- addXmlTag() : self
- Add external tag for entity
- clearEntities() : self
- Clear enities
- clearXmlTags() : mixed
- Clear external XML tags for entity.
- getEntities() : array<string|int, mixed>
- Get children entities
- getStdObject() : stdObject
- Get stdObject for entity and children entities
- getXml() : string
- Build entity XML
- getXmlTags() : array<string|int, mixed>
- Get external XML tags for entity.
- set() : self
- Run when writing data to inaccessible properties
- setUnlimitedProperties() : self
- Set unlimitedProperties
Properties
$_allowedProperties
Allowed object properties
protected
array<string|int, mixed>
$_allowedProperties
= array('name', 'value')
$_attributes
Attributes
protected
array<string|int, mixed>
$_attributes
= array()
$_childrenEntities
Children entities
protected
array<string|int, mixed>
$_childrenEntities
= array()
$_propertiesValues
Properties values
protected
array<string|int, mixed>
$_propertiesValues
= array()
$_unlimitedProperties
Object has unlimited number of properties
protected
bool
$_unlimitedProperties
= \FALSE
$_xmlTags
External XML tags for entity.
protected
array<string|int, mixed>
$_xmlTags
= array()
Methods
__construct()
Constructor.
public
__construct() : mixed
addAllowedProperties()
Add additional allowed properties
public
addAllowedProperties(array<string|int, mixed> $array) : self
Parameters
- $array : array<string|int, mixed>
-
array of properties' names
Return values
selfaddAllowedProperty()
Add additional allowed property
public
addAllowedProperty(string $property) : self
Parameters
- $property : string
-
property name
Return values
selfaddAttribute()
Add attribute
public
addAttribute(string $name, string $value) : self
Parameters
- $name : string
- $value : string
Return values
selfaddEntities()
Add children entities
public
addEntities(array<string|int, mixed> $aChildrenEntities) : self
Parameters
- $aChildrenEntities : array<string|int, mixed>
Return values
selfaddEntity()
Add a children entity
public
addEntity(Core_Entity $oChildrenEntity) : self
Parameters
- $oChildrenEntity : Core_Entity
Return values
selfaddXmlTag()
Add external tag for entity
public
addXmlTag(string $tagName, string $tagValue[, array<string|int, mixed> $attributes = array() ]) : self
Parameters
- $tagName : string
-
tag name
- $tagValue : string
-
tag value
- $attributes : array<string|int, mixed> = array()
-
attributes
Return values
selfclearEntities()
Clear enities
public
clearEntities() : self
Return values
selfclearXmlTags()
Clear external XML tags for entity.
public
clearXmlTags() : mixed
getEntities()
Get children entities
public
getEntities() : array<string|int, mixed>
Return values
array<string|int, mixed>getStdObject()
Get stdObject for entity and children entities
public
getStdObject([mixed $attributePrefix = '_' ]) : stdObject
Parameters
- $attributePrefix : mixed = '_'
Return values
stdObjectgetXml()
Build entity XML
public
getXml() : string
Return values
stringgetXmlTags()
Get external XML tags for entity.
public
getXmlTags() : array<string|int, mixed>
Return values
array<string|int, mixed>set()
Run when writing data to inaccessible properties
public
set(string $property, string $value) : self
Parameters
- $property : string
-
property name
- $value : string
-
property value
Return values
selfsetUnlimitedProperties()
Set unlimitedProperties
public
setUnlimitedProperties([bool $value = TRUE ]) : self
Parameters
- $value : bool = TRUE
-
default TRUR