Star\Component\State\Callbacks\AlwaysReturnStateOnFailure

Complexity

Total Complexity

4

Size/Duplication

Total Lines	38
Duplicated Lines	0 %

Test Coverage

Coverage

0%

Importance

Changes	1
Bugs	0	Features	0

4 Methods

Rating	Name	Duplication	Size	Complexity
A	afterStateChange()	0	2	1
A	beforeStateChange()	0	2	1
A	__construct()	0	3	1
A	onFailure()	0	3	1

<?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 "AlwaysReturnStateOnFailure.php" doesn't match the expected filename "alwaysreturnstateonfailure.php"

namespace Star\Component\State\Callbacks;

use Star\Component\State\InvalidStateTransitionException;
use Star\Component\State\StateMachine;

final class AlwaysReturnStateOnFailure implements TransitionCallback

Missing class doc comment

{

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

    /**

Missing short description in doc comment

     * @var string
     */
    private $to;

Private member variable "to" must contain a leading underscore

Expected 1 blank line before member var; 0 found

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

    public function __construct(string $to)

Expected 2 blank lines before function; 1 found

Missing function doc comment

    {

Opening brace should be on the same line as the declaration

        $this->to = $to;
    }

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 mixed $context

Missing parameter comment

Expected 8 spaces after parameter type; 1 found

     * @param StateMachine $machine

Missing parameter comment

     */

Missing @return tag in function comment

    public function beforeStateChange($context, StateMachine $machine): void
    {

Opening brace should be on the same line as the declaration

    }

Expected 2 blank lines after function; 1 found

Expected 1 blank line before closing function brace; 0 found

Expected //end beforeStateChange()

    /**

Missing short description in doc comment

     * @param mixed $context

Missing parameter comment

Expected 8 spaces after parameter type; 1 found

     * @param StateMachine $machine

Missing parameter comment

     */

Missing @return tag in function comment

    public function afterStateChange($context, StateMachine $machine): void
    {

Opening brace should be on the same line as the declaration

    }

Expected 2 blank lines after function; 1 found

Expected 1 blank line before closing function brace; 0 found

Expected //end afterStateChange()

    /**

Missing short description in doc comment

     * @param InvalidStateTransitionException $exception

Missing parameter comment

     * @param mixed $context

Missing parameter comment

Expected 27 spaces after parameter type; 1 found

     * @param StateMachine $machine

Missing parameter comment

Expected 20 spaces after parameter type; 1 found

     *
     * @return string
     */
    public function onFailure(InvalidStateTransitionException $exception, $context, StateMachine $machine): string

The method parameter $exception is never used

The method parameter $context is never used

The method parameter $machine is never used

    {

Opening brace should be on the same line as the declaration

        return $this->to;
    }

Expected 2 blank lines after function; 0 found

Expected 1 blank line before closing function brace; 0 found

Expected //end onFailure()

}

Expected //end class

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