TimeTrex API Manual

SetupPresets extends Factory
in package

Modules

Users

$cache : Cache_Lite_Function|Cache_Lite_Output
$data : mixed
$db : mixed
$is_new : mixed
$old_data : mixed
$rs : mixed
$tmp_data : mixed
$validate_only : mixed
$Validator : mixed
$already_processed : mixed
$api_message_id : mixed
$company_obj : mixed
$enable_system_log_detail : mixed
$progress_bar_obj : mixed
$user_obj : mixed
$ignore_column_list : bool
$is_valid : mixed
__construct() : mixed: Factory constructor.
__toString() : bool|string: Print primary columns from object.
AbsencePolicy() : bool
AccrualPolicy() : bool
BreakPolicy() : bool
bulkDelete() : bool
castGenericDataValue() : mixed: Generic casting function that all set/get*() functions should pass through.
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
CompanyDeductions() : bool
ContributingPayCodePolicy() : bool
ContributingShiftPolicy() : bool
convertFlexArray() : array<string|int, mixed>
createAbsencePolicy() : bool
createAccrualPolicy() : bool
createAccrualPolicyAccount() : bool
createAccrualPolicyMilestone() : bool
createBreakPolicy() : bool
createCompanyDeduction() : bool
createContributingPayCodePolicy() : bool
createContributingShiftPolicy() : bool
createExceptionPolicy() : bool
createHolidayPolicy() : bool
createKPI() : bool
createKPIGroup() : bool
createMealPolicy() : bool
createOverTimePolicy() : bool
createPayCode() : bool
createPayFormulaPolicy() : bool
createPayrollRemittanceAgency() : bool
createPayrollRemittanceAgencyEvent() : bool
createPayStubAccount() : bool
createPolicyGroup() : bool
createPresets() : bool
createRecurringHoliday() : bool
createRegularTimePolicy() : bool
createRemittanceAgencyEvents() : bool
createSchedulePolicy() : bool
createUserDefault() : bool
createUserReportData() : bool: NOTE: This was originally duplicated in Report class. If you change it here, check to see if changes are needed there too.
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.
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.
ExceptionPolicy() : bool
ExecuteSQL() : bool: Execute SQL queries and handle paging properly for select statements.
FailTransaction() : mixed
fromBool() : bool
fromJSONBool() : bool
getAbsencePolicyByCompanyIDAndName() : array<string|int, mixed>|bool
getAccrualPolicyAccountByCompanyIDAndName() : bool
getAccrualPolicyByCompanyIDAndName() : bool
getAffectedRows() : int|bool
getAPIMessageID() : bool|null: Used for updating progress bar for API calls.
getBreakPolicyByCompanyIDAndName() : bool
getCache() : bool|mixed
getColumn() : bool|mixed: Generic function get any data from the data array.
getColumnList() : array<string|int, mixed>|bool
getCompany() : mixed
getCompanyDeductionByLegalEntityIDAndFuzzyName() : bool
getCompanyGenericMapData() : mixed: Generic function to return and cache CompanyGenericMap data, this greatly improves performance of CalculatePolicy when many policies exist.
getCompanyObject() : bool
getContributingPayCodePolicyByCompanyIDAndName() : array<string|int, mixed>|bool
getContributingShiftPolicyByCompanyIDAndName() : array<string|int, mixed>|bool
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.
getDeleted() : bool
getDeletedBy() : bool|mixed
getDeletedDate() : bool|mixed
getEmptyRecordSet() : mixed
getEnableSystemLogDetail() : bool
getExceptionPolicyByCompanyIDAndName() : 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.
getHolidayPolicyByCompanyIDAndName() : bool
getId() : bool|mixed
getIDSByListFactory() : array<string|int, mixed>|bool
getIterator() : FactoryListIterator
getLabelId() : bool|mixed|string
getLegalEntityObject() : bool
getMealPolicyByCompanyIDAndName() : bool
getNextInsertId() : bool|string
getOptions() : array<string|int, mixed>|bool
getOverTimePolicyByCompanyIDAndName() : array<string|int, mixed>|bool
getPayCodeByCompanyIDAndName() : array<string|int, mixed>|bool
getPayFormulaPolicyByCompanyIDAndName() : bool
getPayrollRemittanceAgencyByLegalEntityAndAgencyID() : bool
getPayStubEntryAccountByCompanyIDAndType() : bool
getPayStubEntryAccountByCompanyIDAndTypeAndFuzzyName() : bool
getPermissionColumns() : bool
getProgressBarObject() : null|ProgressBar
getRecordCount() : int|bool
getRecurringHolidayByCompanyIDAndName() : array<string|int, mixed>|bool
getRecurringHolidayByCompanyIDAndNameAndPrefix() : array<string|int, mixed>|bool
getRegularTimePolicyByCompanyIDAndName() : array<string|int, mixed>|bool
getSequenceName() : bool
getTable() : bool|string
getTransactionMode() : string
getUpdatedBy() : bool|mixed
getUpdatedDate() : int
getUser() : bool
getUserObject() : bool
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.
HolidayPolicy() : 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.
isValid() : bool: Call class specific validation function just before saving.
isWarning() : bool: Call class specific validation function just before saving.
KPI() : mixed
MealPolicy() : bool
modifyInsertQuery() : mixed: Modifies the automatically generated SQL INSERT query for adding things like " ON CONFLICT ..."
OverTimePolicy() : bool
parseCustomFieldsFromArray() : mixed
PayCode() : bool
PayFormulaPolicy() : bool
PayFormulaPolicyAdvanced() : bool: This has to be called after Pay Codes and Contributing Shifts are created, as those are required for advanced pay formulas.
PayrollRemittanceAgencys() : bool
PayStubAccounts() : bool: Need to be able to add just global accounts, or country specific accounts, or just province specific accounts, So this function should be called with once with no arguments, once for the country, and once for each province.
Permissions() : bool
PolicyGroup() : bool
RecurringHolidays() : bool
RecurringHolidaysByRegion() : array<string|int, mixed>
RegularTimePolicy() : 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
SchedulePolicy() : bool
serializeRS() : string: Serialize ADODB recordset.
setAPIMessageID() : bool
setCacheLifeTime() : bool
setCompany() : mixed
setCreatedAndUpdatedColumns() : bool
setCreatedBy() : bool
setCreatedDate() : bool
setCustomField() : void: Set a single custom field by ID.
setCustomFields() : bool
setDeleted() : bool
setDeletedBy() : bool|null
setDeletedDate() : bool
setEnableSystemLogDetail() : 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
setId() : bool
setIsValid() : bool: Sets the is_valid flag, mostly used to set it to FALSE to force a full re-validation.
setProgressBarObject() : bool
setQueryStatementTimeout() : bool
setTimeZone() : bool
setTransactionMode() : mixed
setUpdatedBy() : bool|null
setUpdatedDate() : bool|int|null|string
setUser() : mixed
StartSavePoint() : bool
StartTransaction() : mixed
TaxForms() : bool
toBool() : int
toJSONBool() : string
UserDefaults() : 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
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.

$cache


    public
        Cache_Lite_Function|Cache_Lite_Output
    $cache
     = \null

$data


    public
        mixed
    $data
     = \null

$db


    public
        mixed
    $db
     = \null

$is_new


    public
        mixed
    $is_new
     = \null

$old_data


    public
        mixed
    $old_data
     = []

$rs


    public
        mixed
    $rs
     = \null

$tmp_data


    public
        mixed
    $tmp_data
     = []

$validate_only


    public
        mixed
    $validate_only
     = \false

$Validator


    public
        mixed
    $Validator
     = \null

$already_processed


    protected
        mixed
    $already_processed
     = \null

$api_message_id


    protected
        mixed
    $api_message_id
     = \null

$company_obj


    protected
        mixed
    $company_obj
     = \null

$enable_system_log_detail


    protected
        mixed
    $enable_system_log_detail
     = \true

$progress_bar_obj


    protected
        mixed
    $progress_bar_obj
     = \null

$user_obj


    protected
        mixed
    $user_obj
     = \null

$ignore_column_list


    private
        bool
    $ignore_column_list

$is_valid


    private
        mixed
    $is_valid
     = \false

__construct()

Factory constructor.


    public
                    __construct() : mixed

Return values

mixed —

__toString()

Print primary columns from object.


    public
                    __toString() : bool|string

Return values

bool|string —

AbsencePolicy()


    public
                    AbsencePolicy([null $country = null ][, null $province = null ][, null $district = null ][, null $industry = null ]) : bool

Parameters

$country : null = null
$province : null = null
$district : null = null
$industry : null = null

Return values

bool —

AccrualPolicy()


    public
                    AccrualPolicy([null $country = null ][, null $province = null ][, null $district = null ][, null $industry = null ]) : bool

Parameters

$country : null = null
$province : null = null
$district : null = null
$industry : null = null

Return values

bool —

BreakPolicy()


    public
                    BreakPolicy([null $country = null ][, null $province = null ][, null $district = null ][, null $industry = null ]) : bool

Parameters

$country : null = null
$province : null = null
$district : null = null
$industry : null = null

Return values

bool —

bulkDelete()


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

Parameters

$ids : string|array<string|int, mixed>: UUID

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 —

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

Return values

mixed —

CompanyDeductions()


    public
                    CompanyDeductions([null $country = null ][, null $province = null ][, null $district = null ][, null $industry = null ][, string $legal_entity_id = null ]) : bool

Parameters

$country : null = null
$province : null = null
$district : null = null
$industry : null = null
$legal_entity_id : string = null: UUID

Return values

bool —

ContributingPayCodePolicy()


    public
                    ContributingPayCodePolicy([null $country = null ][, null $province = null ][, null $district = null ][, null $industry = null ]) : bool

Parameters

$country : null = null
$province : null = null
$district : null = null
$industry : null = null

Return values

bool —

ContributingShiftPolicy()


    public
                    ContributingShiftPolicy([null $country = null ][, null $province = null ][, null $district = null ][, null $industry = null ]) : bool

Parameters

$country : null = null
$province : null = null
$district : null = null
$industry : null = null

Return values

bool —

convertFlexArray()


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

Parameters

$array : array<string|int, mixed>

Return values

array<string|int, mixed> —

createAbsencePolicy()


    public
                    createAbsencePolicy( $data) : bool

Parameters

$data :

Return values

bool —

createAccrualPolicy()


    public
                    createAccrualPolicy( $data) : bool

Parameters

$data :

Return values

bool —

createAccrualPolicyAccount()


    public
                    createAccrualPolicyAccount( $data) : bool

Parameters

$data :

Return values

bool —

createAccrualPolicyMilestone()


    public
                    createAccrualPolicyMilestone( $data) : bool

Parameters

$data :

Return values

bool —

createBreakPolicy()


    public
                    createBreakPolicy( $data) : bool

Parameters

$data :

Return values

bool —

createCompanyDeduction()


    public
                    createCompanyDeduction( $data) : bool

Parameters

$data :

Return values

bool —

createContributingPayCodePolicy()


    public
                    createContributingPayCodePolicy( $data) : bool

Parameters

$data :

Return values

bool —

createContributingShiftPolicy()


    public
                    createContributingShiftPolicy( $data) : bool

Parameters

$data :

Return values

bool —

createExceptionPolicy()


    public
                    createExceptionPolicy( $data) : bool

Parameters

$data :

Return values

bool —

createHolidayPolicy()


    public
                    createHolidayPolicy( $data) : bool

Parameters

$data :

Return values

bool —

createKPI()


    public
                    createKPI( $data) : bool

Parameters

$data :

Return values

bool —

createKPIGroup()


    public
                    createKPIGroup( $data) : bool

Parameters

$data :

Return values

bool —

createMealPolicy()


    public
                    createMealPolicy( $data) : bool

Parameters

$data :

Return values

bool —

createOverTimePolicy()


    public
                    createOverTimePolicy( $data) : bool

Parameters

$data :

Return values

bool —

createPayCode()


    public
                    createPayCode( $data) : bool

Parameters

$data :

Return values

bool —

createPayFormulaPolicy()


    public
                    createPayFormulaPolicy( $data) : bool

Parameters

$data :

Return values

bool —

createPayrollRemittanceAgency()


    public
                    createPayrollRemittanceAgency( $data) : bool

Parameters

$data :

Return values

bool —

createPayrollRemittanceAgencyEvent()


    public
                    createPayrollRemittanceAgencyEvent( $data) : bool

Parameters

$data :

Return values

bool —

createPayStubAccount()


    public
                    createPayStubAccount( $data) : bool

Parameters

$data :

Return values

bool —

createPolicyGroup()


    public
                    createPolicyGroup( $data) : bool

Parameters

$data :

Return values

bool —

createPresets()


    public
                    createPresets([null $country = null ][, null $province = null ][, null $district = null ][, null $industry = null ][, null $flags = null ][, null $legal_entity_id = null ]) : bool

Parameters

$country : null = null
$province : null = null
$district : null = null
$industry : null = null
$flags : null = null
$legal_entity_id : null = null

Return values

bool —

createRecurringHoliday()


    public
                    createRecurringHoliday( $data) : bool

Parameters

$data :

Return values

bool —

createRegularTimePolicy()


    public
                    createRegularTimePolicy( $data) : bool

Parameters

$data :

Return values

bool —

createRemittanceAgencyEvents()


    public
                    createRemittanceAgencyEvents(string $id) : bool

Parameters

$id : string: UUID

Return values

bool —

createSchedulePolicy()


    public
                    createSchedulePolicy( $data) : bool

Parameters

$data :

Return values

bool —

createUserDefault()


    public
                    createUserDefault( $data) : bool

Parameters

$data :

Return values

bool —

createUserReportData()

NOTE: This was originally duplicated in Report class. If you change it here, check to see if changes are needed there too.


    public
                    createUserReportData(string $company_id, object $report_obj,  $data) : bool

Parameters

$company_id : string: UUID
$report_obj : object
$data :

Return values

bool —

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

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 —

ExceptionPolicy()


    public
                    ExceptionPolicy([null $country = null ][, null $province = null ][, null $district = null ][, null $industry = null ]) : bool

Parameters

$country : null = null
$province : null = null
$district : null = null
$industry : null = null

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

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 —

getAbsencePolicyByCompanyIDAndName()


    public
                    getAbsencePolicyByCompanyIDAndName( $name) : array<string|int, mixed>|bool

Parameters

$name :

Return values

array<string|int, mixed>|bool —

getAccrualPolicyAccountByCompanyIDAndName()


    public
                    getAccrualPolicyAccountByCompanyIDAndName( $name) : bool

Parameters

$name :

Return values

bool —

getAccrualPolicyByCompanyIDAndName()


    public
                    getAccrualPolicyByCompanyIDAndName( $name) : bool

Parameters

$name :

Return values

bool —

getAffectedRows()


    public
                    getAffectedRows() : int|bool

Return values

int|bool —

getAPIMessageID()

Used for updating progress bar for API calls.


    public
                    getAPIMessageID() : bool|null

Return values

bool|null —

getBreakPolicyByCompanyIDAndName()


    public
                    getBreakPolicyByCompanyIDAndName( $name) : bool

Parameters

$name :

Return values

bool —

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 —

getCompany()


    public
                    getCompany() : mixed

Return values

mixed —

getCompanyDeductionByLegalEntityIDAndFuzzyName()


    public
                    getCompanyDeductionByLegalEntityIDAndFuzzyName(string $legal_entity_id,  $name) : bool

Parameters

$legal_entity_id : string: UUID
$name :

Return values

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 —

getCompanyObject()


    public
                    getCompanyObject() : bool

Return values

bool —

getContributingPayCodePolicyByCompanyIDAndName()


    public
                    getContributingPayCodePolicyByCompanyIDAndName( $name) : array<string|int, mixed>|bool

Parameters

$name :

Return values

array<string|int, mixed>|bool —

getContributingShiftPolicyByCompanyIDAndName()


    public
                    getContributingShiftPolicyByCompanyIDAndName( $name) : array<string|int, mixed>|bool

Parameters

$name :

Return values

array<string|int, mixed>|bool —

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

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 —

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 —

getEmptyRecordSet()


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

Parameters

$id : string = null: UUID

Return values

mixed —

getEnableSystemLogDetail()


    public
                    getEnableSystemLogDetail() : bool

Return values

bool —

getExceptionPolicyByCompanyIDAndName()


    public
                    getExceptionPolicyByCompanyIDAndName( $name) : bool

Parameters

$name :

Return values

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 —

getHolidayPolicyByCompanyIDAndName()


    public
                    getHolidayPolicyByCompanyIDAndName( $name) : bool

Parameters

$name :

Return values

bool —

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 —

getIterator()


    public
        final            getIterator() : FactoryListIterator

Return values

FactoryListIterator —

getLabelId()


    public
                    getLabelId() : bool|mixed|string

Return values

bool|mixed|string —

getLegalEntityObject()


    public
                    getLegalEntityObject( $legal_entity_id) : bool

Parameters

$legal_entity_id :

Return values

bool —

getMealPolicyByCompanyIDAndName()


    public
                    getMealPolicyByCompanyIDAndName( $name) : bool

Parameters

$name :

Return values

bool —

getNextInsertId()


    public
                    getNextInsertId() : bool|string

Return values

bool|string —

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 —

getOverTimePolicyByCompanyIDAndName()


    public
                    getOverTimePolicyByCompanyIDAndName( $name) : array<string|int, mixed>|bool

Parameters

$name :

Return values

array<string|int, mixed>|bool —

getPayCodeByCompanyIDAndName()


    public
                    getPayCodeByCompanyIDAndName( $name) : array<string|int, mixed>|bool

Parameters

$name :

Return values

array<string|int, mixed>|bool —

getPayFormulaPolicyByCompanyIDAndName()


    public
                    getPayFormulaPolicyByCompanyIDAndName( $name) : bool

Parameters

$name :

Return values

bool —

getPayrollRemittanceAgencyByLegalEntityAndAgencyID()


    public
                    getPayrollRemittanceAgencyByLegalEntityAndAgencyID(string $legal_entity_id, string $agency_id) : bool

Parameters

$legal_entity_id : string: UUID
$agency_id : string: UUID

Return values

bool —

getPayStubEntryAccountByCompanyIDAndType()


    public
                    getPayStubEntryAccountByCompanyIDAndType(int $type_id) : bool

Parameters

$type_id : int

Return values

bool —

getPayStubEntryAccountByCompanyIDAndTypeAndFuzzyName()


    public
                    getPayStubEntryAccountByCompanyIDAndTypeAndFuzzyName(int $type_id,  $name) : bool

Parameters

$type_id : int
$name :

Return values

bool —

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 —

getProgressBarObject()


    public
                    getProgressBarObject() : null|ProgressBar

Return values

null|ProgressBar —

getRecordCount()


    public
                    getRecordCount() : int|bool

Return values

int|bool —

getRecurringHolidayByCompanyIDAndName()


    public
                    getRecurringHolidayByCompanyIDAndName( $name) : array<string|int, mixed>|bool

Parameters

$name :

Return values

array<string|int, mixed>|bool —

getRecurringHolidayByCompanyIDAndNameAndPrefix()


    public
                    getRecurringHolidayByCompanyIDAndNameAndPrefix( $name[, null $prefix = null ]) : array<string|int, mixed>|bool

Parameters

$name :
$prefix : null = null

Return values

array<string|int, mixed>|bool —

getRegularTimePolicyByCompanyIDAndName()


    public
                    getRegularTimePolicyByCompanyIDAndName( $name) : array<string|int, mixed>|bool

Parameters

$name :

Return values

array<string|int, mixed>|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 —

getUser()


    public
                    getUser() : bool

Return values

bool —

getUserObject()


    public
                    getUserObject() : bool

Return values

bool —

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

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 —

HolidayPolicy()


    public
                    HolidayPolicy([null $country = null ][, null $province = null ][, null $district = null ][, null $industry = null ]) : bool

Parameters

$country : null = null
$province : null = null
$district : null = null
$industry : null = null

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 —

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 —

KPI()


    public
                    KPI([mixed $country = null ][, mixed $province = null ][, mixed $district = null ][, mixed $industry = null ]) : mixed

Parameters

$country : mixed = null
$province : mixed = null
$district : mixed = null
$industry : mixed = null

Return values

mixed —

MealPolicy()


    public
                    MealPolicy([null $country = null ][, null $province = null ][, null $district = null ][, null $industry = null ]) : bool

Parameters

$country : null = null
$province : null = null
$district : null = null
$industry : null = null

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 —

OverTimePolicy()


    public
                    OverTimePolicy([null $country = null ][, null $province = null ][, null $district = null ][, null $industry = null ]) : bool

Parameters

$country : null = null
$province : null = null
$district : null = null
$industry : null = null

Return values

bool —

parseCustomFieldsFromArray()


    public
                    parseCustomFieldsFromArray( $data) : mixed

Parameters

$data :

Return values

mixed —

PayCode()


    public
                    PayCode([null $country = null ][, null $province = null ][, null $district = null ][, null $industry = null ]) : bool

Parameters

$country : null = null
$province : null = null
$district : null = null
$industry : null = null

Return values

bool —

PayFormulaPolicy()


    public
                    PayFormulaPolicy([null $country = null ][, null $province = null ][, null $district = null ][, null $industry = null ]) : bool

Parameters

$country : null = null
$province : null = null
$district : null = null
$industry : null = null

Return values

bool —

PayFormulaPolicyAdvanced()

This has to be called after Pay Codes and Contributing Shifts are created, as those are required for advanced pay formulas.


    public
                    PayFormulaPolicyAdvanced([null $country = null ][, null $province = null ][, null $district = null ][, null $industry = null ]) : bool

Parameters

$country : null = null
$province : null = null
$district : null = null
$industry : null = null

Return values

bool —

PayrollRemittanceAgencys()


    public
                    PayrollRemittanceAgencys([null $country = null ][, null $province = null ][, null $district = null ][, null $industry = null ][, string $legal_entity_id = null ]) : bool

Parameters

$country : null = null
$province : null = null
$district : null = null
$industry : null = null
$legal_entity_id : string = null: UUID

Return values

bool —

PayStubAccounts()

Need to be able to add just global accounts, or country specific accounts, or just province specific accounts, So this function should be called with once with no arguments, once for the country, and once for each province.


    public
                    PayStubAccounts([null $country = null ][, null $province = null ][, null $district = null ][, null $industry = null ]) : bool

ie: PayStubAccounts(), PayStubAccounts( 'ca' ), PayStubAccounts( 'ca', 'bc' )

Parameters

$country : null = null
$province : null = null
$district : null = null
$industry : null = null

Return values

bool —

Permissions()


    public
                    Permissions() : bool

Return values

bool —

PolicyGroup()


    public
                    PolicyGroup([null $country = null ][, null $province = null ][, null $district = null ][, null $industry = null ]) : bool

Parameters

$country : null = null
$province : null = null
$district : null = null
$industry : null = null

Return values

bool —

RecurringHolidays()


    public
                    RecurringHolidays([null $country = null ][, null $province = null ][, null $district = null ][, null $industry = null ]) : bool

Parameters

$country : null = null
$province : null = null
$district : null = null
$industry : null = null

Return values

bool —

RecurringHolidaysByRegion()


    public
                    RecurringHolidaysByRegion([null $country = null ][, null $province = null ][, null $type_id = null ]) : array<string|int, mixed>

Parameters

$country : null = null
$province : null = null
$type_id : null = null: 10=Province/State recognized Government only Holidays, 100=Federally recognized only holidays.

Return values

array<string|int, mixed> —

RegularTimePolicy()


    public
                    RegularTimePolicy([null $country = null ][, null $province = null ][, null $district = null ][, null $industry = null ]) : bool

Parameters

$country : null = null
$province : null = null
$district : null = null
$industry : null = null

Return values

bool —

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

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

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 —

SchedulePolicy()


    public
                    SchedulePolicy([null $country = null ][, null $province = null ][, null $district = null ][, null $industry = null ]) : bool

Parameters

$country : null = null
$province : null = null
$district : null = null
$industry : null = null

Return values

bool —

serializeRS()

Serialize ADODB recordset.


    public
                    serializeRS(object $rs) : string

Parameters

$rs : object

Return values

string —

setAPIMessageID()


    public
                    setAPIMessageID(string $id) : bool

Parameters

$id : string: UUID

Return values

bool —

setCacheLifeTime()


    public
                    setCacheLifeTime(int $secs) : bool

Parameters

$secs : int

Return values

bool —

setCompany()


    public
                    setCompany(string $id) : mixed

Parameters

$id : string: UUID

Return values

mixed —

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 —

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 —

setEnableSystemLogDetail()


    public
                    setEnableSystemLogDetail( $bool) : bool

Parameters

$bool :

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 —

setId()


    public
                    setId(string $id) : bool

Parameters

$id : 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 —

setProgressBarObject()


    public
                    setProgressBarObject(object $obj) : bool

Parameters

$obj : object

Return values

bool —

setQueryStatementTimeout()


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

Parameters

$milliseconds : null = null

Return values

bool —

setTimeZone()


    public
                    setTimeZone() : bool

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 —

setUser()


    public
                    setUser(string $id) : mixed

Parameters

$id : string: UUID

Return values

mixed —

StartSavePoint()


    public
                    StartSavePoint( $name) : bool

Parameters

$name :

Return values

bool —

StartTransaction()


    public
                    StartTransaction() : mixed

Return values

mixed —

TaxForms()


    public
                    TaxForms([null $country = null ][, null $province = null ][, null $district = null ][, null $industry = null ]) : bool

Parameters

$country : null = null
$province : null = null
$district : null = null
$industry : null = null

Return values

bool —

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 —

UserDefaults()


    public
                    UserDefaults([mixed $country = null ][, mixed $province = null ][, mixed $district = null ][, mixed $industry = null ][, string $legal_entity_id = null ]) : bool

Parameters

$country : mixed = null
$province : mixed = null
$district : mixed = null
$industry : mixed = null
$legal_entity_id : string = null: UUID

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

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 —

getUpdateQuery()


    private
                    getUpdateQuery() : bool

Return values

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 —

SetupPresets extends Factory in package Modules Users

Table of Contents

Properties

$cache

$data

$db

$is_new

$old_data

$rs

$tmp_data

$validate_only

$Validator

$already_processed

$api_message_id

$company_obj

$enable_system_log_detail

$progress_bar_obj

$user_obj

$ignore_column_list

$is_valid

Methods

__construct()

Return values

__toString()

Return values

AbsencePolicy()

Parameters

Return values

AccrualPolicy()

Parameters

Return values

BreakPolicy()

Parameters

Return values

bulkDelete()

Parameters

Tags

Return values

castGenericDataValue()

Parameters

Return values

clearCacheSavedInTransaction()

Return values

clearData()

Return values

clearGeoCode()

Parameters

Return values

clearNonMappedData()

Parameters

Return values

clearOldData()

Return values

CommitSavePoint()

Parameters

Return values

CommitTransaction()

Parameters

Tags

Return values

CompanyDeductions()

Parameters

Return values

ContributingPayCodePolicy()

Parameters

Return values

ContributingShiftPolicy()

Parameters

Return values

convertFlexArray()

Parameters

Return values

createAbsencePolicy()

Parameters

Return values

createAccrualPolicy()

Parameters

Return values

createAccrualPolicyAccount()

Parameters

SetupPresets extends Factory
in package

Modules

Users