Comodojo\Extender\Orm\Entities\Schedule

Complexity

Total Complexity

16

Size/Duplication

Total Lines	270
Duplicated Lines	0 %

Coupling/Cohesion

Components	1
Dependencies	4

Importance

Changes

0

14 Methods

Rating	Name	Duplication	Size	Complexity
A	getDescription()	0	5	1
A	setDescription()	0	7	1
A	getExpression()	0	5	1
A	setExpression()	0	12	1
A	getEnabled()	0	5	1
A	getFirstrun()	0	5	1
A	setFirstrun()	0	7	1
A	getLastrun()	0	5	1
A	setLastrun()	0	7	1
A	setEnabled()	0	9	1
A	shouldRunJob()	0	12	3
A	getNextPlannedRun()	0	16	1
A	merge()	0	10	1
A	buildExpression()	0	14	1

<?php namespace Comodojo\Extender\Orm\Entities;

use \Doctrine\ORM\Mapping as ORM;
use \Comodojo\Extender\Traits\BaseEntityTrait;
use \Comodojo\Extender\Traits\RequestEntityTrait;
use \Cron\CronExpression;
use \Comodojo\Foundation\Validation\DataFilter;
use \DateTime;

/**
 * @package     Comodojo Extender
 * @author      Marco Giovinazzi <marco.giovinazzi@comodojo.org>
 * @license     MIT
 *
 * LICENSE:
 *
 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
 * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
 * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
 * THE SOFTWARE.
 *
 * @ORM\Table(name="extender_schedule")
 * @ORM\Entity
 */

class Schedule {

    use BaseEntityTrait;
    use RequestEntityTrait;

    /**
     * @var string
     *
     * @ORM\Column(name="name", type="string", length=256, nullable=false, unique=true)
     */
    protected $name;

    /**
     * @var string
     *
     * @ORM\Column(name="description", type="text", length=65535, nullable=true)
     */
    protected $description;

    /**
     * @var string
     *
     * @ORM\Column(name="minute", type="string", length=16, nullable=false)
     */
    protected $minute;

    /**
     * @var string
     *
     * @ORM\Column(name="hour", type="string", length=16, nullable=false)
     */
    protected $hour;

    /**
     * @var string
     *
     * @ORM\Column(name="day", type="string", length=16, nullable=false)
     */
    protected $day;

    /**
     * @var string
     *
     * @ORM\Column(name="month", type="string", length=16, nullable=false)
     */
    protected $month;

    /**
     * @var string
     *
     * @ORM\Column(name="weekday", type="string", length=16, nullable=false)
     */
    protected $weekday;

    /**
     * @var string
     *
     * @ORM\Column(name="year", type="string", length=16, nullable=true)
     */
    protected $year;

    /**
     * @var boolean
     *
     * @ORM\Column(name="enabled", type="boolean", nullable=false)
     */
    protected $enabled = false;

    /**
     * @var datetime
     *
     * @ORM\Column(name="firstrun", type="datetime", nullable=true)
     */
    protected $firstrun;

    /**
     * @var datetime
     *
     * @ORM\Column(name="lastrun", type="datetime", nullable=true)
     */
    protected $lastrun;

    /**
     * Get a brief job description
     *
     * @return string
     */
    public function getDescription() {

        return $this->description;

    }

    /**
     * Set brief job description
     *
     * @param string $description
     * @return Schedule
     */
    public function setDescription($description) {

        $this->description = $description;

        return $this;

    }

    /**
     * Get cron expression of this schedule
     *
     * @return string
     */
    public function getExpression() {

        return $this->buildExpression();

    }

    /**
     * set cron expression for this schedule
     *
     * @param srting $expression A cron-compatible expression
     * @return Schedule
     */
    public function setExpression(CronExpression $expression) {

        $this->minute = $expression->getExpression(0);
        $this->hour = $expression->getExpression(1);
        $this->day = $expression->getExpression(2);
        $this->month = $expression->getExpression(3);
        $this->weekday = $expression->getExpression(4);
        $this->year = $expression->getExpression(5);

        return $this;

    }

    /**
     * True if job is currently enabled
     *
     * @return bool
     */
    public function getEnabled() {

        return $this->enabled;

    }

    /**
     * Set enable/disable status
     *
     * @param bool $enable

There is no parameter named $enable. Did you maybe mean $enabled?

     * @return Schedule
     */
    public function setEnabled($enabled) {

        $ena = DataFilter::filterBoolean($enabled);

        $this->enabled = $ena;

        return $this;

    }

    /**
     * Get the first-run-date of job
     *
     * @return DateTime
     */
    public function getFirstrun() {

        return $this->firstrun;

    }

    /**
     * Set the first-run-date of job
     *
     * @param DateTime $datetime
     * @return Schedule
     */
    public function setFirstrun(DateTime $datetime) {

        $this->firstrun = $datetime;

It seems like $datetime of type object<DateTime> is incompatible with the declared type object<Comodojo\Extender\Orm\Entities\datetime> of property $firstrun.

        return $this;

    }

    /**
     * Get the first-run-date of job
     *
     * @return DateTime
     */
    public function getLastrun() {

        return $this->lastrun;

    }

    /**
     * Set the first-run-date of job
     *
     * @param DateTime $datetime
     * @return Schedule
     */
    public function setLastrun(DateTime $datetime) {

        $this->lastrun = $datetime;

It seems like $datetime of type object<DateTime> is incompatible with the declared type object<Comodojo\Extender\Orm\Entities\datetime> of property $lastrun.

        return $this;

    }

    public function shouldRunJob(DateTime $time) {

        $first_run = $this->getFirstrun();
        $last_run = $this->getLastrun();

        $next_run = $this->buildExpression()->getNextRunDate(is_null($last_run) ? $first_run : $last_run);

        return $next_run <= $time ? true : false;

        // return $time <= $next_run;

40% of this comment could be valid code. Did you maybe forget this after debugging?

    }

    public function getNextPlannedRun(DateTime $time) {

        // $first_run = $this->getFirstrun();

55% of this comment could be valid code. Did you maybe forget this after debugging?

        // $last_run = $this->getLastrun();

55% of this comment could be valid code. Did you maybe forget this after debugging?

        //
        // if ( is_null($last_run) ) {

54% of this comment could be valid code. Did you maybe forget this after debugging?

        //     $next_run = $this->getFirstrun();

55% of this comment could be valid code. Did you maybe forget this after debugging?

        // } else {

50% of this comment could be valid code. Did you maybe forget this after debugging?

        //     $next_run = $this->buildExpression()->getNextRunDate($time);

63% of this comment could be valid code. Did you maybe forget this after debugging?

        // }
        //
        // return $next_run;

        return $this->buildExpression()->getNextRunDate($time);

    }

    public function merge(Schedule $schedule) {

        $this->setName($schedule->getName())
            ->setDescription($schedule->getDescription())
            ->setExpression($schedule->getExpression())
            ->setEnabled($schedule->getEnabled());

        return $this;

    }

    protected function buildExpression() {

        $exp_string = implode(" ", [
            $this->minute,
            $this->hour,
            $this->day,
            $this->month,
            $this->weekday,
            $this->year
        ]);

        return CronExpression::factory($exp_string);

    }
}