Référence de la classe Inflector

Graphe d'héritage de Inflector:

Fonctions membres publiques
	addCountableRule ($data)
	addWord ($singular, $plural='')
	addPluraliseRule ($data)
	addSingulariseRule ($data)
	isCountable ($word)
	isPlural ($word)
	isSingular ($word)
	toPlural ($word)
	toSingular ($word)

Fonctions membres publiques statiques
static	getInstance ($new=false)
Fonctions membres publiques statiques hérités de Inflector
static	tableize (string $word)
static	classify (string $word)
static	camelize (string $word)
static	ucwords (string $string, string $delimiters=" \\\B-")
static	reset ()
static	rules (string $type, iterable $rules, bool $reset=false)
static	pluralize (string $word)
static	singularize (string $word)

Fonctions membres privées
static	addRule ($data, string $ruleType)

Attributs privés statiques
static	$instance
static	$countable

Description détaillée

Joomla Framework String Inflector Class

The Inflector transforms words

Depuis

1.0

Documentation des fonctions membres

addCountableRule()

addCountableRule

(

$data

)

Adds a countable word.

Paramètres

mixed

$data

A string or an array of strings to add.

Renvoie

$this

Depuis

1.0

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

addPluraliseRule()

addPluraliseRule

(

$data

)

Adds a pluralisation rule.

Paramètres

mixed

$data

A string or an array of regex rules to add.

Renvoie

$this

Depuis

1.0

Obsolète:

3.0 Use Doctrine::rules() instead.

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

addRule()

static addRule (   $data, string  $ruleType  )

private

Adds inflection regex rules to the inflector.

Paramètres

mixed	$data	A string or an array of strings or regex rules to add.
string	$ruleType	The rule type: singular | plural | countable

Renvoie

void

Depuis

1.0

Exceptions

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

$data

A string or an array of regex rules to add.

Renvoie

$this

Depuis

1.0

Obsolète:

3.0 Use Doctrine::rules() instead.

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

addWord()

addWord	(		$singular,
			$plural = ''
	)

Adds a specific singular-plural pair for a word.

Paramètres

string	$singular	The singular form of the word.
string	$plural	The plural form of the word. If omitted, it is assumed the singular and plural are identical.

Renvoie

$this

Depuis

1.0

Obsolète:

3.0 Use Doctrine::rules() instead.

Références $this, et class.

getInstance()

static getInstance (   $new = false )

static

Gets an instance of the Inflector singleton.

Paramètres

boolean

$new

If true (default is false), returns a new instance regardless if one exists. This argument is mainly used for testing.

Renvoie

static

Depuis

1.0

Obsolète:

3.0 Use static methods without a class instance instead.

isCountable()

isCountable

(

$word

)

Checks if a word is countable.

Paramètres

string

$word

The 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

$word

The string input.

Renvoie

boolean True if word is plural, false if not.

Depuis

1.0

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

isSingular()

isSingular

(

$word

)

Checks if a word is in a singular form.

Paramètres

string

$word

The string input.

Renvoie

boolean True if word is singular, false if not.

Depuis

1.0

Références Inflector\toSingular().

toPlural()

toPlural

(

$word

)

Converts a word into its plural form.

Paramètres

string

$word

The singular word to pluralise.

Renvoie

string The word in plural form.

Depuis

1.0

Obsolète:

3.0 Use Doctrine::pluralize() instead.

Références class.

Référencé par Inflector\isPlural().

toSingular()

toSingular

(

$word

)

Converts a word into its singular form.

Paramètres

string

$word

The plural word to singularise.

Renvoie

string The word in singular form.

Depuis

1.0

Obsolète:

3.0 Use Doctrine::singularize() instead.

Références class.

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

Documentation des champs

$countable

$countable

staticprivate

Valeur initiale :

= [
                'rules' => [
                        'id',
                        'hits',
                        'clicks',
                ]

$instance

$instance

staticprivate

---

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

• joomla/string/src/Inflector.php