TableStyle::getHeaderCellFormat() - Code Metrics - webmozart/console - Measure and Improve Code Quality continuously with Scrutinizer

TableStyle::getHeaderCellFormat() A
last analyzed 2016-08-15 15:54 UTC

↳ Parent: TableStyle

Complexity

Conditions	1
Paths	1

Size

Total Lines	4
Code Lines	2

Duplication

Lines	0
Ratio	0 %

Code Coverage

Tests	2
CRAP Score	1

Importance

Changes	1
Bugs	0	Features	0

Metric	Value
c	1
b	0
f	0
dl	0
loc	4
ccs	2
cts	2
cp	1
rs	10
cc	1
eloc	2
nc	1
nop	0
crap	1

<?php

/*
 * This file is part of the webmozart/console package.
 *
 * (c) Bernhard Schussek <[email protected]>
 *
 * For the full copyright and license information, please view the LICENSE
 * file that was distributed with this source code.
 */

namespace Webmozart\Console\UI\Style;

use Webmozart\Assert\Assert;
use Webmozart\Console\Api\Formatter\Style;

/**
 * Defines the style of a {@link Table}.
 *
 * @since  1.0
 *
 * @author Bernhard Schussek <[email protected]>
 */
class TableStyle
{
    /**
     * @var TableStyle
     */
    private static $borderless;

    /**
     * @var TableStyle
     */
    private static $asciiBorder;

    /**
     * @var TableStyle
     */
    private static $solidBorder;

    /**
     * @var string
     */
    private $paddingChar = ' ';

    /**
     * @var string
     */
    private $headerCellFormat = '%s';

    /**
     * @var string
     */
    private $cellFormat = '%s';

    /**
     * @var string
     */
    private $columnAlignments = array();

    /**
     * @var string
     */
    private $defaultColumnAlignment = Alignment::LEFT;

    /**
     * @var BorderStyle
     */
    private $borderStyle;

    /**
     * @var Style
     */
    private $headerCellStyle;

    /**
     * @var Style
     */
    private $cellStyle;

    /**
     * A borderless style.
     *
     * @return TableStyle The style.
     */
    public static function borderless()
    {
        if (!self::$borderless) {
            self::$borderless = new static();
            self::$borderless->borderStyle = BorderStyle::none();
            self::$borderless->borderStyle->setLineHCChar('=');
            self::$borderless->borderStyle->setLineVCChar(' ');
            self::$borderless->borderStyle->setCrossingCChar(' ');
        }

        return clone self::$borderless;
    }

    /**
     * A style that uses ASCII characters for drawing borders.
     *
     * @return TableStyle The style.
     */
    public static function asciiBorder()

    {
        if (!self::$asciiBorder) {
            self::$asciiBorder = new static();
            self::$asciiBorder->headerCellFormat = ' %s ';
            self::$asciiBorder->cellFormat = ' %s ';
            self::$asciiBorder->borderStyle = BorderStyle::ascii();
        }

        return clone self::$asciiBorder;
    }

    /**
     * A style that uses Unicode characters for drawing solid borders.
     *
     * @return TableStyle The style.
     */
    public static function solidBorder()

    {
        if (!self::$solidBorder) {
            self::$solidBorder = new static();
            self::$solidBorder->headerCellFormat = ' %s ';
            self::$solidBorder->cellFormat = ' %s ';
            self::$solidBorder->borderStyle = BorderStyle::solid();
        }

        return clone self::$solidBorder;
    }

    /**
     * Returns the character used to pad cells to the desired width.
     *
     * @return string The padding character.
     */
    public function getPaddingChar()
    {
        return $this->paddingChar;
    }

    /**
     * Sets the character used to pad cells to the desired width.
     *
     * @param string $char The padding character.
     *
     * @return static The current instance.
     */
    public function setPaddingChar($char)
    {
        $this->paddingChar = $char;

        return $this;
    }

    /**
     * Returns the format string for rendering the header cells.
     *
     * @return string The format string. The string contains the substring "%s"
     *                where the cell content is inserted.
     */
    public function getHeaderCellFormat()
    {
        return $this->headerCellFormat;
    }

    /**
     * Sets the format string for rendering the header cells.
     *
     * @param string $format The format string. The string should contain the
     *                       substring "%s" where the cell content is inserted.
     *
     * @return static The current instance.
     */
    public function setHeaderCellFormat($format)
    {
        $this->headerCellFormat = $format;

        return $this;
    }

    /**
     * Returns the format string for rendering cells.
     *
     * @return string The format string. The string contains the substring "%s"
     *                where the cell content is inserted.
     */
    public function getCellFormat()
    {
        return $this->cellFormat;
    }

    /**
     * Sets the format string for rendering cells.
     *
     * @param string $format The format string. The string should contain the
     *                       substring "%s" where the cell content is inserted.
     *
     * @return static The current instance.
     */
    public function setCellFormat($format)
    {
        $this->cellFormat = $format;

        return $this;
    }

    /**
     * Returns the alignments of the table columns.
     *
     * @param int $nbColumns The number of alignments to return.
     *
     * @return int[] An array of {@link Alignment} constants indexed by the
     *               0-based column keys.
     */
    public function getColumnAlignments($nbColumns)
    {
        return array_slice(array_replace(
            array_fill(0, $nbColumns, $this->defaultColumnAlignment),
            $this->columnAlignments
        ), 0, $nbColumns);
    }

    /**
     * Returns the alignment of a given column.
     *
     * @param int $column The 0-based column key.
     *
     * @return int The {@link Alignment} constant.

     */
    public function getColumnAlignment($column)
    {
        return isset($this->columnAlignments[$column])
            ? $this->columnAlignments[$column]
            : $this->defaultColumnAlignment;
    }

    /**
     * Sets the alignments of the table columns.
     *
     * @param int[] $alignments An array of {@link Alignment} constants indexed
     *                          by the 0-based column keys.
     *
     * @return static The current instance.
     */
    public function setColumnAlignments(array $alignments)
    {
        $this->columnAlignments = array();


        foreach ($alignments as $column => $alignment) {
            $this->setColumnAlignment($column, $alignment);
        }

        return $this;
    }

    /**
     * Sets the alignment of a given column.
     *
     * @param int $column    The 0-based column key.
     * @param int $alignment The alignment.
     *
     * @return static The current instance.
     */
    public function setColumnAlignment($column, $alignment)
    {
        Assert::oneOf($alignment, Alignment::all(), 'The column alignment must be one of the Alignment constants. Got: %s');

        $this->columnAlignments[$column] = $alignment;

        return $this;
    }

    /**
     * Returns the default column alignment.
     *
     * @return int One of the {@link Alignment} constants.

     */
    public function getDefaultColumnAlignment()
    {
        return $this->defaultColumnAlignment;
    }

    /**
     * Returns the default column alignment.
     *
     * @param int $alignment One of the {@link Alignment} constants.
     *
     * @return static The current instance.
     */
    public function setDefaultColumnAlignment($alignment)
    {
        Assert::oneOf($alignment, Alignment::all(), 'The default column alignment must be one of the Alignment constants. Got: %s');

        $this->defaultColumnAlignment = $alignment;
$answer = 42;

$correct = false;

$correct = (bool) $answer;

        return $this;
    }

    /**
     * Returns the border style.
     *
     * @return BorderStyle The border style.
     */
    public function getBorderStyle()
    {
        return $this->borderStyle;
    }

    /**
     * Sets the border style.
     *
     * @param BorderStyle $borderStyle The border style.
     *
     * @return static The current instance.
     */
    public function setBorderStyle(BorderStyle $borderStyle)
    {
        $this->borderStyle = $borderStyle;

        return $this;
    }

    /**
     * Returns the style of the header cells.
     *
     * @return Style The header cell style.
     */
    public function getHeaderCellStyle()
    {
        return $this->headerCellStyle;
    }

    /**
     * Sets the style of the header cells.
     *
     * @param Style $style The header cell style.

     *
     * @return static The current instance.
     */
    public function setHeaderCellStyle(Style $style = null)
    {
        $this->headerCellStyle = $style;

        return $this;
    }

    /**
     * Returns the style of the table cells.
     *
     * @return Style The cell style.
     */
    public function getCellStyle()
    {
        return $this->cellStyle;
    }

    /**
     * Sets the style of the table cells.
     *
     * @param Style $style The cell style.
     *
     * @return static The current instance.
     */
    public function setCellStyle(Style $style)
    {
        $this->cellStyle = $style;

        return $this;
    }
}


1			<?php
2
3			/*
4			* This file is part of the webmozart/console package.
5			*
6			* (c) Bernhard Schussek <[email protected]>
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 Webmozart\Console\UI\Style;
13
14			use Webmozart\Assert\Assert;
15			use Webmozart\Console\Api\Formatter\Style;
16
17			/**
18			* Defines the style of a {@link Table}.
19			*
20			* @since 1.0
21			*
22			* @author Bernhard Schussek <[email protected]>
23			*/
24			class TableStyle
25			{
26			/**
27			* @var TableStyle
28			*/
29			private static $borderless;
30
31			/**
32			* @var TableStyle
33			*/
34			private static $asciiBorder;
35
36			/**
37			* @var TableStyle
38			*/
39			private static $solidBorder;
40
41			/**
42			* @var string
43			*/
44			private $paddingChar = ' ';
45
46			/**
47			* @var string
48			*/
49			private $headerCellFormat = '%s';
50
51			/**
52			* @var string
53			*/
54			private $cellFormat = '%s';
55
56			/**
57			* @var string
58			*/
59			private $columnAlignments = array();
60
61			/**
62			* @var string
63			*/
64			private $defaultColumnAlignment = Alignment::LEFT;
65
66			/**
67			* @var BorderStyle
68			*/
69			private $borderStyle;
70
71			/**
72			* @var Style
73			*/
74			private $headerCellStyle;
75
76			/**
77			* @var Style
78			*/
79			private $cellStyle;
80
81			/**
82			* A borderless style.
83			*
84			* @return TableStyle The style.
85			*/
86	1		public static function borderless()
87			{
88	1		if (!self::$borderless) {
89	1		self::$borderless = new static();
90	1		self::$borderless->borderStyle = BorderStyle::none();
91	1		self::$borderless->borderStyle->setLineHCChar('=');
92	1		self::$borderless->borderStyle->setLineVCChar(' ');
93	1		self::$borderless->borderStyle->setCrossingCChar(' ');
94			}
95
96	1		return clone self::$borderless;
97			}
98
99			/**
100			* A style that uses ASCII characters for drawing borders.
101			*
102			* @return TableStyle The style.
103			*/
104	16	View Code Duplication	public static function asciiBorder()
			0 ignored issues – show Duplication introduced 2015-12-16 14:17 UTC by Report Bug Copy Issue Report This method seems to be duplicated in your project. Duplicated code is one of the most pungent code smells. If you need to duplicate the same code in three or more different places, we strongly encourage you to look into extracting the code into a single class or operation. You can also find more detailed suggestions in the “Code” section of your repository. Loading history...
105			{
106	16		if (!self::$asciiBorder) {
107	1		self::$asciiBorder = new static();
108	1		self::$asciiBorder->headerCellFormat = ' %s ';
109	1		self::$asciiBorder->cellFormat = ' %s ';
110	1		self::$asciiBorder->borderStyle = BorderStyle::ascii();
111			}
112
113	16		return clone self::$asciiBorder;
114			}
115
116			/**
117			* A style that uses Unicode characters for drawing solid borders.
118			*
119			* @return TableStyle The style.
120			*/
121	1	View Code Duplication	public static function solidBorder()
			0 ignored issues – show Duplication introduced 2015-12-16 14:17 UTC by Report Bug Copy Issue Report This method seems to be duplicated in your project. Duplicated code is one of the most pungent code smells. If you need to duplicate the same code in three or more different places, we strongly encourage you to look into extracting the code into a single class or operation. You can also find more detailed suggestions in the “Code” section of your repository. Loading history...
122			{
123	1		if (!self::$solidBorder) {
124	1		self::$solidBorder = new static();
125	1		self::$solidBorder->headerCellFormat = ' %s ';
126	1		self::$solidBorder->cellFormat = ' %s ';
127	1		self::$solidBorder->borderStyle = BorderStyle::solid();
128			}
129
130	1		return clone self::$solidBorder;
131			}
132
133			/**
134			* Returns the character used to pad cells to the desired width.
135			*
136			* @return string The padding character.
137			*/
138	11		public function getPaddingChar()
139			{
140	11		return $this->paddingChar;
141			}
142
143			/**
144			* Sets the character used to pad cells to the desired width.
145			*
146			* @param string $char The padding character.
147			*
148			* @return static The current instance.
149			*/
150			public function setPaddingChar($char)
151			{
152			$this->paddingChar = $char;
153
154			return $this;
155			}
156
157			/**
158			* Returns the format string for rendering the header cells.
159			*
160			* @return string The format string. The string contains the substring "%s"
161			* where the cell content is inserted.
162			*/
163	11		public function getHeaderCellFormat()
164			{
165	11		return $this->headerCellFormat;
166			}
167
168			/**
169			* Sets the format string for rendering the header cells.
170			*
171			* @param string $format The format string. The string should contain the
172			* substring "%s" where the cell content is inserted.
173			*
174			* @return static The current instance.
175			*/
176			public function setHeaderCellFormat($format)
177			{
178			$this->headerCellFormat = $format;
179
180			return $this;
181			}
182
183			/**
184			* Returns the format string for rendering cells.
185			*
186			* @return string The format string. The string contains the substring "%s"
187			* where the cell content is inserted.
188			*/
189	11		public function getCellFormat()
190			{
191	11		return $this->cellFormat;
192			}
193
194			/**
195			* Sets the format string for rendering cells.
196			*
197			* @param string $format The format string. The string should contain the
198			* substring "%s" where the cell content is inserted.
199			*
200			* @return static The current instance.
201			*/
202			public function setCellFormat($format)
203			{
204			$this->cellFormat = $format;
205
206			return $this;
207			}
208
209			/**
210			* Returns the alignments of the table columns.
211			*
212			* @param int $nbColumns The number of alignments to return.
213			*
214			* @return int[] An array of {@link Alignment} constants indexed by the
215			* 0-based column keys.
216			*/
217	11		public function getColumnAlignments($nbColumns)
218			{
219	11		return array_slice(array_replace(
220	11		array_fill(0, $nbColumns, $this->defaultColumnAlignment),
221	11		$this->columnAlignments
222	11		), 0, $nbColumns);
223			}
224
225			/**
226			* Returns the alignment of a given column.
227			*
228			* @param int $column The 0-based column key.
229			*
230			* @return int The {@link Alignment} constant.
			0 ignored issues – show Documentation introduced 2015-12-16 14:17 UTC by Report Bug Copy Issue Report Should the return type not be `string`? This check compares the return type specified in the `@return` annotation of a function or method doc comment with the types returned by the function and raises an issue if they mismatch. Loading history...
231			*/
232			public function getColumnAlignment($column)
233			{
234			return isset($this->columnAlignments[$column])
235			? $this->columnAlignments[$column]
236			: $this->defaultColumnAlignment;
237			}
238
239			/**
240			* Sets the alignments of the table columns.
241			*
242			* @param int[] $alignments An array of {@link Alignment} constants indexed
243			* by the 0-based column keys.
244			*
245			* @return static The current instance.
246			*/
247			public function setColumnAlignments(array $alignments)
248			{
249			$this->columnAlignments = array();
			0 ignored issues – show Documentation Bug introduced 2015-12-16 14:17 UTC by Report Bug Copy Issue Report It seems like `array()` of type `array` is incompatible with the declared type `string` of property `$columnAlignments`. Our type inference engine has found an assignment to a property that is incompatible with the declared type of that property. Either this assignment is in error or the assigned type should be added to the documentation/type hint for that property.. Loading history...
250
251			foreach ($alignments as $column => $alignment) {
252			$this->setColumnAlignment($column, $alignment);
253			}
254
255			return $this;
256			}
257
258			/**
259			* Sets the alignment of a given column.
260			*
261			* @param int $column The 0-based column key.
262			* @param int $alignment The alignment.
263			*
264			* @return static The current instance.
265			*/
266	1		public function setColumnAlignment($column, $alignment)
267			{
268	1		Assert::oneOf($alignment, Alignment::all(), 'The column alignment must be one of the Alignment constants. Got: %s');
269
270	1		$this->columnAlignments[$column] = $alignment;
271
272	1		return $this;
273			}
274
275			/**
276			* Returns the default column alignment.
277			*
278			* @return int One of the {@link Alignment} constants.
			0 ignored issues – show Documentation introduced 2015-12-16 14:17 UTC by Report Bug Copy Issue Report Should the return type not be `string`? This check compares the return type specified in the `@return` annotation of a function or method doc comment with the types returned by the function and raises an issue if they mismatch. Loading history...
279			*/
280			public function getDefaultColumnAlignment()
281			{
282			return $this->defaultColumnAlignment;
283			}
284
285			/**
286			* Returns the default column alignment.
287			*
288			* @param int $alignment One of the {@link Alignment} constants.
289			*
290			* @return static The current instance.
291			*/
292			public function setDefaultColumnAlignment($alignment)
293			{
294			Assert::oneOf($alignment, Alignment::all(), 'The default column alignment must be one of the Alignment constants. Got: %s');
295
296			$this->defaultColumnAlignment = $alignment;
			0 ignored issues – show Documentation Bug introduced 2015-12-16 14:17 UTC by Report Bug Copy Issue Report The property `$defaultColumnAlignment` was declared of type `string`, but `$alignment` is of type `integer`. Maybe add a type cast? This check looks for assignments to scalar types that may be of the wrong type. To ensure the code behaves as expected, it may be a good idea to add an explicit type cast. $answer = 42; $correct = false; $correct = (bool) $answer; Loading history...
297
298			return $this;
299			}
300
301			/**
302			* Returns the border style.
303			*
304			* @return BorderStyle The border style.
305			*/
306	11		public function getBorderStyle()
307			{
308	11		return $this->borderStyle;
309			}
310
311			/**
312			* Sets the border style.
313			*
314			* @param BorderStyle $borderStyle The border style.
315			*
316			* @return static The current instance.
317			*/
318			public function setBorderStyle(BorderStyle $borderStyle)
319			{
320			$this->borderStyle = $borderStyle;
321
322			return $this;
323			}
324
325			/**
326			* Returns the style of the header cells.
327			*
328			* @return Style The header cell style.
329			*/
330	11		public function getHeaderCellStyle()
331			{
332	11		return $this->headerCellStyle;
333			}
334
335			/**
336			* Sets the style of the header cells.
337			*
338			* @param Style $style The header cell style.
			0 ignored issues – show Documentation introduced 2015-12-16 14:17 UTC by Report Bug Copy Issue Report Should the type for parameter `$style` not be `null\|Style`? This check looks for `@param` annotations where the type inferred by our type inference engine differs from the declared type. It makes a suggestion as to what type it considers more descriptive. Most often this is a case of a parameter that can be null in addition to its declared types. Loading history...
339			*
340			* @return static The current instance.
341			*/
342			public function setHeaderCellStyle(Style $style = null)
343			{
344			$this->headerCellStyle = $style;
345
346			return $this;
347			}
348
349			/**
350			* Returns the style of the table cells.
351			*
352			* @return Style The cell style.
353			*/
354	11		public function getCellStyle()
355			{
356	11		return $this->cellStyle;
357			}
358
359			/**
360			* Sets the style of the table cells.
361			*
362			* @param Style $style The cell style.
363			*
364			* @return static The current instance.
365			*/
366			public function setCellStyle(Style $style)
367			{
368			$this->cellStyle = $style;
369
370			return $this;
371			}
372			}
373

webmozart / console

TableStyle::getHeaderCellFormat() A last analyzed 2016-08-15 15:54 UTC

Complexity

Size

Duplication

Code Coverage

Importance

Duplication Side-by-Side

Filter issues like

TableStyle::getHeaderCellFormat() A
last analyzed 2016-08-15 15:54 UTC