yvoyer / php-state

src/TransitionRegistry.php

<?php declare(strict_types=1);

This file is missing a doc comment.

The PHP open tag does not have a corresponding PHP close tag

Filename "TransitionRegistry.php" doesn't match the expected filename "transitionregistry.php"

/**

Inline doc block comments are not allowed; use "/* Comment */" or "// Comment" instead

Block comments must be started with /*

 * This file is part of the php-state project.
 *
 * (c) Yannick Voyer <star.yvoyer@gmail.com> (http://github.com/yvoyer)
 */

PHP version not specified

Missing @category tag in file comment

Missing @package tag in file comment

Missing @author tag in file comment

Missing @license tag in file comment

Missing @link tag in file comment

namespace Star\Component\State;

use Star\Component\State\Transitions\ReadOnlyTransition;

final class TransitionRegistry implements StateRegistry

Missing class doc comment

{

Opening brace should be on the same line as the declaration for class TransitionRegistry

    /**

Missing short description in doc comment

     * @var array[] Collection of states indexed by transition name
     */
    private $transitions = [];

Private member variable "transitions" must contain a leading underscore

Expected 1 blank line before member var; 0 found

Private member variable "transitions" must be prefixed with an underscore

Short array syntax is not allowed

    /**

Missing short description in doc comment

     * @var array[] Collection of attributes indexed by state name
     */
    private $states = [];

Private member variable "states" must contain a leading underscore

Private member variable "states" must be prefixed with an underscore

Short array syntax is not allowed

    /**

Missing short description in doc comment

     * @param StateTransition $transition

Missing parameter comment

     */

Missing @return tag in function comment

Missing @throws tag in function comment

    public function addTransition(StateTransition $transition): void

Expected 2 blank lines before function; 1 found

    {

Opening brace should be on the same line as the declaration

        $name = $transition->getName();
        if (isset($this->transitions[$name])) {
            throw DuplicateEntryException::duplicateTransition($name);
        }

        $transition->onRegister($this);
    }

Expected 2 blank lines after function; 1 found

Expected 1 blank line before closing function brace; 0 found

Expected //end addTransition()

    /**

Missing short description in doc comment

     * @param string $name The transition name

Parameter comment must end with a full stop

     *
     * @return StateTransition
     * @throws NotFoundException

Comment missing for @throws tag in function comment

     */
    public function getTransition(string $name): StateTransition
    {

Opening brace should be on the same line as the declaration

        $transition = null;

TRUE, FALSE and NULL should be uppercase as per the configured coding-style; instead of null please use NULL.

        if (isset($this->transitions[$name]['to'])) {
            $transition = new ReadOnlyTransition($this->transitions[$name]['to']);
        }

        if (! $transition) {
            throw NotFoundException::transitionNotFound($name);
        }

        return $transition;
    }

Expected 2 blank lines after function; 1 found

Expected 1 blank line before closing function brace; 0 found

Expected //end getTransition()

    public function addAttribute(string $state, string $attribute): void

Missing function doc comment

    {

Opening brace should be on the same line as the declaration

        $attributes = [$attribute];

Short array syntax is not allowed

        if ($this->hasState($state)) {
            $attributes = \array_merge($this->states[$state], $attributes);
        }

        $this->states[$state] = \array_unique($attributes);
    }

Expected 2 blank lines after function; 1 found

Expected 1 blank line before closing function brace; 0 found

Expected //end addAttribute()

    /**

Missing short description in doc comment

     * @param string $state

Missing parameter comment

Expected 3 spaces after parameter type; 1 found

     * @param string[] $attributes

Missing parameter comment

     */

Missing @return tag in function comment

    private function addAttributes(string $state, array $attributes): void

Private method name "TransitionRegistry::addAttributes" must be prefixed with an underscore

    {

Opening brace should be on the same line as the declaration

        \array_map(
            function ($attribute) use ($state) {
                $this->addAttribute($state, $attribute);
            },
            $attributes
        );
    }

Expected 2 blank lines after function; 1 found

Expected 1 blank line before closing function brace; 0 found

Expected //end addAttributes()

    public function transitionStartsFrom(string $transition, string $state): bool

Missing function doc comment

    {

Opening brace should be on the same line as the declaration

        $from = [];

Short array syntax is not allowed

        if (isset($this->transitions[$transition]['from'])) {
            $from = $this->transitions[$transition]['from'];
        }

        return \in_array($state, $from, true);

TRUE, FALSE and NULL should be uppercase as per the configured coding-style; instead of true please use TRUE.

    }

Expected 2 blank lines after function; 1 found

Expected 1 blank line before closing function brace; 0 found

Expected //end transitionStartsFrom()

    public function hasAttribute(string $state, string $attribute): bool

Missing function doc comment

    {

Opening brace should be on the same line as the declaration

        if (! $this->hasState($state)) {
            return false;

TRUE, FALSE and NULL should be uppercase as per the configured coding-style; instead of false please use FALSE.

        }

        return \in_array($attribute, $this->states[$state]);
    }

Expected 2 blank lines after function; 1 found

Expected 1 blank line before closing function brace; 0 found

Expected //end hasAttribute()

    public function hasState(string $name): bool

Missing function doc comment

    {

Opening brace should be on the same line as the declaration

        return \array_key_exists($name, $this->states);
    }

Expected 2 blank lines after function; 1 found

Expected 1 blank line before closing function brace; 0 found

Expected //end hasState()

    public function acceptTransitionVisitor(TransitionVisitor $visitor): void

Missing function doc comment

    {

Opening brace should be on the same line as the declaration

        foreach ($this->transitions as $transition => $states) {
            $visitor->visitTransition($transition);

            foreach ($states['from'] as $from) {
                $visitor->visitFromState($from, $this->states[$from]);
            }
            $visitor->visitToState($states['to'], $this->states[$states['to']]);
        }
    }

Expected 2 blank lines after function; 1 found

Expected 1 blank line before closing function brace; 0 found

Expected //end acceptTransitionVisitor()

    public function acceptStateVisitor(StateVisitor $visitor): void

Missing function doc comment

    {

Opening brace should be on the same line as the declaration

        foreach ($this->states as $state => $attributes) {
            $visitor->visitState($state, $attributes);
        }
    }

Expected 2 blank lines after function; 1 found

Expected 1 blank line before closing function brace; 0 found

Expected //end acceptStateVisitor()

    /**

Missing short description in doc comment

     * @param string $transition

Missing parameter comment

Expected 3 spaces after parameter type; 1 found

     * @param string $stateName

Missing parameter comment

Expected 3 spaces after parameter type; 1 found

     * @param string[] $attributes

Missing parameter comment

     */

Missing @return tag in function comment

    public function registerStartingState(string $transition, string $stateName, array $attributes = []): void

Short array syntax is not allowed

    {

Opening brace should be on the same line as the declaration

        $this->initState($stateName);
        $this->addAttributes($stateName, $attributes);
        $this->transitions[$transition]['from'][] = $stateName;
    }

Expected 2 blank lines after function; 1 found

Expected 1 blank line before closing function brace; 0 found

Expected //end registerStartingState()

    /**

Missing short description in doc comment

     * @param string $transition

Missing parameter comment

Expected 3 spaces after parameter type; 1 found

     * @param string $stateName

Missing parameter comment

Expected 3 spaces after parameter type; 1 found

     * @param string[] $attributes

Missing parameter comment

     */

Missing @return tag in function comment

    public function registerDestinationState(string $transition, string $stateName, array $attributes = []): void

Short array syntax is not allowed

    {

Opening brace should be on the same line as the declaration

        $this->initState($stateName);
        $this->addAttributes($stateName, $attributes);
        $this->transitions[$transition]['to'] = $stateName;
    }

Expected 2 blank lines after function; 1 found

Expected 1 blank line before closing function brace; 0 found

Expected //end registerDestinationState()

    /**

Missing short description in doc comment

     * @param string $state

Missing parameter comment

     */

Missing @return tag in function comment

    private function initState(string $state): void

Private method name "TransitionRegistry::initState" must be prefixed with an underscore

    {

Opening brace should be on the same line as the declaration

        if (!$this->hasState($state)) {

There must be a single space after a NOT operator; 0 found

            $this->states[$state] = [];

Short array syntax is not allowed

        }
    }

Expected 2 blank lines after function; 0 found

Expected 1 blank line before closing function brace; 0 found

Expected //end initState()

}

Expected //end class

As per coding style, files should not end with a newline character.