Basebuilder\Scheduling\Schedule

Complexity

Total Complexity

6

Size/Duplication

Total Lines	79
Duplicated Lines	0 %

Coupling/Cohesion

Components	1
Dependencies	2

Test Coverage

Coverage

78.95%

Importance

Changes	1
Bugs	0	Features	0

6 Methods

Rating	Name	Duplication	Size	Complexity
A	__construct()	0	6	1
A	getName()	0	4	1
A	add()	0	6	1
A	run()	0	9	1
A	allEvents()	0	4	1
A	dueEvents()	0	6	1

<?php

namespace Basebuilder\Scheduling;
use Webmozart\Assert\Assert;

/**
 * This class will allow you to register commands and retrieve all events that are due for processing
 */
class Schedule
{
    /**
     * Stack of events
     * @var Event[]
     */
    protected $events = [];

    /**
     * @var string|null
     */
    protected $name;

    public function __construct(/* string */ $name = null)
    {
        Assert::nullOrString($name);

        $this->name = $name;
    }

    /**
     * Get the name of this schedule
     *
     * @return string|null
     */
    public function getName()
    {
        return $this->name;
    }

    /**
     * Add a single Event to the stack
     *
     * @param Event $event
     * @return $this
     */
    public function add(Event $event)
    {
        $this->events[] = $event;

        return $this;
    }

    /**
     * Creates a new Event, adds it to the schedule stack and returns you the instance so you can configure it
     *
     * @param  string $command
     * @return Event
     */
    public function run(/* string */ $command)
    {
        Assert::stringNotEmpty($command);
        $event = new Event($command);

        $this->add($event);

        return $event;
    }

    /**
     * @return Event[]
     */
    public function allEvents()
    {
        return $this->events;
    }

    /**
     * Get all of the events on the schedule that are due.
     *
     * @return Event[]
     */
    public function dueEvents()
    {
        return array_filter($this->events, function (Event $event) {
            return $event->isDue();
        });
    }
}