JMS\Serializer\Type\Compiler\Llk\Rule\Invocation

Complexity

Total Complexity

7

Size/Duplication

Total Lines	116
Duplicated Lines	0 %

Importance

Changes	1
Bugs	0	Features	0

7 Methods

Rating	Name	Duplication	Size	Complexity
A	setDepth()	0	6	1
A	getRule()	0	3	1
A	isTransitional()	0	3	1
A	__construct()	0	13	1
A	getDepth()	0	3	1
A	getTodo()	0	3	1
A	getData()	0	3	1

<?php

declare(strict_types=1);

/**
 * Hoa
 *
 *
 *
 *
 * BSD 3-Clause License
 *
 * Copyright © 2007-2017, Hoa community. All rights reserved.
 *
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions are met:
 *
 * 1. Redistributions of source code must retain the above copyright notice, this
 *    list of conditions and the following disclaimer.
 *
 * 2. Redistributions in binary form must reproduce the above copyright notice,
 *    this list of conditions and the following disclaimer in the documentation
 *    and/or other materials provided with the distribution.
 *
 * 3. Neither the name of the copyright holder nor the names of its
 *    contributors may be used to endorse or promote products derived from
 *    this software without specific prior written permission.
 *
 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
 * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
 * DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE
 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
 * SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
 * CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
 * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
 * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
 */

namespace JMS\Serializer\Type\Compiler\Llk\Rule;

/**
 * Class \JMS\Serializer\Type\Compiler\Llk\Rule\Invocation.
 *
 * Parent of entry and ekzit rules.
 */
abstract class Invocation
{
    /**
     * Rule.
     *
     * @var string|null
     */
    protected $_rule         = null;

    /**
     * Data.
     *
     * @var mixed
     */
    protected $_data         = null;

    /**
     * Piece of todo sequence.
     *
     * @var array|null
     */
    protected $_todo         = null;

    /**
     * Depth in the trace.
     *
     * @var int
     */
    protected $_depth        = -1;

    /**
     * Whether the rule is transitional or not (i.e. not declared in the grammar
     * but created by the analyzer).
     *
     * @var bool
     */
    protected $_transitional = false;

    /**
     * @param   string|int  $rule  Rule name.
     * @param   mixed   $data  Data.
     * @param   array   $todo  Todo.
     * @param   int     $depth Depth.
     */
    public function __construct(
        $rule,
        $data,
        ?array $todo = null,
        $depth = -1
    ) {
        $this->_rule         = $rule;
        $this->_data         = $data;
        $this->_todo         = $todo;
        $this->_depth        = $depth;
        $this->_transitional = \is_int($rule);

        return;
    }

    /**
     * Get rule name.
     *
     * @return string|int
     */
    public function getRule()
    {
        return $this->_rule;
    }

    /**
     * Get data.
     *
     * @return  mixed
     */
    public function getData()
    {
        return $this->_data;
    }

    /**
     * Get todo sequence.
     *
     * @return  array
     */
    public function getTodo(): array
    {
        return $this->_todo;

The expression return $this->_todo could return the type null which is incompatible with the type-hinted return array. Consider adding an additional type-check to rule them out.

    }

    /**
     * Set depth in trace.
     *
     * @param   int  $depth Depth.
     */
    public function setDepth(int $depth): int
    {
        $old          = $this->_depth;
        $this->_depth = $depth;

        return $old;
    }

    /**
     * Get depth in trace.
     */
    public function getDepth(): int
    {
        return $this->_depth;
    }

    /**
     * Check whether the rule is transitional or not.
     */
    public function isTransitional(): bool
    {
        return $this->_transitional;
    }
}