TPLN - Documentation

II. Les fichiers Templates
1. Déclaration d'une variable
2. Déclaration d'un bloc
3. Avant de commencer

III. Les fonctions
  - Open()
  - Parse()
  - Loop()
  - EraseItem()
  - EraseBloc()
  - ParseBloc()
  - GetBlocInFile()
  - Write()
  - OutPut()

IV. Les fonctions spéciales MySQL
1. Fonctions de base
    - SetHost, SetLogin(), SetPassword(), SetBase()
    - DbConnect()
    - DbClose()
    - DoQuery()
    - GetData()
    - GetRowsCount()
2. La fonction ShowRecords()
    - ShowRecords()
    - SetNavLabels()
    - SetNavColor()

V. Les fonctions spéciales TPLN
- AddChrono()
- AddLogo()

I. Présentation de TPLN

TPLN est un moteur de template en Php pour Php.

Le code Php est séparé du design ce qui permet un facilité de mise à jour du design de vos documents et de permettre également de séparer les tâches entre le développeur Php et le Webdesigner.

Top

II. Les fichiers Templates

1. Déclaration d'une variable

La déclaration des variables se fait à l'aide des accolades {} au sein de votre fichier template

Exemple :

<html>
<body>
{ma_variable}
</body>
</html>

2. Déclaration d'un bloc

La déclaration des blocs se fait à l'aide des accolades <> au sein de votre fichier template

Exemple :

<html>
<body>
<mon_bloc> {ma_variable} </mon_bloc>
</body>
</html>

3. Avant de commencer

Avant de commencer, il vous faut configurer les variables globales présentes dans le fichier TPLN_Cfg.php au sein du répertoire TPLN.

Example :

/***************************** Configuration *******************************************/
define('ABSPATH', ''); // Absolute path
define('TPLN_PATH',"../../../TPLN/"); // TPLN path slash at end !
define('TPLN_CACHE_DIR',TPLN_PATH."cached/"); // default cache dir slash at end !
define('TPLN_CACHE_TIME',"3600"); // default cache time

// Db configuration
$TPLN_DB_HOST_DEFAULT = "localhost"; // your host by defaut
$TPLN_DB_LOGIN_DEFAULT = "root"; // your login by defaut
$TPLN_DB_PASSWORD_DEFAULT = ""; // your password by defaut
$TPLN_DB_BASE_DEFAULT = "my_base"; // your base by defaut

$TPLN_DB_UrlBngTxt = "[<<]";
$TPLN_DB_UrlPrevTxt = "[< Prev]";
$TPLN_DB_UrlNextTxt = "[Next >]";
$TPLN_DB_UrlEndTxt = "[>>]";

$TPLN_DB_NavColorFirst = "#CCCCCC"; // alternate ligne color
$TPLN_DB_NavColorSecond = "#FFFFFF"; // alternate ligne color
/**********************************************************************************/

Top

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

Top

- 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 à replace ce qui le rend gras
|I ajoute les balises à replace ce qui le rend italique
|U ajoute les balises à 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("monbloc.ma_variable","replace","|B");

Top

- 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("monbloc");

ou bien
$TPLN->Loop();

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

Top

- 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");

Top

- EraseBloc()

La fonction EraseBloc() sert à effacer un bloc.

EraseBloc( string blocname )

Exemple :

EraseBloc :

$TPLN->EraseBloc("mon_bloc");

Top

- 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 !");

Top

- GetBlocInFile()

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

GetBlocInFile( string blocname )

Exemple :

GetBlocInFile :

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

Top

- Write()

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

Write( )

Exemple :

Write :

$TPLN->Write();

Top

- Output()

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

OutPut( )

Exemple :

Output :

$file_parsed = $TPLN->Output();

Top

IV. Les fonctions spéciales MySQL

1. Fonctions de base

- SetHost(), SetLogin(), SetPassword(), SetBase()

Les fonctions SetHost(), SetLogin(), SetPassword(), SetBase() servent à initialiser les variables pour la connection.

Il est préférable de les configurer à partir du fichier TPLN_Cfg.php dans le répertoire TPLN pour éviter d'appeler ces fonctions à chaque fois.

SetHost( string host )
SetLogin( string login )
SetPassword( string password )
SetBase( string base )

Exemple :

SetBase :

$TPLN->SetBase("my_base"); // change la base par défaut

Top

- DbConnect()

La fonction DbConnect() sert se connecter à votre base de données MySQL.

DbConnect( )

Exemple :

DbConnect() :

$TPLN->DbConnect();

Top

- DbClose()

La fonction DbClose() sert se déconnecter à votre base de données MySQL.

DbClose( )

Exemple :

DbClose() :

$TPLN->DbClose();

Top

- DoQuery()

La fonction DoQuery() sert effectuer une requete.

DoQuery(string query )

Exemple :

DoQuery() :

$TPLN->DoQuery("SELECT * FROM my_table");

Top

- GetData()

La fonction GetData() sert retourner les résultats de la requete.
Si le paramètre COUNT est passé alors le résultats retourné valable pour les requete de type count().

GetData( [COUNT] )

Exemple :

GetData() pour un requete normale:

$TPLN->DoQuery("SELECT * FROM my_table");
$res = $TPLN->GetData();

GetData() pour un requete avec count:

$TPLN->DoQuery("SELECT COUNT(*) FROM my_table");
$count = $TPLN->GetData(COUNT);

Top

- GetRowsCount()

La fonction GetRowsCount() sert retourner le nombre de résultats de la requête.

GetRowsCount( )

Exemple :

GetRowsCount() :

$TPLN->DoQuery("SELECT * FROM my_table");
$nb_results = $TPLN->GetRowsCount();

Top

2. La fonction ShowRecords()

- ShowRecords()

La fonction ShowRecords() est une fonction qui permet de parser les données provenant de MySQL, vous n'avez qu'a créer votre template et la fonction s'occupe de tout pour vous !

Votre template doit être configurer comme ceci :

<data>
<loop> </loop> contient le nom de vos champs en variable
<norecord></norecord> contient le message s'il n'y a pas de résultats
</data>

Exemple :

<html>
<body>
<data>
 Données 
 <loop> {champs_nom} </loop>
 <norecord>Pas de résultas</norecord>
</data>
</body>
</html>

ShowRecords( string query , int resultsbypage )

Exemple :

ShowRecords() :

$query = "SELECT * FROM my_table";
$TPLN->ShowRecords($query,10);

Cette fonction possède ses variables propriétaires qui sont parsées automatiquement celles ci doivent être présentes dans le bloc <data></data> elles sont notées comme ceci {_Variable}

_First indique la position du première enregistrement
_Last indique la position du dernier enregistrement
_Count indique le nombre de résultats

_PageNumber indique la page actuelle
_PageCount indique le nombre de page total

_UrlBng url de la première page (texte défini dans TPLN_Cfg.php ou par SetNavLabels() )
_UrlPrev url de la page précédente ( texte défini dans TPLN_Cfg.php ou par SetNavLabels() )
_UrlNext url de la page suivante ( texte défini dans TPLN_Cfg.php ou par SetNavLabels() )
_UrlEnd url de la dernière page ( texte défini dans TPLN_Cfg.php ou par SetNavLabels() )

_ NavColor remplace par l'un des deux couleurs spécifiés dans le fichier TPLN_Cfg.php ou par SetNavColor()
_AbsPath remplace par ABSPATH défini dans TPLN_Cfg.php

Top

- SetNavLabels()

La fonction SetNavLabels() permet de remplacer le texte présent dans _UrlBng, _UrlPrev, _UrlNext, _UrlEnd.

SetNavLabels(string bngtxt , string prevtxt , string nexttxt , string endtxt )

Exemple :

SetNavLabels() :

$TPLN->SetNavLabels("[<<]","[<]","[>]","[>>]");

Top

V. Les fonctions spéciales TPLN

- AddChrono()

La fonction AddChrono() permet de pouvoir connaitre le temps de génération du template.
Vous devez impérativement placer dans votre fichier template la variable {chrono}.

AddChrono([ ALL ])

Si le paramètre ALL est passé en paramètre alors le chrono retournera la somme de toute les fois ou TPLN a été appelé, sinon renvoi la session actuelle.

Cette fonction doit être placée avant Write() ou Output()

Top

- AddLogo()

La fonction AddLogo() permet d'ajouter le logo TPLN à votre fichier.
Vous devez impérativement placer dans votre fichier template la variable {logo}.

AddLogo()

Cette fonction doit être placée avant Write() ou Output()

Top