kevintweber / Groundskeeper

src/Tokens/AbstractToken.php

<?php

namespace Groundskeeper\Tokens;

use Groundskeeper\Configuration;
use Psr\Log\LoggerInterface;

/**
 * A base class for all tokens.
 */
abstract class AbstractToken implements Token
{
    /** @var Configuration */
    protected $configuration;

    /** @var int */
    private $depth;

    /** @var int */
    private $line;

    /** @var null|Token */
    private $parent;

    /** @var int */
    private $position;

    /**
     * Constructor
     */
    public function __construct(Configuration $configuration, int $line, int $position)
    {
        $this->configuration = $configuration;
        $this->depth = 0;
        $this->line = $line;
        $this->parent = null;
        $this->position = $position;
    }

    /**
     * Required by the Token interface.
     */
    public function getDepth() : int
    {
        return $this->depth;
    }

    /**
     * Getter for 'line'.
     */
    public function getLine() : int
    {
        return $this->line;
    }

    /**
     * Required by the Token interface.
     */
    public function getParent()
    {
        return $this->parent;
    }

    /**
     * Chainable setter for 'parent'.
     */
    public function setParent(Token $parent = null)
    {
        $this->depth = 0;
        if ($parent instanceof Token) {
            $this->depth = $parent->getDepth() + 1;
        }

        $this->parent = $parent;
    }

    public function hasAncestor(Element $element) : bool
    {
        if ($this->parent === null) {
            return false;
        }

        if ($this->parent->getType() === Token::ELEMENT &&
            $this->parent->getName() === $element->getName()) {

It seems like you code against a concrete implementation and not the interface Groundskeeper\Tokens\Token as the method getName() does only exist in the following implementations of said interface: Groundskeeper\Tokens\Element, Groundskeeper\Tokens\ElementTypes\ClosedElement, Groundskeeper\Tokens\ElementTypes\OpenElement, Groundskeeper\Tokens\Elements\A, Groundskeeper\Tokens\Elements\Abbr, Groundskeeper\Tokens\Elements\Address, Groundskeeper\Tokens\Elements\Area, Groundskeeper\Tokens\Elements\Article, Groundskeeper\Tokens\Elements\Aside, Groundskeeper\Tokens\Elements\Audio, Groundskeeper\Tokens\Elements\B, Groundskeeper\Tokens\Elements\Base, Groundskeeper\Tokens\Elements\Bdi, Groundskeeper\Tokens\Elements\Bdo, Groundskeeper\Tokens\Elements\Blockquote, Groundskeeper\Tokens\Elements\Body, Groundskeeper\Tokens\Elements\Br, Groundskeeper\Tokens\Elements\Button, Groundskeeper\Tokens\Elements\Canvas, Groundskeeper\Tokens\Elements\Caption, Groundskeeper\Tokens\Elements\Cite, Groundskeeper\Tokens\Elements\Code, Groundskeeper\Tokens\Elements\Col, Groundskeeper\Tokens\Elements\Colgroup, Groundskeeper\Tokens\Elements\Data, Groundskeeper\Tokens\Elements\Datalist, Groundskeeper\Tokens\Elements\Dd, Groundskeeper\Tokens\Elements\Del, Groundskeeper\Tokens\Elements\Details, Groundskeeper\Tokens\Elements\Dfn, Groundskeeper\Tokens\Elements\Dialog, Groundskeeper\Tokens\Elements\Div, Groundskeeper\Tokens\Elements\Dl, Groundskeeper\Tokens\Elements\Dt, Groundskeeper\Tokens\Elements\Em, Groundskeeper\Tokens\Elements\Embed, Groundskeeper\Tokens\Elements\Fieldset, Groundskeeper\Tokens\Elements\Figcaption, Groundskeeper\Tokens\Elements\Figure, Groundskeeper\Tokens\Elements\Footer, Groundskeeper\Tokens\Elements\Form, Groundskeeper\Tokens\Elements\H1, Groundskeeper\Tokens\Elements\H2, Groundskeeper\Tokens\Elements\H3, Groundskeeper\Tokens\Elements\H4, Groundskeeper\Tokens\Elements\H5, Groundskeeper\Tokens\Elements\H6, Groundskeeper\Tokens\Elements\Head, Groundskeeper\Tokens\Elements\Header, Groundskeeper\Tokens\Elements\Hgroup, Groundskeeper\Tokens\Elements\Hr, Groundskeeper\Tokens\Elements\Html, Groundskeeper\Tokens\Elements\I, Groundskeeper\Tokens\Elements\Iframe, Groundskeeper\Tokens\Elements\Img, Groundskeeper\Tokens\Elements\Input, Groundskeeper\Tokens\Elements\Ins, Groundskeeper\Tokens\Elements\Kbd, Groundskeeper\Tokens\Elements\Label, Groundskeeper\Tokens\Elements\Legend, Groundskeeper\Tokens\Elements\Li, Groundskeeper\Tokens\Elements\Link, Groundskeeper\Tokens\Elements\Main, Groundskeeper\Tokens\Elements\Map, Groundskeeper\Tokens\Elements\Mark, Groundskeeper\Tokens\Elements\Menu, Groundskeeper\Tokens\Elements\Menuitem, Groundskeeper\Tokens\Elements\Meta, Groundskeeper\Tokens\Elements\Meter, Groundskeeper\Tokens\Elements\Nav, Groundskeeper\Tokens\Elements\Noscript, Groundskeeper\Tokens\Elements\Object, Groundskeeper\Tokens\Elements\Ol, Groundskeeper\Tokens\Elements\Optgroup, Groundskeeper\Tokens\Elements\Option, Groundskeeper\Tokens\Elements\Output, Groundskeeper\Tokens\Elements\P, Groundskeeper\Tokens\Elements\Param, Groundskeeper\Tokens\Elements\Picture, Groundskeeper\Tokens\Elements\Pre, Groundskeeper\Tokens\Elements\Progress, Groundskeeper\Tokens\Elements\Q, Groundskeeper\Tokens\Elements\Rp, Groundskeeper\Tokens\Elements\Rt, Groundskeeper\Tokens\Elements\Ruby, Groundskeeper\Tokens\Elements\S, Groundskeeper\Tokens\Elements\Samp, Groundskeeper\Tokens\Elements\Script, Groundskeeper\Tokens\Elements\Section, Groundskeeper\Tokens\Elements\Select, Groundskeeper\Tokens\Elements\Slot, Groundskeeper\Tokens\Elements\Small, Groundskeeper\Tokens\Elements\Source, Groundskeeper\Tokens\Elements\Span, Groundskeeper\Tokens\Elements\Strong, Groundskeeper\Tokens\Elements\Style, Groundskeeper\Tokens\Elements\Sub, Groundskeeper\Tokens\Elements\Summary, Groundskeeper\Tokens\Elements\Sup, Groundskeeper\Tokens\Elements\Table, Groundskeeper\Tokens\Elements\Tbody, Groundskeeper\Tokens\Elements\Td, Groundskeeper\Tokens\Elements\Template, Groundskeeper\Tokens\Elements\Textarea, Groundskeeper\Tokens\Elements\Tfoot, Groundskeeper\Tokens\Elements\Th, Groundskeeper\Tokens\Elements\Thead, Groundskeeper\Tokens\Elements\Time, Groundskeeper\Tokens\Elements\Title, Groundskeeper\Tokens\Elements\Tr, Groundskeeper\Tokens\Elements\Track, Groundskeeper\Tokens\Elements\U, Groundskeeper\Tokens\Elements\Ul, Groundskeeper\Tokens\Elements\VarElement, Groundskeeper\Tokens\Elements\Video, Groundskeeper\Tokens\Elements\Wbr.

            return true;
        }

        return $this->parent->hasAncestor($element);
    }

    /**
     * Getter for 'position'.
     */
    public function getPosition() : int
    {
        return $this->position;
    }

    public static function cleanChildTokens(Configuration $configuration, array &$children, LoggerInterface $logger)
    {
        if ($configuration->get('clean-strategy') === Configuration::CLEAN_STRATEGY_NONE) {
            return true;
        }

        foreach ($children as $key => $child) {
            if ($child instanceof Cleanable) {
                $isClean = $child->clean($logger);
                if (!$isClean && $configuration->get('clean-strategy') !== Configuration::CLEAN_STRATEGY_LENIENT) {
                    unset($children[$key]);
                }
            }
        }

        return true;
    }

    abstract public function getType() : string;

    public function __toString()
    {
        return ucfirst($this->getType()) . ' (line: ' . $this->line .
            '; position: ' . $this->position . ')';
    }
}