1: <?php
  2: 
  3: /*
  4:  * This file is part of the Symfony package.
  5:  *
  6:  * (c) Fabien Potencier <fabien@symfony.com>
  7:  *
  8:  * For the full copyright and license information, please view the LICENSE
  9:  * file that was distributed with this source code.
 10:  */
 11: 
 12: namespace Symfony\Component\Console\Formatter;
 13: 
 14: /**
 15:  * Formatter class for console output.
 16:  *
 17:  * @author Konstantin Kudryashov <ever.zet@gmail.com>
 18:  *
 19:  * @api
 20:  */
 21: class OutputFormatter implements OutputFormatterInterface
 22: {
 23:     /**
 24:      * The pattern to phrase the format.
 25:      */
 26:     const FORMAT_PATTERN = '#<([a-z][a-z0-9_=;-]+)>(.*?)</\\1?>#is';
 27: 
 28:     private $decorated;
 29:     private $styles = array();
 30: 
 31:     /**
 32:      * Initializes console output formatter.
 33:      *
 34:      * @param   Boolean $decorated  Whether this formatter should actually decorate strings
 35:      * @param   array   $styles     Array of "name => FormatterStyle" instances
 36:      *
 37:      * @api
 38:      */
 39:     public function __construct($decorated = null, array $styles = array())
 40:     {
 41:         $this->decorated = (Boolean) $decorated;
 42: 
 43:         $this->setStyle('error',    new OutputFormatterStyle('white', 'red'));
 44:         $this->setStyle('info',     new OutputFormatterStyle('green'));
 45:         $this->setStyle('comment',  new OutputFormatterStyle('yellow'));
 46:         $this->setStyle('question', new OutputFormatterStyle('black', 'cyan'));
 47: 
 48:         foreach ($styles as $name => $style) {
 49:             $this->setStyle($name, $style);
 50:         }
 51:     }
 52: 
 53:     /**
 54:      * Sets the decorated flag.
 55:      *
 56:      * @param Boolean $decorated Whether to decorate the messages or not
 57:      *
 58:      * @api
 59:      */
 60:     public function setDecorated($decorated)
 61:     {
 62:         $this->decorated = (Boolean) $decorated;
 63:     }
 64: 
 65:     /**
 66:      * Gets the decorated flag.
 67:      *
 68:      * @return Boolean true if the output will decorate messages, false otherwise
 69:      *
 70:      * @api
 71:      */
 72:     public function isDecorated()
 73:     {
 74:         return $this->decorated;
 75:     }
 76: 
 77:     /**
 78:      * Sets a new style.
 79:      *
 80:      * @param string                        $name  The style name
 81:      * @param OutputFormatterStyleInterface $style The style instance
 82:      *
 83:      * @api
 84:      */
 85:     public function setStyle($name, OutputFormatterStyleInterface $style)
 86:     {
 87:         $this->styles[strtolower($name)] = $style;
 88:     }
 89: 
 90:     /**
 91:      * Checks if output formatter has style with specified name.
 92:      *
 93:      * @param   string  $name
 94:      *
 95:      * @return  Boolean
 96:      *
 97:      * @api
 98:      */
 99:     public function hasStyle($name)
100:     {
101:         return isset($this->styles[strtolower($name)]);
102:     }
103: 
104:     /**
105:      * Gets style options from style with specified name.
106:      *
107:      * @param   string  $name
108:      *
109:      * @return  OutputFormatterStyleInterface
110:      *
111:      * @throws  \InvalidArgumentException When style isn't defined
112:      *
113:      * @api
114:      */
115:     public function getStyle($name)
116:     {
117:         if (!$this->hasStyle($name)) {
118:             throw new \InvalidArgumentException('Undefined style: '.$name);
119:         }
120: 
121:         return $this->styles[strtolower($name)];
122:     }
123: 
124:     /**
125:      * Formats a message according to the given styles.
126:      *
127:      * @param  string $message The message to style
128:      *
129:      * @return string The styled message
130:      *
131:      * @api
132:      */
133:     public function format($message)
134:     {
135:         return preg_replace_callback(self::FORMAT_PATTERN, array($this, 'replaceStyle'), $message);
136:     }
137: 
138:     /**
139:      * Replaces style of the output.
140:      *
141:      * @param array $match
142:      *
143:      * @return string The replaced style
144:      */
145:     private function replaceStyle($match)
146:     {
147:         if (!$this->isDecorated()) {
148:             return $match[2];
149:         }
150: 
151:         if (isset($this->styles[strtolower($match[1])])) {
152:             $style = $this->styles[strtolower($match[1])];
153:         } else {
154:             $style = $this->createStyleFromString($match[1]);
155: 
156:             if (false === $style) {
157:                 return $match[0];
158:             }
159:         }
160: 
161:         return $style->apply($this->format($match[2]));
162:     }
163: 
164:     /**
165:      * Tries to create new style instance from string.
166:      *
167:      * @param   string  $string
168:      *
169:      * @return  Symfony\Component\Console\Format\FormatterStyle|Boolean false if string is not format string
170:      */
171:     private function createStyleFromString($string)
172:     {
173:         if (!preg_match_all('/([^=]+)=([^;]+)(;|$)/', strtolower($string), $matches, PREG_SET_ORDER)) {
174:             return false;
175:         }
176: 
177:         $style = new OutputFormatterStyle();
178:         foreach ($matches as $match) {
179:             array_shift($match);
180: 
181:             if ('fg' == $match[0]) {
182:                 $style->setForeground($match[1]);
183:             } elseif ('bg' == $match[0]) {
184:                 $style->setBackground($match[1]);
185:             } else {
186:                 $style->setOption($match[1]);
187:             }
188:         }
189: 
190:         return $style;
191:     }
192: }
193: