Laravel\Forge\ServerResources\Commands\ServerResourceCommand

Complexity

Total Complexity

15

Size/Duplication

Total Lines	160
Duplicated Lines	0 %

Coupling/Cohesion

Components	1
Dependencies	3

Importance

Changes

0

11 Methods

Rating	Name	Duplication	Size	Complexity
	resourcePath()	0	1	?
	resourceClass()	0	1	?
A	isListCommand()	0	4	1
A	command()	0	4	1
A	requestMethod()	0	8	3
A	requestUrl()	0	10	2
A	setItemId()	0	6	1
A	getItemId()	0	4	1
A	processResponseItem()	0	4	1
A	handleResponse()	0	12	2
A	handleListCommandResponse()	0	19	3

<?php

namespace Laravel\Forge\ServerResources\Commands;

use Laravel\Forge\Server;
use InvalidArgumentException;
use Psr\Http\Message\ResponseInterface;
use Laravel\Forge\Commands\ServerCommand;

abstract class ServerResourceCommand extends ServerCommand
{
    /**
     * Item ID.
     */
    protected $itemId;

    /**
     * Server resource path.
     *
     * @return string
     */
    abstract public function resourcePath();

    /**
     * Server resource class name.
     *
     * @return string
     */
    abstract public function resourceClass();

    /**
     * Determines if current command is list command.
     *
     * @return bool
     */
    protected function isListCommand(): bool
    {
        return method_exists($this, 'listResponseItemsKey');
    }

    /**
     * Command name.
     *
     * @return string
     */
    public function command()
    {
        return $this->resourcePath();
    }

    /**
     * HTTP request method.
     *
     * @return string
     */
    public function requestMethod()
    {
        if ($this->isListCommand()) {
            return 'GET';
        }

        return is_null($this->itemId) ? 'POST' : 'GET';
    }

    /**
     * HTTP request URL.
     *
     * @param \Laravel\Forge\Server
     *
     * @return string
     */
    public function requestUrl(Server $server)
    {
        $resourcePath = $this->resourcePath();

        if (!is_null($this->getItemId())) {
            $resourcePath .= '/'.$this->getItemId();
        }

        return $server->apiUrl($resourcePath);
    }

    /**
     * Set Item ID.
     *
     * @param int|string $itemId
     *
     * @return static
     */
    public function setItemId($itemId)
    {
        $this->itemId = $itemId;

        return $this;
    }

    /**
     * Get Item ID.
     *
     * @return int|string|null
     */
    public function getItemId()
    {
        return $this->itemId;
    }

    /**
     * Processes new response item.
     *
     * @param mixed $item
     *
     * @return mixed
     */
    public function processResponseItem($item)
    {
        return $item;
    }

    /**
     * Handle command response.
     *
     * @param \Psr\Http\Message\ResponseInterface $response
     * @param \Laravel\Forge\Server               $server
     *
     * @return \Laravel\Forge\ServerResources\ServerResource|array|bool|string
     */
    public function handleResponse(ResponseInterface $response, Server $server)
    {
        if ($this->isListCommand()) {
            return $this->handleListCommandResponse($response, $server);
        }

        $className = $this->resourceClass();

        return $this->processResponseItem(
            $className::createFromResponse($response, $server)
        );
    }

    /**
     * List response handler.
     *
     * @param \Psr\Http\Message\ResponseInterface $response
     * @param \Laravel\Forge\Server               $server
     *
     * @throws \InvalidArgumentException
     *
     * @return array
     */
    public function handleListCommandResponse(ResponseInterface $response, Server $server)
    {
        $itemsKey = $this->listResponseItemsKey();

It seems like you code against a specific sub-type and not the parent class Laravel\Forge\ServerResources\Commands\ServerResourceCommand as the method listResponseItemsKey() does only exist in the following sub-classes of Laravel\Forge\ServerResources\Commands\ServerResourceCommand: Laravel\Forge\Daemons\Commands\ListDaemonsCommand, Laravel\Forge\Firewall\Commands\ListFirewallRulesCommand, Laravel\Forge\Jobs\Commands\ListJobsCommand, Laravel\Forge\Services\Mysql\Commands\ListMysqlDatabasesCommand, Laravel\Forge\Services\Mysql\Commands\ListMysqlUsersCommand, Laravel\Forge\Sites\Commands\ListSitesCommand, Laravel\Forge\Sites\Commands\Workers\ListWorkersCommand, Laravel\Forge\SshKeys\Commands\ListSshKeysCommand. Maybe you want to instanceof check for one of these explicitly?

        $json = json_decode((string) $response->getBody(), true);

        if (empty($json[$itemsKey])) {
            throw new InvalidArgumentException('Given response is not a '.$this->resourcePath().' response.');
        }

        $items = [];
        $className = $this->resourceClass();

        foreach ($json[$itemsKey] as $item) {
            $items[] = $this->processResponseItem(new $className($server, $item));
        }

        return $items;
    }
}