Mailcode\Mailcode_Parser_Statement

Complexity

Total Complexity

12

Size/Duplication

Total Lines	111
Duplicated Lines	0 %

Importance

Changes	4
Bugs	0	Features	0

8 Methods

Rating	Name	Duplication	Size	Complexity
A	getSourceCommand()	0	3	1
A	getValidationResult()	0	3	1
A	getNormalized()	0	3	1
A	getStatementString()	0	3	1
A	__construct()	0	9	1
A	getInfo()	0	10	2
A	isValid()	0	5	1
A	validate()	0	24	4

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

declare(strict_types=1);

namespace Mailcode;

use AppUtils\OperationResult;

/**
 * Mailcode statement parser: parses arbitrary statements
 * to check for validation issues.
 *
 * @package Mailcode
 * @subpackage Parser
 * @author Sebastian Mordziol <s.mordziol@mistralys.eu>
 */
class Mailcode_Parser_Statement
{
    const VALIDATION_EMPTY = 48801;
    const VALIDATION_UNQUOTED_STRING_LITERALS = 48802;
    
   /**
    * @var string
    */
    protected $statement;
    
   /**
    * @var OperationResult
    */
    protected $result;
    
   /**
    * @var Mailcode_Parser_Statement_Tokenizer
    */
    protected $tokenizer;
    
   /**
    * @var Mailcode_Parser_Statement_Info|NULL
    */
    protected $info;

    /**
     * @var bool
     */
    protected $freeform = false;

    /**
     * @var Mailcode_Commands_Command|null
     */
    private $sourceCommand;

    public function __construct(string $statement, bool $freeform=false, ?Mailcode_Commands_Command $sourceCommand=null)
    {
        $this->sourceCommand = $sourceCommand;
        $this->statement = $statement;
        $this->result = new OperationResult($this);
        $this->tokenizer = new Mailcode_Parser_Statement_Tokenizer($this);
        $this->freeform = $freeform;

        $this->validate();
    }

    public function getSourceCommand() : ?Mailcode_Commands_Command
    {
        return $this->sourceCommand;
    }

    public function getStatementString() : string
    {
        return $this->statement;
    }
    
    public function isValid() : bool
    {
        $this->validate();

        return $this->result->isValid();
    }
    
    public function getValidationResult() : OperationResult
    {
        return $this->result;
    }
    
    public function getInfo() : Mailcode_Parser_Statement_Info
    {
        if($this->info instanceof Mailcode_Parser_Statement_Info)
        {
            return $this->info; 
        }
        
        $this->info = new Mailcode_Parser_Statement_Info($this->tokenizer);
        
        return $this->info;
    }
    
    protected function validate() : void
    {
        if($this->freeform)
        {
            return;
        }

        if(!$this->tokenizer->hasTokens())
        {
            $this->result->makeError(
                t('Empty statement'),
                self::VALIDATION_EMPTY
            );
            
            return;
        }
        
        $unknown = $this->tokenizer->getFirstUnknown();
        
        if($unknown)
        {
            $this->result->makeError(
               t('Unquoted string literal found:').' ('.htmlspecialchars($unknown->getMatchedText()).')',
                self::VALIDATION_UNQUOTED_STRING_LITERALS
            );
        }
    }
    
    public function getNormalized() : string
    {
        return $this->tokenizer->getNormalized();
    }
}