TimeTrex API Manual

StationListFactory extends StationFactory
in package
implements IteratorAggregate

Interfaces, Classes, Traits and Enums

IteratorAggregate

Table of Contents

$cache  : Cache_Lite_Function|Cache_Lite_Output
$data  : mixed
$db  : mixed
$is_new  : mixed
$old_data  : mixed
$rs  : mixed
$station_id_validator_regex  : mixed
$tmp_data  : mixed
$validate_only  : mixed
$Validator  : mixed
$api_message_id  : mixed
$company_obj  : mixed
$enable_system_log_detail  : mixed
$json_columns  : mixed
$pk_sequence_name  : mixed
$progress_bar_obj  : mixed
$table  : mixed
$ignore_column_list  : bool
$is_valid  : mixed
__construct()  : mixed
Factory constructor.
__toString()  : bool|string
Print primary columns from object.
addLog()  : bool
bulkDelete()  : bool
castGenericDataValue()  : mixed
Generic casting function that all set/get*() functions should pass through.
checkAllowed()  : bool
A fast way to check many stations if the user is allowed. 10 = PC
checkSource()  : bool
clearCacheSavedInTransaction()  : bool
clearData()  : bool
clearGeoCode()  : bool
clearNonMappedData()  : array<string|int, mixed>|null
Removes array elements from $data that are not in the function map.
clearOldData()  : bool
CommitSavePoint()  : bool
CommitTransaction()  : mixed
convertFlexArray()  : array<string|int, mixed>
decodeCustomFields()  : bool
decodeGenericJSONData()  : bool
Decode generic 'other_json' column data.
decodeJSONColumn()  : bool
Decodes JSON columns that are not the 'other_json' column.
Delete()  : bool
Deletes the record directly from the database.
destroyCookie()  : bool
encodeCustomFields()  : bool
encodeGenericJSONData()  : bool
Encode generic 'other_json' column data. This should only be done in Save() after all validation has occurred already and we are just about to commit it to the DB.
encodeJSONColumns()  : bool
Encode any JSON columns that are not 'other_json' column. This should only be done in Save() after all validation has occurred already and we are just about to commit it to the DB.
ExecuteSQL()  : bool
Execute SQL queries and handle paging properly for select statements.
FailTransaction()  : mixed
fromBool()  : bool
fromJSONBool()  : bool
getAffectedRows()  : int|bool
getAll()  : $this
getAllowedDate()  : bool|mixed
getAPIMessageID()  : bool|null
Used for updating progress bar for API calls.
getAPISearchByCompanyIdAndArrayCriteria()  : bool|StationListFactory
getAPITimeClockStationsByArrayCriteria()  : $this
getBranch()  : array<string|int, mixed>|bool
getBranchSelectionType()  : bool|int
getByCompanyId()  : bool|StationListFactory
getByCompanyIdAndTypeId()  : bool|StationListFactory
getByCompanyIdArray()  : array<string|int, mixed>|bool
getById()  : bool|StationListFactory
getByIdAndCompanyId()  : bool|StationListFactory
getByStationId()  : bool|StationListFactory
getByStationIdAndCompanyId()  : bool|StationListFactory
getByStationIdAndStatusIdAndTypeId()  : bool|StationListFactory
getByUserIdAndStatusAndType()  : bool|StationListFactory
getCache()  : bool|mixed
getColumn()  : bool|mixed
Generic function get any data from the data array.
getColumnList()  : array<string|int, mixed>|bool
getCompany()  : mixed
getCompanyGenericMapData()  : mixed
Generic function to return and cache CompanyGenericMap data, this greatly improves performance of CalculatePolicy when many policies exist.
getCompanyObject()  : bool
getCountByCompanyIdAndTypeId()  : bool|StationListFactory
getCreatedAndUpdatedColumns()  : bool
getCreatedBy()  : bool|mixed
getCreatedDate()  : int
getCurrent()  : mixed
Grabs the current object
getCurrentRow()  : int|bool
getCustomField()  : void
Get a single custom field by ID.
getCustomFields()  : mixed
getCustomFieldsColumns()  : array<string|int, mixed>
getCustomFieldsDataForObject()  : array<string|int, mixed>
Get custom field data for this specific object, so it can be easily cached in memory without having to go to the database or unserialize it from cache for every row.
getCustomFieldsDefaultData()  : mixed
getCustomFieldsParseHints()  : array<string|int, mixed>
getCustomFieldTableName()  : string
getDataDifferences()  : array<string|int, mixed>
Returns the differences in data from the DB vs the in-memory object, so the data will be the OLD data. Used in Validation/postSave() functions to determine if a field has changed or not.
getDateRangeSQL()  : bool|string
This function takes plain input from the user and creates a SQL statement for filtering based on a date range.
getDefaultBranch()  : bool|mixed
getDefaultDepartment()  : bool|mixed
getDefaultJob()  : bool|mixed
getDefaultJobItem()  : bool|mixed
getDefaultModeFlag()  : bool|int
getDefaultPunchTag()  : array<string|int, mixed>|bool
getDeleted()  : bool
getDeletedBy()  : bool|mixed
getDeletedDate()  : bool|mixed
getDepartment()  : array<string|int, mixed>|bool
getDepartmentSelectionType()  : bool|int
getDescription()  : bool|mixed
getEmptyRecordSet()  : mixed
getEnableAutoPunchStatus()  : bool
getEnableSystemLogDetail()  : bool
getExcludeUser()  : array<string|int, mixed>|bool
getGenericDataValue()  : bool|mixed
Generic getter/setter functions that should be used when Validation code is moved from get/set functions to Validate() function.
getGenericJSONDataValue()  : bool|mixed
Generic getter/setter functions for handling generic JSON data in 'other_json' SQL column.
getGenericObject()  : object|bool
Generic function to return and cache class objects ListFactory, ListFactoryMethod, Variable, ID, IDMethod
getGenericOldDataValue()  : bool|mixed
getGenericTempDataValue()  : bool
Generic getter/setter functions that should be used when Validation code is moved from get/set functions to Validate() function.
getGroup()  : array<string|int, mixed>|bool
getGroupSelectionType()  : bool|int
getId()  : bool|mixed
getIDSByListFactory()  : array<string|int, mixed>|bool
getIncludeUser()  : array<string|int, mixed>|bool
getIterator()  : FactoryListIterator
getLabelId()  : bool|mixed|string
getLastPartialPushDate()  : bool|mixed
getLastPartialPushStatusMessage()  : bool|mixed
getLastPollDate()  : bool|mixed
getLastPollStatusMessage()  : bool|mixed
getLastPunchTimeStamp()  : bool|int
getLastPushDate()  : bool|mixed
getLastPushStatusMessage()  : bool|mixed
getModeFlag()  : array<string|int, mixed>|bool
getNextInsertId()  : bool|string
getObjectAsArray()  : array<string|int, mixed>
getOptions()  : array<string|int, mixed>|bool
getOrCreateStation()  : bool|object|StationFactory|StationListFactory|string
getPartialPushFrequency()  : bool|mixed
getPassword()  : bool|mixed
getPendingSynchronizationByCompanyIdAndTypeId()  : bool|StationListFactory
getPermissionColumns()  : bool
getPollFrequency()  : bool|mixed
getPort()  : bool|mixed
getProgressBarObject()  : null|ProgressBar
getPushFrequency()  : bool|mixed
getRecordCount()  : int|bool
getSequenceName()  : bool
getSource()  : bool|mixed
getStation()  : bool|string
getStatus()  : bool|int
getTable()  : bool|string
getTimeZone()  : bool|mixed
getTransactionMode()  : string
getType()  : bool|int
getUpdatedBy()  : bool|mixed
getUpdatedDate()  : int
getUserName()  : bool|mixed
getUserValue1()  : string
getUserValue2()  : string
getUserValue3()  : string
getUserValue4()  : string
getUserValue5()  : string
getValidSQLColumns()  : array<string|int, mixed>
getVariableToFunctionMap()  : array<string|int, mixed>|bool
handleSaveSQLReturning()  : bool
Used to handle any "RETURNING ..." clause on a SQL INSERT/UPDATE query.
hasDataChanged()  : bool
Determine if the record data has changed at all.
isActiveForAnyEmployee()  : bool
Check to see if this station is active for any employees, if not, we may as well mark it as disabled to speed up queries.
isAllowed()  : bool
isClientFriendly()  : bool
Check if the remote client is our main UI app controlled by us, vs. a user utilizing the API for example.
isDataDifferent()  : bool
Used to check the differences between a single key in the $old_data vs. $data arrays.
isNew()  : bool
Determines if the data is new data, or updated data. Basically determines if a database INSERT or UPDATE SQL statement is generated.
isSQLExceptionRetryable()  : bool
Determines if a SQL exception is one that can be retried or not.
isUniqueStation()  : bool
isValid()  : bool
Call class specific validation function just before saving.
isWarning()  : bool
Call class specific validation function just before saving.
modifyInsertQuery()  : mixed
Modifies the automatically generated SQL INSERT query for adding things like " ON CONFLICT ..."
parseCustomFieldsFromArray()  : mixed
parseWorkCode()  : array<string|int, mixed>
postSave()  : bool
preSave()  : bool
removeCache()  : bool
RetryTransaction()  : mixed
Accepts a Closure and is retried at set intervals which should be in a transaction.
rewind()  : bool
Rewinds record set iterator to begining. The same as ADODB's MoveFirst() function.
RollbackSavePoint()  : bool
Save()  : bool|int|string
Determines to insert or update, and does it.
saveCache()  : bool
serializeRS()  : string
Serialize ADODB recordset.
setAllowedDate()  : bool
setAPIMessageID()  : bool
setBranch()  : bool
setBranchSelectionType()  : bool
setCacheLifeTime()  : bool
setCompany()  : bool
setCookie()  : bool
setCreatedAndUpdatedColumns()  : bool
setCreatedBy()  : bool
setCreatedDate()  : bool
setCustomField()  : void
Set a single custom field by ID.
setCustomFields()  : bool
setDefaultBranch()  : bool
setDefaultDepartment()  : bool
setDefaultJob()  : bool
setDefaultJobItem()  : bool
setDefaultModeFlag()  : bool
setDefaultPunchTag()  : bool
setDeleted()  : bool
setDeletedBy()  : bool|null
setDeletedDate()  : bool
setDepartment()  : bool
setDepartmentSelectionType()  : bool
setDescription()  : bool
setEnableAutoPunchStatus()  : bool
setEnableSystemLogDetail()  : bool
setExcludeUser()  : bool
setGenericDataValue()  : bool
setGenericJSONDataValue()  : bool
Generic getter/setter functions for handling generic JSON data in 'other_json' SQL column.
setGenericObject()  : bool
Allow method to pre-populate/overwrite the cache if needed.
setGenericTempDataValue()  : bool
setGroup()  : bool
setGroupSelectionType()  : bool
setId()  : bool
setIncludeUser()  : bool
setIsValid()  : bool
Sets the is_valid flag, mostly used to set it to FALSE to force a full re-validation.
setLastPartialPushDate()  : bool
setLastPartialPushStatusMessage()  : bool
setLastPollDate()  : bool
setLastPollStatusMessage()  : bool
setLastPunchTimeStamp()  : bool
setLastPushDate()  : bool
setLastPushStatusMessage()  : bool
setModeFlag()  : bool
setObjectFromArray()  : bool
setPartialPushFrequency()  : bool
setPassword()  : bool
setPollFrequency()  : bool
setPort()  : bool
setProgressBarObject()  : bool
setPushFrequency()  : bool
setQueryStatementTimeout()  : bool
setSource()  : bool
setStation()  : bool
setStatus()  : bool
setTimeZone()  : bool
setTransactionMode()  : mixed
setType()  : bool
setUpdatedBy()  : bool|null
setUpdatedDate()  : bool|int|null|string
setUserName()  : bool
setUserValue1()  : bool
setUserValue2()  : bool
setUserValue3()  : bool
setUserValue4()  : bool
setUserValue5()  : bool
StartSavePoint()  : bool
StartTransaction()  : mixed
toBool()  : int
toJSONBool()  : string
updateAllowedDate()  : bool
Update JUST station allowed_date without affecting updated_date, and without creating an EDIT entry in the system_log.
updateLastPartialPushDate()  : bool
Update JUST station last_partial_push_date without affecting updated_date, and without creating an EDIT entry in the system_log.
updateLastPollDate()  : bool
Update JUST station last_poll_date without affecting updated_date, and without creating an EDIT entry in the system_log.
updateLastPollDateAndLastPunchTimeStamp()  : bool
Update JUST station last_poll_date AND last_punch_time_stamp without affecting updated_date, and without creating an EDIT entry in the system_log.
updateLastPushDate()  : bool
Update JUST station last_push_date without affecting updated_date, and without creating an EDIT entry in the system_log.
Validate()  : bool
validateCustomFields()  : mixed
_getFactoryOptions()  : bool
_getVariableToFunctionMap()  : bool
castInteger()  : bool|int|string
getColumnsFromAliases()  : array<string|int, mixed>
getCustomFieldWhereSQL()  : string
getDatabaseType()  : string
getListSQL()  : bool|int|string|array<string|int, mixed>
getSortSQL()  : bool|string
getSQLStringAggregate()  : string
getSQLToEpochFunction()  : string
getSQLToTimeFunction()  : string
getSQLToTimeStampFunction()  : string
getWhereClauseSQL()  : null|string
getWhereSQL()  : bool|string
handleSQLSyntax()  : string
SQL where clause Syntax: or % as wildcard.
stripSQLSyntax()  : mixed
genStationID()  : string
getInsertQuery()  : mixed
getRecordSetColumnList()  : array<string|int, mixed>|bool
getUpdateQuery()  : bool
parseColumnName()  : bool|string
Parses out the exact column name, without any aliases, or = signs in it.

Properties

$cache

public Cache_Lite_Function|Cache_Lite_Output $cache = \null

$station_id_validator_regex

public mixed $station_id_validator_regex = '/^[a-zA-Z0-9-\\*]{1,100}$/i'

$enable_system_log_detail

protected mixed $enable_system_log_detail = \true

Methods

__construct()

Factory constructor.

public __construct() : mixed
Return values
mixed

__toString()

Print primary columns from object.

public __toString() : bool|string
Return values
bool|string

addLog()

public addLog( $log_action) : bool
Parameters
$log_action :
Return values
bool

bulkDelete()

public bulkDelete(string|array<string|int, mixed> $ids) : bool
Parameters
$ids : string|array<string|int, mixed>

UUID

Tags
throws
DBError
Return values
bool

castGenericDataValue()

Generic casting function that all set/get*() functions should pass through.

public castGenericDataValue( &$value,  $cast) : mixed

However for now lets wait until we have meta data from SQL schema so we can pass those datatypes directly into this.

Parameters
$value :

mixed

$cast :

string

Return values
mixed

checkAllowed()

A fast way to check many stations if the user is allowed. 10 = PC

public checkAllowed([string $user_id = null ][, string $station_id = null ][, int $type = 10 ][, bool $update_allowed_date = true ][, mixed $return_station_id = false ]) : bool
Parameters
$user_id : string = null

UUID

$station_id : string = null

UUID

$type : int = 10
$update_allowed_date : bool = true
$return_station_id : mixed = false
Tags
parem

bool $update_allowed_date Updates the station allowed date, which should only be done when a punch is saved.

Return values
bool

checkSource()

public checkSource( $source, string $current_station_id) : bool
Parameters
$source :
$current_station_id : string

UUID

Return values
bool

clearCacheSavedInTransaction()

public clearCacheSavedInTransaction() : bool
Return values
bool

clearData()

public clearData() : bool
Return values
bool

clearGeoCode()

public clearGeoCode([array<string|int, mixed> $data_diff = null ]) : bool
Parameters
$data_diff : array<string|int, mixed> = null
Return values
bool

clearNonMappedData()

Removes array elements from $data that are not in the function map.

public clearNonMappedData([array<string|int, mixed>|null $data = null ]) : array<string|int, mixed>|null
Parameters
$data : array<string|int, mixed>|null = null
Return values
array<string|int, mixed>|null

clearOldData()

public clearOldData() : bool
Return values
bool

CommitSavePoint()

public CommitSavePoint( $name) : bool
Parameters
$name :
Return values
bool

CommitTransaction()

public CommitTransaction([bool $unnest_transactions = false ]) : mixed
Parameters
$unnest_transactions : bool = false
Tags
throws
DBError
Return values
mixed

convertFlexArray()

public convertFlexArray(array<string|int, mixed> $array) : array<string|int, mixed>
Parameters
$array : array<string|int, mixed>
Return values
array<string|int, mixed>

decodeCustomFields()

public decodeCustomFields() : bool
Return values
bool

decodeGenericJSONData()

Decode generic 'other_json' column data.

public decodeGenericJSONData() : bool
Return values
bool

decodeJSONColumn()

Decodes JSON columns that are not the 'other_json' column.

public decodeJSONColumn( $column) : bool
Parameters
$column :
Return values
bool

Delete()

Deletes the record directly from the database.

public Delete([bool $disable_audit_log = false ]) : bool
Parameters
$disable_audit_log : bool = false
Tags
throws
DBError
Return values
bool

encodeCustomFields()

public encodeCustomFields() : bool
Return values
bool

encodeGenericJSONData()

Encode generic 'other_json' column data. This should only be done in Save() after all validation has occurred already and we are just about to commit it to the DB.

public encodeGenericJSONData() : bool
Return values
bool

encodeJSONColumns()

Encode any JSON columns that are not 'other_json' column. This should only be done in Save() after all validation has occurred already and we are just about to commit it to the DB.

public encodeJSONColumns() : bool
Return values
bool

ExecuteSQL()

Execute SQL queries and handle paging properly for select statements.

public ExecuteSQL(string $query[, array<string|int, mixed> $ph = null ][, int $limit = null ][, int $page = null ]) : bool
Parameters
$query : string
$ph : array<string|int, mixed> = null
$limit : int = null

Limit the number of records returned

$page : int = null

Page number of records to return for pagination

Tags
throws
DBError
throws
Exception
Return values
bool

FailTransaction()

public FailTransaction() : mixed
Return values
mixed

fromBool()

public fromBool(string|int|bool $value) : bool
Parameters
$value : string|int|bool
Return values
bool

fromJSONBool()

public fromJSONBool(string|int|bool $value) : bool
Parameters
$value : string|int|bool
Return values
bool

getAffectedRows()

public getAffectedRows() : int|bool
Return values
int|bool

getAll()

public getAll([int $limit = null ][, int $page = null ][, array<string|int, mixed> $where = null ][, array<string|int, mixed> $order = null ]) : $this
Parameters
$limit : int = null

Limit the number of records returned

$page : int = null

Page number of records to return for pagination

$where : array<string|int, mixed> = null

Additional SQL WHERE clause in format of array( $column => $filter, ... ). ie: array( 'id' => 1, ... )

$order : array<string|int, mixed> = null

Sort order passed to SQL in format of array( $column => 'asc', 'name' => 'desc', ... ). ie: array( 'id' => 'asc', 'name' => 'desc', ... )

Return values
$this

getAPIMessageID()

Used for updating progress bar for API calls.

public getAPIMessageID() : bool|null
Return values
bool|null

getAPISearchByCompanyIdAndArrayCriteria()

public getAPISearchByCompanyIdAndArrayCriteria(string $company_id,  $filter_data[, int $limit = null ][, int $page = null ][, array<string|int, mixed> $where = null ][, array<string|int, mixed> $order = null ]) : bool|StationListFactory
Parameters
$company_id : string

UUID

$filter_data :
$limit : int = null

Limit the number of records returned

$page : int = null

Page number of records to return for pagination

$where : array<string|int, mixed> = null

Additional SQL WHERE clause in format of array( $column => $filter, ... ). ie: array( 'id' => 1, ... )

$order : array<string|int, mixed> = null

Sort order passed to SQL in format of array( $column => 'asc', 'name' => 'desc', ... ). ie: array( 'id' => 'asc', 'name' => 'desc', ... )

Return values
bool|StationListFactory

getAPITimeClockStationsByArrayCriteria()

public getAPITimeClockStationsByArrayCriteria( $filter_data[, int $limit = null ][, int $page = null ][, array<string|int, mixed> $where = null ][, array<string|int, mixed> $order = null ]) : $this
Parameters
$filter_data :
$limit : int = null

Limit the number of records returned

$page : int = null

Page number of records to return for pagination

$where : array<string|int, mixed> = null

Additional SQL WHERE clause in format of array( $column => $filter, ... ). ie: array( 'id' => 1, ... )

$order : array<string|int, mixed> = null

Sort order passed to SQL in format of array( $column => 'asc', 'name' => 'desc', ... ). ie: array( 'id' => 'asc', 'name' => 'desc', ... )

Return values
$this

getBranch()

public getBranch() : array<string|int, mixed>|bool
Return values
array<string|int, mixed>|bool

getBranchSelectionType()

public getBranchSelectionType() : bool|int
Return values
bool|int

getByCompanyId()

public getByCompanyId(string $id[, int $limit = null ][, int $page = null ][, array<string|int, mixed> $where = null ][, array<string|int, mixed> $order = null ]) : bool|StationListFactory
Parameters
$id : string

UUID

$limit : int = null

Limit the number of records returned

$page : int = null

Page number of records to return for pagination

$where : array<string|int, mixed> = null

Additional SQL WHERE clause in format of array( $column => $filter, ... ). ie: array( 'id' => 1, ... )

$order : array<string|int, mixed> = null

Sort order passed to SQL in format of array( $column => 'asc', 'name' => 'desc', ... ). ie: array( 'id' => 'asc', 'name' => 'desc', ... )

Return values
bool|StationListFactory

getByCompanyIdAndTypeId()

public getByCompanyIdAndTypeId(string $company_id, int|array<string|int, int> $type_id[, array<string|int, mixed> $order = null ]) : bool|StationListFactory
Parameters
$company_id : string

UUID

$type_id : int|array<string|int, int>
$order : array<string|int, mixed> = null

Sort order passed to SQL in format of array( $column => 'asc', 'name' => 'desc', ... ). ie: array( 'id' => 'asc', 'name' => 'desc', ... )

Return values
bool|StationListFactory

getByCompanyIdArray()

public getByCompanyIdArray(string $company_id) : array<string|int, mixed>|bool
Parameters
$company_id : string

UUID

Return values
array<string|int, mixed>|bool

getById()

public getById(string $id[, array<string|int, mixed> $where = null ][, array<string|int, mixed> $order = null ]) : bool|StationListFactory
Parameters
$id : string

UUID

$where : array<string|int, mixed> = null

Additional SQL WHERE clause in format of array( $column => $filter, ... ). ie: array( 'id' => 1, ... )

$order : array<string|int, mixed> = null

Sort order passed to SQL in format of array( $column => 'asc', 'name' => 'desc', ... ). ie: array( 'id' => 'asc', 'name' => 'desc', ... )

Return values
bool|StationListFactory

getByIdAndCompanyId()

public getByIdAndCompanyId(string $id, string $company_id[, array<string|int, mixed> $order = null ]) : bool|StationListFactory
Parameters
$id : string

UUID

$company_id : string

UUID

$order : array<string|int, mixed> = null

Sort order passed to SQL in format of array( $column => 'asc', 'name' => 'desc', ... ). ie: array( 'id' => 'asc', 'name' => 'desc', ... )

Return values
bool|StationListFactory

getByStationId()

public getByStationId(string $station_id[, array<string|int, mixed> $order = null ]) : bool|StationListFactory
Parameters
$station_id : string

UUID

$order : array<string|int, mixed> = null

Sort order passed to SQL in format of array( $column => 'asc', 'name' => 'desc', ... ). ie: array( 'id' => 'asc', 'name' => 'desc', ... )

Return values
bool|StationListFactory

getByStationIdAndCompanyId()

public getByStationIdAndCompanyId(string $station_id, string $company_id[, array<string|int, mixed> $order = null ]) : bool|StationListFactory
Parameters
$station_id : string

UUID

$company_id : string

UUID

$order : array<string|int, mixed> = null

Sort order passed to SQL in format of array( $column => 'asc', 'name' => 'desc', ... ). ie: array( 'id' => 'asc', 'name' => 'desc', ... )

Return values
bool|StationListFactory

getByStationIdAndStatusIdAndTypeId()

public getByStationIdAndStatusIdAndTypeId(string $station_id, int|array<string|int, mixed> $status_id, int|array<string|int, mixed> $type_id[, array<string|int, mixed> $order = null ]) : bool|StationListFactory
Parameters
$station_id : string

UUID

$status_id : int|array<string|int, mixed>
$type_id : int|array<string|int, mixed>
$order : array<string|int, mixed> = null

Sort order passed to SQL in format of array( $column => 'asc', 'name' => 'desc', ... ). ie: array( 'id' => 'asc', 'name' => 'desc', ... )

Return values
bool|StationListFactory

getCache()

public getCache(string $cache_id[, string $group_id = null ]) : bool|mixed
Parameters
$cache_id : string
$group_id : string = null
Return values
bool|mixed

getColumn()

Generic function get any data from the data array.

public getColumn(string $column) : bool|mixed

Used mainly for the reports that return grouped queries and such.

Parameters
$column : string
Return values
bool|mixed

getColumnList()

public getColumnList() : array<string|int, mixed>|bool
Return values
array<string|int, mixed>|bool

getCompanyGenericMapData()

Generic function to return and cache CompanyGenericMap data, this greatly improves performance of CalculatePolicy when many policies exist.

public getCompanyGenericMapData(string $company_id, int $object_type_id, string $id, string $variable) : mixed
Parameters
$company_id : string

UUID

$object_type_id : int
$id : string

UUID

$variable : string
Return values
mixed

getCountByCompanyIdAndTypeId()

public getCountByCompanyIdAndTypeId(string $company_id, int $type_id[, array<string|int, mixed> $order = null ]) : bool|StationListFactory
Parameters
$company_id : string

UUID

$type_id : int
$order : array<string|int, mixed> = null

Sort order passed to SQL in format of array( $column => 'asc', 'name' => 'desc', ... ). ie: array( 'id' => 'asc', 'name' => 'desc', ... )

Return values
bool|StationListFactory

getCreatedAndUpdatedColumns()

public getCreatedAndUpdatedColumns(array<string|int, mixed> &$data[, null $include_columns = null ]) : bool
Parameters
$data : array<string|int, mixed>
$include_columns : null = null
Return values
bool

getCreatedBy()

public getCreatedBy() : bool|mixed
Return values
bool|mixed

getCreatedDate()

public getCreatedDate() : int
Return values
int

getCurrent()

Grabs the current object

public final getCurrent() : mixed
Return values
mixed

getCurrentRow()

public getCurrentRow([int $offset = 1 ]) : int|bool
Parameters
$offset : int = 1
Return values
int|bool

getCustomField()

Get a single custom field by ID.

public getCustomField(string $id) : void
Parameters
$id : string

UUID

Return values
void

getCustomFields()

public getCustomFields( $company_id,  $data[,  $include_columns = null ]) : mixed
Parameters
$company_id :
$data :
$include_columns : = null
Return values
mixed

getCustomFieldsColumns()

public getCustomFieldsColumns(array<string|int, mixed> $columns, string $company_id[, bool $use_sort_prefix = true ][, string|null $table_name = null ]) : array<string|int, mixed>
Parameters
$columns : array<string|int, mixed>
$company_id : string
$use_sort_prefix : bool = true
$table_name : string|null = null
Return values
array<string|int, mixed>

getCustomFieldsDataForObject()

Get custom field data for this specific object, so it can be easily cached in memory without having to go to the database or unserialize it from cache for every row.

public getCustomFieldsDataForObject( $company_id[, mixed $table_name = null ]) : array<string|int, mixed>
Parameters
$company_id :
$table_name : mixed = null
Tags
throws
ReflectionException
Return values
array<string|int, mixed>

getCustomFieldsDefaultData()

public getCustomFieldsDefaultData( $company_id,  $data[, bool $get_all_fields = false ]) : mixed
Parameters
$company_id :
$data :
$get_all_fields : bool = false
Return values
mixed

getCustomFieldsParseHints()

public getCustomFieldsParseHints(array<string|int, mixed> $columns, string $company_id, string|null $table_name) : array<string|int, mixed>
Parameters
$columns : array<string|int, mixed>
$company_id : string
$table_name : string|null
Return values
array<string|int, mixed>

getCustomFieldTableName()

public getCustomFieldTableName() : string
Return values
string

getDataDifferences()

Returns the differences in data from the DB vs the in-memory object, so the data will be the OLD data. Used in Validation/postSave() functions to determine if a field has changed or not.

public getDataDifferences() : array<string|int, mixed>
Return values
array<string|int, mixed>

getDateRangeSQL()

This function takes plain input from the user and creates a SQL statement for filtering based on a date range.

public getDateRangeSQL(string $str, string $column[, string $format = 'epoch' ][, bool $include_blank_dates = false ]) : bool|string

Supported Syntax:

=01-Jan-09 <=01-Jan-09 <01-Jan-09 01-Jan-09 01-Jan-09 & <10-Jan-09

Parameters
$str : string
$column : string
$format : string = 'epoch'
$include_blank_dates : bool = false
Return values
bool|string

getDefaultDepartment()

public getDefaultDepartment() : bool|mixed
Return values
bool|mixed

getDefaultJobItem()

public getDefaultJobItem() : bool|mixed
Return values
bool|mixed

getDefaultModeFlag()

public getDefaultModeFlag() : bool|int
Return values
bool|int

getDefaultPunchTag()

public getDefaultPunchTag() : array<string|int, mixed>|bool
Return values
array<string|int, mixed>|bool

getDeleted()

public getDeleted() : bool
Return values
bool

getDeletedBy()

public getDeletedBy() : bool|mixed
Return values
bool|mixed

getDeletedDate()

public getDeletedDate() : bool|mixed
Return values
bool|mixed

getDepartment()

public getDepartment() : array<string|int, mixed>|bool
Return values
array<string|int, mixed>|bool

getDepartmentSelectionType()

public getDepartmentSelectionType() : bool|int
Return values
bool|int

getEmptyRecordSet()

public getEmptyRecordSet([string $id = null ]) : mixed
Parameters
$id : string = null

UUID

Tags
throws
DBError
Return values
mixed

getEnableAutoPunchStatus()

public getEnableAutoPunchStatus() : bool
Return values
bool

getEnableSystemLogDetail()

public getEnableSystemLogDetail() : bool
Return values
bool

getExcludeUser()

public getExcludeUser() : array<string|int, mixed>|bool
Return values
array<string|int, mixed>|bool

getGenericDataValue()

Generic getter/setter functions that should be used when Validation code is moved from get/set functions to Validate() function.

public getGenericDataValue(string $name[, null $cast = null ]) : bool|mixed
Parameters
$name : string
$cast : null = null
Return values
bool|mixed

getGenericJSONDataValue()

Generic getter/setter functions for handling generic JSON data in 'other_json' SQL column.

public getGenericJSONDataValue(string $name[, null $cast = null ]) : bool|mixed
Parameters
$name : string
$cast : null = null
Return values
bool|mixed

getGenericObject()

Generic function to return and cache class objects ListFactory, ListFactoryMethod, Variable, ID, IDMethod

public getGenericObject(string $list_factory, string|int $id, string $variable[, string $list_factory_method = 'getById' ][, string $id_method = 'getID' ]) : object|bool
Parameters
$list_factory : string
$id : string|int

UUID

$variable : string
$list_factory_method : string = 'getById'
$id_method : string = 'getID'
Return values
object|bool

getGenericOldDataValue()

public getGenericOldDataValue(string $name) : bool|mixed
Parameters
$name : string

Gets data value from old_data array, or the original value in the database, prior to any changes currently in memory.

Return values
bool|mixed

getGenericTempDataValue()

Generic getter/setter functions that should be used when Validation code is moved from get/set functions to Validate() function.

public getGenericTempDataValue(string $name) : bool
Parameters
$name : string
Return values
bool

getGroup()

public getGroup() : array<string|int, mixed>|bool
Return values
array<string|int, mixed>|bool

getGroupSelectionType()

public getGroupSelectionType() : bool|int
Return values
bool|int

getId()

public getId() : bool|mixed
Return values
bool|mixed

getIDSByListFactory()

public getIDSByListFactory(object $lf) : array<string|int, mixed>|bool
Parameters
$lf : object
Return values
array<string|int, mixed>|bool

getIncludeUser()

public getIncludeUser() : array<string|int, mixed>|bool
Return values
array<string|int, mixed>|bool

getLabelId()

public getLabelId() : bool|mixed|string
Return values
bool|mixed|string

getLastPartialPushDate()

public getLastPartialPushDate() : bool|mixed
Return values
bool|mixed

getLastPartialPushStatusMessage()

public getLastPartialPushStatusMessage() : bool|mixed
Return values
bool|mixed

getLastPollStatusMessage()

public getLastPollStatusMessage() : bool|mixed
Return values
bool|mixed

getLastPunchTimeStamp()

public getLastPunchTimeStamp([bool $raw = false ]) : bool|int
Parameters
$raw : bool = false
Return values
bool|int

getLastPushStatusMessage()

public getLastPushStatusMessage() : bool|mixed
Return values
bool|mixed

getModeFlag()

public getModeFlag() : array<string|int, mixed>|bool
Return values
array<string|int, mixed>|bool

getNextInsertId()

public getNextInsertId() : bool|string
Return values
bool|string

getObjectAsArray()

public getObjectAsArray([null $include_columns = null ][, bool $permission_children_ids = false ]) : array<string|int, mixed>
Parameters
$include_columns : null = null
$permission_children_ids : bool = false
Return values
array<string|int, mixed>

getOptions()

public getOptions(string $name[, string|int $parent = null ]) : array<string|int, mixed>|bool
Parameters
$name : string
$parent : string|int = null
Return values
array<string|int, mixed>|bool

getOrCreateStation()

public static getOrCreateStation(string $station_id, string $company_id[, int $type_id = 10 ][, string $description = null ][, Permission $permission_obj = null ][, UserFactory $user_obj = null ]) : bool|object|StationFactory|StationListFactory|string
Parameters
$station_id : string

UUID

$company_id : string

UUID

$type_id : int = 10
$description : string = null
$permission_obj : Permission = null
$user_obj : UserFactory = null
Tags
throws
DBError
throws
GeneralError
Return values
bool|object|StationFactory|StationListFactory|string

getPartialPushFrequency()

public getPartialPushFrequency() : bool|mixed
Return values
bool|mixed

getPendingSynchronizationByCompanyIdAndTypeId()

public getPendingSynchronizationByCompanyIdAndTypeId(string $company_id, int|array<string|int, int> $type_id[, array<string|int, mixed> $order = null ]) : bool|StationListFactory
Parameters
$company_id : string

UUID

$type_id : int|array<string|int, int>
$order : array<string|int, mixed> = null

Sort order passed to SQL in format of array( $column => 'asc', 'name' => 'desc', ... ). ie: array( 'id' => 'asc', 'name' => 'desc', ... )

Return values
bool|StationListFactory

getPermissionColumns()

public getPermissionColumns(array<string|int, mixed> &$data, string $object_user_id, string $created_by_id[, string $permission_children_ids = null ][, array<string|int, mixed> $include_columns = null ]) : bool
Parameters
$data : array<string|int, mixed>
$object_user_id : string

UUID

$created_by_id : string

UUID

$permission_children_ids : string = null

UUID

$include_columns : array<string|int, mixed> = null
Return values
bool

getPollFrequency()

public getPollFrequency() : bool|mixed
Return values
bool|mixed

getPushFrequency()

public getPushFrequency() : bool|mixed
Return values
bool|mixed

getRecordCount()

public getRecordCount() : int|bool
Return values
int|bool

getSequenceName()

public getSequenceName() : bool
Return values
bool

getTable()

public getTable([bool $strip_quotes = false ]) : bool|string
Parameters
$strip_quotes : bool = false
Return values
bool|string

getTransactionMode()

public getTransactionMode([bool $force = false ]) : string
Parameters
$force : bool = false
Return values
string

getUpdatedBy()

public getUpdatedBy() : bool|mixed
Return values
bool|mixed

getUpdatedDate()

public getUpdatedDate() : int
Return values
int

getValidSQLColumns()

public getValidSQLColumns(array<string|int, mixed> $array[, bool $strict = true ][, array<string|int, mixed> $additional_fields = null ]) : array<string|int, mixed>
Parameters
$array : array<string|int, mixed>
$strict : bool = true
$additional_fields : array<string|int, mixed> = null
Tags
throws
Exception
Return values
array<string|int, mixed>

getVariableToFunctionMap()

public getVariableToFunctionMap([array<string|int, mixed> $data = null ]) : array<string|int, mixed>|bool
Parameters
$data : array<string|int, mixed> = null
Return values
array<string|int, mixed>|bool

handleSaveSQLReturning()

Used to handle any "RETURNING ..." clause on a SQL INSERT/UPDATE query.

public handleSaveSQLReturning( $rs) : bool
Parameters
$rs :
Return values
bool

hasDataChanged()

Determine if the record data has changed at all.

public hasDataChanged() : bool
Return values
bool

isActiveForAnyEmployee()

Check to see if this station is active for any employees, if not, we may as well mark it as disabled to speed up queries.

public isActiveForAnyEmployee() : bool
Return values
bool

isAllowed()

public isAllowed([string $user_id = null ][, string $current_station_id = null ][, string $id = null ][, bool $update_allowed_date = true ]) : bool
Parameters
$user_id : string = null

UUID

$current_station_id : string = null

UUID

$id : string = null

UUID

$update_allowed_date : bool = true
Return values
bool

isClientFriendly()

Check if the remote client is our main UI app controlled by us, vs. a user utilizing the API for example.

public isClientFriendly() : bool

This is mostly used to determine if we can return columns that are resource intensive to compute when obtaining a list. (ie: Users, Jobs)

Return values
bool

isDataDifferent()

Used to check the differences between a single key in the $old_data vs. $data arrays.

public isDataDifferent( $key,  $data_diff[, null $type_id = null ][, null $new_data = null ]) : bool

This is especially important to use when trying to see if a date or timestamp field in the DB has changed, as they need to be handled in special ways.

Parameters
$key :

string

$data_diff :

array

$type_id : null = null

string

$new_data : null = null

mixed

Return values
bool

isNew()

Determines if the data is new data, or updated data. Basically determines if a database INSERT or UPDATE SQL statement is generated.

public isNew([bool $force_lookup = false ][, string $id = null ]) : bool
Parameters
$force_lookup : bool = false
$id : string = null

UUID

Return values
bool

isSQLExceptionRetryable()

Determines if a SQL exception is one that can be retried or not.

public isSQLExceptionRetryable( $e) : bool
Parameters
$e :

Exception

Return values
bool

isUniqueStation()

public isUniqueStation( $station) : bool
Parameters
$station :
Return values
bool

isValid()

Call class specific validation function just before saving.

public isValid([bool $ignore_warning = true ]) : bool
Parameters
$ignore_warning : bool = true
Return values
bool

isWarning()

Call class specific validation function just before saving.

public isWarning() : bool
Return values
bool

modifyInsertQuery()

Modifies the automatically generated SQL INSERT query for adding things like " ON CONFLICT ..."

public modifyInsertQuery( $query) : mixed
Parameters
$query :
Return values
mixed

parseCustomFieldsFromArray()

public parseCustomFieldsFromArray( $data) : mixed
Parameters
$data :
Return values
mixed

parseWorkCode()

public parseWorkCode( $work_code) : array<string|int, mixed>
Parameters
$work_code :
Return values
array<string|int, mixed>

removeCache()

public removeCache([string $cache_id = null ][, string $group_id = null ]) : bool
Parameters
$cache_id : string = null
$group_id : string = null
Return values
bool

RetryTransaction()

Accepts a Closure and is retried at set intervals which should be in a transaction.

public RetryTransaction( $transaction_function[, int $retry_max_attempts = 4 ][, int $retry_sleep = 1 ]) : mixed
Parameters
$transaction_function :

Closure

$retry_max_attempts : int = 4
$retry_sleep : int = 1

in seconds

Tags
throws
DBError
Return values
mixed

rewind()

Rewinds record set iterator to begining. The same as ADODB's MoveFirst() function.

public final rewind() : bool
Return values
bool

RollbackSavePoint()

public RollbackSavePoint( $name) : bool
Parameters
$name :
Return values
bool

Save()

Determines to insert or update, and does it.

public Save([bool $reset_data = true ][, bool $force_lookup = false ]) : bool|int|string

Have this handle created, createdby, updated, updatedby.

Parameters
$reset_data : bool = true
$force_lookup : bool = false
Tags
throws
DBError
throws
GeneralError
Return values
bool|int|string

saveCache()

public saveCache(mixed $data, string $cache_id[, string $group_id = null ]) : bool
Parameters
$data : mixed
$cache_id : string
$group_id : string = null
Return values
bool

serializeRS()

Serialize ADODB recordset.

public serializeRS(object $rs) : string
Parameters
$rs : object
Tags
noinspection

PhpUndefinedConstantInspection

Return values
string

setAllowedDate()

public setAllowedDate([int $value = null ]) : bool
Parameters
$value : int = null

EPOCH

Return values
bool

setAPIMessageID()

public setAPIMessageID(string $id) : bool
Parameters
$id : string

UUID

Return values
bool

setBranch()

public setBranch(string $ids) : bool
Parameters
$ids : string

UUID

Return values
bool

setBranchSelectionType()

public setBranchSelectionType( $value) : bool
Parameters
$value :
Return values
bool

setCacheLifeTime()

public setCacheLifeTime(int $secs) : bool
Parameters
$secs : int
Return values
bool

setCompany()

public setCompany(string $value) : bool
Parameters
$value : string

UUID

Return values
bool

setCreatedAndUpdatedColumns()

public setCreatedAndUpdatedColumns(array<string|int, mixed> $data[, array<string|int, mixed> $variable_to_function_map = [] ]) : bool
Parameters
$data : array<string|int, mixed>
$variable_to_function_map : array<string|int, mixed> = []
Return values
bool

setCreatedBy()

public setCreatedBy([string $id = null ]) : bool
Parameters
$id : string = null

UUID

Return values
bool

setCreatedDate()

public setCreatedDate([int $epoch = null ]) : bool
Parameters
$epoch : int = null

EPOCH

Return values
bool

setCustomField()

Set a single custom field by ID.

public setCustomField(mixed $value, string $id) : void
Parameters
$value : mixed
$id : string

UUID

Return values
void

setCustomFields()

public setCustomFields( $data) : bool
Parameters
$data :
Return values
bool

setDefaultBranch()

public setDefaultBranch(string $value) : bool
Parameters
$value : string

UUID

Return values
bool

setDefaultDepartment()

public setDefaultDepartment(string $value) : bool
Parameters
$value : string

UUID

Return values
bool

setDefaultJob()

public setDefaultJob(string $value) : bool
Parameters
$value : string

UUID

Return values
bool

setDefaultJobItem()

public setDefaultJobItem(string $value) : bool
Parameters
$value : string

UUID

Return values
bool

setDefaultModeFlag()

public setDefaultModeFlag( $value) : bool
Parameters
$value :
Return values
bool

setDefaultPunchTag()

public setDefaultPunchTag(array<string|int, mixed>|string $value) : bool
Parameters
$value : array<string|int, mixed>|string

UUID

Return values
bool

setDeleted()

public setDeleted(bool $bool) : bool
Parameters
$bool : bool
Return values
bool

setDeletedBy()

public setDeletedBy([string $id = null ]) : bool|null
Parameters
$id : string = null

UUID

Return values
bool|null

setDeletedDate()

public setDeletedDate([int $epoch = null ]) : bool
Parameters
$epoch : int = null

EPOCH

Return values
bool

setDepartment()

public setDepartment(string $ids) : bool
Parameters
$ids : string

UUID

Return values
bool

setDepartmentSelectionType()

public setDepartmentSelectionType( $value) : bool
Parameters
$value :
Return values
bool

setDescription()

public setDescription( $value) : bool
Parameters
$value :
Return values
bool

setEnableAutoPunchStatus()

public setEnableAutoPunchStatus( $value) : bool
Parameters
$value :
Return values
bool

setEnableSystemLogDetail()

public setEnableSystemLogDetail( $bool) : bool
Parameters
$bool :
Return values
bool

setExcludeUser()

public setExcludeUser(string $ids) : bool
Parameters
$ids : string

UUID

Return values
bool

setGenericDataValue()

public setGenericDataValue(string $name, mixed $data[, null $cast = null ]) : bool
Parameters
$name : string
$data : mixed
$cast : null = null
Return values
bool

setGenericJSONDataValue()

Generic getter/setter functions for handling generic JSON data in 'other_json' SQL column.

public setGenericJSONDataValue(string $name, mixed $data[, null $cast = null ]) : bool
Parameters
$name : string
$data : mixed
$cast : null = null
Return values
bool

setGenericObject()

Allow method to pre-populate/overwrite the cache if needed.

public setGenericObject(object $obj, string $variable) : bool
Parameters
$obj : object
$variable : string
Return values
bool

setGenericTempDataValue()

public setGenericTempDataValue(string $name, mixed $data) : bool
Parameters
$name : string
$data : mixed
Return values
bool

setGroup()

public setGroup(string $ids) : bool
Parameters
$ids : string

UUID

Return values
bool

setGroupSelectionType()

public setGroupSelectionType( $value) : bool
Parameters
$value :
Return values
bool

setId()

public setId(string $id) : bool
Parameters
$id : string

UUID

Return values
bool

setIncludeUser()

public setIncludeUser(string $ids) : bool
Parameters
$ids : string

UUID

Return values
bool

setIsValid()

Sets the is_valid flag, mostly used to set it to FALSE to force a full re-validation.

public setIsValid([bool $is_valid = false ]) : bool

Required because $this->is_valid is a private variable and should stay that way.

Parameters
$is_valid : bool = false
Return values
bool

setLastPartialPushDate()

public setLastPartialPushDate([int $value = null ]) : bool
Parameters
$value : int = null

EPOCH

Return values
bool

setLastPartialPushStatusMessage()

public setLastPartialPushStatusMessage( $value) : bool
Parameters
$value :
Return values
bool

setLastPollDate()

public setLastPollDate([int $value = null ]) : bool
Parameters
$value : int = null

EPOCH

Return values
bool

setLastPollStatusMessage()

public setLastPollStatusMessage( $value) : bool
Parameters
$value :
Return values
bool

setLastPunchTimeStamp()

public setLastPunchTimeStamp([int $value = null ]) : bool
Parameters
$value : int = null

EPOCH

Return values
bool

setLastPushDate()

public setLastPushDate([int $value = null ]) : bool
Parameters
$value : int = null

EPOCH

Return values
bool

setLastPushStatusMessage()

public setLastPushStatusMessage( $value) : bool
Parameters
$value :
Return values
bool

setModeFlag()

public setModeFlag( $arr) : bool
Parameters
$arr :
Return values
bool

setObjectFromArray()

public setObjectFromArray( $data) : bool
Parameters
$data :
Return values
bool

setPartialPushFrequency()

public setPartialPushFrequency( $value) : bool
Parameters
$value :
Return values
bool

setPassword()

public setPassword( $value) : bool
Parameters
$value :
Return values
bool

setPollFrequency()

public setPollFrequency( $value) : bool
Parameters
$value :
Return values
bool

setProgressBarObject()

public setProgressBarObject(object $obj) : bool
Parameters
$obj : object
Return values
bool

setPushFrequency()

public setPushFrequency( $value) : bool
Parameters
$value :
Return values
bool

setQueryStatementTimeout()

public setQueryStatementTimeout([null $milliseconds = null ]) : bool
Parameters
$milliseconds : null = null
Return values
bool

setSource()

public setSource( $value) : bool
Parameters
$value :
Return values
bool

setStation()

public setStation([string $value = null ]) : bool
Parameters
$value : string = null

UUID

Return values
bool

setStatus()

public setStatus( $value) : bool
Parameters
$value :
Return values
bool

setTimeZone()

public setTimeZone( $value) : bool
Parameters
$value :
Return values
bool

setTransactionMode()

public setTransactionMode([string $mode = '' ]) : mixed
Parameters
$mode : string = ''
Return values
mixed

setUpdatedBy()

public setUpdatedBy([string $id = null ]) : bool|null
Parameters
$id : string = null

UUID

Return values
bool|null

setUpdatedDate()

public setUpdatedDate([int $epoch = null ]) : bool|int|null|string
Parameters
$epoch : int = null

EPOCH

Return values
bool|int|null|string

setUserName()

public setUserName( $value) : bool
Parameters
$value :
Return values
bool

setUserValue1()

public setUserValue1( $value) : bool
Parameters
$value :
Return values
bool

setUserValue2()

public setUserValue2( $value) : bool
Parameters
$value :
Return values
bool

setUserValue3()

public setUserValue3( $value) : bool
Parameters
$value :
Return values
bool

setUserValue4()

public setUserValue4( $value) : bool
Parameters
$value :
Return values
bool

setUserValue5()

public setUserValue5( $value) : bool
Parameters
$value :
Return values
bool

StartSavePoint()

public StartSavePoint( $name) : bool
Parameters
$name :
Return values
bool

StartTransaction()

public StartTransaction() : mixed
Return values
mixed

toBool()

public toBool(string|int|bool $value) : int
Parameters
$value : string|int|bool
Return values
int

toJSONBool()

public toJSONBool(string|int|bool $value) : string
Parameters
$value : string|int|bool
Return values
string

updateAllowedDate()

Update JUST station allowed_date without affecting updated_date, and without creating an EDIT entry in the system_log.

public updateAllowedDate(string $id, string $user_id) : bool
Parameters
$id : string

UUID

$user_id : string

UUID

Return values
bool

updateLastPartialPushDate()

Update JUST station last_partial_push_date without affecting updated_date, and without creating an EDIT entry in the system_log.

public updateLastPartialPushDate(string $id, int $last_partial_push_date) : bool
Parameters
$id : string

UUID

$last_partial_push_date : int
Return values
bool

updateLastPollDate()

Update JUST station last_poll_date without affecting updated_date, and without creating an EDIT entry in the system_log.

public updateLastPollDate(string $id, int $last_poll_date) : bool
Parameters
$id : string

UUID

$last_poll_date : int
Return values
bool

updateLastPollDateAndLastPunchTimeStamp()

Update JUST station last_poll_date AND last_punch_time_stamp without affecting updated_date, and without creating an EDIT entry in the system_log.

public updateLastPollDateAndLastPunchTimeStamp(string $id, int $last_poll_date, int $last_punch_date) : bool
Parameters
$id : string

UUID

$last_poll_date : int
$last_punch_date : int
Return values
bool

updateLastPushDate()

Update JUST station last_push_date without affecting updated_date, and without creating an EDIT entry in the system_log.

public updateLastPushDate(string $id, int $last_push_date) : bool
Parameters
$id : string

UUID

$last_push_date : int
Return values
bool

Validate()

public Validate([bool $ignore_warning = true ]) : bool
Parameters
$ignore_warning : bool = true
Return values
bool

validateCustomFields()

public validateCustomFields(mixed $company_id[, mixed $enable_required_field_check = true ]) : mixed
Parameters
$company_id : mixed
$enable_required_field_check : mixed = true
Return values
mixed

_getFactoryOptions()

protected _getFactoryOptions(string $name[, string|int $parent = null ]) : bool
Parameters
$name : string
$parent : string|int = null
Return values
bool

_getVariableToFunctionMap()

protected _getVariableToFunctionMap(array<string|int, mixed> $data) : bool
Parameters
$data : array<string|int, mixed>
Return values
bool

castInteger()

protected castInteger(int|string $int[, string $type = 'int' ]) : bool|int|string
Parameters
$int : int|string
$type : string = 'int'
Return values
bool|int|string

getColumnsFromAliases()

protected getColumnsFromAliases(array<string|int, mixed> $columns, array<string|int, mixed> $aliases) : array<string|int, mixed>
Parameters
$columns : array<string|int, mixed>
$aliases : array<string|int, mixed>
Return values
array<string|int, mixed>

getCustomFieldWhereSQL()

protected getCustomFieldWhereSQL(mixed $company_id, mixed $column, array<string|int, mixed> $filter_data, array<string|int, mixed> &$ph) : string
Parameters
$company_id : mixed
$column : mixed
$filter_data : array<string|int, mixed>
$ph : array<string|int, mixed>
Return values
string

getDatabaseType()

protected getDatabaseType() : string
Return values
string

getListSQL()

protected getListSQL(array<string|int, mixed>|string|int $array[, array<string|int, mixed> &$ph = null ][, string|bool $cast = false ]) : bool|int|string|array<string|int, mixed>
Parameters
$array : array<string|int, mixed>|string|int
$ph : array<string|int, mixed> = null
$cast : string|bool = false
Return values
bool|int|string|array<string|int, mixed>

getSortSQL()

protected getSortSQL(array<string|int, mixed> $array[, bool $strict = true ][, array<string|int, mixed> $additional_fields = null ]) : bool|string
Parameters
$array : array<string|int, mixed>
$strict : bool = true
$additional_fields : array<string|int, mixed> = null
Return values
bool|string

getSQLStringAggregate()

protected getSQLStringAggregate(string $sql, string $glue) : string
Parameters
$sql : string
$glue : string
Return values
string

getSQLToEpochFunction()

protected getSQLToEpochFunction(string $sql) : string
Parameters
$sql : string
Return values
string

getSQLToTimeFunction()

protected getSQLToTimeFunction(string $sql) : string
Parameters
$sql : string
Return values
string

getSQLToTimeStampFunction()

protected getSQLToTimeStampFunction() : string
Return values
string

getWhereClauseSQL()

protected getWhereClauseSQL(array<string|int, mixed>|string $columns, array<string|int, mixed>|string $args, string $type, array<string|int, mixed> &$ph[, string $query_stub = null ][, bool $and = true ]) : null|string
Parameters
$columns : array<string|int, mixed>|string
$args : array<string|int, mixed>|string
$type : string
$ph : array<string|int, mixed>
$query_stub : string = null
$and : bool = true
Tags
noinspection

PhpParamsInspection

Return values
null|string

getWhereSQL()

protected getWhereSQL(array<string|int, mixed> $array[, bool $append_where = false ]) : bool|string
Parameters
$array : array<string|int, mixed>
$append_where : bool = false
Return values
bool|string

handleSQLSyntax()

SQL where clause Syntax: or % as wildcard.

protected handleSQLSyntax(string $arg) : string

"" as exact match, no default wildcard and no metaphone

Handles '*' and '%' as wildcards, defaults to wildcard on the end always. If no wildcard is to be added, the last character should be |

Parameters
$arg : string
Return values
string

stripSQLSyntax()

protected stripSQLSyntax(string $arg) : mixed
Parameters
$arg : string
Return values
mixed

getInsertQuery()

private getInsertQuery() : mixed
Return values
mixed

getRecordSetColumnList()

private getRecordSetColumnList(object $rs) : array<string|int, mixed>|bool
Parameters
$rs : object
Return values
array<string|int, mixed>|bool

parseColumnName()

Parses out the exact column name, without any aliases, or = signs in it.

private parseColumnName(string $column) : bool|string
Parameters
$column : string
Return values
bool|string

Search results