Mailcode_Parser_Safeguard_Formatter_HTMLHighlighting_Location

Complexity

Total Complexity

16

Size/Duplication

Total Lines	128
Duplicated Lines	0 %

Importance

Changes	1
Bugs	0	Features	0

7 Methods

Rating	Name	Duplication	Size	Complexity
A	getParentTags()	0	20	3
A	getAdjustedText()	0	3	1
A	init()	0	9	1
A	isInExcludedTag()	0	13	3
A	requiresAdjustment()	0	8	3
A	getHaystackBefore()	0	17	2
A	isInTagAttributes()	0	13	3

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

declare(strict_types=1);

namespace Mailcode;

/**
 * Detects whether the placeholder location can be highlighted or not.
 *
 * @package Mailcode
 * @subpackage Parser
 * @author Sebastian Mordziol <s.mordziol@mistralys.eu>
 * 
 * @property Mailcode_Parser_Safeguard_Formatter_HTMLHighlighting $formatter
 */
class Mailcode_Parser_Safeguard_Formatter_HTMLHighlighting_Location extends Mailcode_Parser_Safeguard_FormatterLocation
{
    const COMMAND_MARKER = '__MAILCODE_COMMAND__';
    
   /**
    * @var array<int,array<int,string>>
    */
    private $tagAncestry;
    
    protected function init() : void
    {
        $haystack = $this->getHaystackBefore();
        
        // Get a list of all HTML tags before the command, opening and closing.
        $matches = array();
        preg_match_all('%<\s*(/?)\s*([a-z][a-z0-9]*)\s*([^<>]*)>%ix', $haystack, $matches, PREG_PATTERN_ORDER);
        
        $this->tagAncestry = $matches;
    }
    
    protected function getAdjustedText(): string
    {
        return '<mailcode:highlight>'.$this->location->getPlaceholderString().'</mailcode:highlight>';
    }

    public function requiresAdjustment(): bool
    {
        if($this->isInTagAttributes() || $this->isInExcludedTag()) 
        {
           return false; 
        }
        
        return true;
    }
    
   /**
    * Retrieves the part of the subject string that comes
    * before the command.
    * 
    * @return string
    */
    private function getHaystackBefore() : string
    {
        $pos = $this->location->getStartPosition();
        
        // at the beginning of the document? Sure, we can highlight this.
        if($pos === 0)
        {
            return '';
        }
        
        $subject = $this->location->getSubjectString();
        
        // We add a command marker and a closing tag bracket,
        // so that is the command is in a tag's attributes,
        // the tags ancestry can detect the tag as a parent 
        // tag, including the marker in the attributes string.
        return mb_substr($subject, 0, $pos).self::COMMAND_MARKER.'>';
    }
    
   /**
    * Whether the command is nested in one of the tags
    * that have been added to the list of excluded tags.
    * 
    * @return bool
    */
    private function isInExcludedTag() : bool
    {
        $tagNames = $this->getParentTags();
        
        foreach($tagNames as $tagName)
        {
            if($this->formatter->isTagExcluded($tagName))
            {
                return true;
            }
        }
        
        return false;
    }
    
   /**
    * Retrieves a list of the command's parent HTML tags, from
    * highest to lowest.
    * 
    * @return string[]
    */
    private function getParentTags() : array
    {
        // Create a stack of all direct parent tags of the command.
        // Handles closing tags as well.
        $stack = array();
        foreach($this->tagAncestry[2] as $idx => $tagName)
        {
            $closing = $this->tagAncestry[1][$idx] === '/';
            
            if($closing)
            {
                array_pop($stack);
            }
            else
            {
                $stack[] = $tagName;
            }
        }
        
        return $stack;
    }
    
   /**
    * Checks whether the command is located within the attributes
    * of an HTML tag.
    * 
    * @return bool
    */
    private function isInTagAttributes() : bool
    {
        // This check is easy: if the command is in the attribute
        // of any of the tags, we will find the command marker in there.
        foreach($this->tagAncestry[3] as $attributes)
        {
            if(strstr($attributes, self::COMMAND_MARKER))
            {
                return true;
            }
        }
        
        return false;
    }
}