yvoyer / php-state

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

namespace Star\Component\State;

use Star\Component\State\Builder\StateBuilder;
use Star\Component\State\Callbacks\TransitionCallback;

abstract class StateMetadata

Missing class doc comment

{

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

    /**

Missing short description in doc comment

     * @var string
     */
    protected $current;

Protected member variable "current" must contain a leading underscore

Expected 1 blank line before member var; 0 found

    /**

Missing short description in doc comment

     * @param string $initial The initial state name

Parameter comment must end with a full stop

     */
    public function __construct(string $initial)

Expected 2 blank lines before function; 1 found

    {

Opening brace should be on the same line as the declaration

        $this->current = $initial;
    }

Expected 2 blank lines after function; 1 found

Expected 1 blank line before closing function brace; 0 found

Expected //end __construct()

    /**
     * Returns the state workflow configuration.
     *
     * @param StateBuilder $builder

Missing parameter comment

     */

Missing @return tag in function comment

    abstract protected function configure(StateBuilder $builder): void;

Expected 2 blank lines after function; 1 found

    private function getMachine(): StateMachine

Private method name "StateMetadata::getMachine" must be prefixed with an underscore

Missing function doc comment

    {

Opening brace should be on the same line as the declaration

        $this->configure($builder = new StateBuilder());

Assignments must be the first block of code on a line

        // todo implement caching for faster building

Comments for TODO tasks are often forgotten in the code; it might be better to use a dedicated issue tracker.

Inline comments must start with a capital letter

Inline comments must end in full-stops, exclamation marks, or question marks

        return $builder->create($this->current);
    }

Expected 2 blank lines after function; 1 found

Expected 1 blank line before closing function brace; 0 found

Expected //end getMachine()

    /**

Missing short description in doc comment

     * @param string $name

Missing parameter comment

Expected 18 spaces after parameter type; 1 found

     * @param mixed $context

Missing parameter comment

Expected 19 spaces after parameter type; 1 found

     * @param TransitionCallback|null $callback

Missing parameter comment

     *
     * @return static
     */
    final public function transit(string $name, $context, TransitionCallback $callback = null): StateMetadata

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

        $this->current = $this->getMachine()->transit($name, $context, $callback);

        return $this;
    }

Expected 2 blank lines after function; 1 found

Expected 1 blank line before closing function brace; 0 found

Expected //end transit()

    final public function hasAttribute(string $attribute): bool

Missing function doc comment

    {

Opening brace should be on the same line as the declaration

        return $this->getMachine()->hasAttribute($attribute);
    }

Expected 2 blank lines after function; 1 found

Expected 1 blank line before closing function brace; 0 found

Expected //end hasAttribute()

    final public function isInState(string $state): bool

Missing function doc comment

    {

Opening brace should be on the same line as the declaration

        return $this->getMachine()->isInState($state);
    }

Expected 2 blank lines after function; 1 found

Expected 1 blank line before closing function brace; 0 found

Expected //end isInState()

    final public function getCurrent(): string

Missing function doc comment

    {

Opening brace should be on the same line as the declaration

        return $this->current;
    }

Expected 2 blank lines after function; 0 found

Expected 1 blank line before closing function brace; 0 found

Expected //end getCurrent()

}

Expected //end class

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