Core_Html_Entity
extends Core_Servant_Properties
in package
HTML entity
Tags
Table of Contents
- $_allowedProperties : array<string|int, mixed>
- Allowed object properties
- $_attrCommon : array<string|int, mixed>
- Common attributes
- $_attrEvent : array<string|int, mixed>
- Common events
- $_children : array<string|int, mixed>
- List of children elements
- $_data : array<string|int, mixed>
- data-values,
- $_propertiesValues : array<string|int, mixed>
- Properties values
- $_skipProperties : array<string|int, mixed>
- Skip properties
- $_unlimitedProperties : bool
- Object has unlimited number of properties
- $_useAttrCommon : bool
- Use common attributes
- $_useAttrEvent : bool
- Use common events
- __construct() : mixed
- Constructor.
- add() : self
- Add new entity
- addAfter() : self
- Add new entity after $oAdmin_Form_Entity_After
- addAllowedProperties() : self
- Add additional allowed properties
- addAllowedProperty() : self
- Add additional allowed property
- addBefore() : self
- Add new entity before $oAdmin_Form_Entity_Before
- addClass() : self
- Add Class
- addSkipProperty() : self
- Add Skip Property
- clear() : self
- Clear children elements list
- data() : self|string
- Get/set data, e.g. $obj->data('foo', 'bar'); echo $obj->data('foo');
- delete() : self
- Delete child element
- deleteChild() : self
- Delete child by key
- execute() : self
- Executes the business logic.
- executeChildren() : self
- Execute all children
- factory() : object
- Create and return an object of Admin_Form_Entity for current skin
- getAllowedProperties() : array<string|int, mixed>
- Get allowed object properties
- getAttrsString() : array<string|int, mixed>
- Get allowed properties
- getChildren() : array<string|int, mixed>
- Get entity's children
- getCountChildren() : int
- Get count of children entities
- removeClass() : self
- Remove Class
- 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()
$_attrCommon
Common attributes
protected
static array<string|int, mixed>
$_attrCommon
= array('accesskey', 'class', 'dir', 'id', 'lang', 'style', 'tabindex', 'title')
$_attrEvent
Common events
protected
static array<string|int, mixed>
$_attrEvent
= array('onblur', 'onchange', 'onclick', 'ondblclick', 'onfocus', 'onkeydown', 'onkeypress', 'onkeyup', 'onload', 'onmousedown', 'onmousemove', 'onmouseout', 'onmouseover', 'onmouseup', 'onreset', 'onselect', 'onsubmit', 'onunload')
$_children
List of children elements
protected
array<string|int, mixed>
$_children
= array()
$_data
data-values,
protected
array<string|int, mixed>
$_data
= array()
$_propertiesValues
Properties values
protected
array<string|int, mixed>
$_propertiesValues
= array()
$_skipProperties
Skip properties
protected
array<string|int, mixed>
$_skipProperties
= array()
$_unlimitedProperties
Object has unlimited number of properties
protected
bool
$_unlimitedProperties
= \FALSE
$_useAttrCommon
Use common attributes
protected
bool
$_useAttrCommon
= \TRUE
$_useAttrEvent
Use common events
protected
bool
$_useAttrEvent
= \TRUE
Methods
__construct()
Constructor.
public
__construct() : mixed
Return values
mixed —add()
Add new entity
public
add(Admin_Form_Entity $oCore_Html_Entity) : self
Parameters
- $oCore_Html_Entity : Admin_Form_Entity
-
new entity
Return values
self —addAfter()
Add new entity after $oAdmin_Form_Entity_After
public
addAfter(Admin_Form_Entity $oCore_Html_Entity, Admin_Form_Entity $oCore_Html_Entity_After) : self
Parameters
- $oCore_Html_Entity : Admin_Form_Entity
-
new entity
- $oCore_Html_Entity_After : Admin_Form_Entity
-
entity after which to add the new entity
Return values
self —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
self —addAllowedProperty()
Add additional allowed property
public
addAllowedProperty(string $property) : self
Parameters
- $property : string
-
property name
Return values
self —addBefore()
Add new entity before $oAdmin_Form_Entity_Before
public
addBefore(Admin_Form_Entity $oCore_Html_Entity, Admin_Form_Entity $oCore_Html_Entity_Before) : self
Parameters
- $oCore_Html_Entity : Admin_Form_Entity
-
new entity
- $oCore_Html_Entity_Before : Admin_Form_Entity
-
entity before which to add the new entity
Return values
self —addClass()
Add Class
public
addClass(string $className) : self
Parameters
- $className : string
Return values
self —addSkipProperty()
Add Skip Property
public
addSkipProperty(name $name) : self
Parameters
- $name : name
Return values
self —clear()
Clear children elements list
public
clear() : self
Return values
self —data()
Get/set data, e.g. $obj->data('foo', 'bar'); echo $obj->data('foo');
public
data(string $name) : self|string
Parameters
- $name : string
Return values
self|string —delete()
Delete child element
public
delete(Core_Html_Entity $oCore_Html_Entity) : self
Parameters
- $oCore_Html_Entity : Core_Html_Entity
-
element
Return values
self —deleteChild()
Delete child by key
public
deleteChild(int $key) : self
Parameters
- $key : int
Return values
self —execute()
Executes the business logic.
public
execute() : self
Return values
self —executeChildren()
Execute all children
public
executeChildren() : self
Return values
self —factory()
Create and return an object of Admin_Form_Entity for current skin
public
static factory(string $className) : object
Parameters
- $className : string
-
name of class
Return values
object —getAllowedProperties()
Get allowed object properties
public
getAllowedProperties() : array<string|int, mixed>
Return values
array<string|int, mixed> —getAttrsString()
Get allowed properties
public
getAttrsString() : array<string|int, mixed>
Return values
array<string|int, mixed> —getChildren()
Get entity's children
public
getChildren() : array<string|int, mixed>
Return values
array<string|int, mixed> —getCountChildren()
Get count of children entities
public
getCountChildren() : int
Return values
int —removeClass()
Remove Class
public
removeClass(string $className) : self
Parameters
- $className : string
Return values
self —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
self —setUnlimitedProperties()
Set unlimitedProperties
public
setUnlimitedProperties([bool $value = TRUE ]) : self
Parameters
- $value : bool = TRUE
-
default TRUR