FormatterHelper.php in Zircon Profile 8

Namespace

Symfony\Component\Console\Helper

File

vendor/symfony/console/Helper/FormatterHelper.php

<?php

/*
 * This file is part of the Symfony package.
 *
 * (c) Fabien Potencier <[e-mail]>
 *
 * For the full copyright and license information, please view the LICENSE
 * file that was distributed with this source code.
 */
namespace Symfony\Component\Console\Helper;

use Symfony\Component\Console\Formatter\OutputFormatter;

/**
 * The Formatter class provides helpers to format messages.
 *
 * @author Fabien Potencier <[e-mail]>
 */
class FormatterHelper extends Helper {

  /**
   * Formats a message within a section.
   *
   * @param string $section The section name
   * @param string $message The message
   * @param string $style   The style to apply to the section
   *
   * @return string The format section
   */
  public function formatSection($section, $message, $style = 'info') {
    return sprintf('<%s>[%s]</%s> %s', $style, $section, $style, $message);
  }

  /**
   * Formats a message as a block of text.
   *
   * @param string|array $messages The message to write in the block
   * @param string       $style    The style to apply to the whole block
   * @param bool         $large    Whether to return a large block
   *
   * @return string The formatter message
   */
  public function formatBlock($messages, $style, $large = false) {
    if (!is_array($messages)) {
      $messages = array(
        $messages,
      );
    }
    $len = 0;
    $lines = array();
    foreach ($messages as $message) {
      $message = OutputFormatter::escape($message);
      $lines[] = sprintf($large ? '  %s  ' : ' %s ', $message);
      $len = max($this
        ->strlen($message) + ($large ? 4 : 2), $len);
    }
    $messages = $large ? array(
      str_repeat(' ', $len),
    ) : array();
    for ($i = 0; isset($lines[$i]); ++$i) {
      $messages[] = $lines[$i] . str_repeat(' ', $len - $this
        ->strlen($lines[$i]));
    }
    if ($large) {
      $messages[] = str_repeat(' ', $len);
    }
    for ($i = 0; isset($messages[$i]); ++$i) {
      $messages[$i] = sprintf('<%s>%s</%s>', $style, $messages[$i], $style);
    }
    return implode("\n", $messages);
  }

  /**
   * {@inheritdoc}
   */
  public function getName() {
    return 'formatter';
  }

}

Classes

Name	Description
FormatterHelper	The Formatter class provides helpers to format messages.