class MessageEvents

@author Fabien Potencier <fabien@symfony.com>

Hierarchy

class \Symfony\Component\Mailer\Event\MessageEvents

Expanded class hierarchy of MessageEvents

3 files declare their use of MessageEvents

EmailCount.php in vendor/symfony/mailer/Test/Constraint/EmailCount.php
MessageDataCollector.php in vendor/symfony/mailer/DataCollector/MessageDataCollector.php
MessageLoggerListener.php in vendor/symfony/mailer/EventListener/MessageLoggerListener.php

File

vendor/symfony/mailer/Event/MessageEvents.php, line 19

Namespace

Symfony\Component\Mailer\Event

View source

class MessageEvents {
    
    /**
     * @var MessageEvent[]
     */
    private array $events = [];
    
    /**
     * @var array<string, bool>
     */
    private array $transports = [];
    public function add(MessageEvent $event) : void {
        $this->events[] = $event;
        $this->transports[$event->getTransport()] = true;
    }
    public function getTransports() : array {
        return array_keys($this->transports);
    }
    
    /**
     * @return MessageEvent[]
     */
    public function getEvents(?string $name = null) : array {
        if (null === $name) {
            return $this->events;
        }
        $events = [];
        foreach ($this->events as $event) {
            if ($name === $event->getTransport()) {
                $events[] = $event;
            }
        }
        return $events;
    }
    
    /**
     * @return RawMessage[]
     */
    public function getMessages(?string $name = null) : array {
        $events = $this->getEvents($name);
        $messages = [];
        foreach ($events as $event) {
            $messages[] = $event->getMessage();
        }
        return $messages;
    }

}

Members

Title Sort descending	Modifiers	Object type
MessageEvents::$events	private	property
MessageEvents::$transports	private	property
MessageEvents::add	public	function
MessageEvents::getEvents	public	function
MessageEvents::getMessages	public	function
MessageEvents::getTransports	public	function