yvoyer / php-state

src/Builder/StateBuilder.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 "StateBuilder.php" doesn't match the expected filename "statebuilder.php"

namespace Star\Component\State\Builder;

use Star\Component\State\EventRegistry;
use Star\Component\State\Port\Symfony\EventDispatcherAdapter;
use Star\Component\State\StateMachine;
use Star\Component\State\StateTransition;
use Star\Component\State\TransitionRegistry;
use Star\Component\State\Transitions\ManyToOneTransition;
use Star\Component\State\Transitions\OneToOneTransition;

/**
 * Tool to build the StateMachine.
 */

Missing @category tag in class comment

Missing @package tag in class comment

Missing @author tag in class comment

Missing @license tag in class comment

Missing @link tag in class comment

final class StateBuilder
{

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

    /**

Missing short description in doc comment

     * @var TransitionRegistry
     */
    private $registry;

Private member variable "registry" must contain a leading underscore

Expected 1 blank line before member var; 0 found

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

    /**

Missing short description in doc comment

     * @var EventRegistry
     */
    private $listeners;

Private member variable "listeners" must contain a leading underscore

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

    public function __construct()

Expected 2 blank lines before function; 1 found

Missing function doc comment

    {

Opening brace should be on the same line as the declaration

        $this->registry = new TransitionRegistry();

Equals sign not aligned with surrounding assignments; expected 2 spaces but found 1 space

        $this->listeners = new EventDispatcherAdapter();
    }

Expected 2 blank lines after function; 1 found

Expected 1 blank line before closing function brace; 0 found

Expected //end __construct()

    /**

Missing short description in doc comment

     * @param string $name

Missing parameter comment

Expected 10 spaces after parameter type; 1 found

     * @param string|string[] $from

Missing parameter comment

     * @param string $to

Missing parameter comment

Expected 10 spaces after parameter type; 1 found

     *
     * @return StateBuilder
     */
    public function allowTransition(string $name, $from, string $to): StateBuilder
    {

Opening brace should be on the same line as the declaration

        if (\is_array($from)) {
            $transition = new ManyToOneTransition($name, $to, ...$from);
        } else {
            $transition = new OneToOneTransition($name, $from, $to);
        }

        $this->allowCustomTransition($transition);

        return $this;
    }

Expected 2 blank lines after function; 1 found

Expected 1 blank line before closing function brace; 0 found

Expected //end allowTransition()

    /**

Missing short description in doc comment

     * @param StateTransition $transition

Missing parameter comment

     */

Missing @return tag in function comment

    public function allowCustomTransition(StateTransition $transition): void
    {

Opening brace should be on the same line as the declaration

        $this->registry->addTransition($transition);
    }

Expected 2 blank lines after function; 1 found

Expected 1 blank line before closing function brace; 0 found

Expected //end allowCustomTransition()

    /**

Missing short description in doc comment

     * @param string $attribute The attribute

Expected 10 spaces after parameter type; 1 found

Parameter comment must end with a full stop

     * @param string|string[] $states The list of states that this attribute applies to

Expected 4 spaces after parameter name; 1 found

Parameter comment must end with a full stop

     *
     * @return StateBuilder
     */
    public function addAttribute(string $attribute, $states): StateBuilder
    {

Opening brace should be on the same line as the declaration

        $states = (array) $states;

A cast statement should not be followed as per the coding-style.

        foreach ($states as $stateName) {
            $this->registry->addAttribute($stateName, $attribute);
        }

        return $this;
    }

Expected 2 blank lines after function; 1 found

Expected 1 blank line before closing function brace; 0 found

Expected //end addAttribute()

    public function create(string $currentState): StateMachine

Missing function doc comment

    {

Opening brace should be on the same line as the declaration

        return new StateMachine($currentState, $this->registry, $this->listeners);
    }

Expected 2 blank lines after function; 1 found

Expected 1 blank line before closing function brace; 0 found

Expected //end create()

    public static function build(): StateBuilder

Missing function doc comment

    {

Opening brace should be on the same line as the declaration

        return new static();
    }

Expected 2 blank lines after function; 0 found

Expected 1 blank line before closing function brace; 0 found

Expected //end build()

}

Expected //end class

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