Skip to main content
Drupal API
User account menu
  • Log in

Breadcrumb

  1. Drupal Core 11.1.x
  2. OutputFormatterInterface.php

interface OutputFormatterInterface

Formatter interface for console output.

@author Konstantin Kudryashov <ever.zet@gmail.com>

Hierarchy

  • interface \Symfony\Component\Console\Formatter\OutputFormatterInterface

Expanded class hierarchy of OutputFormatterInterface

All classes that implement OutputFormatterInterface

10 files declare their use of OutputFormatterInterface
BufferIO.php in vendor/composer/composer/src/Composer/IO/BufferIO.php
ConsoleOutput.php in vendor/symfony/console/Output/ConsoleOutput.php
ConsoleSectionOutput.php in vendor/symfony/console/Output/ConsoleSectionOutput.php
Helper.php in vendor/symfony/console/Helper/Helper.php
NullOutput.php in vendor/symfony/console/Output/NullOutput.php

... See full list

File

vendor/symfony/console/Formatter/OutputFormatterInterface.php, line 19

Namespace

Symfony\Component\Console\Formatter
View source
interface OutputFormatterInterface {
    
    /**
     * Sets the decorated flag.
     */
    public function setDecorated(bool $decorated) : void;
    
    /**
     * Whether the output will decorate messages.
     */
    public function isDecorated() : bool;
    
    /**
     * Sets a new style.
     */
    public function setStyle(string $name, OutputFormatterStyleInterface $style) : void;
    
    /**
     * Checks if output formatter has style with specified name.
     */
    public function hasStyle(string $name) : bool;
    
    /**
     * Gets style options from style with specified name.
     *
     * @throws \InvalidArgumentException When style isn't defined
     */
    public function getStyle(string $name) : OutputFormatterStyleInterface;
    
    /**
     * Formats a message according to the given styles.
     */
    public function format(?string $message) : ?string;

}

Members

Title Sort descending Modifiers Object type Summary Overrides
OutputFormatterInterface::format public function Formats a message according to the given styles. 2
OutputFormatterInterface::getStyle public function Gets style options from style with specified name. 2
OutputFormatterInterface::hasStyle public function Checks if output formatter has style with specified name. 2
OutputFormatterInterface::isDecorated public function Whether the output will decorate messages. 2
OutputFormatterInterface::setDecorated public function Sets the decorated flag. 2
OutputFormatterInterface::setStyle public function Sets a new style. 2
RSS feed
Powered by Drupal