PayPeriodListFactory
extends PayPeriodFactory
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
- $pay_period_schedule_obj : mixed
- $rs : mixed
- $tmp_data : mixed
- $validate_only : mixed
- $Validator : mixed
- $api_message_id : mixed
- $enable_system_log_detail : mixed
- $old_status_id : mixed
- $pk_sequence_name : mixed
- $progress_bar_obj : mixed
- $table : mixed
- $ignore_column_list : bool
- $import_data : mixed
- $import_orphaned_data : mixed
- $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.
- 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.
- deleteData() : bool
- Delete all data assigned to this pay period.
- 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
- findPayPeriod() : bool
- fromBool() : bool
- fromJSONBool() : bool
- getAffectedRows() : int|bool
- getAll() : $this
- getAPIMessageID() : bool|null
- Used for updating progress bar for API calls.
- getAPISearchByCompanyIdAndArrayCriteria() : bool|PayPeriodListFactory
- getArrayByListFactory() : array<string|int, mixed>|bool
- getByCompanyId() : bool|PayPeriodListFactory
- getByCompanyIdAndEndDate() : bool|PayPeriodListFactory
- getByCompanyIdAndOverlapStartDateAndEndDate() : bool|PayPeriodListFactory
- Gets all pay periods that start or end between the two dates. Ideal for finding all pay periods that affect a given week.
- getByCompanyIDAndPayPeriodScheduleIdAndAnyDate() : bool|PayPeriodListFactory
- getByCompanyIDAndPayPeriodScheduleIdAndStartTransactionDateAndEndTransactionDate() : bool|PayPeriodListFactory
- getByCompanyIDAndPayPeriodScheduleIdAndStatusAndStartTransactionDateAndEndTransactionDate() : bool|PayPeriodListFactory
- getByCompanyIdAndRemittanceAgencyIdAndTransactionDateAndPayPeriodSchedule() : $this|bool
- getByCompanyIdAndStatus() : bool|PayPeriodListFactory
- getByCompanyIdAndStatusAndTransactionDate() : bool|PayPeriodListFactory
- getByCompanyIdAndTransactionDate() : bool|PayPeriodListFactory
- getByCompanyIdAndTransactionStartDateAndTransactionEndDate() : bool|PayPeriodListFactory
- getById() : bool|PayPeriodListFactory
- getByIdAndCompanyId() : bool|PayPeriodListFactory
- getByIdList() : bool|PayPeriodListFactory
- getByIdListArray() : array<string|int, mixed>|bool
- getByPayPeriodScheduleId() : bool|PayPeriodListFactory
- getByPayPeriodScheduleIdAndEndDateBefore() : bool|PayPeriodListFactory
- getByPayPeriodScheduleIdAndStartTransactionDateAndEndTransactionDate() : bool|PayPeriodListFactory
- getByPayPeriodScheduleIdAndTransactionDate() : bool|PayPeriodListFactory
- getByStatus() : bool|PayPeriodListFactory
- getByUserId() : bool|PayPeriodListFactory
- getByUserIdAndEndDate() : bool|PayPeriodListFactory
- getByUserIdAndOverlapStartDateAndEndDate() : bool|PayPeriodListFactory
- Gets all pay periods that start or end between the two dates. Ideal for finding all pay periods that affect a given week.
- getByUserIdAndStartDateAndEndDate() : bool|PayPeriodListFactory
- getByUserIdAndTransactionDate() : bool|PayPeriodListFactory
- getByUserIdListAndNotStatus() : bool|PayPeriodListFactory
- getByUserIdListAndNotStatusAndStartDateAndEndDate() : bool|PayPeriodListFactory
- 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.
- getConflictingByPayPeriodScheduleIdAndStartDateAndEndDate() : bool|PayPeriodListFactory
- 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
- getEnableImportData() : bool
- getEnableImportOrphanedData() : bool
- getEnableSystemLogDetail() : bool
- getEndDate() : bool|int
- getExceptions() : array<string|int, mixed>
- getFirstStartDateAndLastEndDateByPayPeriodScheduleId() : 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.
- getId() : bool|mixed
- getIDSByListFactory() : array<string|int, mixed>|bool
- getIsLocked() : bool
- getIterator() : FactoryListIterator
- getJSCalendarPayPeriodArray() : bool|mixed
- Get last 6mths worth of pay periods and prepare a JS array so they can be highlighted in the calendar.
- getLabelId() : bool|mixed|string
- getLastPayPeriodByCompanyIdAndPayPeriodScheduleIdAndDate() : bool|PayPeriodListFactory
- getName() : string
- getNextInsertId() : bool|string
- getObjectAsArray() : array<string|int, mixed>
- getOptions() : array<string|int, mixed>|bool
- getPayPeriodDates() : array<string|int, mixed>|bool
- getPayPeriodSchedule() : bool|mixed
- getPayPeriodScheduleObject() : bool|null
- getPayPeriodsWithPayStubsByCompanyId() : bool|PayPeriodListFactory
- getPayStubAmendments() : int
- getPayStubs() : mixed
- getPayStubsOpen() : mixed
- getPendingRequests() : bool|int
- getPermissionColumns() : bool
- getPreviousPayPeriodById() : bool|PayPeriodListFactory
- getPrimary() : bool
- getProgressBarObject() : null|ProgressBar
- getRecordCount() : int|bool
- getSequenceName() : bool
- getStartAndEndDateRangeFromCompanyIdAndPayPeriodId() : array<string|int, mixed>|bool
- Gets the maximum date range to cover the start/end date of the specified pay period IDs.
- getStartDate() : bool|int
- getStatus() : bool|int
- getTable() : bool|string
- getTainted() : bool
- getTaintedBy() : bool|mixed
- getTaintedDate() : bool|mixed
- getThisPayPeriodByCompanyIdAndPayPeriodScheduleIdAndDate() : bool|PayPeriodListFactory
- getTimeSheets() : array<string|int, mixed>
- getTimeSheetVerifyType() : bool
- getTimeSheetVerifyWindowEndDate() : bool|int
- getTimeSheetVerifyWindowStartDate() : bool|int
- getTotalAbsences() : mixed
- getTotalManualTimeSheets() : mixed
- getTotalPunches() : mixed
- getTransactionDate() : bool|int
- getTransactionMode() : string
- getUpdatedBy() : bool|mixed
- getUpdatedDate() : int
- getValidSQLColumns() : array<string|int, mixed>
- getVariableToFunctionMap() : array<string|int, mixed>|bool
- getYearsArrayByCompanyId() : 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.
- importData() : bool
- Imports all data from other pay periods into this one.
- importOrphanedData() : bool
- Imports only data not assigned to other pay periods
- isClientFriendly() : bool
- Check if the remote client is our main UI app controlled by us, vs. a user utilizing the API for example.
- isConflicting() : bool
- isDataDifferent() : bool
- Used to check the differences between a single key in the $old_data vs. $data arrays.
- isFirstPayPeriodInYear() : bool
- isNew() : bool
- Determines if the data is new data, or updated data. Basically determines if a database INSERT or UPDATE SQL statement is generated.
- isPreviousPayPeriodClosed() : bool
- Check to make sure previous pay period is closed.
- 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.
- isValidStartDate() : bool
- 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
- postSave() : bool
- preSave() : bool
- purgePayStubAmendments() : 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.
- setAPIMessageID() : bool
- setCacheLifeTime() : bool
- setCompany() : bool
- setCreatedAndUpdatedColumns() : bool
- setCreatedBy() : bool
- setCreatedDate() : bool
- setCustomField() : void
- Set a single custom field by ID.
- setCustomFields() : bool
- setDeleted() : bool
- setDeletedBy() : bool|null
- setDeletedDate() : bool
- setEnableImportData() : bool
- setEnableImportOrphanedData() : bool
- setEnableSystemLogDetail() : bool
- setEndDate() : 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.
- setObjectFromArray() : bool
- setPayPeriodSchedule() : bool
- setPayStubStatus() : bool
- setPrimary() : bool
- setProgressBarObject() : bool
- setQueryStatementTimeout() : bool
- setStartDate() : bool
- setStatus() : bool
- setTainted() : bool
- setTaintedBy() : bool
- setTaintedDate() : bool
- setTransactionDate() : bool
- setTransactionMode() : mixed
- setUpdatedBy() : bool|null
- setUpdatedDate() : bool|int|null|string
- StartSavePoint() : bool
- StartTransaction() : mixed
- toBool() : int
- toJSONBool() : string
- 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
- 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
$data
public
mixed
$data
= []
$db
public
mixed
$db
= \null
$is_new
public
mixed
$is_new
= \null
$old_data
public
mixed
$old_data
= []
$pay_period_schedule_obj
public
mixed
$pay_period_schedule_obj
= \null
$rs
public
mixed
$rs
= \null
$tmp_data
public
mixed
$tmp_data
= []
$validate_only
public
mixed
$validate_only
= \false
$Validator
public
mixed
$Validator
= \null
$api_message_id
protected
mixed
$api_message_id
= \null
$enable_system_log_detail
protected
mixed
$enable_system_log_detail
= \true
$old_status_id
protected
mixed
$old_status_id
= \null
$pk_sequence_name
protected
mixed
$pk_sequence_name
= 'pay_period_id_seq'
$progress_bar_obj
protected
mixed
$progress_bar_obj
= \null
$table
protected
mixed
$table
= 'pay_period'
$ignore_column_list
private
bool
$ignore_column_list
$import_data
private
mixed
$import_data
$import_orphaned_data
private
mixed
$import_orphaned_data
$is_valid
private
mixed
$is_valid
= \false
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
Return values
bool —bulkDelete()
public
bulkDelete(string|array<string|int, mixed> $ids) : bool
Parameters
- $ids : string|array<string|int, mixed>
-
UUID
Tags
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
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
Return values
bool —CommitTransaction()
public
CommitTransaction([bool $unnest_transactions = false ]) : mixed
Parameters
- $unnest_transactions : bool = false
Tags
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
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
Return values
bool —deleteData()
Delete all data assigned to this pay period.
public
deleteData() : bool
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
Return values
bool —FailTransaction()
public
FailTransaction() : mixed
Return values
mixed —findPayPeriod()
public
static findPayPeriod(string $user_id, int $date_stamp) : bool
Parameters
- $user_id : string
-
UUID
- $date_stamp : int
-
EPOCH
Return values
bool —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|PayPeriodListFactory
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|PayPeriodListFactory —getArrayByListFactory()
public
getArrayByListFactory( $lf[, bool $include_blank = true ][, bool $sort_prefix = false ]) : array<string|int, mixed>|bool
Parameters
Return values
array<string|int, mixed>|bool —getByCompanyId()
public
getByCompanyId(string $id[, int $limit = null ][, int $page = null ][, array<string|int, mixed> $where = null ][, array<string|int, mixed> $order = null ]) : bool|PayPeriodListFactory
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|PayPeriodListFactory —getByCompanyIdAndEndDate()
public
getByCompanyIdAndEndDate(string $company_id, int $end_date[, mixed $limit = null ][, mixed $page = null ][, array<string|int, mixed> $where = null ][, array<string|int, mixed> $order = null ]) : bool|PayPeriodListFactory
Parameters
- $company_id : string
-
UUID
- $end_date : int
-
EPOCH
- $limit : mixed = null
- $page : mixed = null
- $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|PayPeriodListFactory —getByCompanyIdAndOverlapStartDateAndEndDate()
Gets all pay periods that start or end between the two dates. Ideal for finding all pay periods that affect a given week.
public
getByCompanyIdAndOverlapStartDateAndEndDate(string $company_id, int $start_date, int $end_date[, array<string|int, mixed> $where = null ][, array<string|int, mixed> $order = null ]) : bool|PayPeriodListFactory
Parameters
- $company_id : string
-
UUID
- $start_date : int
-
EPOCH
- $end_date : int
-
EPOCH
- $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|PayPeriodListFactory —getByCompanyIDAndPayPeriodScheduleIdAndAnyDate()
public
getByCompanyIDAndPayPeriodScheduleIdAndAnyDate(string $company_id, string $id, int $date[, int $limit = null ][, int $page = null ][, array<string|int, mixed> $where = null ][, array<string|int, mixed> $order = null ]) : bool|PayPeriodListFactory
Parameters
- $company_id : string
-
UUID
- $id : string
-
UUID
- $date : int
-
EPOCH
- $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|PayPeriodListFactory —getByCompanyIDAndPayPeriodScheduleIdAndStartTransactionDateAndEndTransactionDate()
public
getByCompanyIDAndPayPeriodScheduleIdAndStartTransactionDateAndEndTransactionDate(string $company_id, string $id, int $start_transaction_date, int $end_transaction_date[, int $limit = null ][, int $page = null ][, array<string|int, mixed> $where = null ][, array<string|int, mixed> $order = null ]) : bool|PayPeriodListFactory
Parameters
- $company_id : string
-
UUID
- $id : string
-
UUID
- $start_transaction_date : int
-
EPOCH
- $end_transaction_date : int
-
EPOCH
- $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|PayPeriodListFactory —getByCompanyIDAndPayPeriodScheduleIdAndStatusAndStartTransactionDateAndEndTransactionDate()
public
getByCompanyIDAndPayPeriodScheduleIdAndStatusAndStartTransactionDateAndEndTransactionDate(string $company_id, string|array<string|int, string> $id, int|array<string|int, int> $status_id, int $start_transaction_date, int $end_transaction_date[, int $limit = null ][, int $page = null ][, array<string|int, mixed> $where = null ][, array<string|int, mixed> $order = null ]) : bool|PayPeriodListFactory
Parameters
- $company_id : string
-
UUID
- $id : string|array<string|int, string>
-
UUID
- $status_id : int|array<string|int, int>
- $start_transaction_date : int
-
EPOCH
- $end_transaction_date : int
-
EPOCH
- $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|PayPeriodListFactory —getByCompanyIdAndRemittanceAgencyIdAndTransactionDateAndPayPeriodSchedule()
public
getByCompanyIdAndRemittanceAgencyIdAndTransactionDateAndPayPeriodSchedule( $company_id, $id[, null $transaction_date = null ][, null $pay_period_schedule = null ][, null $limit = null ][, null $page = null ][, null $where = null ][, null $order = null ]) : $this|bool
Parameters
- $company_id :
- $id :
- $transaction_date : null = null
- $pay_period_schedule : null = null
- $limit : null = null
- $page : null = null
- $where : null = null
- $order : null = null
Tags
Return values
$this|bool —getByCompanyIdAndStatus()
public
getByCompanyIdAndStatus(string $company_id, int|array<string|int, int> $status_ids[, array<string|int, mixed> $where = null ][, array<string|int, mixed> $order = null ]) : bool|PayPeriodListFactory
Parameters
- $company_id : string
-
UUID
- $status_ids : int|array<string|int, int>
- $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|PayPeriodListFactory —getByCompanyIdAndStatusAndTransactionDate()
public
getByCompanyIdAndStatusAndTransactionDate(string $company_id, array<string|int, int> $status_ids, int $transaction_date[, array<string|int, mixed> $where = null ][, array<string|int, mixed> $order = null ]) : bool|PayPeriodListFactory
Parameters
- $company_id : string
-
UUID
- $status_ids : array<string|int, int>
- $transaction_date : int
-
EPOCH
- $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|PayPeriodListFactory —getByCompanyIdAndTransactionDate()
public
getByCompanyIdAndTransactionDate(string $company_id, int $transaction_date[, array<string|int, mixed> $where = null ][, array<string|int, mixed> $order = null ]) : bool|PayPeriodListFactory
Parameters
- $company_id : string
-
UUID
- $transaction_date : int
-
EPOCH
- $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|PayPeriodListFactory —getByCompanyIdAndTransactionStartDateAndTransactionEndDate()
public
getByCompanyIdAndTransactionStartDateAndTransactionEndDate(string $company_id, int $start_date, int $end_date[, array<string|int, mixed> $where = null ][, array<string|int, mixed> $order = null ]) : bool|PayPeriodListFactory
Parameters
- $company_id : string
-
UUID
- $start_date : int
-
EPOCH
- $end_date : int
-
EPOCH
- $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|PayPeriodListFactory —getById()
public
getById(string $id[, array<string|int, mixed> $where = null ][, array<string|int, mixed> $order = null ]) : bool|PayPeriodListFactory
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|PayPeriodListFactory —getByIdAndCompanyId()
public
getByIdAndCompanyId(string|array<string|int, string> $id, string $company_id[, array<string|int, mixed> $where = null ][, array<string|int, mixed> $order = null ]) : bool|PayPeriodListFactory
Parameters
- $id : string|array<string|int, string>
-
UUID
- $company_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|PayPeriodListFactory —getByIdList()
public
getByIdList(array<string|int, string> $ids[, array<string|int, mixed> $where = null ][, array<string|int, mixed> $order = null ]) : bool|PayPeriodListFactory
Parameters
- $ids : array<string|int, 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|PayPeriodListFactory —getByIdListArray()
public
getByIdListArray(string|array<string|int, string> $ids[, array<string|int, mixed> $where = null ][, array<string|int, mixed> $order = null ][, bool $enable_names = true ]) : array<string|int, mixed>|bool
Parameters
- $ids : string|array<string|int, 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', ... )
- $enable_names : bool = true
Return values
array<string|int, mixed>|bool —getByPayPeriodScheduleId()
public
getByPayPeriodScheduleId(string $id[, int $limit = null ][, int $page = null ][, array<string|int, mixed> $where = null ][, array<string|int, mixed> $order = null ]) : bool|PayPeriodListFactory
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|PayPeriodListFactory —getByPayPeriodScheduleIdAndEndDateBefore()
public
getByPayPeriodScheduleIdAndEndDateBefore(string $id, $end_date[, null $limit = null ][, null $page = null ][, array<string|int, mixed> $where = null ][, array<string|int, mixed> $order = null ]) : bool|PayPeriodListFactory
Parameters
- $id : string
-
UUID
- $end_date :
- $limit : null = null
- $page : null = null
- $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', ... )
Tags
Return values
bool|PayPeriodListFactory —getByPayPeriodScheduleIdAndStartTransactionDateAndEndTransactionDate()
public
getByPayPeriodScheduleIdAndStartTransactionDateAndEndTransactionDate(string $id, int $start_transaction_date, int $end_transaction_date[, array<string|int, mixed> $where = null ][, array<string|int, mixed> $order = null ]) : bool|PayPeriodListFactory
Parameters
- $id : string
-
UUID
- $start_transaction_date : int
-
EPOCH
- $end_transaction_date : int
-
EPOCH
- $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|PayPeriodListFactory —getByPayPeriodScheduleIdAndTransactionDate()
public
getByPayPeriodScheduleIdAndTransactionDate(string $id, int $transaction_date[, array<string|int, mixed> $where = null ][, array<string|int, mixed> $order = null ]) : bool|PayPeriodListFactory
Parameters
- $id : string
-
UUID
- $transaction_date : int
-
EPOCH
- $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|PayPeriodListFactory —getByStatus()
public
getByStatus( $status[, array<string|int, mixed> $where = null ][, array<string|int, mixed> $order = null ]) : bool|PayPeriodListFactory
Parameters
- $status :
- $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|PayPeriodListFactory —getByUserId()
public
getByUserId(string $user_id[, int $limit = null ][, int $page = null ][, array<string|int, mixed> $where = null ][, array<string|int, mixed> $order = null ]) : bool|PayPeriodListFactory
Parameters
- $user_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|PayPeriodListFactory —getByUserIdAndEndDate()
public
getByUserIdAndEndDate(string $user_id, int $end_date[, array<string|int, mixed> $where = null ][, array<string|int, mixed> $order = null ]) : bool|PayPeriodListFactory
Parameters
- $user_id : string
-
UUID
- $end_date : int
-
EPOCH
- $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|PayPeriodListFactory —getByUserIdAndOverlapStartDateAndEndDate()
Gets all pay periods that start or end between the two dates. Ideal for finding all pay periods that affect a given week.
public
getByUserIdAndOverlapStartDateAndEndDate(string $user_id, int $start_date, int $end_date[, array<string|int, mixed> $where = null ][, array<string|int, mixed> $order = null ]) : bool|PayPeriodListFactory
Parameters
- $user_id : string
-
UUID
- $start_date : int
-
EPOCH
- $end_date : int
-
EPOCH
- $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|PayPeriodListFactory —getByUserIdAndStartDateAndEndDate()
public
getByUserIdAndStartDateAndEndDate(string $user_id, int $start_date, int $end_date[, array<string|int, mixed> $where = null ][, array<string|int, mixed> $order = null ]) : bool|PayPeriodListFactory
Parameters
- $user_id : string
-
UUID
- $start_date : int
-
EPOCH
- $end_date : int
-
EPOCH
- $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|PayPeriodListFactory —getByUserIdAndTransactionDate()
public
getByUserIdAndTransactionDate(string $user_id, int $transaction_date[, array<string|int, mixed> $where = null ][, array<string|int, mixed> $order = null ]) : bool|PayPeriodListFactory
Parameters
- $user_id : string
-
UUID
- $transaction_date : int
-
EPOCH
- $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|PayPeriodListFactory —getByUserIdListAndNotStatus()
public
getByUserIdListAndNotStatus(string $user_ids, int $status_ids[, array<string|int, mixed> $where = null ][, array<string|int, mixed> $order = null ]) : bool|PayPeriodListFactory
Parameters
- $user_ids : string
-
UUID
- $status_ids : int
- $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|PayPeriodListFactory —getByUserIdListAndNotStatusAndStartDateAndEndDate()
public
getByUserIdListAndNotStatusAndStartDateAndEndDate(string $user_ids, int $status_ids, int $start_date, int $end_date[, array<string|int, mixed> $where = null ][, array<string|int, mixed> $order = null ]) : bool|PayPeriodListFactory
Parameters
- $user_ids : string
-
UUID
- $status_ids : int
- $start_date : int
-
EPOCH
- $end_date : int
-
EPOCH
- $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|PayPeriodListFactory —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 —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 —getConflictingByPayPeriodScheduleIdAndStartDateAndEndDate()
public
getConflictingByPayPeriodScheduleIdAndStartDateAndEndDate(string $pay_period_schedule_id, int $start_date, int $end_date[, string $id = null ][, array<string|int, mixed> $where = null ][, array<string|int, mixed> $order = null ]) : bool|PayPeriodListFactory
Parameters
- $pay_period_schedule_id : string
-
UUID
- $start_date : int
-
EPOCH
- $end_date : int
-
EPOCH
- $id : string = null
-
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|PayPeriodListFactory —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
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
Tags
Return values
array<string|int, mixed> —getCustomFieldsDefaultData()
public
getCustomFieldsDefaultData( $company_id, $data[, bool $get_all_fields = false ]) : mixed
Parameters
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
Tags
Return values
mixed —getEnableImportData()
public
getEnableImportData() : bool
Return values
bool —getEnableImportOrphanedData()
public
getEnableImportOrphanedData() : bool
Return values
bool —getEnableSystemLogDetail()
public
getEnableSystemLogDetail() : bool
Return values
bool —getEndDate()
public
getEndDate([bool $raw = false ]) : bool|int
Parameters
- $raw : bool = false
Return values
bool|int —getExceptions()
public
getExceptions() : array<string|int, mixed>
Return values
array<string|int, mixed> —getFirstStartDateAndLastEndDateByPayPeriodScheduleId()
public
getFirstStartDateAndLastEndDateByPayPeriodScheduleId(string $id[, array<string|int, mixed> $where = null ][, array<string|int, mixed> $order = null ]) : bool
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 —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 —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 —getIsLocked()
public
getIsLocked() : bool
Return values
bool —getIterator()
public
final getIterator() : FactoryListIterator
Return values
FactoryListIterator —getJSCalendarPayPeriodArray()
Get last 6mths worth of pay periods and prepare a JS array so they can be highlighted in the calendar.
public
getJSCalendarPayPeriodArray([bool $include_all_pay_period_schedules = false ]) : bool|mixed
Parameters
- $include_all_pay_period_schedules : bool = false
Return values
bool|mixed —getLabelId()
public
getLabelId() : bool|mixed|string
Return values
bool|mixed|string —getLastPayPeriodByCompanyIdAndPayPeriodScheduleIdAndDate()
public
getLastPayPeriodByCompanyIdAndPayPeriodScheduleIdAndDate(string $company_id, string $id, int $date[, array<string|int, mixed> $where = null ][, array<string|int, mixed> $order = null ]) : bool|PayPeriodListFactory
Parameters
- $company_id : string
-
UUID
- $id : string
-
UUID
- $date : int
-
EPOCH
- $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|PayPeriodListFactory —getName()
public
getName([bool $include_schedule_name = false ][, mixed $include_transaction_date = false ]) : string
Parameters
- $include_schedule_name : bool = false
- $include_transaction_date : mixed = false
Return values
string —getNextInsertId()
public
getNextInsertId() : bool|string
Return values
bool|string —getObjectAsArray()
public
getObjectAsArray([null $include_columns = null ]) : array<string|int, mixed>
Parameters
- $include_columns : null = null
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 —getPayPeriodDates()
public
getPayPeriodDates([int $filter_start_date = null ][, int $filter_end_date = null ][, bool $include_pay_period_id = false ]) : array<string|int, mixed>|bool
Parameters
- $filter_start_date : int = null
-
EPOCH
- $filter_end_date : int = null
-
EPOCH
- $include_pay_period_id : bool = false
Return values
array<string|int, mixed>|bool —getPayPeriodSchedule()
public
getPayPeriodSchedule() : bool|mixed
Return values
bool|mixed —getPayPeriodScheduleObject()
public
getPayPeriodScheduleObject() : bool|null
Return values
bool|null —getPayPeriodsWithPayStubsByCompanyId()
public
getPayPeriodsWithPayStubsByCompanyId(string $id[, int $limit = null ][, int $page = null ][, array<string|int, mixed> $where = null ][, array<string|int, mixed> $order = null ]) : bool|PayPeriodListFactory
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|PayPeriodListFactory —getPayStubAmendments()
public
getPayStubAmendments() : int
Return values
int —getPayStubs()
public
getPayStubs() : mixed
Return values
mixed —getPayStubsOpen()
public
getPayStubsOpen() : mixed
Return values
mixed —getPendingRequests()
public
getPendingRequests() : bool|int
Return values
bool|int —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 —getPreviousPayPeriodById()
public
getPreviousPayPeriodById(string $id) : bool|PayPeriodListFactory
Parameters
- $id : string
-
UUID
Return values
bool|PayPeriodListFactory —getPrimary()
public
getPrimary() : bool
Return values
bool —getProgressBarObject()
public
getProgressBarObject() : null|ProgressBar
Return values
null|ProgressBar —getRecordCount()
public
getRecordCount() : int|bool
Return values
int|bool —getSequenceName()
public
getSequenceName() : bool
Return values
bool —getStartAndEndDateRangeFromCompanyIdAndPayPeriodId()
Gets the maximum date range to cover the start/end date of the specified pay period IDs.
public
getStartAndEndDateRangeFromCompanyIdAndPayPeriodId(string $company_id, string $pay_period_id) : array<string|int, mixed>|bool
Parameters
- $company_id : string
-
UUID
- $pay_period_id : string
-
UUID
Return values
array<string|int, mixed>|bool —getStartDate()
public
getStartDate([bool $raw = false ]) : bool|int
Parameters
- $raw : bool = false
Return values
bool|int —getStatus()
public
getStatus() : bool|int
Return values
bool|int —getTable()
public
getTable([bool $strip_quotes = false ]) : bool|string
Parameters
- $strip_quotes : bool = false
Return values
bool|string —getTainted()
public
getTainted() : bool
Return values
bool —getTaintedBy()
public
getTaintedBy() : bool|mixed
Return values
bool|mixed —getTaintedDate()
public
getTaintedDate() : bool|mixed
Return values
bool|mixed —getThisPayPeriodByCompanyIdAndPayPeriodScheduleIdAndDate()
public
getThisPayPeriodByCompanyIdAndPayPeriodScheduleIdAndDate(string $company_id, array<string|int, string> $id, int $date[, array<string|int, mixed> $where = null ][, array<string|int, mixed> $order = null ]) : bool|PayPeriodListFactory
Parameters
- $company_id : string
-
UUID
- $id : array<string|int, string>
-
UUID
- $date : int
-
EPOCH
- $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|PayPeriodListFactory —getTimeSheets()
public
getTimeSheets() : array<string|int, mixed>
Return values
array<string|int, mixed> —getTimeSheetVerifyType()
public
getTimeSheetVerifyType() : bool
Return values
bool —getTimeSheetVerifyWindowEndDate()
public
getTimeSheetVerifyWindowEndDate() : bool|int
Return values
bool|int —getTimeSheetVerifyWindowStartDate()
public
getTimeSheetVerifyWindowStartDate() : bool|int
Return values
bool|int —getTotalAbsences()
public
getTotalAbsences() : mixed
Return values
mixed —getTotalManualTimeSheets()
public
getTotalManualTimeSheets() : mixed
Return values
mixed —getTotalPunches()
public
getTotalPunches() : mixed
Return values
mixed —getTransactionDate()
public
getTransactionDate([bool $raw = false ]) : bool|int
Parameters
- $raw : bool = false
Return values
bool|int —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
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 —getYearsArrayByCompanyId()
public
getYearsArrayByCompanyId(string $company_id) : array<string|int, mixed>|bool
Parameters
- $company_id : string
-
UUID
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
Return values
bool —hasDataChanged()
Determine if the record data has changed at all.
public
hasDataChanged() : bool
Return values
bool —importData()
Imports all data from other pay periods into this one.
public
importData([bool $user_ids = false ][, bool $pay_period_id = false ]) : bool
Parameters
- $user_ids : bool = false
- $pay_period_id : bool = false
Return values
bool —importOrphanedData()
Imports only data not assigned to other pay periods
public
importOrphanedData() : bool
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 —isConflicting()
public
isConflicting() : bool
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
Return values
bool —isFirstPayPeriodInYear()
public
isFirstPayPeriodInYear() : bool
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 —isPreviousPayPeriodClosed()
Check to make sure previous pay period is closed.
public
isPreviousPayPeriodClosed() : bool
Return values
bool —isSQLExceptionRetryable()
Determines if a SQL exception is one that can be retried or not.
public
isSQLExceptionRetryable( $e) : bool
Parameters
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 —isValidStartDate()
public
isValidStartDate(int $epoch) : bool
Parameters
- $epoch : int
-
EPOCH
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
Return values
mixed —parseCustomFieldsFromArray()
public
parseCustomFieldsFromArray( $data) : mixed
Parameters
Return values
mixed —postSave()
public
postSave() : bool
Return values
bool —preSave()
public
preSave() : bool
Return values
bool —purgePayStubAmendments()
public
purgePayStubAmendments() : bool
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
Tags
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
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
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
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 $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
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 —setEnableImportData()
public
setEnableImportData( $bool) : bool
Parameters
Return values
bool —setEnableImportOrphanedData()
public
setEnableImportOrphanedData( $bool) : bool
Parameters
Return values
bool —setEnableSystemLogDetail()
public
setEnableSystemLogDetail( $bool) : bool
Parameters
Return values
bool —setEndDate()
public
setEndDate(int $value) : bool
Parameters
- $value : int
-
EPOCH
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 —setObjectFromArray()
public
setObjectFromArray( $data) : bool
Parameters
Return values
bool —setPayPeriodSchedule()
public
setPayPeriodSchedule(string $value) : bool
Parameters
- $value : string
-
UUID
Return values
bool —setPayStubStatus()
public
setPayStubStatus( $status[, bool $dry_run = false ]) : bool
Parameters
Tags
Return values
bool —setPrimary()
public
setPrimary( $value) : bool
Parameters
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 —setStartDate()
public
setStartDate(int $value) : bool
Parameters
- $value : int
-
EPOCH
Return values
bool —setStatus()
public
setStatus( $value) : bool
Parameters
Return values
bool —setTainted()
public
setTainted( $value) : bool
Parameters
Return values
bool —setTaintedBy()
public
setTaintedBy([string $value = null ]) : bool
Parameters
- $value : string = null
-
UUID
Return values
bool —setTaintedDate()
public
setTaintedDate([int $value = null ]) : bool
Parameters
- $value : int = null
-
EPOCH
Return values
bool —setTransactionDate()
public
setTransactionDate(int $value) : bool
Parameters
- $value : int
-
EPOCH
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 —StartSavePoint()
public
StartSavePoint( $name) : bool
Parameters
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 —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
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
"
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
Tags
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