RunOpenCode\Sax\Handler\AbstractStackedSaxHandler

Complexity

Total Complexity

6

Size/Duplication

Total Lines	73
Duplicated Lines	0 %

Coupling/Cohesion

Components	1
Dependencies	1

Test Coverage

Coverage

100%

Importance

Changes

0

7 Methods

Rating	Name	Duplication	Size	Complexity
A	onElementStart()	0	5	1
A	onElementEnd()	0	5	1
A	getCurrentElementName()	0	4	2
A	getStack()	0	4	1
A	getStackSize()	0	4	1
	handleOnElementStart()	0	1	?
	handleOnElementEnd()	0	1	?

<?php
/*
 * This file is part of the runopencode/sax, an RunOpenCode project.
 *
 * (c) 2017 RunOpenCode
 *
 * For the full copyright and license information, please view the LICENSE
 * file that was distributed with this source code.
 */
namespace RunOpenCode\Sax\Handler;

/**
 * Class AbstractStackedSaxHandler
 *
 * Sax handler prototype with implemented elements stack.
 *
 * @package RunOpenCode\Sax\Handler
 */
abstract class AbstractStackedSaxHandler extends AbstractSaxHandler
{
    /**
     * @var array Elements stack
     */
    private $stack = [];

    /**
     * {@inheritdoc}
     */
    protected function onElementStart($parser, $name, $attributes)
    {
        array_push($this->stack, $name);
        $this->handleOnElementStart($parser, $name, $attributes);
    }

    /**
     * {@inheritdoc}
     */
    protected function onElementEnd($parser, $name)
    {
        array_pop($this->stack);
        $this->handleOnElementEnd($parser, $name);
    }

    /**
     * Get current processing element name (uppercase), or null, if there is no element on stack
     * (processing didn't started or it is ended)
     *
     * @return string|null
     */
    protected function getCurrentElementName()
    {
        return (($count = count($this->stack)) > 0) ? $this->stack[$count-1] : null;
    }

    /**
     * Get current stack trace.
     *
     * @return array
     */
    protected function getStack()
    {
        return $this->stack;
    }

    /**
     * Get current element stack size
     *
     * @return int
     */
    protected function getStackSize()
    {
        return count($this->stack);
    }

    /**
     * Element start handler, executed when XML tag is entered.
     *
     * @param resource $parser Parser handler.
     * @param string $name Tag name.
     * @param array $attributes Element attributes.
     */
    abstract protected function handleOnElementStart($parser, $name, $attributes);

    /**
     * Element end handler, executed when XML tag is leaved.
     *
     * @param resource $parser Parser handler.
     * @param string $name Tag name.
     */
    abstract protected function handleOnElementEnd($parser, $name);
}