Vitex Software's Ease Html

HtmlMailer extends Document

Build & Send email Sestaví a odešle mail.

Tags
author

Vitex vitex@hippy.cz

Table of Contents

$allItems  : array
Pole odkazů na všechny vložené objekty.
$crLf  : mixed
$drawStatus  : bool
Byla jiz stranka vykreslena.
$emailAddress  : string
Adresa odesilatele zprávy.
$emailSubject  : mixed
$finalized  : mixed
$fromEmailAddress  : string
Emailová adresa odesilatele.
$htmlBody  : BodyTag
Ukazatel na BODY html dokumentu.
$htmlBodyRendered  : string
Již vzrendrované HTML.
$htmlDocument  : HtmlTag
Objekt stránky pro rendrování do mailu.
$htmlHead  : SimpleHtmlHeadTag
$lastItem  : object
Odkaz na naposledy přidaný element.
$libVersion  : string
Library version
$mailBody  : mixed
$mailer  : mixed
Objekt pro odesílání pošty.
$mailHeaders  : mixed
$mailHeadersDone  : mixed
$mimer  : mixed
$notify  : bool
Zobrazovat uživateli informaci o odeslání zprávy ?
$pageClosed  : bool
Is page closed for adding new contents ?
$pageParts  : array
Pole objektů a fragmentů k vykreslení.
$parameters  : array
Parametry odchozí pošty.
$raiseItems  : array
Které objekty převzít od přebírajícího objektu.
$sendResult  : bool
Byla již zpráva odeslána ?
$textBody  : mixed
$webPage  : WebPage
Odkaz na základní objekt stránky.
$embedName  : string|null
$instance  : mixed
Saves obejct instace (singleton...).
__construct()  : mixed
Ease Mail - sestaví a odešle.
__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.
addFile()  : mixed
Připojí k mailu přílohu ze souboru.
addItem()  : mixed
Přidá položku do těla mailu.
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()  : Container
Vloží další element za stávající.
addToLastItem()  : Container|null
Přidá položku do poslední vložené položky.
afterAdd()  : mixed
Method executed after adding object into new one
arrayToUrlParams()  : mixed
Vrací pole jako parametry URL.
draw()  : mixed
Do not draw mail included in page
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 objektu.
finalize()  : mixed
Sestavení těla mailu.
getContents()  : mixed
getFirstPart()  : mixed
Vrací první vloženou položku.
getGetValue()  : string
Vrací hodnotu klíče pramatru volání stránky.
getItemsCount()  : int
Obtain item count
getMailHeader()  : string
Vrací obsah poštovní hlavičky.
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.
getUri()  : string
Vrací požadovanou adresu.
includeCss()  : bool
Include an CSS file call into page.
includeJavaScript()  : string
Includuje Javascript do stránky.
isEmpty()  : bool
Is object 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()  : Brick|mixed
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.
send()  : mixed
Send mail.
setEmbedName()  : bool
Notify component about its embed name
setFinalized()  : mixed
Set label of parts finalized.
setMailHeaders()  : bool
Nastaví hlavičky mailu.
setUserNotification()  : mixed
Nastaví návěští uživatelské notifikace.
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 = []

$drawStatus

Byla jiz stranka vykreslena.

public bool $drawStatus = false

$emailAddress

Adresa odesilatele zprávy.

public string $emailAddress = 'postmaster@localhost'

$fromEmailAddress

Emailová adresa odesilatele.

public string $fromEmailAddress = null

$htmlBodyRendered

Již vzrendrované HTML.

public string $htmlBodyRendered = null

$htmlDocument

Objekt stránky pro rendrování do mailu.

public HtmlTag $htmlDocument = null

$htmlHead

public SimpleHtmlHeadTag $htmlHead = null

$lastItem

Odkaz na naposledy přidaný element.

public object $lastItem = null

$libVersion

Library version

public static string $libVersion = 1.0

$mailer

Objekt pro odesílání pošty.

public mixed $mailer = null

$mailHeadersDone

public mixed $mailHeadersDone = null

$notify

Zobrazovat uživateli informaci o odeslání zprávy ?

public bool $notify = true

$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

$parameters

Parametry odchozí pošty.

public array $parameters = []

$raiseItems

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

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

$sendResult

Byla již zpráva odeslána ?

public bool $sendResult = false

$webPage

Odkaz na základní objekt stránky.

public static WebPage $webPage = null

$embedName

private string|null $embedName = null

$instance

Saves obejct instace (singleton...).

private static mixed $instance = null

Methods

__construct()

Ease Mail - sestaví a odešle.

public __construct(string $emailAddress, string $mailSubject[, mixed $emailContents = null ]) : mixed
Parameters
$emailAddress : string

adresa

$mailSubject : string

předmět

$emailContents : mixed = null

tělo - libovolný mix textu a EaseObjektů

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

css definice

Return values
bool

addFile()

Připojí k mailu přílohu ze souboru.

public addFile(string $filename[, string $mimeType = 'text/plain' ]) : mixed
Parameters
$filename : string

cesta/název souboru k přiložení

$mimeType : string = 'text/plain'

MIME typ přílohy

Return values
mixed

addItem()

Přidá položku do těla mailu.

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

EaseObjekt nebo cokoliv s metodou draw();

$pageItemName : mixed = null
Return values
mixed

ukazatel na vložený obsah

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) : Container
Parameters
$pageItem : mixed

hodnota nebo EaseObjekt s metodou draw()

Return values
Container

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

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()

Do not draw mail included in page

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 objektu.

public emptyContents() : mixed

Empty container contents

Return values
mixed

finalize()

Sestavení těla mailu.

public finalize() : mixed
Return values
mixed

getContents()

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()

Obtain item count

public getItemsCount() : int
Return values
int

getMailHeader()

Vrací obsah poštovní hlavičky.

public getMailHeader(string $headername) : string
Parameters
$headername : string

název hlavičky

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

getUri()

Vrací požadovanou adresu.

public static getUri() : string
Return values
string

includeCss()

Include an CSS file call into page.

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

cesta k souboru vkládanému do stránky

$fwPrefix : bool = false

přidat prefix frameworku (obvykle /Ease/) ?

$media : string = 'screen'

médium screen|print|braile apod ...

Return values
bool

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()

Is object empty ?

public isEmpty() : bool
Return values
bool

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() : Brick|mixed
Return values
Brick|mixed

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

send()

Send mail.

public send() : mixed
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

setMailHeaders()

Nastaví hlavičky mailu.

public setMailHeaders(mixed $mailHeaders) : bool
Parameters
$mailHeaders : mixed

asociativní pole hlaviček

Return values
bool

true pokud byly hlavičky nastaveny

setUserNotification()

Nastaví návěští uživatelské notifikace.

public setUserNotification(bool $notify) : mixed
Parameters
$notify : bool

požadovaný stav notifikace

Return values
mixed

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