Zend_ProgressBar_Adapter_Console.xml 4.3 KB

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