Tariqa  3.0
 All Data Structures Namespaces Files Functions Variables Enumerations
iUser Interface Reference
Inheritance diagram for iUser:
EC_User TariqaUser

Public Member Functions

 getUserId ()
 getAttributeList ()
 isMemberOf ($groups, $binary_and=false)
 get_preference ($name)
 set_preference ($name, $value, $db=null)
 get_access_level ()
 __get ($attributeName)
 __set ($attributeName, $value)
 __isset ($attributeName)
 __unset ($attributeName)

Member Function Documentation

__get ( attributeName)

Accessor, quickly access the user's attributes using object style syntax

Returns:
string

Implemented in EC_User.

__isset ( attributeName)

Accessor, quickly access the user's attributes using object style syntax

Returns:
bool

Implemented in EC_User.

__set ( attributeName,
value 
)

Accessor, quickly access the user's attributes using object style syntax

Implemented in EC_User.

__unset ( attributeName)

Accessor, quickly access the user's attributes using object style syntax

Returns:
bool

Implemented in EC_User.

Gets the user access level public

Returns:
int

Implemented in EC_User.

get_preference ( name)

Gets an user preference. Returns null if the preference is not set

Parameters:
string$nameThe name of the preference public
Returns:
mixed

Implemented in EC_User.

Returns an array of valid attributes associated with

Returns:
array

Implemented in EC_User.

getUserId ( )

Returns the UserId of the user

Returns:
string

Implemented in EC_User.

isMemberOf ( groups,
binary_and = false 
)

Check the group membership of an user

Parameters:
string | array$groupsEither the name of a group or an array of group names against which to check the membership of the user
bool$binary_andIf set to true, the user must be a member of ALL the groups in the list, otherwise it must belong to at least one of the groups
Returns:
bool

Implemented in EC_User.

set_preference ( name,
value,
db = null 
)

Sets an user preference. To delete a preference from the database, just set the null value for it and set the $db to an instance of mMysql. If you want to delete an array from the database, just put a "%" instead of the index value. For example, to delete the "general/countries" array: $user->set_preference("general/countries/%", null);

Parameters:
string$nameThe preference
mixed$valueThe value
mMysql$dbA database connection (used for saving the preference to the database) [OPTIONAL] public
Returns:
void

Implemented in EC_User.


The documentation for this interface was generated from the following file: