Page principale | Liste des classes | Répertoires | Liste des fichiers | Membres de classe | Pages associées

Référence de la classe block_template

Liste de tous les membres

Fonctions membres publiques

 block_template ($page_title, $template_name='default', $template_dir='template')
 output ($vars=null, $return=FALSE)
 set_safe_output ($set=TRUE)
 parse_template ($template_file=null, $overwrite=TRUE, $halt_on_error=TRUE)
 set_title ($title)
 add_favicon ($favicon)
 add_css ($css, $title=null, $alternate=FALSE)
 box ($content, $title='', $boxname='')
 add_body_param ($paramname, $paramvalue, $overwrite=FALSE)
 register_callback ($signame, $callback, $tagtype=3, $sectioname=null)
 unregister_callback ($cb_handler)
 templatize ($sectionvars, $sectioname, $section_optional=FALSE)
 templatize_string ($string, $sectionvars=null)
 get_section_vars ($sectioname, $nocache=FALSE)
 get_string_vars ($string)
 get_sections ()
 get_sections_select ($name='template_section', $selected=null, $autoselect=TRUE, $id=null)
 get_section ($sectioname)
 section_exists ($sectioname, $returnname=FALSE)
 choose_section ($section_list)
 add_section ($sectioname, $section_content, $overwrite=FALSE)
 append_section ($sectioname, $section_content, $autocreate=TRUE)
 prepend_section ($sectioname, $section_content, $autocreate=TRUE)
 _header ()
 _body ($bodyvars=null)
 highlight_str ($str, $outfile=null)
 highlight_section ($sectioname, $outfile=null)
 highlight_template_file ($file=null, $outfile=null)

Attributs publics

 $content
 $header
 $footer
 $favicon
 $css = array()
 $js = array()
 $_css
 $_js

Fonctions membres privées

 _safe_output ($block_template, $vars, $return)
 _emit_signal ($signame, $params=null, $tagname=null, $content=null, $section=null)
 _templatize ($section, $sectionvars, $sectioname=null, $section_optional=FALSE)

Attributs privés

 $metas = array()

Description détaillée

manage the HTML output. block_template is a template parser/renderer see the template sample for more info on the way the template work 2005-06-07 - now register_callback() will return a pointer


Documentation des contructeurs et destructeur

block_template.block_template page_title,
template_name = 'default',
template_dir = 'template'
 

Paramètres:
str $page_title
str $template_name (the directory containing the template must have the same name (case sensitive))
str $template_dir directory containing templates subdirs


Documentation des fonctions membres

block_template._body bodyvars = null  ) 
 

Prepare the body content to output Private

À faire:
supprimer les variables logo et consorts

block_template._emit_signal signame,
params = null,
tagname = null,
content = null,
section = null
[private]
 

le prototype de la fonction de rappelle sera function callback(block_template object,$section,$tagname,$params,$content)

cette methode est utilisé par l'objet en interne afin de gerer les signaux

Paramètres:
string $signame nom du signal emis (on-templatize,on-output);
Voir également:
_templatize output

block_template._header  ) 
 

Prepare the header to output Private

block_template._safe_output block_template,
vars,
return
[private]
 

internally used as callback to protect eventual block_template tags in the output

Voir également:
set_safe_output

block_template._templatize section,
sectionvars,
sectioname = null,
section_optional = FALSE
[private]
 

methode interne pour les methodes 'templatize'

Voir également:
templatize,templatize_string
Paramètres:
string $section contenu de la section (ou chaine si on a appeller templatize_string)
array $sectionvars variables en provenance du programmeur
string $sectioname le nom de la section sur laquelle on travaille
bool $section_optional flag pour le traitement des sections incluse (par un tag)
Renvoie:
string

block_template.add_body_param paramname,
paramvalue,
overwrite = FALSE
 

add some attribute to the body tag, an onload event for example

Paramètres:
string $paramname name of the attribute
mixed $paramvalue value of the attribute

block_template.add_css css,
title = null,
alternate = FALSE
 

add an external css stylesheet or css header definition

Paramètres:
string $css path to css file or css rules
string $title optionnal title for the stylesheet
bool $alternate set to true for alternate stylesheet

block_template.add_favicon favicon  ) 
 

add a favicon to the page

block_template.add_section sectioname,
section_content,
overwrite = FALSE
 

permet l'ajout dynamique de section par le programmeur

Paramètres:
string $sectioname le nom de la section
string $section_content le contenu de la section
bool $overwrite si passe a TRUE alors ecrasera une eventuelle section existante au lieu de renvoyer FALSE

block_template.append_section sectioname,
section_content,
autocreate = TRUE
 

ajoute du contenu a la fin d'une section

Paramètres:
string $sectioname le nom de la section
string $section_content contenu a ajouter
bool $autocreate TRUE par defaut, si FALSE ne creera pas la section si elle n'existe pas

block_template.box content,
title = '',
boxname = ''
 

return a 'BOX_*' section in a more common way BOX_* sections are section containings 2 vars boxtitle and boxcontent this function is the same as calling block_template.templatize(array('boxtitle'=>'title','boxcontent'=>'content'),'BOX_NAME');

Paramètres:
string $content
string $title may be ommit
string $boxname the BOX_ section to use

block_template.choose_section section_list  ) 
 

prend une liste de nom de section sous forme de tableau ou de chaine et retourne la premiere qui est trouvé. cette fonction peut etre utile si votre application veut permettre l'utilisation de section par defaut au cas ou le template ne fournirais pas la section données par exemple: block_template->choose_section('SEC1|SEC2|SEC3) testera successivement les sections passé en arguments et retournera la premiere section existante.

Paramètres:
mixed $section_list string('SEC1|SEC2...') ou array(SEC1,SEC2..)
Renvoie:
string first section name matching an existing section or '' if no section match and false on input error

block_template.get_section sectioname  ) 
 

retourne le contenue d'une section de template tel quel sans le parser

Paramètres:
string $sectioname
Renvoie:
string

block_template.get_section_vars sectioname,
nocache = FALSE
 

renvoie les variables attendus par la section $sectioname du template

Paramètres:
string $sectioname le nom de la section
bool $nocache par defaut vaut false ainsi les resultats sont gardé en cache de facon a accellerer les futures requetes. il peut s'averer utile de ne pas caché ses resultats (pour une section appeller une seule fois par exemple) auquel cas il suffit de passer cette option a TRUE
Renvoie:
array or FALSE if none the array will contain arrays(tagname,params,str_replace,is_optionnal[,content]) for complex vars, where sectionvarname is equal to the sting return for single vars, params is an array of parameter array('paramname or int'=>'value',...) and finally the original_tag which is the complete tag as it is in the template (will be use for string replacement)

block_template.get_sections  ) 
 

renvoie un tableau contenant le nom des sections disponibles dans le template

Renvoie:
array or FALSE si pas de sections

block_template.get_sections_select name = 'template_section',
selected = null,
autoselect = TRUE,
id = null
 

retourne le code html d'un element select contenant la liste des sections du template.

Paramètres:
string $name nom de l'element de formulaire (valeur de l'attribut name de la balise select)
string $selected nom de la section preselectionnée (si null alors essaie de trouver une occurence dans _POST ou _GET)
bool $autoselect si oui alors ajoute un submit onchange
string $id attribut id optionnel de la balise select.
Renvoie:
string HTML code

block_template.get_string_vars string  ) 
 

renvoie les variables contenue dans la chaine $string comme si c'était une section de template

Paramètres:
string string

block_template.highlight_section sectioname,
outfile = null
 

block_template.highlight_str str,
outfile = null
 

retourne le code de la chaine comme un code source de template avec coloration syntaxique au format html

Paramètres:
str $str chaine de caractere a colorer
str $outfile nom de fichier de sortie optionnel, si fournis alors la sortie sera sauvegarder dans un fichier.

block_template.highlight_template_file file = null,
outfile = null
 

block_template.output vars = null,
return = FALSE
 

send the rendered html code to STD-OUT (browser) cette fonction emetra le signal on-output voici prototype de rappelle callback(&$block_template,$vars,$return) si la fonction de rapelle renvoie autrechose que FALSE alors la sortie sera remplacé par la valeur retourné par la fonction de rappelle

Paramètres:
array $vars same as setcionvars in *templatize* methods
mixed $return FALSE as default it will print the output to STDOUT as always you can set it to true to get the output page return as a function returned value and at last but not least you can pass a filename to save the document to.
Renvoie:
void (if $return=FALSE)| string HTML code of the page (if $return=TRUE) | bool (if $return='/path/to/filesave');

block_template.parse_template template_file = null,
overwrite = TRUE,
halt_on_error = TRUE
 

parse a template file

Paramètres:
string $template_file filepath to the template file
bool $overwrite will overwrite any previously loaded sections if a new one have the same name
bool $halt_on_error will stop the script execution on error else will return FALSE
Renvoie:
bool
À faire:
add dynamic include support

block_template.prepend_section sectioname,
section_content,
autocreate = TRUE
 

ajoute du contenu au debut d'une section

Paramètres:
string $sectioname le nom de la section
string $section_content contenu a ajouter
bool $autocreate TRUE par defaut, si FALSE ne creera pas la section si elle n'existe pas

block_template.register_callback signame,
callback,
tagtype = 3,
sectioname = null
 

enregistre une fonction de callback qui sera appelé lors de certains signaux.

Paramètres:
string $signame nom du signal (on-load, on-output, on-templatize)
mixed $callback nom de la fonction de callback (peut prendre un tableau array($object,$method))
string $tagtype type de tag sur lequel on applique le callback 0|3| applique le callback sur tout les types de tag 1| applique le callback uniquement au tag unique 2| applique le callback sur des tags disposant de tag de fermeture
string $sectioname null par defaut, contraint le callback a la section précisé, ou toutes les sections si null
Voir également:
_emit_signal pour le prototype de rappelle
Renvoie:
int callback handler id

block_template.section_exists sectioname,
returnname = FALSE
 

verifie qu'une section existe

Paramètres:
string $sectioname nom de la section dont on veut verifier l'existence
bool $returnname si passer a TRUE alors la fonction retournera le nom de la section en cas de succes au lieu de TRUE
Renvoie:
bool

block_template.set_safe_output set = TRUE  ) 
 

block_template.set_title title  ) 
 

set the page title

Paramètres:
string $title

block_template.templatize sectionvars,
sectioname,
section_optional = FALSE
 

block_template.templatize_string string,
sectionvars = null
 

parse la chaine $string comme une section de template. Cela permet au programmeur de parser une chaine recue d'une base de données ou encore généré dynamiquement.

Note:
Cette méthode à été ajouter car elle me parassait apporter une certaine souplesse dans l'utilisation de block_template, cependant n'en ayant jamais fait usage, je serais tres interresser d'etre informé de l'utilisation que vous pouriez en faire.

block_template.unregister_callback cb_handler  ) 
 

permet de referencer un callback associé a un signal par le biais de la methode register_callback()

Paramètres:
int $cb_handler pointeur de callback renvoyé par la methode register_callback()
Voir également:
register_callback()
Renvoie:
bool


Documentation des données membres

block_template.$_css
 

string css definition that will go in the <style></style> tags inside the header

block_template.$_js
 

string javascript code that will go in the <script></script> tags inside the header

block_template.$content
 

where all the body content will go

block_template.$css = array()
 

array of css link tags

block_template.$favicon
 

string favicon link tag

block_template.$footer
 

block_template.$header
 

block_template.$js = array()
 

array of js link tags

block_template.$metas = array() [private]
 

metas tags parameters


La documentation de cette classe a été générée à partir du fichier suivant:
Généré le Tue Jun 14 16:32:45 2005 pour Block Template par  doxygen 1.3.9.1