Show:

Users_AppUser Class

Extends Base_Users_AppUser
Defined in: platform/plugins/Users/classes/Users/AppUser.php:43
Module: Users

Class representing 'AppUser' rows in the 'Users' database You can create an object of this class either to access its non-static methods, or to actually represent a app_user row in the Users database.

Methods

__set_state

(
  • $array
)
Users_AppUser

Defined in platform/plugins/Users/classes/Users/AppUser.php:175

Implements the __set_state method, so it can work with with var_export and be re-imported successfully.

Parameters:

  • $array Array

Returns:

Users_AppUser:

Class instance

clearExtra

(
  • $extraName
)

Defined in platform/plugins/Users/classes/Users/AppUser.php:131

Parameters:

  • $extraName String

    The name of the extra to remove

getAllExtras

() Array

Defined in platform/plugins/Users/classes/Users/AppUser.php:86

Returns:

Array:

The array of all extras set in the stream

getExtra

(
  • $extraName
  • $default
)
Mixed

Defined in platform/plugins/Users/classes/Users/AppUser.php:97

Parameters:

  • $extraName String

    The name of the extra to get

  • $default Mixed

    The value to return if the extra is missing

Returns:

Mixed:

The value of the extra, or the default value, or null

setExtra

(
  • $extraName
  • $value
)

Defined in platform/plugins/Users/classes/Users/AppUser.php:109

Parameters:

  • $extraName String

    The name of the extra to set, or an array of $extraName => $extraValue pairs

  • $value Mixed

    The value to set the extra to

Returns:

Users_AppUser

setUp

()

Defined in platform/plugins/Users/classes/Users/AppUser.php:165

The setUp() method is called the first time an object of this class is constructed.