Passed
Push — master ( 1515ff...7c0b30 )
by Sebastian
04:21
created

getVariableName()   A

Complexity

Conditions 1
Paths 1

Size

Total Lines 3
Code Lines 1

Duplication

Lines 0
Ratio 0 %

Importance

Changes 1
Bugs 0 Features 0
Metric Value
cc 1
eloc 1
c 1
b 0
f 0
nc 1
nop 0
dl 0
loc 3
rs 10
1
<?php
2
/**
3
 * File containing the {@see Mailcode_Traits_Commands_Validation_Variable} trait.
4
 *
5
 * @package Mailcode
6
 * @subpackage Validation
7
 * @see Mailcode_Traits_Commands_Validation_Variable
8
 */
9
10
declare(strict_types=1);
11
12
namespace Mailcode;
13
14
/**
15
 * Command validation drop-in: checks for the presence
16
 * of a variable name. Will accept the first variable 
17
 * it finds.
18
 *
19
 * @package Mailcode
20
 * @subpackage Validation
21
 * @author Sebastian Mordziol <[email protected]>
22
 *
23
 * @property Mailcode_Parser_Statement_Validator $validator
24
 */
25
trait Mailcode_Traits_Commands_Validation_Variable
26
{
27
   /**
28
    * @var Mailcode_Parser_Statement_Tokenizer_Token_Variable|NULL
29
    */
30
    protected $variableToken;
31
    
32
    protected function validateSyntax_variable() : void
33
    {
34
        $var = $this->validator->createVariable();
35
        
36
        if($var->isValid())
37
        {
38
            $this->variableToken = $var->getToken();
39
        }
40
        else
41
        {
42
            $this->validationResult->makeError(
43
                t('No variable has been specified.'),
44
                Mailcode_Commands_CommonConstants::VALIDATION_VARIABLE_MISSING
45
            );
46
        }
47
    }
48
    
49
   /**
50
    * Retrieves the variable being compared.
51
    *
52
    * @return Mailcode_Variables_Variable
53
    */
54
    public function getVariable() : Mailcode_Variables_Variable
55
    {
56
        if($this->variableToken instanceof Mailcode_Parser_Statement_Tokenizer_Token_Variable)
57
        {
58
            return $this->variableToken->getVariable();
59
        }
60
        
61
        throw new Mailcode_Exception(
62
            'No variable available',
63
            null,
64
            Mailcode_Commands_CommonConstants::ERROR_NO_VARIABLE_AVAILABLE
65
        );
66
    }
67
    
68
    public function getVariableName() : string
69
    {
70
        return $this->getVariable()->getFullName();
71
    }
72
}
73