RegisteredAction.php

Go to the documentation of this file.

<?php

namespace BristolSU\Support\Action;

use BristolSU\Support\Action\Contracts\RegisteredAction as RegisteredActionContract;
use Illuminate\Contracts\Support\Arrayable;
use Illuminate\Contracts\Support\Jsonable;

class RegisteredAction implements Arrayable, Jsonable, RegisteredActionContract
{

    private $name;

    private $description;

    private $className;

    public function setName(string $name): void
    {
        $this->name = $name;
    }

    public function getName(): string
    {
        return $this->name;
    }

    public function setDescription(string $description): void
    {
        $this->description = $description;
    }

    public function getDescription(): string
    {
        return $this->description;
    }

    public function setClassName(string $className): void
    {
        $this->className = $className;
    }

    public function getClassName(): string
    {
        return $this->className;
    }

    public static function fromArray(array $parameters): RegisteredActionContract
    {
        $registeredAction = new self;
        $registeredAction->setName($parameters['name']);
        $registeredAction->setDescription($parameters['description']);
        $registeredAction->setClassName($parameters['class']);
        return $registeredAction;
    }

    public function toArray()
    {
        return [
            'name' => $this->getName(),
            'description' => $this->getDescription(),
            'class' => $this->getClassName()
        ];
    }

    public function toJson($options = 0)
    {
        return json_encode($this->toArray(), $options);
    }

    public function __toString()
    {
        return $this->toJson();
    }
    
}