• Class name: PayStubFactory
• Namespace:
• Parent class: Factory

protected mixed $table = 'pay_stub'

• Visibility: protected

protected mixed $pk_sequence_name = 'pay_stub_id_seq'

• Visibility: protected

public mixed $tmp_data = array()

• Visibility: public

protected mixed $is_unique_pay_stub = NULL

• Visibility: protected

protected mixed $is_unique_pay_stub_type = NULL

• Visibility: protected

protected mixed $pay_period_obj = NULL

• Visibility: protected

protected mixed $currency_obj = NULL

• Visibility: protected

protected mixed $user_obj = NULL

• Visibility: protected

protected mixed $pay_stub_entry_account_link_obj = NULL

• Visibility: protected

protected mixed $pay_stub_entry_accounts_obj = NULL

• Visibility: protected

protected mixed $old_currency_id = NULL

• Visibility: protected

public mixed $validate_only = FALSE

• Visibility: public

public mixed $data = array()

• Visibility: public

public mixed $old_data = array()

• Visibility: public

protected mixed $enable_system_log_detail = TRUE

• Visibility: protected

protected mixed $progress_bar_obj = NULL

• Visibility: protected

protected mixed $AMF_message_id = NULL

• Visibility: protected

public mixed $Validator = NULL

• Visibility: public

private mixed $is_valid = FALSE

• Visibility: private

boolean Factory::_getFactoryOptions(string $name, string|integer $parent)

• Visibility: protected
• This method is defined by Factory

• $name string
• $parent string|integer

boolean Factory::_getVariableToFunctionMap(array $data)

• Visibility: protected
• This method is defined by Factory

• $data array

boolean PayStubFactory::getPayPeriodObject()

• Visibility: public

boolean PayStubFactory::getCurrencyObject()

• Visibility: public

boolean PayStubFactory::getUserObject()

• Visibility: public

boolean|mixed PayStubFactory::getUser()

• Visibility: public

boolean PayStubFactory::setUser(string $value)

• Visibility: public

• $value string - UUID

boolean|mixed PayStubFactory::getDisplayID()

• Visibility: public

boolean|mixed PayStubFactory::getPayPeriod()

• Visibility: public

boolean PayStubFactory::setPayPeriod(string $value)

• Visibility: public

• $value string - UUID

integer PayStubFactory::getRun()

• Visibility: public

boolean PayStubFactory::setRun(string $value)

• Visibility: public

• $value string - UUID

boolean|mixed PayStubFactory::getCurrency()

• Visibility: public

boolean PayStubFactory::setCurrency(string $value)

• Visibility: public

• $value string - UUID

boolean|mixed PayStubFactory::getCurrencyRate()

• Visibility: public

boolean PayStubFactory::setCurrencyRate($value)

• Visibility: public

• $value mixed

boolean PayStubFactory::isValidStartDate(integer $epoch)

• Visibility: public

• $epoch integer - EPOCH

boolean|integer PayStubFactory::getStartDate(boolean $raw)

• Visibility: public

• $raw boolean

boolean PayStubFactory::setStartDate(integer $value)

• Visibility: public

• $value integer - EPOCH

boolean PayStubFactory::isValidEndDate(integer $epoch)

• Visibility: public

• $epoch integer - EPOCH

boolean|integer PayStubFactory::getEndDate(boolean $raw)

• Visibility: public

• $raw boolean

boolean PayStubFactory::setEndDate(integer $value)

• Visibility: public

• $value integer - EPOCH

boolean PayStubFactory::isValidTransactionDate(integer $epoch)

• Visibility: public

• $epoch integer - EPOCH

boolean|integer PayStubFactory::getTransactionDate(boolean $raw)

• Visibility: public

• $raw boolean

boolean PayStubFactory::setTransactionDate(integer $value)

• Visibility: public

• $value integer - EPOCH

boolean|integer PayStubFactory::getStatus()

• Visibility: public

boolean PayStubFactory::setStatus($value)

• Visibility: public

• $value mixed

boolean|mixed PayStubFactory::getStatusDate()

• Visibility: public

boolean PayStubFactory::setStatusDate(integer $value)

• Visibility: public

• $value integer - EPOCH

boolean|mixed PayStubFactory::getStatusBy()

• Visibility: public

boolean PayStubFactory::setStatusBy(string $value)

• Visibility: public

• $value string - UUID

boolean|integer PayStubFactory::getType()

• Visibility: public

boolean PayStubFactory::setType($value)

• Visibility: public

• $value mixed

boolean PayStubFactory::getTainted()

• Visibility: public

boolean PayStubFactory::setTainted($value)

• Visibility: public

• $value mixed

boolean PayStubFactory::getTemp()

• Visibility: public

boolean PayStubFactory::setTemp($value)

• Visibility: public

• $value mixed

boolean|null PayStubFactory::isUniquePayStub()

• Visibility: public

boolean|null PayStubFactory::isUniquePayStubType()

• Visibility: public

boolean PayStubFactory::setDefaultDates()

• Visibility: public

boolean PayStubFactory::getEnableProcessEntries()

• Visibility: public

boolean PayStubFactory::setEnableProcessEntries($bool)

• Visibility: public

• $bool mixed

boolean PayStubFactory::getEnableProcessTransactions()

• Visibility: public

boolean PayStubFactory::setEnableProcessTransactions($bool)

• Visibility: public

• $bool mixed

boolean PayStubFactory::getEnableCalcYTD()

• Visibility: public

boolean PayStubFactory::setEnableCalcYTD($bool)

• Visibility: public

• $bool mixed

boolean PayStubFactory::getEnableCalcCurrentYTD()

• Visibility: public

boolean PayStubFactory::setEnableCalcCurrentYTD($bool)

• Visibility: public

• $bool mixed

boolean PayStubFactory::getIsReCalculatingYTD()

• Visibility: public

boolean PayStubFactory::setIsReCalculatingYTD($bool)

• Visibility: public

• $bool mixed

boolean PayStubFactory::getEnableEmail()

• Visibility: public

boolean PayStubFactory::setEnableEmail($bool)

• Visibility: public

• $bool mixed

boolean PayStubFactory::getEnableLinkedAccruals()

• Visibility: public

boolean PayStubFactory::setEnableLinkedAccruals($bool)

• Visibility: public

• $bool mixed

boolean PayStubFactory::CalcDifferences(string $pay_stub_id1, string $pay_stub_id2, integer $pay_stub_2_end_date, integer $ps_amendment_date)

• Visibility: public
• This method is static.

• $pay_stub_id1 string - UUID
• $pay_stub_id2 string - UUID
• $pay_stub_2_end_date integer - EPOCH
• $ps_amendment_date integer - EPOCH

boolean PayStubFactory::reCalculatePayStubYTD(string $pay_stub_id, boolean $enable_email)

• Visibility: public

• $pay_stub_id string - UUID
• $enable_email boolean

boolean PayStubFactory::reCalculateCurrentYTD()

• Visibility: public

boolean PayStubFactory::reCalculateYTD()

• Visibility: public

boolean PayStubFactory::preSave()

• Visibility: public

boolean PayStubFactory::Validate(boolean $ignore_warning)

• Visibility: public

• $ignore_warning boolean

boolean PayStubFactory::ValidateEntries()

• Visibility: public

boolean PayStubFactory::ValidateTransactions()

• Visibility: public

boolean PayStubFactory::postSave()

• Visibility: public

boolean PayStubFactory::handlePayStubAmendmentStatuses()

• Visibility: public

boolean PayStubFactory::handleUserExpenseStatuses()

• Visibility: public

boolean PayStubFactory::isAccrualBalanceOutstanding()

• Visibility: public

boolean|null PayStubFactory::getPayStubEntryAccountLinkObject()

• Visibility: public

array|boolean|null PayStubFactory::getPayStubEntryAccountsArray()

• Visibility: public

boolean|mixed PayStubFactory::getPayStubEntryAccountArray(string $id)

• Visibility: public

• $id string - UUID

array|boolean PayStubFactory::getSumByEntriesArrayAndTypeIDAndPayStubAccountID($ps_entries, integer $type_ids, string $ps_account_ids)

• Visibility: public

• $ps_entries mixed
• $type_ids integer - ID
• $ps_account_ids string - UUID

mixed PayStubFactory::calculateTemporaryTotals($entries)

Calculate the real-time total accounts while the pay stub is being generated. This should allow Tax/Deductions records to calculate based on including/excluding Net Pay.

This only needs to work on 'current' PS entries, as previous entries should already have the net pay calculated.

• Visibility: public

• $entries mixed - array

mixed PayStubFactory::loadCurrentPayStubTransactions()

• Visibility: public

boolean PayStubFactory::loadCurrentPayStubEntries()

• Visibility: public

boolean PayStubFactory::loadPreviousPayStub()

• Visibility: public

boolean PayStubFactory::prepareEntry(string $pay_stub_entry_account_id, $amount, null $units, null $rate, null $description, string $ps_amendment_id, null $ytd_amount, null $ytd_units, boolean $ytd_adjustment, string $user_expense_id)

Prepares the Pay Stub entry for adding.

• Visibility: public

• $pay_stub_entry_account_id string - UUID
• $amount mixed
• $units null
• $rate null
• $description null
• $ps_amendment_id string - UUID
• $ytd_amount null
• $ytd_units null
• $ytd_adjustment boolean
• $user_expense_id string - UUID

boolean PayStubFactory::addEntry(string $pay_stub_entry_account_id, $amount, null $units, null $rate, null $description, string $ps_amendment_id, null $ytd_amount, null $ytd_units, boolean $ytd_adjustment, string $user_expense_id)

• Visibility: public

• $pay_stub_entry_account_id string - UUID
• $amount mixed
• $units null
• $rate null
• $description null
• $ps_amendment_id string - UUID
• $ytd_amount null
• $ytd_units null
• $ytd_adjustment boolean
• $user_expense_id string - UUID

boolean PayStubFactory::processEntries()

• Visibility: public

boolean PayStubFactory::markPayStubEntriesForYTDCalculation($pay_stub_arr, boolean $clear_out_ytd)

• Visibility: public

• $pay_stub_arr mixed
• $clear_out_ytd boolean

boolean PayStubFactory::calcPayStubEntriesYTD()

• Visibility: public

boolean PayStubFactory::savePayStubEntries()

• Visibility: public

boolean PayStubFactory::deleteZeroAmountEntries()

There may be cases where Tax/Deduction records need to do calculations on hours (ie: unpaid absences) when there is no pay, but they need to do other calculations to add pay.

So we need to make sure all paid and unpaid time ($0 amounts) from the timesheets still appears on the pay stubs initially, then gets deleted off after all Tax/Deductions are calculated.

• Visibility: public

boolean PayStubFactory::deleteEntries(boolean $all_entries)

• Visibility: public

• $all_entries boolean

boolean PayStubFactory::addUnUsedYTDEntries()

• Visibility: public

boolean PayStubFactory::addEarningSum()

• Visibility: public

boolean PayStubFactory::addDeductionSum()

• Visibility: public

boolean PayStubFactory::addEmployerDeductionSum()

• Visibility: public

mixed PayStubFactory::getNetPaySum()

• Visibility: public

boolean PayStubFactory::addNetPay()

• Visibility: public

array PayStubFactory::getEarningSum()

• Visibility: public

integer PayStubFactory::getTotalTransactions()

• Visibility: public

integer PayStubFactory::getTotalPendingTransactions()

• Visibility: public

integer|string PayStubFactory::getTransactionsSum()

• Visibility: public

array PayStubFactory::getDeductionSum()

• Visibility: public

array PayStubFactory::getEmployerDeductionSum()

• Visibility: public

boolean|integer|mixed PayStubFactory::getGrossPay()

• Visibility: public

boolean|integer|mixed PayStubFactory::getDeductions()

• Visibility: public

boolean|integer|mixed PayStubFactory::getNetPay()

• Visibility: public

boolean PayStubFactory::checkNoEarnings()

• Visibility: public

boolean PayStubFactory::checkEarnings()

Returns TRUE unless Amount explicitly does not match Gross Pay use checkNoEarnings to see if any earnings exist or not.

• Visibility: public

boolean PayStubFactory::checkTransactions()

• Visibility: public

boolean PayStubFactory::checkDeductions()

• Visibility: public

boolean PayStubFactory::checkNetPay()

• Visibility: public

boolean PayStubFactory::checkNegativeNetPay()

• Visibility: public

boolean PayStubFactory::addTransaction(object $pst_obj)

For the api to edit transactions ensure that you validate at the API before calling this method.

• Visibility: public

• $pst_obj object

boolean PayStubFactory::savePayStubTransactions()

• Visibility: public

boolean PayStubFactory::calculateDefaultTransactions()

• Visibility: public

array|boolean PayStubFactory::getEmailPayStubAddresses()

• Visibility: public

boolean PayStubFactory::emailPayStub()

• Visibility: public

boolean PayStubFactory::setObjectFromArray($data)

• Visibility: public

• $data mixed

mixed PayStubFactory::getObjectAsArray(null $include_columns, boolean $permission_children_ids)

• Visibility: public

• $include_columns null
• $permission_children_ids boolean

mixed PayStubFactory::getFormObject()

• Visibility: public

mixed PayStubFactory::getChequeFormsObject($format)

• Visibility: public

• $format mixed

boolean|string PayStubFactory::getPayStub(null $pslf, boolean $hide_employer_rows)

• Visibility: public

• $pslf null
• $hide_employer_rows boolean

boolean PayStubFactory::addLog($log_action)

• Visibility: public

• $log_action mixed

mixed Factory::__construct()

Factory constructor.

• Visibility: public
• This method is defined by Factory

boolean|null Factory::getAMFMessageID()

Used for updating progress bar for API calls.

• Visibility: public
• This method is defined by Factory

boolean Factory::setAMFMessageID(string $id)

• Visibility: public
• This method is defined by Factory

• $id string - UUID

boolean Factory::setProgressBarObject(object $obj)

• Visibility: public
• This method is defined by Factory

• $obj object

null|\ProgressBar Factory::getProgressBarObject()

• Visibility: public
• This method is defined by Factory

boolean Factory::setGenericObject(object $obj, string $variable)

• Visibility: public
• This method is defined by Factory

• $obj object
• $variable string

boolean Factory::getGenericObject(string $list_factory, string|integer $id, string $variable, string $list_factory_method, string $id_method)

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

• Visibility: public
• This method is defined by Factory

• $list_factory string
• $id string|integer - UUID
• $variable string
• $list_factory_method string
• $id_method string

mixed Factory::getCompanyGenericMapData(string $company_id, integer $object_type_id, string $id, string $variable)

• Visibility: public
• This method is defined by Factory

• $company_id string - UUID
• $object_type_id integer
• $id string - UUID
• $variable string

boolean|mixed Factory::getGenericDataValue(string $name, $cast)

• Visibility: public
• This method is defined by Factory

• $name string
• $cast mixed

boolean Factory::setGenericDataValue(string $name, mixed $data, $cast)

• Visibility: public
• This method is defined by Factory

• $name string
• $data mixed
• $cast mixed

mixed Factory::castGenericDataValue($value, $cast)

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

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

• Visibility: public
• This method is defined by Factory

• $value mixed - mixed
• $cast mixed - string

boolean Factory::getGenericTempDataValue(string $name)

• Visibility: public
• This method is defined by Factory

• $name string

boolean Factory::setGenericTempDataValue(string $name, mixed $data)

• Visibility: public
• This method is defined by Factory

• $name string
• $data mixed

boolean|mixed Factory::getGenericOldDataValue(string $name)

• Visibility: public
• This method is defined by Factory

• $name string - Gets data value from old_data array, or the original value in the database, prior to any changes currently in memory.

boolean|mixed Factory::getCache(string $cache_id, string $group_id)

• Visibility: public
• This method is defined by Factory

• $cache_id string
• $group_id string

boolean Factory::saveCache(mixed $data, string $cache_id, string $group_id)

• Visibility: public
• This method is defined by Factory

• $data mixed
• $cache_id string
• $group_id string

boolean Factory::removeCache(string $cache_id, string $group_id)

• Visibility: public
• This method is defined by Factory

• $cache_id string
• $group_id string

boolean Factory::setCacheLifeTime(integer $secs)

• Visibility: public
• This method is defined by Factory

• $secs integer

string Factory::serializeRS(object $rs)

• Visibility: public
• This method is defined by Factory

• $rs object

mixed Factory::unserializeRS(string $rs)

• Visibility: public
• This method is defined by Factory

• $rs string

boolean|string Factory::getTable(boolean $strip_quotes)

• Visibility: public
• This method is defined by Factory

• $strip_quotes boolean

boolean|mixed Factory::getColumn(string $column)

• Visibility: public
• This method is defined by Factory

• $column string

boolean|string Factory::__toString()

• Visibility: public
• This method is defined by Factory

integer Factory::toBool(string|integer|boolean $value)

• Visibility: public
• This method is defined by Factory

• $value string|integer|boolean

boolean Factory::fromBool(string|integer|boolean $value)

• Visibility: public
• This method is defined by Factory

• $value string|integer|boolean

boolean Factory::isNew(boolean $force_lookup, string $id)

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

• Visibility: public
• This method is defined by Factory

• $force_lookup boolean
• $id string - UUID

boolean|mixed|string Factory::getLabelId()

• Visibility: public
• This method is defined by Factory

boolean|mixed Factory::getId()

• Visibility: public
• This method is defined by Factory

boolean Factory::setId(string $id)

• Visibility: public
• This method is defined by Factory

• $id string - UUID

boolean Factory::getEnableSystemLogDetail()

• Visibility: public
• This method is defined by Factory

boolean Factory::setEnableSystemLogDetail($bool)

• Visibility: public
• This method is defined by Factory

• $bool mixed

boolean Factory::getDeleted()

• Visibility: public
• This method is defined by Factory

boolean Factory::setDeleted(boolean $bool)

• Visibility: public
• This method is defined by Factory

• $bool boolean

integer Factory::getCreatedDate()

• Visibility: public
• This method is defined by Factory

boolean Factory::setCreatedDate(integer $epoch)

• Visibility: public
• This method is defined by Factory

• $epoch integer - EPOCH

boolean|mixed Factory::getCreatedBy()

• Visibility: public
• This method is defined by Factory

boolean Factory::setCreatedBy(string $id)

• Visibility: public
• This method is defined by Factory

• $id string - UUID

integer Factory::getUpdatedDate()

• Visibility: public
• This method is defined by Factory

boolean|integer|null|string Factory::setUpdatedDate(integer $epoch)

• Visibility: public
• This method is defined by Factory

• $epoch integer - EPOCH

boolean|mixed Factory::getUpdatedBy()

• Visibility: public
• This method is defined by Factory

boolean|null Factory::setUpdatedBy(string $id)

• Visibility: public
• This method is defined by Factory

• $id string - UUID

boolean|mixed Factory::getDeletedDate()

• Visibility: public
• This method is defined by Factory

boolean Factory::setDeletedDate(integer $epoch)

• Visibility: public
• This method is defined by Factory

• $epoch integer - EPOCH

boolean|mixed Factory::getDeletedBy()

• Visibility: public
• This method is defined by Factory

boolean|null Factory::setDeletedBy(string $id)

• Visibility: public
• This method is defined by Factory

• $id string - UUID

boolean Factory::setIsValid(boolean $is_valid)

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

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

• Visibility: public
• This method is defined by Factory

• $is_valid boolean

boolean Factory::setCreatedAndUpdatedColumns(array $data, array $variable_to_function_map)

• Visibility: public
• This method is defined by Factory

• $data array
• $variable_to_function_map array

boolean Factory::getCreatedAndUpdatedColumns(array $data, null $include_columns)

• Visibility: public
• This method is defined by Factory

• $data array
• $include_columns null

boolean Factory::getPermissionColumns(array $data, string $object_user_id, string $created_by_id, string $permission_children_ids, array $include_columns)

• Visibility: public
• This method is defined by Factory

• $data array
• $object_user_id string - UUID
• $created_by_id string - UUID
• $permission_children_ids string - UUID
• $include_columns array

array|boolean Factory::getOptions(string $name, string|integer $parent)

• Visibility: public
• This method is defined by Factory

• $name string
• $parent string|integer

array|boolean Factory::getVariableToFunctionMap(array $data)

• Visibility: public
• This method is defined by Factory

• $data array

integer|boolean Factory::getRecordCount()

• Visibility: public
• This method is defined by Factory

integer|boolean Factory::getCurrentRow(integer $offset)

• Visibility: public
• This method is defined by Factory

• $offset integer

boolean Factory::setQueryStatementTimeout(null $milliseconds)

• Visibility: public
• This method is defined by Factory

• $milliseconds null

array|boolean Factory::getRecordSetColumnList(object $rs)

• Visibility: private
• This method is defined by Factory

• $rs object

boolean|integer|string Factory::castInteger(integer|string $int, string $type)

• Visibility: protected
• This method is defined by Factory

• $int integer|string
• $type string

boolean|integer|string|array Factory::getListSQL(array|string|integer $array, array $ph, string|boolean $cast)

• Visibility: protected
• This method is defined by Factory

• $array array|string|integer
• $ph array
• $cast string|boolean

boolean|string Factory::getDateRangeSQL(string $str, string $column, string $format, boolean $include_blank_dates)

• Visibility: public
• This method is defined by Factory

• $str string
• $column string
• $format string
• $include_blank_dates boolean

string Factory::handleSQLSyntax(string $arg)

SQL where clause Syntax: or % as wildcard.

"" 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 |

• Visibility: protected
• This method is defined by Factory

• $arg string

mixed Factory::stripSQLSyntax(string $arg)

• Visibility: protected
• This method is defined by Factory

• $arg string

string Factory::getSQLToTimeStampFunction()

• Visibility: protected
• This method is defined by Factory

string Factory::getDatabaseType()

• Visibility: protected
• This method is defined by Factory

string Factory::getGEOMAsTextFunction(string $sql)

• Visibility: protected
• This method is defined by Factory

• $sql string

string Factory::getSQLToEpochFunction(string $sql)

• Visibility: protected
• This method is defined by Factory

• $sql string

string Factory::getSQLToTimeFunction(string $sql)

• Visibility: protected
• This method is defined by Factory

• $sql string

string Factory::getSQLStringAggregate(string $sql, string $glue)

• Visibility: protected
• This method is defined by Factory

• $sql string
• $glue string

null|string Factory::getWhereClauseSQL(array|string $columns, array|string $args, string $type, array $ph, string $query_stub, boolean $and)

• Visibility: protected
• This method is defined by Factory

• $columns array|string
• $args array|string
• $type string
• $ph array
• $query_stub string
• $and boolean

boolean|string Factory::parseColumnName(string $column)

• Visibility: private
• This method is defined by Factory

• $column string

boolean|string Factory::getWhereSQL(array $array, boolean $append_where)

• Visibility: protected
• This method is defined by Factory

• $array array
• $append_where boolean

array Factory::getColumnsFromAliases(array $columns, array $aliases)

• Visibility: protected
• This method is defined by Factory

• $columns array
• $aliases array

array Factory::convertFlexArray(array $array)

• Visibility: public
• This method is defined by Factory

• $array array

array Factory::getValidSQLColumns(array $array, boolean $strict, array $additional_fields)

• Visibility: public
• This method is defined by Factory

• $array array
• $strict boolean
• $additional_fields array

boolean|string Factory::getSortSQL(array $array, boolean $strict, array $additional_fields)

• Visibility: protected
• This method is defined by Factory

• $array array
• $strict boolean
• $additional_fields array

array|boolean Factory::getColumnList()

• Visibility: public
• This method is defined by Factory

mixed Factory::getEmptyRecordSet(string $id)

• Visibility: public
• This method is defined by Factory

• $id string - UUID

boolean Factory::getUpdateQuery()

• Visibility: private
• This method is defined by Factory

mixed Factory::getInsertQuery()

• Visibility: private
• This method is defined by Factory

mixed Factory::StartTransaction()

• Visibility: public
• This method is defined by Factory

mixed Factory::FailTransaction()

• Visibility: public
• This method is defined by Factory

mixed Factory::CommitTransaction()

• Visibility: public
• This method is defined by Factory

mixed Factory::setTransactionMode(string $mode)

• Visibility: public
• This method is defined by Factory

• $mode string

string Factory::getTransactionMode()

• Visibility: public
• This method is defined by Factory

boolean Factory::isValid(boolean $ignore_warning)

• Visibility: public
• This method is defined by Factory

• $ignore_warning boolean

boolean Factory::isWarning()

• Visibility: public
• This method is defined by Factory

boolean Factory::getSequenceName()

• Visibility: public
• This method is defined by Factory

boolean|string Factory::getNextInsertId()

• Visibility: public
• This method is defined by Factory

boolean Factory::ExecuteSQL(string $query, array $ph, integer $limit, integer $page)

• Visibility: public
• This method is defined by Factory

• $query string
• $ph array
• $limit integer - Limit the number of records returned
• $page integer - Page number of records to return for pagination

boolean Factory::RetryExecuteSQL(string $query, array $ph, integer $retry_max_attempts, integer $sleep)

• Visibility: public
• This method is defined by Factory

• $query string
• $ph array
• $retry_max_attempts integer
• $sleep integer

array Factory::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.

• Visibility: public
• This method is defined by Factory

boolean Factory::isDataDifferent($key, $data_diff, null $type_id, null $new_data)

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

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.

• Visibility: public
• This method is defined by Factory

• $key mixed - string
• $data_diff mixed - array
• $type_id null - string
• $new_data null - mixed

boolean|integer|string Factory::Save(boolean $reset_data, boolean $force_lookup)

• Visibility: public
• This method is defined by Factory

• $reset_data boolean
• $force_lookup boolean

boolean Factory::Delete()

• Visibility: public
• This method is defined by Factory

array|boolean Factory::getIDSByListFactory(object $lf)

• Visibility: public
• This method is defined by Factory

• $lf object

boolean Factory::bulkDelete(string|array $ids)

• Visibility: public
• This method is defined by Factory

• $ids string|array - UUID

boolean Factory::clearGeoCode(array $data_diff)

• Visibility: public
• This method is defined by Factory

• $data_diff array

array|null Factory::clearNonMappedData(array|null $data)

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

• Visibility: public
• This method is defined by Factory

• $data array|null

boolean Factory::clearData()

• Visibility: public
• This method is defined by Factory

boolean Factory::clearOldData()

• Visibility: public
• This method is defined by Factory

\FactoryListIterator Factory::getIterator()

• Visibility: public
• This method is defined by Factory

mixed Factory::getCurrent()

• Visibility: public
• This method is defined by Factory