package API\ClientStation
inherited_from \APIFactory

 Methods

__construct()

__construct() 
inherited_from \APIFactory::__construct()

__construct()

__construct() 
Inherited

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

deleteUserIdentification()

deleteUserIdentification($user_id, $type_id, $number) 

Parameters

$user_id

$type_id

$number

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

getBranches()

getBranches($last_update_epoch = 0, $remote_ids = array()

Parameters

$last_update_epoch

$remote_ids

getClientConfig()

getClientConfig($device_os = NULL, $device_model = NULL, $device_os_version = NULL

Parameters

$device_os

$device_model

$device_os_version

getClientVersion()

getClientVersion() 

getCurrentCompanyObject()

getCurrentCompanyObject() 
Inherited

getCurrentUserObject()

getCurrentUserObject() 
Inherited

getCurrentUserPreferenceObject()

getCurrentUserPreferenceObject() 
Inherited

getDate()

getDate() 

getDefaultPunchSettings()

getDefaultPunchSettings($user_id = NULL, $epoch = NULL, $is_api = TRUE

Parameters

$user_id

$epoch

$is_api

getDepartments()

getDepartments($last_update_epoch = 0, $remote_ids = array()

Parameters

$last_update_epoch

$remote_ids

getJobItems()

getJobItems($last_update_epoch = 0, $remote_ids = array()

Parameters

$last_update_epoch

$remote_ids

getJobToJobItemMap()

getJobToJobItemMap($last_update_epoch = 0

Parameters

$last_update_epoch

getJobToUserMap()

getJobToUserMap($last_update_epoch = 0

Parameters

$last_update_epoch

getJobs()

getJobs($last_update_epoch = 0, $remote_ids = array()

Parameters

$last_update_epoch

$remote_ids

getLatestVersion()

getLatestVersion() 

getMainClassObject()

getMainClassObject() 
Inherited

getMessage()

getMessage($user_id, $status_id = 0, $type_id = 0, $order = 0

Parameters

$user_id

$status_id

$type_id

$order

getNextInsertID()

getNextInsertID() 
Inherited

getOptions()

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

Parameters

$name

$parent

getOtherFields()

getOtherFields($last_update_epoch = 0, $remote_ids = array()

Parameters

$last_update_epoch

$remote_ids

getPagerData()

getPagerData() 
Inherited

getPermissionChildren()

getPermissionChildren() 
Inherited

getPermissionObject()

getPermissionObject() 
Inherited

getPermissionUsers()

getPermissionUsers($last_update_epoch = 0, $remote_ids = array()

Parameters

$last_update_epoch

$remote_ids

getPermissions()

getPermissions($last_update_epoch = 0, $remote_ids = array()

Parameters

$last_update_epoch

$remote_ids

getProgressBarObject()

getProgressBarObject() 
Inherited

getProtocolVersion()

getProtocolVersion() 
Inherited

getSingleUserIdentification()

getSingleUserIdentification($user_id, $type_id = 70

Parameters

$user_id

$type_id

getTimeZone()

getTimeZone() 

getUserIdentification()

getUserIdentification($last_update_epoch = 0, $clock_user_ids = array()

Parameters

$last_update_epoch

$clock_user_ids

getUserPreference()

getUserPreference($last_update_epoch = 0, $clock_user_ids = array()

Parameters

$last_update_epoch

$clock_user_ids

getUsers()

getUsers($last_update_epoch = 0, $remote_user_ids = array()

Parameters

$last_update_epoch

$remote_user_ids

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

isLatestData()

isLatestData($last_check_epoch, $station_epoch = NULL

Parameters

$last_check_epoch

$station_epoch

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

setAMFMessageID()

setAMFMessageID($id) 
Inherited

Parameters

$id

setAttendance()

setAttendance($data = FALSE

Parameters

$data

setLog()

setLog($data = NULL

Parameters

$data

setMainClassObject()

setMainClassObject($obj) 
Inherited

Parameters

$obj

setPagerObject()

setPagerObject($lf) 
Inherited

Parameters

$lf

setUserIdentification()

setUserIdentification($data) 

Parameters

$data

setValidationArray()

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

Parameters

$primary_validator

$secondary_validator

$tertiary_validator

stationCheckAllowed()

stationCheckAllowed() 

stripReturnHandler()

stripReturnHandler($retarr) 
Inherited

Parameters

$retarr

test()

test() 

checkStationType()

checkStationType($type_id) 

Parameters

$type_id

getCompanyObject()

getCompanyObject() 

getStationID()

getStationID() 

getStationObject()

getStationObject() 

getStationPassword()

getStationPassword() 

getStationTypeID()

getStationTypeID() 

isKioskModeType()

isKioskModeType($type_id) 

Parameters

$type_id

isLoggedIn()

isLoggedIn() 

processPunches()

processPunches($attendance_log) 

Parameters

$attendance_log

 Properties

 

$data

$data 

Default

array()
 

$AMF_message_id

$AMF_message_id 

Default

NULL
 

$company_obj

$company_obj 

Default

NULL
 

$current_company

$current_company 

Default

NULL
 

$current_user

$current_user 

Default

NULL
 

$current_user_prefs

$current_user_prefs 

Default

NULL
 

$kiosk_mode_type_ids

$kiosk_mode_type_ids 

Default

array(61, 65)
 

$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
 

$station_obj

$station_obj 

Default

NULL
 

$test_mode

$test_mode 

Default

FALSE
 

$type_ids

$type_ids 

Default

array(28, 60, 61, 65)