interface PluralFormulaInterface

Same name in other branches
  1. 9 core/modules/locale/src/PluralFormulaInterface.php \Drupal\locale\PluralFormulaInterface
  2. 8.9.x core/modules/locale/src/PluralFormulaInterface.php \Drupal\locale\PluralFormulaInterface
  3. 11.x core/modules/locale/src/PluralFormulaInterface.php \Drupal\locale\PluralFormulaInterface

An interface for a service providing plural formulae.

Hierarchy

Expanded class hierarchy of PluralFormulaInterface

All classes that implement PluralFormulaInterface

File

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

Namespace

Drupal\locale
View source 
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

Title Modifiers Object type Summary
PluralFormulaInterface::getFormula public function Gets the plural formula for a langcode.
PluralFormulaInterface::getNumberOfPlurals public function Returns the number of plurals supported by a given language.
PluralFormulaInterface::reset public function Resets the static formulae cache.
PluralFormulaInterface::setPluralFormula public function

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