Mailcode\Mailcode_Commands_Command_Mono

Complexity

Total Complexity

24

Size/Duplication

Total Lines	143
Duplicated Lines	0 %

Importance

Changes	1
Bugs	0	Features	0

15 Methods

Rating	Name	Duplication	Size	Complexity
A	generatesContent()	0	3	1
A	addClass()	0	22	3
A	renderAttributes()	0	7	2
A	supportsURLEncoding()	0	3	1
A	getDefaultType()	0	3	1
A	preProcessClosing()	0	7	2
A	getName()	0	3	1
A	preProcessOpening()	0	7	2
A	validateSyntax_class()	0	14	4
A	getLabel()	0	3	1
A	supportsType()	0	3	1
A	requiresParameters()	0	3	1
A	getValidations()	0	5	1
A	isClassNameValid()	0	5	2
A	supportsLogicKeywords()	0	3	1

<?php
/**
 * File containing the {@see \Mailcode\Mailcode_Commands_Command_Mono} class.
 *
 * @package Mailcode
 * @subpackage Commands
 * @see \Mailcode\Mailcode_Commands_Command_Mono
 */

declare(strict_types=1);

namespace Mailcode;

use AppUtils\ConvertHelper;

/**
 * Mailcode command: opening CODE statement.
 *
 * @package Mailcode
 * @subpackage Commands
 * @author Sebastian Mordziol <s.mordziol@mistralys.eu>
 */
class Mailcode_Commands_Command_Mono
    extends Mailcode_Commands_Command
    implements
        Mailcode_Commands_Command_Type_Opening,
        Mailcode_Interfaces_Commands_Multiline,
        Mailcode_Interfaces_Commands_PreProcessing
{
    use Mailcode_Traits_Commands_Validation_Multiline;
    use Mailcode_Traits_Commands_Type_Opening;

    const ERROR_INVALID_CSS_CLASS_NAME = 82201;

    /**
     * @var string[]
     */
    protected $classes = array();

    public function getName() : string
    {
        return 'mono';
    }
    
    public function getLabel() : string
    {
        return t('Format text as monospaced');
    }
    
    public function supportsType(): bool
    {
        return false;
    }

    public function supportsURLEncoding() : bool
    {
        return false;
    }

    public function getDefaultType() : string
    {
        return '';
    }
    
    public function requiresParameters(): bool
    {
        return false;
    }
    
    public function supportsLogicKeywords() : bool
    {
        return false;
    }
    
    protected function getValidations() : array
    {
        return array(
            'multiline',
            'class'
        );
    }

    protected function validateSyntax_class(): void
    {
        $literals = $this->params->getInfo()->getStringLiterals();

        if(empty($literals)) {
            return;
        }

        foreach($literals as $literal)
        {
            $parts = ConvertHelper::explodeTrim(' ', $literal->getText());

            foreach($parts as $part) {
                $this->addClass($part);
            }
        }
    }

    /**
     * @param string $className
     * @return bool
     */
    public function addClass(string $className) : bool
    {
        $className = trim($className);

        if($this->isClassNameValid($className))
        {
            if(!in_array($className, $this->classes)) {
                $this->classes[] = $className;
            }

            return true;
        }

        $this->validationResult->makeError(
            t('%1$s is not a valid CSS class name.', $className).' '.
            t('Allowed characters:').' '.
            t('Upper and lowercase letters, digits, underscores (_) and hyphens (-).').' '.
            t('May not start with a digit, two hyphens, or a hyphen followed by a digit.'),
            self::ERROR_INVALID_CSS_CLASS_NAME
        );

        return false;
    }

    public function isClassNameValid(string $className) : bool
    {
        $result = preg_match('/\A[a-z_][a-z0-9_][-_a-z0-9]+\Z/si', $className);

        return $result !== false && $result > 0;
    }

    public function generatesContent() : bool
    {
        return true;
    }

    public function preProcessOpening(): string
    {
        if($this->isMultiline()) {
            return sprintf('<pre%s>', $this->renderAttributes());
        }

        return sprintf('<code%s>', $this->renderAttributes());
    }

    public function preProcessClosing(): string
    {
        if($this->isMultiline()) {
            return '</pre>';
        }

        return '</code>';
    }

    private function renderAttributes() : string
    {
        if(empty($this->classes)) {
            return '';
        }

        return sprintf(' class="%s"', implode(' ', $this->classes));
    }
}