class LocaleEvent

Defines a Locale event.

Hierarchy

Expanded class hierarchy of 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

View on git.drupalcode.org

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

Namespace

Drupal\locale
View source 
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 array $lids;
  
  /**
   * 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 = []) {
    $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

Title Modifiers Object type Summary
LocaleEvent::$langCodes protected property The list of Language codes for updated translations.
LocaleEvent::$lids 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.

Buggy or inaccurate documentation? Please file an issue. Need support? Need help programming? Connect with the Drupal community.