Joomla CMS  3.8.5 (avec JPlatform 13.1 inclus)
Documentation des API du CMS Joomla en version 3.8.5 et du framework Joomla Platform intégré
Référence de la classe Inflector

Fonctions membres publiques

 addCountableRule ($data)
 
 addWord ($singular, $plural=null)
 
 addPluraliseRule ($data)
 
 addSingulariseRule ($data)
 
 isCountable ($word)
 
 isPlural ($word)
 
 isSingular ($word)
 
 toPlural ($word)
 
 toSingular ($word)
 

Fonctions membres publiques statiques

static getInstance ($new=false)
 

Fonctions membres protégées

 __construct ()
 

Fonctions membres privées

 addRule ($data, $ruleType)
 
 getCachedPlural ($singular)
 
 getCachedSingular ($plural)
 
 matchRegexRule ($word, $ruleType)
 
 setCache ($singular, $plural=null)
 

Attributs privés

 $rules
 
 $cache = array()
 

Attributs privés statiques

static $instance
 

Description détaillée

Joomla Framework String Inflector Class

The Inflector transforms words

Depuis
1.0

Documentation des constructeurs et destructeur

◆ __construct()

__construct ( )
protected

Protected constructor.

Depuis
1.0

Documentation des fonctions membres

◆ addCountableRule()

addCountableRule (   $data)

Adds a countable word.

Paramètres
mixed$dataA string or an array of strings to add.
Renvoie
Inflector Returns this object to support chaining.
Depuis
1.0

Références $data, et Inflector\addRule().

◆ addPluraliseRule()

addPluraliseRule (   $data)

Adds a pluralisation rule.

Paramètres
mixed$dataA string or an array of regex rules to add.
Renvoie
Inflector Returns this object to support chaining.
Depuis
1.0

Références $data, et Inflector\addRule().

◆ addRule()

addRule (   $data,
  $ruleType 
)
private

Adds inflection regex rules to the inflector.

Paramètres
mixed$dataA string or an array of strings or regex rules to add.
string$ruleTypeThe rule type: singular | plural | countable
Renvoie
void
Depuis
1.0
Exceptions
InvalidArgumentException

Références $data, et elseif.

Référencé par Inflector\addCountableRule(), Inflector\addPluraliseRule(), et Inflector\addSingulariseRule().

◆ addSingulariseRule()

addSingulariseRule (   $data)

Adds a singularisation rule.

Paramètres
mixed$dataA string or an array of regex rules to add.
Renvoie
Inflector Returns this object to support chaining.
Depuis
1.0

Références $data, et Inflector\addRule().

◆ addWord()

addWord (   $singular,
  $plural = null 
)

Adds a specific singular-plural pair for a word.

Paramètres
string$singularThe singular form of the word.
string$pluralThe plural form of the word. If omitted, it is assumed the singular and plural are identical.
Renvoie
Inflector Returns this object to support chaining.
Depuis
1.0

Références Inflector\setCache().

◆ getCachedPlural()

getCachedPlural (   $singular)
private

Gets an inflected word from the cache where the singular form is supplied.

Paramètres
string$singularA singular form of a word.
Renvoie
mixed The cached inflection or false if none found.
Depuis
1.0

Référencé par Inflector\isSingular(), Inflector\toPlural(), et Inflector\toSingular().

◆ getCachedSingular()

getCachedSingular (   $plural)
private

Gets an inflected word from the cache where the plural form is supplied.

Paramètres
string$pluralA plural form of a word.
Renvoie
mixed The cached inflection or false if none found.
Depuis
1.0

Référencé par Inflector\isPlural(), Inflector\toPlural(), et Inflector\toSingular().

◆ getInstance()

static getInstance (   $new = false)
static

Gets an instance of the JStringInflector singleton.

Paramètres
boolean$newIf true (default is false), returns a new instance regardless if one exists. This argument is mainly used for testing.
Renvoie
Inflector
Depuis
1.0

Références elseif.

◆ isCountable()

isCountable (   $word)

Checks if a word is countable.

Paramètres
string$wordThe string input.
Renvoie
boolean True if word is countable, false otherwise.
Depuis
1.0

◆ isPlural()

isPlural (   $word)

Checks if a word is in a plural form.

Paramètres
string$wordThe string input.
Renvoie
boolean True if word is plural, false if not.
Depuis
1.0

Références Inflector\getCachedSingular(), Inflector\toPlural(), et Inflector\toSingular().

◆ isSingular()

isSingular (   $word)

Checks if a word is in a singular form.

Paramètres
string$wordThe string input.
Renvoie
boolean True if word is singular, false if not.
Depuis
1.0

Références Inflector\getCachedPlural(), Inflector\toPlural(), et Inflector\toSingular().

◆ matchRegexRule()

matchRegexRule (   $word,
  $ruleType 
)
private

Execute a regex from rules.

The 'plural' rule type expects a singular word. The 'singular' rule type expects a plural word.

Paramètres
string$wordThe string input.
string$ruleTypeString (eg, singular|plural)
Renvoie
mixed An inflected string, or false if no rule could be applied.
Depuis
1.0

Référencé par Inflector\toPlural(), et Inflector\toSingular().

◆ setCache()

setCache (   $singular,
  $plural = null 
)
private

Sets an inflected word in the cache.

Paramètres
string$singularThe singular form of the word.
string$pluralThe plural form of the word. If omitted, it is assumed the singular and plural are identical.
Renvoie
void
Depuis
1.0

Références null.

Référencé par Inflector\addWord(), Inflector\toPlural(), et Inflector\toSingular().

◆ toPlural()

toPlural (   $word)

Converts a word into its plural form.

Paramètres
string$wordThe singular word to pluralise.
Renvoie
mixed An inflected string, or false if no rule could be applied.
Depuis
1.0

Références Inflector\$cache, Inflector\getCachedPlural(), Inflector\getCachedSingular(), Inflector\matchRegexRule(), et Inflector\setCache().

Référencé par Inflector\isPlural(), et Inflector\isSingular().

◆ toSingular()

toSingular (   $word)

Converts a word into its singular form.

Paramètres
string$wordThe plural word to singularise.
Renvoie
mixed An inflected string, or false if no rule could be applied.
Depuis
1.0

Références Inflector\$cache, Inflector\getCachedPlural(), Inflector\getCachedSingular(), Inflector\matchRegexRule(), et Inflector\setCache().

Référencé par Inflector\isPlural(), et Inflector\isSingular().

Documentation des champs

◆ $cache

$cache = array()
private

◆ $instance

$instance
staticprivate

◆ $rules

$rules
private

La documentation de cette classe a été générée à partir du fichier suivant :