Docs For Class Pxxo

Class Pxxo_Widget

Description

Classe mère de tous les widgets

copyright: Copyright (c) 2008 Nicolas Thouvenin
license: http://opensource.org/licenses/bsd-license.php

Pxxo
   |
   --Pxxo_Widget

Variable Summary

boolean $CacheMode

string $CachePath

string $CacheTime

mixed $ClassAlias

mixed $ClassID

mixed $ClassName

array $Components

string $CurrentMode

string $DefaultMode

Pxxo_Buffers $Headers

string $HiddenMode

string $Lang

boolean $LoadingMode

integer $MinifyLevel

boolean $ModeCaptived

boolean $ModeChanged

boolean $ModeSelected

string $OutputMode

Pxxo_Action $Parent

boolean $PersistentMode

boolean $PrependVar

boolean $PreviousMode

string $ResourcePath

Pxxo_Buffers $Resources

string $ResourceURL

Pxxo_Response $Response

mixed $Return

string $StandaloneMode

mixed $State

string $TemplatePath

array $Templates

string $Theme

string $ThemePaths

Zend_Translate $Translate

string $TranslateAdapter

mixed $TranslateData

array $TranslateOptions

mixed $varnamemode

string $_cached

Pxxo_Widget $_decorated

Pxxo_Widget $_decorated_leaf

Pxxo_Widget_Decorator $_decorator

array $_onetime

array $_options

array $_params

boolean $_returned

array $_vars

mixed $_vars_privates

mixed $_vars_protected

array $_vars_public

object Pxxo_View $_view

Method Summary

Pxxo_Widget __construct (string $options, string $filename)

void addDecorator (mixed $deco, [array $decoparams = array()])

boolean addThemePath (string $s, [boolean $e = false])

void checkSession ()

string chooseDefaultMode ()

void chooseMode (string 0)

integer computeCacheID ()

boolean connect (string $event, object récepteur $objet, string $mode, [mixed $param = null])

null delPersistentVar (string $n)

null delSessionVar (string $n)

void dump ()

void dumphead ([bool $return = false])

string dynResource (string $filename, string $typ_rsc)

void enableCache ()

void execMode (string $m)

string get ()

Pxxo_Buffer getBuffer ()

string getDefaultMode ()

mixed getInputVar (string $n, [string $v = null])

string getMode ()

mixed getPersistentVar (string $n, [string $v = ''])

array getProtectedVars ()

array getPublicVars ()

mixed getSessionVar (string $n, [string $v = null])

string getTemplate ([string $s = null])

string getThemeFile (string $s, [string $r = null])

Zend_View getViewObject ()

void initMode ()

void initTemplate ()

void initTranslate ()

boolean isPrivateVar (string $k)

boolean isProtectedVar (string $k)

boolean loadComponent (string $name)

array loadResource (string $filename, [string $type = 'Html'])

void main ()

void putData (string $id, Pxxo_Buffer $value)

void putFile (string $id, string $filename)

void putImage (string $filename, [string $id = null])

void putMedia (string $filename, [string $id = null])

void putOnceImage (string $filename, [string $id = null])

string putOnceScript (string $filename, [string $disposition = 'file'])

string putOnceStyle (string $filename, [string $media = 'screen'])

void putScript (string $filename, [string $disposition = 'file'])

void putStyle (string $filename, [string $media = 'screen'])

void putTitle ( $s)

mixed putWidget (string $id, Pxxo_Widget $o)

void putXSLT (string $id, string $xsl, string $xml, [array $par = array()], [boolean $php = false], [string $engine = 'auto'])

void setDefaultMode (string $s)

void setHeaders (Pxxo_Buffers $h)

mixed setInputVar (string $n, string $v)

void setLifetime (integer $lt)

void setMode (string $s)

void setOneTimeMode (string $s)

string setPersistentVar (string $n, string $v)

void setProtectedVars (array $tab)

void setPublicVars (array $tab)

void setResourcePath (string $s)

void setResources (Pxxo_Buffers $b)

void setResourceURL (string $s)

void setSessionVar (string $n, string $v)

void setTemplate (string $a, [string $t = null])

void setTemplatePath (string $s)

void setTemplateRaw (string $a, string $t)

Pxxo_Buffer stackComponent (Pxxo_Component $son)

string _ (string 0)

Variables

boolean $CacheMode = null (line 200)

var: Active ou non le mode cache
access: public

string $CachePath = '' (line 205)

var: lieu de stockage du cache
access: public

string $CacheTime = 4000 (line 210)

var: temps de stockage dans le cache
access: public

mixed $ClassAlias = null (line 309)

Nom donné par un Composant Parent

access: public

mixed $ClassID = null (line 303)

Identifiant UNIQUE pour chaque instance de la classe

access: public

mixed $ClassName = null (line 297)

Nom UNIQUE de définition de la classe

access: public

array $Components = array() (line 69)

Tableau d'objet Pxxo_Component contenant tous fils de l'objet courant

access: public

string $CurrentMode = null (line 127)

Mode (ou action) en cours de traitment

access: public

string $DefaultMode = 'index' (line 133)

Mode (ou action) à exécuter par défaut

access: public

Pxxo_Buffers $Headers (line 80)

var: Tableau contenant des informations destinées à l'entete HTML de la page terminale
access: public

string $HiddenMode = false (line 169)

Active le mode caché ! Attention incompatible avec le controller...

Ne peut être modidfié uniquement un surchargant cette déclaration

access: public

string $Lang = null (line 228)

Langue active

var: null par défaut ce qui indique que cette valeur prendra la même que son objet parent
access: public

boolean $LoadingMode = true (line 162)

var: active le chargement automatiques des ressources
access: public

integer $MinifyLevel = null (line 145)

Niveau de filtre appliqué sur la sortie

access: public

boolean $ModeCaptived = false (line 184)

var: le mode actuel ne pourra produire de résultat car un mode fils à déclencher le mode Standalone
access: public

boolean $ModeChanged = false (line 174)

var: vient-on de changer de mode ?
access: public

boolean $ModeSelected = false (line 179)

var: le mode actuel vient-il d'être séléctionné volontairement
access: public

string $OutputMode = 'html' (line 139)

Type de contenu produit en sortie

access: public

Pxxo_Action $Parent = null (line 63)

Pointeur vers l'objet parent de l'objet courant

access: public

boolean $PersistentMode = false (line 151)

mode persistant ou non (cad : le mode reste actif tant que l'on n'en change pas explicitement)

access: public

boolean $PrependVar = false (line 195)

Permet d'ajouter automatiquement un prefix aux variables accessible avec les méthodes getXxxxVar() et setXxxxVar()

access: public

boolean $PreviousMode = '' (line 189)

var: le Mode précendent
access: public

string $ResourcePath = '' (line 291)

Chemin physique correspondant à l'URL d'accès aux ressources du composant

access: public

Pxxo_Buffers $Resources (line 75)

Tableau d'objet Pxxo_Buffer contenant toutes les ressources de l'objet courant

access: public

string $ResourceURL = '' (line 285)

URL d'accès aux ressources du composant

access: public

Pxxo_Response $Response = null (line 85)

var: Gestion de l'entete HTTP
access: public

mixed $Return = null (line 320)

var: Contient la valeur retournée par la méthode du dernier mode executé...
access: public

string $StandaloneMode = false (line 157)

Cet objet va produire une page terminale

access: public

mixed $State = false (line 216)

Indique l'état dans lequel se trouve l'objet

access: public

string $TemplatePath = '' (line 273)

Chemin physique par défaut des templates de l'objet

access: public

array $Templates = array() (line 279)

Tableau associant un mode à un objet Pxxo_Buffer

access: public

string $Theme = '' (line 259)

Nom du thème actif

access: public

string $ThemePaths = '' (line 267)

Liste de chemin physique de répertoire contenant des themes

Exemple : ./themes:/var/httpd/www/themes

var: des chemins séparer par PATH_SEPARATOR
access: public

Zend_Translate $Translate = null (line 252)

Module de Traduction

access: public

string $TranslateAdapter = 'Array' (line 240)

Adapter de traduction

access: public

mixed $TranslateData = null (line 234)

Donnée permettant les traductions

access: public

array $TranslateOptions = array() (line 246)

Options du Module de Traduction

access: public

mixed $varnamemode = null (line 222)

Nom de la variable permettant de choisir le mode (ou l'action) à traiter

access: public

string $_cached = false (line 315)

Contenu du cache

access: private

Pxxo_Widget $_decorated = NULL (line 367)

var: instance de ce que l'on décore (peut pointer sur un décorateur)
access: protected

Pxxo_Widget $_decorated_leaf = NULL (line 372)

var: instance du widget que l'on décore (ne peut pas pointer sur un decorateur)
access: protected

Pxxo_Widget_Decorator $_decorator = NULL (line 362)

var: instance de l'éventuel décorateur
access: protected

array $_onetime = array() (line 121)

Liste des modes "OneTime"

access: private

array $_options = array(
// Variable de classe => son equivalent dans Pxxo::config
'Theme' => 'theme_name',
'ThemePaths' => 'theme_path',
'TemplatePath' => 'templates_path',
'ResourcePath' => 'resources_path',
'ResourceURL' => 'resources_url',
'CachePath' => 'cache_path',
'CacheMode' => 'cache_flag',
'CacheTime' => 'cache_time',
'Lang' => 'language',
'PrependVar' => 'undefined',
'MinifyLevel' => 'undefined',
'StandaloneMode' => 'undefined',
'PersistentMode' => 'undefined',
'DefaultMode' => 'undefined',
'CurrentMode' => 'undefined',
'ClassName' => 'undefined',
'TranslateData' => 'undefined',
'TranslateAdapter'=> 'undefined',
'TranslateOptions'=> 'undefined',
) (line 331)

var: Tableau contenant les variables de classes modifiables à la construction de l'objet
access: private

array $_params = array() (line 357)

var: liste des options du widgets
access: protected

boolean $_returned = false (line 325)

var: la première méthode correspondant à un mode qui retourne une valeur à gagner...
access: private

array $_vars = array() (line 97)

Liste des variables utilisées pas l'objet

access: private

mixed $_vars_privates = array('Parent', 'Templates', 'Components', 'Resources', 'widget', 'Response') (line 109)

Liste des variables privées de l'objet en plus des variables préfixées par _

access: private

mixed $_vars_protected = array('Resources', 'CurrentMode') (line 115)

Liste des variables devant être mise en cache en plus des variables non privées

access: private

array $_vars_public = null (line 103)

Liste des variables publique de la classe (calculées automatiquement)

access: private

object Pxxo_View $_view = null (line 91)

Object View

access: private

Inherited Variables

Inherited from Pxxo

Pxxo::$_bench
Pxxo::$_cache
Pxxo::$_cache_options
Pxxo::$_cache_options_default
Pxxo::$_caching
Pxxo::$_debugging
Pxxo::$_debug_options
Pxxo::$_debug_options_default
Pxxo::$_idcache
Pxxo::$_ids
Pxxo::$_levelcache

Methods

Constructor __construct (line 383)

Constructeur

Pxxo_Widget __construct (string $options, string $filename)

string $options: tableau des paramètres du composants
string $filename: chemin complet du fichier de définition du widget

Redefinition of:

Pxxo::__construct(): Constructeur

addDecorator (line 1026)

Permet de décorer le widget courant avec un widget particulier

Les widgets décorator dérivent de Pxxo_Widget_Decorator et permettent de modifier l'apparence ou le comportement du widget courant Exemples : rajouter des bords, ajaxiser, ajouter un corps html

access: public

void addDecorator (mixed $deco, [array $decoparams = array()])

mixed $deco: nom ou instance du décorateur
array $decoparams: paramètres du décorateur si ce n'est pas une isnstance

addThemePath (line 1722)

Ajout d'un chemin à la liste des chemins de thème

return: ajoute oui/non
access: protected

boolean addThemePath (string $s, [boolean $e = false])

string $s
boolean $e: en entete

checkSession (line 1740)

Vérifie qu'une session est initialisée avant de placer de fixer des variables de sessions

access: private

void checkSession ()

chooseDefaultMode (line 783)

retourne le mode par défaut (utile surtout pour gérer la rétro compatibilité avec l'ancien mode 'defaut')

access: public

string chooseDefaultMode ()

chooseMode (line 802)

quel mode doit être executé

access: protected

void chooseMode (string 0)

string 0: nom du mode à exécuter

computeCacheID (line 1492)

Calcul un identifiant de cache

access: protected

integer computeCacheID ()

connect (line 1616)

Méthode permettant de "connecter" les modes de 2 objets

Si l'objet est dans le mode $event, alors on postionne dans l'objet $objet le mode $mode si on fournit un tableau comme quatrième argument on lancera l'éxécution de la méthode correspondant au mode récèpteur chaque valeur du tableau sera passée en paramètre à cette méthode auquel on ajoutera comme dernier paramètre la valeur du retour de l'exécution de la méthode déclencheur Cette dernière valeur peut-être null si

return: vrai si la connection a été faite faux sinon
access: public

boolean connect (string $event, object récepteur $objet, string $mode, [mixed $param = null])

string $event: nom du mode déclencheur
object récepteur $objet
string $mode: nom du mode récepteur
mixed $param: paramètres envoyé au mode récepteur

delPersistentVar (line 1474)

Supprime toute apparition d'une variable persistante

access: public

null delPersistentVar (string $n)

string $n

delSessionVar (line 1373)

Supprime une variable de session

access: public

null delSessionVar (string $n)

string $n: nom de la variable

dump (line 1309)

Affiche le résultat

access: public

void dump ()

dumphead (line 2009)

Affiche en html toutes les informations destinées à l'entete de la page : Headers et Resources

access: public

void dumphead ([bool $return = false])

bool $return: false pour retourner le contenu des balises générées, true pour les afficher directement

dynResource (line 1894)

construction d'une ressource dynamique comme un template HTML

return: identifiant de la ressource
access: private

string dynResource (string $filename, string $typ_rsc)

string $filename: nom du fichier (son emplacement sera déduit en fonction du theme)
string $typ_rsc: type du fichier

enableCache (line 2154)

Quand on démarre le cache on fixe (si et seulement si ce n'est pas déjà fait)

un niveau de cache standard

access: public

void enableCache ()

Redefinition of:

Pxxo::enableCache(): mise en route du cache

execMode (line 758)

On exécute la méthode correpondant à un mode donné

access: protected

void execMode (string $m)

string $m: nom du mode à exécuter

get (line 1297)

Sortie du résultat

access: public

string get ()

getBuffer (line 1262)

Sortie du résultat sous forme de flux

access: public

Pxxo_Buffer getBuffer ()

getDefaultMode (line 1225)

on renvoit le mode qui sera exécuté par défaut

access: public

string getDefaultMode ()

getInputVar (line 1392)

Methode permettant de récupèrer une variable en provenance du client Si on le trouve pas, on renvoit la valeur par défaut ou null

return: Valeur du parametre
access: public

mixed getInputVar (string $n, [string $v = null])

string $n: nom
string $v: valeur par défaut si il n'existe pas

getMode (line 1151)

Le mode correspond à la méthode "Action" à déclencher

Par défaut cette méthode va chercher le "mode" dans les variables _POST ou _GET.

return: Le mode trouvé ou sinon null
access: public

string getMode ()

getPersistentVar (line 1431)

Methode permettant de récupérer une variable persistante

Une variable persistante est une variable généralement en provenance du client dont la dernière affectation persistante dans le temps (même si le client ne la positionne plus) Si on le trouve pas on la fixe à une valeur par défaut

access: public

mixed getPersistentVar (string $n, [string $v = ''])

string $n: nom
string $v: valeur par défaut si il n'existe pas

getProtectedVars (line 1521)

Renvoit un tableau contenant les variables protegées de la classe

access: private

array getProtectedVars ()

getPublicVars (line 1536)

Renvoit un tableau contenant les variables publiques de la classe

access: private

array getPublicVars ()

getSessionVar (line 1339)

Récupère une variable de session si elle n'existe pas on la crée on on l'affecte avec une valeur par défaut

return: Valeur du parametre
access: public

mixed getSessionVar (string $n, [string $v = null])

string $n: nom
string $v: valeur par défaut si il n'existe pas

getTemplate (line 1801)

Retourne le fichier de Template à utiliser

access: public

string getTemplate ([string $s = null])

string $s: on peut forcer un mode

getThemeFile (line 1651)

Recherche un fichier interne à la classe en fonction de ThemePaths et de ThemeName et renvoit son emplacement et son nom

return: la référence physique du fichier donnée en paramètre
access: public

string getThemeFile (string $s, [string $r = null])

string $s: un nom fichier
string $r: une valeur de retour si on trouve pas le fichier (on évite une erreur)

getViewObject (line 2143)

retourne l'objet view utilisé

access: public

Zend_View getViewObject ()

initMode (line 747)

Cette méthode est toujours exéctuée avant le mode courant

access: protected

void initMode ()

initTemplate (line 1774)

Devine le nom des templates associés à l'action courant ou à l'action par défaut

access: protected

void initTemplate ()

initTranslate (line 2061)

Initialise le moteur de traduction

access: protected

void initTranslate ()

isPrivateVar (line 1581)

On teste si le nom de la variable donnée en argument correspond à une variable qui ne doit pas être envoyée à la VIEW

return: Description
access: private

boolean isPrivateVar (string $k)

string $k: nom du variable

isProtectedVar (line 1594)

On teste si le nom de la variable donnée en argument correspond à une variable qui peut éventuellment être envoyée à la vue

return: Description
access: private

boolean isProtectedVar (string $k)

string $k: nom du variable

loadComponent (line 2033)

Charge le fichier de définition d'une classe

On vérifie que le nom de la classe donnée en paramètre est correct On recherche un fichier de définition/déclaration de la cette classe On le charge en mémoire (on fait un include_once)

return: true la classe existe et on put l'utiliser la classe est inutilisable...
access: public

boolean loadComponent (string $name)

string $name: nom d'une classe

loadResource (line 1091)

On recherche automatiquement les ressources liées un fichier de ressource

Exemples : pour un fichier HTML, on incluera les Javascript, les CSS et les images pour un fichier Javascript, on incluera les CSS et les images pour un fichier CSS, on incluera les images

Les inclusion se font dans l'ordre inverse. D'abord les images, puis les CSS, puis les scripts, puis les

return: Description
access: private

array loadResource (string $filename, [string $type = 'Html'])

string $filename: nom d'un fichier
string $type: type du fichier (Image|Style|Script|Html)

main (line 825)

Execution du widget

access: public

void main ()

putData (line 524)

Ajout de donnée

void putData (string $id, Pxxo_Buffer $value)

string $id: identifiant dans les templates
Pxxo_Buffer $value: instance d'un flux

putFile (line 538)

Ajout le contenu d'un template dans une zone

void putFile (string $id, string $filename)

string $id: identifiant dans les templates
string $filename: fichier

putImage (line 663)

see: Pxxo_Widget::putOnceImage()
access: public

void putImage (string $filename, [string $id = null])

string $filename: nom du fichier (son emplacement sera déduit en fonction du theme)
string $id: identifiant dans les templates

putMedia (line 681)

Ajout d'un media Dynamique (calculé comme un template)

Un média est une ressource externe à la page référencé dans celle-ci par une URL Exemple : un fichier svg, swf, png, etc ...

void putMedia (string $filename, [string $id = null])

string $filename: nom du fichier (son emplacement sera déduit en fonction du theme)
string $id: identifiant du widget dans les templates

putOnceImage (line 637)

Ajout d'une image (statique) Si l'identifiant n'est pas choisit, celui ci sera automatiquement égale au nom (en majuscule) du fichier sans son suffixe

access: public

void putOnceImage (string $filename, [string $id = null])

string $filename: nom du fichier (son emplacement sera déduit en fonction du theme)
string $id: identifiant dans les templates

putOnceScript (line 603)

Ajout de Javascript

le javascript est contenu dans un fichier. Ce fichier fonctionne comme un template.

return: identifiant de la ressources dans $this->Resources

string putOnceScript (string $filename, [string $disposition = 'file'])

string $filename: nom du fichier (son emplacement sera déduit en fonction du theme)
string $disposition: disposition du code (dans un fichier externe ou à l'intérieur de la page)

putOnceStyle (line 563)

Ajout de CSS

le CSS est contenu dans un fichier. Ce fichier fonctionne comme un template.

return: identifiant de la ressources dans $this->Resources

string putOnceStyle (string $filename, [string $media = 'screen'])

string $filename: nom du fichier (son emplacement sera déduit en fonction du theme)
string $media: media destibation des templates

putScript (line 620)

see: Pxxo_Widget::putOnceScript()
access: public

void putScript (string $filename, [string $disposition = 'file'])

string $filename: nom du fichier (son emplacement sera déduit en fonction du theme)
string $disposition: disposition du code (dans un fichier externe ou à l'intérieur de la page)

putStyle (line 585)

see: Pxxo_Widget::putOnceStyle()

void putStyle (string $filename, [string $media = 'screen'])

string $filename: nom du fichier (son emplacement sera déduit en fonction du theme)
string $media: media destibation des templates

putTitle (line 700)

Ajout d'un titre

void putTitle ( $s)

putWidget (line 502)

Ajout d'un widget sous forme de composant

si l'identifiant est null on attache un widget au Widget courant sans pour autant le mettre à disposition du template mais renvoyant simplement le rendu sous forme d'une chaine de caractères

mixed putWidget (string $id, Pxxo_Widget $o)

string $id: identifiant du widget dans les templates
Pxxo_Widget $o: instance d'un widget

putXSLT (line 718)

Ajout d'une transformation XSL

access: public

void putXSLT (string $id, string $xsl, string $xml, [array $par = array()], [boolean $php = false], [string $engine = 'auto'])

string $id: identifiant dans les templates
string $xsl: fichier xsl présent dans ThemePaths ou chaine de caractères
string $xml: fichier xml présent dans ThemePaths ou chaine de caractères
array $par: paramètres pour la transformation
boolean $php: Booléen permettant d'activer l'exécution de code php éventuellement générer par la transformation (par défaut: false)
string $engine: nom du parseur XSLT à utiliser. Les valeurs possibles sont : domxslt, xsltproc (par défaut automatique)

setDefaultMode (line 1236)

On fixe le mode, l'action, la méthode qui sera exécuté par défaut.

access: public

void setDefaultMode (string $s)

string $s

setHeaders (line 1881)

On fixe toutes entetes de l'objet d'un seul coup

access: public

void setHeaders (Pxxo_Buffers $h)

Pxxo_Buffers $h

setInputVar (line 1412)

Methode permettant de forcer une variable en provenance du client

return: Valeur du parametre
access: public

mixed setInputVar (string $n, string $v)

string $n: nom
string $v: valeur

setLifetime (line 2168)

Fixe la durée de vie du cache (de toutes les caches possibles)

access: public

void setLifetime (integer $lt)

integer $lt: new lifetime (in seconds)

setMode (line 1214)

On effectue en changement de mode

access: public

void setMode (string&nbs