Subversion Repositories Applications.framework

Compare Revisions

Ignore whitespace Rev 302 → Rev 303

/tags/v0.3-aleaume/doc/HTMLSmartyConverter/Framework/Framework.html
New file
0,0 → 1,443
<html>
<head>
<title>Docs For Class Framework</title>
<meta http-equiv='Content-Type' content='text/html; charset=UTF-8'/>
<link rel="stylesheet" type="text/css" href="../media/style.css">
</head>
<body>
 
<table border="0" cellspacing="0" cellpadding="0" height="48" width="100%">
<tr>
<td class="header_top">Framework</td>
</tr>
<tr><td class="header_line"><img src="../media/empty.png" width="1" height="1" border="0" alt="" /></td></tr>
<tr>
<td class="header_menu">
[ <a href="../classtrees_Framework.html" class="menu">class tree: Framework</a> ]
[ <a href="../elementindex_Framework.html" class="menu">index: Framework</a> ]
[ <a href="../elementindex.html" class="menu">all elements</a> ]
</td>
</tr>
<tr><td class="header_line"><img src="../media/empty.png" width="1" height="1" border="0" alt="" /></td></tr>
</table>
 
<table width="100%" border="0" cellpadding="0" cellspacing="0">
<tr valign="top">
<td width="200" class="menu">
<div id="todolist">
<p><a href="../todolist.html">Todo List</a></p>
</div>
<b>Packages:</b><br />
<a href="../li_Framework.html">Framework</a><br />
<a href="../li_Utilitaire.html">Utilitaire</a><br />
<a href="../li_Zend_OpenId.html">Zend_OpenId</a><br />
<br /><br />
<b>Files:</b><br />
<div class="package">
<a href="../Framework/_Bdd.php.html"> Bdd.php
</a><br>
<a href="../Framework/_Cache.php.html"> Cache.php
</a><br>
<a href="../Framework/_CacheFichier.php.html"> CacheFichier.php
</a><br>
<a href="../Framework/_CacheSimple.php.html"> CacheSimple.php
</a><br>
<a href="../Framework/_CacheSqlite.php.html"> CacheSqlite.php
</a><br>
<a href="../Framework/_Chronometre.php.html"> Chronometre.php
</a><br>
<a href="../Framework/_Cli.php.html"> Cli.php
</a><br>
<a href="../Framework/_Config.php.html"> Config.php
</a><br>
<a href="../Framework/_Controleur.php.html"> Controleur.php
</a><br>
<a href="../Framework/_Debug.php.html"> Debug.php
</a><br>
<a href="../Framework/_utilitaires---DiffieHellmanUtil.php.html"> DiffieHellmanUtil.php
</a><br>
<a href="../Framework/_Framework.php.html"> Framework.php
</a><br>
<a href="../Framework/_GestionnaireException.php.html"> GestionnaireException.php
</a><br>
<a href="../Framework/_I18n.php.html"> I18n.php
</a><br>
<a href="../Framework/_Log.php.html"> Log.php
</a><br>
<a href="../Framework/_OpenIdClient.php.html"> OpenIdClient.php
</a><br>
<a href="../Framework/_Registre.php.html"> Registre.php
</a><br>
<a href="../Framework/_RestClient.php.html"> RestClient.php
</a><br>
<a href="../Framework/_RestServeur.php.html"> RestServeur.php
</a><br>
<a href="../Framework/_RestService.php.html"> RestService.php
</a><br>
<a href="../Framework/_Script.php.html"> Script.php
</a><br>
<a href="../Framework/_SquelettePhp.php.html"> SquelettePhp.php
</a><br>
<a href="../Framework/_Url.php.html"> Url.php
</a><br>
</div><br />
<b>Classes:</b><br />
<div class="package">
<a href="../Framework/Bdd.html">Bdd</a><br />
<a href="../Framework/Cache.html">Cache</a><br />
<a href="../Framework/CacheFichier.html">CacheFichier</a><br />
<a href="../Framework/CacheSimple.html">CacheSimple</a><br />
<a href="../Framework/CacheSqlite.html">CacheSqlite</a><br />
<a href="../Framework/Chronometre.html">Chronometre</a><br />
<a href="../Framework/Cli.html">Cli</a><br />
<a href="../Framework/Config.html">Config</a><br />
<a href="../Framework/Controleur.html">Controleur</a><br />
<a href="../Framework/Debug.html">Debug</a><br />
<a href="../Framework/DiffieHellmanUtil.html">DiffieHellmanUtil</a><br />
<a href="../Framework/Framework.html">Framework</a><br />
<a href="../Framework/GestionnaireException.html">GestionnaireException</a><br />
<a href="../Framework/I18n.html">I18n</a><br />
<a href="../Framework/Log.html">Log</a><br />
<a href="../Framework/OpenIdClient.html">OpenIdClient</a><br />
<a href="../Framework/Registre.html">Registre</a><br />
<a href="../Framework/RestClient.html">RestClient</a><br />
<a href="../Framework/RestServeur.html">RestServeur</a><br />
<a href="../Framework/RestService.html">RestService</a><br />
<a href="../Framework/Script.html">Script</a><br />
<a href="../Framework/SquelettePhp.html">SquelettePhp</a><br />
<a href="../Framework/Url.html">Url</a><br />
</div>
</td>
<td>
<table cellpadding="10" cellspacing="0" width="100%" border="0"><tr><td valign="top">
 
<h1>Class: Framework</h1>
Source Location: /Framework.php<br /><br />
 
 
<table width="100%" border="0">
<tr><td valign="top">
 
<h3><a href="#class_details">Class Overview</a></h3>
<pre></pre><br />
<div class="description">Classe de base du Framework :</div><br /><br />
<h4>Author(s):</h4>
<ul>
<li>Jean-Pascal MILCENT &lt;<a href="mailto:jpm@tela-botanica.org">jpm@tela-botanica.org</a>&gt;</li>
</ul>
 
 
 
 
<h4>Version:</h4>
<ul>
<li>$Id: Framework.php 274 2010-12-28 15:37:22Z jpm $</li>
</ul>
 
<h4>Copyright:</h4>
<ul>
<li>Copyright (c) 2010, Tela Botanica (accueil@tela-botanica.org)</li>
</ul>
</td>
 
 
 
<td valign="top">
<h3><a href="#class_methods">Methods</a></h3>
<ul>
<li><a href="../Framework/Framework.html#methodencoderTableau">encoderTableau</a></li>
<li><a href="../Framework/Framework.html#methodgetCheminAppli">getCheminAppli</a></li>
<li><a href="../Framework/Framework.html#methodgetInfoAppli">getInfoAppli</a></li>
<li><a href="../Framework/Framework.html#methodsetCheminAppli">setCheminAppli</a></li>
<li><a href="../Framework/Framework.html#methodsetInfoAppli">setInfoAppli</a></li>
<li><a href="../Framework/Framework.html#methodverifierEtReencoderTableauRequete">verifierEtReencoderTableauRequete</a></li>
</ul>
</td>
 
</tr></table>
<hr />
 
<table width="100%" border="0"><tr>
 
 
 
 
 
 
</tr></table>
<hr />
 
<a name="class_details"></a>
<h3>Class Details</h3>
<div class="tags">
[line <a href="../__filesource/fsource_Framework__Framework.php.html#a23">23</a>]<br />
Classe de base du Framework :<br /><br /><p><ul><li>fournissant des infos sur l'application,</li><li>paramétrant l'environnement de l'appli et du framework,</li><li>réalisant des traitements sur les variables globales ($_GET, $_POST, $_COOKIE...)</li></ul> 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><br /><br /><br />
<h4>Tags:</h4>
<div class="tags">
<table border="0" cellspacing="0" cellpadding="0">
<tr>
<td><b>author:</b>&nbsp;&nbsp;</td><td>Jean-Pascal MILCENT &lt;<a href="mailto:jpm@tela-botanica.org">jpm@tela-botanica.org</a>&gt;</td>
</tr>
<tr>
<td><b>version:</b>&nbsp;&nbsp;</td><td>$Id: Framework.php 274 2010-12-28 15:37:22Z jpm $</td>
</tr>
<tr>
<td><b>copyright:</b>&nbsp;&nbsp;</td><td>Copyright (c) 2010, Tela Botanica (accueil@tela-botanica.org)</td>
</tr>
<tr>
<td><b>link:</b>&nbsp;&nbsp;</td><td>/doc/framework/</td>
</tr>
<tr>
<td><b>since:</b>&nbsp;&nbsp;</td><td>0.3</td>
</tr>
<tr>
<td><b>license:</b>&nbsp;&nbsp;</td><td><a href="http://www.gnu.org/licenses/gpl.html">Licence GNU-GPL-v3</a></td>
</tr>
<tr>
<td><b>license:</b>&nbsp;&nbsp;</td><td><a href="http://www.cecill.info/licences/Licence_CeCILL_V2-fr.txt">Licence CECILL-v2</a></td>
</tr>
</table>
</div>
</div><br /><br />
<div class="top">[ <a href="#top">Top</a> ]</div><br />
 
 
<hr />
<a name="class_methods"></a>
<h3>Class Methods</h3>
<div class="tags">
<hr />
<a name="methodencoderTableau"></a>
<h3>static method encoderTableau <span class="smalllinenumber">[line <a href="../__filesource/fsource_Framework__Framework.php.html#a228">228</a>]</span></h3>
<div class="function">
<table width="90%" border="0" cellspacing="0" cellpadding="1"><tr><td class="code_border">
<table width="100%" border="0" cellspacing="0" cellpadding="2"><tr><td class="code">
<code>static Array encoderTableau(
$tableau
$tableau, $encodage_sortie
$encodage_sortie, [$encodage_entree
$encodage_entree = null])</code>
</td></tr></table>
</td></tr></table><br />
Fonction récursive transcodant toutes les valeurs d'un tableau de leur encodage d'entrée vers un encodage de sortie donné<br /><br /><br /><br />
<h4>Tags:</h4>
<div class="tags">
<table border="0" cellspacing="0" cellpadding="0">
<tr>
<td><b>return:</b>&nbsp;&nbsp;</td><td>Le tableau encodé dans l'encodage de sortie</td>
</tr>
<tr>
<td><b>access:</b>&nbsp;&nbsp;</td><td>protected</td>
</tr>
</table>
</div>
<br /><br />
 
<h4>Parameters:</h4>
<div class="tags">
<table border="0" cellspacing="0" cellpadding="0">
<tr>
<td class="type">$tableau&nbsp;&nbsp;</td>
<td><b>$tableau</b>&nbsp;&nbsp;</td>
<td>Array Un tableau de données à encoder</td>
</tr>
<tr>
<td class="type">$encodage_sortie&nbsp;&nbsp;</td>
<td><b>$encodage_sortie</b>&nbsp;&nbsp;</td>
<td>String l'encodage vers lequel on doit transcoder</td>
</tr>
<tr>
<td class="type">$encodage_entree&nbsp;&nbsp;</td>
<td><b>$encodage_entree</b>&nbsp;&nbsp;</td>
<td>String l'encodage original des chaines du tableau (optionnel)</td>
</tr>
</table>
</div><br />
<div class="top">[ <a href="#top">Top</a> ]</div>
</div>
<hr />
<a name="methodgetCheminAppli"></a>
<h3>static method getCheminAppli <span class="smalllinenumber">[line <a href="../__filesource/fsource_Framework__Framework.php.html#a155">155</a>]</span></h3>
<div class="function">
<table width="90%" border="0" cellspacing="0" cellpadding="1"><tr><td class="code_border">
<table width="100%" border="0" cellspacing="0" cellpadding="2"><tr><td class="code">
<code>static string getCheminAppli(
)</code>
</td></tr></table>
</td></tr></table><br />
accesseur pour le chemin<br /><br /><br /><br />
<h4>Tags:</h4>
<div class="tags">
<table border="0" cellspacing="0" cellpadding="0">
<tr>
<td><b>return:</b>&nbsp;&nbsp;</td><td>le chemin</td>
</tr>
<tr>
<td><b>access:</b>&nbsp;&nbsp;</td><td>public</td>
</tr>
</table>
</div>
<br /><br />
 
<div class="top">[ <a href="#top">Top</a> ]</div>
</div>
<hr />
<a name="methodgetInfoAppli"></a>
<h3>static method getInfoAppli <span class="smalllinenumber">[line <a href="../__filesource/fsource_Framework__Framework.php.html#a179">179</a>]</span></h3>
<div class="function">
<table width="90%" border="0" cellspacing="0" cellpadding="1"><tr><td class="code_border">
<table width="100%" border="0" cellspacing="0" cellpadding="2"><tr><td class="code">
<code>static void getInfoAppli(
[string
$cle = null])</code>
</td></tr></table>
</td></tr></table><br />
Accesseur pour le tableau d'infos sur l'application.<br /><br /><br /><br />
<h4>Tags:</h4>
<div class="tags">
<table border="0" cellspacing="0" cellpadding="0">
<tr>
<td><b>access:</b>&nbsp;&nbsp;</td><td>public</td>
</tr>
</table>
</div>
<br /><br />
 
<h4>Parameters:</h4>
<div class="tags">
<table border="0" cellspacing="0" cellpadding="0">
<tr>
<td class="type">string&nbsp;&nbsp;</td>
<td><b>$cle</b>&nbsp;&nbsp;</td>
<td>la clé à laquelle on veut accéder</td>
</tr>
</table>
</div><br />
<div class="top">[ <a href="#top">Top</a> ]</div>
</div>
<hr />
<a name="methodsetCheminAppli"></a>
<h3>static method setCheminAppli <span class="smalllinenumber">[line <a href="../__filesource/fsource_Framework__Framework.php.html#a136">136</a>]</span></h3>
<div class="function">
<table width="90%" border="0" cellspacing="0" cellpadding="1"><tr><td class="code_border">
<table width="100%" border="0" cellspacing="0" cellpadding="2"><tr><td class="code">
<code>static void setCheminAppli(
string
$chemin_fichier_principal)</code>
</td></tr></table>
</td></tr></table><br />
Permet d'indiquer le chemin de base de l'Application.<br /><br /><p>Cette méthode doit obligatoirement être utilisée par l'application pour que le Framework fonctionne correctement.</p><br /><br /><br />
<h4>Tags:</h4>
<div class="tags">
<table border="0" cellspacing="0" cellpadding="0">
<tr>
<td><b>access:</b>&nbsp;&nbsp;</td><td>public</td>
</tr>
</table>
</div>
<br /><br />
 
<h4>Parameters:</h4>
<div class="tags">
<table border="0" cellspacing="0" cellpadding="0">
<tr>
<td class="type">string&nbsp;&nbsp;</td>
<td><b>$chemin_fichier_principal</b>&nbsp;&nbsp;</td>
<td>chemin de base</td>
</tr>
</table>
</div><br />
<div class="top">[ <a href="#top">Top</a> ]</div>
</div>
<hr />
<a name="methodsetInfoAppli"></a>
<h3>static method setInfoAppli <span class="smalllinenumber">[line <a href="../__filesource/fsource_Framework__Framework.php.html#a167">167</a>]</span></h3>
<div class="function">
<table width="90%" border="0" cellspacing="0" cellpadding="1"><tr><td class="code_border">
<table width="100%" border="0" cellspacing="0" cellpadding="2"><tr><td class="code">
<code>static void setInfoAppli(
array
$info)</code>
</td></tr></table>
</td></tr></table><br />
Le tableau des informations sur l'application possède les clés suivantes :<br /><br /><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></p><br /><br /><br />
<h4>Tags:</h4>
<div class="tags">
<table border="0" cellspacing="0" cellpadding="0">
<tr>
<td><b>access:</b>&nbsp;&nbsp;</td><td>public</td>
</tr>
</table>
</div>
<br /><br />
 
<h4>Parameters:</h4>
<div class="tags">
<table border="0" cellspacing="0" cellpadding="0">
<tr>
<td class="type">array&nbsp;&nbsp;</td>
<td><b>$info</b>&nbsp;&nbsp;</td>
<td>tableau fournissant des informations sur l'application</td>
</tr>
</table>
</div><br />
<div class="top">[ <a href="#top">Top</a> ]</div>
</div>
<hr />
<a name="methodverifierEtReencoderTableauRequete"></a>
<h3>static method verifierEtReencoderTableauRequete <span class="smalllinenumber">[line <a href="../__filesource/fsource_Framework__Framework.php.html#a192">192</a>]</span></h3>
<div class="function">
<table width="90%" border="0" cellspacing="0" cellpadding="1"><tr><td class="code_border">
<table width="100%" border="0" cellspacing="0" cellpadding="2"><tr><td class="code">
<code>static void verifierEtReencoderTableauRequete(
)</code>
</td></tr></table>
</td></tr></table><br />
Procédure vérifiant l'encodage des tableaux $_GET et $_POST et les transcodant dans l'encodage de l'application<br /><br /><br /><br />
<h4>Tags:</h4>
<div class="tags">
<table border="0" cellspacing="0" cellpadding="0">
<tr>
<td><b>access:</b>&nbsp;&nbsp;</td><td>protected</td>
</tr>
</table>
</div>
<br /><br />
 
<div class="top">[ <a href="#top">Top</a> ]</div>
</div>
 
</div><br />
 
 
<div class="credit">
<hr />
Documentation generated on Tue, 18 Jan 2011 15:31:18 +0100 by <a href="http://www.phpdoc.org">phpDocumentor 1.4.3</a>
</div>
</td></tr></table>
</td>
</tr>
</table>
 
</body>
</html>