User.php

Show: inherited
Table of Contents

User service file

Author
Dave Cutler  
Copyright
2011 SOS Staffing Inc.  
Package
Service  
Subpackage
User  

\Service_User

Package: Service\User

User Service

Interacts with a JOSSO back-end for authorizing/deauthorizing user accounts as well as providing information about user accounts in general. Includes staff-specific methods for accessing and updating internal information.

Note: All parameters are required unless otherwise stated.

Api
 
Author
Dave Cutler  
Copyright
2011 SOS Staffing Inc.  

Methods

methodpublicgetMetaData

Returns meta data about the specified user

methodpublicgetPassHash

Returns a JOSSO-hashed form of the provided password

methodpublicgetRoles

Returns all roles currently assigned to the session's user

methodpublicgetSSLKeys

Attempt to get keys from database, if not present, generate new keys, store in database, and then return the new keys

methodpublicgetSsoData

Returns SSO app data for the current user

methodpublicgetSsoMetaData

Get user-specific meta data from SSO

methodpublicgetWebData

Returns all user properties currently assigned to the session's user in the web database

methodpublichasRole

Verifies that the session's user has a specific role

methodpubliclogin

Logs in a user and returns basic information about the user and their session

methodpubliclogout

Logs out the current user

methodpublicping

Verifies the JOSSO service is running

methodpublicsearchByUsername

Finds a user by their username

methodpublicsetMetaData

Sets meta data about the specified user

methodpublicsetSsoData

Set SSO app data

methodpublicvalidateSession

Validates that a session is active and returns basic information about the session and user, can also validate the session against a provided username

Documentation was generated by DocBlox 0.18.1.