Laravel\Forge\Commands\ResourceCommand

Complexity

Total Complexity

14

Size/Duplication

Total Lines	146
Duplicated Lines	0 %

Coupling/Cohesion

Components	1
Dependencies	3

Importance

Changes

0

10 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	setResourceId()	0	6	1
A	getResourceId()	0	4	1
A	handleResponse()	0	10	2
A	handleListCommandResponse()	0	19	3

<?php

namespace Laravel\Forge\Commands;

use Laravel\Forge\Contracts\ResourceContract;
use InvalidArgumentException;
use Psr\Http\Message\ResponseInterface;

abstract class ResourceCommand extends Command
{
    /**
     * Resource ID.
     */
    protected $resourceId;

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

    /**
     * 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->getResourceId()) ? 'POST' : 'GET';
    }

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

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

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

    /**
     * Set resource ID.
     *
     * @param int|string $resourceId
     *
     * @return static
     */
    public function setResourceId($resourceId)
    {
        $this->resourceId = $resourceId;

        return $this;
    }

    /**
     * Get resource ID.
     *
     * @return int|string|null
     */
    public function getResourceId()
    {
        return $this->resourceId;
    }

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

        $className = $this->resourceClass();

        return $className::createFromResponse($response, $owner->getApi(), $owner);
    }

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

It seems like you code against a specific sub-type and not the parent class Laravel\Forge\Commands\ResourceCommand as the method listResponseItemsKey() does only exist in the following sub-classes of Laravel\Forge\Commands\ResourceCommand: 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\SshKeys\Commands\ListSshKeysCommand, Laravel\Forge\Workers\Commands\ListWorkersCommand. 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[] = new $className($owner->getApi(), $item, $owner);
        }

        return $items;
    }
}