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

Breadcrumb

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

class OutputFormatterStyle

Formatter style class for defining styles.

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

Hierarchy

  • class \Symfony\Component\Console\Formatter\OutputFormatterStyle implements \Symfony\Component\Console\Formatter\OutputFormatterStyleInterface

Expanded class hierarchy of OutputFormatterStyle

5 files declare their use of OutputFormatterStyle
BaseDependencyCommand.php in vendor/composer/composer/src/Composer/Command/BaseDependencyCommand.php
Factory.php in vendor/composer/composer/src/Composer/Factory.php
HtmlOutputFormatter.php in vendor/composer/composer/src/Composer/Console/HtmlOutputFormatter.php
QuestionHelper.php in vendor/symfony/console/Helper/QuestionHelper.php
ShowCommand.php in vendor/composer/composer/src/Composer/Command/ShowCommand.php

File

vendor/symfony/console/Formatter/OutputFormatterStyle.php, line 21

Namespace

Symfony\Component\Console\Formatter
View source
class OutputFormatterStyle implements OutputFormatterStyleInterface {
    private Color $color;
    private string $foreground;
    private string $background;
    private array $options;
    private ?string $href = null;
    private bool $handlesHrefGracefully;
    
    /**
     * Initializes output formatter style.
     *
     * @param string|null $foreground The style foreground color name
     * @param string|null $background The style background color name
     */
    public function __construct(?string $foreground = null, ?string $background = null, array $options = []) {
        $this->color = new Color($this->foreground = $foreground ?: '', $this->background = $background ?: '', $this->options = $options);
    }
    public function setForeground(?string $color) : void {
        $this->color = new Color($this->foreground = $color ?: '', $this->background, $this->options);
    }
    public function setBackground(?string $color) : void {
        $this->color = new Color($this->foreground, $this->background = $color ?: '', $this->options);
    }
    public function setHref(string $url) : void {
        $this->href = $url;
    }
    public function setOption(string $option) : void {
        $this->options[] = $option;
        $this->color = new Color($this->foreground, $this->background, $this->options);
    }
    public function unsetOption(string $option) : void {
        $pos = array_search($option, $this->options);
        if (false !== $pos) {
            unset($this->options[$pos]);
        }
        $this->color = new Color($this->foreground, $this->background, $this->options);
    }
    public function setOptions(array $options) : void {
        $this->color = new Color($this->foreground, $this->background, $this->options = $options);
    }
    public function apply(string $text) : string {
        $this->handlesHrefGracefully ??= 'JetBrains-JediTerm' !== getenv('TERMINAL_EMULATOR') && (!getenv('KONSOLE_VERSION') || (int) getenv('KONSOLE_VERSION') > 201100) && !isset($_SERVER['IDEA_INITIAL_DIRECTORY']);
        if (null !== $this->href && $this->handlesHrefGracefully) {
            $text = "\x1b]8;;{$this->href}\x1b\\{$text}\x1b]8;;\x1b\\";
        }
        return $this->color
            ->apply($text);
    }

}

Members

Title Sort descending Modifiers Object type Summary Overriden Title
OutputFormatterStyle::$background private property
OutputFormatterStyle::$color private property
OutputFormatterStyle::$foreground private property
OutputFormatterStyle::$handlesHrefGracefully private property
OutputFormatterStyle::$href private property
OutputFormatterStyle::$options private property
OutputFormatterStyle::apply public function Applies the style to a given text. Overrides OutputFormatterStyleInterface::apply
OutputFormatterStyle::setBackground public function Sets style background color. Overrides OutputFormatterStyleInterface::setBackground
OutputFormatterStyle::setForeground public function Sets style foreground color. Overrides OutputFormatterStyleInterface::setForeground
OutputFormatterStyle::setHref public function
OutputFormatterStyle::setOption public function Sets some specific style option. Overrides OutputFormatterStyleInterface::setOption
OutputFormatterStyle::setOptions public function Sets multiple style options at once. Overrides OutputFormatterStyleInterface::setOptions
OutputFormatterStyle::unsetOption public function Unsets some specific style option. Overrides OutputFormatterStyleInterface::unsetOption
OutputFormatterStyle::__construct public function Initializes output formatter style.
RSS feed
Powered by Drupal