Les fonctions

TPLN est une classe PHP. Elle nécessite cette déclaration.

<?php

include
("TPLN/TPLN.php");
// Inclusion du fichier
$TPLN = new TPLN; // Déclaration de l'object

// ... suite du programme


?>

Open()

La fonction Open() sert à ouvrir le fichier template le fichier peut avoir n'importe quelle extension (.htm, .html, .tpl, ... ).

Open( string filename [, CACHED, int time ] )

Exemple :

Ouverture simple :

$TPLN->Open("nomfichier");

Ouverture avec cache à 3600 secondes soit 1 heure :

if ( !$TPLN ->Open("nomfichier",CACHED, 3600) ){
//code à executer pour générer le fichier

}

$
TPLN->Write(); // Affiche le résultat


Vous pouvez désormais ouvrir plusieurs fichiers depuis la version 1.3, pour l'ouverture multiple il est préférable d'utiliser la function DefineTemplate()
 
DefineTemplate()

La fonction DefineTemplate() sert à ouvrir plusieurs templates en leurs donnant un nom.

DefineTemplate( array filename )

Exemple :

 

$TPLN->DefineTemplate(array("TOP"=>"top.html",
"BOTTOM" => "bottom.html");

 


Cette fonction s'utlise avec la fonction SetTemplate()
 
SetTemplate()

La fonction SetTemplate() sert à sélectionner un template ouvert par la fonction Open() ou DefineTemplate() soit par un nom ou par un numéro.

SetTemplate( string|int file )

Exemple :

SetTemplate avec Definetemplate :

$TPLN->DefineTemplate(array("TOP"=>"top.html",
"BOTTOM" => "bottom.html");

$TPLN->SetTemplate("TOP");//on choisi le template TOP
... //code à executer

SetTemplate avec Open :

$TPLN->Open("top.html");//numero 0
$TPLN->Open("bottom.html"); //numero 1

$TPLN->SetTemplate(0);//on choisi le template TOP
... //code à executer


 
Parse()

La fonction Parse() sert à remplacer une variable définie au sein de votre fichier template. TPLN utilise un pseudo langage objet de style javascript pour accéder à votre variable grâce au séparateur ".".

Cette fonction possède également un paramètre optionnel functions.
Celui ci sert à formater le texte de replace.
Ces options sont les suivantes :

  • |B ajoute les balises <b></b> à replace ce qui le rend gras
  • |I ajoute les balises <i></i> à replace ce qui le rend italique
  • |U ajoute les balises <u></u> à replace ce qui le rend souligné
  • |nom de la fonction Php n'importe quelle fonction Php (ucfirst par exemple)

Parse( string item , string replace [, string functions ] )

Exemple :

Parse simple

$TPLN->Parse("ma_variable","replace");

Parse dans un bloc simple :

$TPLN->Parse("mon_bloc.ma_variable","replace");

Parse dans un bloc simple avec format:

$TPLN->Parse("mon_bloc.ma_variable","replace","|B");


 
FastParse()

La fonction FastParse() est similaire à la fonction Parse() excepté quelle évite de réécrire les variables définies

FastParse( string item [, string functions ] )

Exemple :

FastParse :

$nom = "my_name";
$TPLN
->FastParse("nom");

ce qui équivaut à :

$TPLN
->Parse("nom",$nom);


/* va remplacer la variable nom dans le template par le contenu de la variable PHP $nom ici {nom} sera remplacé par my_name */

 

Pour remplacer automatiquement les variables provenant des session, de Post ou Get voir les fonctions ParseSessionVar(), ParseGetVar(), ParsePostVar().
 
ParseGlobals()

La fonction ParseGlobals() sert à remplacer toutes les variables Php ayant le même nom que les variables de votre fichier template.

ParseGlobals( )

Exemple :

 

$nom = "my_name";
$TPLN
->Open("file.html");

/* va remplacer automatiquement la variable {$nom} du fichier template par la variable Php $nom */

 

 


Cette fonction peut être appelé automatiquement à l'ouverture de votre fichier template cf TPLN_Cfg.php.
 
Loop()

La fonction Loop() est appliquée à un bloc pour signaler sa répétition.

Vous pouvez également écrire de cette manière
Loop(this) ou bien Loop() pour faire un Loop du dernier Bloc défini

Attention :il est conseillé d'utiliser le chemin complet du bloc si c'est un bloc imbriqué !

Loop( [ string blocname ] )

Exemple :

Loop simple

for($i=0,$i < 10;$i++){
$TPLN
->Parse("mon_bloc.ma_variable","$i");
$TPLN
->Loop("mon_bloc");

ou bien

$TPLN->Loop();

ou encore
$TPLN->Loop(this);
}


 
EraseItem()

La fonction EraseItem() sert à effacer une variable.

EraseItem( string item )

Exemple :

EraseItem simple :

$TPLN->EraseItem("ma_variable");

EraseItem dans un bloc:

$TPLN->EraseItem("mon_bloc.ma_variable");


 
EraseBloc()

La fonction EraseBloc() sert à effacer un bloc.

EraseBloc( string blocname )

Exemple :

EraseBloc :

$TPLN->EraseBloc("mon_bloc");


 
ParseBloc()

La fonction ParseBloc() sert à remplacer un bloc entier avec ses balises incluses.

ParseBloc( string blocname , string replace )

Exemple :

ParseBloc :

$TPLN->ParseBloc("mon_bloc" , "plus de bloc !");


 
LoadArrayInBloc()

La fonction LoadArrayInBloc() sert à remplacer dans un bloc entier les items par les pairs clefs d'un array.

LoadArrayInBloc( array array)

Exemple :

LoadArrayInBloc :

$array[] = array("User"=>"Me",
"Password"=>"test");
$TPLN
->LoadArrayInBloc("my_bloc" , $arr);


/* ceci va remplacer tous les variables User at Password dans le fichier template par les clefs associés de $arr */


 
IncludeFile()

La fonction IncludeFile() sert à remplacer une variable de votre fichier template par le contenu d'un fichier.

IncludeFile( string variable , string filename)

Exemple :

 

$TPLN->IncludeFile("my_variable","file.html");



Depuis la version 1.3, TPLN supporte l'inclusion de fichier Php.
 
GetBlocInFile()

La fonction GetBlocInFile() sert à retourner un bloc entier du fichier template.

GetBlocInFile( string blocname )

Exemple :

GetBlocInFile :

$bloc = $TPLN->GetBlocInFile("mon_bloc");



 
GetFile()

La fonction GetFile() sert à retourner le contenu d'un fichier.
Si le paramètre optionnel blocname est précisé alors la fonction retourne le contenu du bloc défini dans le fichier.

GetFile( string filename , [ string blocname ] )

Exemple :

Getfile :

$file= $TPLN->GetFile("file.html","bloc1");



 
Write()

La fonction Write() sert à imprimer le fichier template parsé.

Write( )

Exemple :

Write :

$TPLN->Write();



 
Output()

La fonction Output() sert à retourner le contenu du fichier template parsé.

OutPut( )

Exemple :

Output :

$file_parsed = $TPLN->Output();



ItemExists()

La fonction ItemExists() sert savoir si une variable dans votre fichier template existe .

ItemExists(string variable, [string bloc])


Retourne true en cas de réussite sinon retourne false.
 
BlocExists()

La fonction BlocExists() sert savoir si un bloc dans votre fichier template existe .

BlocExists(string bloc)


Retourne true en cas de réussite sinon retourne false.