MapEvent.php in Sophron 8

Namespace

Drupal\sophron\Event

File

src/Event/MapEvent.php

<?php

namespace Drupal\sophron\Event;

use Symfony\Component\EventDispatcher\Event;

/**
 * Defines the MapEvent.
 */
class MapEvent extends Event {

  /**
   * Fires when a MimeMap map is initialized in Sophron.
   *
   * @Event
   *
   * @var string
   */
  const INIT = 'sophron.map.initialize';

  /**
   * The MimeMap class being processed.
   *
   * @var string
   */
  protected $mapClass;

  /**
   * An array of errors collected by the event.
   *
   * @var array
   */
  protected $errors = [];

  /**
   * Constructs the object.
   *
   * @param string $map_class
   *   The MimeMap class being processed.
   */
  public function __construct($map_class) {
    $this->mapClass = $map_class;
  }

  /**
   * Returns the MimeMap class being processed.
   *
   * @return string
   *   The MimeMap class being processed.
   */
  public function getMapClass() {
    return $this->mapClass;
  }

  /**
   * Adds an error.
   *
   * @param string $method
   *   An identifier of the method where the error occurred.
   * @param array $args
   *   An array of arguments passed to the method.
   * @param string $type
   *   An identifier of the type of the error.
   * @param string $message
   *   A messagge detailing the error.
   */
  public function addError($method, array $args, $type, $message) {
    $this->errors[] = [
      'method' => $method,
      'args' => $args,
      'type' => $type,
      'message' => $message,
    ];
    return $this;
  }

  /**
   * Returns the errors collected during the processing of the event.
   *
   * @return array
   *   The array of errors collected.
   */
  public function getErrors() {
    return $this->errors;
  }

}

Classes

Name	Description
MapEvent	Defines the MapEvent.