Dhii/iterator-abstract

Avoid using short method names like IteratorTrait::__(). The configured minimum method name length is 3.

Open

    abstract protected function __($string, $args = [], $context = null);

• Read up
  Read up
• Exclude checks
  • Disable engine
  • Disable check

class ShortMethod {
    public function a( $index ) { // Violation
    }
}

Avoid using short method names like IteratorIteratorTrait::__(). The configured minimum method name length is 3.

Open

    abstract protected function __($string, $args = [], $context = null);

• Read up
  Read up
• Exclude checks
  • Disable engine
  • Disable check

class ShortMethod {
    public function a( $index ) { // Violation
    }
}

Avoid using short method names like IteratorAwareTrait::__(). The configured minimum method name length is 3.

Open

    abstract protected function __($string, $args = [], $context = null);

• Read up
  Read up
• Exclude checks
  • Disable engine
  • Disable check

class ShortMethod {
    public function a( $index ) { // Violation
    }
}

Avoid too many return statements within this method.

Open

        return $this->_loop();

The method _advanceTracker is not named in camelCase.

Open

    protected function _advanceTracker($tracker)
    {
        if (!($tracker instanceof Iterator)) {
            throw $this->_createInvalidArgumentException($this->__('Can only advance an Iterator tracker'), null, null, $tracker);
        }

• Read up
  Read up
• Exclude checks
  • Disable engine
  • Disable check

class ClassName {
    public function get_name() {
    }
}

The method _resetTracker is not named in camelCase.

Open

    protected function _resetTracker($tracker)
    {
        if (!($tracker instanceof Iterator)) {
            throw $this->_createInvalidArgumentException($this->__('Can only reset an Iterator tracker'), null, null, $tracker);
        }

• Read up
  Read up
• Exclude checks
  • Disable engine
  • Disable check

class ClassName {
    public function get_name() {
    }
}

The method _key is not named in camelCase.

Open

    protected function _key()
    {
        return $this->_getIteration()->getKey();
    }

• Read up
  Read up
• Exclude checks
  • Disable engine
  • Disable check

class ClassName {
    public function get_name() {
    }
}

The method _loop is not named in camelCase.

Open

    protected function _loop()
    {
        // Ensure that there are items on the stack
        if (!$this->_hasParents()) {
            return $this->_createIteration(null, null);

• Read up
  Read up
• Exclude checks
  • Disable engine
  • Disable check

class ClassName {
    public function get_name() {
    }
}

The method _valid is not named in camelCase.

Open

    protected function _valid()
    {
        return $this->_hasParents();
    }

• Read up
  Read up
• Exclude checks
  • Disable engine
  • Disable check

class ClassName {
    public function get_name() {
    }
}

The method _getCurrentIterable is not named in camelCase.

Open

    protected function &_getCurrentIterable()
    {
        $iterable = &$this->_getTopmostParent();

        return $iterable;

• Read up
  Read up
• Exclude checks
  • Disable engine
  • Disable check

class ClassName {
    public function get_name() {
    }
}

The method _resetTracker is not named in camelCase.

Open

    abstract protected function _resetTracker($tracker);

• Read up
  Read up
• Exclude checks
  • Disable engine
  • Disable check

class ClassName {
    public function get_name() {
    }
}

The method _createIterationFromTracker is not named in camelCase.

Open

    abstract protected function _createIterationFromTracker($tracker);

• Read up
  Read up
• Exclude checks
  • Disable engine
  • Disable check

class ClassName {
    public function get_name() {
    }
}

The method _backtrackLoop is not named in camelCase.

Open

    protected function _backtrackLoop()
    {
        $this->_popParent();

        if (!$this->_hasParents()) {

• Read up
  Read up
• Exclude checks
  • Disable engine
  • Disable check

class ClassName {
    public function get_name() {
    }
}

The method _pushParent is not named in camelCase.

Open

    protected function _pushParent(&$parent)
    {
        $children    = &$this->_getElementChildren($parent);
        $pathSegment = $this->_getElementPathSegment(null, $parent);

• Read up
  Read up
• Exclude checks
  • Disable engine
  • Disable check

class ClassName {
    public function get_name() {
    }
}

The method _getTopmostParent is not named in camelCase.

Open

    protected function &_getTopmostParent()
    {
        if (isset($this->parents[0])) {
            return $this->parents[0];
        }

• Read up
  Read up
• Exclude checks
  • Disable engine
  • Disable check

class ClassName {
    public function get_name() {
    }
}

The method _getElementChildren is not named in camelCase.

Open

    protected function &_getElementChildren($value)
    {
        $children = $this->_isElementHasChildren($value)
            /* @var $value ChildrenAwareInterface */
            ? $value->getChildren()

• Read up
  Read up
• Exclude checks
  • Disable engine
  • Disable check

class ClassName {
    public function get_name() {
    }
}

The method _createInvalidArgumentException is not named in camelCase.

Open

    abstract protected function _createInvalidArgumentException(
        $message = null,
        $code = null,
        RootException $previous = null,
        $argument = null

• Read up
  Read up
• Exclude checks
  • Disable engine
  • Disable check

class ClassName {
    public function get_name() {
    }
}

The method _calculateKey is not named in camelCase.

Open

    protected function _calculateKey(Iterator $iterator)
    {
        return $iterator->valid()
            ? $iterator->key()
            : null;

• Read up
  Read up
• Exclude checks
  • Disable engine
  • Disable check

class ClassName {
    public function get_name() {
    }
}

The method _value is not named in camelCase.

Open

    protected function _value()
    {
        return $this->_getIteration()->getValue();
    }

• Read up
  Read up
• Exclude checks
  • Disable engine
  • Disable check

class ClassName {
    public function get_name() {
    }
}

The method _getCurrentIterableKey is not named in camelCase.

Open

    abstract protected function _getCurrentIterableKey(&$iterable);

• Read up
  Read up
• Exclude checks
  • Disable engine
  • Disable check

class ClassName {
    public function get_name() {
    }
}