interface StyleInterface in Zircon Profile 8

Output style helpers.

@author Kevin Bond <[e-mail]>

Hierarchy

• interface \Symfony\Component\Console\Style\StyleInterface

File

vendor/symfony/console/Style/StyleInterface.php, line 19

Namespace

Symfony\Component\Console\Style

interface StyleInterface {

  /**
   * Formats a command title.
   *
   * @param string $message
   */
  public function title($message);

  /**
   * Formats a section title.
   *
   * @param string $message
   */
  public function section($message);

  /**
   * Formats a list.
   *
   * @param array $elements
   */
  public function listing(array $elements);

  /**
   * Formats informational text.
   *
   * @param string|array $message
   */
  public function text($message);

  /**
   * Formats a success result bar.
   *
   * @param string|array $message
   */
  public function success($message);

  /**
   * Formats an error result bar.
   *
   * @param string|array $message
   */
  public function error($message);

  /**
   * Formats an warning result bar.
   *
   * @param string|array $message
   */
  public function warning($message);

  /**
   * Formats a note admonition.
   *
   * @param string|array $message
   */
  public function note($message);

  /**
   * Formats a caution admonition.
   *
   * @param string|array $message
   */
  public function caution($message);

  /**
   * Formats a table.
   *
   * @param array $headers
   * @param array $rows
   */
  public function table(array $headers, array $rows);

  /**
   * Asks a question.
   *
   * @param string        $question
   * @param string|null   $default
   * @param callable|null $validator
   *
   * @return string
   */
  public function ask($question, $default = null, $validator = null);

  /**
   * Asks a question with the user input hidden.
   *
   * @param string        $question
   * @param callable|null $validator
   *
   * @return string
   */
  public function askHidden($question, $validator = null);

  /**
   * Asks for confirmation.
   *
   * @param string $question
   * @param bool   $default
   *
   * @return bool
   */
  public function confirm($question, $default = true);

  /**
   * Asks a choice question.
   *
   * @param string          $question
   * @param array           $choices
   * @param string|int|null $default
   *
   * @return string
   */
  public function choice($question, array $choices, $default = null);

  /**
   * Add newline(s).
   *
   * @param int $count The number of newlines
   */
  public function newLine($count = 1);

  /**
   * Starts the progress output.
   *
   * @param int $max Maximum steps (0 if unknown)
   */
  public function progressStart($max = 0);

  /**
   * Advances the progress output X steps.
   *
   * @param int $step Number of steps to advance
   */
  public function progressAdvance($step = 1);

  /**
   * Finishes the progress output.
   */
  public function progressFinish();

}

Members

Name	Modifiers	Type	Description	Overrides
StyleInterface::ask	public	function	Asks a question.	1
StyleInterface::askHidden	public	function	Asks a question with the user input hidden.	1
StyleInterface::caution	public	function	Formats a caution admonition.	1
StyleInterface::choice	public	function	Asks a choice question.	1
StyleInterface::confirm	public	function	Asks for confirmation.	1
StyleInterface::error	public	function	Formats an error result bar.	1
StyleInterface::listing	public	function	Formats a list.	1
StyleInterface::newLine	public	function	Add newline(s).	1
StyleInterface::note	public	function	Formats a note admonition.	1
StyleInterface::progressAdvance	public	function	Advances the progress output X steps.	1
StyleInterface::progressFinish	public	function	Finishes the progress output.	1
StyleInterface::progressStart	public	function	Starts the progress output.	1
StyleInterface::section	public	function	Formats a section title.	1
StyleInterface::success	public	function	Formats a success result bar.	1
StyleInterface::table	public	function	Formats a table.	1
StyleInterface::text	public	function	Formats informational text.	1
StyleInterface::title	public	function	Formats a command title.	1
StyleInterface::warning	public	function	Formats an warning result bar.	1