APIClientStationUnAuthenticated - staffcheck/api GitHub Wiki

APIClientStationUnAuthenticated

  • Class name: APIClientStationUnAuthenticated
  • Namespace:
  • Parent class: APIFactory

Properties

$station_obj

protected mixed $station_obj = NULL
  • Visibility: protected

$company_obj

protected mixed $company_obj = NULL
  • Visibility: protected

$type_ids

protected mixed $type_ids = array(28, 60, 61, 65)
  • Visibility: protected

$kiosk_mode_type_ids

protected mixed $kiosk_mode_type_ids = array(61, 65)
  • Visibility: protected

$test_mode

protected mixed $test_mode = FALSE
  • Visibility: protected

$data

public mixed $data = array()
  • Visibility: public

$main_class_obj

protected mixed $main_class_obj = NULL
  • Visibility: protected

$AMF_message_id

protected mixed $AMF_message_id = NULL
  • Visibility: protected

$pager_obj

protected mixed $pager_obj = NULL
  • Visibility: protected

$current_company

protected mixed $current_company = NULL
  • Visibility: protected

$current_user

protected mixed $current_user = NULL
  • Visibility: protected

$current_user_prefs

protected mixed $current_user_prefs = NULL
  • Visibility: protected

$permission

protected mixed $permission = NULL
  • Visibility: protected

$progress_bar_obj

protected mixed $progress_bar_obj = NULL
  • Visibility: protected

Methods

__construct

mixed APIFactory::__construct()

APIFactory constructor.

  • Visibility: public
  • This method is defined by APIFactory

test

boolean APIClientStationUnAuthenticated::test()
  • Visibility: public

getLatestVersion

string APIClientStationUnAuthenticated::getLatestVersion()
  • Visibility: public

getClientVersion

boolean|string APIClientStationUnAuthenticated::getClientVersion()
  • Visibility: public

getCompanyObject

boolean|null APIClientStationUnAuthenticated::getCompanyObject()
  • Visibility: private

isLoggedIn

boolean APIClientStationUnAuthenticated::isLoggedIn()
  • Visibility: private

isKioskModeType

boolean APIClientStationUnAuthenticated::isKioskModeType(integer $type_id)
  • Visibility: private

Arguments

  • $type_id integer

checkStationType

boolean APIClientStationUnAuthenticated::checkStationType(integer $type_id)
  • Visibility: private

Arguments

  • $type_id integer

getStationID

boolean APIClientStationUnAuthenticated::getStationID()
  • Visibility: private

getStationTypeID

boolean|integer APIClientStationUnAuthenticated::getStationTypeID()
  • Visibility: private

getStationPassword

boolean APIClientStationUnAuthenticated::getStationPassword()
  • Visibility: private

getStationObject

boolean|null APIClientStationUnAuthenticated::getStationObject()
  • Visibility: private

stationCheckAllowed

array|boolean APIClientStationUnAuthenticated::stationCheckAllowed()
  • Visibility: public

getDate

array APIClientStationUnAuthenticated::getDate()
  • Visibility: public

getTimeZone

array APIClientStationUnAuthenticated::getTimeZone()
  • Visibility: public

getClientConfig

array|boolean APIClientStationUnAuthenticated::getClientConfig(null $device_os, null $device_model, null $device_os_version, $current_client_config)
  • Visibility: public

Arguments

  • $device_os null
  • $device_model null
  • $device_os_version null
  • $current_client_config mixed

isLatestData

array APIClientStationUnAuthenticated::isLatestData(integer $last_check_epoch, integer $station_epoch)
  • Visibility: public

Arguments

  • $last_check_epoch integer - EPOCH
  • $station_epoch integer - EPOCH

getUsers

array|boolean APIClientStationUnAuthenticated::getUsers(integer $last_update_epoch, array $remote_user_ids)

Accept a list of valid_user_ids from getUserIDs() so we can always send data for those users.

as well as sending updated data based on last_update_epoch. Since users can be assigned/unassigned from the client without updating their own data in some cases.

  • Visibility: public

Arguments

  • $last_update_epoch integer
  • $remote_user_ids array

getUserPreference

array|boolean APIClientStationUnAuthenticated::getUserPreference(integer $last_update_epoch, array $clock_user_ids)
  • Visibility: public

Arguments

  • $last_update_epoch integer
  • $clock_user_ids array

getSingleUserIdentification

array|boolean APIClientStationUnAuthenticated::getSingleUserIdentification(string $user_id, integer $type_id)
  • Visibility: public

Arguments

  • $user_id string - UUID
  • $type_id integer

getUserIdentification

array|boolean APIClientStationUnAuthenticated::getUserIdentification(integer $last_update_epoch, array $clock_user_ids, $remote_ids)

The client needs to pass a list of new users that were just added to it, so the identification for those users is included no matter what, along with any new data.

The client will need to do this automatically.

  • Visibility: public

Arguments

  • $last_update_epoch integer
  • $clock_user_ids array
  • $remote_ids mixed

getPermissions

array|boolean APIClientStationUnAuthenticated::getPermissions(integer $last_update_epoch, array $remote_ids)
  • Visibility: public

Arguments

  • $last_update_epoch integer
  • $remote_ids array

getPermissionUsers

array|boolean APIClientStationUnAuthenticated::getPermissionUsers(integer $last_update_epoch, array $remote_ids)
  • Visibility: public

Arguments

  • $last_update_epoch integer
  • $remote_ids array

getBranches

array|boolean APIClientStationUnAuthenticated::getBranches(integer $last_update_epoch, array $remote_ids)
  • Visibility: public

Arguments

  • $last_update_epoch integer
  • $remote_ids array

getDepartments

array|boolean APIClientStationUnAuthenticated::getDepartments(integer $last_update_epoch, array $remote_ids)
  • Visibility: public

Arguments

  • $last_update_epoch integer
  • $remote_ids array

getJobs

array|boolean APIClientStationUnAuthenticated::getJobs(integer $last_update_epoch, array $remote_ids)
  • Visibility: public

Arguments

  • $last_update_epoch integer
  • $remote_ids array

getJobItems

array|boolean APIClientStationUnAuthenticated::getJobItems(integer $last_update_epoch, array $remote_ids)
  • Visibility: public

Arguments

  • $last_update_epoch integer
  • $remote_ids array

getJobToUserMap

array|boolean APIClientStationUnAuthenticated::getJobToUserMap(integer $last_update_epoch)

If a job_id is not returned, then that means the job is allowed for all users.

  • Visibility: public

Arguments

  • $last_update_epoch integer

getJobToJobItemMap

array|boolean APIClientStationUnAuthenticated::getJobToJobItemMap(integer $last_update_epoch)
  • Visibility: public

Arguments

  • $last_update_epoch integer

getOtherFields

array|boolean APIClientStationUnAuthenticated::getOtherFields(integer $last_update_epoch, array $remote_ids)

Gets labels for OtherFields.

  • Visibility: public

Arguments

  • $last_update_epoch integer
  • $remote_ids array

getDefaultPunchSettings

array|boolean APIClientStationUnAuthenticated::getDefaultPunchSettings(string $user_id, integer $epoch, boolean $is_api)
  • Visibility: public

Arguments

  • $user_id string - UUID
  • $epoch integer - EPOCH
  • $is_api boolean

setAttendance

array|boolean APIClientStationUnAuthenticated::setAttendance(boolean $data)
  • Visibility: public

Arguments

  • $data boolean

processPunches

boolean APIClientStationUnAuthenticated::processPunches($attendance_log)
  • Visibility: private

Arguments

  • $attendance_log mixed

deleteUserIdentification

boolean APIClientStationUnAuthenticated::deleteUserIdentification(string $user_id, integer $type_id, $number)
  • Visibility: public

Arguments

  • $user_id string - UUID
  • $type_id integer
  • $number mixed

setUserIdentification

boolean APIClientStationUnAuthenticated::setUserIdentification($data)
  • Visibility: public

Arguments

  • $data mixed

getMessage

array APIClientStationUnAuthenticated::getMessage(string $user_id, integer $status_id, integer $type_id, integer $order)
  • Visibility: public

Arguments

  • $user_id string - UUID
  • $status_id integer
  • $type_id integer
  • $order integer

setLog

array|boolean APIClientStationUnAuthenticated::setLog(null $data)
  • Visibility: public

Arguments

  • $data null

getProtocolVersion

integer APIFactory::getProtocolVersion()
  • Visibility: public
  • This method is defined by APIFactory

getAMFMessageID

boolean|null APIFactory::getAMFMessageID()
  • Visibility: public
  • This method is defined by APIFactory

setAMFMessageID

boolean APIFactory::setAMFMessageID(string $id)
  • Visibility: public
  • This method is defined by APIFactory

Arguments

  • $id string - UUID

getCurrentCompanyObject

boolean|\CompanyFactory APIFactory::getCurrentCompanyObject()
  • Visibility: public
  • This method is defined by APIFactory

getCurrentUserObject

boolean|\UserFactory APIFactory::getCurrentUserObject()
  • Visibility: public
  • This method is defined by APIFactory

getCurrentUserPreferenceObject

boolean|\UserPreferenceFactory APIFactory::getCurrentUserPreferenceObject()
  • Visibility: public
  • This method is defined by APIFactory

getPermissionObject

boolean|null|\Permission APIFactory::getPermissionObject()
  • Visibility: public
  • This method is defined by APIFactory

getProgressBarObject

null|\ProgressBar APIFactory::getProgressBarObject()
  • Visibility: public
  • This method is defined by APIFactory

setPagerObject

boolean APIFactory::setPagerObject(object $lf)
  • Visibility: public
  • This method is defined by APIFactory

Arguments

  • $lf object

getPagerData

array|boolean APIFactory::getPagerData()
  • Visibility: public
  • This method is defined by APIFactory

setMainClassObject

boolean APIFactory::setMainClassObject(object $obj)
  • Visibility: public
  • This method is defined by APIFactory

Arguments

  • $obj object

getMainClassObject

string APIFactory::getMainClassObject()
  • Visibility: public
  • This method is defined by APIFactory

initializeFilterAndPager

array|boolean APIFactory::initializeFilterAndPager(array $data, boolean $disable_paging)
  • Visibility: public
  • This method is defined by APIFactory

Arguments

  • $data array
  • $disable_paging boolean

handlePermissionFilterColumns

array|null APIFactory::handlePermissionFilterColumns(array $filter_columns, array $allowed_columns)
  • Visibility: public
  • This method is defined by APIFactory

Arguments

  • $filter_columns array
  • $allowed_columns array

convertToSingleRecord

mixed APIFactory::convertToSingleRecord(array $data)
  • Visibility: public
  • This method is defined by APIFactory

Arguments

  • $data array

convertToMultipleRecords

array APIFactory::convertToMultipleRecords(array $data)
  • Visibility: public
  • This method is defined by APIFactory

Arguments

  • $data array

exportRecords

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

downloaded a result_set as a csv.

  • Visibility: public
  • This method is defined by APIFactory

Arguments

  • $format string
  • $file_name string
  • $result array
  • $filter_columns array

getNextInsertID

string APIFactory::getNextInsertID()
  • Visibility: public
  • This method is defined by APIFactory

getPermissionChildren

array APIFactory::getPermissionChildren()
  • Visibility: public
  • This method is defined by APIFactory

returnHandler

array|boolean APIFactory::returnHandler(boolean $retval, boolean $code, boolean $description, boolean $details, boolean $validator_stats, boolean $user_generic_status_batch_id, boolean $request_data)
  • Visibility: public
  • This method is defined by APIFactory

Arguments

  • $retval boolean
  • $code boolean
  • $description boolean
  • $details boolean
  • $validator_stats boolean
  • $user_generic_status_batch_id boolean
  • $request_data boolean

stripReturnHandler

mixed APIFactory::stripReturnHandler(mixed $retarr)
  • Visibility: public
  • This method is defined by APIFactory

Arguments

  • $retarr mixed

getOptions

array|boolean APIFactory::getOptions(boolean $name, string|integer $parent)
  • Visibility: public
  • This method is defined by APIFactory

Arguments

  • $name boolean
  • $parent string|integer

getVariableToFunctionMap

array APIFactory::getVariableToFunctionMap(string $name, string|integer $parent)
  • Visibility: public
  • This method is defined by APIFactory

Arguments

  • $name string
  • $parent string|integer

convertAPIReturnHandlerToValidatorObject

boolean|\Validator APIFactory::convertAPIReturnHandlerToValidatorObject($api_retarr, boolean $validator_obj)
  • Visibility: public
  • This method is defined by APIFactory

Arguments

  • $api_retarr mixed
  • $validator_obj boolean

setValidationArray

array|boolean APIFactory::setValidationArray(string $primary_validator, string $secondary_validator, boolean $tertiary_validator)
  • Visibility: public
  • This method is defined by APIFactory

Arguments

  • $primary_validator string - UUID
  • $secondary_validator string - UUID
  • $tertiary_validator boolean

handleRecordValidationResults

array APIFactory::handleRecordValidationResults(object|boolean $validator, array $validator_stats, integer $key, array|boolean $save_result)
  • Visibility: public
  • This method is defined by APIFactory

Arguments

  • $validator object|boolean
  • $validator_stats array
  • $key integer
  • $save_result array|boolean
⚠️ **GitHub.com Fallback** ⚠️