• Class name: PayPeriodListFactory
• Namespace:
• Parent class: PayPeriodFactory
• This class implements: IteratorAggregate

protected mixed $table = 'pay_period'

• Visibility: protected

protected mixed $pk_sequence_name = 'pay_period_id_seq'

• Visibility: protected

protected mixed $old_status_id = NULL

• Visibility: protected

public mixed $pay_period_schedule_obj = NULL

• Visibility: public

public mixed $data = array()

• Visibility: public

public mixed $old_data = array()

• Visibility: public

public mixed $tmp_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

public mixed $validate_only = FALSE

• Visibility: public

private mixed $is_valid = FALSE

• Visibility: private

\PayPeriodListFactory PayPeriodListFactory::getAll(integer $limit, integer $page, array $where, array $order)

• Visibility: public

• $limit integer - Limit the number of records returned
• $page integer - Page number of records to return for pagination
• $where array - Additional SQL WHERE clause in format of array( $column => $filter, ... ). ie: array( 'id' => 1, ... )
• $order array - Sort order passed to SQL in format of array( $column => 'asc', 'name' => 'desc', ... ). ie: array( 'id' => 'asc', 'name' => 'desc', ... )

boolean|\PayPeriodListFactory PayPeriodListFactory::getById(string $id, array $where, array $order)

• Visibility: public

• $id string - UUID
• $where array - Additional SQL WHERE clause in format of array( $column => $filter, ... ). ie: array( 'id' => 1, ... )
• $order array - Sort order passed to SQL in format of array( $column => 'asc', 'name' => 'desc', ... ). ie: array( 'id' => 'asc', 'name' => 'desc', ... )

boolean|\PayPeriodListFactory PayPeriodListFactory::getByIdList(string $ids, array $where, array $order)

• Visibility: public

• $ids string - UUID
• $where array - Additional SQL WHERE clause in format of array( $column => $filter, ... ). ie: array( 'id' => 1, ... )
• $order array - Sort order passed to SQL in format of array( $column => 'asc', 'name' => 'desc', ... ). ie: array( 'id' => 'asc', 'name' => 'desc', ... )

array|boolean PayPeriodListFactory::getByIdListArray(string $ids, array $where, array $order, boolean $enable_names)

• Visibility: public

• $ids string - UUID
• $where array - Additional SQL WHERE clause in format of array( $column => $filter, ... ). ie: array( 'id' => 1, ... )
• $order array - Sort order passed to SQL in format of array( $column => 'asc', 'name' => 'desc', ... ). ie: array( 'id' => 'asc', 'name' => 'desc', ... )
• $enable_names boolean

array|boolean PayPeriodListFactory::getArrayByListFactory($lf, boolean $include_blank, boolean $sort_prefix)

• Visibility: public

• $lf mixed
• $include_blank boolean
• $sort_prefix boolean

boolean|\PayPeriodListFactory PayPeriodListFactory::getByPayPeriodScheduleId(string $id, integer $limit, integer $page, array $where, array $order)

• Visibility: public

• $id string - UUID
• $limit integer - Limit the number of records returned
• $page integer - Page number of records to return for pagination
• $where array - Additional SQL WHERE clause in format of array( $column => $filter, ... ). ie: array( 'id' => 1, ... )
• $order array - Sort order passed to SQL in format of array( $column => 'asc', 'name' => 'desc', ... ). ie: array( 'id' => 'asc', 'name' => 'desc', ... )

boolean|\PayPeriodListFactory PayPeriodListFactory::getByCompanyId(string $id, integer $limit, integer $page, array $where, array $order)

• Visibility: public

• $id string - UUID
• $limit integer - Limit the number of records returned
• $page integer - Page number of records to return for pagination
• $where array - Additional SQL WHERE clause in format of array( $column => $filter, ... ). ie: array( 'id' => 1, ... )
• $order array - Sort order passed to SQL in format of array( $column => 'asc', 'name' => 'desc', ... ). ie: array( 'id' => 'asc', 'name' => 'desc', ... )

boolean|\PayPeriodListFactory PayPeriodListFactory::getByCompanyIdAndStatus(string $company_id, integer $status_ids, array $where, array $order)

• Visibility: public

• $company_id string - UUID
• $status_ids integer
• $where array - Additional SQL WHERE clause in format of array( $column => $filter, ... ). ie: array( 'id' => 1, ... )
• $order array - Sort order passed to SQL in format of array( $column => 'asc', 'name' => 'desc', ... ). ie: array( 'id' => 'asc', 'name' => 'desc', ... )

boolean|\PayPeriodListFactory PayPeriodListFactory::getByCompanyIdAndStatusAndTransactionDate(string $company_id, integer $status_ids, integer $transaction_date, array $where, array $order)

• Visibility: public

• $company_id string - UUID
• $status_ids integer
• $transaction_date integer - EPOCH
• $where array - Additional SQL WHERE clause in format of array( $column => $filter, ... ). ie: array( 'id' => 1, ... )
• $order array - Sort order passed to SQL in format of array( $column => 'asc', 'name' => 'desc', ... ). ie: array( 'id' => 'asc', 'name' => 'desc', ... )

boolean|\PayPeriodListFactory PayPeriodListFactory::getByIdAndCompanyId(string $id, string $company_id, array $where, array $order)

• Visibility: public

• $id string - UUID
• $company_id string - UUID
• $where array - Additional SQL WHERE clause in format of array( $column => $filter, ... ). ie: array( 'id' => 1, ... )
• $order array - Sort order passed to SQL in format of array( $column => 'asc', 'name' => 'desc', ... ). ie: array( 'id' => 'asc', 'name' => 'desc', ... )

boolean|\PayPeriodListFactory PayPeriodListFactory::getByCompanyIdAndEndDate(string $company_id, integer $end_date, array $where, array $order)

• Visibility: public

• $company_id string - UUID
• $end_date integer - EPOCH
• $where array - Additional SQL WHERE clause in format of array( $column => $filter, ... ). ie: array( 'id' => 1, ... )
• $order array - Sort order passed to SQL in format of array( $column => 'asc', 'name' => 'desc', ... ). ie: array( 'id' => 'asc', 'name' => 'desc', ... )

boolean|\PayPeriodListFactory PayPeriodListFactory::getByCompanyIdAndTransactionDate(string $company_id, integer $transaction_date, array $where, array $order)

• Visibility: public

• $company_id string - UUID
• $transaction_date integer - EPOCH
• $where array - Additional SQL WHERE clause in format of array( $column => $filter, ... ). ie: array( 'id' => 1, ... )
• $order array - Sort order passed to SQL in format of array( $column => 'asc', 'name' => 'desc', ... ). ie: array( 'id' => 'asc', 'name' => 'desc', ... )

boolean|\PayPeriodListFactory PayPeriodListFactory::getByCompanyIdAndTransactionStartDateAndTransactionEndDate(string $company_id, integer $start_date, integer $end_date, array $where, array $order)

• Visibility: public

• $company_id string - UUID
• $start_date integer - EPOCH
• $end_date integer - EPOCH
• $where array - Additional SQL WHERE clause in format of array( $column => $filter, ... ). ie: array( 'id' => 1, ... )
• $order array - Sort order passed to SQL in format of array( $column => 'asc', 'name' => 'desc', ... ). ie: array( 'id' => 'asc', 'name' => 'desc', ... )

boolean|\PayPeriodListFactory PayPeriodListFactory::getByUserId(string $user_id, integer $limit, integer $page, array $where, array $order)

• Visibility: public

• $user_id string - UUID
• $limit integer - Limit the number of records returned
• $page integer - Page number of records to return for pagination
• $where array - Additional SQL WHERE clause in format of array( $column => $filter, ... ). ie: array( 'id' => 1, ... )
• $order array - Sort order passed to SQL in format of array( $column => 'asc', 'name' => 'desc', ... ). ie: array( 'id' => 'asc', 'name' => 'desc', ... )

boolean|\PayPeriodListFactory PayPeriodListFactory::getByUserIdAndStartDateAndEndDate(string $user_id, integer $start_date, integer $end_date, array $where, array $order)

• Visibility: public

• $user_id string - UUID
• $start_date integer - EPOCH
• $end_date integer - EPOCH
• $where array - Additional SQL WHERE clause in format of array( $column => $filter, ... ). ie: array( 'id' => 1, ... )
• $order array - Sort order passed to SQL in format of array( $column => 'asc', 'name' => 'desc', ... ). ie: array( 'id' => 'asc', 'name' => 'desc', ... )

boolean|\PayPeriodListFactory PayPeriodListFactory::getByCompanyIdAndOverlapStartDateAndEndDate(string $company_id, integer $start_date, integer $end_date, array $where, array $order)

• Visibility: public

• $company_id string - UUID
• $start_date integer - EPOCH
• $end_date integer - EPOCH
• $where array - Additional SQL WHERE clause in format of array( $column => $filter, ... ). ie: array( 'id' => 1, ... )
• $order array - Sort order passed to SQL in format of array( $column => 'asc', 'name' => 'desc', ... ). ie: array( 'id' => 'asc', 'name' => 'desc', ... )

boolean|\PayPeriodListFactory PayPeriodListFactory::getByUserIdAndOverlapStartDateAndEndDate(string $user_id, integer $start_date, integer $end_date, array $where, array $order)

• Visibility: public

• $user_id string - UUID
• $start_date integer - EPOCH
• $end_date integer - EPOCH
• $where array - Additional SQL WHERE clause in format of array( $column => $filter, ... ). ie: array( 'id' => 1, ... )
• $order array - Sort order passed to SQL in format of array( $column => 'asc', 'name' => 'desc', ... ). ie: array( 'id' => 'asc', 'name' => 'desc', ... )

boolean|\PayPeriodListFactory PayPeriodListFactory::getByUserIdAndEndDate(string $user_id, integer $end_date, array $where, array $order)

• Visibility: public

• $user_id string - UUID
• $end_date integer - EPOCH
• $where array - Additional SQL WHERE clause in format of array( $column => $filter, ... ). ie: array( 'id' => 1, ... )
• $order array - Sort order passed to SQL in format of array( $column => 'asc', 'name' => 'desc', ... ). ie: array( 'id' => 'asc', 'name' => 'desc', ... )

boolean|\PayPeriodListFactory PayPeriodListFactory::getByUserIdAndTransactionDate(string $user_id, integer $transaction_date, array $where, array $order)

• Visibility: public

• $user_id string - UUID
• $transaction_date integer - EPOCH
• $where array - Additional SQL WHERE clause in format of array( $column => $filter, ... ). ie: array( 'id' => 1, ... )
• $order array - Sort order passed to SQL in format of array( $column => 'asc', 'name' => 'desc', ... ). ie: array( 'id' => 'asc', 'name' => 'desc', ... )

boolean|\PayPeriodListFactory PayPeriodListFactory::getConflictingByPayPeriodScheduleIdAndStartDateAndEndDate(string $pay_period_schedule_id, integer $start_date, integer $end_date, string $id, array $where, array $order)

• Visibility: public

• $pay_period_schedule_id string - UUID
• $start_date integer - EPOCH
• $end_date integer - EPOCH
• $id string - UUID
• $where array - Additional SQL WHERE clause in format of array( $column => $filter, ... ). ie: array( 'id' => 1, ... )
• $order array - Sort order passed to SQL in format of array( $column => 'asc', 'name' => 'desc', ... ). ie: array( 'id' => 'asc', 'name' => 'desc', ... )

boolean|\PayPeriodListFactory PayPeriodListFactory::getByPayPeriodScheduleIdAndStartTransactionDateAndEndTransactionDate(string $id, integer $start_transaction_date, integer $end_transaction_date, array $where, array $order)

• Visibility: public

• $id string - UUID
• $start_transaction_date integer - EPOCH
• $end_transaction_date integer - EPOCH
• $where array - Additional SQL WHERE clause in format of array( $column => $filter, ... ). ie: array( 'id' => 1, ... )
• $order array - Sort order passed to SQL in format of array( $column => 'asc', 'name' => 'desc', ... ). ie: array( 'id' => 'asc', 'name' => 'desc', ... )

boolean|\PayPeriodListFactory PayPeriodListFactory::getByPayPeriodScheduleIdAndEndDateBefore(string $id, $end_date, $limit, $page, array $where, array $order)

• Visibility: public

• $id string - UUID
• $end_date mixed
• $limit mixed
• $page mixed
• $where array - Additional SQL WHERE clause in format of array( $column => $filter, ... ). ie: array( 'id' => 1, ... )
• $order array - Sort order passed to SQL in format of array( $column => 'asc', 'name' => 'desc', ... ). ie: array( 'id' => 'asc', 'name' => 'desc', ... )

boolean|\PayPeriodListFactory PayPeriodListFactory::getByCompanyIDAndPayPeriodScheduleIdAndStartTransactionDateAndEndTransactionDate(string $company_id, string $id, integer $start_transaction_date, integer $end_transaction_date, integer $limit, integer $page, array $where, array $order)

• Visibility: public

• $company_id string - UUID
• $id string - UUID
• $start_transaction_date integer - EPOCH
• $end_transaction_date integer - EPOCH
• $limit integer - Limit the number of records returned
• $page integer - Page number of records to return for pagination
• $where array - Additional SQL WHERE clause in format of array( $column => $filter, ... ). ie: array( 'id' => 1, ... )
• $order array - Sort order passed to SQL in format of array( $column => 'asc', 'name' => 'desc', ... ). ie: array( 'id' => 'asc', 'name' => 'desc', ... )

boolean|\PayPeriodListFactory PayPeriodListFactory::getByCompanyIDAndPayPeriodScheduleIdAndStatusAndStartTransactionDateAndEndTransactionDate(string $company_id, string $id, integer $status_id, integer $start_transaction_date, integer $end_transaction_date, integer $limit, integer $page, array $where, array $order)

• Visibility: public

• $company_id string - UUID
• $id string - UUID
• $status_id integer
• $start_transaction_date integer - EPOCH
• $end_transaction_date integer - EPOCH
• $limit integer - Limit the number of records returned
• $page integer - Page number of records to return for pagination
• $where array - Additional SQL WHERE clause in format of array( $column => $filter, ... ). ie: array( 'id' => 1, ... )
• $order array - Sort order passed to SQL in format of array( $column => 'asc', 'name' => 'desc', ... ). ie: array( 'id' => 'asc', 'name' => 'desc', ... )

boolean|\PayPeriodListFactory PayPeriodListFactory::getByCompanyIDAndPayPeriodScheduleIdAndAnyDate(string $company_id, string $id, integer $date, integer $limit, integer $page, array $where, array $order)

• Visibility: public

• $company_id string - UUID
• $id string - UUID
• $date integer - EPOCH
• $limit integer - Limit the number of records returned
• $page integer - Page number of records to return for pagination
• $where array - Additional SQL WHERE clause in format of array( $column => $filter, ... ). ie: array( 'id' => 1, ... )
• $order array - Sort order passed to SQL in format of array( $column => 'asc', 'name' => 'desc', ... ). ie: array( 'id' => 'asc', 'name' => 'desc', ... )

boolean|\PayPeriodListFactory PayPeriodListFactory::getThisPayPeriodByCompanyIdAndPayPeriodScheduleIdAndDate(string $company_id, string $id, integer $date, array $where, array $order)

• Visibility: public

• $company_id string - UUID
• $id string - UUID
• $date integer - EPOCH
• $where array - Additional SQL WHERE clause in format of array( $column => $filter, ... ). ie: array( 'id' => 1, ... )
• $order array - Sort order passed to SQL in format of array( $column => 'asc', 'name' => 'desc', ... ). ie: array( 'id' => 'asc', 'name' => 'desc', ... )

boolean|\PayPeriodListFactory PayPeriodListFactory::getLastPayPeriodByCompanyIdAndPayPeriodScheduleIdAndDate(string $company_id, string $id, integer $date, array $where, array $order)

• Visibility: public

• $company_id string - UUID
• $id string - UUID
• $date integer - EPOCH
• $where array - Additional SQL WHERE clause in format of array( $column => $filter, ... ). ie: array( 'id' => 1, ... )
• $order array - Sort order passed to SQL in format of array( $column => 'asc', 'name' => 'desc', ... ). ie: array( 'id' => 'asc', 'name' => 'desc', ... )

boolean|\PayPeriodListFactory PayPeriodListFactory::getByPayPeriodScheduleIdAndTransactionDate(string $id, integer $transaction_date, array $where, array $order)

• Visibility: public

• $id string - UUID
• $transaction_date integer - EPOCH
• $where array - Additional SQL WHERE clause in format of array( $column => $filter, ... ). ie: array( 'id' => 1, ... )
• $order array - Sort order passed to SQL in format of array( $column => 'asc', 'name' => 'desc', ... ). ie: array( 'id' => 'asc', 'name' => 'desc', ... )

boolean|\PayPeriodListFactory PayPeriodListFactory::getPreviousPayPeriodById(string $id)

• Visibility: public

• $id string - UUID

boolean|\PayPeriodListFactory PayPeriodListFactory::getByStatus($status, array $where, array $order)

• Visibility: public

• $status mixed
• $where array - Additional SQL WHERE clause in format of array( $column => $filter, ... ). ie: array( 'id' => 1, ... )
• $order array - Sort order passed to SQL in format of array( $column => 'asc', 'name' => 'desc', ... ). ie: array( 'id' => 'asc', 'name' => 'desc', ... )

boolean|\PayPeriodListFactory PayPeriodListFactory::getByUserIdListAndNotStatus(string $user_ids, integer $status_ids, array $where, array $order)

• Visibility: public

• $user_ids string - UUID
• $status_ids integer
• $where array - Additional SQL WHERE clause in format of array( $column => $filter, ... ). ie: array( 'id' => 1, ... )
• $order array - Sort order passed to SQL in format of array( $column => 'asc', 'name' => 'desc', ... ). ie: array( 'id' => 'asc', 'name' => 'desc', ... )

boolean|\PayPeriodListFactory PayPeriodListFactory::getByUserIdListAndNotStatusAndStartDateAndEndDate(string $user_ids, integer $status_ids, integer $start_date, integer $end_date, array $where, array $order)

• Visibility: public

• $user_ids string - UUID
• $status_ids integer
• $start_date integer - EPOCH
• $end_date integer - EPOCH
• $where array - Additional SQL WHERE clause in format of array( $column => $filter, ... ). ie: array( 'id' => 1, ... )
• $order array - Sort order passed to SQL in format of array( $column => 'asc', 'name' => 'desc', ... ). ie: array( 'id' => 'asc', 'name' => 'desc', ... )

boolean PayPeriodListFactory::getFirstStartDateAndLastEndDateByPayPeriodScheduleId(string $id, array $where, array $order)

• Visibility: public

• $id string - UUID
• $where array - Additional SQL WHERE clause in format of array( $column => $filter, ... ). ie: array( 'id' => 1, ... )
• $order array - Sort order passed to SQL in format of array( $column => 'asc', 'name' => 'desc', ... ). ie: array( 'id' => 'asc', 'name' => 'desc', ... )

array|boolean PayPeriodListFactory::getYearsArrayByCompanyId(string $company_id)

• Visibility: public

• $company_id string - UUID

boolean|\PayPeriodListFactory PayPeriodListFactory::getPayPeriodsWithPayStubsByCompanyId(string $id, integer $limit, integer $page, array $where, array $order)

• Visibility: public

• $id string - UUID
• $limit integer - Limit the number of records returned
• $page integer - Page number of records to return for pagination
• $where array - Additional SQL WHERE clause in format of array( $column => $filter, ... ). ie: array( 'id' => 1, ... )
• $order array - Sort order passed to SQL in format of array( $column => 'asc', 'name' => 'desc', ... ). ie: array( 'id' => 'asc', 'name' => 'desc', ... )

$this|boolean PayPeriodListFactory::getByCompanyIdAndRemittanceAgencyIdAndTransactionDateAndPayPeriodSchedule($company_id, $id, null $transaction_date, $pay_period_schedule, null $limit, null $page, null $where, null $order)

• Visibility: public

• $company_id mixed
• $id mixed
• $transaction_date null
• $pay_period_schedule mixed
• $limit null
• $page null
• $where null
• $order null

boolean|mixed PayPeriodListFactory::getJSCalendarPayPeriodArray(boolean $include_all_pay_period_schedules)

Get last 6mths worth of pay periods and prepare a JS array so they can be highlighted in the calendar.

• Visibility: public

• $include_all_pay_period_schedules boolean

boolean|\PayPeriodListFactory PayPeriodListFactory::getAPISearchByCompanyIdAndArrayCriteria(string $company_id, $filter_data, integer $limit, integer $page, array $where, array $order)

• Visibility: public

• $company_id string - UUID
• $filter_data mixed
• $limit integer - Limit the number of records returned
• $page integer - Page number of records to return for pagination
• $where array - Additional SQL WHERE clause in format of array( $column => $filter, ... ). ie: array( 'id' => 1, ... )
• $order array - Sort order passed to SQL in format of array( $column => 'asc', 'name' => 'desc', ... ). ie: array( 'id' => 'asc', 'name' => 'desc', ... )

boolean PayPeriodListFactory::findPayPeriod(string $user_id, integer $date_stamp)

• Visibility: public
• This method is static.

• $user_id string - UUID
• $date_stamp integer - EPOCH

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|null PayPeriodFactory::getPayPeriodScheduleObject()

• Visibility: public
• This method is defined by PayPeriodFactory

mixed PayPeriodFactory::getCompany()

• Visibility: public
• This method is defined by PayPeriodFactory

boolean PayPeriodFactory::setCompany(string $value)

• Visibility: public
• This method is defined by PayPeriodFactory

• $value string - UUID

boolean|integer PayPeriodFactory::getStatus()

• Visibility: public
• This method is defined by PayPeriodFactory

boolean PayPeriodFactory::setStatus($value)

• Visibility: public
• This method is defined by PayPeriodFactory

• $value mixed

boolean|mixed PayPeriodFactory::getPayPeriodSchedule()

• Visibility: public
• This method is defined by PayPeriodFactory

boolean PayPeriodFactory::setPayPeriodSchedule(string $value)

• Visibility: public
• This method is defined by PayPeriodFactory

• $value string - UUID

boolean PayPeriodFactory::isValidStartDate(integer $epoch)

• Visibility: public
• This method is defined by PayPeriodFactory

• $epoch integer - EPOCH

boolean PayPeriodFactory::isConflicting()

• Visibility: public
• This method is defined by PayPeriodFactory

array|boolean PayPeriodFactory::getPayPeriodDates(integer $filter_start_date, integer $filter_end_date, boolean $include_pay_period_id)

• Visibility: public
• This method is defined by PayPeriodFactory

• $filter_start_date integer - EPOCH
• $filter_end_date integer - EPOCH
• $include_pay_period_id boolean

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

• Visibility: public
• This method is defined by PayPeriodFactory

• $raw boolean

boolean PayPeriodFactory::setStartDate(integer $value)

• Visibility: public
• This method is defined by PayPeriodFactory

• $value integer - EPOCH

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

• Visibility: public
• This method is defined by PayPeriodFactory

• $raw boolean

boolean PayPeriodFactory::setEndDate(integer $value)

• Visibility: public
• This method is defined by PayPeriodFactory

• $value integer - EPOCH

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

• Visibility: public
• This method is defined by PayPeriodFactory

• $raw boolean

boolean PayPeriodFactory::setTransactionDate(integer $value)

• Visibility: public
• This method is defined by PayPeriodFactory

• $value integer - EPOCH

boolean PayPeriodFactory::getPrimary()

• Visibility: public
• This method is defined by PayPeriodFactory

boolean PayPeriodFactory::setPrimary($value)

• Visibility: public
• This method is defined by PayPeriodFactory

• $value mixed

boolean PayPeriodFactory::setPayStubStatus($status, $dry_run)

• Visibility: public
• This method is defined by PayPeriodFactory

• $status mixed
• $dry_run mixed

mixed PayPeriodFactory::purgePayStubAmendments()

• Visibility: public
• This method is defined by PayPeriodFactory

boolean PayPeriodFactory::getTainted()

• Visibility: public
• This method is defined by PayPeriodFactory

boolean PayPeriodFactory::setTainted($value)

• Visibility: public
• This method is defined by PayPeriodFactory

• $value mixed

boolean|mixed PayPeriodFactory::getTaintedDate()

• Visibility: public
• This method is defined by PayPeriodFactory

boolean PayPeriodFactory::setTaintedDate(integer $value)

• Visibility: public
• This method is defined by PayPeriodFactory

• $value integer - EPOCH

boolean|mixed PayPeriodFactory::getTaintedBy()

• Visibility: public
• This method is defined by PayPeriodFactory

boolean PayPeriodFactory::setTaintedBy(string $value)

• Visibility: public
• This method is defined by PayPeriodFactory

• $value string - UUID

boolean PayPeriodFactory::getTimeSheetVerifyType()

• Visibility: public
• This method is defined by PayPeriodFactory

boolean|integer PayPeriodFactory::getTimeSheetVerifyWindowStartDate()

• Visibility: public
• This method is defined by PayPeriodFactory

boolean|integer PayPeriodFactory::getTimeSheetVerifyWindowEndDate()

• Visibility: public
• This method is defined by PayPeriodFactory

boolean PayPeriodFactory::getIsLocked()

• Visibility: public
• This method is defined by PayPeriodFactory

string PayPeriodFactory::getName(boolean $include_schedule_name)

• Visibility: public
• This method is defined by PayPeriodFactory

• $include_schedule_name boolean

boolean PayPeriodFactory::getEnableImportOrphanedData()

• Visibility: public
• This method is defined by PayPeriodFactory

boolean PayPeriodFactory::setEnableImportOrphanedData($bool)

• Visibility: public
• This method is defined by PayPeriodFactory

• $bool mixed

boolean PayPeriodFactory::getEnableImportData()

• Visibility: public
• This method is defined by PayPeriodFactory

boolean PayPeriodFactory::setEnableImportData($bool)

• Visibility: public
• This method is defined by PayPeriodFactory

• $bool mixed

boolean PayPeriodFactory::isPreviousPayPeriodClosed()

• Visibility: public
• This method is defined by PayPeriodFactory

boolean PayPeriodFactory::isFirstPayPeriodInYear()

• Visibility: public
• This method is defined by PayPeriodFactory

boolean PayPeriodFactory::importOrphanedData()

• Visibility: public
• This method is defined by PayPeriodFactory

boolean PayPeriodFactory::importData(boolean $user_ids, boolean $pay_period_id)

• Visibility: public
• This method is defined by PayPeriodFactory

• $user_ids boolean
• $pay_period_id boolean

boolean PayPeriodFactory::deleteData()

• Visibility: public
• This method is defined by PayPeriodFactory

boolean|integer PayPeriodFactory::getPendingRequests()

• Visibility: public
• This method is defined by PayPeriodFactory

array PayPeriodFactory::getExceptions()

• Visibility: public
• This method is defined by PayPeriodFactory

mixed PayPeriodFactory::getTotalPunches()

• Visibility: public
• This method is defined by PayPeriodFactory

mixed PayPeriodFactory::getTotalManualTimeSheets()

• Visibility: public
• This method is defined by PayPeriodFactory

mixed PayPeriodFactory::getTotalAbsences()

• Visibility: public
• This method is defined by PayPeriodFactory

array PayPeriodFactory::getTimeSheets()

• Visibility: public
• This method is defined by PayPeriodFactory

integer PayPeriodFactory::getPayStubAmendments()

• Visibility: public
• This method is defined by PayPeriodFactory

mixed PayPeriodFactory::getPayStubs()

• Visibility: public
• This method is defined by PayPeriodFactory

mixed PayPeriodFactory::getPayStubsOpen()

• Visibility: public
• This method is defined by PayPeriodFactory

boolean PayPeriodFactory::Validate(boolean $ignore_warning)

• Visibility: public
• This method is defined by PayPeriodFactory

• $ignore_warning boolean

boolean PayPeriodFactory::preSave()

• Visibility: public
• This method is defined by PayPeriodFactory

boolean PayPeriodFactory::postSave()

• Visibility: public
• This method is defined by PayPeriodFactory

boolean PayPeriodFactory::setObjectFromArray($data)

• Visibility: public
• This method is defined by PayPeriodFactory

• $data mixed

array PayPeriodFactory::getObjectAsArray(null $include_columns)

• Visibility: public
• This method is defined by PayPeriodFactory

• $include_columns null

boolean PayPeriodFactory::addLog($log_action)

• Visibility: public
• This method is defined by PayPeriodFactory

• $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