Executor::getEventManager() - Code Metrics - Inspection of "add Executor tests" - t4web/Cron - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — master ( 0f4012...9997db )

by max

created 2016-02-26 10:34 UTC

Executor::getEventManager() A

↳ Parent: Executor

Complexity

Conditions	2
Paths	2

Size

Total Lines	9
Code Lines	5

Duplication

Lines	0
Ratio	0 %

Importance

Changes	1
Bugs	0	Features	1

Metric	Value
c	1
b	0
f	1
dl	0
loc	9
rs	9.6666
cc	2
eloc	5
nc	2
nop	0

<?php

namespace T4web\Cron\Executor;

use Zend\EventManager\EventManager;
use Cron\Job\JobInterface;
use Cron\Report\ReportInterface;
use Cron\Report\CronReport;
use Cron\Executor\ExecutorInterface;
use T4web\Cron\JobEndedEvent;
use T4web\Cron\Job\ShellJob;

class Executor implements ExecutorInterface
{
    /**
     * @var JobInterface[]
     */
    private $jobs;

    /**
     * @var EventManager
     */
    private $eventManager;

    /**
     * @var array
     */
    private $processedJobs = [];

    /**
     * @param JobInterface[] $jobs
     *
     * @return ReportInterface
     */
    public function execute(array $jobs)
    {
        $report = new CronReport();

        $this->jobs = $jobs;
        $this->startProcesses($report);

        return $report;
    }

    /**
     * @param CronReport $report
     */
    protected function startProcesses(CronReport $report)
    {
        foreach ($this->jobs as $job) {
            $report->addJobReport($job->getReport());
interface User
{
    /** @return string */
    public function getPassword();
}

class MyUser implements User
{
    public function getPassword()
    {
        // return something
    }

    public function getDisplayName()
    {
        // return some name.
    }
}

class AuthSystem
{
    public function authenticate(User $user)
    {
        $this->logger->info(sprintf('Authenticating %s.', $user->getDisplayName()));
        // do something.
    }
}
            // :) brilliantly
            $job->run($job->getReport());
interface User
{
    /** @return string */
    public function getPassword();
}

class MyUser implements User
{
    public function getPassword()
    {
        // return something
    }

    public function getDisplayName()
    {
        // return some name.
    }
}

class AuthSystem
{
    public function authenticate(User $user)
    {
        $this->logger->info(sprintf('Authenticating %s.', $user->getDisplayName()));
        // do something.
    }
}
        }
    }

    private function getEventManager()
    {
        if (!$this->eventManager) {
            $this->eventManager = new EventManager();
            $this->eventManager->setIdentifiers(get_class($this));
        }

        return $this->eventManager;
    }

    /**
     * @return bool
     */
    public function isRunning()
    {
        $isRunning = false;

        foreach ($this->jobs as $id => $job) {
            if ($job->isRunning()) {
                $isRunning = true;
            } else {

                if (isset($this->processedJobs[$id])) {
                    continue;
                }

                $event = new JobEndedEvent();
                $event->setTarget($this);
                $event->setJob($job);

                $event->setReport($job->getReport());
interface User
{
    /** @return string */
    public function getPassword();
}

class MyUser implements User
{
    public function getPassword()
    {
        // return something
    }

    public function getDisplayName()
    {
        // return some name.
    }
}

class AuthSystem
{
    public function authenticate(User $user)
    {
        $this->logger->info(sprintf('Authenticating %s.', $user->getDisplayName()));
        // do something.
    }
}
                $this->getEventManager()->trigger($event);

                $this->processedJobs[$id] = true;
            }
        }

        return $isRunning;
    }

    /**
     * @return ShellJob[]
     */
    public function getRunningJobs()
    {
        $jobs = [];
        foreach ($this->jobs as $job) {
            if ($job->isRunning()) {
                $jobs[] = $job;
            }
        }

        return $jobs;
    }
}


1			<?php
2
3			namespace T4web\Cron\Executor;
4
5			use Zend\EventManager\EventManager;
6			use Cron\Job\JobInterface;
7			use Cron\Report\ReportInterface;
8			use Cron\Report\CronReport;
9			use Cron\Executor\ExecutorInterface;
10			use T4web\Cron\JobEndedEvent;
11			use T4web\Cron\Job\ShellJob;
12
13			class Executor implements ExecutorInterface
14			{
15			/**
16			* @var JobInterface[]
17			*/
18			private $jobs;
19
20			/**
21			* @var EventManager
22			*/
23			private $eventManager;
24
25			/**
26			* @var array
27			*/
28			private $processedJobs = [];
29
30			/**
31			* @param JobInterface[] $jobs
32			*
33			* @return ReportInterface
34			*/
35			public function execute(array $jobs)
36			{
37			$report = new CronReport();
38
39			$this->jobs = $jobs;
40			$this->startProcesses($report);
41
42			return $report;
43			}
44
45			/**
46			* @param CronReport $report
47			*/
48			protected function startProcesses(CronReport $report)
49			{
50			foreach ($this->jobs as $job) {
51			$report->addJobReport($job->getReport());
			0 ignored issues – show Bug introduced 2016-02-26 10:37 UTC by Report Bug Copy Issue Report It seems like you code against a concrete implementation and not the interface `Cron\Job\JobInterface` as the method `getReport()` does only exist in the following implementations of said interface: `T4web\Cron\Job\ShellJob`. Let’s take a look at an example: interface User { /** @return string / public function getPassword(); } class MyUser implements User { public function getPassword() { // return something } public function getDisplayName() { // return some name. } } class AuthSystem { public function authenticate(User $user) { $this->logger->info(sprintf('Authenticating %s.', $user->getDisplayName())); // do something. } } In the above example, the authenticate() method works fine as long as you just pass instances of MyUser. However, if you now also want to pass a different implementation of User which does not have a getDisplayName() method, the code will break. Available Fixes Change the type-hint for the parameter: class AuthSystem { public function authenticate(MyUser $user) { / ... / } } Add an additional type-check: class AuthSystem { public function authenticate(User $user) { if ($user instanceof MyUser) { $this->logger->info(/* ... /); } // or alternatively if ( ! $user instanceof MyUser) { throw new \LogicException( '$user must be an instance of MyUser, ' .'other instances are not supported.' ); } } } Note:* PHP Analyzer uses reverse abstract interpretation to narrow down the types inside the if block in such a case. Add the method to the interface: interface User { /** @return string / public function getPassword(); /* @return string */ public function getDisplayName(); } Loading history...
52			// :) brilliantly
53			$job->run($job->getReport());
			0 ignored issues – show Bug introduced 2016-02-26 10:37 UTC by Report Bug Copy Issue Report It seems like you code against a concrete implementation and not the interface `Cron\Job\JobInterface` as the method `getReport()` does only exist in the following implementations of said interface: `T4web\Cron\Job\ShellJob`. Let’s take a look at an example: interface User { /** @return string / public function getPassword(); } class MyUser implements User { public function getPassword() { // return something } public function getDisplayName() { // return some name. } } class AuthSystem { public function authenticate(User $user) { $this->logger->info(sprintf('Authenticating %s.', $user->getDisplayName())); // do something. } } In the above example, the authenticate() method works fine as long as you just pass instances of MyUser. However, if you now also want to pass a different implementation of User which does not have a getDisplayName() method, the code will break. Available Fixes Change the type-hint for the parameter: class AuthSystem { public function authenticate(MyUser $user) { / ... / } } Add an additional type-check: class AuthSystem { public function authenticate(User $user) { if ($user instanceof MyUser) { $this->logger->info(/* ... /); } // or alternatively if ( ! $user instanceof MyUser) { throw new \LogicException( '$user must be an instance of MyUser, ' .'other instances are not supported.' ); } } } Note:* PHP Analyzer uses reverse abstract interpretation to narrow down the types inside the if block in such a case. Add the method to the interface: interface User { /** @return string / public function getPassword(); /* @return string */ public function getDisplayName(); } Loading history...
54			}
55			}
56
57			private function getEventManager()
58			{
59			if (!$this->eventManager) {
60			$this->eventManager = new EventManager();
61			$this->eventManager->setIdentifiers(get_class($this));
62			}
63
64			return $this->eventManager;
65			}
66
67			/**
68			* @return bool
69			*/
70			public function isRunning()
71			{
72			$isRunning = false;
73
74			foreach ($this->jobs as $id => $job) {
75			if ($job->isRunning()) {
76			$isRunning = true;
77			} else {
78
79			if (isset($this->processedJobs[$id])) {
80			continue;
81			}
82
83			$event = new JobEndedEvent();
84			$event->setTarget($this);
85			$event->setJob($job);
			0 ignored issues – show Compatibility introduced 2016-02-26 10:37 UTC by Report Bug Copy Issue Report `$job` of type `object<Cron\Job\JobInterface>` is not a sub-type of `object<T4web\Cron\Job\ShellJob>`. It seems like you assume a concrete implementation of the interface `Cron\Job\JobInterface` to be always present. This check looks for parameters that are defined as one type in their type hint or doc comment but seem to be used as a narrower type, i.e an implementation of an interface or a subclass. Consider changing the type of the parameter or doing an instanceof check before assuming your parameter is of the expected type. Loading history...
86			$event->setReport($job->getReport());
			0 ignored issues – show Bug introduced 2016-02-26 10:37 UTC by Report Bug Copy Issue Report It seems like you code against a concrete implementation and not the interface `Cron\Job\JobInterface` as the method `getReport()` does only exist in the following implementations of said interface: `T4web\Cron\Job\ShellJob`. Let’s take a look at an example: interface User { /** @return string / public function getPassword(); } class MyUser implements User { public function getPassword() { // return something } public function getDisplayName() { // return some name. } } class AuthSystem { public function authenticate(User $user) { $this->logger->info(sprintf('Authenticating %s.', $user->getDisplayName())); // do something. } } In the above example, the authenticate() method works fine as long as you just pass instances of MyUser. However, if you now also want to pass a different implementation of User which does not have a getDisplayName() method, the code will break. Available Fixes Change the type-hint for the parameter: class AuthSystem { public function authenticate(MyUser $user) { / ... / } } Add an additional type-check: class AuthSystem { public function authenticate(User $user) { if ($user instanceof MyUser) { $this->logger->info(/* ... /); } // or alternatively if ( ! $user instanceof MyUser) { throw new \LogicException( '$user must be an instance of MyUser, ' .'other instances are not supported.' ); } } } Note:* PHP Analyzer uses reverse abstract interpretation to narrow down the types inside the if block in such a case. Add the method to the interface: interface User { /** @return string / public function getPassword(); /* @return string */ public function getDisplayName(); } Loading history...
87			$this->getEventManager()->trigger($event);
88
89			$this->processedJobs[$id] = true;
90			}
91			}
92
93			return $isRunning;
94			}
95
96			/**
97			* @return ShellJob[]
98			*/
99			public function getRunningJobs()
100			{
101			$jobs = [];
102			foreach ($this->jobs as $job) {
103			if ($job->isRunning()) {
104			$jobs[] = $job;
105			}
106			}
107
108			return $jobs;
109			}
110			}
111

t4web / Cron

Push — master ( 0f4012...9997db )

Executor::getEventManager() A

Complexity

Size

Duplication

Importance

Available Fixes

Available Fixes

Available Fixes

Duplication Side-by-Side

Filter issues like