upstream / vendor / symfony / console / Formatter / OutputFormatterStyleInterface.php

OutputFormatterStyleInterface.php in UpStream: a Project Management Plugin for WordPress trunk, at vendor/symfony/console/Formatter/OutputFormatterStyleInterface.php

63 lines 1.3 KB

Raw Download Zip

1	<?php
2
3	/*
4	* This file is part of the Symfony package.
5	*
6	* (c) Fabien Potencier <fabien@symfony.com>
7	*
8	* For the full copyright and license information, please view the LICENSE
9	* file that was distributed with this source code.
10	*/
11
12	namespace Symfony\Component\Console\Formatter;
13
14	/**
15	* Formatter style interface for defining styles.
16	*
17	* @author Konstantin Kudryashov <ever.zet@gmail.com>
18	*/
19	interface OutputFormatterStyleInterface
20	{
21	/**
22	* Sets style foreground color.
23	*
24	* @param string\|null $color The color name
25	*/
26	public function setForeground($color = null);
27
28	/**
29	* Sets style background color.
30	*
31	* @param string $color The color name
32	*/
33	public function setBackground($color = null);
34
35	/**
36	* Sets some specific style option.
37	*
38	* @param string $option The option name
39	*/
40	public function setOption($option);
41
42	/**
43	* Unsets some specific style option.
44	*
45	* @param string $option The option name
46	*/
47	public function unsetOption($option);
48
49	/**
50	* Sets multiple style options at once.
51	*/
52	public function setOptions(array $options);
53
54	/**
55	* Applies the style to a given text.
56	*
57	* @param string $text The text to style
58	*
59	* @return string
60	*/
61	public function apply($text);
62	}
63