API Documentation
\
Helper

\MyTemplate

Outils de templatage

Summary

Methods
Properties
Constants
__construct()
setDoctype()
setTitle()
versioningVal()
versioningUrl()
cssPrepare()
sassUrl()
canCombine()
combineJs()
combineCss()
generateCombineFile()
combineFiles()
combineCssUrl()
combineJsUrl()
addCSS()
addFavicon()
addJS()
addRss()
addInHead()
setBodyAttrs()
add()
getBodyAttrs()
getFlashComponent()
print_xml()
print_text()
print_empty()
print_default()
printPage()
getHeader()
getFooter()
getScriptsStart()
getScripts()
getBody()
getDialog()
cookieconsent()
getCookieWarning()
getBwin()
callStop()
callAdminStop()
tinyMCE()
plupload()
jQuery()
jQueryUI()
jQueryLightBox()
jQueryImgAreaSelect()
jsVars()
dependencies()
print_siteadmin()
No public properties found
XHTML_10_STRICT
XHTML_10_TRANSITIONAL
XHTM_11
HTML_STD
getHead()
print_html()
$doctype
$head
$head_title
$head_favicon
$head_css
$head_css_combined
$head_js
$head_js_combined
$head_rss
$body_attrs
$output
$body_corpus
N/A
No private methods found
No private properties found
N/A

Constants

XHTML_10_STRICT

XHTML_10_STRICT

XHTML_10_TRANSITIONAL

XHTML_10_TRANSITIONAL

XHTM_11

XHTM_11

HTML_STD

HTML_STD

Properties

$doctype

$doctype : string

Type

string — doctype

$head

$head : string

Type

string — Header others (favicon, ...)

$head_title

$head_title : string

Type

string — Titre de la page

$head_favicon

$head_favicon : string

Type

string — Favicon

$head_css

$head_css : array

Type

array — Liens vers fichiers CSS

$head_css_combined

$head_css_combined : array

Type

array — Liens vers fichiers JS Combinés

$head_js

$head_js : array

Type

array — Liens vers fichiers JavaScript

$head_js_combined

$head_js_combined : array

Type

array — Liens vers fichiers JS Combinés

$head_rss

$head_rss : array

Type

array — Liens vers les flux RSS

$body_attrs

$body_attrs : array

Type

array — Tableau d'attributs de <body>

$output

$output : string

Type

string — Contenu de la page via $html en php

$body_corpus

$body_corpus : string

Type

string — Contenu de la page

Methods

__construct()

__construct()

Retourne le header du template

setDoctype()

setDoctype(string  $doctype = '')

Attribue au template le doctype en entrée.

Parameters

string $doctype

setTitle()

setTitle(string  $title = null, boolean  $alone = true)

Attribue au template le titre renseigné en entrée .

Parameters

string $title
boolean $alone

True si on ajoute ni préfixe, ni suffixe au titre.

versioningVal()

versioningVal() : mixed

Recupère le numéro de versioning

Returns

mixed

versioningUrl()

versioningUrl(string  $url) : string

Ajoute la version à l'url si possible

Parameters

string $url

Returns

string

cssPrepare()

cssPrepare()

Transforme une feuille de style php en css en fonction des configurations

sassUrl()

sassUrl(  $what) : string

Retourne le lien sass ou non en fonction du context

Parameters

$what

Returns

string

canCombine()

canCombine(  $url, string  $type = 'css') : boolean

Retourne true si le fichier doit être combiné

Parameters

$url
string $type

Returns

boolean

combineJs()

combineJs(  $url) : boolean

Empile le fichier js s'il doit être combiné

Parameters

$url

Returns

boolean

combineCss()

combineCss(  $url) : boolean

Empile le fichier css s'il doit être combiné

Parameters

$url

Returns

boolean

generateCombineFile()

generateCombineFile(array  $files = array(), string  $type = 'css') : boolean|string

Génère un fichier de combinaison en fonction des fichiers en entrée et retourne le chemin vers le fichier généré

Parameters

array $files
string $type

Returns

boolean|string

combineFiles()

combineFiles(  $dest_file, array  $files = array(), string  $type = 'css') : boolean

Combine les fichiers dans le fichier renseigné en entrée

Parameters

$dest_file
array $files
string $type

Returns

boolean

combineCssUrl()

combineCssUrl(boolean|true  $versioning = true) : boolean|string

Retourne l'url du fichier de combinaison CSS

Parameters

boolean|true $versioning

Returns

boolean|string

combineJsUrl()

combineJsUrl(boolean|true  $versioning = true) : boolean|string

Retourne l'url du fichier de combinaison JS

Parameters

boolean|true $versioning

Returns

boolean|string

addCSS()

addCSS(  $url, boolean|true  $versioning = true)

Associe une feuille de style au template.

Parameters

$url
boolean|true $versioning

addFavicon()

addFavicon(string  $url)

Associe un favicon au template.

Parameters

string $url

addJS()

addJS(string  $url, boolean|true  $versioning = true)

Associe un document javascript au template.

Parameters

string $url
boolean|true $versioning

addRss()

addRss(string  $title, string  $url)

Associe un flux RSS au template.

Parameters

string $title
string $url

addInHead()

addInHead(string  $str)

Ajoute le contenu en entrée dans le template.

Parameters

string $str

setBodyAttrs()

setBodyAttrs(array  $tab)

Définit les attributs du body

Parameters

array $tab

([attributs]=>[valeurs])

add()

add(string  $str)

Ajoute un contenu au corps HTML du template

Parameters

string $str

getBodyAttrs()

getBodyAttrs() : string

Retourne les attributs du Body sous leur forme HTML.

Returns

string

getFlashComponent()

getFlashComponent(string  $path, string  $width, string  $height, string  $id_obj = '', array  $flashvars = array(), string  $alternative_text = '', string  $tabs = '') : string

Retourne l'appel HTML d'un élément flash en fonction des paramètres en entrée.

Parameters

string $path

Chemin vers le fichier Flash.
string $width

Largeur.
string $height

Hauteur.
string $id_obj

Identifiant HTML.
array $flashvars

Liste des variables Flash.
string $alternative_text

Texte alternatif.
string $tabs

Tabulation.

Returns

string

print_xml()

print_xml()

Affiche le template sous sa forme XML

print_text()

print_text()

Affiche le template sous sa forme Text

print_empty()

print_empty()

Affiche le corps du template

print_default()

print_default()

Template par défaut

printPage()

printPage()

Affiche la page au format renseigné par $GLOBALS['acid']['out'].

Cette méthode utilise la variable globale $GLOBALS['acid']['out']

getHeader()

getHeader(  $v = array())

Retourne le header du template

Parameters

$v

getFooter()

getFooter(  $v = array())

Retourne le footer du template

Parameters

$v

getScriptsStart()

getScriptsStart(  $v = array())

Retourne les scripts de haut de page

Parameters

$v

getScripts()

getScripts(  $v = array())

Retourne les scripts de fin de page

Parameters

$v

getBody()

getBody(  $v = array())

Retourne le footer du template

Parameters

$v

getDialog()

getDialog()

Retourne le corps de la pop-in de dialogue du template

cookieconsent()

cookieconsent()

Charge les ressources de consentement des cookies

getCookieWarning()

getCookieWarning()

Retourne le corps de la pop-in du template

getBwin()

getBwin()

Retourne le corps de la pop-in du template

callStop()

callStop()

Renvoie le contenu du stop.tpl, lequel contient le JavaScript à mettre en fin de page.

callAdminStop()

callAdminStop()

Renvoie le contenu du admin/stop.tpl, lequel contient le JavaScript à mettre en fin de page.

tinyMCE()

tinyMCE()

Active le plugin tiny_mce pour les contenus dynamiques

plupload()

plupload()

Active le plugin plupload pour l'upload de fichier

jQuery()

jQuery()

Active le plugin jquery

jQueryUI()

jQueryUI()

Active le plugin UI pour les contenus dynamiques

jQueryLightBox()

jQueryLightBox()

Active le plugin plupload pour l'upload de fichier

jQueryImgAreaSelect()

jQueryImgAreaSelect()

Active le plugin plupload pour l'upload de fichier

jsVars()

jsVars()

Définit les variables d'environnement Acid en javascript

dependencies()

dependencies()

Fait appel aux dépendences globales à tous les thèmes

print_siteadmin()

print_siteadmin()

Template par défaut

getHead()

getHead() : string

Retourne l'entête HTML du template

Returns

string

print_html()

print_html()

Affiche le template sous sa forme HTML