File: Zend_Console_Getopt-Introduction.xml

package info (click to toggle)
zendframework 1.12.9%2Bdfsg-2
  • links: PTS, VCS
  • area: main
  • in suites: jessie-kfreebsd
  • size: 133,584 kB
  • sloc: xml: 1,311,829; php: 570,173; sh: 170; makefile: 125; sql: 121
file content (129 lines) | stat: -rw-r--r-- 6,220 bytes parent folder | download | duplicates (2)
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
<?xml version="1.0" encoding="UTF-8"?>
<!-- EN-Revision: 24249 -->
<!-- Reviewed: no -->
<sect1 id="zend.console.getopt.introduction">
    <title>Einführung</title>

    <para>
        Die <classname>Zend_Console_Getopt</classname> Klasse hilft Kommandozeilen Anwendungen
        Ihre Optionen und Argumente zu Analysieren.
    </para>

    <para>
        Benutzer können Kommandozeilen Argumente definieren wenn die Anwendung
        ausgeführt wird. Diese Argumente haben für die Anwendung die Bedeutung,
        das Verhalten in einem bestimmten Weg zu Ändern oder Ressourcen auszuwählen,
        oder Parameter zu definieren. Viele Optionen haben eine einheitliche Bedeutung
        entwickelt wie zum Beispiel <command>--verbose</command> welches die Ausgabe von
        zusätzlicher Ausgabe für viele Anwendungen erlaubt. Andere Optionen haben auch
        eine Bedeutung die in jeder Anwendung unterschiedlich ist. Zum Beispiel
        erlaubt <command>-c</command> unterschiedliche Features in <command>grep</command>,
        <command>ls</command>, und <command>tar</command>.
     </para>

    <para>
        Anbei sind einige Definitionen von Ausdrücken. Die übliche Verwendung der
        Ausdrücke variiert, aber diese Dokumentation wird die anbei beschriebenen
        Definitionen verwenden.
    </para>

    <itemizedlist>
        <listitem>
            <para>
                "Argument": eine Zeichenkette die in der Kommandozeile dem
                Namen des Kommandos folgt. Argumente können Optionen sein, oder auch
                ohne Option vorkommen, um eine Ressource zu benennen die das
                Kommando verwendet.
            </para>
        </listitem>

        <listitem>
            <para>
                "Option": ist ein Argument das andeutet dass das Kommando sein
                Verhalten in einem bestimmten Weg verändern soll.
            </para>
        </listitem>

        <listitem>
            <para>
                "Flag": Der erste Teil einer Option, identifiziert den Zweck
                der Option. Einem Flag werden normalerweise ein oder zwei Bindestriche
                vorangestellt (<command>-</command> oder <command>--</command>).
                Ein einzelner wird einem Einzel-Zeichen Flag vorangestellt oder einem
                Verbund von Einzel-Zeichen Flags. Ein doppelter Bindestrich wird einem
                Mehr-Zeichen Flag vorangestellt. Lange Flags können nicht gebündelt werden.
            </para>
        </listitem>

        <listitem>
            <para>
                "Parameter": Der zweite Teil einer Option; Ein Datenwert der ein Flag
                begleitet, wenn er zu einer Option passt. Zum Beispiel kann ein Kommando
                eine <command>--verbose</command> Option akzeptieren, aber typischerweise
                hat diese Option keine Parameter. Trotzdem wird eine Option wie
                <command>--user</command> immer einen nachfolgenden Parameter benötigen.
            </para>

            <para>
                Ein Parameter kann als separates Argument angegeben werden der einem
                Flag Argument folgt, oder als Teil der gleichen Zeichenkette des
                Arguments, getrennt vom Flag durch ein Gleichheitszeichen
                (<command>=</command>). Die zweite Form wird nur bei langen Flags
                unterstützt. Zum Beispiel, <command>-u username</command>,
                <command>--user username</command>, und <command>--user=username</command>
                sind Formen welche durch <classname>Zend_Console_Getopt</classname>
                unterstützt werden.
            </para>
        </listitem>

        <listitem>
            <para>
                "Verbund": Mehrere Einzel-Zeichen Flags kombiniert in einem
                einzelnen Argument als Zeichenkette und vorangestellt durch einen
                einzelnen Bindestrich. Zum Beispiel "<command>ls -1str</command>"
                benutzt einen Verbund von vier kurzen Flags. Dieses Kommando ist
                identisch mit "<command>ls -1 -s -t -r</command>". Nur
                Einzel-Zeichen Flags können kombiniert werden. Ein Verbund von
                langen Flags kann nicht erstellt werden.
            </para>
        </listitem>
    </itemizedlist>

    <para>
        Zum Beispiel <command>mysql --user=root mydatabase</command>.
        <command>mysql</command> ist ein <emphasis>Kommando</emphasis>,
        <command>--user=root</command> ist eine <emphasis>Option</emphasis>,
        <command>--user</command> ist ein <emphasis>Flag</emphasis>,
        <command>root</command> ist ein <emphasis>Parameter</emphasis> für diese Option
        und <command>mydatabase</command> ist ein Argument aber nicht eine Option laut
        unserer Definition.
    </para>

    <para>
        <classname>Zend_Console_Getopt</classname> bietet ein Interface um zu definieren welche
        Flags für die Anwendung gültig sind, das einen Fehler und Benutzungshinweise ausgibt
        wenn ein ungültiges Flag verwendet wird, und dem Code der Anwendung bekanntgibt
        welche Flags der Benutzer definiert hat.
    </para>

    <note>
        <title>Getopt ist kein Framework für eine Anwendung</title>

        <para>
            <classname>Zend_Console_Getopt</classname> kann <emphasis>nicht</emphasis>
            die Bedeutung der Flags und Parameter interpretieren, noch implementiert
            diese Klasse einen Anwendungsworkflow oder ruft Anwendungscode auf.
            Diese Aktionen müssen im eigenen Anwendungscode integriert werden.
            Die <classname>Zend_Console_Getopt</classname> Klasse kann dazu verwendet werden um
            die Kommandozeile zu analysieren und bietet Objekt-Orientierte Methoden
            für die Abfrage welche Optionen durch den Benutzer angegeben wurden.
            Aber der Code um diese Informationen zu Verwenden und Teile der eigenen
            Anwendung aufzurufen sollten in einer anderen <acronym>PHP</acronym> Klasse sein.
        </para>
    </note>

    <para>
        Die folgende Sektion beschreibt die Verwendung von
        <classname>Zend_Console_Getopt</classname>.
    </para>
</sect1>