Subversion Repositories Applications.framework

Rev

Blame | Last modification | View Log | RSS feed

<!DOCTYPE html>
<html lang="en">
<head>
    <meta name="viewport" content="width=device-width, initial-scale=1.0, maximum-scale=1.0, user-scalable=0"/>
    <meta charset="utf-8"/>
    <title>TBFramework - v0.4</title>
    <meta name="author" content=""/>
    <meta name="description" content=""/>

    <link href="https://netdna.bootstrapcdn.com/twitter-bootstrap/2.3.2/css/bootstrap-combined.no-icons.min.css" rel="stylesheet">
    <link href="https://netdna.bootstrapcdn.com/font-awesome/3.2.1/css/font-awesome.min.css" rel="stylesheet">
    <link href="../css/prism.css" rel="stylesheet" media="all"/>
    <link href="../css/template.css" rel="stylesheet" media="all"/>
    
    <!--[if lt IE 9]>
    <script src="https://html5shim.googlecode.com/svn/trunk/html5.js" type="text/javascript"></script>
    <![endif]-->
    <script src="https://code.jquery.com/jquery-1.10.2.min.js" type="text/javascript"></script>
    <script src="https://code.jquery.com/ui/1.10.3/jquery-ui.min.js" type="text/javascript"></script>
    <script src="https://netdna.bootstrapcdn.com/twitter-bootstrap/2.3.2/js/bootstrap.min.js"></script>
    <script src="../js/jquery.smooth-scroll.js"></script>
    <script src="../js/prism.min.js"></script>
    <!-- TODO: Add http://jscrollpane.kelvinluck.com/ to style the scrollbars for browsers not using webkit-->
    <script type="text/javascript">
    function loadExternalCodeSnippets() {
        Array.prototype.slice.call(document.querySelectorAll('pre[data-src]')).forEach(function (pre) {
            var src = pre.getAttribute('data-src');
            var extension = (src.match(/\.(\w+)$/) || [, ''])[1];
            var language = 'php';

            var code = document.createElement('code');
            code.className = 'language-' + language;

            pre.textContent = '';

            code.textContent = 'Loading…';

            pre.appendChild(code);

            var xhr = new XMLHttpRequest();

            xhr.open('GET', src, true);

            xhr.onreadystatechange = function () {
                if (xhr.readyState == 4) {

                    if (xhr.status < 400 && xhr.responseText) {
                        code.textContent = xhr.responseText;

                        Prism.highlightElement(code);
                    }
                    else if (xhr.status >= 400) {
                        code.textContent = '✖ Error ' + xhr.status + ' while fetching file: ' + xhr.statusText;
                    }
                    else {
                        code.textContent = '✖ Error: File does not exist or is empty';
                    }
                }
            };

            xhr.send(null);
        });
    }

    $(document).ready(function(){
        loadExternalCodeSnippets();
    });
    $('#source-view').on('shown', function () {
        loadExternalCodeSnippets();
    })
</script>

    <link rel="shortcut icon" href="../images/favicon.ico"/>
    <link rel="apple-touch-icon" href="../images/apple-touch-icon.png"/>
    <link rel="apple-touch-icon" sizes="72x72" href="../images/apple-touch-icon-72x72.png"/>
    <link rel="apple-touch-icon" sizes="114x114" href="../images/apple-touch-icon-114x114.png"/>
</head>
<body>

<div class="navbar navbar-fixed-top">
    <div class="navbar-inner">
        <div class="container">
            <a class="btn btn-navbar" data-toggle="collapse" data-target=".nav-collapse">
                <i class="icon-ellipsis-vertical"></i>
            </a>
            <a class="brand" href="../index.html">TBFramework - v0.4</a>

            <div class="nav-collapse">
                <ul class="nav pull-right">
                    <li class="dropdown">
                        <a href="../index.html" class="dropdown-toggle" data-toggle="dropdown">
                            API Documentation <b class="caret"></b>
                        </a>
                        <ul class="dropdown-menu">
                                                    </ul>
                    </li>
                    <li class="dropdown" id="charts-menu">
                        <a href="#" class="dropdown-toggle" data-toggle="dropdown">
                            Charts <b class="caret"></b>
                        </a>
                        <ul class="dropdown-menu">
                            <li>
                                <a href="../graphs/class.html">
                                    <i class="icon-list-alt"></i>&#160;Class hierarchy diagram
                                </a>
                            </li>
                        </ul>
                    </li>
                    <li class="dropdown" id="reports-menu">
                        <a href="#" class="dropdown-toggle" data-toggle="dropdown">
                            Reports <b class="caret"></b>
                        </a>
                        <ul class="dropdown-menu">
                            <li>
                                <a href="../reports/errors.html">
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    <i class="icon-list-alt"></i>&#160;Errors <span class="label label-info pull-right">281</span>
                                </a>
                            </li>
                            <li>
                                <a href="../reports/markers.html">
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    <i class="icon-list-alt"></i>&#160;Markers <span class="label label-info pull-right">12</span>
                                </a>
                            </li>
                        </ul>
                    </li>
                </ul>
            </div>
        </div>
    </div>
    <!--<div class="go_to_top">-->
    <!--<a href="#___" style="color: inherit">Back to top&#160;&#160;<i class="icon-upload icon-white"></i></a>-->
    <!--</div>-->
</div>

<div id="___" class="container-fluid">
        <section class="row-fluid">
        <div class="span2 sidebar">
                                <div class="accordion" style="margin-bottom: 0">
        <div class="accordion-group">
            <div class="accordion-heading">
                                    <a class="accordion-toggle " data-toggle="collapse" data-target="#namespace-1206739871"></a>
                                <a href="../namespaces/default.html" style="margin-left: 30px; padding-left: 0">\</a>
            </div>
            <div id="namespace-1206739871" class="accordion-body collapse in">
                <div class="accordion-inner">

                    
                    <ul>
                                                                                                    <li class="class"><a href="../classes/Url.html">Url</a></li>
                                                    <li class="class"><a href="../classes/Debug.html">Debug</a></li>
                                                    <li class="class"><a href="../classes/Chronometre.html">Chronometre</a></li>
                                                    <li class="class"><a href="../classes/RestServeur.html">RestServeur</a></li>
                                                    <li class="class"><a href="../classes/SquelettePhp.html">SquelettePhp</a></li>
                                                    <li class="class"><a href="../classes/Controleur.html">Controleur</a></li>
                                                    <li class="class"><a href="../classes/Cache.html">Cache</a></li>
                                                    <li class="class"><a href="../classes/RestClient.html">RestClient</a></li>
                                                    <li class="class"><a href="../classes/GestionnaireException.html">GestionnaireException</a></li>
                                                    <li class="class"><a href="../classes/Script.html">Script</a></li>
                                                    <li class="class"><a href="../classes/Registre.html">Registre</a></li>
                                                    <li class="class"><a href="../classes/RestService.html">RestService</a></li>
                                                    <li class="class"><a href="../classes/Cli.html">Cli</a></li>
                                                    <li class="class"><a href="../classes/Encodage.html">Encodage</a></li>
                                                    <li class="class"><a href="../classes/Tableau.html">Tableau</a></li>
                                                    <li class="class"><a href="../classes/Pattern.html">Pattern</a></li>
                                                    <li class="class"><a href="../classes/Chaine.html">Chaine</a></li>
                                                    <li class="class"><a href="../classes/Fichier.html">Fichier</a></li>
                                                    <li class="class"><a href="../classes/I18n.html">I18n</a></li>
                                                    <li class="class"><a href="../classes/Config.html">Config</a></li>
                                                    <li class="class"><a href="../classes/CacheSqlite.html">CacheSqlite</a></li>
                                                    <li class="class"><a href="../classes/Bdd.html">Bdd</a></li>
                                                    <li class="class"><a href="../classes/Log.html">Log</a></li>
                                                    <li class="class"><a href="../classes/CacheFichier.html">CacheFichier</a></li>
                                                    <li class="class"><a href="../classes/Framework.html">Framework</a></li>
                                                    <li class="class"><a href="../classes/CacheSimple.html">CacheSimple</a></li>
                                            </ul>
                </div>
            </div>
        </div>
    </div>

        </div>
    </section>
    <section class="row-fluid">
        <div class="span10 offset2">
            <div class="row-fluid">
                <div class="span8 content class">
                    <nav>
                                                <a href="../namespaces/default.html">\</a> <i class="icon-level-up"></i>
                                            </nav>
                    <a href="#source-view" role="button" class="pull-right btn" data-toggle="modal"><i class="icon-code"></i></a>

                    <h1><small>\</small>Script</h1>
                    <p><em>Script est une classe abstraite qui doit être implémenté par les classes éxecutant des scripts en ligne de commande.</em></p>
                    

                    <section id="summary">
                        <h2>Summary</h2>
                        <section class="row-fluid heading">
                            <section class="span4">
                                <a href="#methods">Methods</a>
                            </section>
                            <section class="span4">
                                <a href="#properties">Properties</a>
                            </section>
                            <section class="span4">
                                <a href="#constants">Constants</a>
                            </section>
                        </section>
                        <section class="row-fluid public">
                            <section class="span4">
                                                                    <a href="../classes/Script.html#method___construct" class="">__construct()</a><br />
                                                                    <a href="../classes/Script.html#method_executer" class="">executer()</a><br />
                                                            </section>
                            <section class="span4">
                                                                    <em>No public properties found</em>
                                                            </section>
                            <section class="span4">
                                                                    <a href="../classes/Script.html#constant_MSG_LOG" class="">MSG_LOG</a><br />
                                                                    <a href="../classes/Script.html#constant_MSG_ERREUR" class="">MSG_ERREUR</a><br />
                                                                    <a href="../classes/Script.html#constant_MSG_AVERTISSEMENT" class="">MSG_AVERTISSEMENT</a><br />
                                                                    <a href="../classes/Script.html#constant_MSG_INFO" class="">MSG_INFO</a><br />
                                                            </section>
                        </section>
                        <section class="row-fluid protected">
                            <section class="span4">
                                                                    <a href="../classes/Script.html#method_getScriptNom" class="">getScriptNom()</a><br />
                                                                    <a href="../classes/Script.html#method_getScriptChemin" class="">getScriptChemin()</a><br />
                                                                    <a href="../classes/Script.html#method_getParametre" class="">getParametre()</a><br />
                                                                    <a href="../classes/Script.html#method_traiterErreur" class="">traiterErreur()</a><br />
                                                                    <a href="../classes/Script.html#method_traiterAvertissement" class="">traiterAvertissement()</a><br />
                                                                    <a href="../classes/Script.html#method_traiterInfo" class="">traiterInfo()</a><br />
                                                                    <a href="../classes/Script.html#method_formaterMsg" class="">formaterMsg()</a><br />
                                                                    <a href="../classes/Script.html#method_afficherAvancement" class="">afficherAvancement()</a><br />
                                                            </section>
                            <section class="span4">
                                                                    <a href="../classes/Script.html#property_parametres_autorises" class="">$parametres_autorises</a><br />
                                                                    <a href="../classes/Script.html#property_parametres" class="">$parametres</a><br />
                                                            </section>
                            <section class="span4">
                                <em>N/A</em>
                            </section>
                        </section>
                        <section class="row-fluid private">
                            <section class="span4">
                                                                    <a href="../classes/Script.html#method_getMsgNiveauTxt" class="">getMsgNiveauTxt()</a><br />
                                                                    <a href="../classes/Script.html#method_chargerParametresAutorises" class="">chargerParametresAutorises()</a><br />
                                                                    <a href="../classes/Script.html#method_chargerParametres" class="">chargerParametres()</a><br />
                                                                    <a href="../classes/Script.html#method_traiterMessage" class="">traiterMessage()</a><br />
                                                            </section>
                            <section class="span4">
                                                                    <a href="../classes/Script.html#property_msg_niveaux_txt" class="">$msg_niveaux_txt</a><br />
                                                                    <a href="../classes/Script.html#property_script_nom" class="">$script_nom</a><br />
                                                                    <a href="../classes/Script.html#property_parametres_autorises_defaut" class="">$parametres_autorises_defaut</a><br />
                                                                    <a href="../classes/Script.html#property_parametres_cli" class="">$parametres_cli</a><br />
                                                                    <a href="../classes/Script.html#property_avancement" class="">$avancement</a><br />
                                                                    <a href="../classes/Script.html#property_parametres_obligatoires" class="">$parametres_obligatoires</a><br />
                                                            </section>
                            <section class="span4">
                                <em>N/A</em>
                            </section>
                        </section>
                    </section>
                </div>
                <aside class="span4 detailsbar">
                                            <span class="label label-info">abstract</span>
                                        
                    
                    <dl>
                        <dt>File</dt>
                            <dd><a href="../files/Script.php.html"><div class="path-wrapper">Script.php</div></a></dd>
                                                <dt>Package</dt>
                            <dd><div class="namespace-wrapper">\Framework</div></dd>
                                                <dt>Class hierarchy</dt>
                            <dd class="hierarchy">
                                                                                                                                                                    <div class="namespace-wrapper">\Script</div>
                            </dd>

                        
                        
                        
                                                                            <dt>See also</dt>
                                                                                    <dd><a href="/doc/framework/"><div class="namespace-wrapper">/doc/framework/</div></a></dd>
                                                    
                                                                        </dl>
                    <h2>Tags</h2>
                    <table class="table table-condensed">
                                            <tr>
                            <th>
                                category
                            </th>
                            <td>
                                                                    <p>PHP 5.2</p>
                                                            </td>
                        </tr>
                                            <tr>
                            <th>
                                author
                            </th>
                            <td>
                                                                    <p>Jean-Pascal MILCENT <a href="mailto:jpm@tela-botanica.org">jpm@tela-botanica.org</a></p>
                                                                    <p>Delphine CAUQUIL <a href="mailto:delphine@tela-botanica.org">delphine@tela-botanica.org</a></p>
                                                            </td>
                        </tr>
                                            <tr>
                            <th>
                                copyright
                            </th>
                            <td>
                                                                    <p>Copyright (c) 2010, Tela Botanica (accueil@tela-botanica.org)</p>
                                                            </td>
                        </tr>
                                            <tr>
                            <th>
                                license
                            </th>
                            <td>
                                                                    <p><a href="http://www.gnu.org/licenses/gpl.html">http://www.gnu.org/licenses/gpl.html</a> Licence GNU-GPL-v3</p>
                                                                    <p><a href="http://www.cecill.info/licences/Licence_CeCILL_V2-fr.txt">http://www.cecill.info/licences/Licence_CeCILL_V2-fr.txt</a> Licence CECILL-v2</p>
                                                            </td>
                        </tr>
                                            <tr>
                            <th>
                                since
                            </th>
                            <td>
                                                                    
                                                            </td>
                        </tr>
                                            <tr>
                            <th>
                                version
                            </th>
                            <td>
                                                                    <p>$Id: Script.php 299 2011-01-18 14:03:46Z jpm $</p>
                                                            </td>
                        </tr>
                                            <tr>
                            <th>
                                todo
                            </th>
                            <td>
                                                            </td>
                        </tr>
                                        </table>
                </aside>
            </div>

                                    <a id="constants" name="constants"></a>
            <div class="row-fluid">
                <div class="span8 content class">
                    <h2>Constants</h2>
                </div>
                <aside class="span4 detailsbar"></aside>
            </div>

                                <div class="row-fluid">
        <div class="span8 content class">
            <a id="constant_MSG_LOG" name="constant_MSG_LOG" class="anchor"></a>
            <article id="constant_MSG_LOG" class="constant">
                <h3 class="">MSG_LOG</h3>
                <pre class="signature">MSG_LOG</pre>
                <p><em>Niveau de message de type LOG</em></p>
                
            </article>
        </div>
        <aside class="span4 detailsbar">
            <h1><i class="icon-arrow-down"></i></h1>
                        <dl>
                                                                            </dl>
            <h2>Tags</h2>
            <table class="table table-condensed">
                                    <tr>
                        <th>
                            todo
                        </th>
                        <td>
                                                    </td>
                    </tr>
                            </table>
        </aside>
    </div>

                                    <div class="row-fluid">
        <div class="span8 content class">
            <a id="constant_MSG_ERREUR" name="constant_MSG_ERREUR" class="anchor"></a>
            <article id="constant_MSG_ERREUR" class="constant">
                <h3 class="">MSG_ERREUR</h3>
                <pre class="signature">MSG_ERREUR</pre>
                <p><em>Niveau de message de type ERREUR</em></p>
                
            </article>
        </div>
        <aside class="span4 detailsbar">
            <h1><i class="icon-arrow-down"></i></h1>
                        <dl>
                                                                            </dl>
            <h2>Tags</h2>
            <table class="table table-condensed">
                                    <tr>
                        <th>
                            todo
                        </th>
                        <td>
                                                    </td>
                    </tr>
                            </table>
        </aside>
    </div>

                                    <div class="row-fluid">
        <div class="span8 content class">
            <a id="constant_MSG_AVERTISSEMENT" name="constant_MSG_AVERTISSEMENT" class="anchor"></a>
            <article id="constant_MSG_AVERTISSEMENT" class="constant">
                <h3 class="">MSG_AVERTISSEMENT</h3>
                <pre class="signature">MSG_AVERTISSEMENT</pre>
                <p><em>Niveau de message de type AVERTISSEMENT</em></p>
                
            </article>
        </div>
        <aside class="span4 detailsbar">
            <h1><i class="icon-arrow-down"></i></h1>
                        <dl>
                                                                            </dl>
            <h2>Tags</h2>
            <table class="table table-condensed">
                                    <tr>
                        <th>
                            todo
                        </th>
                        <td>
                                                    </td>
                    </tr>
                            </table>
        </aside>
    </div>

                                    <div class="row-fluid">
        <div class="span8 content class">
            <a id="constant_MSG_INFO" name="constant_MSG_INFO" class="anchor"></a>
            <article id="constant_MSG_INFO" class="constant">
                <h3 class="">MSG_INFO</h3>
                <pre class="signature">MSG_INFO</pre>
                <p><em>Niveau de message de type INFORMATION</em></p>
                
            </article>
        </div>
        <aside class="span4 detailsbar">
            <h1><i class="icon-arrow-down"></i></h1>
                        <dl>
                                                                            </dl>
            <h2>Tags</h2>
            <table class="table table-condensed">
                                    <tr>
                        <th>
                            todo
                        </th>
                        <td>
                                                    </td>
                    </tr>
                            </table>
        </aside>
    </div>

                            
                                    <a id="properties" name="properties"></a>
            <div class="row-fluid">
                <div class="span8 content class">
                    <h2>Properties</h2>
                </div>
                <aside class="span4 detailsbar"></aside>
            </div>

                                                    <div class="row-fluid">
        <div class="span8 content class">
            <a id="property_parametres_autorises" name="property_parametres_autorises" class="anchor"></a>
            <article class="property">
                <h3 class="protected ">$parametres_autorises</h3>
                <pre class="signature">$parametres_autorises : array</pre>
                <p><em>Paramêtres autorisés par le script.</em></p>
                <p>le tableau est de la forme suivante :</p>
<ul>
<li>clé =  nom du paramêtre '-foo'</li>
<li>value = contient un nouveau tableau composé de cette façon :
<ul>
<li>booléen: true si le paramêtre est obligatoire</li>
<li>booléen ou var : true si le paramêtre nécessite un valeur à sa suite ou la valeur par défaut</li>
<li>string: description du contenu du paramêtre
Les paramêtres optionels devraient être déclaré à la fin du tableau.
Le dernier parametre du tableau peut avoir la valeur '...',
il contiendra alors l'ensemble des paramêtres suivant trouvés sur la ligne de commande.</li>
</ul>
</li>
</ul>

                                <h4>Type</h4>
                array
                                            </article>
        </div>
        <aside class="span4 detailsbar">
            <h1><i class="icon-arrow-down"></i></h1>
                        <dl>
                                                            </dl>
            <h2>Tags</h2>
            <table class="table table-condensed">
                                    <tr>
                        <th>
                            todo
                        </th>
                        <td>
                                                    </td>
                    </tr>
                            </table>
        </aside>
    </div>

                                    <div class="row-fluid">
        <div class="span8 content class">
            <a id="property_parametres" name="property_parametres" class="anchor"></a>
            <article class="property">
                <h3 class="protected ">$parametres</h3>
                <pre class="signature">$parametres : array</pre>
                <p><em>Contient le tableau des paramètres disponible après vérification :
le tableau est de la forme suivante :
- clé =  nom du paramêtre &#039;-foo&#039;
- valeur = la valeur récupérée sur la ligne de commande</em></p>
                

                                <h4>Type</h4>
                array
                                            </article>
        </div>
        <aside class="span4 detailsbar">
            <h1><i class="icon-arrow-down"></i></h1>
                        <dl>
                                                            </dl>
            <h2>Tags</h2>
            <table class="table table-condensed">
                                    <tr>
                        <th>
                            todo
                        </th>
                        <td>
                                                    </td>
                    </tr>
                            </table>
        </aside>
    </div>

                                                    <div class="row-fluid">
        <div class="span8 content class">
            <a id="property_msg_niveaux_txt" name="property_msg_niveaux_txt" class="anchor"></a>
            <article class="property">
                <h3 class="private ">$msg_niveaux_txt</h3>
                <pre class="signature">$msg_niveaux_txt</pre>
                <p><em>Inititulé des différents types de message.</em></p>
                

                            </article>
        </div>
        <aside class="span4 detailsbar">
            <h1><i class="icon-arrow-down"></i></h1>
                        <dl>
                                                            </dl>
            <h2>Tags</h2>
            <table class="table table-condensed">
                                    <tr>
                        <th>
                            todo
                        </th>
                        <td>
                                                    </td>
                    </tr>
                            </table>
        </aside>
    </div>

                                    <div class="row-fluid">
        <div class="span8 content class">
            <a id="property_script_nom" name="property_script_nom" class="anchor"></a>
            <article class="property">
                <h3 class="private ">$script_nom</h3>
                <pre class="signature">$script_nom : string</pre>
                <p><em>Le nom du script tel que passé dans la ligne de commande.</em></p>
                

                                <h4>Type</h4>
                string
                                            </article>
        </div>
        <aside class="span4 detailsbar">
            <h1><i class="icon-arrow-down"></i></h1>
                        <dl>
                                                            </dl>
            <h2>Tags</h2>
            <table class="table table-condensed">
                                    <tr>
                        <th>
                            todo
                        </th>
                        <td>
                                                    </td>
                    </tr>
                            </table>
        </aside>
    </div>

                                    <div class="row-fluid">
        <div class="span8 content class">
            <a id="property_parametres_autorises_defaut" name="property_parametres_autorises_defaut" class="anchor"></a>
            <article class="property">
                <h3 class="private ">$parametres_autorises_defaut</h3>
                <pre class="signature">$parametres_autorises_defaut : array</pre>
                <p><em>Paramêtres par défaut disponibles pour la ligne de commande
le tableau se construit de la forme suivante :
- clé =  nom du paramêtre &#039;-foo&#039;
- value = contient un nouveau tableau composé de cette façon :
 - booléen: true si le paramêtre est obligatoire
 - booléen ou var : true si le paramêtre nécessite un valeur à sa suite ou la valeur par défaut
 - string: description du contenu du paramêtre
Les paramêtres optionels devraient être déclaré à la fin du tableau.</em></p>
                <p>Le dernier parametre du tableau peut avoir la valeur '...',
il contiendra alors l'ensemble des paramêtres suivant trouvés sur la ligne de commande.</p>

                                <h4>Type</h4>
                array
                                            </article>
        </div>
        <aside class="span4 detailsbar">
            <h1><i class="icon-arrow-down"></i></h1>
                        <dl>
                                                            </dl>
            <h2>Tags</h2>
            <table class="table table-condensed">
                                    <tr>
                        <th>
                            todo
                        </th>
                        <td>
                                                    </td>
                    </tr>
                            </table>
        </aside>
    </div>

                                    <div class="row-fluid">
        <div class="span8 content class">
            <a id="property_parametres_cli" name="property_parametres_cli" class="anchor"></a>
            <article class="property">
                <h3 class="private ">$parametres_cli</h3>
                <pre class="signature">$parametres_cli : array</pre>
                <p><em>Contient les valeurs des paramêtres récupérés de la ligne de commande :
le tableau se construit de la forme suivnate :
- clé =  nom du paramêtre &#039;-foo&#039;
- valeur = la valeur récupérée sur la ligne de commande</em></p>
                

                                <h4>Type</h4>
                array
                                            </article>
        </div>
        <aside class="span4 detailsbar">
            <h1><i class="icon-arrow-down"></i></h1>
                        <dl>
                                                            </dl>
            <h2>Tags</h2>
            <table class="table table-condensed">
                                    <tr>
                        <th>
                            todo
                        </th>
                        <td>
                                                    </td>
                    </tr>
                            </table>
        </aside>
    </div>

                                    <div class="row-fluid">
        <div class="span8 content class">
            <a id="property_avancement" name="property_avancement" class="anchor"></a>
            <article class="property">
                <h3 class="private ">$avancement</h3>
                <pre class="signature">$avancement : array</pre>
                <p><em>Tableau associatif permettant de stocker l&#039;avancement dans une boucle.</em></p>
                <p>La clé est un md5 du message à afficher au démarrage de la boucle.</p>

                                <h4>Type</h4>
                array
                                            </article>
        </div>
        <aside class="span4 detailsbar">
            <h1><i class="icon-arrow-down"></i></h1>
                        <dl>
                                                            </dl>
            <h2>Tags</h2>
            <table class="table table-condensed">
                                    <tr>
                        <th>
                            todo
                        </th>
                        <td>
                                                    </td>
                    </tr>
                            </table>
        </aside>
    </div>

                                    <div class="row-fluid">
        <div class="span8 content class">
            <a id="property_parametres_obligatoires" name="property_parametres_obligatoires" class="anchor"></a>
            <article class="property">
                <h3 class="private ">$parametres_obligatoires</h3>
                <pre class="signature">$parametres_obligatoires</pre>
                <p><em>Tableau des noms des paramètres à définir dans le fichier de config car obligatoirement nécessaire à cette classe.</em></p>
                

                            </article>
        </div>
        <aside class="span4 detailsbar">
            <h1><i class="icon-arrow-down"></i></h1>
                        <dl>
                                                            </dl>
            <h2>Tags</h2>
            <table class="table table-condensed">
                                    <tr>
                        <th>
                            todo
                        </th>
                        <td>
                                                    </td>
                    </tr>
                            </table>
        </aside>
    </div>

                            
                                    <a id="methods" name="methods"></a>
            <div class="row-fluid">
                <div class="span8 content class"><h2>Methods</h2></div>
                <aside class="span4 detailsbar"></aside>
            </div>

                                    <div class="row-fluid">
        <div class="span8 content class">
            <a id="method___construct" name="method___construct" class="anchor"></a>
            <article class="method">
                <h3 class="public ">__construct()</h3>
                <a href="#source-view" role="button" class="pull-right btn" data-toggle="modal" style="font-size: 1.1em; padding: 9px 14px"><i class="icon-code"></i></a>
                <pre class="signature" style="margin-right: 54px;">__construct( <span class="argument">$script_nom</span>,  <span class="argument">$parametres_cli</span>)</pre>
                <p><em></em></p>
                

                                    <h4>Parameters</h4>
                    <table class="table table-condensed table-hover">
                                                    <tr>
                                <td></td>
                                <td>$script_nom</td>
                                <td></td>
                            </tr>
                                                    <tr>
                                <td></td>
                                <td>$parametres_cli</td>
                                <td></td>
                            </tr>
                                            </table>
                
                
                            </article>
        </div>
        <aside class="span4 detailsbar">
            <h1><i class="icon-arrow-down"></i></h1>
                                                            <dl>
                                                                            </dl>
            <h2>Tags</h2>
            <table class="table table-condensed">
                                    <tr>
                        <th>
                            todo
                        </th>
                        <td>
                                                    </td>
                    </tr>
                            </table>
        </aside>
    </div>

                                    <div class="row-fluid">
        <div class="span8 content class">
            <a id="method_executer" name="method_executer" class="anchor"></a>
            <article class="method">
                <h3 class="public ">executer()</h3>
                <a href="#source-view" role="button" class="pull-right btn" data-toggle="modal" style="font-size: 1.1em; padding: 9px 14px"><i class="icon-code"></i></a>
                <pre class="signature" style="margin-right: 54px;">executer()</pre>
                <p><em></em></p>
                

                
                
                            </article>
        </div>
        <aside class="span4 detailsbar">
            <h1><i class="icon-arrow-down"></i></h1>
                                        <span class="label label-info">abstract</span>
                                                <dl>
                                                                            </dl>
            <h2>Tags</h2>
            <table class="table table-condensed">
                                    <tr>
                        <th>
                            todo
                        </th>
                        <td>
                                                    </td>
                    </tr>
                            </table>
        </aside>
    </div>

                                                    <div class="row-fluid">
        <div class="span8 content class">
            <a id="method_getScriptNom" name="method_getScriptNom" class="anchor"></a>
            <article class="method">
                <h3 class="protected ">getScriptNom()</h3>
                <a href="#source-view" role="button" class="pull-right btn" data-toggle="modal" style="font-size: 1.1em; padding: 9px 14px"><i class="icon-code"></i></a>
                <pre class="signature" style="margin-right: 54px;">getScriptNom()</pre>
                <p><em></em></p>
                

                
                
                            </article>
        </div>
        <aside class="span4 detailsbar">
            <h1><i class="icon-arrow-down"></i></h1>
                                                            <dl>
                                                                            </dl>
            <h2>Tags</h2>
            <table class="table table-condensed">
                                    <tr>
                        <th>
                            todo
                        </th>
                        <td>
                                                    </td>
                    </tr>
                            </table>
        </aside>
    </div>

                                    <div class="row-fluid">
        <div class="span8 content class">
            <a id="method_getScriptChemin" name="method_getScriptChemin" class="anchor"></a>
            <article class="method">
                <h3 class="protected ">getScriptChemin()</h3>
                <a href="#source-view" role="button" class="pull-right btn" data-toggle="modal" style="font-size: 1.1em; padding: 9px 14px"><i class="icon-code"></i></a>
                <pre class="signature" style="margin-right: 54px;">getScriptChemin( <span class="argument">$doit_exister</span>)</pre>
                <p><em></em></p>
                

                                    <h4>Parameters</h4>
                    <table class="table table-condensed table-hover">
                                                    <tr>
                                <td></td>
                                <td>$doit_exister</td>
                                <td></td>
                            </tr>
                                            </table>
                
                
                            </article>
        </div>
        <aside class="span4 detailsbar">
            <h1><i class="icon-arrow-down"></i></h1>
                                                            <dl>
                                                                            </dl>
            <h2>Tags</h2>
            <table class="table table-condensed">
                                    <tr>
                        <th>
                            todo
                        </th>
                        <td>
                                                    </td>
                    </tr>
                            </table>
        </aside>
    </div>

                                    <div class="row-fluid">
        <div class="span8 content class">
            <a id="method_getParametre" name="method_getParametre" class="anchor"></a>
            <article class="method">
                <h3 class="protected ">getParametre()</h3>
                <a href="#source-view" role="button" class="pull-right btn" data-toggle="modal" style="font-size: 1.1em; padding: 9px 14px"><i class="icon-code"></i></a>
                <pre class="signature" style="margin-right: 54px;">getParametre( <span class="argument">$parametre</span>)</pre>
                <p><em></em></p>
                

                                    <h4>Parameters</h4>
                    <table class="table table-condensed table-hover">
                                                    <tr>
                                <td></td>
                                <td>$parametre</td>
                                <td></td>
                            </tr>
                                            </table>
                
                
                            </article>
        </div>
        <aside class="span4 detailsbar">
            <h1><i class="icon-arrow-down"></i></h1>
                                                            <dl>
                                                                            </dl>
            <h2>Tags</h2>
            <table class="table table-condensed">
                                    <tr>
                        <th>
                            todo
                        </th>
                        <td>
                                                    </td>
                    </tr>
                            </table>
        </aside>
    </div>

                                    <div class="row-fluid">
        <div class="span8 content class">
            <a id="method_traiterErreur" name="method_traiterErreur" class="anchor"></a>
            <article class="method">
                <h3 class="protected ">traiterErreur()</h3>
                <a href="#source-view" role="button" class="pull-right btn" data-toggle="modal" style="font-size: 1.1em; padding: 9px 14px"><i class="icon-code"></i></a>
                <pre class="signature" style="margin-right: 54px;">traiterErreur( <span class="argument">$message</span>,  <span class="argument">$tab_arguments</span>) : \void.</pre>
                <p><em>Affiche un message d&#039;erreur formaté.</em></p>
                <p>Si le paramétre de verbosité (-v) vaut 1 ou plus, le message est écrit dans le fichier de log et afficher dans la console.</p>

                                    <h4>Parameters</h4>
                    <table class="table table-condensed table-hover">
                                                    <tr>
                                <td></td>
                                <td>$message</td>
                                <td></td>
                            </tr>
                                                    <tr>
                                <td></td>
                                <td>$tab_arguments</td>
                                <td></td>
                            </tr>
                                            </table>
                
                
                                    <h4>Returns</h4>
                    \void.
                                                </article>
        </div>
        <aside class="span4 detailsbar">
            <h1><i class="icon-arrow-down"></i></h1>
                                                            <dl>
                                                                            </dl>
            <h2>Tags</h2>
            <table class="table table-condensed">
                                    <tr>
                        <th>
                            todo
                        </th>
                        <td>
                                                    </td>
                    </tr>
                            </table>
        </aside>
    </div>

                                    <div class="row-fluid">
        <div class="span8 content class">
            <a id="method_traiterAvertissement" name="method_traiterAvertissement" class="anchor"></a>
            <article class="method">
                <h3 class="protected ">traiterAvertissement()</h3>
                <a href="#source-view" role="button" class="pull-right btn" data-toggle="modal" style="font-size: 1.1em; padding: 9px 14px"><i class="icon-code"></i></a>
                <pre class="signature" style="margin-right: 54px;">traiterAvertissement( <span class="argument">$message</span>,  <span class="argument">$tab_arguments</span>) : \void.</pre>
                <p><em>Affiche un message d&#039;avertissement formaté.</em></p>
                <p>Si le paramétre de verbosité (-v) vaut 1, le message est écrit dans le fichier de log.
Si le paramétre de verbosité (-v) vaut 2 ou plus, le message est écrit dans le fichier de log et afficher dans la console.</p>

                                    <h4>Parameters</h4>
                    <table class="table table-condensed table-hover">
                                                    <tr>
                                <td></td>
                                <td>$message</td>
                                <td></td>
                            </tr>
                                                    <tr>
                                <td></td>
                                <td>$tab_arguments</td>
                                <td></td>
                            </tr>
                                            </table>
                
                
                                    <h4>Returns</h4>
                    \void.
                                                </article>
        </div>
        <aside class="span4 detailsbar">
            <h1><i class="icon-arrow-down"></i></h1>
                                                            <dl>
                                                                            </dl>
            <h2>Tags</h2>
            <table class="table table-condensed">
                                    <tr>
                        <th>
                            todo
                        </th>
                        <td>
                                                    </td>
                    </tr>
                            </table>
        </aside>
    </div>

                                    <div class="row-fluid">
        <div class="span8 content class">
            <a id="method_traiterInfo" name="method_traiterInfo" class="anchor"></a>
            <article class="method">
                <h3 class="protected ">traiterInfo()</h3>
                <a href="#source-view" role="button" class="pull-right btn" data-toggle="modal" style="font-size: 1.1em; padding: 9px 14px"><i class="icon-code"></i></a>
                <pre class="signature" style="margin-right: 54px;">traiterInfo( <span class="argument">$message</span>,  <span class="argument">$tab_arguments</span>) : \void.</pre>
                <p><em>Retourne un message d&#039;information formaté.</em></p>
                <p>Si le paramétre de verbosité (-v) vaut 1 ou 2 , le message est écrit dans le fichier de log.
Si le paramétre de verbosité (-v) vaut 3 ou plus, le message est écrit dans le fichier de log et afficher dans la console.</p>

                                    <h4>Parameters</h4>
                    <table class="table table-condensed table-hover">
                                                    <tr>
                                <td></td>
                                <td>$message</td>
                                <td></td>
                            </tr>
                                                    <tr>
                                <td></td>
                                <td>$tab_arguments</td>
                                <td></td>
                            </tr>
                                            </table>
                
                
                                    <h4>Returns</h4>
                    \void.
                                                </article>
        </div>
        <aside class="span4 detailsbar">
            <h1><i class="icon-arrow-down"></i></h1>
                                                            <dl>
                                                                            </dl>
            <h2>Tags</h2>
            <table class="table table-condensed">
                                    <tr>
                        <th>
                            todo
                        </th>
                        <td>
                                                    </td>
                    </tr>
                            </table>
        </aside>
    </div>

                                    <div class="row-fluid">
        <div class="span8 content class">
            <a id="method_formaterMsg" name="method_formaterMsg" class="anchor"></a>
            <article class="method">
                <h3 class="protected ">formaterMsg()</h3>
                <a href="#source-view" role="button" class="pull-right btn" data-toggle="modal" style="font-size: 1.1em; padding: 9px 14px"><i class="icon-code"></i></a>
                <pre class="signature" style="margin-right: 54px;">formaterMsg( <span class="argument">$message</span>,  <span class="argument">$tab_arguments</span>,  <span class="argument">$niveau</span>) : string</pre>
                <p><em>Retourne un message d&#039;information formaté.</em></p>
                

                                    <h4>Parameters</h4>
                    <table class="table table-condensed table-hover">
                                                    <tr>
                                <td></td>
                                <td>$message</td>
                                <td></td>
                            </tr>
                                                    <tr>
                                <td></td>
                                <td>$tab_arguments</td>
                                <td></td>
                            </tr>
                                                    <tr>
                                <td></td>
                                <td>$niveau</td>
                                <td></td>
                            </tr>
                                            </table>
                
                
                                    <h4>Returns</h4>
                    string
                                            &mdash; <p>le message d'erreur formaté.</p>
                                                </article>
        </div>
        <aside class="span4 detailsbar">
            <h1><i class="icon-arrow-down"></i></h1>
                                                            <dl>
                                                                            </dl>
            <h2>Tags</h2>
            <table class="table table-condensed">
                                    <tr>
                        <th>
                            todo
                        </th>
                        <td>
                                                    </td>
                    </tr>
                            </table>
        </aside>
    </div>

                                    <div class="row-fluid">
        <div class="span8 content class">
            <a id="method_afficherAvancement" name="method_afficherAvancement" class="anchor"></a>
            <article class="method">
                <h3 class="protected ">afficherAvancement()</h3>
                <a href="#source-view" role="button" class="pull-right btn" data-toggle="modal" style="font-size: 1.1em; padding: 9px 14px"><i class="icon-code"></i></a>
                <pre class="signature" style="margin-right: 54px;">afficherAvancement( <span class="argument">$message</span>,  <span class="argument">$depart</span>) : void</pre>
                <p><em>Utiliser cette méthode dans une boucle pour afficher un message suivi du nombre de tour de boucle effectué.</em></p>
                <p>Vous devrez vous même gérer le retour à la ligne à la sortie de la boucle.</p>

                                    <h4>Parameters</h4>
                    <table class="table table-condensed table-hover">
                                                    <tr>
                                <td></td>
                                <td>$message</td>
                                <td></td>
                            </tr>
                                                    <tr>
                                <td></td>
                                <td>$depart</td>
                                <td></td>
                            </tr>
                                            </table>
                
                
                            </article>
        </div>
        <aside class="span4 detailsbar">
            <h1><i class="icon-arrow-down"></i></h1>
                                                            <dl>
                                                                            </dl>
            <h2>Tags</h2>
            <table class="table table-condensed">
                                    <tr>
                        <th>
                            todo
                        </th>
                        <td>
                                                    </td>
                    </tr>
                            </table>
        </aside>
    </div>

                                                    <div class="row-fluid">
        <div class="span8 content class">
            <a id="method_getMsgNiveauTxt" name="method_getMsgNiveauTxt" class="anchor"></a>
            <article class="method">
                <h3 class="private ">getMsgNiveauTxt()</h3>
                <a href="#source-view" role="button" class="pull-right btn" data-toggle="modal" style="font-size: 1.1em; padding: 9px 14px"><i class="icon-code"></i></a>
                <pre class="signature" style="margin-right: 54px;">getMsgNiveauTxt( <span class="argument">$niveau</span>)</pre>
                <p><em></em></p>
                

                                    <h4>Parameters</h4>
                    <table class="table table-condensed table-hover">
                                                    <tr>
                                <td></td>
                                <td>$niveau</td>
                                <td></td>
                            </tr>
                                            </table>
                
                
                            </article>
        </div>
        <aside class="span4 detailsbar">
            <h1><i class="icon-arrow-down"></i></h1>
                            <span class="label label-info">static</span>
                                                            <dl>
                                                                            </dl>
            <h2>Tags</h2>
            <table class="table table-condensed">
                                    <tr>
                        <th>
                            todo
                        </th>
                        <td>
                                                    </td>
                    </tr>
                            </table>
        </aside>
    </div>

                                    <div class="row-fluid">
        <div class="span8 content class">
            <a id="method_chargerParametresAutorises" name="method_chargerParametresAutorises" class="anchor"></a>
            <article class="method">
                <h3 class="private ">chargerParametresAutorises()</h3>
                <a href="#source-view" role="button" class="pull-right btn" data-toggle="modal" style="font-size: 1.1em; padding: 9px 14px"><i class="icon-code"></i></a>
                <pre class="signature" style="margin-right: 54px;">chargerParametresAutorises()</pre>
                <p><em></em></p>
                

                
                
                            </article>
        </div>
        <aside class="span4 detailsbar">
            <h1><i class="icon-arrow-down"></i></h1>
                                                            <dl>
                                                                            </dl>
            <h2>Tags</h2>
            <table class="table table-condensed">
                                    <tr>
                        <th>
                            todo
                        </th>
                        <td>
                                                    </td>
                    </tr>
                            </table>
        </aside>
    </div>

                                    <div class="row-fluid">
        <div class="span8 content class">
            <a id="method_chargerParametres" name="method_chargerParametres" class="anchor"></a>
            <article class="method">
                <h3 class="private ">chargerParametres()</h3>
                <a href="#source-view" role="button" class="pull-right btn" data-toggle="modal" style="font-size: 1.1em; padding: 9px 14px"><i class="icon-code"></i></a>
                <pre class="signature" style="margin-right: 54px;">chargerParametres()</pre>
                <p><em></em></p>
                

                
                
                            </article>
        </div>
        <aside class="span4 detailsbar">
            <h1><i class="icon-arrow-down"></i></h1>
                                                            <dl>
                                                                            </dl>
            <h2>Tags</h2>
            <table class="table table-condensed">
                                    <tr>
                        <th>
                            todo
                        </th>
                        <td>
                                                    </td>
                    </tr>
                            </table>
        </aside>
    </div>

                                    <div class="row-fluid">
        <div class="span8 content class">
            <a id="method_traiterMessage" name="method_traiterMessage" class="anchor"></a>
            <article class="method">
                <h3 class="private ">traiterMessage()</h3>
                <a href="#source-view" role="button" class="pull-right btn" data-toggle="modal" style="font-size: 1.1em; padding: 9px 14px"><i class="icon-code"></i></a>
                <pre class="signature" style="margin-right: 54px;">traiterMessage( <span class="argument">$message</span>,  <span class="argument">$tab_arguments</span>,  <span class="argument">$niveau</span>) : \void.</pre>
                <p><em>Retourne un message formaté en le stockant dans un fichier de log si nécessaire.</em></p>
                

                                    <h4>Parameters</h4>
                    <table class="table table-condensed table-hover">
                                                    <tr>
                                <td></td>
                                <td>$message</td>
                                <td></td>
                            </tr>
                                                    <tr>
                                <td></td>
                                <td>$tab_arguments</td>
                                <td></td>
                            </tr>
                                                    <tr>
                                <td></td>
                                <td>$niveau</td>
                                <td></td>
                            </tr>
                                            </table>
                
                
                                    <h4>Returns</h4>
                    \void.
                                                </article>
        </div>
        <aside class="span4 detailsbar">
            <h1><i class="icon-arrow-down"></i></h1>
                                                            <dl>
                                                                            </dl>
            <h2>Tags</h2>
            <table class="table table-condensed">
                                    <tr>
                        <th>
                            todo
                        </th>
                        <td>
                                                    </td>
                    </tr>
                            </table>
        </aside>
    </div>

                                    </div>
    </section>

    <div id="source-view" class="modal hide fade" tabindex="-1" role="dialog" aria-labelledby="source-view-label" aria-hidden="true">
        <div class="modal-header">
            <button type="button" class="close" data-dismiss="modal" aria-hidden="true">×</button>
            <h3 id="source-view-label">Script.php</h3>
        </div>
        <div class="modal-body">
            <pre data-src="../files/Script.php.txt" class="language-php line-numbers"></pre>
        </div>
    </div>

    <footer class="row-fluid">
        <section class="span10 offset2">
            <section class="row-fluid">
                <section class="span10 offset1">
                    <section class="row-fluid footer-sections">
                        <section class="span4">
                                                        <h1><i class="icon-code"></i></h1>
                            <div>
                                <ul>
                                                                    </ul>
                            </div>
                        </section>
                        <section class="span4">
                                                        <h1><i class="icon-bar-chart"></i></h1>
                            <div>
                                <ul>
                                    <li><a href="../graphs/class.html">Class Hierarchy Diagram</a></li>
                                </ul>
                            </div>
                        </section>
                        <section class="span4">
                                                        <h1><i class="icon-pushpin"></i></h1>
                            <div>
                                <ul>
                                    <li><a href="../reports/errors.html">Errors</a></li>
                                    <li><a href="../reports/markers.html">Markers</a></li>
                                </ul>
                            </div>
                        </section>
                    </section>
                </section>
            </section>
            <section class="row-fluid">
                <section class="span10 offset1">
                    <hr />
                    Documentation is powered by <a href="http://www.phpdoc.org/">phpDocumentor </a> and authored
                    on March 12th, 2014 at 15:57.
                </section>
            </section>
        </section>
    </footer>
</div>

</body>
</html>