Mailcode_Commands_Command_Code::getValidations() - Code Metrics - Inspection of "Added changes." - Mistralys/mailcode - Measure and Improve Code Quality continuously with Scrutinizer

Test Failed

Retried Inspection

Push — master ( 36c5b6...af11e6 )

by Sebastian

created 2022-02-24 11:12 UTC

Mailcode_Commands_Command_Code::getValidations() A

↳ Parent: Mailcode_Commands_Command_Code

Complexity

Conditions	1
Paths	1

Size

Total Lines	6
Code Lines	4

Duplication

Lines	0
Ratio	0 %

Importance

Changes	2
Bugs	0	Features	0

Metric	Value
cc	1
eloc	4
c	2
b	0
f	0
nc	1
nop	0
dl	0
loc	6
rs	10

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

declare(strict_types=1);

namespace Mailcode;

/**
 * Mailcode command: opening CODE statement.
 *
 * @package Mailcode
 * @subpackage Commands
 * @author Sebastian Mordziol <[email protected]>
 */
class Mailcode_Commands_Command_Code
    extends Mailcode_Commands_Command
    implements
        Mailcode_Commands_Command_Type_Standalone,
        Mailcode_Interfaces_Commands_ProtectedContent
{
    use Mailcode_Traits_Commands_ProtectedContent;

    public const ERROR_LANG_TOKEN_MISSING = 73101;

    public const VALIDATION_LANGUAGE_NOT_SPECIFIED = 72901;
    public const VALIDATION_UNKNOWN_LANGUAGE = 72902;

    /**
     * @var Mailcode_Parser_Statement_Tokenizer_Token_StringLiteral|NULL
     */
    private ?Mailcode_Parser_Statement_Tokenizer_Token_StringLiteral $langToken = null;

    public function getName() : string
    {
        return 'code';
    }
    
    public function getLabel() : string
    {
        return t('Raw backend code');
    }
    
    public function supportsType(): bool
    {
        return false;
    }

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

    public function getDefaultType() : string
    {
        return '';
    }
    
    public function requiresParameters(): bool
    {
        return true;
    }
    
    public function supportsLogicKeywords() : bool
    {
        return false;
    }
    
    protected function getValidations() : array
    {
        return array(
            Mailcode_Interfaces_Commands_ProtectedContent::VALIDATION_NAME_CONTENT_ID,
            'token',
            'language'
        );
    }
    
    public function generatesContent() : bool
    {
        return true;
    }

    // region: Supported syntaxes

    public const SYNTAX_APACHE_VELOCITY = 'ApacheVelocity';
    public const SYNTAX_MAILCODE = 'Mailcode';

    /**
     * @return string[]
     */
    public static function getSupportedSyntaxes() : array
    {
        return array(
            self::SYNTAX_APACHE_VELOCITY,
            self::SYNTAX_MAILCODE
        );
    }

    /**
     * Retrieves the name of the syntax that the code is written in.
     *
     * @return string
     * @throws Mailcode_Exception If the command has no language parameter.
     *
     * @see Mailcode_Commands_Command_Code::ERROR_LANG_TOKEN_MISSING
     */
    public function getSyntaxName() : string
    {
        if(isset($this->langToken))
        {
            return $this->langToken->getText();
            return $this->langToken->/** @scrutinizer ignore-call */ getText();
        }

        throw new Mailcode_Exception(
            'No language name available',
            'The command has no lang token.',
            self::ERROR_LANG_TOKEN_MISSING
        );
    }

    // endregion

    /**
     * Ensures that the language token is present.
     */
    protected function validateSyntax_token() : void
    {
        $lang = $this->requireParams()
            ->getInfo()
            ->getStringLiteralByIndex(1);

        if($lang)
        {
            $this->langToken = $lang;
            return;
        }

        $translator = new Mailcode_Translator();

        $this->validationResult->makeError(
            t('The target language has to be specified in the first parameter of the command.').' '.
            t('Possible values are:').' '.
            '<code>'.implode('</code>, <code>', $translator->getSyntaxNames()).'</code>',
            self::VALIDATION_LANGUAGE_NOT_SPECIFIED
        );
    }

    /**
     * Ensures that the syntax specified in the language token
     * is a valid translator syntax name.
     */
    protected function validateSyntax_language() : void
    {
        // To keep PHPStan happy. If no token has been found, this
        // method will not be called.
        if(!isset($this->langToken))
        {
            return;
        }

        $name = $this->langToken->getText();
        $supported = self::getSupportedSyntaxes();

        if(in_array($name, $supported))
        {
            return;
        }

        $this->validationResult->makeError(
            t('The language %1$s does not exist.', '<code>'.$name.'</code>').' '.
            t('Possible values are:').' '.
            '<code>'.implode('</code>, <code>', $supported).'</code>',
            self::VALIDATION_UNKNOWN_LANGUAGE
        );
    }
}


Mistralys / mailcode

Push — master ( 36c5b6...af11e6 )

Mailcode_Commands_Command_Code::getValidations() A

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like