documentation/manual/en/module_specs/Zend_ProgressBar_Adapter_Console.xml

   1 <?xml version="1.0" encoding="UTF-8"?>
   2 <!-- Reviewed: no -->
   3 <sect3 id="zend.progressbar.adapter.console">
   4     <title>Zend_ProgressBar_Adapter_Console</title>
   5
   6     <para>
   7         <classname>Zend_ProgressBar_Adapter_Console</classname> is a text-based adapter
   8         for terminals. It can automatically detect terminal widths but supports
   9         custom widths as well. You can define which elements are displayed with
  10         the progressbar and as well customize the order of them. You can also
  11         define the style of the progressbar itself.
  12     </para>
  13
  14     <note>
  15         <title>Automatic console width recognition</title>
  16
  17         <para>
  18             <code>shell_exec</code> is required for this feature to work on
  19             *nix based systems. On windows, there is always a fixed terminal
  20             width of 80 character, so no recognition is required there.
  21         </para>
  22     </note>
  23
  24     <para>
  25         You can set the adapter options either via the <code>set*</code> methods
  26         or give an array or a <classname>Zend_Config</classname> instance with options as first
  27         parameter to the constructor. The available options are:
  28     </para>
  29
  30     <itemizedlist>
  31         <listitem>
  32             <para>
  33                 <code>outputStream</code>: A different output-stream, if you don't
  34                 want to stream to STDOUT. Can be any other stream like
  35                 <code>php://stderr</code> or a path to a file.
  36             </para>
  37         </listitem>
  38
  39         <listitem>
  40             <para>
  41                 <code>width</code>: Either an integer or the <constant>AUTO</constant>
  42                 constant of <classname>Zend_Console_ProgressBar</classname>.
  43             </para>
  44         </listitem>
  45
  46         <listitem>
  47             <para>
  48                 <code>elements</code>: Either <constant>NULL</constant> for default
  49                 or an array with at least one of the following constants
  50                 of <classname>Zend_Console_ProgressBar</classname> as value:
  51             </para>
  52
  53             <itemizedlist>
  54                 <listitem>
  55                     <para>
  56                         <constant>ELEMENT_PERCENT</constant>: The current value in percent.
  57                     </para>
  58                 </listitem>
  59
  60                 <listitem>
  61                     <para>
  62                         <constant>ELEMENT_BAR</constant>: The visual bar which display
  63                         the percentage.
  64                     </para>
  65                 </listitem>
  66
  67                 <listitem>
  68                     <para>
  69                         <constant>ELEMENT_ETA</constant>: The automatic calculated ETA.
  70                         This element is firstly displayed after five seconds,
  71                         because in this time, it is not able to calculate
  72                         accurate results.
  73                     </para>
  74                 </listitem>
  75
  76                 <listitem>
  77                     <para>
  78                         <constant>ELEMENT_TEXT</constant>: An optional status message
  79                         about the current process.
  80                     </para>
  81                 </listitem>
  82             </itemizedlist>
  83         </listitem>
  84
  85         <listitem>
  86             <para>
  87                 <code>textWidth</code>: Width in characters of the
  88                 <constant>ELEMENT_TEXT</constant> element. Default is 20.
  89             </para>
  90         </listitem>
  91
  92         <listitem>
  93             <para>
  94                 <code>charset</code>: Charset of the
  95                 <constant>ELEMENT_TEXT</constant> element. Default is utf-8.
  96             </para>
  97         </listitem>
  98
  99         <listitem>
 100             <para>
 101                 <code>barLeftChar</code>: A string which is used left-hand
 102                 of the indicator in the progressbar.
 103             </para>
 104         </listitem>
 105
 106         <listitem>
 107             <para>
 108                 <code>barRightChar</code>: A string which is used right-hand
 109                 of the indicator in the progressbar.
 110             </para>
 111         </listitem>
 112
 113         <listitem>
 114             <para>
 115                 <code>barIndicatorChar</code>: A string which is used for
 116                 the indicator in the progressbar. This one can be empty.
 117             </para>
 118         </listitem>
 119     </itemizedlist>
 120 </sect3>
 121 <!--
 122 vim:se ts=4 sw=4 et:
 123 -->