Chris@0: <?php
Chris@0: 
Chris@0: /*
Chris@0:  * This file is part of the Symfony package.
Chris@0:  *
Chris@0:  * (c) Fabien Potencier <fabien@symfony.com>
Chris@0:  *
Chris@0:  * For the full copyright and license information, please view the LICENSE
Chris@0:  * file that was distributed with this source code.
Chris@0:  */
Chris@0: 
Chris@0: namespace Symfony\Component\Console\Helper;
Chris@0: 
Chris@0: use Symfony\Component\Console\Formatter\OutputFormatter;
Chris@0: 
Chris@0: /**
Chris@0:  * The Formatter class provides helpers to format messages.
Chris@0:  *
Chris@0:  * @author Fabien Potencier <fabien@symfony.com>
Chris@0:  */
Chris@0: class FormatterHelper extends Helper
Chris@0: {
Chris@0:     /**
Chris@0:      * Formats a message within a section.
Chris@0:      *
Chris@0:      * @param string $section The section name
Chris@0:      * @param string $message The message
Chris@0:      * @param string $style   The style to apply to the section
Chris@0:      *
Chris@0:      * @return string The format section
Chris@0:      */
Chris@0:     public function formatSection($section, $message, $style = 'info')
Chris@0:     {
Chris@0:         return sprintf('<%s>[%s]</%s> %s', $style, $section, $style, $message);
Chris@0:     }
Chris@0: 
Chris@0:     /**
Chris@0:      * Formats a message as a block of text.
Chris@0:      *
Chris@0:      * @param string|array $messages The message to write in the block
Chris@0:      * @param string       $style    The style to apply to the whole block
Chris@0:      * @param bool         $large    Whether to return a large block
Chris@0:      *
Chris@0:      * @return string The formatter message
Chris@0:      */
Chris@0:     public function formatBlock($messages, $style, $large = false)
Chris@0:     {
Chris@17:         if (!\is_array($messages)) {
Chris@17:             $messages = [$messages];
Chris@0:         }
Chris@0: 
Chris@0:         $len = 0;
Chris@17:         $lines = [];
Chris@0:         foreach ($messages as $message) {
Chris@0:             $message = OutputFormatter::escape($message);
Chris@0:             $lines[] = sprintf($large ? '  %s  ' : ' %s ', $message);
Chris@0:             $len = max($this->strlen($message) + ($large ? 4 : 2), $len);
Chris@0:         }
Chris@0: 
Chris@17:         $messages = $large ? [str_repeat(' ', $len)] : [];
Chris@0:         for ($i = 0; isset($lines[$i]); ++$i) {
Chris@0:             $messages[] = $lines[$i].str_repeat(' ', $len - $this->strlen($lines[$i]));
Chris@0:         }
Chris@0:         if ($large) {
Chris@0:             $messages[] = str_repeat(' ', $len);
Chris@0:         }
Chris@0: 
Chris@0:         for ($i = 0; isset($messages[$i]); ++$i) {
Chris@0:             $messages[$i] = sprintf('<%s>%s</%s>', $style, $messages[$i], $style);
Chris@0:         }
Chris@0: 
Chris@0:         return implode("\n", $messages);
Chris@0:     }
Chris@0: 
Chris@0:     /**
Chris@0:      * Truncates a message to the given length.
Chris@0:      *
Chris@0:      * @param string $message
Chris@0:      * @param int    $length
Chris@0:      * @param string $suffix
Chris@0:      *
Chris@0:      * @return string
Chris@0:      */
Chris@0:     public function truncate($message, $length, $suffix = '...')
Chris@0:     {
Chris@0:         $computedLength = $length - $this->strlen($suffix);
Chris@0: 
Chris@0:         if ($computedLength > $this->strlen($message)) {
Chris@0:             return $message;
Chris@0:         }
Chris@0: 
Chris@0:         if (false === $encoding = mb_detect_encoding($message, null, true)) {
Chris@0:             return substr($message, 0, $length).$suffix;
Chris@0:         }
Chris@0: 
Chris@0:         return mb_substr($message, 0, $length, $encoding).$suffix;
Chris@0:     }
Chris@0: 
Chris@0:     /**
Chris@0:      * {@inheritdoc}
Chris@0:      */
Chris@0:     public function getName()
Chris@0:     {
Chris@0:         return 'formatter';
Chris@0:     }
Chris@0: }