TPage
extends TElement
in package
uses
AdiantiPageControlTrait
Page Controller Pattern: used as container for all elements inside a page and also as a page controller
Tags
Attributes
- #[AllowDynamicProperties]
Table of Contents
Properties
- $children : mixed
- $afterElement : mixed
- $body : mixed
- $constructed : mixed
- $hidden : mixed
- $isVoidElement : mixed
- $loadedcss : mixed
- $loadedjs : mixed
- $properties : mixed
- $registeredcss : mixed
- $tagname : mixed
- $useLineBreaks : mixed
- $useSingleQuotes : mixed
- $voidelements : mixed
- $wrapped : mixed
Methods
- __clone() : mixed
- Clone the object
- __construct() : mixed
- Class Constructor
- __get() : mixed
- Returns a property's value
- __isset() : mixed
- Returns is a property's is set
- __set() : mixed
- Intercepts whenever someones assign a new property's value
- __toString() : mixed
- Converts the object into a string
- __unset() : mixed
- Intercepts whenever someones unset a property's value
- add() : mixed
- Add an child element
- addMany() : mixed
- Add many children
- after() : mixed
- Insert element after
- clearChildren() : mixed
- Clear element children
- close() : mixed
- BC only
- closeTag() : mixed
- Closes the tag
- create() : mixed
- Static creation
- del() : mixed
- Del an child element
- enableVoidElement() : mixed
- Turn element into a void element
- find() : mixed
- Find child element
- get() : mixed
- Get an child element
- getAfterElement() : mixed
- Return the after element
- getChildren() : mixed
- get children
- getClassName() : mixed
- Return the Page name
- getContents() : mixed
- Returns the element content as a string
- getIsWrapped() : mixed
- Return if the element is wrapped inside another one
- getLoadedCSS() : mixed
- Return the loaded Cascade Stylesheet files
- getLoadedJS() : mixed
- Return the loaded JavaScript files
- getName() : mixed
- Returns tag name
- getProperties() : mixed
- Return element properties
- getProperty() : mixed
- Return a property
- getTargetContainer() : mixed
- Return target container
- hide() : mixed
- hide object
- include_css() : mixed
- Include a specific Cascading Stylesheet to this page
- include_js() : mixed
- Include a specific JavaScript function to this page
- insert() : mixed
- Insert an child element
- isMobile() : mixed
- Discover if the browser is mobile device
- open() : mixed
- BC only
- openFile() : mixed
- Open a File Dialog
- openPage() : mixed
- Open a page in new tab
- openTag() : mixed
- Opens the tag
- register_css() : mixed
- Register a specific Cascading Stylesheet to this page
- run() : mixed
- Interprets an action based at the URL parameters
- setCurtainWidth() : mixed
- Set last curtain width
- setIsWrapped() : mixed
- Define if the element is wrapped inside another one
- setName() : mixed
- Change the element name
- setPageName() : mixed
- Set page name
- setPageTitle() : mixed
- Change page title
- setProperties() : mixed
- Set element properties
- setProperty() : mixed
- Set tag property
- setTargetContainer() : mixed
- Set target container for page content
- setUseLineBreaks() : mixed
- Set the use of linebreaks
- setUseSingleQuotes() : mixed
- Set the use of single quotes
- show() : mixed
- Decide wich action to take and show the page
- tag() : mixed
- Create an element
Properties
$children
protected
mixed
$children
$afterElement
private
mixed
$afterElement
$body
private
mixed
$body
$constructed
private
mixed
$constructed
$hidden
private
mixed
$hidden
$isVoidElement
private
mixed
$isVoidElement
$loadedcss
private
static mixed
$loadedcss
$loadedjs
private
static mixed
$loadedjs
$properties
private
mixed
$properties
$registeredcss
private
static mixed
$registeredcss
$tagname
private
mixed
$tagname
$useLineBreaks
private
mixed
$useLineBreaks
$useSingleQuotes
private
mixed
$useSingleQuotes
$voidelements
private
static mixed
$voidelements
$wrapped
private
mixed
$wrapped
Methods
__clone()
Clone the object
public
__clone() : mixed
__construct()
Class Constructor
public
__construct() : mixed
__get()
Returns a property's value
public
__get(mixed $name) : mixed
Parameters
- $name : mixed
-
Property Name
__isset()
Returns is a property's is set
public
__isset(mixed $name) : mixed
Parameters
- $name : mixed
-
Property Name
__set()
Intercepts whenever someones assign a new property's value
public
__set(mixed $name, mixed $value) : mixed
Parameters
- $name : mixed
-
Property Name
- $value : mixed
-
Property Value
__toString()
Converts the object into a string
public
__toString() : mixed
__unset()
Intercepts whenever someones unset a property's value
public
__unset(mixed $name) : mixed
Parameters
- $name : mixed
-
Property Name
add()
Add an child element
public
add(mixed $child) : mixed
Parameters
- $child : mixed
-
Any object that implements the show() method
addMany()
Add many children
public
addMany(mixed $children) : mixed
Parameters
- $children : mixed
-
Array of child
after()
Insert element after
public
after(mixed $element) : mixed
Parameters
- $element : mixed
clearChildren()
Clear element children
public
clearChildren() : mixed
close()
BC only
public
close() : mixed
closeTag()
Closes the tag
public
closeTag() : mixed
create()
Static creation
public
static create() : mixed
del()
Del an child element
public
del(mixed $object) : mixed
Parameters
- $object : mixed
enableVoidElement()
Turn element into a void element
public
enableVoidElement() : mixed
find()
Find child element
public
find(mixed $element[, mixed $properties = null ]) : mixed
Parameters
- $element : mixed
-
tag name
- $properties : mixed = null
-
match properties
get()
Get an child element
public
get(mixed $position) : mixed
Parameters
- $position : mixed
-
Element position
getAfterElement()
Return the after element
public
getAfterElement() : mixed
getChildren()
get children
public
getChildren() : mixed
getClassName()
Return the Page name
public
getClassName() : mixed
getContents()
Returns the element content as a string
public
getContents() : mixed
getIsWrapped()
Return if the element is wrapped inside another one
public
getIsWrapped() : mixed
getLoadedCSS()
Return the loaded Cascade Stylesheet files
public
static getLoadedCSS() : mixed
Tags
getLoadedJS()
Return the loaded JavaScript files
public
static getLoadedJS() : mixed
Tags
getName()
Returns tag name
public
getName() : mixed
getProperties()
Return element properties
public
getProperties() : mixed
getProperty()
Return a property
public
getProperty(mixed $name) : mixed
Parameters
- $name : mixed
-
property name
getTargetContainer()
Return target container
public
getTargetContainer() : mixed
hide()
hide object
public
hide() : mixed
include_css()
Include a specific Cascading Stylesheet to this page
public
static include_css(mixed $css) : mixed
Parameters
- $css : mixed
-
Cascading Stylesheet
include_js()
Include a specific JavaScript function to this page
public
static include_js(mixed $js) : mixed
Parameters
- $js : mixed
-
JavaScript location
insert()
Insert an child element
public
insert(mixed $position, mixed $child) : mixed
Parameters
- $position : mixed
-
Element position
- $child : mixed
-
Any object that implements the show() method
isMobile()
Discover if the browser is mobile device
public
static isMobile() : mixed
open()
BC only
public
open() : mixed
openFile()
Open a File Dialog
public
static openFile(mixed $file[, mixed $basename = null ]) : mixed
Parameters
- $file : mixed
-
File Name
- $basename : mixed = null
openPage()
Open a page in new tab
public
static openPage(mixed $page) : mixed
Parameters
- $page : mixed
openTag()
Opens the tag
public
openTag() : mixed
register_css()
Register a specific Cascading Stylesheet to this page
public
static register_css(mixed $cssname, mixed $csscode) : mixed
Parameters
- $cssname : mixed
-
Cascading Stylesheet Name
- $csscode : mixed
-
Cascading Stylesheet Code
run()
Interprets an action based at the URL parameters
public
run() : mixed
setCurtainWidth()
Set last curtain width
public
setCurtainWidth(mixed $width) : mixed
Parameters
- $width : mixed
setIsWrapped()
Define if the element is wrapped inside another one
public
setIsWrapped(mixed $bool) : mixed
Parameters
- $bool : mixed
setName()
Change the element name
public
setName(mixed $tagname) : mixed
Parameters
- $tagname : mixed
-
Element name
setPageName()
Set page name
public
setPageName(mixed $name) : mixed
Parameters
- $name : mixed
setPageTitle()
Change page title
public
static setPageTitle(mixed $title) : mixed
Parameters
- $title : mixed
setProperties()
Set element properties
public
setProperties(mixed $properties) : mixed
Parameters
- $properties : mixed
setProperty()
Set tag property
public
setProperty(mixed $name, mixed $value) : mixed
Parameters
- $name : mixed
-
Property Name
- $value : mixed
-
Property Value
setTargetContainer()
Set target container for page content
public
setTargetContainer(mixed $container) : mixed
Parameters
- $container : mixed
setUseLineBreaks()
Set the use of linebreaks
public
setUseLineBreaks(mixed $linebreaks) : mixed
Parameters
- $linebreaks : mixed
-
boolean
setUseSingleQuotes()
Set the use of single quotes
public
setUseSingleQuotes(mixed $singlequotes) : mixed
Parameters
- $singlequotes : mixed
-
boolean
show()
Decide wich action to take and show the page
public
show() : mixed
tag()
Create an element
public
static tag(mixed $tagname, mixed $value[, mixed $attributes = NULL ]) : mixed
Parameters
- $tagname : mixed
-
Element name
- $value : mixed
-
Element value
- $attributes : mixed = NULL
-
Element attributes