TimeClock_TTF4
extends TimeClock_TTA8
in package
Table of Contents
- $connection_timeout : mixed
- $data : mixed
- $failed_connection : mixed
- $firmware_file : mixed
- $firmware_files : mixed
- $firmware_version : mixed
- $mode_flag_map : mixed
- $request_timeout : mixed
- $soap_obj : mixed
- $wsdl : mixed
- clearAttendanceLog() : bool
- clearData() : bool
- 1 = Clear all Users & Templates 2 = Clear all templates 3 = Clear attendance logs
- deleteUser() : bool
- deleteUserTemplate() : bool
- generateOEMCode() : bool|string
- getAttendanceLog() : array<string|int, mixed>|bool
- getDate() : bool|false|int
- getFailedConnection() : bool
- getFirmwareVersion() : mixed|string
- getHardwareVersion() : mixed|string
- getIPAddress() : mixed
- getModeFlagMap() : array<string|int, mixed>
- getOption() : array<string|int, mixed>|bool
- getPassword() : mixed
- getPath() : mixed
- getPort() : mixed
- getSerialNumber() : array<string|int, mixed>|bool
- getSoapObject() : bool
- getType() : mixed
- getUser() : array<string|int, mixed>|bool
- getUserName() : mixed
- getUserTemplate() : array<string|int, mixed>|bool
- handleSoapFault() : bool
- parseOEMCode() : array<string|int, mixed>
- refresh() : bool
- removeDuplicatePunches() : array<string|int, mixed>|bool
- Remove duplicate punches within the average rounded $threshold time.
- restart() : bool
- setDate() : bool
- setFailedConnection() : bool
- setFirmware() : bool
- setFirmwareVersion() : bool
- setIPAddress() : bool
- setOption() : bool
- setPassword() : bool
- setPath() : bool
- setPort() : bool
- setSoapObject() : 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
= 'ttf4.firmware'
$firmware_files
public
mixed
$firmware_files
= ['0300' => ['tta8.0300_2_0a.firmware', 'tta8.0300_2_0b.firmware'], '0500' => []]
$firmware_version
public
mixed
$firmware_version
= '2.0'
$mode_flag_map
public
mixed
$mode_flag_map
= [
//We can use: OEMCode to set our own version numbers and such on the clock.
//1 is the default options that need to be set first so all values are reset to factory defaults.
1 => [
//Make UserID support up to 9 digits by default, the maximum.
//When PIN's greater than 5 digits are detected the clock just switches to using PIN2 field instead of PIN
//So getUser() needs to take this into account.
['name' => '~PIN2Width', 'value' => 9],
['name' => '~MustChoiceInOut', 'value' => 0],
['name' => 'WorkCode', 'value' => 0],
['name' => '~ExtendFmt', 'value' => 1],
['name' => '~LockFunOn', 'value' => 2],
//Access Control options in menu. Required for selecting type verification methods.
['name' => '~UserExtFmt', 'value' => 1],
//User Verification Methods Menu
['name' => 'GVS', 'value' => 0],
//FP or PW or RF
['name' => 'ShowScore', 'value' => 1],
//Always show score to help diagnose fingerprint problems.
['name' => 'State0', 'value' => 'In'],
['name' => 'State1', 'value' => 'Out'],
['name' => 'State2', 'value' => ''],
['name' => 'State3', 'value' => ''],
['name' => 'State4', 'value' => ''],
['name' => 'State5', 'value' => ''],
['name' => 'State0ExtraField', 'value' => '1'],
//Only ask for extra fields when punching IN.
['name' => 'State1ExtraField', 'value' => '0'],
['name' => 'State2ExtraField', 'value' => '0'],
['name' => 'State3ExtraField', 'value' => '1'],
['name' => 'State4ExtraField', 'value' => '0'],
['name' => 'State5ExtraField', 'value' => '1'],
['name' => 'ExtraField0', 'value' => ''],
['name' => 'ExtraField1', 'value' => ''],
['name' => 'ExtraField2', 'value' => ''],
['name' => 'ExtraField3', 'value' => ''],
['name' => 'ExtraField4', 'value' => ''],
['name' => 'ExtraField5', 'value' => ''],
['name' => 'ExtraField6', 'value' => ''],
['name' => 'ExtraField7', 'value' => ''],
['name' => 'ExtraField8', 'value' => ''],
['name' => 'ExtraField9', 'value' => ''],
],
2 => [['name' => '~MustChoiceInOut', 'value' => 1]],
//4 => array( array( 'name' => 'WorkCode', 'value' => 1 ), array( 'name' => '~ExtendFmt', 'value' => 1 ) ),
//8 => array( array( 'name' => 'WorkCode', 'value' => 2 ), array( 'name' => '~ExtendFmt', 'value' => 1 ) ),
4 => [['name' => 'State1', 'value' => '']],
//Disable Out State, so only In is available and TimeTrex can be forced to determine it everytime.
//16-Aug-10: For some reason there is a bug that if just Lunch is enabled, the timeclock is making lunch punches break punches.
//Doepker ran into this problem.
8 => [['name' => 'State2', 'value' => 'Break Out'], ['name' => 'State3', 'value' => 'Break In']],
16 => [['name' => 'State4', 'value' => 'Lunch Out'], ['name' => 'State5', 'value' => 'Lunch In']],
32 => [['name' => 'ExtraField0', 'value' => 'Branch?'], ['name' => '~ExtendFmt', 'value' => 1]],
64 => [['name' => 'ExtraField1', 'value' => 'Department?'], ['name' => '~ExtendFmt', 'value' => 1]],
128 => [['name' => 'ExtraField2', 'value' => 'Job?'], ['name' => '~ExtendFmt', 'value' => 1]],
256 => [['name' => 'ExtraField3', 'value' => 'Task?'], ['name' => '~ExtendFmt', 'value' => 1]],
512 => [['name' => 'ExtraField4', 'value' => 'Quantity?'], ['name' => '~ExtendFmt', 'value' => 1]],
1024 => [['name' => 'ExtraField5', 'value' => 'Bad Quantity?'], ['name' => '~ExtendFmt', 'value' => 1]],
//2048 - Hold for ExtraField6
//4096 - Hold for ExtraField7
//8192 - Hold for ExtraField8
//16384 - Hold for ExtraField9
32768 => [['name' => 'GVS1', 'value' => 9]],
//Fingerprint & Password
65536 => [['name' => 'GVS1', 'value' => 10]],
//Fingerprint & Proximity Card
131072 => [['name' => 'GVS1', 'value' => 8]],
//PIN & Fingerprint
262144 => [['name' => 'GVS1', 'value' => 11]],
]
$request_timeout
public
mixed
$request_timeout
= 3600
$soap_obj
public
mixed
$soap_obj
= \null
$wsdl
public
mixed
$wsdl
= 'TTA8.wsdl'
Methods
clearAttendanceLog()
public
clearAttendanceLog() : bool
Return values
bool —clearData()
1 = Clear all Users & Templates 2 = Clear all templates 3 = Clear attendance logs
public
clearData( $number) : bool
Parameters
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 —generateOEMCode()
public
generateOEMCode( $oem_code_arr) : bool|string
Parameters
Return values
bool|string —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
Tags
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 —getFirmwareVersion()
public
getFirmwareVersion() : mixed|string
Return values
mixed|string —getHardwareVersion()
public
getHardwareVersion() : mixed|string
Return values
mixed|string —getIPAddress()
public
getIPAddress() : mixed
Return values
mixed —getModeFlagMap()
public
getModeFlagMap() : array<string|int, mixed>
Return values
array<string|int, mixed> —getOption()
public
getOption( $name) : array<string|int, mixed>|bool
Parameters
Return values
array<string|int, mixed>|bool —getPassword()
public
getPassword() : mixed
Return values
mixed —getPath()
public
getPath() : mixed
Return values
mixed —getPort()
public
getPort() : mixed
Return values
mixed —getSerialNumber()
public
getSerialNumber() : array<string|int, mixed>|bool
Return values
array<string|int, mixed>|bool —getSoapObject()
public
getSoapObject() : bool
Return values
bool —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 —parseOEMCode()
public
parseOEMCode( $oem_code) : array<string|int, mixed>
Parameters
Return values
array<string|int, mixed> —refresh()
public
refresh() : bool
Return values
bool —removeDuplicatePunches()
Remove duplicate punches within the average rounded $threshold time.
public
removeDuplicatePunches( $arr[, int $threshold = 30 ]) : array<string|int, mixed>|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
array<string|int, mixed>|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 —setFirmwareVersion()
public
setFirmwareVersion([null $version = null ]) : bool
Parameters
- $version : null = null
Return values
bool —setIPAddress()
public
setIPAddress( $value) : bool
Parameters
Return values
bool —setOption()
public
setOption( $name, $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 —setSoapObject()
public
setSoapObject(object $obj) : bool
Parameters
- $obj : object
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