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 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491
|
<?xml version="1.0" encoding="UTF-8"?>
<!-- EN-Revision: 24249 -->
<!-- Reviewed: no -->
<sect1 id="zend.reflection.reference">
<title>Zend_Reflection Referenz</title>
<para>
Die verschiedenen Klassen in <classname>Zend_Reflection</classname> mimen die
<acronym>API</acronym> von <acronym>PHP</acronym>'s <ulink
url="http://php.net/reflection">Reflection <acronym>API</acronym></ulink> - mit einem
wichtigen Unterschied. <acronym>PHP</acronym>'s Reflection <acronym>API</acronym>
unterstützt die Introspection in die Annotation Tags von DocBlocks nicht, und auch nicht in
die Variablen-Typen von Parametern, oder die Rückgabe-Typen.
</para>
<para>
<classname>Zend_Reflection</classname> analysiert die DocBlock Anotations von Methoden um
die Variablen-Typen und Rückgabe-Typen von Parametern zu Erkennen. Speziell die Annotations
von <code>@param</code> und <code>@return</code> werden verwendet. Trotzdem kann man auch
auf andere Annotation Tags prüfen, sowie die Standardmäßigen "Kurz"- (short) und
"Lang" (long) Beschreibungen.
</para>
<para>
Jedes Reflection Objekt in <classname>Zend_Reflection</classname> überschreibt die
<methodname>getDocblock()</methodname> Methode um eine Instanz von
<classname>Zend_Reflection_Docblock</classname> zurückzugeben. Die Klasse bietet
Introspektion in die DocBlocks und Annotation Tags.
</para>
<para>
<classname>Zend_Reflection_File</classname> ist eine neue Reflection Klasse welche die
Introspektion von <acronym>PHP</acronym> Dateien erlaubt. Mit Ihr kann man die Klassen,
Funktionen und globalen <acronym>PHP</acronym> Code erhalten der in der Datei enthalten ist.
</para>
<para>
Letztendlich erlauben die verschiedenen Methoden, die andere Reflection Objekte
zurückgeben, einen zweiten Parameter: Den Namen der Reflection Klasse die für das
zurückzugebende Reflection Objekt zu verwenden ist.
</para>
<sect2 id="zend.reflection.reference.docblock">
<title>Zend_Reflection_Docblock</title>
<para>
<classname>Zend_Reflection_Docblock</classname> ist das Herz von
<classname>Zend_Reflection_Docblock</classname> Bonus über <acronym>PHP</acronym>'s
Reflection <acronym>API</acronym>. Es bietet die folgenden Methoden:
</para>
<itemizedlist>
<listitem>
<para>
<methodname>getContents()</methodname>: Gibt den kompletten Inhalt des DocBlocks
zurück.
</para>
</listitem>
<listitem>
<para>
<methodname>getStartLine()</methodname>: Gibt die Startposition des DocBlocks in
der definierten Datei zurück.
</para>
</listitem>
<listitem>
<para>
<methodname>getEndLine()</methodname>: Gibt die letzte Zeile des DocBlocks in
der definierten Datei zurück.
</para>
</listitem>
<listitem>
<para>
<methodname>getShortDescription()</methodname>: Gibt die kurze, ein-zeilige
Beschreibung zurück (normalerweise die erste Zeile des DocBlocks).
</para>
</listitem>
<listitem>
<para>
<methodname>getLongDescription()</methodname>: Gibt die lange Beschreibung des
DocBlocks zurück.
</para>
</listitem>
<listitem>
<para>
<methodname>hasTag($name)</methodname>: Erkennt ob der DocBlock das angegebene
Annotation Tag besitzt.
</para>
</listitem>
<listitem>
<para>
<methodname>getTag($name)</methodname>: Empfängt das Reflection Objekt des
angegebenen Annotation Tags, oder ein boolsches <constant>FALSE</constant> wenn
es nicht vorhanden ist.
</para>
</listitem>
<listitem>
<para>
<methodname>getTags($filter)</methodname>: Gibt alle Tags zurück, oder alle Tags
die dem angegebenen <varname>$filter</varname> String entsprechen. Die
zurückgegebenen Tags werden ein Array von
<code>Zend_Reflection_Docblock_Tag</code> Objekten sein.
</para>
</listitem>
</itemizedlist>
</sect2>
<sect2 id="zend.reflection.reference.docblock-tag">
<title>Zend_Reflection_Docblock_Tag</title>
<para>
<classname>Zend_Reflection_Docblock_Tag</classname> bietet Reflection für individuelle
Annotation Tags. Die meisten Tags bestehen nur aus einem Namen und einer Beschreibung.
Im Fall einiger spezieller Tags, bietet die Klasse eine Factory Methode um eine
Instanz der entsprechenden Klasse zu erhalten.
</para>
<para>
Die folgenden Methoden sind für <classname>Zend_Reflection_Docblock_Tag</classname>
definiert:
</para>
<itemizedlist>
<listitem>
<para>
<methodname>factory($tagDocblockLine)</methodname>: Instanziert die
entsprechende Reflection Klasse des Tags und gibt diese zurück.
</para>
</listitem>
<listitem>
<para>
<methodname>getName()</methodname>: Gibt den Namen des Annotation Tags zurück.
</para>
</listitem>
<listitem>
<para>
<methodname>getDescription()</methodname>: Gibt die Beschreibung des Annotation
Tags zurück.
</para>
</listitem>
</itemizedlist>
</sect2>
<sect2 id="zend.reflection.reference.docblock-tag-param">
<title>Zend_Reflection_Docblock_Tag_Param</title>
<para>
<classname>Zend_Reflection_Docblock_Tag_Param</classname> ist eine spezialisierte
Version von <classname>Zend_Reflection_Docblock_Tag</classname>. Die Beschreibung des
<code>@param</code> Annotation Tags besteht aus dem Typ des Parameters, dem Namen der
Variable und der Beschreibung der Variable. Sie fügt die folgenden Methoden zu
<classname>Zend_Reflection_Docblock_Tag</classname> hinzu:
</para>
<itemizedlist>
<listitem>
<para>
<methodname>getType()</methodname>: Gibt den Variablentyp des Parameters zurück.
</para>
</listitem>
<listitem>
<para>
<methodname>getVariableName()</methodname>: Gibt den Variablennamen des
Parameters zurück.
</para>
</listitem>
</itemizedlist>
</sect2>
<sect2 id="zend.reflection.reference.docblock-tag-return">
<title>Zend_Reflection_Docblock_Tag_Return</title>
<para>
Wie <classname>Zend_Reflection_Docblock_Tag_Param</classname> ist
<classname>Zend_Reflection_Docblock_Tag_Return</classname> eine spezialisierte Version
von <classname>Zend_Reflection_Docblock_Tag</classname>. Die Beschreibung des
<code>@return</code> Annotation Tags besteht aus dem Rückgabetyp und der Beschreibung
der Variable. Sie fügt die folgende Methode zu
<code>Zend_Reflection_Docblock_Tag</code> hinzu:
</para>
<itemizedlist>
<listitem>
<para><methodname>getType()</methodname>: gibt den Rückgabetyp zurück.</para>
</listitem>
</itemizedlist>
</sect2>
<sect2 id="zend.reflection.reference.file">
<title>Zend_Reflection_File</title>
<para>
<classname>Zend_Reflection_File</classname> bietet Introspection in
<acronym>PHP</acronym> Dateien. Mit Ihr kann man Klassen, Funktionen und reinen
<acronym>PHP</acronym> Code der in einer Datei definiert ist, betrachten. Sie definiert
die folgenden Methoden:
</para>
<itemizedlist>
<listitem>
<para>
<methodname>getFileName()</methodname>: empfängt den Dateinamen der Datei die
reflektiert wird.
</para>
</listitem>
<listitem>
<para>
<methodname>getStartLine()</methodname>: empfängt den Startwert der Datei (Immer
"1").
</para>
</listitem>
<listitem>
<para>
<methodname>getEndLine()</methodname>: empfängt die letzte Teile / Anzahl der
Linien in der Datei.
</para>
</listitem>
<listitem>
<para>
<methodname>getDocComment($reflectionClass =
'Zend_Reflection_Docblock')</methodname>: empfängt das Reflection Objekt des
Datei-Level DocBlocks.
</para>
</listitem>
<listitem>
<para>
<methodname>getClasses($reflectionClass = 'Zend_Reflection_Class')</methodname>:
empfängt ein Array von Reflection Objekten, eines für jede Klasse die in der
Datei definiert ist.
</para>
</listitem>
<listitem>
<para>
<methodname>getFunctions($reflectionClass =
'Zend_Reflection_Function')</methodname>: empfängt ein Array von Reflection
Objekten, eines für jede Funktion die in der Datei definiert ist.
</para>
</listitem>
<listitem>
<para>
<methodname>getClass($name = null, $reflectionClass =
'Zend_Reflection_Class')</methodname>: empfängt das Reflection Objekt für
eine einzelne Klasse.
</para>
</listitem>
<listitem>
<para>
<methodname>getContents()</methodname>: empfängt den kompletten Inhalt der
Datei.
</para>
</listitem>
</itemizedlist>
</sect2>
<sect2 id="zend.reflection.reference.class">
<title>Zend_Reflection_Class</title>
<para>
<classname>Zend_Reflection_Class</classname> erweitert <code>ReflectionClass</code> und
folgt dessen <acronym>API</acronym>. Sie fügt eine zusätzliche,
<methodname>getDeclaringFile()</methodname>, Methode hinzu, welche verwendet werden kann
um das <classname>Zend_Reflection_File</classname> Reflection Objekt für die definierte
Datei zu erhalten.
</para>
<para>
Zusätzlich fügen die folgenden Methoden ein zusätzliches Argument für die Spezifikation
der Reflection Klasse hinzu, die zu verwenden ist wenn ein Reflection Objekt geholt
wird.
</para>
<itemizedlist>
<listitem>
<para>
<methodname>getDeclaringFile($reflectionClass =
'Zend_Reflection_File')</methodname>
</para>
</listitem>
<listitem>
<para>
<methodname>getDocblock($reflectionClass =
'Zend_Reflection_Docblock')</methodname>
</para>
</listitem>
<listitem>
<para>
<methodname>getInterfaces($reflectionClass =
'Zend_Reflection_Class')</methodname>
</para>
</listitem>
<listitem>
<para>
<methodname>getMethod($reflectionClass = 'Zend_Reflection_Method')</methodname>
</para>
</listitem>
<listitem>
<para>
<methodname>getMethods($filter = -1, $reflectionClass =
'Zend_Reflection_Method')</methodname>
</para>
</listitem>
<listitem>
<para>
<methodname>getParentClass($reflectionClass =
'Zend_Reflection_Class')</methodname>
</para>
</listitem>
<listitem>
<para>
<code>getProperty($name, $reflectionClass = 'Zend_Reflection_Property')</code>
</para>
</listitem>
<listitem>
<para>
<code>getProperties($filter = -1, $reflectionClass =
'Zend_Reflection_Property')</code>
</para>
</listitem>
</itemizedlist>
</sect2>
<sect2 id="zend.reflection.reference.extension">
<title>Zend_Reflection_Extension</title>
<para>
<classname>Zend_Reflection_Extension</classname> erweitert
<code>ReflectionExtension</code> und folgt dessen <acronym>API</acronym>. Sie
überschreibt die folgenden Methoden und fügt ein zusätzliches Argument hinzu, für die
Spezifikation der Reflection Klasse, die zu verwenden ist wenn ein Reflection Objekt
geholt wird:
</para>
<itemizedlist>
<listitem>
<para>
<methodname>getFunctions($reflectionClass =
'Zend_Reflection_Function')</methodname>: empfängt ein Array von Reflection
Objekten welche die Funktionen repräsentieren die von der Erweiterung definiert
werden.
</para>
</listitem>
<listitem>
<para>
<methodname>getClasses($reflectionClass = 'Zend_Reflection_Class')</methodname>:
empfängt ein Array von Reflection Objekten welche die Klassen repräsentieren die
von der Erweiterung definiert werden.
</para>
</listitem>
</itemizedlist>
</sect2>
<sect2 id="zend.reflection.reference.function">
<title>Zend_Reflection_Function</title>
<para>
<classname>Zend_Reflection_Function</classname> fügt eine Methode für das Empfangen des
Rückgabewerts der Funktion hinzu, und überschreibt diverse Methoden um die
Spezifikation der Reflection Klasse zu erlauben, die für zurückgegebene Reflection
Objekte zu verwenden ist.
</para>
<itemizedlist>
<listitem>
<para>
<methodname>getDocblock($reflectionClass =
'Zend_Reflection_Docblock')</methodname>: empfängt das Reflection Objekt des
Funktions DocBlocks.
</para>
</listitem>
<listitem>
<para>
<methodname>getParameters($reflectionClass =
'Zend_Reflection_Parameter')</methodname>: empfängt ein Array aller
Reflection Objekte für die Parameter der Funktionen.
</para>
</listitem>
<listitem>
<para>
<methodname>getReturn()</methodname>: empfängt das Reflection Objekt des
Rückgabewerts.
</para>
</listitem>
</itemizedlist>
</sect2>
<sect2 id="zend.reflection.reference.method">
<title>Zend_Reflection_Method</title>
<para>
<classname>Zend_Reflection_Method</classname> spiegelt
<classname>Zend_Reflection_Function</classname> und überschreibt nur eine zusätzliche
Methode:
</para>
<itemizedlist>
<listitem>
<para>
<methodname>getParentClass($reflectionClass =
'Zend_Reflection_Class')</methodname>: empfängt das Reflection Objekt der
Eltern-Klasse.
</para>
</listitem>
</itemizedlist>
</sect2>
<sect2 id="zend.reflection.reference.parameter">
<title>Zend_Reflection_Parameter</title>
<para>
<classname>Zend_Reflection_Parameter</classname> fügt eine Methode für das Empfangen
des Parametertyps hinzu, und überschreibt Methoden um die Spezifikation der Reflection
Klasse zu erlauben, die für zurückgegebene Reflection Objekte zu verwenden ist.
</para>
<itemizedlist>
<listitem>
<para>
<methodname>getDeclaringClass($reflectionClass =
'Zend_Reflection_Class')</methodname>: gibt die deklarierte Klasse des
Parameters als Reflection Objekt zurück (wenn vorhanden).
</para>
</listitem>
<listitem>
<para>
<methodname>getClass($reflectionClass = 'Zend_Reflection_Class')</methodname>:
gibt die Klasse des Parameters als Reflection Objekt zurück (wenn vorhanden).
</para>
</listitem>
<listitem>
<para>
<methodname>getDeclaringFunction($reflectionClass =
'Zend_Reflection_Function')</methodname>: gibt die Funktion des Parameters
als Reflection Objekt zurück (wenn vorhanden).
</para>
</listitem>
<listitem>
<para>
<methodname>getType()</methodname>: gibt den Typ des Parameters zurück.
</para>
</listitem>
</itemizedlist>
</sect2>
<sect2 id="zend.reflection.reference.property">
<title>Zend_Reflection_Property</title>
<para>
<classname>Zend_Reflection_Property</classname> überschreibt eine einzelne Methode um
die Spezifikation der zurückgegebenen Reflection Objekt Klasse zu spezifizieren:
</para>
<itemizedlist>
<listitem>
<para>
<methodname>getDeclaringClass($reflectionClass =
'Zend_Reflection_Class')</methodname>: empfängt die deklarierte Klasse der
Eigenschaft als Reflection Objekt.
</para>
</listitem>
</itemizedlist>
</sect2>
</sect1>
|