Class JHtmlUsers

Description

Extended Utility class for the Users component.

  • since: 2.5

Located in /administrator/components/com_users/helpers/html/users.php (line 19)


	
			
Method Summary
 static array activateStates ()
 static string addNote (integer $userId)
 static array blockStates ([boolean $self = false])
 static string filterNotes (integer $count, integer $userId)
 static string image (string $src)
 static string notes (integer $count, integer $userId)
Methods
static activateStates (line 181)

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

  • return: a list of possible states to display
  • since: 3.0
  • access: public
static array activateStates ()
static addNote (line 55)

Displays an icon to add a note for this user.

  • return: A link to add a note
  • since: 2.5
  • access: public
static string addNote (integer $userId)
  • integer $userId: The user ID
static blockStates (line 122)

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

  • return: a list of possible states to display
  • since: 3.0
  • access: public
static array blockStates ([boolean $self = false])
  • boolean $self: True if state array is for currently logged in user
static filterNotes (line 73)

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

  • return: A link to apply a filter
  • since: 2.5
  • access: public
static string filterNotes (integer $count, integer $userId)
  • integer $count: The number of notes for the user
  • integer $userId: The user ID
static image (line 30)

Display an image.

  • return: A <img> element if the specified file exists, otherwise, a null string
  • since: 2.5
  • access: public
static string image (string $src)
  • string $src: The source of the image
static notes (line 96)

Displays a note icon.

  • return: A link to a modal window with the user notes
  • since: 2.5
  • access: public
static string notes (integer $count, integer $userId)
  • integer $count: The number of notes for the user
  • integer $userId: The user ID

Documentation generated on Tue, 19 Nov 2013 15:16:37 +0100 by phpDocumentor 1.4.3