package API\UnAuthenticated
inherited_from \APIFactory

 Methods

Logout()

Logout() 

Ping()

Ping() 

PunchLogin()

PunchLogin($user_name = NULL, $password = NULL

Parameters

$user_name

$password

__construct()

__construct() 
inherited_from \APIFactory::__construct()

__construct()

__construct() 
Inherited

Allows user who isn't logged in to change their password.

changePassword(string $user_name, string $current_password = NULL, string $new_password = NULL, string $new_password2 = NULL) : boolean

Parameters

$user_name

string

$current_password

string

$new_password

string

$new_password2

string

Returns

boolean

convertAPIReturnHandlerToValidatorObject()

convertAPIReturnHandlerToValidatorObject($api_retarr, $validator_obj = FALSE
Inherited

Parameters

$api_retarr

$validator_obj

convertToMultipleRecords()

convertToMultipleRecords($data) 
Inherited

Parameters

$data

convertToSingleRecord()

convertToSingleRecord($data) 
Inherited

Parameters

$data

downloaded a result_set as a csv.

exportRecords($format, $file_name, $result, $filter_columns) : array | boolean
Inherited

Parameters

$format

$file_name

$result

$filter_columns

Returns

arrayboolean

getAMFMessageID()

getAMFMessageID() 
Inherited

getAnalyticsTrackingCode()

getAnalyticsTrackingCode() 

getApplicationBuild()

getApplicationBuild() 

getApplicationName()

getApplicationName() 

getApplicationVersion()

getApplicationVersion() 

getApplicationVersionDate()

getApplicationVersionDate() 

getCompanyName()

getCompanyName() 

getCurrentCompany()

getCurrentCompany() 

getCurrentCompanyObject()

getCurrentCompanyObject() 
Inherited

getCurrentUser()

getCurrentUser() 

getCurrentUserName()

getCurrentUserName() 

getCurrentUserObject()

getCurrentUserObject() 
Inherited

getCurrentUserPreference()

getCurrentUserPreference() 

getCurrentUserPreferenceObject()

getCurrentUserPreferenceObject() 
Inherited

getDeploymentOnDemand()

getDeploymentOnDemand() 

getHTTPHost()

getHTTPHost() 

getLocale()

getLocale($language = NULL, $country = NULL

Parameters

$language

$country

getMainClassObject()

getMainClassObject() 
Inherited

getNextInsertID()

getNextInsertID() 
Inherited

getOptions()

getOptions($name = FALSE, $parent = NULL
Inherited

Parameters

$name

$parent

getOrganizationName()

getOrganizationName() 

getOrganizationURL()

getOrganizationURL() 

getPagerData()

getPagerData() 
Inherited

getPermissionChildren()

getPermissionChildren() 
Inherited

getPermissionObject()

getPermissionObject() 
Inherited

getPreLoginData()

getPreLoginData($api = NULL

Parameters

$api

getProduction()

getProduction() 

getProgressBarObject()

getProgressBarObject() 
Inherited

getProtocolVersion()

getProtocolVersion() 
Inherited

getRegistrationKey()

getRegistrationKey() 

getSessionIdle()

getSessionIdle() 

getSystemLoad()

getSystemLoad() 

getTTProductEdition()

getTTProductEdition($name = FALSE

Parameters

$name

getVariableToFunctionMap()

getVariableToFunctionMap($name, $parent = NULL
Inherited

Parameters

$name

$parent

handlePermissionFilterColumns()

handlePermissionFilterColumns($filter_columns, $allowed_columns) 
Inherited

Parameters

$filter_columns

$allowed_columns

handleRecordValidationResults()

handleRecordValidationResults($validator, $validator_stats, $key, $save_result) 
Inherited

Parameters

$validator

$validator_stats

$key

$save_result

initializeFilterAndPager()

initializeFilterAndPager($data, $disable_paging = FALSE
Inherited

Parameters

$data

$disable_paging

isAnalyticsEnabled()

isAnalyticsEnabled() 

isLoggedIn()

isLoggedIn($touch_updated_date = TRUE, $type = 'USER_NAME'

Parameters

$touch_updated_date

$type

newSession()

newSession($user_id, $client_id = NULL, $ip_address = NULL

Parameters

$user_id

$client_id

$ip_address

passwordReset()

passwordReset($key, $password, $password2) 

Parameters

$key

$password

$password2

resetPassword()

resetPassword($email) 

Parameters

$email

returnHandler()

returnHandler($retval = TRUE, $code = FALSE, $description = FALSE, $details = FALSE, $validator_stats = FALSE, $user_generic_status_batch_id = FALSE, $request_data = FALSE
Inherited

Parameters

$retval

$code

$description

$details

$validator_stats

$user_generic_status_batch_id

$request_data

sendErrorReport()

sendErrorReport($data = NULL, $screenshot = NULL

Parameters

$data

$screenshot

setAMFMessageID()

setAMFMessageID($id) 
Inherited

Parameters

$id

setMainClassObject()

setMainClassObject($obj) 
Inherited

Parameters

$obj

setPagerObject()

setPagerObject($lf) 
Inherited

Parameters

$lf

setValidationArray()

setValidationArray($primary_validator, $secondary_validator, $tertiary_validator = FALSE
Inherited

Parameters

$primary_validator

$secondary_validator

$tertiary_validator

stripReturnHandler()

stripReturnHandler($retarr) 
Inherited

Parameters

$retarr

switchUser()

switchUser($user_id) 

Parameters

$user_id

 Properties

 

$data

$data 

Default

array()
 

$AMF_message_id

$AMF_message_id 

Default

NULL
 

$current_company

$current_company 

Default

NULL
 

$current_user

$current_user 

Default

NULL
 

$current_user_prefs

$current_user_prefs 

Default

NULL
 

$main_class

$main_class 

Default

'Authentication'
 

$main_class_obj

$main_class_obj 

Default

NULL
 

$pager_obj

$pager_obj 

Default

NULL
 

$permission

$permission 

Default

NULL
 

$progress_bar_obj

$progress_bar_obj 

Default

NULL