ScheduledCommand::user() - Code Metrics - Indatus/dispatcher - Measure and Improve Code Quality continuously with Scrutinizer

ScheduledCommand::user() A
last analyzed 2016-09-29 01:12 UTC

↳ Parent: ScheduledCommand

Complexity

Conditions	1
Paths	1

Size

Total Lines	4
Code Lines	2

Duplication

Lines	0
Ratio	0 %

Code Coverage

Tests	2
CRAP Score	1

Importance

Changes

Metric	Value
dl	0
loc	4
ccs	2
cts	2
cp	1
rs	10
c	0
b	0
f	0
cc	1
eloc	2
nc	1
nop	0
crap	1

<?php namespace Indatus\Dispatcher\Scheduling;

/**
 * This file is part of Dispatcher
 *
 * (c) Ben Kuhl <[email protected]>
 *
 * For the full copyright and license information, please view the LICENSE
 * file that was distributed with this source code.
 */

use Illuminate\Console\Command;

abstract class ScheduledCommand extends Command implements ScheduledCommandInterface
{
    /**
     * Unfortunately, this has to be here for unit testing
     *
     * @var string
     */
    protected $name = 'scheduledCommand';

    /**
     * User to run the command as
     *
     * @return string Defaults to false to run as default user
     */
    public function user()
    {
        return false;
class Author {
    private $name;

    public function __construct($name) {
        $this->name = $name;
    }

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

abstract class Post {
    public function getAuthor() {
        return 'Johannes';
    }
}

class BlogPost extends Post {
    public function getAuthor() {
        return new Author('Johannes');
    }
}

class ForumPost extends Post { /* ... */ }

function my_function(Post $post) {
    echo strtoupper($post->getAuthor());
}
    }

    /**
     * Environment(s) under which the given command should run
     *
     * @return string|array
     */
    public function environment()
    {
        return '*';
    }

    /**
     * Should this command be allowed to run when application is in maintenance mode
     *
     * @return boolean Defaults to false
     */
    public function runInMaintenanceMode()
    {
        return false;
    }
}


1		<?php namespace Indatus\Dispatcher\Scheduling;
2
3		/**
4		* This file is part of Dispatcher
5		*
6		* (c) Ben Kuhl <[email protected]>
7		*
8		* For the full copyright and license information, please view the LICENSE
9		* file that was distributed with this source code.
10		*/
11
12		use Illuminate\Console\Command;
13
14		abstract class ScheduledCommand extends Command implements ScheduledCommandInterface
15		{
16		/**
17		* Unfortunately, this has to be here for unit testing
18		*
19		* @var string
20		*/
21		protected $name = 'scheduledCommand';
22
23		/**
24		* User to run the command as
25		*
26		* @return string Defaults to false to run as default user
27		*/
28	1	public function user()
29		{
30	1	return false;
		0 ignored issues – show Bug Best Practice introduced 2016-01-13 22:50 UTC by Report Bug Copy Issue Report The return type of `return false;` (`false`) is incompatible with the return type declared by the interface `Indatus\Dispatcher\Sched...dCommandInterface::user` of type `string`. If you return a value from a function or method, it should be a sub-type of the type that is given by the parent type f.e. an interface, or abstract method. This is more formally defined by the Lizkov substitution principle, and guarantees that classes that depend on the parent type can use any instance of a child type interchangably. This principle also belongs to the SOLID principles for object oriented design. Let’s take a look at an example: class Author { private $name; public function __construct($name) { $this->name = $name; } public function getName() { return $this->name; } } abstract class Post { public function getAuthor() { return 'Johannes'; } } class BlogPost extends Post { public function getAuthor() { return new Author('Johannes'); } } class ForumPost extends Post { /* ... */ } function my_function(Post $post) { echo strtoupper($post->getAuthor()); } Our function `my_function` expects a `Post` object, and outputs the author of the post. The base class `Post` returns a simple string and outputting a simple string will work just fine. However, the child class `BlogPost` which is a sub-type of `Post` instead decided to return an `object`, and is therefore violating the SOLID principles. If a `BlogPost` were passed to `my_function`, PHP would not complain, but ultimately fail when executing the `strtoupper` call in its body. Loading history...
31		}
32
33		/**
34		* Environment(s) under which the given command should run
35		*
36		* @return string\|array
37		*/
38	1	public function environment()
39		{
40	1	return '*';
41		}
42
43		/**
44		* Should this command be allowed to run when application is in maintenance mode
45		*
46		* @return boolean Defaults to false
47		*/
48	1	public function runInMaintenanceMode()
49		{
50	1	return false;
51		}
52		}
53

Indatus / dispatcher

ScheduledCommand::user() A last analyzed 2016-09-29 01:12 UTC

Complexity

Size

Duplication

Code Coverage

Importance

Duplication Side-by-Side

Filter issues like

ScheduledCommand::user() A
last analyzed 2016-09-29 01:12 UTC