New file |
0,0 → 1,449 |
<!DOCTYPE html> |
<html> |
<head> |
<meta http-equiv="Content-Type" content="text/html; charset=utf-8"> |
<meta name="generator" content="ApiGen 2.8.0"> |
|
<title>Class Framework | TBFramework - v0.4</title> |
|
<script type="text/javascript" src="resources/combined.js?4205936287"></script> |
<script type="text/javascript" src="elementlist.js?1964084359"></script> |
<link rel="stylesheet" type="text/css" media="all" href="resources/style.css?3505392360"> |
|
</head> |
|
<body> |
<div id="left"> |
<div id="menu"> |
<a href="index.html" title="Overview"><span>Overview</span></a> |
|
|
<div id="groups"> |
<h3>Packages</h3> |
<ul> |
<li class="active"><a href="package-Framework.html">Framework</a> |
</li> |
<li><a href="package-None.html">None</a> |
</li> |
<li><a href="package-PHP.html">PHP</a> |
</li> |
<li><a href="package-Utilitaire.html">Utilitaire</a> |
</li> |
</ul> |
</div> |
|
<hr> |
|
|
<div id="elements"> |
<h3>Classes</h3> |
<ul> |
<li><a href="class-Bdd.html">Bdd</a></li> |
<li><a href="class-Cache.html">Cache</a></li> |
<li><a href="class-CacheSimple.html">CacheSimple</a></li> |
<li><a href="class-Chronometre.html">Chronometre</a></li> |
<li><a href="class-Cli.html">Cli</a></li> |
<li><a href="class-Config.html">Config</a></li> |
<li><a href="class-Controleur.html">Controleur</a></li> |
<li><a href="class-Debug.html">Debug</a></li> |
<li class="active"><a href="class-Framework.html">Framework</a></li> |
<li><a href="class-GestionnaireException.html">GestionnaireException</a></li> |
<li><a href="class-I18n.html">I18n</a></li> |
<li><a href="class-Log.html">Log</a></li> |
<li><a href="class-MonService.html">MonService</a></li> |
<li><a href="class-Registre.html">Registre</a></li> |
<li><a href="class-RestClient.html">RestClient</a></li> |
<li><a href="class-RestServeur.html">RestServeur</a></li> |
<li><a href="class-RestService.html">RestService</a></li> |
<li><a href="class-Script.html">Script</a></li> |
<li><a href="class-ServiceCacheFichier.html">ServiceCacheFichier</a></li> |
<li><a href="class-ServiceCacheSimple.html">ServiceCacheSimple</a></li> |
<li><a href="class-ServiceCacheSqlite.html">ServiceCacheSqlite</a></li> |
<li><a href="class-SquelettePhp.html">SquelettePhp</a></li> |
<li><a href="class-Url.html">Url</a></li> |
</ul> |
|
|
|
|
|
</div> |
</div> |
</div> |
|
<div id="splitter"></div> |
|
<div id="right"> |
<div id="rightInner"> |
<form id="search"> |
<input type="hidden" name="cx" value=""> |
<input type="hidden" name="ie" value="UTF-8"> |
<input type="text" name="q" class="text"> |
<input type="submit" value="Search"> |
</form> |
|
<div id="navigation"> |
<ul> |
<li> |
<a href="index.html" title="Overview"><span>Overview</span></a> |
</li> |
<li> |
<a href="package-Framework.html" title="Summary of Framework"><span>Package</span></a> |
</li> |
<li class="active"> |
<span>Class</span> </li> |
</ul> |
<ul> |
<li> |
<a href="tree.html" title="Tree view of classes, interfaces, traits and exceptions"><span>Tree</span></a> |
</li> |
<li> |
<a href="deprecated.html" title="List of deprecated elements"><span>Deprecated</span></a> |
</li> |
<li> |
<a href="todo.html" title="Todo list"><span>Todo</span></a> |
</li> |
</ul> |
<ul> |
</ul> |
</div> |
|
<div id="content" class="class"> |
<h1>Class Framework</h1> |
|
|
<div class="description"> |
|
<p>Classe de base du Framework : - fournissant des infos sur l'application, - |
paramétrant l'environnement de l'appli et du framework, - réalisant des |
traitements sur les variables globales ($_GET, $_POST, $_COOKIE...)</p> |
|
<p>Cette classe contient la fonction de chargement automatique de classes. Ce |
fichier doit toujours rester à la racine du framework car il initialise le |
chemin de l'application en se basant sur son propre emplacement.</p> |
|
</div> |
|
|
|
|
|
|
|
|
|
<div class="info"> |
|
|
|
<b>Package:</b> <a href="package-Framework.html">Framework</a><br> |
|
<b>Category:</b> |
PHP 5.2<br> |
<b>Copyright:</b> |
Copyright (c) 2010, Tela Botanica (<a |
href="mailto:accueil@tela-botanica.org">accueil@<!-- -->tela-botanica.org</a>)<br> |
<b>License:</b> |
<a href="http://www.gnu.org/licenses/gpl.html">Licence GNU-GPL-v3</a><br> |
<b>License:</b> |
<a href="http://www.cecill.info/licences/Licence_CeCILL_V2-fr.txt">Licence CECILL-v2</a><br> |
<b>Author:</b> |
Jean-Pascal MILCENT <<a |
href="mailto:jpm@tela-botanica.org">jpm@<!-- -->tela-botanica.org</a>><br> |
<b>Version:</b> |
$Id: Framework.php 393 2011-11-10 13:36:48Z jpm $<br> |
<b>Since:</b> |
0.3<br> |
<b>Link:</b> |
/doc/framework/<br> |
<b>Located at</b> <a href="source-class-Framework.html#3-252" title="Go to source code">framework/Framework.php</a><br> |
</div> |
|
|
|
<table class="summary" id="methods"> |
<caption>Methods summary</caption> |
<tr data-order="setCheminAppli" id="_setCheminAppli"> |
|
<td class="attributes"><code> |
public static |
|
|
</code> |
</td> |
|
<td class="name"><div> |
<a class="anchor" href="#_setCheminAppli">#</a> |
<code><a href="source-class-Framework.html#143-161" title="Go to source code">setCheminAppli</a>( <span>string <var>$chemin_fichier_principal</var></span> )</code> |
|
<div class="description short"> |
|
<p>Permet d'indiquer le chemin de base de l'Application. Cette méthode doit |
obligatoirement être utilisée par l'application pour que le Framework |
fonctionne correctement.</p> |
|
</div> |
|
<div class="description detailed hidden"> |
|
<p>Permet d'indiquer le chemin de base de l'Application. Cette méthode doit |
obligatoirement être utilisée par l'application pour que le Framework |
fonctionne correctement.</p> |
|
|
|
<h4>Parameters</h4> |
<div class="list"><dl> |
<dt><var>$chemin_fichier_principal</var></dt> |
<dd><code>string</code><br>$chemin_fichier_principal chemin de base</dd> |
</dl></div> |
|
|
|
|
|
</div> |
</div></td> |
</tr> |
<tr data-order="getCheminAppli" id="_getCheminAppli"> |
|
<td class="attributes"><code> |
public static |
string |
|
</code> |
</td> |
|
<td class="name"><div> |
<a class="anchor" href="#_getCheminAppli">#</a> |
<code><a href="source-class-Framework.html#163-169" title="Go to source code">getCheminAppli</a>( )</code> |
|
<div class="description short"> |
|
<p>accesseur pour le chemin</p> |
|
</div> |
|
<div class="description detailed hidden"> |
|
<p>accesseur pour le chemin</p> |
|
|
|
|
<h4>Returns</h4> |
<div class="list"> |
<code>string</code><br>le chemin<br> |
</div> |
|
|
|
|
</div> |
</div></td> |
</tr> |
<tr data-order="setInfoAppli" id="_setInfoAppli"> |
|
<td class="attributes"><code> |
public static |
|
|
</code> |
</td> |
|
<td class="name"><div> |
<a class="anchor" href="#_setInfoAppli">#</a> |
<code><a href="source-class-Framework.html#171-185" title="Go to source code">setInfoAppli</a>( <span>array <var>$info</var></span> )</code> |
|
<div class="description short"> |
|
<p>Le tableau des informations sur l'application possède les clés suivantes |
:</p> |
|
<ul> |
<li>nom : nom de l'application</li> |
|
<li>abr : abréviation de l'application</li> |
|
<li>encodage : encodage de l'application (ISO-8859-15, UTF-8...)</li> |
</ul> |
|
</div> |
|
<div class="description detailed hidden"> |
|
<p>Le tableau des informations sur l'application possède les clés suivantes |
:</p> |
|
<ul> |
<li>nom : nom de l'application</li> |
|
<li>abr : abréviation de l'application</li> |
|
<li>encodage : encodage de l'application (ISO-8859-15, UTF-8...)</li> |
</ul> |
|
|
|
<h4>Parameters</h4> |
<div class="list"><dl> |
<dt><var>$info</var></dt> |
<dd><code>array</code><br>$info tableau fournissant des informations sur l'application</dd> |
</dl></div> |
|
|
|
|
|
</div> |
</div></td> |
</tr> |
<tr data-order="getInfoAppli" id="_getInfoAppli"> |
|
<td class="attributes"><code> |
public static |
|
|
</code> |
</td> |
|
<td class="name"><div> |
<a class="anchor" href="#_getInfoAppli">#</a> |
<code><a href="source-class-Framework.html#187-199" title="Go to source code">getInfoAppli</a>( <span>string <var>$cle</var> = <span class="php-keyword1">null</span></span> )</code> |
|
<div class="description short"> |
|
<p>Accesseur pour le tableau d'infos sur l'application.</p> |
|
</div> |
|
<div class="description detailed hidden"> |
|
<p>Accesseur pour le tableau d'infos sur l'application.</p> |
|
|
|
<h4>Parameters</h4> |
<div class="list"><dl> |
<dt><var>$cle</var></dt> |
<dd><code>string</code><br>$cle la clé à laquelle on veut accéder</dd> |
</dl></div> |
|
|
|
|
|
</div> |
</div></td> |
</tr> |
<tr data-order="verifierEtReencoderTableauRequete" id="_verifierEtReencoderTableauRequete"> |
|
<td class="attributes"><code> |
protected static |
|
|
</code> |
</td> |
|
<td class="name"><div> |
<a class="anchor" href="#_verifierEtReencoderTableauRequete">#</a> |
<code><a href="source-class-Framework.html#201-214" title="Go to source code">verifierEtReencoderTableauRequete</a>( )</code> |
|
<div class="description short"> |
|
<p>Procédure vérifiant l'encodage des tableaux $_GET et $_POST et les |
transcodant dans l'encodage de l'application</p> |
|
</div> |
|
<div class="description detailed hidden"> |
|
<p>Procédure vérifiant l'encodage des tableaux $_GET et $_POST et les |
transcodant dans l'encodage de l'application</p> |
|
|
|
|
|
|
|
|
</div> |
</div></td> |
</tr> |
<tr data-order="encoderTableau" id="_encoderTableau"> |
|
<td class="attributes"><code> |
final protected static |
Array |
|
</code> |
</td> |
|
<td class="name"><div> |
<a class="anchor" href="#_encoderTableau">#</a> |
<code><a href="source-class-Framework.html#232-251" title="Go to source code">encoderTableau</a>( <span>mixed <var>$tableau</var></span>, <span>mixed <var>$encodage_sortie</var></span>, <span>mixed <var>$encodage_entree</var> = <span class="php-keyword1">null</span></span> )</code> |
|
<div class="description short"> |
|
<p>Fonction récursive transcodant toutes les valeurs d'un tableau de leur |
encodage d'entrée vers un encodage de sortie donné</p> |
|
</div> |
|
<div class="description detailed hidden"> |
|
<p>Fonction récursive transcodant toutes les valeurs d'un tableau de leur |
encodage d'entrée vers un encodage de sortie donné</p> |
|
|
|
<h4>Parameters</h4> |
<div class="list"><dl> |
<dt><var>$tableau</var></dt> |
<dd><code>mixed</code><br>$tableau Array Un tableau de données à encoder</dd> |
<dt><var>$encodage_sortie</var></dt> |
<dd><code>mixed</code><br>$encodage_sortie String l'encodage vers lequel on doit transcoder</dd> |
<dt><var>$encodage_entree</var></dt> |
<dd><code>mixed</code><br>$encodage_entree String l'encodage original des chaines du tableau (optionnel)</dd> |
</dl></div> |
|
<h4>Returns</h4> |
<div class="list"> |
<code>Array</code><br>Le tableau encodé dans l'encodage de sortie<br> |
</div> |
|
|
|
|
</div> |
</div></td> |
</tr> |
</table> |
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
</div> |
|
<div id="footer"> |
TBFramework - v0.4 API documentation generated by <a href="http://apigen.org">ApiGen 2.8.0</a> |
</div> |
</div> |
</div> |
</body> |
</html> |