LocaleEvent.php

Same filename in other branches
  1. 9 core/modules/locale/src/LocaleEvent.php
  2. 8.9.x core/modules/locale/src/LocaleEvent.php
  3. 11.x core/modules/locale/src/LocaleEvent.php

Namespace

Drupal\locale

File

core/modules/locale/src/LocaleEvent.php

View source
<?php

namespace Drupal\locale;

use Drupal\Component\EventDispatcher\Event;

/**
 * Defines a Locale event.
 */
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;
    }

}

Classes

Title Deprecated Summary
LocaleEvent Defines a Locale event.

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