Matks\Vivian\Output\EscapeAttribute

Complexity

Total Complexity

5

Size/Duplication

Total Lines	62
Duplicated Lines	0 %

Coupling/Cohesion

Components	1
Dependencies	0

Test Coverage

Coverage

88.89%

Importance

Changes	3
Bugs	1	Features	0

5 Methods

Rating	Name	Duplication	Size	Complexity
A	__construct()	0	9	2
A	getEscapeCharacter()	0	4	1
A	equals()	0	4	1
A	buildEscapeCharacter()	0	6	1
	getAllowedEscapeCodes()	0	1	?

<?php

namespace Matks\Vivian\Output;

use Exception;

/**
 * ANSI/VT100 Escape attribute
 */
abstract class EscapeAttribute
{
    const ANSI_ESCAPE_CODE_BEGIN = "\033[";
    const ANSI_ESCAPE_CODE_END   = 'm';

    /**
     * @var string
     */
    private $escapeCharacter;

    /**
     * @param string $code
     */
    public function __construct($code)
    {
        if (!in_array($code, $this->getAllowedEscapeCodes())) {
            throw new Exception("Forbidden code $code");
        }

        $escapeCharacter       = $this->buildEscapeCharacter($code);
        $this->escapeCharacter = $escapeCharacter;
    }

    /**
     * @return string
     */
    public function getEscapeCharacter()
    {
        return $this->escapeCharacter;
    }

    /**
     * @param EscapeAttribute $escapeAttribute
     *
     * @return bool
     */
    public function equals(EscapeAttribute $escapeAttribute)
    {
        return ($escapeAttribute->getEscapeCharacter() === $this->getEscapeCharacter());
    }

    /**
     * Build escape character to be print
     *
     * @param string $escapeCode
     *
     * @return string
     */
    protected function buildEscapeCharacter($escapeCode)
    {
        $result = static::ANSI_ESCAPE_CODE_BEGIN . $escapeCode . static::ANSI_ESCAPE_CODE_END;

        return $result;
    }

    /**
     * Get allowed escape codes
     *
     * @return string[]
     */
    abstract protected function getAllowedEscapeCodes();
}