File: Zend_ProgressBar_Adapter_Console.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 (120 lines) | stat: -rw-r--r-- 4,384 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
<?xml version="1.0" encoding="UTF-8"?>
<!-- EN-Revision: 24249 -->
<!-- Reviewed: no -->
<sect3 id="zend.progressbar.adapter.console">
    <title>Zend_ProgressBar_Adapter_Console</title>

    <para>
        <classname>Zend_ProgressBar_Adapter_Console</classname> to adapter tekstowy przeznaczony
        do użytku z terminalem (konsolą, wierszem polecenia). Adapter potrafi automatycznie wykryć
        dostępną szerokość ale można również podać ją ręcznie. Oprócz tego można definiować
        elementy, jakie mają zostać pokazane oraz ich kolejność jak również sam styl wyświetlanego
        paska postępu.
    </para>

    <note>
        <title>Automatyczne rozpoznawanie szerokości konsoli</title>

        <para>
            W przypadku systemów *nix niezbędny dla tej funkcjonalności jest
            <code>shell_exec</code>. Na maszynach Windows szerokość terminala jest stała
            (wynosi 80 znaków) więc automatyczne rozpoznawanie szerokości nie jest potrzebne.
        </para>
    </note>

    <para>
        Opcje adaptera można ustawiać za pomocą metod <code>set*</code> albo przez podanie
        tablicy asocjacyjnej lub obiektu <classname>Zend_Config</classname> w pierwszym parametrze
        konstruktora. Dostępne opcje to:
    </para>

    <itemizedlist>
        <listitem>
            <para>
                <code>outputStream</code>: Strumień do którego będzie kierowany wynik.
                Domyślnie to STDOUT.
                Może być dowolnym strumieniem, np.: <code>php://stderr</code> lub ścieżką do pliku.
            </para>
        </listitem>

        <listitem>
            <para>
                <code>width</code>: Liczba całkowita lub stała <constant>AUTO</constant>
                klasy <classname>Zend_Console_ProgressBar</classname>.
            </para>
        </listitem>

        <listitem>
            <para>
                <code>elements</code>: Przyjmuje <constant>NULL</constant> dla domyślnej
                konfiguracji lub tablicę zawierającą co najmniej jedną z następujących wartości:
            </para>

            <itemizedlist>
                <listitem>
                    <para>
                        <constant>ELEMENT_PERCENT</constant>: Obecna wartość wyrażona procentowo
                    </para>
                </listitem>

                <listitem>
                    <para>
                        <constant>ELEMENT_BAR</constant>: Pasek pokazujący wartość procentową.
                    </para>
                </listitem>

                <listitem>
                    <para>
                        <constant>ELEMENT_ETA</constant>: Automatycznie obliczany czas do
                        zakończenia operacji. Ten element jest pokazywany pierwszy raz z
                        opóźnieniem 5 sekund bo w krótszym czasie nie ma możliwości
                        obliczenia wiarygodnych wyników.
                    </para>
                </listitem>

                <listitem>
                    <para>
                        <constant>ELEMENT_TEXT</constant>: Opcjonalna wiadomość stanu postępu
                        operacji.
                    </para>
                </listitem>
            </itemizedlist>
        </listitem>

        <listitem>
            <para>
                <code>textWidth</code>: Szerokość elementu <constant>ELEMENT_TEXT</constant>
                podana w znakach. Domyślnie to 20.
            </para>
        </listitem>

        <listitem>
            <para>
                <code>charset</code>: Kodowanie elementu <constant>ELEMENT_TEXT</constant>.
                Domyślnie to utf-8.
            </para>
        </listitem>

        <listitem>
            <para>
                <code>barLeftChar</code>: Łańcuch znaków używany jako lewa krawędź paska postępu.
            </para>
        </listitem>

        <listitem>
            <para>
                <code>barRightChar</code>: Łańcuch znaków używany jako prawa krawędź paska postępu.
            </para>
        </listitem>

        <listitem>
            <para>
                <code>barIndicatorChar</code>: Łańcuch znaków używany jako wskaźnik paska postępu.
                Może zostać pusty.
            </para>
        </listitem>
    </itemizedlist>
</sect3>
<!--
vim:se ts=4 sw=4 et:
-->