class LocaleEvent in Zircon Profile 8

Defines a Locale event.

Hierarchy

• class \Symfony\Component\EventDispatcher\Event
  • class \Drupal\locale\LocaleEvent

1 file declares its use of LocaleEvent

locale.module in core/modules/locale/locale.module

Enables the translation of the user interface to languages other than English.

File

core/modules/locale/src/LocaleEvent.php, line 15

Contains \Drupal\locale\LocaleEvent.

Namespace

Drupal\locale

class LocaleEvent extends Event {

  /**
   * The list of Language codes for updated translations.
   *
   * @var string[]
   */
  protected $langCodes;

  /**
   * List of string identifiers that have been updated / created.
   *
   * @var string[]
   */
  protected $original;

  /**
   * Constructs a new LocaleEvent.
   *
   * @param array $lang_codes
   *   Language codes for updated translations.
   * @param array $lids
   *   (optional) List of string identifiers that have been updated / created.
   */
  public function __construct(array $lang_codes, array $lids = array()) {
    $this->langCodes = $lang_codes;
    $this->lids = $lids;
  }

  /**
   * Returns the language codes.
   *
   * @return string[] $langCodes
   */
  public function getLangCodes() {
    return $this->langCodes;
  }

  /**
   * Returns the string identifiers.
   *
   * @return array $lids
   */
  public function getLids() {
    return $this->lids;
  }

}

Members

Name	Modifiers	Type	Description	Overrides
Event::$dispatcher	private	property
Event::$name	private	property
Event::$propagationStopped	private	property
Event::getDispatcher Deprecated	public	function	Returns the EventDispatcher that dispatches this Event.
Event::getName Deprecated	public	function	Gets the event's name.
Event::isPropagationStopped	public	function	Returns whether further event listeners should be triggered.
Event::setDispatcher Deprecated	public	function	Stores the EventDispatcher that dispatches this Event.
Event::setName Deprecated	public	function	Sets the event's name property.
Event::stopPropagation	public	function	Stops the propagation of the event to further event listeners.
LocaleEvent::$langCodes	protected	property	The list of Language codes for updated translations.
LocaleEvent::$original	protected	property	List of string identifiers that have been updated / created.
LocaleEvent::getLangCodes	public	function	Returns the language codes.
LocaleEvent::getLids	public	function	Returns the string identifiers.
LocaleEvent::__construct	public	function	Constructs a new LocaleEvent.