documentation/manual/pl/module_specs/Zend_ProgressBar_Adapter_Console.xml

   1 <?xml version="1.0" encoding="UTF-8"?>
   2 <!-- EN-Revision: 20827 -->
   3 <!-- Reviewed: no -->
   4 <sect3 id="zend.progressbar.adapter.console">
   5     <title>Zend_ProgressBar_Adapter_Console</title>
   6
   7     <para>
   8         <classname>Zend_ProgressBar_Adapter_Console</classname> to adapter tekstowy przeznaczony
   9         do użytku z terminalem (konsolą, wierszem polecenia). Adapter potrafi automatycznie wykryć
  10         dostępną szerokość ale można również podać ją ręcznie. Oprócz tego można definiować
  11         elementy, jakie mają zostać pokazane oraz ich kolejność jak również sam styl wyświetlanego
  12         paska postępu.
  13     </para>
  14
  15     <note>
  16         <title>Automatyczne rozpoznawanie szerokości konsoli</title>
  17
  18         <para>
  19             W przypadku systemów *nix niezbędny dla tej funkcjonalności jest
  20             <code>shell_exec</code>. Na maszynach Windows szerokość terminala jest stała
  21             (wynosi 80 znaków) więc automatyczne rozpoznawanie szerokości nie jest potrzebne.
  22         </para>
  23     </note>
  24
  25     <para>
  26         Opcje adaptera można ustawiać za pomocą metod <code>set*</code> albo przez podanie
  27         tablicy asocjacyjnej lub obiektu <classname>Zend_Config</classname> w pierwszym parametrze
  28         konstruktora. Dostępne opcje to:
  29     </para>
  30
  31     <itemizedlist>
  32         <listitem>
  33             <para>
  34                 <code>outputStream</code>: Strumień do którego będzie kierowany wynik.
  35                 Domyślnie to STDOUT.
  36                 Może być dowolnym strumieniem, np.: <code>php://stderr</code> lub ścieżką do pliku.
  37             </para>
  38         </listitem>
  39
  40         <listitem>
  41             <para>
  42                 <code>width</code>: Liczba całkowita lub stała <constant>AUTO</constant>
  43                 klasy <classname>Zend_Console_ProgressBar</classname>.
  44             </para>
  45         </listitem>
  46
  47         <listitem>
  48             <para>
  49                 <code>elements</code>: Przyjmuje <constant>NULL</constant> dla domyślnej
  50                 konfiguracji lub tablicę zawierającą co najmniej jedną z następujących wartości:
  51             </para>
  52
  53             <itemizedlist>
  54                 <listitem>
  55                     <para>
  56                         <constant>ELEMENT_PERCENT</constant>: Obecna wartość wyrażona procentowo
  57                     </para>
  58                 </listitem>
  59
  60                 <listitem>
  61                     <para>
  62                         <constant>ELEMENT_BAR</constant>: Pasek pokazujący wartość procentową.
  63                     </para>
  64                 </listitem>
  65
  66                 <listitem>
  67                     <para>
  68                         <constant>ELEMENT_ETA</constant>: Automatycznie obliczany czas do
  69                         zakończenia operacji. Ten element jest pokazywany pierwszy raz z
  70                         opóźnieniem 5 sekund bo w krótszym czasie nie ma możliwości
  71                         obliczenia wiarygodnych wyników.
  72                     </para>
  73                 </listitem>
  74
  75                 <listitem>
  76                     <para>
  77                         <constant>ELEMENT_TEXT</constant>: Opcjonalna wiadomość stanu postępu
  78                         operacji.
  79                     </para>
  80                 </listitem>
  81             </itemizedlist>
  82         </listitem>
  83
  84         <listitem>
  85             <para>
  86                 <code>textWidth</code>: Szerokość elementu <constant>ELEMENT_TEXT</constant>
  87                 podana w znakach. Domyślnie to 20.
  88             </para>
  89         </listitem>
  90
  91         <listitem>
  92             <para>
  93                 <code>charset</code>: Kodowanie elementu <constant>ELEMENT_TEXT</constant>.
  94                 Domyślnie to utf-8.
  95             </para>
  96         </listitem>
  97
  98         <listitem>
  99             <para>
 100                 <code>barLeftChar</code>: Łańcuch znaków używany jako lewa krawędź paska postępu.
 101             </para>
 102         </listitem>
 103
 104         <listitem>
 105             <para>
 106                 <code>barRightChar</code>: Łańcuch znaków używany jako prawa krawędź paska postępu.
 107             </para>
 108         </listitem>
 109
 110         <listitem>
 111             <para>
 112                 <code>barIndicatorChar</code>: Łańcuch znaków używany jako wskaźnik paska postępu.
 113                 Może zostać pusty.
 114             </para>
 115         </listitem>
 116     </itemizedlist>
 117 </sect3>
 118 <!--
 119 vim:se ts=4 sw=4 et:
 120 -->