Mailcode\Mailcode_Commands_Command_ShowSnippet

Complexity

Total Complexity

11

Size/Duplication

Total Lines	95
Duplicated Lines	0 %

Importance

Changes	1
Bugs	0	Features	0

9 Methods

Rating	Name	Duplication	Size	Complexity
A	supportsType()	0	3	1
A	getName()	0	3	1
A	getLabel()	0	3	1
A	getValidations()	0	3	1
A	validateSyntax_require_variable()	0	14	2
A	requiresParameters()	0	3	1
A	getVariable()	0	13	2
A	generatesContent()	0	3	1
A	getVariableName()	0	3	1

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

declare(strict_types=1);

namespace Mailcode;

/**
 * Mailcode command: show a variable value.
 *
 * @package Mailcode
 * @subpackage Commands
 * @author Sebastian Mordziol <s.mordziol@mistralys.eu>
 */
class Mailcode_Commands_Command_ShowSnippet extends Mailcode_Commands_Command_Type_Standalone
{
    const ERROR_NO_VARIABLE_AVAILABLE = 51901;
    
    const VALIDATION_VARIABLE_COUNT_MISMATCH = 52001;
    
   /**
    * @var Mailcode_Variables_Variable|NULL
    */
    protected $variable;
    
    public function getName() : string
    {
        return 'showsnippet';
    }
    
    public function getLabel() : string
    {
        return t('Show text snippet');
    }
    
    public function supportsType(): bool
    {
        return false;
    }

    public function requiresParameters(): bool
    {
        return true;
    }
    
   /**
    * Retrieves the variable to show.
    * 
    * NOTE: Only available once the command has been
    * validated. Always use isValid() first.
    * 
    * @throws Mailcode_Exception
    * @return Mailcode_Variables_Variable
    */
    public function getVariable() : Mailcode_Variables_Variable
    {
        $this->validate();
        
        if(isset($this->variable))
        {
            return $this->variable;

The expression return $this->variable could return the type null which is incompatible with the type-hinted return Mailcode\Mailcode_Variables_Variable. Consider adding an additional type-check to rule them out.

        }
        
        throw new Mailcode_Exception(
            'No variable available.',
            'No variable is present at this time, or the validation failed.',
            self::ERROR_NO_VARIABLE_AVAILABLE
        );
    }
    
   /**
    * Retrieves the full name of the variable to show.
    * 
    * NOTE: Only available once the command has been
    * validated. Always use isValid() first.
    * 
    * @throws Mailcode_Exception
    * @return string
    */
    public function getVariableName() : string
    {
        return $this->getVariable()->getFullName();
    }

    protected function validateSyntax_require_variable() : void
    {
         $vars = $this->getVariables()->getGroupedByName();
         $amount = count($vars);
         
         if($amount === 1)
         {
             $this->variable = array_pop($vars);
             return;
         }
         
         $this->validationResult->makeError(
            t('Command has %1$s variables, %2$s expected.', $amount, 1),
            self::VALIDATION_VARIABLE_COUNT_MISMATCH
         );
    }
    
    protected function getValidations() : array
    {
        return array('require_variable');
    }
    
    public function generatesContent() : bool
    {
        return true;
    }
}