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 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440
|
<?xml version="1.0" encoding="UTF-8"?>
<!-- EN-Revision: 21357 -->
<!-- Reviewed: no -->
<sect2 id="zend.application.core-functionality.application">
<title>Zend_Application</title>
<para>
<classname>Zend_Application</classname> bietet die Basisfunktionalität der Komponente, und
ist der Eintrittspunkt zur eigenen Zend Framework Anwendung. Sein Zweck ist zweigeteilt: das
Setup der <acronym>PHP</acronym> Umgebung (inklusive Autoloading), und das
Anwendungs-Bootstrap auszuführen.
</para>
<para>
Typischerweise, wird man die komplette Konfiguration an den
<classname>Zend_Application</classname> Konstruktor übergeben, aber man kann das Objekt auch
komplett konfigurieren indem dessen eigene Methoden verwendet werden. Diese Referenz dient
dazu beide Fälle zu zeigen.
</para>
<table id="zend.application.core-functionality.application.api.options">
<title>Optionen für Zend_Application</title>
<tgroup cols="2">
<thead>
<row>
<entry>Option</entry>
<entry>Beschreibung</entry>
</row>
</thead>
<tbody>
<row>
<entry><emphasis><property>phpSettings</property></emphasis></entry>
<entry>
<para>
Array von <filename>php.ini</filename> Einstellungen die zu verwenden
sind. Die Schlüssel sollten die <filename>php.ini</filename> Schlüssel
sein.
</para>
</entry>
</row>
<row>
<entry><emphasis><property>includePaths</property></emphasis></entry>
<entry>
<para>
Zusätzliche Pfade die dem <emphasis>include_path</emphasis>
vorangestellt werden. Sollte ein Array von Pfaden sein.
</para>
</entry>
</row>
<row>
<entry><emphasis><property>autoloaderNamespaces</property></emphasis></entry>
<entry>
<para>
Array von zusätzlichen Namespaces die bei der
<classname>Zend_Loader_Autoloader</classname> Instanz zu registrieren
sind.
</para>
</entry>
</row>
<row>
<entry><emphasis><property>bootstrap</property></emphasis></entry>
<entry>
<para>
Entweder der String mit dem Pfad zur Bootstrap Klasse, oder ein Array
mit Elementen für 'path' und 'class' für den Bootstrap der Anwendung.
</para>
</entry>
</row>
</tbody>
</tgroup>
</table>
<note>
<title>Namen der Optionen</title>
<para>
Beachten Sie das die Namen für die Optionen von der Groß- und Kleinschreibung abhängen.
</para>
</note>
<table id="zend.application.core-functionality.application.api.table">
<title>Zend_Application Methoden</title>
<tgroup cols="4">
<thead>
<row>
<entry>Methode</entry>
<entry>Rückgabewert</entry>
<entry>Parameter</entry>
<entry>Beschreibung</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>Benötigt</emphasis>.
String Repräsentation der aktuellen Anwendungsumgebung.
Typischerweise kann ein String "development", "testing", "qa"
oder "production" enthalten, wird aber von den eigenen
organisatorischen Notwendigkeiten bestimmt.
</para>
</listitem>
<listitem>
<para>
<varname>$options</varname>: <emphasis>Optional</emphasis>.
Das Argument kann einen der folgenden Werte haben:
</para>
<itemizedlist>
<listitem>
<para>
<emphasis><type>String</type></emphasis>: Pfad zu einer
<classname>Zend_Config</classname> Datei für die eigene
Anwendung. <varname>$environment</varname> wird
verwendet um zu erkennen welche Sektion der
Konfiguration geholt werden soll.
</para>
<para>
Ab 1.10 kann man auch mehrere Pfade übergeben übergeben
welche Konfigurationsdateien enthalten die in eine
einzelne Konfiguration zusammengefügt werden sollen. Das
Hilft bei der Reduzierung von doppelten Konfigurationen
über mehrere Kontexte welche die gleichen gemeinsamen
Einstellungen teilen (z.B. Konfiguration für
<acronym>HTTP</acronym>, oder <acronym>CLI</acronym>,
welche alle einige Charakteristiken teilen aber mit
deren eigenen wiedersprüchlichen Werten für andere)
oder indem eine lange Konfiguration in viele kleinere
kategorisierte Dateien geteilt wird. Der Parameter ist
in diesem Fall ein Array mit einem einzelnen Schlüssel
"configs" dessen Wert ein Array von Dateien ist welche
zusammengefügt werden. Beachte: Dies bedeutet das man
entweder einen literalen Pfad übergibt, oder
<command>array("configs"=>array("/path1","/path2"[,...]));</command>.
</para>
</listitem>
<listitem>
<para>
<emphasis><type>Array</type></emphasis>: Assoziatives
Array von Konfigurationsdaten für die eigene Anwendung.
</para>
</listitem>
<listitem>
<para>
<emphasis><classname>Zend_Config</classname></emphasis>:
Objekt Instanz der Konfiguration.
</para>
</listitem>
</itemizedlist>
</listitem>
</itemizedlist>
</entry>
<entry>
<para>
Konstruktor. Die Argumente sind wie beschrieben, und werden verwendet
um den initialen Objektstatus zu setzen. Eine Instanz von
<classname>Zend_Loader_Autoloader</classname> wird während der
Instanziierung registriert. Optionen die an den Konstruktor übergeben
werden, werden an <methodname>setOptions()</methodname> weitergeleitet.
</para>
</entry>
</row>
<row>
<entry><methodname>getEnvironment()</methodname></entry>
<entry><type>String</type></entry>
<entry>N/A</entry>
<entry>
<para>
Empfangen des Umgebungsstrings der an den Konstruktor übergeben wurde.
</para>
</entry>
</row>
<row>
<entry><methodname>getAutoloader()</methodname></entry>
<entry><classname>Zend_Loader_Autoloader</classname></entry>
<entry>N/A</entry>
<entry>
<para>
Empfangen der <classname>Zend_Loader_Autoloader</classname> Instanz die
während der Instanziierung registriert wurde.
</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>Benötigt</emphasis>.
Ein Array von Anweundungsoptionen.
</para>
</listitem>
</itemizedlist>
</entry>
<entry>
<para>
Alle Optionen werden intern gespeichert, und der mehrfache Aufruf der
Methode wird Optionen zusammenfügen. Optionen die zu den verschiedenen
Setter Methoden passen werden an diese Methoden übergeben. Als Beispiel
wird die Option "phpSettings" dann an
<methodname>setPhpSettings()</methodname> übergeben. (Optionsnamen sind
abhängig von der Groß- und Kleinschreibung.
</para>
</entry>
</row>
<row>
<entry><methodname>getOptions()</methodname></entry>
<entry><type>Array</type></entry>
<entry>N/A</entry>
<entry>
<para>
Empfängt alle Optionen die verwendet wurden um das Objekt zu
initialisieren; könnte verwendet werden um
<classname>Zend_Config</classname> Optionen zwischen Anfragen in ein
serialisierbares Format zu cachen.
</para>
</entry>
</row>
<row>
<entry><methodname>hasOption($key)</methodname></entry>
<entry><type>Boolean</type></entry>
<entry>
<itemizedlist>
<listitem>
<para>
<varname>$key</varname>: String des Optionsschlüssels der
gesucht wird.
</para>
</listitem>
</itemizedlist>
</entry>
<entry>
<para>
Erkennt ob eine Option mit dem spezifizierten Schlüssel registriert
wurde oder nicht. Schlüssel sind unabhängig von der Groß- oder
Kleinschreibung.
</para>
</entry>
</row>
<row>
<entry><methodname>getOption($key)</methodname></entry>
<entry><type>Mixed</type></entry>
<entry>
<itemizedlist>
<listitem>
<para>
<varname>$key</varname>: String des Optionsschlüssels der
gesucht wird.
</para>
</listitem>
</itemizedlist>
</entry>
<entry>
<para>
Empfängt den Optionswert eines angegebenen Schlüssels. Gibt
<constant>NULL</constant> zurück wenn der Schlüssel nicht existiert.
</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>Benötigt</emphasis>.
Assoziatives Array von <acronym>PHP</acronym>
<acronym>INI</acronym> Einstellungen.
</para>
</listitem>
<listitem>
<para>
<varname>$prefix</varname>: <emphasis>Optional</emphasis>.
String Präfix der Optionsschlüssel vorangestellt werden soll.
Wird intern verwendet um das Mapping von verschachtelten Array
zu Punkt-getrennten <filename>php.ini</filename> Schlüssels zu
erlauben. Bei normaler Verwendung sollte dieses Argument nie von
einem Benutzer übergeben werden.
</para>
</listitem>
</itemizedlist>
</entry>
<entry>
<para>
Setzt Laufzeit <filename>php.ini</filename> Einstellungen.
Punkt-getrennte Einstellungen können hierarchisch verschachtelt sein
(welche in <classname>Zend_Config</classname> <acronym>INI</acronym>
Dateien auftreten können) über ein Array-von-Arrays, und wird trotzdem
korrekt aufgelöst.
</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>Benötigt</emphasis>.
Array von Strings die den Namespace repräsentieren der mit der
<classname>Zend_Loader_Autoloader</classname> Instanz
registriert wird.
</para>
</listitem>
</itemizedlist>
</entry>
<entry>
<para>
Registriert den Namespace mit der
<classname>Zend_Loader_Autoloader</classname> Instanz.
</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>Benötigt</emphasis>.
Kann entweder eine Instanz von
<classname>Zend_Application_Bootstrap_Bootstrapper</classname>,
ein String Pfad zur Bootstrap Klasse, ein assoziatives Array von
Klassenname => Dateiname, oder ein assoziatives Array mit den
Schlüsseln 'class' und 'path' sein.
</para>
</listitem>
<listitem>
<para>
<varname>$class</varname>: <emphasis>Optional</emphasis>. Wenn
<varname>$path</varname> ein String ist, kann
<varname>$class</varname> spezifiziert werden, und sollte ein
String des Klassennamens der Klasse sein die in der Datei
enthalten ist die den Pfad repräsentiert.
</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>Empfängt die registrierte Bootstrap Instanz.</para></entry>
</row>
<row>
<entry><methodname>bootstrap()</methodname></entry>
<entry><type>Void</type></entry>
<entry>N/A</entry>
<entry>
<para>
Ruft die <methodname>bootstrap()</methodname> Methode des Bootstraps auf
um die Anwendung zu bootstrappen.
</para>
</entry>
</row>
<row>
<entry><methodname>run()</methodname></entry>
<entry><type>Void</type></entry>
<entry>N/A</entry>
<entry>
<para>
Ruft die <methodname>run()</methodname> Methode des Bootstraps auf um
die Anwendung auszuführen.
</para>
</entry>
</row>
</tbody>
</tgroup>
</table>
</sect2>
|