TimeClock_ACTAtek
extends TimeClock_Base
in package
Table of Contents
- $connection_timeout : mixed
- $data : mixed
- $failed_connection : mixed
- $firmware_file : mixed
- $request_timeout : mixed
- $session_id : mixed
- $soap_obj : mixed
- $wsdl : mixed
- deleteAttendanceLog() : bool
- deleteUser() : bool
- deleteUserTemplate() : bool
- getAttendanceLog() : array<string|int, mixed>|bool
- getDate() : bool|false|int
- getFailedConnection() : bool
- getIPAddress() : mixed
- getPassword() : mixed
- getPath() : mixed
- getPort() : mixed
- getSerialNumber() : bool
- getSessionID() : bool|int
- getSoapObject() : bool
- getTimeZone() : bool|false|int
- getType() : mixed
- getUser() : array<string|int, mixed>|bool
- getUserName() : mixed
- getUserTemplate() : array<string|int, mixed>|bool
- handleSoapFault() : bool
- Login() : bool
- refresh() : bool
- removeDuplicatePunches() : bool
- Remove duplicate punches within the average rounded $threshold time.
- restart() : bool
- setDate() : bool
- setFailedConnection() : bool
- setFirmware() : bool
- setIPAddress() : bool
- setPassword() : bool
- setPath() : bool
- setPort() : bool
- setSessionID() : bool
- setSoapObject() : bool
- setTimeZone() : bool
- setTrigger() : bool
- setType() : bool
- setUser() : bool
- setUserName() : bool
- setUserTemplate() : bool
- soapDebug() : mixed
- soapGetFunctions() : mixed
- soapGetTypes() : mixed
- testConnection() : bool
- initiateSoapObject() : bool
Properties
$connection_timeout
public
mixed
$connection_timeout
= 5
$data
public
mixed
$data
= []
$failed_connection
public
mixed
$failed_connection
= \false
$firmware_file
public
mixed
$firmware_file
= 'ACTAtek.firmware'
$request_timeout
public
mixed
$request_timeout
= 3600
$session_id
public
mixed
$session_id
= \null
$soap_obj
public
mixed
$soap_obj
= \null
$wsdl
public
mixed
$wsdl
= 'ACTAtek.wsdl'
Methods
deleteAttendanceLog()
public
deleteAttendanceLog([int $last_punch_epoch = null ]) : bool
Parameters
- $last_punch_epoch : int = null
-
EPOCH
Return values
bool —deleteUser()
public
deleteUser(string $user_id) : bool
Parameters
- $user_id : string
-
UUID
Return values
bool —deleteUserTemplate()
public
deleteUserTemplate(string $user_id) : bool
Parameters
- $user_id : string
-
UUID
Return values
bool —getAttendanceLog()
public
getAttendanceLog([string $user_id = null ][, int $last_punch_epoch = null ][, bool $remove_duplicates = true ][, int $remove_duplicate_threshold = 30 ]) : array<string|int, mixed>|bool
Parameters
- $user_id : string = null
-
UUID
- $last_punch_epoch : int = null
-
EPOCH
- $remove_duplicates : bool = true
- $remove_duplicate_threshold : int = 30
Return values
array<string|int, mixed>|bool —getDate()
public
getDate() : bool|false|int
Return values
bool|false|int —getFailedConnection()
public
getFailedConnection() : bool
Return values
bool —getIPAddress()
public
getIPAddress() : mixed
Return values
mixed —getPassword()
public
getPassword() : mixed
Return values
mixed —getPath()
public
getPath() : mixed
Return values
mixed —getPort()
public
getPort() : mixed
Return values
mixed —getSerialNumber()
public
getSerialNumber() : bool
Return values
bool —getSessionID()
public
getSessionID() : bool|int
Return values
bool|int —getSoapObject()
public
getSoapObject() : bool
Return values
bool —getTimeZone()
public
getTimeZone() : bool|false|int
Return values
bool|false|int —getType()
public
getType() : mixed
Return values
mixed —getUser()
public
getUser([string $user_id = null ]) : array<string|int, mixed>|bool
Parameters
- $user_id : string = null
-
UUID
Return values
array<string|int, mixed>|bool —getUserName()
public
getUserName() : mixed
Return values
mixed —getUserTemplate()
public
getUserTemplate([string $user_id = null ][, string $finger_id = null ]) : array<string|int, mixed>|bool
Parameters
- $user_id : string = null
-
UUID
- $finger_id : string = null
-
UUID
Return values
array<string|int, mixed>|bool —handleSoapFault()
public
handleSoapFault( $result) : bool
Parameters
Return values
bool —Login()
public
Login() : bool
Return values
bool —refresh()
public
refresh() : bool
Return values
bool —removeDuplicatePunches()
Remove duplicate punches within the average rounded $threshold time.
public
removeDuplicatePunches( $arr[, int $threshold = 30 ]) : bool
IMPORTANT: Be sure to keep the last punch, not the first punch. Because otherwise we store the first punch as the last punch date, and the next time we download the punches it will include the duplicate.
Parameters
Return values
bool —restart()
public
restart() : bool
Return values
bool —setDate()
public
setDate([int $epoch = null ][, null $time_zone = null ]) : bool
Parameters
- $epoch : int = null
-
EPOCH
- $time_zone : null = null
Return values
bool —setFailedConnection()
public
setFailedConnection( $value) : bool
Parameters
Return values
bool —setFirmware()
public
setFirmware([null $file_name = null ]) : bool
Parameters
- $file_name : null = null
Return values
bool —setIPAddress()
public
setIPAddress( $value) : bool
Parameters
Return values
bool —setPassword()
public
setPassword( $value) : bool
Parameters
Return values
bool —setPath()
public
setPath( $value) : bool
Parameters
Return values
bool —setPort()
public
setPort( $value) : bool
Parameters
Return values
bool —setSessionID()
public
setSessionID( $value) : bool
Parameters
Return values
bool —setSoapObject()
public
setSoapObject(object $obj) : bool
Parameters
- $obj : object
Return values
bool —setTimeZone()
public
setTimeZone([null $string = null ]) : bool
Parameters
- $string : null = null
Return values
bool —setTrigger()
public
setTrigger( $trigger_type, $trigger_name) : bool
Parameters
Return values
bool —setType()
public
setType( $value) : bool
Parameters
Return values
bool —setUser()
public
setUser( $data) : bool
Parameters
Return values
bool —setUserName()
public
setUserName( $value) : bool
Parameters
Return values
bool —setUserTemplate()
public
setUserTemplate( $data) : bool
Parameters
Return values
bool —soapDebug()
public
soapDebug() : mixed
Return values
mixed —soapGetFunctions()
public
soapGetFunctions() : mixed
Return values
mixed —soapGetTypes()
public
soapGetTypes() : mixed
Return values
mixed —testConnection()
public
testConnection() : bool
Return values
bool —initiateSoapObject()
protected
initiateSoapObject() : bool