BaseTenantableCommand::parseTenantInput() - Code Metrics - tomschlick/townhouse - Measure and Improve Code Quality continuously with Scrutinizer

BaseTenantableCommand::parseTenantInput() A
last analyzed 2017-08-12 04:35 UTC

↳ Parent: BaseTenantableCommand

Complexity

Conditions	3
Paths	3

Size

Total Lines	19
Code Lines	11

Duplication

Lines	0
Ratio	0 %

Importance

Changes

Metric	Value
dl	0
loc	19
rs	9.4285
c	0
b	0
f	0
cc	3
eloc	11
nc	3
nop	0

<?php

namespace TomSchlick\Townhouse;

use Illuminate\Console\Command;
use Illuminate\Support\Collection;
use Symfony\Component\Console\Input\InputOption;

abstract class BaseTenantableCommand extends Command
{
    /**
     * Declare the handle method as final and use it to traverse through tenants.
     */
    final public function handle()
    {
        if (! $this->confirmToProceed()) {

            return;
        }

        /** @var Tenant $tenant */
        foreach ($this->parseTenantInput() as $tenant) {
$collection = json_decode($data, true);
if ( ! is_array($collection)) {
    throw new \RuntimeException('$collection must be an array.');
}

foreach ($collection as $item) { /** ... */ }
            $this->info("Starting for tenant: {$tenant->id} - {$tenant->name}");

            $this->bootstrapTenant($tenant);

            $this->handleTenant($tenant);

            $this->info("\nFinished for tenant: " . $tenant->id);
        }
    }

    /**
     * @param \TomSchlick\Townhouse\Tenant $tenant
     *
     * @return void
     */
    abstract public function handleTenant(Tenant $tenant) : void;

    /**
     * Get or ask for the tenant(s) you'd like to run the commands on.
     *
     * @return \Illuminate\Support\Collection|null
     */
    protected function parseTenantInput() : ?Collection
    {
        if ($this->option('all')) {
            return Tenant::all();
        }

        $input_ids = $this->option('tenant')
            ? $this->option('tenant')
            : $this->ask('Which tenant would you like to use? [tenant_id]');

        return Tenant::find(
            array_map(
                function ($id) {
                    return trim($id);
                },
                explode(',', $input_ids)
            )
        );
    }

    /**
     * Get the console command arguments.
     *
     * @return array
     */
    public function getArguments()
    {
        return [];
    }

    /**
     * Get the console command options.
     *
     * @return array
     */
    protected function getOptions()
    {
        return [
            ['tenant', null, InputOption::VALUE_REQUIRED, 'The tenant you want to run the command as.'],
            ['all', null, InputOption::VALUE_NONE, 'Run all tenants instead of just one.'],
            ['force', null, InputOption::VALUE_NONE, 'Force the operation to run when in production.'],
        ];
    }

    /**
     * Override the fire method as well.
     */
    final public function fire()
    {
        $this->handle();
    }

    /**
     * Make Laravel ready for the tenant we want to run the command on.
     *
     * @param \TomSchlick\Townhouse\Tenant $tenant
     */
    protected function bootstrapTenant(Tenant $tenant)
    {
        if ($this->checkTenantDatabaseExists && ! $tenant->databaseExists()) {
class MyClass { }

$x = new MyClass();
$x->foo = true;
            $this->error('Tenant ' . $tenant->id . ' does not have a database setup.');
        }

        if ($tenant->databaseExists()) {
            $tenant->setCurrentTenantConfiguration();
        }
    }
}


1			<?php
2
3			namespace TomSchlick\Townhouse;
4
5			use Illuminate\Console\Command;
6			use Illuminate\Support\Collection;
7			use Symfony\Component\Console\Input\InputOption;
8
9			abstract class BaseTenantableCommand extends Command
10			{
11			/**
12			* Declare the handle method as final and use it to traverse through tenants.
13			*/
14			final public function handle()
15			{
16			if (! $this->confirmToProceed()) {
			0 ignored issues – show Bug introduced 2017-08-12 03:59 UTC by Report Bug Copy Issue Report The method `confirmToProceed()` does not exist on `TomSchlick\Townhouse\BaseTenantableCommand`. Did you maybe mean `confirm()`? This check marks calls to methods that do not seem to exist on an object. This is most likely the result of a method being renamed without all references to it being renamed likewise. Loading history...
17			return;
18			}
19
20			/** @var Tenant $tenant */
21			foreach ($this->parseTenantInput() as $tenant) {
			0 ignored issues – show Bug introduced 2017-08-12 03:59 UTC by Report Bug Copy Issue Report The expression `$this->parseTenantInput()` of type `object<Illuminate\Support\Collection>\|null` is not guaranteed to be traversable. How about adding an additional type check? There are different options of fixing this problem. If you want to be on the safe side, you can add an additional type-check: $collection = json_decode($data, true); if ( ! is_array($collection)) { throw new \RuntimeException('$collection must be an array.'); } foreach ($collection as $item) { /** ... / } If you are sure that the expression is traversable, you might want to add a doc comment cast* to improve IDE auto-completion and static analysis: /** @var array $collection / $collection = json_decode($data, true); foreach ($collection as $item) { /* .. / } Mark the issue as a false-positive*: Just hover the remove button, in the top-right corner of this issue for more options. Loading history...
22			$this->info("Starting for tenant: {$tenant->id} - {$tenant->name}");
23
24			$this->bootstrapTenant($tenant);
25
26			$this->handleTenant($tenant);
27
28			$this->info("\nFinished for tenant: " . $tenant->id);
29			}
30			}
31
32			/**
33			* @param \TomSchlick\Townhouse\Tenant $tenant
34			*
35			* @return void
36			*/
37			abstract public function handleTenant(Tenant $tenant) : void;
38
39			/**
40			* Get or ask for the tenant(s) you'd like to run the commands on.
41			*
42			* @return \Illuminate\Support\Collection\|null
43			*/
44			protected function parseTenantInput() : ?Collection
45			{
46			if ($this->option('all')) {
47			return Tenant::all();
48			}
49
50			$input_ids = $this->option('tenant')
51			? $this->option('tenant')
52			: $this->ask('Which tenant would you like to use? [tenant_id]');
53
54			return Tenant::find(
55			array_map(
56			function ($id) {
57			return trim($id);
58			},
59			explode(',', $input_ids)
60			)
61			);
62			}
63
64			/**
65			* Get the console command arguments.
66			*
67			* @return array
68			*/
69			public function getArguments()
70			{
71			return [];
72			}
73
74			/**
75			* Get the console command options.
76			*
77			* @return array
78			*/
79			protected function getOptions()
80			{
81			return [
82			['tenant', null, InputOption::VALUE_REQUIRED, 'The tenant you want to run the command as.'],
83			['all', null, InputOption::VALUE_NONE, 'Run all tenants instead of just one.'],
84			['force', null, InputOption::VALUE_NONE, 'Force the operation to run when in production.'],
85			];
86			}
87
88			/**
89			* Override the fire method as well.
90			*/
91			final public function fire()
92			{
93			$this->handle();
94			}
95
96			/**
97			* Make Laravel ready for the tenant we want to run the command on.
98			*
99			* @param \TomSchlick\Townhouse\Tenant $tenant
100			*/
101			protected function bootstrapTenant(Tenant $tenant)
102			{
103			if ($this->checkTenantDatabaseExists && ! $tenant->databaseExists()) {
			0 ignored issues – show Bug introduced 2017-08-12 03:59 UTC by Report Bug Copy Issue Report The property `checkTenantDatabaseExists` does not exist. Did you maybe forget to declare it? In PHP it is possible to write to properties without declaring them. For example, the following is perfectly valid PHP code: class MyClass { } $x = new MyClass(); $x->foo = true; Generally, it is a good practice to explictly declare properties to avoid accidental typos and provide IDE auto-completion: class MyClass { public $foo; } $x = new MyClass(); $x->foo = true; Loading history...
104			$this->error('Tenant ' . $tenant->id . ' does not have a database setup.');
105			}
106
107			if ($tenant->databaseExists()) {
108			$tenant->setCurrentTenantConfiguration();
109			}
110			}
111			}
112

tomschlick / townhouse

BaseTenantableCommand::parseTenantInput() A last analyzed 2017-08-12 04:35 UTC

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like

BaseTenantableCommand::parseTenantInput() A
last analyzed 2017-08-12 04:35 UTC