Event.php

<?php

declare (strict_types=1);

/*
 * This file is part of Composer.
 *
 * (c) Nils Adermann <naderman@naderman.de>
 *     Jordi Boggiano <j.boggiano@seld.be>
 *
 * For the full copyright and license information, please view the LICENSE
 * file that was distributed with this source code.
 */
namespace Composer\Script;

use Composer\Composer;
use Composer\IO\IOInterface;
use Composer\EventDispatcher\Event as BaseEvent;

/**
 * The script event class
 *
 * @author François Pluchino <francois.pluchino@opendisplay.com>
 * @author Nils Adermann <naderman@naderman.de>
 */
class Event extends BaseEvent {
    
    /**
     * @var Composer The composer instance
     */
    private $composer;
    
    /**
     * @var IOInterface The IO instance
     */
    private $io;
    
    /**
     * @var bool Dev mode flag
     */
    private $devMode;
    
    /**
     * @var BaseEvent|null
     */
    private $originatingEvent;
    
    /**
     * Constructor.
     *
     * @param string $name The event name
     * @param Composer $composer The composer object
     * @param IOInterface $io The IOInterface object
     * @param bool $devMode Whether or not we are in dev mode
     * @param array<string|int|float|bool|null> $args Arguments passed by the user
     * @param mixed[] $flags Optional flags to pass data not as argument
     */
    public function __construct(string $name, Composer $composer, IOInterface $io, bool $devMode = false, array $args = [], array $flags = []) {
        parent::__construct($name, $args, $flags);
        $this->composer = $composer;
        $this->io = $io;
        $this->devMode = $devMode;
    }
    
    /**
     * Returns the composer instance.
     */
    public function getComposer() : Composer {
        return $this->composer;
    }
    
    /**
     * Returns the IO instance.
     */
    public function getIO() : IOInterface {
        return $this->io;
    }
    
    /**
     * Return the dev mode flag
     */
    public function isDevMode() : bool {
        return $this->devMode;
    }
    
    /**
     * Set the originating event.
     *
     * @return ?BaseEvent
     */
    public function getOriginatingEvent() : ?BaseEvent {
        return $this->originatingEvent;
    }
    
    /**
     * Set the originating event.
     *
     * @return $this
     */
    public function setOriginatingEvent(BaseEvent $event) : self {
        $this->originatingEvent = $this->calculateOriginatingEvent($event);
        return $this;
    }
    
    /**
     * Returns the upper-most event in chain.
     */
    private function calculateOriginatingEvent(BaseEvent $event) : BaseEvent {
        if ($event instanceof Event && $event->getOriginatingEvent()) {
            return $this->calculateOriginatingEvent($event->getOriginatingEvent());
        }
        return $event;
    }

}