Apache Zeta Components Manual :: File Source for progressbar.php
Source for file progressbar.php
Documentation is available at progressbar.php
* File containing the ezcConsoleProgressbarOptions class.
* Licensed to the Apache Software Foundation (ASF) under one
* or more contributor license agreements. See the NOTICE file
* distributed with this work for additional information
* regarding copyright ownership. The ASF licenses this file
* to you under the Apache License, Version 2.0 (the
* "License"); you may not use this file except in compliance
* with the License. You may obtain a copy of the License at
* http://www.apache.org/licenses/LICENSE-2.0
* Unless required by applicable law or agreed to in writing,
* software distributed under the License is distributed on an
* "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
* KIND, either express or implied. See the License for the
* specific language governing permissions and limitations
* @version //autogentag//
* @license http://www.apache.org/licenses/LICENSE-2.0 Apache License, Version 2.0
* Struct class to store the options of the ezcConsoleOutput class.
* This class stores the options for the {@link ezcConsoleOutput} class.
* @property string $barChar
* The character to fill the bar with, during progress indication.
* @property string $emptyChar
* The character to pre-fill the bar, before indicating progress.
* @property string $formatString
* The format string to describe the complete progressbar.
* @property string $fractionFormat
* Format to display the fraction value.
* @property string $processChar
* The character for the end of the progress area (the arrow!).
* @property int $redrawFrequency
* How often to redraw the progressbar (on every Xth call to advance()).
* How many steps to advance the progressbar on each call to advance().
* The width of the bar itself.
* @property string $actFormat
* The format to display the actual value with.
* @property string $maxFormat
* The format to display the actual value with.
* @property int $minVerbosity
* Defines the minimum {ezcConsoleOutputOptions->$verbosityLevel}
* that is needed by the progress bar to be rendered. If
* $verbosityLevel is lower, the bar is skipped. Default is 0 to
* @property int $maxVerbosity
* Defines the maximum {ezcConsoleOutputOptions->$verbosityLevel} on
* which the progress bar is rendered. If $verbosityLevel is higher,
* the bar is skipped. Default is false, to render always.
'formatString' =>
"%act% / %max% [%bar%] %fraction%%",
'fractionFormat' =>
"%01.2f",
* @throws ezcBasePropertyNotFoundException
* If a desired property could not be found.
* @throws ezcBaseValueException
* If a desired property value is out of range.
* @param string $key Name of the property.
* @param mixed $value The value for the property.
public function __set( $key, $value )
if ( !is_int( $value ) ||
$value <
5 )
if ( !is_int( $value ) ||
$value <
0 )
if ( ( !is_int( $value ) ||
$value <
0 ) &&
$value !==
false )