• Class name: APISchedule
• Namespace:
• Parent class: APIFactory

protected mixed $main_class = 'ScheduleFactory'

• Visibility: protected

public mixed $data = array()

• Visibility: public

protected mixed $main_class_obj = NULL

• Visibility: protected

protected mixed $AMF_message_id = NULL

• Visibility: protected

protected mixed $pager_obj = NULL

• Visibility: protected

protected mixed $current_company = NULL

• Visibility: protected

protected mixed $current_user = NULL

• Visibility: protected

protected mixed $current_user_prefs = NULL

• Visibility: protected

protected mixed $permission = NULL

• Visibility: protected

protected mixed $progress_bar_obj = NULL

• Visibility: protected

mixed APIFactory::__construct()

APIFactory constructor.

• Visibility: public
• This method is defined by APIFactory

array APISchedule::getScheduleDefaultData(array $data)

Get default schedule data for creating new schedulees.

• Visibility: public

• $data array

array|boolean APISchedule::getCombinedSchedule(array $data, integer $base_date, null $type, null $strict)

Get combined recurring schedule and committed schedule data for one or more schedulees.

• Visibility: public

• $data array - filter data
• $base_date integer - EPOCH
• $type null
• $strict null

array|boolean APISchedule::getSchedule(array $data, boolean $disable_paging)

Get schedule data for one or more schedulees.

• Visibility: public

• $data array - filter data
• $disable_paging boolean

array APISchedule::exportSchedule(string $format, array $data, boolean $disable_paging)

Export wage data to csv

• Visibility: public

• $format string - file format (csv)
• $data array - filter data
• $disable_paging boolean

array APISchedule::getCommonScheduleData(array $data)

Get only the fields that are common across all records in the search criteria. Used for Mass Editing of records.

• Visibility: public

• $data array - filter data

array APISchedule::validateSchedule(array $data)

Validate schedule data for one or more schedulees.

• Visibility: public

• $data array - schedule data

array APISchedule::setSchedule(array $data, boolean $validate_only, boolean $ignore_warning)

Set schedule data for one or more schedulees.

• Visibility: public

• $data array - schedule data
• $validate_only boolean
• $ignore_warning boolean

array|boolean APISchedule::deleteSchedule(array $data)

Delete one or more schedules.

• Visibility: public

• $data array - schedule data

array|boolean APISchedule::getScheduleTotalTime(integer $start, integer $end, integer $schedule_policy_id, string $user_id)

Get schedule total time

• Visibility: public

• $start integer - Start date epoch
• $end integer - End date epoch
• $schedule_policy_id integer - Schedule policy ID
• $user_id string - UUID

array APISchedule::swapSchedule(array $src_ids, array $dst_ids)

Swap schedules with one another. This doesn't work with recurring schedules, and is not used by Flex currently.

• Visibility: public

• $src_ids array - Source schedule IDs
• $dst_ids array - Destination schedule IDs

array|boolean APISchedule::addPunchesFromScheduledShifts(array $schedule_arr)

Creates punches from an array of scheduled shift ids.

• Visibility: public

• $schedule_arr array - should have 2 sub arrays of integer ids, one labeled 'schedule', one labeled 'recurring'

integer APIFactory::getProtocolVersion()

• Visibility: public
• This method is defined by APIFactory

boolean|null APIFactory::getAMFMessageID()

• Visibility: public
• This method is defined by APIFactory

boolean APIFactory::setAMFMessageID(string $id)

• Visibility: public
• This method is defined by APIFactory

• $id string - UUID

boolean|\CompanyFactory APIFactory::getCurrentCompanyObject()

• Visibility: public
• This method is defined by APIFactory

boolean|\UserFactory APIFactory::getCurrentUserObject()

• Visibility: public
• This method is defined by APIFactory

boolean|\UserPreferenceFactory APIFactory::getCurrentUserPreferenceObject()

• Visibility: public
• This method is defined by APIFactory

boolean|null|\Permission APIFactory::getPermissionObject()

• Visibility: public
• This method is defined by APIFactory

null|\ProgressBar APIFactory::getProgressBarObject()

• Visibility: public
• This method is defined by APIFactory

boolean APIFactory::setPagerObject(object $lf)

• Visibility: public
• This method is defined by APIFactory

• $lf object

array|boolean APIFactory::getPagerData()

• Visibility: public
• This method is defined by APIFactory

boolean APIFactory::setMainClassObject(object $obj)

• Visibility: public
• This method is defined by APIFactory

• $obj object

string APIFactory::getMainClassObject()

• Visibility: public
• This method is defined by APIFactory

array|boolean APIFactory::initializeFilterAndPager(array $data, boolean $disable_paging)

• Visibility: public
• This method is defined by APIFactory

• $data array
• $disable_paging boolean

array|null APIFactory::handlePermissionFilterColumns(array $filter_columns, array $allowed_columns)

• Visibility: public
• This method is defined by APIFactory

• $filter_columns array
• $allowed_columns array

mixed APIFactory::convertToSingleRecord(array $data)

• Visibility: public
• This method is defined by APIFactory

• $data array

array APIFactory::convertToMultipleRecords(array $data)

• Visibility: public
• This method is defined by APIFactory

• $data array

array|boolean APIFactory::exportRecords(string $format, string $file_name, array $result, array $filter_columns)

downloaded a result_set as a csv.

• Visibility: public
• This method is defined by APIFactory

• $format string
• $file_name string
• $result array
• $filter_columns array

string APIFactory::getNextInsertID()

• Visibility: public
• This method is defined by APIFactory

array APIFactory::getPermissionChildren()

• Visibility: public
• This method is defined by APIFactory

array|boolean APIFactory::returnHandler(boolean $retval, boolean $code, boolean $description, boolean $details, boolean $validator_stats, boolean $user_generic_status_batch_id, boolean $request_data)

• Visibility: public
• This method is defined by APIFactory

• $retval boolean
• $code boolean
• $description boolean
• $details boolean
• $validator_stats boolean
• $user_generic_status_batch_id boolean
• $request_data boolean

mixed APIFactory::stripReturnHandler(mixed $retarr)

• Visibility: public
• This method is defined by APIFactory

• $retarr mixed

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

• Visibility: public
• This method is defined by APIFactory

• $name boolean
• $parent string|integer

array APIFactory::getVariableToFunctionMap(string $name, string|integer $parent)

• Visibility: public
• This method is defined by APIFactory

• $name string
• $parent string|integer

boolean|\Validator APIFactory::convertAPIReturnHandlerToValidatorObject($api_retarr, boolean $validator_obj)

• Visibility: public
• This method is defined by APIFactory

• $api_retarr mixed
• $validator_obj boolean

array|boolean APIFactory::setValidationArray(string $primary_validator, string $secondary_validator, boolean $tertiary_validator)

• Visibility: public
• This method is defined by APIFactory

• $primary_validator string - UUID
• $secondary_validator string - UUID
• $tertiary_validator boolean

array APIFactory::handleRecordValidationResults(object|boolean $validator, array $validator_stats, integer $key, array|boolean $save_result)

• Visibility: public
• This method is defined by APIFactory

• $validator object|boolean
• $validator_stats array
• $key integer
• $save_result array|boolean