Vitex Software's Ease Html

WebPage extends Document

Common Web Page class

Tags
author

Vítězslav Dvořák vitex@hippy.cz

Table of Contents

$allItems  : array
Pole odkazů na všechny vložené objekty.
$body  : BodyTag
Objekt samotného těla stránky.
$cascadeStyles  : array
Pole CSS k vykreslení.
$cssPrefix  : string
Default CSS locaton on debian.
$drawStatus  : bool
Byla jiz stranka vykreslena.
$head  : HeadTag
head stránky.
$javaScripts  : array
JavaScripts to be in page
$jqueryJavaScript  : string
Where to look for jquery script
$jsPrefix  : string
Výchozí umístění javascriptů v Debianu.
$lastItem  : object
Odkaz na naposledy přidaný element.
$libVersion  : string
Library version
$myTable  : string|bool
Nepřipojovat se DB.
$pageClosed  : bool
Is page closed for adding new contents ?
$pageParts  : array
Pole objektů a fragmentů k vykreslení.
$pageTitle  : string
Nadpis stránky.
$raiseItems  : array
Které objekty převzít od přebírajícího objektu.
$webPage  : WebPage
Odkaz na základní objekt stránky.
$finalized  : bool
Is class finalized ? Prošel už objekt finalizací ?
$embedName  : string|null
$instance  : mixed
Saves obejct instace (singleton...).
__construct()  : mixed
Content to place inside of body
__toString()  : string
Render Obect (and its contents) as string.
addAsFirst()  : mixed
Vloží jako první element do objektu.
addCSS()  : bool
Add another CSS definition to stack.
addItem()  : Document
Add item into page body
addItemCustom()  : mixed
Vloží další element do objektu.
addItems()  : mixed
Insert an array of elemnts Vloží pole elementů.
addJavaScript()  : int
Vloží javascript do stránky.
addNextTo()  : Embedable|string
Vloží další element za stávající.
addToLastItem()  : Container|null
Přidá položku do poslední vložené položky.
addToScriptsStack()  : int
Vloží javascript do zasobniku skriptu stránky.
afterAdd()  : mixed
Method executed after adding object into new one
arrayToUrlParams()  : mixed
Vrací pole jako parametry URL.
draw()  : mixed
Provede vykreslení obsahu objektu.
drawAllContents()  : mixed
Projde rekurzivně všechny vložené objekty a zavolá jeich draw().
drawIfNotDrawn()  : mixed
Vykresli se, pokud již tak nebylo učiněno.
embedablize()  : Embedable
Always return Embedable item
emptyContents()  : mixed
Vyprázní obsah webstránky Empty webpage contents
finalize()  : mixed
Method executed before rendering
finalizeRegistred()  : mixed
Provede finalizaci všech registrovaných objektů.
getContents()  : mixed
Get body Contentets
getFirstPart()  : mixed
Vrací první vloženou položku.
getGetValue()  : string
Vrací hodnotu klíče pramatru volání stránky.
getItemsCount()  : int
Vrací počet vložených položek.
getPageTitle()  : string
getPostValue()  : string
Vrací hodnotu klíče pramatru volání stránky.
getRendered()  : string
Vrací rendrovaný obsah objektů.
getRequestValue()  : mixed
Vrací hodnotu klíče prametru volání stránky.
getRequestValues()  : array
Vrací pole $_REQUEST.
getStatusMessagesBlock()  : DivTag
Use this to show status messages on page
getTagID()  : string|null
Get ID for page body
getUri()  : string
Vrací požadovanou adresu.
includeCss()  : bool
Vloží do stránky odkaz na CSS definici.
includeJavaScript()  : string
Includuje Javascript do stránky.
isEmpty()  : bool
Je element prázdný ? Is body element empty ?
isFinalized()  : bool
Vrací stav návěští finalizace části.
isFormPosted()  : bool
Byla stránka zobrazena po odeslání formuláře metodou POST ?
isPosted()  : bool
Is page called by Form Post ?
lastItem()  : Embedable|string
Vrací odkaz na poslední vloženou položku.
onlyForLogged()  : mixed
Nepřihlášeného uživatele přesměruje na přihlašovací stránku.
phpSelf()  : string
Returns the current URL. This is instead of PHP_SELF which is unsafe.
redirect()  : mixed
Perform http redirect
registerItem()  : mixed
Zaregistruje položku k finalizaci.
sanitizeAsType()  : mixed
Ošetří proměnou podle jejího očekávaného typu.
setEmbedName()  : bool
Notify component about its embed name
setFinalized()  : mixed
Set label of parts finalized.
setPageTitle()  : mixed
Nastaví titul webové stánky.
setTagID()  : string
Set ID for page body
singleton()  : WebPage
suicide()  : mixed
Umožní již vloženému objektu se odstranit ze stromu k vykreslení.
webPage()  : WebPage
Vrací nebo registruje instanci webové stránky.

Properties

$allItems

Pole odkazů na všechny vložené objekty.

public static array $allItems = []

$cascadeStyles

Pole CSS k vykreslení.

public array $cascadeStyles = null

$cssPrefix

Default CSS locaton on debian.

public string $cssPrefix = '/javascript/'

$drawStatus

Byla jiz stranka vykreslena.

public bool $drawStatus = false

$javaScripts

JavaScripts to be in page

public array $javaScripts = null

$jqueryJavaScript

Where to look for jquery script

public string $jqueryJavaScript = 'https://cdnjs.cloudflare.com/ajax/libs/jquery/3.3.1/jquery.min.js'

$jsPrefix

Výchozí umístění javascriptů v Debianu.

public string $jsPrefix = '/javascript/'

$lastItem

Odkaz na naposledy přidaný element.

public object $lastItem = null

$libVersion

Library version

public static string $libVersion = 1.0

$myTable

Nepřipojovat se DB.

public string|bool $myTable = false

$pageClosed

Is page closed for adding new contents ?

public static bool $pageClosed = false

$pageParts

Pole objektů a fragmentů k vykreslení.

public array $pageParts = []

Array of objects and fragments to draw

$pageTitle

Nadpis stránky.

public string $pageTitle = null

$raiseItems

Které objekty převzít od přebírajícího objektu.

public array $raiseItems = ['SetUpUser' => 'User', 'webPage', 'OutputFormat']

$webPage

Odkaz na základní objekt stránky.

public static WebPage $webPage = null

$finalized

Is class finalized ? Prošel už objekt finalizací ?

protected bool $finalized = false

$embedName

private string|null $embedName = null

$instance

Saves obejct instace (singleton...).

private static mixed $instance = null

Methods

__construct()

Content to place inside of body

public __construct([ $pageTitle = null ][,  $toBody = [] ]) : mixed
Parameters
$pageTitle : = null

string

$toBody : = []

mixed

Return values
mixed

__toString()

Render Obect (and its contents) as string.

public __toString() : string
Return values
string

addAsFirst()

Vloží jako první element do objektu.

public addAsFirst(mixed $pageItem[, string $pageItemName = null ]) : mixed
Parameters
$pageItem : mixed

hodnota nebo EaseObjekt s metodou draw()

$pageItemName : string = null

Pod tímto jménem je objekt vkládán do stromu

Return values
mixed

Odkaz na vložený objekt

addCSS()

Add another CSS definition to stack.

public addCSS(string $css) : bool
Parameters
$css : string

definice CSS pravidla

Return values
bool

addItem()

Add item into page body

public addItem(mixed $item[, string $pageItemName = null ]) : Document
Parameters
$item : mixed

vkládaná položka

$pageItemName : string = null

Pod tímto jménem je objekt vkládán do stromu

Return values
Document

poiner to object well included

addItemCustom()

Vloží další element do objektu.

public static addItemCustom(Embedable|string $pageItem, Embedable $context) : mixed
Parameters
$pageItem : Embedable|string

hodnota nebo EaseObjekt s metodou draw()

$context : Embedable

Objekt do nějž jsou prvky/položky vkládány

Return values
mixed

Odkaz na vložený objekt

addItems()

Insert an array of elemnts Vloží pole elementů.

public addItems(array $itemsArray) : mixed
Parameters
$itemsArray : array

pole hodnot nebo EaseObjektů s metodou draw()

Return values
mixed

addJavaScript()

Vloží javascript do stránky.

public addJavaScript(string $javaScript[, string $position = null ][, bool $inDocumentReady = true ]) : int
Parameters
$javaScript : string

JS code

$position : string = null

končná pozice: '+','-','0','--',...

$inDocumentReady : bool = true

vložit do DocumentReady bloku ?

Return values
int

addNextTo()

Vloží další element za stávající.

public addNextTo(mixed $pageItem) : Embedable|string
Parameters
$pageItem : mixed

hodnota nebo EaseObjekt s metodou draw()

Return values
Embedable|string

Odkaz na vložený objekt

addToLastItem()

Přidá položku do poslední vložené položky.

public addToLastItem(object $pageItem) : Container|null
Parameters
$pageItem : object

hodnota nebo EaseObjekt s metodou draw()

Return values
Container|null

success

addToScriptsStack()

Vloží javascript do zasobniku skriptu stránky.

public addToScriptsStack(string $code, string $position) : int
Parameters
$code : string

JS code

$position : string

končná pozice: '+','-','0','--',...

Return values
int

afterAdd()

Method executed after adding object into new one

public afterAdd() : mixed
Return values
mixed

arrayToUrlParams()

Vrací pole jako parametry URL.

public static arrayToUrlParams(array $params[, string $baseUrl = '' ]) : mixed
Parameters
$params : array
$baseUrl : string = ''
Return values
mixed

draw()

Provede vykreslení obsahu objektu.

public draw() : mixed
Return values
mixed

drawAllContents()

Projde rekurzivně všechny vložené objekty a zavolá jeich draw().

public drawAllContents() : mixed
Return values
mixed

drawIfNotDrawn()

Vykresli se, pokud již tak nebylo učiněno.

public drawIfNotDrawn() : mixed

Draw contents not drawn yet.

Return values
mixed

embedablize()

Always return Embedable item

public static embedablize(mixed $item) : Embedable
Parameters
$item : mixed
Return values
Embedable

emptyContents()

Vyprázní obsah webstránky Empty webpage contents

public emptyContents() : mixed
Return values
mixed

finalize()

Method executed before rendering

public finalize() : mixed
Return values
mixed

finalizeRegistred()

Provede finalizaci všech registrovaných objektů.

public finalizeRegistred() : mixed
Return values
mixed

getContents()

Get body Contentets

public getContents() : mixed
Return values
mixed

getFirstPart()

Vrací první vloženou položku.

public getFirstPart() : mixed
Return values
mixed

getGetValue()

Vrací hodnotu klíče pramatru volání stránky.

public static getGetValue(string $field[, string $sanitizeAs = null ]) : string
Parameters
$field : string

klíč GET

$sanitizeAs : string = null

ošetřit vrácenou hodnotu jako float|int|string

Return values
string

getItemsCount()

Vrací počet vložených položek.

public getItemsCount() : int

Obtain number of enclosed items in current page body or given object.

Return values
int

nuber of parts enclosed

getPageTitle()

public getPageTitle() : string
Return values
string

getPostValue()

Vrací hodnotu klíče pramatru volání stránky.

public static getPostValue(string $field[, string $sanitizeAs = null ]) : string
Parameters
$field : string

klíč POST

$sanitizeAs : string = null

ošetřit vrácenou hodnotu jako float|int|string

Return values
string

getRendered()

Vrací rendrovaný obsah objektů.

public getRendered() : string
Return values
string

getRequestValue()

Vrací hodnotu klíče prametru volání stránky.

public static getRequestValue(string $field[, string $sanitizeAs = null ]) : mixed
Parameters
$field : string

klíč POST nebo GET

$sanitizeAs : string = null

ošetřit vrácenou hodnotu jako float|int|string

Return values
mixed

getRequestValues()

Vrací pole $_REQUEST.

public getRequestValues() : array
Return values
array

getStatusMessagesBlock()

Use this to show status messages on page

public getStatusMessagesBlock([array $properties = [] ]) : DivTag
Parameters
$properties : array = []

Div properties

Return values
DivTag

getTagID()

Get ID for page body

public getTagID() : string|null
Return values
string|null

Page BODY ID

getUri()

Vrací požadovanou adresu.

public static getUri() : string
Return values
string

includeCss()

Vloží do stránky odkaz na CSS definici.

public includeCss(string $cssFile[, bool $fwPrefix = false ][, string $media = 'screen' ]) : bool
Parameters
$cssFile : string

url CSS souboru

$fwPrefix : bool = false

Přidat cestu frameworku ? (obvykle /Ease/)

$media : string = 'screen'

screen|printer|braile a podobně

Return values
bool

success

includeJavaScript()

Includuje Javascript do stránky.

public includeJavaScript(string $javaScriptFile[, string $position = null ]) : string
Parameters
$javaScriptFile : string

soubor s javascriptem

$position : string = null

končná pozice: '+','-','0','--',...

Return values
string

isEmpty()

Je element prázdný ? Is body element empty ?

public isEmpty([mixed $element = null ]) : bool
Parameters
$element : mixed = null
Return values
bool

emptyness

isFinalized()

Vrací stav návěští finalizace části.

public isFinalized() : bool
Return values
bool

isFormPosted()

Byla stránka zobrazena po odeslání formuláře metodou POST ?

public static isFormPosted() : bool
Tags
category

requestValue

Return values
bool

isPosted()

Is page called by Form Post ?

public static isPosted() : bool
Return values
bool

lastItem()

Vrací odkaz na poslední vloženou položku.

public lastItem() : Embedable|string
Return values
Embedable|string

onlyForLogged()

Nepřihlášeného uživatele přesměruje na přihlašovací stránku.

public onlyForLogged([string $loginPage = 'login.php' ][, mixed $message = null ]) : mixed
Parameters
$loginPage : string = 'login.php'

adresa přihlašovací stránky

$message : mixed = null
Return values
mixed

phpSelf()

Returns the current URL. This is instead of PHP_SELF which is unsafe.

public static phpSelf([bool $dropqs = true ]) : string
Parameters
$dropqs : bool = true

whether to drop the querystring or not. Default true

Return values
string

the current URL or NULL for php-cli

redirect()

Perform http redirect

public redirect(string $url) : mixed
Parameters
$url : string

redirect to URL

Return values
mixed

registerItem()

Zaregistruje položku k finalizaci.

public static registerItem(mixed &$itemPointer) : mixed
Parameters
$itemPointer : mixed
Return values
mixed

sanitizeAsType()

Ošetří proměnou podle jejího očekávaného typu.

public static sanitizeAsType(mixed $value, string $sanitizeAs) : mixed
Parameters
$value : mixed

hodnota

$sanitizeAs : string

typ hodnoty int|string|float|null

Return values
mixed

setEmbedName()

Notify component about its embed name

public setEmbedName(string $embedName) : bool
Parameters
$embedName : string

parent::$pageParts[$embedName] == self

Return values
bool

success

setFinalized()

Set label of parts finalized.

public setFinalized([bool $flag = true ]) : mixed

Nastaví návěstí finalizace části.

Parameters
$flag : bool = true

příznak finalizace

Return values
mixed

setPageTitle()

Nastaví titul webové stánky.

public setPageTitle(string $pageTitle) : mixed
Parameters
$pageTitle : string

titulek

Return values
mixed

setTagID()

Set ID for page body

public setTagID([mixed $tagID = null ]) : string
Parameters
$tagID : mixed = null
Return values
string

singleton()

public static singleton([mixed $webPage = null ]) : WebPage
Parameters
$webPage : mixed = null
Return values
WebPage

suicide()

Umožní již vloženému objektu se odstranit ze stromu k vykreslení.

public suicide() : mixed
Return values
mixed

webPage()

Vrací nebo registruje instanci webové stránky.

public static webPage([WebPage $oPage = null ]) : WebPage
Parameters
$oPage : WebPage = null

objekt webstránky k zaregistrování

Return values
WebPage

Search results