NextFlow\Core\Scene\Scene

Complexity

Total Complexity

12

Size/Duplication

Total Lines	107
Duplicated Lines	0 %

Coupling/Cohesion

Components	1
Dependencies	1

Importance

Changes	1
Bugs	0	Features	0

8 Methods

Rating	Name	Duplication	Size	Complexity
A	__construct()	0	4	1
A	execute()	0	13	3
A	addEvent()	0	6	2
A	clearEvents()	0	4	1
A	getEvents()	0	4	1
A	getName()	0	4	1
A	removeEvent()	0	7	2
A	setName()	0	4	1

<?php
/**
 * NextFlow (http://github.com/nextflow)
 *
 * @link http://github.com/nextflow/nextflow-php for the canonical source repository
 * @copyright Copyright (c) 2014-2016 NextFlow (http://github.com/nextflow)
 * @license https://raw.github.com/nextflow/nextflow-php/master/LICENSE MIT
 */

namespace NextFlow\Core\Scene;

use NextFlow\Core\Event\EventInterface;

/**
 * A scene that contains event nodes that can be executed.
 */
final class Scene implements SceneInterface
{
    /**
     * The name of the scene.
     *
     * @var string
     */
    private $name;

    /**
     * The list with events that can be executed.
     *
     * @var EventInterface[]
     */
    private $events;

    /**
     * Initializes a new instance of this class.
     */
    public function __construct()
    {
        $this->events = array();
    }

    /**
     * Executes the event with the given name.
     *
     * @param string $eventName The name of the event to execute.
     * @return int Returns the amount of events that are executed.
     */
    public function execute($eventName)
    {
        $result = 0;

        foreach ($this->events as $event) {
            if ($event->getName() == $eventName) {
                $event->execute();
                $result++;
            }
        }

        return $result;
    }

    /**
     * Adds the given event to this scene.
     *
     * @param EventInterface $event
     */
    public function addEvent(EventInterface $event)
    {
        if (!in_array($event, $this->events)) {
            $this->events[] = $event;
        }
    }

    /**
     * Clears all the events within the scene.
     */
    public function clearEvents()
    {
        $this->events = array();
    }

    /**
     * Gets a list with all events that are registered.
     *
     * @return EventInterface[]
     */
    public function getEvents()
    {
        return $this->events;
    }

    /**
     * Gets the name of the scene.
     *
     * @return string
     */
    public function getName()
    {
        return $this->name;
    }

    /**
     * Removes the given event from the scene.
     *
     * @param EventInterface $event The event to remove.
     */
    public function removeEvent(EventInterface $event)
    {
        $key = array_search($event, $this->events, true);
        if ($key !== false) {
            unset($this->events[$key]);
        }
    }

    /**
     * Sets the name of the scene.
     *
     * @param string $name The name to set.
     */
    public function setName($name)
    {
        $this->name = (string)$name;
    }
}