Object methods

get([$load=1])

  • Retrieve a user definition from stored users objects, and put values in the object properties.
  • Before calling this method, ensure to set the property 'uname' in the instantiated object.
  • This method returns true if successfull, false on error.

add([$load=1],[$reason="ownership"])

  • Store as new user object using object properties. This creates a new user. Set all object properties before calling the method.
  • The method will manage also XML indexing automatically.
  • Reason argument is used for audit trail.
  • This method returns true if successfull, false on error.

delete([$load=1],[$reason="ownership"])

  • Delete logically the user object. This delete a user.
  • Before calling this method, ensure to set the property 'uname' in the instantiated object.
  • Reason argument is used for audit trail.
  • This method returns true if successfull, false on error.

undelete([$load=1],[$reason="ownership"])

  • Undelete the user object. This undelete a deleted user.
  • Before calling this method, ensure to set the property 'uname' in the instantiated object.
  • Reason argument is used for audit trail.
  • This method returns true if successfull, false on error.

update([$load=1],[$passupdate=false],[$unlock=false],[$reason="ownership"])

  • Update an existing user object.
  • Set the argument passupdate to true if you change the user password property.
  • set the argument unlock to set back the active property of user to true.
  • Reason argument is used for audit trail.
  • This method returns true if successfull, false on error.

getuname($uid)

  • Returns the username of the given user identifier (uid), or empty string if uid not found.

tsig($user,$password,[$userstorage=1])

  • Tests the accuracy of an electronic signature. Userstorage argument is load mode.
  • Returns true if correct, false if error.

login($user,$password,[$module="NSD"],[$userstorage=1])

  • Login a user in a requested module. Userstorage argument is load mode.
  • This method returns true if successfull, false on error.