Zend_Console_Getopt-Rules.xml 6.0 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142
  1. <?xml version="1.0" encoding="UTF-8"?>
  2. <!-- EN-Revision: 24249 -->
  3. <!-- Reviewed: no -->
  4. <sect1 id="zend.console.getopt.rules">
  5. <title>Definieren von Getopt Regeln</title>
  6. <para>
  7. Der Constructor für die <classname>Zend_Console_Getopt</classname> Klasse nimmt ein bis drei
  8. Argumente. Das erste Argument definiert welche Optionen durch die Anwendung unterstützt
  9. werden. Diese Klasse unterstützt alternative Syntaxformen für das definieren der Optionen.
  10. Die nächsten Sektionen geben Auskunft über das Format und die Verwendung dieser
  11. Syntaxformen.
  12. </para>
  13. <para>
  14. Der Constructor nimmt zwei weitere Argumente, welche optional sind. Das zweite Argument kann
  15. Kommandozeilen Argumente enthalten. Sein Standardwert ist
  16. <varname>$_SERVER['argv']</varname>.
  17. </para>
  18. <para>
  19. Das dritte Argument des Constructors kann Konfigurationsoptionen enthalten um das Verhalten
  20. von <classname>Zend_Console_Getopt</classname> anzupassen. Siehe <link
  21. linkend="zend.console.getopt.configuration.config">Konfiguration hinzufügen</link> für
  22. eine Referenz der möglichen Optionen.
  23. </para>
  24. <sect2 id="zend.console.getopt.rules.short">
  25. <title>Optionen mit der kurzen Syntax definieren</title>
  26. <para>
  27. <classname>Zend_Console_Getopt</classname> unterstützt eine kompakte Syntax wie Sie
  28. durch <acronym>GNU</acronym> Getopt verwendet wird (siehe <ulink
  29. url="http://www.gnu.org/software/libc/manual/html_node/Getopt.html">http://www.gnu.org/software/libc/manual/html_node/Getopt.html</ulink>).
  30. Diese Syntax unterstützt nur Einzel-Zeichen Flags. In einer einzelnen Zeichenkette, wird
  31. jeder Buchstabe angegeben der einem Flag entspricht das durch die Anwendung unterstützt
  32. wird. Der Buchstabe, gefolgt von einem Doppelpunkt Zeichen (<emphasis>:</emphasis>)
  33. zeigt ein Flag das einen Parameter benötigt.
  34. </para>
  35. <example id="zend.console.getopt.rules.short.example">
  36. <title>Verwendung der kurzen Syntax</title>
  37. <programlisting language="php"><![CDATA[
  38. $opts = new Zend_Console_Getopt('abp:');
  39. ]]></programlisting>
  40. </example>
  41. <para>
  42. Das obige Beispiel zeigt die Verwendung von <classname>Zend_Console_Getopt</classname>
  43. um die Optionen zu definieren die als <command>-a</command>, <command>-b</command>,
  44. oder <command>-p</command> angegeben werden können. Das letzte Flag benötigt
  45. einen Parameter.
  46. </para>
  47. <para>
  48. Die kurze Syntax ist limitiert auf Flags mit einzelnen Zeichen.
  49. Aliase, Parametertypen und Hilfszeichenketten werden in der
  50. kurzen Syntax nicht unterstützt.
  51. </para>
  52. </sect2>
  53. <sect2 id="zend.console.getopt.rules.long">
  54. <title>Optionen mit der langen Syntax definieren</title>
  55. <para>
  56. Eine andere Syntax mit mehr Möglichkeiten ist auch vorhanden. Diese
  57. Syntax ermöglicht es Aliase für Flags, Typen von Optionsparametern
  58. und auch Hilfszeichenkette zu definieren um die Verwendung für den
  59. Benutzer zu beschreiben. Statt einer einzelnen Zeichenkette die in der
  60. kurzen Syntax verwendet wird um die Optionen zu definieren, verwendet
  61. die lange Syntax ein assoziatives Array als erstes Argument für den
  62. Constructor.
  63. </para>
  64. <para>
  65. Der Schlüssel jeden Elements des assoziativen Array ist eine
  66. Zeichenkette mit einem Format dass das Flag benennt, mit jedem Alias,
  67. getrennt durch ein Pipe Symbol ("<emphasis>|</emphasis>"). Dieser Serie von
  68. Flag Aliasen folgende, wenn die Option einen Parameter benötigt, ist
  69. ein Gleichheitszeichen ("<emphasis>=</emphasis>") mit einem Buchstaben der
  70. für den <emphasis>Typ</emphasis> dieses Parameters steht:
  71. </para>
  72. <itemizedlist>
  73. <listitem>
  74. <para>
  75. "<emphasis>=s</emphasis>" für einen Zeichenketten Parameter
  76. </para>
  77. </listitem>
  78. <listitem>
  79. <para>
  80. "<emphasis>=w</emphasis>" für einen Wort Parameter
  81. (eine Zeichenkette die keine Leerzeichen enthält)
  82. </para>
  83. </listitem>
  84. <listitem>
  85. <para>
  86. "<emphasis>=i</emphasis>" für einen Integer Parameter
  87. </para>
  88. </listitem>
  89. </itemizedlist>
  90. <para>
  91. Wenn der Parameter optional ist, kann ein Bindestrich ("<emphasis>-</emphasis>")
  92. statt des Gleichheitszeichens verwendet werden.
  93. </para>
  94. <para>
  95. Der Wert jeden Elements in diesem assiziativen Array ist eine
  96. Hilfszeichenkette um dem Benutzer zu beschreiben wie das Programm
  97. verwendet werden kann.
  98. </para>
  99. <example id="zend.console.getopt.rules.long.example">
  100. <title>Verwendung der langen Syntax</title>
  101. <programlisting language="php"><![CDATA[
  102. $opts = new Zend_Console_Getopt(
  103. array(
  104. 'apfel|a' => 'Apfel Option, ohne Parameter',
  105. 'banane|b=i' => 'Bananen Option, mit benötigtem Integer Parameter',
  106. 'pfirsich|p-s' => 'Pfirsich Option, mit optionalem String Parameter'
  107. )
  108. );
  109. ]]></programlisting>
  110. </example>
  111. <para>
  112. In der obigen Beispieldefinition, sind drei Optionen.
  113. <command>--apfel</command> und <command>-a</command> sind Aliase füreinander,
  114. und diese Option nimmt keinen Parameter.
  115. <command>--banane</command> und <command>-b</command> sind Aliase füreinander,
  116. und diese Option nimmt einen notwendigen Integer Parameter.
  117. Letztendlich, <command>--pfirsich</command> und <command>-p</command> sind
  118. Aliase füreinander, und diese Option kann einen Optionalen
  119. Zeichenketten Parameter annehmen.
  120. </para>
  121. </sect2>
  122. </sect1>