Laravel\Forge\Commands\Command

Complexity

Total Complexity

24

Size/Duplication

Total Lines	234
Duplicated Lines	0 %

Coupling/Cohesion

Components	1
Dependencies	2

Importance

Changes

0

15 Methods

Rating	Name	Duplication	Size	Complexity
	command()	0	1	?
A	description()	0	4	1
A	runnable()	0	4	1
A	requestMethod()	0	4	1
A	requestUrl()	0	4	1
A	requestOptions()	0	6	1
A	withPayload()	0	6	1
A	attachPayload()	0	10	2
A	getPayloadData()	0	8	2
B	hasPayloadData()	0	18	5
A	on()	0	12	3
A	from()	0	4	1
A	executeOn()	0	10	2
A	executeOnMulitpleResources()	0	10	2
A	execute()	0	8	1

<?php

namespace Laravel\Forge\Commands;

use Laravel\Forge\Contracts\ResourceContract;
use InvalidArgumentException;

abstract class Command
{
    /**
     * Command payload.
     *
     * @var array
     */
    protected $payload = [];

    /**
     * Command name.
     *
     * @return string
     */
    abstract public function command();

Please use __construct() instead of a PHP4-style constructor that is named after the class.

    /**
     * Command description.
     *
     * @return string
     */
    public function description()
    {
        return '';
    }

    /**
     * Determines if command can run.
     *
     * @return bool
     */
    public function runnable()
    {
        return true;
    }

    /**
     * HTTP request method.
     *
     * @return string
     */
    public function requestMethod()
    {
        return 'POST';
    }

    /**
     * HTTP request URL.
     *
     * @param \Laravel\Forge\Contracts\ResourceContract $owner
     *
     * @return string
     */
    public function requestUrl(ResourceContract $owner)
    {
        return $owner->apiUrl();
    }

    /**
     * HTTP request options.
     *
     * @return array
     */
    public function requestOptions()
    {
        return [
            'form_params' => $this->payload,
        ];
    }

    /**
     * Set command payload.
     *
     * @param array $payload
     *
     * @return static
     */
    public function withPayload(array $payload)
    {
        $this->payload = $payload;

        return $this;
    }

    /**
     * Set payload data.
     *
     * @param string|int $key
     * @param mixed      $value
     *
     * @return static
     */
    public function attachPayload($key, $value)
    {
        if (is_null($this->payload)) {
            $this->payload = [];
        }

        $this->payload[$key] = $value;

        return $this;
    }

    /**
     * Return payload data.
     *
     * @param string|int $key
     * @param mixed      $default = null
     *
     * @return mixed|null
     */
    public function getPayloadData($key, $default = null)
    {
        if (is_null($this->payload)) {
            return;
        }

        return $this->payload[$key] ?? $default;
    }

    /**
     * Determines if payload has requried keys.
     *
     * @param string|int|array $keys
     *
     * @return bool
     */
    public function hasPayloadData($keys): bool
    {
        if (is_null($this->payload)) {
            return false;
        }

        if (!is_array($keys)) {
            $keys = [$keys];
        }

        foreach ($keys as $key) {
            if (!isset($this->payload[$key])) {
                return false;
            }
        }

        return true;
    }

    /**
     * Execute command on single or multiple resources.
     *
     * @param array|\Laravel\Forge\Contracts\ResourceContract $resource
     *
     * @throws \InvalidArgumentException
     *
     * @return bool|array
     */
    public function on($resource)
    {
        if (!$this->runnable()) {
            throw new InvalidArgumentException('Command execution is restricted.');
        }

        if (is_array($resource)) {
            return $this->executeOnMulitpleResources($resource);
        }

        return $this->executeOn($resource);
    }

    /**
     * Alias for "on" command.
     *
     * @param array|\Laravel\Forge\Contracts\ResourceContract $resource
     *
     * @throws \InvalidArgumentException
     *
     * @see \Laravel\Forge\Services\Commands\AbstractServiceCommand::on
     *
     * @return bool|array
     */
    public function from($resource)
    {
        return $this->on($resource);
    }

    /**
     * Execute current command on given resource.
     *
     * @param \Laravel\Forge\Contracts\ResourceContract $resource
     *
     * @return bool|mixed
     */
    protected function executeOn(ResourceContract $resource)
    {
        $response = $this->execute($resource);

        if (method_exists($this, 'handleResponse')) {
            return $this->handleResponse($response, $resource);

It seems like you code against a specific sub-type and not the parent class Laravel\Forge\Commands\Command as the method handleResponse() does only exist in the following sub-classes of Laravel\Forge\Commands\Command: Laravel\Forge\Commands\ResourceCommand, Laravel\Forge\Daemons\Commands\CreateDaemonCommand, Laravel\Forge\Daemons\Commands\DaemonCommand, Laravel\Forge\Daemons\Commands\GetDaemonCommand, Laravel\Forge\Daemons\Commands\ListDaemonsCommand, Laravel\Forge\Deployment\Commands\DeployCommand, Laravel\Forge\Deployment\Commands\DisableDeploymentCommand, Laravel\Forge\Deployment\Commands\EnableDeploymentCommand, Laravel\Forge\Deployment\Commands\GetDeploymentLogCommand, Laravel\Forge\Deployment\Commands\GetDeploymentScriptCommand, Laravel\Forge\Deployment\Commands\ResetDeploymentStatusCommand, Laravel\Forge\Deployment\Commands\UpdateDeploymentScriptCommand, Laravel\Forge\Firewall\Commands\CreateFirewallRuleCommand, Laravel\Forge\Firewall\Commands\FirewallRuleCommand, Laravel\Forge\Firewall\Commands\GetFirewallRuleCommand, Laravel\Forge\Firewall\Commands\ListFirewallRulesCommand, Laravel\Forge\Jobs\Commands\CreateJobCommand, Laravel\Forge\Jobs\Commands\GetJobCommand, Laravel\Forge\Jobs\Commands\JobCommand, Laravel\Forge\Jobs\Commands\ListJobsCommand, Laravel\Forge\Services\Mysql\Commands\CreateMysqlDatabaseCommand, Laravel\Forge\Services\Mysql\Commands\CreateMysqlUserCommand, Laravel\Forge\Services\Mysql\Commands\GetMysqlDatabaseCommand, Laravel\Forge\Services\Mysql\Commands\GetMysqlUserCommand, Laravel\Forge\Services\Mysql\Commands\ListMysqlDatabasesCommand, Laravel\Forge\Services\Mysql\Commands\ListMysqlUsersCommand, Laravel\Forge\Services\Mysql\Commands\MysqlDatabaseCommand, Laravel\Forge\Services\Mysql\Commands\MysqlUserCommand, Laravel\Forge\Sites\Commands\CreateSiteCommand, Laravel\Forge\Sites\Commands\GetSiteCommand, Laravel\Forge\Sites\Commands\ListSitesCommand, Laravel\Forge\Sites\Commands\SiteCommand, Laravel\Forge\SshKeys\Commands\CreateSshKeyCommand, Laravel\Forge\SshKeys\Commands\GetSshKeyCommand, Laravel\Forge\SshKeys\Commands\ListSshKeysCommand, Laravel\Forge\SshKeys\Commands\SshKeyCommand, Laravel\Forge\Workers\Commands\CreateWorkerCommand, Laravel\Forge\Workers\Commands\GetWorkerCommand, Laravel\Forge\Workers\Commands\ListWorkersCommand, Laravel\Forge\Workers\Commands\WorkerCommand. Maybe you want to instanceof check for one of these explicitly?

        }

        return true;
    }

    /**
     * Execute current command on multiple resources.
     *
     * @param array $resources
     *
     * @return array
     */
    protected function executeOnMulitpleResources(array $resources): array
    {
        $results = [];

        foreach ($resources as $resource) {
            $results[$resource->name()] = $this->executeOn($resource);
        }

        return $results;
    }

    /**
     * Execute current command.
     *
     * @param \Laravel\Forge\Contracts\ResourceContract $resource
     */
    protected function execute(ResourceContract $resource)
    {
        return $resource->getHttpClient()->request(
            $this->requestMethod(),
            $this->requestUrl($resource),
            $this->requestOptions()
        );
    }
}