Référence de la classe Users

Fonctions membres publiques
	image ($src)
	addNote ($userId)
	filterNotes ($count, $userId)
	notes ($count, $userId)
	notesModal ($count, $userId)
	blockStates ($self=false)
	activateStates ()
	value ($value)
	spacer ($value)
	templatestyle ($value)
	admin_language ($value)
	language ($value)
	editor ($value)

Description détaillée

Extended Utility class for the Users component.

Depuis

2.5

Documentation des fonctions membres

activateStates()

activateStates

(

)

Build an array of activate states to be used by jgrid.state,

Renvoie

array a list of possible states to display

Depuis

3.0

addNote()

addNote

(

$userId

)

Displays an icon to add a note for this user.

Paramètres

integer

$userId

The user ID

Renvoie

string A link to add a note

Depuis

2.5

Références $title, $userId, Text\_(), et Route\_().

admin_language()

admin_language

(

$value

)

Get the sanitized language

Paramètres

mixed

$value

Value of the field

Renvoie

mixed String/void

Depuis

1.6

Références $path, $result, $value, ENT_COMPAT, LanguageHelper\getLanguagePath(), JPATH_ADMINISTRATOR, LanguageHelper\parseXMLLanguageFile(), et value.

blockStates()

blockStates

(

$self = false

)

Build an array of block/unblock user states to be used by jgrid.state, State options will be different for any user and for currently logged in user

Paramètres

boolean

$self

True if state array is for currently logged in user

Renvoie

array a list of possible states to display

Depuis

3.0

Références $self.

editor()

editor

(

$value

)

Get the sanitized editor name

Paramètres

mixed

$value

Value of the field

Renvoie

mixed String/void

Depuis

1.6

Références $db, $lang, $query, $title, $value, Text\_(), Factory\getDbo(), Factory\getLanguage(), JPATH_ADMINISTRATOR, JPATH_PLUGINS, et value.

filterNotes()

filterNotes	(		$count,
			$userId
	)

Displays an icon to filter the notes list on this user.

Paramètres

integer	$count	The number of notes for the user
integer	$userId	The user ID

Renvoie

string A link to apply a filter

Depuis

2.5

Références $count, $title, $userId, Text\_(), et Route\_().

image()

image

(

$src

)

Display an image.

Paramètres

string

$src

The source of the image

Renvoie

string A element if the specified file exists, otherwise, a null string

Depuis

2.5

Exceptions

Références Path\check(), JPATH_SITE, et Uri\root().

language()

language

(

$value

)

Get the sanitized language

Paramètres

mixed

$value

Value of the field

Renvoie

mixed String/void

Depuis

1.6

Références $path, $result, $value, ENT_COMPAT, LanguageHelper\getLanguagePath(), JPATH_SITE, LanguageHelper\parseXMLLanguageFile(), et value.

notes()

notes	(		$count,
			$userId
	)

Displays a note icon.

Paramètres

integer	$count	The number of notes for the user
integer	$userId	The user ID

Renvoie

string A link to a modal window with the user notes

Depuis

2.5

Références $count, $title, $userId, et Text\plural().

notesModal()

notesModal	(		$count,
			$userId
	)

Renders the modal html.

Paramètres

integer	$count	The number of notes for the user
integer	$userId	The user ID

Renvoie

string The html for the rendered modal

Depuis

3.4.1

Références $count, $title, $userId, Text\_(), Route\_(), HTMLHelper\_(), et Text\plural().

spacer()

spacer

(

$value

)

Get the space symbol

Paramètres

mixed

$value

Value of the field

Renvoie

string

Depuis

1.6

templatestyle()

templatestyle

(

$value

)

Get the sanitized template style

Paramètres

mixed

$value

Value of the field

Renvoie

mixed String/void

Depuis

1.6

Références $db, $query, $title, $value, ENT_COMPAT, Factory\getDbo(), ParameterType\INTEGER, et value.

value()

value

(

$value

)

Get the sanitized value

Paramètres

mixed

$value

Value of the field

Renvoie

mixed String/void

Depuis

1.6

Références $value, Text\_(), elseif, et ENT_COMPAT.

---

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

• Users.php