Standards  1.0
Public Member Functions | Static Public Member Functions | Data Fields
iUserSystem_User Interface Reference
User System

A user entity for the UserSystem standard. More...

Public Member Functions

 changeUsername ($newUsername)
 
 getUsername ()
 
 getRegisterTime ()
 
 getEmail ()
 
 getId ()
 
 isConfirmed ()
 
 checkPassword ($plainPassword)
 
 checkPermission ($permissionPath)
 
 addToGroup ($groupName)
 
 removeFromGroup ($group)
 
 inGroup ($groupName)
 
 setPassword ($newPassword)
 
 notify ($title, $body, $label="Notification", $sendEmail=true)
 

Static Public Member Functions

static getRawView ($injections, $level=1)
 

Data Fields

const iType = "User"
 
const iShort = "u"
 
const iParent = "iUserSystem"
 

Detailed Description

A user entity for the UserSystem standard.

Tokens:

  • "<": Sorts from higest to lowest or newest to oldest.
    • Allowed values:
      • string time
  • ">": Sorts from lowest to higest or oldest to newest.
    • Allowed values:
      • string time
  • ";": Not true checker.
    • Allowed values:
      • string confirmed.
  • "~": Is true checker.
    • Allowed values:
      • string confirmed.
  • "#": Search for an id.
    • Allowed values:
      • int Any int id(1, 6236, ect.).
  • "=": pair([array of 2]) Checks if the column(first value) value is = to the second value.

Member Function Documentation

addToGroup (   $groupName)

Adds this user to the groupName.

Returns
True on success or false on failure.
changeUsername (   $newUsername)

Sets the users username to the newUsername.

checkPassword (   $plainPassword)
Returns
True if the $plainPassword matches the current password, or false if not.
checkPermission (   $permissionPath)

Checks if the user has the permissionPath permission.

See iUserSystem for more info on Permission paths.

Returns
True if the user has the permission or false if not.
static getRawView (   $injections,
  $level = 1 
)
static
Returns
View object with the $injections injected.

Levels:

  • 1 small:
    • Rows:
      • "username": The username of this user.
    • Injections:
      • "action": An area for actions(buttons) to go.

Example:

static protected function getRawView($inj, $level = 1) {
$view = new MyView($inj, $level); //This will create our new view and override the injections with $inj.
return $view;
}
inGroup (   $groupName)

Checks if the user is in the groupName group.

Returns
True if this user is in the groupName or false if not.
notify (   $title,
  $body,
  $label = "Notification",
  $sendEmail = true 
)

This will use the installed iNotificationSystem standard to notify the user.

If an iNotificationSystem standard is not installed this will send an email with the $title being the subject.

removeFromGroup (   $group)

Removes this user from the groupName.

Returns
True on success or false on failure.
setPassword (   $newPassword)

This will set the password to the $newPassword

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