yvoyer / php-state

src/StateMachine.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 "StateMachine.php" doesn't match the expected filename "statemachine.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\Callbacks\AlwaysThrowExceptionOnFailure;
use Star\Component\State\Callbacks\TransitionCallback;
use Star\Component\State\Event\StateEventStore;
use Star\Component\State\Event\TransitionWasFailed;
use Star\Component\State\Event\TransitionWasSuccessful;
use Star\Component\State\Event\TransitionWasRequested;

final class StateMachine

Missing class doc comment

{

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

    /**

Missing short description in doc comment

     * @var EventRegistry
     */
    private $listeners;

Private member variable "listeners" must contain a leading underscore

Expected 1 blank line before member var; 0 found

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

    /**

Missing short description in doc comment

     * @var StateRegistry
     */
    private $states;

Private member variable "states" must contain a leading underscore

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

    /**

Missing short description in doc comment

     * @var string
     */
    private $currentState;

Private member variable "currentState" must contain a leading underscore

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

    public function __construct(

Expected 2 blank lines before function; 1 found

Missing function doc comment

        string $currentState,
        StateRegistry $states,
        EventRegistry $listeners
    ) {

Opening brace should be on a new line

        $this->listeners = $listeners;
        $this->states = $states;

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

        $this->setCurrentState($currentState);
    }

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 $transitionName The transition name

Expected 18 spaces after parameter type; 1 found

Parameter comment must end with a full stop

     * @param mixed $context

Missing parameter comment

Expected 19 spaces after parameter type; 1 found

     * @param TransitionCallback|null $callback

Missing parameter comment

     *
     * @return string The next state to store on your context
     * @throws InvalidStateTransitionException

Comment missing for @throws tag in function comment

     * @throws NotFoundException

Comment missing for @throws tag in function comment

     */
    public function transit(string $transitionName, $context, TransitionCallback $callback = null): string

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

    {

Opening brace should be on the same line as the declaration

        if (! $callback) {
            $callback = new AlwaysThrowExceptionOnFailure();
        }

        $this->listeners->dispatch(
            StateEventStore::BEFORE_TRANSITION,
            new TransitionWasRequested($transitionName)
        );

        $transition = $this->states->getTransition($transitionName);
        $callback->beforeStateChange($context, $this);

        $newState = $transition->getDestinationState();
        $allowed = $this->states->transitionStartsFrom($transitionName, $this->currentState);

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

        if (! $allowed) {
            $exception = InvalidStateTransitionException::notAllowedTransition(
                $transitionName,
                $context,
                $this->currentState
            );

            $this->listeners->dispatch(
                StateEventStore::FAILURE_TRANSITION,
                new TransitionWasFailed($transitionName, $exception)
            );

            $newState = $callback->onFailure($exception, $context, $this);
        }

        $this->setCurrentState($newState);

        $callback->afterStateChange($context, $this);

        $this->listeners->dispatch(
            StateEventStore::AFTER_TRANSITION,
            new TransitionWasSuccessful($transitionName)
        );

        return $this->currentState;
    }

Expected 2 blank lines after function; 1 found

Expected 1 blank line before closing function brace; 0 found

Expected //end transit()

    /**

Missing short description in doc comment

     * @param string $stateName

Missing parameter comment

     * @return bool

Expected "boolean" but found "bool" for function return type

     * @throws NotFoundException

Comment missing for @throws tag in function comment

     */
    public function isInState(string $stateName): bool
    {

Opening brace should be on the same line as the declaration

        if (! $this->states->hasState($stateName)) {
            throw NotFoundException::stateNotFound($stateName);
        }

        return $this->currentState === $stateName;
    }

Expected 2 blank lines after function; 1 found

Expected 1 blank line before closing function brace; 0 found

Expected //end isInState()

    public function hasAttribute(string $attribute): bool

Missing function doc comment

    {

Opening brace should be on the same line as the declaration

        return $this->states->hasAttribute($this->currentState, $attribute);
    }

Expected 2 blank lines after function; 1 found

Expected 1 blank line before closing function brace; 0 found

Expected //end hasAttribute()

    public function addListener(string $event, \Closure $listener): void

Missing function doc comment

    {

Opening brace should be on the same line as the declaration

        $this->listeners->addListener($event, $listener);
    }

Expected 2 blank lines after function; 1 found

Expected 1 blank line before closing function brace; 0 found

Expected //end addListener()

    public function acceptTransitionVisitor(TransitionVisitor $visitor): void

Missing function doc comment

    {

Opening brace should be on the same line as the declaration

        $this->states->acceptTransitionVisitor($visitor);
    }

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

        $this->states->acceptStateVisitor($visitor);
    }

Expected 2 blank lines after function; 1 found

Expected 1 blank line before closing function brace; 0 found

Expected //end acceptStateVisitor()

    private function setCurrentState(string $state): void

Private method name "StateMachine::setCurrentState" must be prefixed with an underscore

Missing function doc comment

    {

Opening brace should be on the same line as the declaration

        $this->currentState = $state;
    }

Expected 2 blank lines after function; 0 found

Expected 1 blank line before closing function brace; 0 found

Expected //end setCurrentState()

}

Expected //end class

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