interface PluralFormulaInterface in Drupal 9

An interface for a service providing plural formulae.

Hierarchy

• interface \Drupal\locale\PluralFormulaInterface

File

core/modules/locale/src/PluralFormulaInterface.php, line 8

Namespace

Drupal\locale

interface PluralFormulaInterface {

  /**
   * @param string $langcode
   *   The language code to get the formula for.
   * @param int $plural_count
   *   The number of plural forms.
   * @param array $formula
   *   An array of formulae.
   *
   * @return self
   *   The PluralFormula object.
   */
  public function setPluralFormula($langcode, $plural_count, array $formula);

  /**
   * Returns the number of plurals supported by a given language.
   *
   * @param null|string $langcode
   *   (optional) The language code. If not provided, the current language
   *   will be used.
   *
   * @return int
   *   Number of plural variants supported by the given language.
   */
  public function getNumberOfPlurals($langcode = NULL);

  /**
   * Gets the plural formula for a langcode.
   *
   * @param string $langcode
   *   The language code to get the formula for.
   *
   * @return array
   *   An array of formulae.
   */
  public function getFormula($langcode);

  /**
   * Resets the static formulae cache.
   *
   * @return self
   *   The PluralFormula object.
   */
  public function reset();

}

Members

Name	Modifiers	Type	Description	Overrides
PluralFormulaInterface::getFormula	public	function	Gets the plural formula for a langcode.	1
PluralFormulaInterface::getNumberOfPlurals	public	function	Returns the number of plurals supported by a given language.	1
PluralFormulaInterface::reset	public	function	Resets the static formulae cache.	1
PluralFormulaInterface::setPluralFormula	public	function		1