1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335
|
<?xml version="1.0" encoding="UTF-8"?>
<!-- EN-Revision: 24249 -->
<!-- Reviewed: no -->
<sect2 id="zend.application.core-functionality.application">
<title>Zend_Application</title>
<para>
<classname>Zend_Application</classname> est la classe de base du composant
et le point d'entrée de votre application Zend Framework. Ses buts sont multiples :
configurer l'environnement <acronym>PHP</acronym> (incluant l'autoloading)
et exécuter le bootstrap de votre application.
</para>
<para>
Typiquement, vous allez passer toute la configuration au constructeur de
<classname>Zend_Application</classname>, mais vous pouvez aussi configurer l'objet
via ses méthodes. Ce chapitre illustrera les deux aspects.
</para>
<table id="zend.application.core-functionality.application.api.options">
<title>Zend_Application options</title>
<tgroup cols="2">
<thead>
<row>
<entry>Option</entry>
<entry>Description</entry>
</row>
</thead>
<tbody>
<row>
<entry><emphasis><property>phpSettings</property></emphasis></entry>
<entry><para>
Tableau de paramètres <filename>php.ini</filename> à utiliser.
Les clés doivent être des clés reconnues dans
<filename>php.ini</filename>.
</para></entry>
</row>
<row>
<entry><emphasis><property>includePaths</property></emphasis></entry>
<entry><para>
Chemins additionnels à ajouter à <emphasis>include_path</emphasis>.
Ces chemins sont ajoutés avant l'include_path.
L'option doit être un tableau de chemins.
</para></entry>
</row>
<row>
<entry><emphasis><property>autoloaderNamespaces</property></emphasis></entry>
<entry><para>
Tableau d'espaces de noms à enregistrer dans
<classname>Zend_Loader_Autoloader</classname>.
</para></entry>
</row>
<row>
<entry><emphasis><property>bootstrap</property></emphasis></entry>
<entry><para>
Soit une chaîne vers le fichier contenant la classe de bootstrap, soit un
tableau avec les clés 'path' et 'class' menant vers le bootstrap.
</para></entry>
</row>
</tbody>
</tgroup>
</table>
<note>
<title>Noms des options</title>
<para>
Notez que les noms des options ne sont pas sensibles à la casse.
</para>
</note>
<table id="zend.application.core-functionality.application.api.table">
<title>Méthodes dans Zend_Application</title>
<tgroup cols="4">
<thead>
<row>
<entry>Méthode</entry>
<entry>Valeur de retour</entry>
<entry>Paramètres</entry>
<entry>Description</entry>
</row>
</thead>
<tbody>
<row>
<entry>
<methodname>__construct($environment, $options = null)</methodname>
</entry>
<entry><type>Void</type></entry>
<entry><itemizedlist>
<listitem><para>
<varname>$environment</varname> : <emphasis>requis</emphasis>,
Chaîne représentant l'environnement actuel dans lequel tourne
l'application. Par exemple "development", "testing", "qa", ou
"production". Les significations de ces chaînes sont à définir
par la suite.
</para></listitem>
<listitem>
<para>
<varname>$options</varname> : <emphasis>optionnel</emphasis>.
</para>
<itemizedlist>
<listitem>
<para>
<emphasis><type>String</type></emphasis> : chemin vers
un fichier <classname>Zend_Config</classname> à charger pour
la configuration de votre application.
<varname>$environment</varname> sera utilisé pour déterminer
la section de configuration à charger depuis le fichier.
</para>
<para>
A partir de la version 1.10, vous pouvez fournir de
multiples chemins contenant des fichiers de configuration
qui seront fusionnés en une seule configuration. Ceci
permet de diminuer les duplications de configuration suivant
les contextes en permettant le partage des réglages communs
(par ex., avec les configurations <acronym>HTTP</acronym>,
ou <acronym>CLI</acronym>, chacune partageant quelques
caractéristiques alors que d'autres entrent en conflit)
ou tout simplement pour découper de longs fichiers de
configuration en plus petits fichiers par catégorie.
Le paramètre dans ce cas est un tableau avec une clé unique
"config", dont la valeur est un tableau des fichiers à
fusionner. Note : ceci veut dire que vous pouvez fournir
un chemin littéral ou
<command>array("config"=>array("/path1","/path2"[,...]));</command>.
</para>
</listitem>
<listitem><para>
<emphasis><type>Array</type></emphasis> : tableau
associatif de données de configuration pour votre application.
</para></listitem>
<listitem><para>
<emphasis><classname>Zend_Config</classname></emphasis> :
un instance d'objet de configuration.
</para></listitem>
</itemizedlist>
</listitem>
</itemizedlist></entry>
<entry><para>
Une instance de <classname>Zend_Loader_Autoloader</classname> est
enregistrée lors de l'instanciation. Les options passées au
constructeur sont passées à <methodname>setOptions()</methodname>.
</para></entry>
</row>
<row>
<entry><methodname>getEnvironment()</methodname></entry>
<entry><type>String</type></entry>
<entry>N/A</entry>
<entry><para>
Récupère l'environnement passé au constructeur.
</para></entry>
</row>
<row>
<entry><methodname>getAutoloader()</methodname></entry>
<entry><classname>Zend_Loader_Autoloader</classname></entry>
<entry>N/A</entry>
<entry><para>
Récupère l'objet <classname>Zend_Loader_Autoloader</classname>
enregistré lors de l'instanciation.
</para></entry>
</row>
<row>
<entry><methodname>setOptions(array $options)</methodname></entry>
<entry><classname>Zend_Application</classname></entry>
<entry><itemizedlist>
<listitem><para>
<varname>$options</varname> : <emphasis>requis</emphasis>.
Un tableau d'options pour l'application.
</para></listitem>
</itemizedlist></entry>
<entry><para>
Toutes les options sont stockées en interne, et appeler plusieurs fois
la même méthode fusionnera les options qu'elle définit. Les options qui
correspondent aux diverses méthodes setter seront passées à ces méthodes.
Par exemple, l'option "phpSettings" sera passée à
<methodname>setPhpSettings()</methodname>.
</para></entry>
</row>
<row>
<entry><methodname>getOptions()</methodname></entry>
<entry><type>Array</type></entry>
<entry>N/A</entry>
<entry><para>
Récupère toutes les options utilisées pour initialiser l'objet.
Pourrait être utilisé pour mettre en cache les options
<classname>Zend_Config</classname> entre chaque requête, par exemple.
</para></entry>
</row>
<row>
<entry><methodname>hasOption($key)</methodname></entry>
<entry><type>Boolean</type></entry>
<entry>
<itemizedlist>
<listitem><para>
<varname>$key</varname> : La clé de l'option à chercher
</para></listitem>
</itemizedlist>
</entry>
<entry><para>
Indique si une option correspondant à une clé précise a été utilisée
ou pas. Les clés sont insensibles à la casse.
</para></entry>
</row>
<row>
<entry><methodname>getOption($key)</methodname></entry>
<entry>
<type>Mixed</type>
</entry>
<entry><itemizedlist>
<listitem><para>
<varname>$key</varname> : La clé de l'option à récupérer
</para></listitem>
</itemizedlist></entry>
<entry><para>
Récupère l'option correspondant à la clé passée, <constant>NULL</constant>
si celle-ci n'existe pas.
</para></entry>
</row>
<row>
<entry>
<methodname>setPhpSettings(array $settings, $prefix = '')</methodname>
</entry>
<entry><classname>Zend_Application</classname></entry>
<entry><itemizedlist>
<listitem><para>
<varname>$settings</varname> : <emphasis>requis</emphasis>.
Tableau associatif de paramètres <acronym>PHP</acronym>
<acronym>INI</acronym>
</para></listitem>
<listitem><para>
<varname>$prefix</varname> : <emphasis>optionnel</emphasis>.
Préfixe pour construire la chaîne des clés d'options.
Utilisée en interne pour faire correspondre les clés
<filename>php.ini</filename> séparés par des points (".") avec des
tableaux à plusieurs niveaux. En temps normal, cet argument
ne devrait jamais être utilisé par l'utilisateur.
</para></listitem>
</itemizedlist></entry>
<entry><para>
Affecte à la volée des paramètres de <filename>php.ini</filename>.
Les paramètres séparés par des points peuvent être imbriqués
hiérarchiquement (comme dans le cas des paramètres
<acronym>INI</acronym> de <classname>Zend_Config</classname>).
</para></entry>
</row>
<row>
<entry>
<methodname>setAutoloaderNamespaces(array $namespaces)</methodname>
</entry>
<entry><classname>Zend_Application</classname></entry>
<entry><itemizedlist>
<listitem><para>
<varname>$namespaces</varname> : <emphasis>requis</emphasis>.
Tableau de chaînes représentant les espaces de noms à enregistrer dans
<classname>Zend_Loader_Autoloader</classname>.
</para></listitem>
</itemizedlist></entry>
<entry><para>
Enregistre des espaces de noms dans
<classname>Zend_Loader_Autoloader</classname>.
</para></entry>
</row>
<row>
<entry><methodname>setBootstrap($path, $class = null)</methodname></entry>
<entry><classname>Zend_Application</classname></entry>
<entry><itemizedlist>
<listitem><para>
<varname>$path</varname> : <emphasis>requis</emphasis>. Peut
être soit un objet de
<classname>Zend_Application_Bootstrap_Bootstrapper</classname>,
soit une chaîne représentant le chemin vers la classe de bootstrap,
soit un tableau associatif nom de classe => chemin de fichier,
ou encore un tableau associatif avec les clés "class" et "path".
</para></listitem>
<listitem><para>
<varname>$class</varname> : <emphasis>optionnel</emphasis>.
Si <varname>$path</varname> est une chaîne, <varname>$class</varname>
doit être indiqué et doit être une chaîne représentant le nom d'une
classe contenue dans le fichier représenté par le chemin.
</para></listitem>
</itemizedlist></entry>
</row>
<row>
<entry><methodname>getBootstrap()</methodname></entry>
<entry>
<constant>NULL</constant> |
<classname>Zend_Application_Bootstrap_Bootstrapper</classname>
</entry>
<entry>N/A</entry>
<entry><para>
Récupère l'instance du bootstrap enregistrée.
</para></entry>
</row>
<row>
<entry><methodname>bootstrap()</methodname></entry>
<entry><type>Void</type></entry>
<entry>N/A</entry>
<entry><para>
Appelle la méthode <methodname>bootstrap()</methodname> du bootstrap pour
lancer l'application.
</para></entry>
</row>
<row>
<entry><methodname>run()</methodname></entry>
<entry><type>Void</type></entry>
<entry>N/A</entry>
<entry><para>
Appelle la méthode <methodname>run()</methodname> du bootstrap pour
lancer le dispatch de l'application.
</para></entry>
</row>
</tbody>
</tgroup>
</table>
</sect2>
|