SoliDry / api-generator

src/Extension/StateMachine.php

<?php
namespace SoliDry\Extension;

use SoliDry\Exceptions\AttributesException;
use SoliDry\Helpers\ConfigHelper;
use SoliDry\Helpers\MigrationsHelper;
use SoliDry\Types\ConfigInterface;
use SoliDry\Types\ErrorsInterface;

/**
 * Class StateMachine
 * @package SoliDry\Extension
 */
class StateMachine
{
    private $machine = [];
    private $states  = [];
    private $initial;
    // state field taken from table in config
    private $field;

    /**
     * StateMachine constructor.
     * @param string $entity
     */
    public function __construct(string $entity)
    {
        $this->machine = ConfigHelper::getNestedParam(ConfigInterface::STATE_MACHINE, MigrationsHelper::getTableName($entity));
        $this->field   = key($this->machine);

It seems like $this->machine can also be of type null; however, parameter $array of key() does only seem to accept array|object, maybe add an additional type check?

    }

    /**
     * @param string $field
     * @return bool
     */
    public function isStatedField(string $field) : bool
    {
        return empty($this->machine[$field]) === false
            && $this->machine[$field][ConfigInterface::ENABLED] === true
            && empty($this->machine[$field][ConfigInterface::STATES]) === false;
    }

    /**
     * @param mixed $from
     * @param mixed $to
     * @return bool
     */
    public function isTransitive($from, $to): bool
    {
        return $from === $to || in_array($to, $this->states[$from], true);
    }

    public function isInitial($state): bool
    {
        return empty($this->states[ConfigInterface::INITIAL]) === false
        && in_array($state, $this->states[ConfigInterface::INITIAL]);
    }

    /**
     * @return mixed
     */
    public function getInitial()
    {
        return $this->initial;
    }

    /**
     * @param string $field
     * @throws AttributesException
     */
    public function setStates(string $field) : void
    {
        if(empty($this->machine[$field][ConfigInterface::STATES])) {
            throw new AttributesException(ErrorsInterface::JSON_API_ERRORS[ErrorsInterface::HTTP_CODE_BULK_EXT_ERROR], ErrorsInterface::HTTP_CODE_BULK_EXT_ERROR);
        }

        $this->states = $this->machine[$field][ConfigInterface::STATES];
    }

    /**
     * @param string $field
     * @throws AttributesException
     */
    public function setInitial(string $field) : void
    {
        if(empty($this->machine[$field][ConfigInterface::STATES][ConfigInterface::INITIAL][0])) {
            throw new AttributesException('There should be an initial value for: "' . $field . '" field."', ErrorsInterface::HTTP_CODE_FSM_INIT_ATTR);
        }

        $this->initial = $this->machine[$field][ConfigInterface::STATES][ConfigInterface::INITIAL][0];
    }

    /**
     * @return mixed|null
     */
    public function getField()
    {
        return $this->field;
    }
}