Class: VUser

Source Location: /libraries/vwp/user.php

Class Overview [line 52]

VType
   |
   --VObject
      |
      --VUser

Virtual Web Platform - User Library

Author(s):

Version:

Copyright:

  • (c) Ralph Ritoch - All Rights Reserved

Variables

Constants

Methods

Inherited Variables

Class: VObject

VObject::$_nosave_errors
VObject::$_nosave_original_state

Inherited Constants

Inherited Methods

Class: VObject

VObject::__construct()
Class Constructor
VObject::bind()
Bind values to this object
VObject::delete()
Delete Object
VObject::get()
Get value
VObject::getAll()
Get all object values
VObject::getError()
Get error message
VObject::getErrors()
Get errors
VObject::getMethods()
Get object methods
VObject::getProperties()
Get object properties
VObject::save()
Save Object
VObject::set()
Set a value
VObject::setError()
Set error value
VObject::setProperties()
Set property values
VObject::setProperty()
Set property value
VObject::toString()
Convert object to string
VObject::__destruct()
Class Destructor
VObject::__get()
VObject::__isset()
VObject::__set()
VObject::__toString()
Return object as a string
VObject::__unset()

Class Details

Virtual Web Platform - User Library

This file provides the base user interface

Tags:

[ Top ]

Class Variables

static $_user_cache = array()

[line 192]

User Cache

Tags:

  • var - User Cache
  • access - public

Type: array

Overrides:

[ Top ]

$email =  null

[line 119]

Email address

Tags:

  • access - public

Type: string

Overrides:

[ Top ]

$email_verification =  null

[line 128]

Email Verification

Tags:

  • var - Email Verification Code
  • access - public

Type: string

Overrides:

[ Top ]

$meta = array()

[line 146]

Meta data

Tags:

  • var - Meta data
  • access - public

Type: array

Overrides:

[ Top ]

$name =  'Guest'

[line 137]

User's Name

Tags:

  • access - public

Type: string

Overrides:

[ Top ]

$password =  null

[line 110]

Password

Tags:

  • var - Password
  • access - public

Type: string

Overrides:

[ Top ]

$username =  null

[line 101]

Username

Tags:

  • var - Username
  • access - public

Type: string

Overrides:

[ Top ]

$_admin =  false

[line 91]

Administrator status

Tags:

  • var - Administrator status
  • access - public

Type: integer

Overrides:

[ Top ]

$_domain =  null

[line 164]

User's domain

Tags:

  • var - Domain
  • access - public

Type: string

Overrides:

[ Top ]

$_extra = array()

[line 81]

Temporary nosave data

Tags:

  • var - Temporary nosave data
  • access - public

Type: array

Overrides:

[ Top ]

$_roles = array('GUEST')

[line 155]

User's roles

Tags:

  • var - Assigned roles
  • access - public

Type: array

Overrides:

[ Top ]

Class Methods

static freeUserRecord

static void freeUserRecord( &$user, VUser $user)

[line 829]

Free User Record

Tags:

  • access - public

Parameters:

  • VUser $user - User
  • &$user -

[ Top ]

static getCurrent

static VUser &getCurrent( )

[line 663]

Get current user

Tags:

  • return - Current user
  • todo - Make logout more friendly, destroying session is overkill
  • access - public

Parameters:

[ Top ]

static getUserByUsername

static VUser|VWarning &getUserByUsername( string $username, [string $_domain = null])

[line 792]

Get user by username

Tags:

  • return - User on success, error or warning otherwise
  • access - public

Parameters:

  • string $username - Username
  • string $_domain - Domain

[ Top ]

static getUsernamesByEmail

static array getUsernamesByEmail( string $email)

[line 1083]

Get Usernames By Email

Tags:

  • return - Usernames
  • access - public

Parameters:

  • string $email -

[ Top ]

static suid

static boolean suid( array $credentials)

[line 494]

Start a SUID session

Tags:

  • return - True if authenticated, false otherwise
  • access - public

Parameters:

  • array $credentials - user credentials

[ Top ]

static updateSession

static void updateSession( )

[line 446]

Update Session

Tags:

  • access - public

Parameters:

[ Top ]

allow

boolean allow( string $usage, string $R_Id, [array $S_Id = null])

[line 231]

Test if user is allowed to access a feature

Tags:

  • return - True if user is allowed access
  • access - public

Parameters:

  • string $usage - Usage note
  • string $R_Id - Resource ID
  • array $S_Id - Service ID

[ Top ]

authenticate

void authenticate( array $credentials)

[line 336]

Authenticate user with given credentials

Tags:

  • access - public

Parameters:

  • array $credentials - user credentials

[ Top ]

confirmEmail

boolean|object True confirmEmail( string $confirmation_code)

[line 858]

Confirm Email

Tags:

  • return - on success, error or warning otherwise
  • access - public

Parameters:

  • string $confirmation_code -

[ Top ]

createCallback

array createCallback( string|array $action)

[line 649]

Create a callback

Tags:

  • return - Callback action
  • access - public

Parameters:

  • string|array $action - Requested callback action

[ Top ]

delete

boolean|object True delete( )

[line 923]

Delete User

Tags:

  • return - on success, error or warning otherwise
  • access - public

Overrides VObject::delete() (Delete Object)

Parameters:

[ Top ]

deny

boolean deny( string $usage, string $R_Id, [array $S_Id = null])

[line 284]

Test if user is blocked from accessing a feature

Tags:

  • return - True if user is blocked from accessing the feature
  • access - public

Parameters:

  • string $usage - Usage note
  • string $R_Id - Resource ID
  • array $S_Id - Service ID

[ Top ]

doCallback

void doCallback( object $callback)

[line 616]

Perform a callback with this users shell

Tags:

  • access - public

Parameters:

  • object $callback - Callback Object

[ Top ]

getMeta

mixed getMeta( string $vname, [mixed $default = null], [string $domain = "__default"])

[line 1070]

Get Meta

Tags:

  • return - Value

Parameters:

  • string $vname -
  • mixed $default - Default value
  • string $domain -

[ Top ]

getShell

VShell &getShell( )

[line 1008]

Get user's current shell

Tags:

  • return - User's current shell object
  • access - public

Parameters:

[ Top ]

getShellStack

array &getShellStack( )

[line 1020]

Get users shell stack

Tags:

  • return - Shell stack
  • access - public

Parameters:

[ Top ]

isAdmin

boolean isAdmin( )

[line 201]

Test if this user is an administrator

Tags:

  • return - True if user is an administrator
  • access - public

Parameters:

[ Top ]

is_foreign

boolean is_foreign( )

[line 216]

Check if a foreign user

Tags:

  • return - True if foreign
  • access - public

Parameters:

[ Top ]

is_suid

boolean is_suid( )

[line 842]

Get SUID mode status

Tags:

  • return - True if in SUID mode
  • access - public

Parameters:

[ Top ]

logon

void logon( )

[line 1103]

Resume logon session (Do not call directly)

Note: This is the entry point for requests sent to the platform.

Tags:

  • access - public

Parameters:

[ Top ]

save

boolean|object True save( )

[line 878]

Save user

Tags:

  • return - on success, error or warning otherwise
  • access - public

Overrides VObject::save() (Save Object)

Parameters:

[ Top ]

setMeta

mixed setMeta( string $vname, mixed $value, [string $domain = "__default"])

[line 1033]

Set Meta Data

Tags:

  • return - Set Value

Parameters:

  • string $vname - Variable name
  • mixed $value - Value
  • string $domain - Domain

[ Top ]

suid_exit

void suid_exit( )

[line 427]

Exit a SUID session

Tags:

  • access - public

Parameters:

[ Top ]

unsetMeta

mixed unsetMeta( string $vname, string $domain)

[line 1051]

Unset Meta Data

Tags:

  • return - old value

Parameters:

  • string $vname - Value name
  • string $domain - Domain

[ Top ]

Class Constants

Documentation generated on Sun, 06 Mar 2011 02:22:30 -0600 by phpDocumentor 1.4.3