APIJobApplicantPortal
extends APIFactory
in package
Table of Contents
- $data : mixed
- $api_message_id : mixed
- $current_company : mixed
- $current_user : mixed
- $current_user_prefs : mixed
- $document_class_obj : mixed
- $job_applicant_class_obj : mixed
- $job_applicant_education_class_obj : mixed
- $job_applicant_employment_class_obj : mixed
- $job_applicant_language_class_obj : mixed
- $job_applicant_license_class_obj : mixed
- $job_applicant_location_class_obj : mixed
- $job_applicant_membership_class_obj : mixed
- $job_applicant_reference_class_obj : mixed
- $job_applicant_skill_class_obj : mixed
- $job_application_class_obj : mixed
- $main_class_obj : mixed
- $pager_obj : mixed
- $permission : mixed
- $progress_bar_obj : mixed
- $recruitment_portal_config_class_obj : mixed
- __construct() : mixed
- APIJobApplicantPortal constructor.
- calcExperience() : array<string|int, mixed>|bool
- convertAPIReturnHandlerToValidatorObject() : bool|Validator
- Take a API ReturnHandler array and pulls out the Validation errors/warnings to be merged back into another Validator This is useful for calling one API function from another one when their are sub-classes.
- convertToMultipleRecords() : array<string|int, mixed>
- convertToSingleRecord() : mixed
- deleteDocument() : array<string|int, mixed>
- Delete one or more documents.
- deleteJobApplicantEducation() : array<string|int, mixed>
- Delete one or more.
- deleteJobApplicantEmployment() : array<string|int, mixed>
- Delete one or more.
- deleteJobApplicantLanguage() : array<string|int, mixed>
- Delete one or more.
- deleteJobApplicantLicense() : array<string|int, mixed>
- Delete one or more.
- deleteJobApplicantLocation() : array<string|int, mixed>
- Delete one or more.
- deleteJobApplicantMembership() : array<string|int, mixed>
- Delete one or more.
- deleteJobApplicantReference() : array<string|int, mixed>
- Delete one or more.
- deleteJobApplicantSkill() : array<string|int, mixed>
- Delete one or more.
- deleteJobApplication() : array<string|int, mixed>
- Delete one or more job application.
- exportRecords() : array<string|int, mixed>|bool
- Download a result_set as a csv.
- getAPIMessageID() : bool|null
- Returns the API messageID for each individual call.
- getCurrentCompanyObject() : bool|CompanyFactory
- getCurrentUserObject() : bool|UserFactory
- getCurrentUserPreferenceObject() : bool|UserPreferenceFactory
- getDocument() : array<string|int, mixed>|bool
- Get document data for one or more documentes.
- getDocumentDefaultData() : array<string|int, mixed>
- Get default document data for creating new documentes.
- getJobApplicant() : array<string|int, mixed>
- Get job applicant data for one or more job applicant.
- getJobApplicantEducation() : array<string|int, mixed>
- Get job applicant education data for one or more.
- getJobApplicantEducationDefaultData() : array<string|int, mixed>
- Get default job applicant education data for creating new .
- getJobApplicantEducationOptions() : bool
- Bridge to job applicant education class getOptions factory.
- getJobApplicantEmployment() : array<string|int, mixed>
- Get job applicant Employment data for one or more.
- getJobApplicantEmploymentDefaultData() : array<string|int, mixed>
- Get default job applicant Employment data.
- getJobApplicantEmploymentOptions() : bool
- Bridge to job applicant employment class getOptions factory.
- getJobApplicantLanguage() : array<string|int, mixed>
- Get job applicant language data for one or more.
- getJobApplicantLanguageDefaultData() : array<string|int, mixed>
- Get default job applicant language data for creating new .
- getJobApplicantLanguageOptions() : bool
- Bridge to job applicant language class getOptions factory.
- getJobApplicantLicense() : array<string|int, mixed>
- Get job applicant license data for one or more.
- getJobApplicantLicenseDefaultData() : array<string|int, mixed>
- Get default job applicant license data for creating new .
- getJobApplicantLicenseOptions() : bool
- Bridge to job applicant license class getOptions factory.
- getJobApplicantLocation() : array<string|int, mixed>
- Get job applicant location data for one or more.
- getJobApplicantLocationDefaultData() : array<string|int, mixed>
- Get default job applicant location data.
- getJobApplicantLocationOptions() : bool
- Bridge to job applicant location class getOptions factory.
- getJobApplicantMembership() : array<string|int, mixed>
- Get job applicant membership data for one or more.
- getJobApplicantMembershipDefaultData() : array<string|int, mixed>
- Get default job applicant membership data for creating new .
- getJobApplicantMembershipOptions() : bool
- Bridge to job applicant membership class getOptions factory.
- getJobApplicantOptions() : array<string|int, mixed>|bool
- Get options for dropdown boxes.
- getJobApplicantReference() : array<string|int, mixed>
- Get job applicant Reference data for one or more.
- getJobApplicantReferenceDefaultData() : array<string|int, mixed>
- Get default job applicant Reference data.
- getJobApplicantReferenceOptions() : bool
- Bridge to job applicant reference class getOptions factory.
- getJobApplicantSkill() : array<string|int, mixed>
- Get job applicant skill data for one or more.
- getJobApplicantSkillDefaultData() : array<string|int, mixed>
- Get default job applicant skill data for creating new .
- getJobApplicantSkillOptions() : bool
- Bridge to job applicant skill class getOptions factory.
- getJobApplication() : array<string|int, mixed>
- Get job application data for one or more job application.
- getMainClassObject() : string
- getNextInsertID() : string
- getOptions() : array<string|int, mixed>|bool
- Bridge to main class getOptions factory.
- getOptionsBatch() : array<string|int, mixed>
- Bridge multiple batched requests to main class getOptions factory.
- getPagerData() : array<string|int, mixed>|bool
- getPagerObject() : Pager
- getPermissionChildren() : array<string|int, mixed>
- getPermissionObject() : bool|null|Permission
- getProgressBarObject() : null|ProgressBar
- getProtocolVersion() : int
- getRecruitmentPortalAvailabelFields() : array<string|int, mixed>
- getRecruitmentPortalConfig() : array<string|int, mixed>|bool
- getRecruitmentPortalConfigOptions() : bool
- getVariableToFunctionMap() : array<string|int, mixed>
- Bridge to main class getVariableToFunctionMap factory.
- handlePermissionFilterColumns() : array<string|int, mixed>|null
- In cases where data can be displayed in just a list_view (dropdown boxes), ie: branch, department, job, task in In/Out punch view restrict the dropdown box to just a subset of columns, so not all data is shown.
- handleRecordValidationResults() : array<string|int, mixed>
- initializeFilterAndPager() : array<string|int, mixed>|bool
- isProgressBarStarted() : bool
- returnHandler() : array<string|int, mixed>|bool
- Controls returning information to client in a standard format.
- setAPIMessageID() : bool
- setDocument() : array<string|int, mixed>
- Set document data for one or more documentes.
- setJobApplicant() : array<string|int, mixed>
- Set job applicant data for one or more job applicant.
- setJobApplicantEducation() : array<string|int, mixed>
- Set job applicant education data for one or more.
- setJobApplicantEmployment() : array<string|int, mixed>
- Set job applicant Employment data for one or more.
- setJobApplicantLanguage() : array<string|int, mixed>
- Set job applicant language data for one or more.
- setJobApplicantLicense() : array<string|int, mixed>
- Set job applicant license data for one or more.
- setJobApplicantLocation() : array<string|int, mixed>
- Set job applicant location data for one or more.
- setJobApplicantMembership() : array<string|int, mixed>
- Set job applicant membership data for one or more.
- setJobApplicantReference() : array<string|int, mixed>
- Set job applicant Reference data for one or more.
- setJobApplicantSkill() : array<string|int, mixed>
- Set job applicant skill data for one or more.
- setJobApplication() : array<string|int, mixed>
- Set job application data for one or more job application.
- setMainClassObject() : bool
- Allow storing the main class object persistently in memory, so we can build up other variables to help out things like getOptions() Mainly used for the APIReport class.
- setPagerObject() : bool
- setProgressBarObject() : bool
- setValidationArray() : array<string|int, mixed>|bool
- stripReturnHandler() : mixed
- validateDocument() : array<string|int, mixed>
- Validate document data for one or more documentes.
- validateJobApplicant() : array<string|int, mixed>
- Validate job applicant data for one or more job applicant.
- validateJobApplicantEducation() : array<string|int, mixed>
- Validate job applicant education data for one or more.
- validateJobApplicantEmployment() : array<string|int, mixed>
- Validate job applicant Employment data for one or more.
- validateJobApplicantLanguage() : array<string|int, mixed>
- Validate job applicant language data for one or more.
- validateJobApplicantLicense() : array<string|int, mixed>
- Validate job applicant license data for one or more.
- validateJobApplicantLocation() : array<string|int, mixed>
- Validate job applicant location data for one or more.
- validateJobApplicantMembership() : array<string|int, mixed>
- Validate job applicant membership data for one or more.
- validateJobApplicantReference() : array<string|int, mixed>
- Validate job applicant Reference data for one or more.
- validateJobApplicantSkill() : array<string|int, mixed>
- Validate job applicant skill data for one or more.
Properties
$data
public
mixed
$data
= []
$api_message_id
protected
mixed
$api_message_id
= \null
$current_company
protected
mixed
$current_company
= \null
$current_user
protected
mixed
$current_user
= \null
$current_user_prefs
protected
mixed
$current_user_prefs
= \null
$document_class_obj
protected
mixed
$document_class_obj
= \null
$job_applicant_class_obj
protected
mixed
$job_applicant_class_obj
= \null
$job_applicant_education_class_obj
protected
mixed
$job_applicant_education_class_obj
= \null
$job_applicant_employment_class_obj
protected
mixed
$job_applicant_employment_class_obj
= \null
$job_applicant_language_class_obj
protected
mixed
$job_applicant_language_class_obj
= \null
$job_applicant_license_class_obj
protected
mixed
$job_applicant_license_class_obj
= \null
$job_applicant_location_class_obj
protected
mixed
$job_applicant_location_class_obj
= \null
$job_applicant_membership_class_obj
protected
mixed
$job_applicant_membership_class_obj
= \null
$job_applicant_reference_class_obj
protected
mixed
$job_applicant_reference_class_obj
= \null
$job_applicant_skill_class_obj
protected
mixed
$job_applicant_skill_class_obj
= \null
$job_application_class_obj
protected
mixed
$job_application_class_obj
= \null
$main_class_obj
protected
mixed
$main_class_obj
= \null
$pager_obj
protected
mixed
$pager_obj
= \null
$permission
protected
mixed
$permission
= \null
$progress_bar_obj
protected
mixed
$progress_bar_obj
= \null
$recruitment_portal_config_class_obj
protected
mixed
$recruitment_portal_config_class_obj
= \null
Methods
__construct()
APIJobApplicantPortal constructor.
public
__construct() : mixed
Return values
mixed —calcExperience()
public
calcExperience(int $first_used_date[, int $last_used_date = null ]) : array<string|int, mixed>|bool
Parameters
- $first_used_date : int
-
EPOCH
- $last_used_date : int = null
-
EPOCH
Return values
array<string|int, mixed>|bool —convertAPIReturnHandlerToValidatorObject()
Take a API ReturnHandler array and pulls out the Validation errors/warnings to be merged back into another Validator This is useful for calling one API function from another one when their are sub-classes.
public
convertAPIReturnHandlerToValidatorObject( $api_retarr[, bool $validator_obj = false ]) : bool|Validator
Parameters
Return values
bool|Validator —convertToMultipleRecords()
public
convertToMultipleRecords(array<string|int, mixed> $data) : array<string|int, mixed>
Parameters
- $data : array<string|int, mixed>
Return values
array<string|int, mixed> —convertToSingleRecord()
public
convertToSingleRecord(array<string|int, mixed> $data) : mixed
Parameters
- $data : array<string|int, mixed>
Return values
mixed —deleteDocument()
Delete one or more documents.
public
deleteDocument(array<string|int, mixed> $data[, int $object_type_id = null ]) : array<string|int, mixed>
Parameters
- $data : array<string|int, mixed>
-
document data
- $object_type_id : int = null
-
ID
Return values
array<string|int, mixed> —deleteJobApplicantEducation()
Delete one or more.
public
deleteJobApplicantEducation(array<string|int, mixed> $data) : array<string|int, mixed>
Parameters
- $data : array<string|int, mixed>
-
job applicant education data
Return values
array<string|int, mixed> —deleteJobApplicantEmployment()
Delete one or more.
public
deleteJobApplicantEmployment(array<string|int, mixed> $data) : array<string|int, mixed>
Parameters
- $data : array<string|int, mixed>
-
job applicant Employment data
Return values
array<string|int, mixed> —deleteJobApplicantLanguage()
Delete one or more.
public
deleteJobApplicantLanguage(array<string|int, mixed> $data) : array<string|int, mixed>
Parameters
- $data : array<string|int, mixed>
-
job applicant language data
Return values
array<string|int, mixed> —deleteJobApplicantLicense()
Delete one or more.
public
deleteJobApplicantLicense(array<string|int, mixed> $data) : array<string|int, mixed>
Parameters
- $data : array<string|int, mixed>
-
job applicant license data
Return values
array<string|int, mixed> —deleteJobApplicantLocation()
Delete one or more.
public
deleteJobApplicantLocation(array<string|int, mixed> $data) : array<string|int, mixed>
Parameters
- $data : array<string|int, mixed>
-
job applicant location data
Return values
array<string|int, mixed> —deleteJobApplicantMembership()
Delete one or more.
public
deleteJobApplicantMembership(array<string|int, mixed> $data) : array<string|int, mixed>
Parameters
- $data : array<string|int, mixed>
-
job applicant membership data
Return values
array<string|int, mixed> —deleteJobApplicantReference()
Delete one or more.
public
deleteJobApplicantReference(array<string|int, mixed> $data) : array<string|int, mixed>
Parameters
- $data : array<string|int, mixed>
-
job applicant Reference data
Return values
array<string|int, mixed> —deleteJobApplicantSkill()
Delete one or more.
public
deleteJobApplicantSkill(array<string|int, mixed> $data) : array<string|int, mixed>
Parameters
- $data : array<string|int, mixed>
-
job applicant skill data
Return values
array<string|int, mixed> —deleteJobApplication()
Delete one or more job application.
public
deleteJobApplication(array<string|int, mixed> $data) : array<string|int, mixed>
Parameters
- $data : array<string|int, mixed>
-
job application data
Return values
array<string|int, mixed> —exportRecords()
Download a result_set as a csv.
public
exportRecords(string $format, string $file_name, array<string|int, mixed> $result, array<string|int, mixed> $filter_columns) : array<string|int, mixed>|bool
Parameters
- $format : string
- $file_name : string
- $result : array<string|int, mixed>
- $filter_columns : array<string|int, mixed>
Return values
array<string|int, mixed>|bool —getAPIMessageID()
Returns the API messageID for each individual call.
public
getAPIMessageID() : bool|null
Return values
bool|null —getCurrentCompanyObject()
public
getCurrentCompanyObject() : bool|CompanyFactory
Return values
bool|CompanyFactory —getCurrentUserObject()
public
getCurrentUserObject() : bool|UserFactory
Return values
bool|UserFactory —getCurrentUserPreferenceObject()
public
getCurrentUserPreferenceObject() : bool|UserPreferenceFactory
Return values
bool|UserPreferenceFactory —getDocument()
Get document data for one or more documentes.
public
getDocument([array<string|int, mixed> $data = null ][, bool $disable_paging = false ]) : array<string|int, mixed>|bool
Parameters
- $data : array<string|int, mixed> = null
-
filter data
- $disable_paging : bool = false
Return values
array<string|int, mixed>|bool —getDocumentDefaultData()
Get default document data for creating new documentes.
public
getDocumentDefaultData() : array<string|int, mixed>
Return values
array<string|int, mixed> —getJobApplicant()
Get job applicant data for one or more job applicant.
public
getJobApplicant([array<string|int, mixed> $data = null ][, bool $disable_paging = false ]) : array<string|int, mixed>
Parameters
- $data : array<string|int, mixed> = null
-
filter data
- $disable_paging : bool = false
Return values
array<string|int, mixed> —getJobApplicantEducation()
Get job applicant education data for one or more.
public
getJobApplicantEducation([array<string|int, mixed> $data = null ][, bool $disable_paging = false ]) : array<string|int, mixed>
Parameters
- $data : array<string|int, mixed> = null
-
filter data
- $disable_paging : bool = false
Return values
array<string|int, mixed> —getJobApplicantEducationDefaultData()
Get default job applicant education data for creating new .
public
getJobApplicantEducationDefaultData() : array<string|int, mixed>
Return values
array<string|int, mixed> —getJobApplicantEducationOptions()
Bridge to job applicant education class getOptions factory.
public
getJobApplicantEducationOptions( $name[, null $parent = null ]) : bool
Parameters
Return values
bool —getJobApplicantEmployment()
Get job applicant Employment data for one or more.
public
getJobApplicantEmployment([array<string|int, mixed> $data = null ][, bool $disable_paging = false ]) : array<string|int, mixed>
Parameters
- $data : array<string|int, mixed> = null
-
filter data
- $disable_paging : bool = false
Return values
array<string|int, mixed> —getJobApplicantEmploymentDefaultData()
Get default job applicant Employment data.
public
getJobApplicantEmploymentDefaultData() : array<string|int, mixed>
Return values
array<string|int, mixed> —getJobApplicantEmploymentOptions()
Bridge to job applicant employment class getOptions factory.
public
getJobApplicantEmploymentOptions( $name[, null $parent = null ]) : bool
Parameters
Return values
bool —getJobApplicantLanguage()
Get job applicant language data for one or more.
public
getJobApplicantLanguage([array<string|int, mixed> $data = null ][, bool $disable_paging = false ]) : array<string|int, mixed>
Parameters
- $data : array<string|int, mixed> = null
-
filter data
- $disable_paging : bool = false
Return values
array<string|int, mixed> —getJobApplicantLanguageDefaultData()
Get default job applicant language data for creating new .
public
getJobApplicantLanguageDefaultData() : array<string|int, mixed>
Return values
array<string|int, mixed> —getJobApplicantLanguageOptions()
Bridge to job applicant language class getOptions factory.
public
getJobApplicantLanguageOptions( $name[, null $parent = null ]) : bool
Parameters
Return values
bool —getJobApplicantLicense()
Get job applicant license data for one or more.
public
getJobApplicantLicense([array<string|int, mixed> $data = null ][, bool $disable_paging = false ]) : array<string|int, mixed>
Parameters
- $data : array<string|int, mixed> = null
-
filter data
- $disable_paging : bool = false
Return values
array<string|int, mixed> —getJobApplicantLicenseDefaultData()
Get default job applicant license data for creating new .
public
getJobApplicantLicenseDefaultData() : array<string|int, mixed>
Return values
array<string|int, mixed> —getJobApplicantLicenseOptions()
Bridge to job applicant license class getOptions factory.
public
getJobApplicantLicenseOptions( $name[, null $parent = null ]) : bool
Parameters
Return values
bool —getJobApplicantLocation()
Get job applicant location data for one or more.
public
getJobApplicantLocation([array<string|int, mixed> $data = null ][, bool $disable_paging = false ]) : array<string|int, mixed>
Parameters
- $data : array<string|int, mixed> = null
-
filter data
- $disable_paging : bool = false
Return values
array<string|int, mixed> —getJobApplicantLocationDefaultData()
Get default job applicant location data.
public
getJobApplicantLocationDefaultData() : array<string|int, mixed>
Return values
array<string|int, mixed> —getJobApplicantLocationOptions()
Bridge to job applicant location class getOptions factory.
public
getJobApplicantLocationOptions( $name[, null $parent = null ]) : bool
Parameters
Return values
bool —getJobApplicantMembership()
Get job applicant membership data for one or more.
public
getJobApplicantMembership([array<string|int, mixed> $data = null ][, bool $disable_paging = false ]) : array<string|int, mixed>
Parameters
- $data : array<string|int, mixed> = null
-
filter data
- $disable_paging : bool = false
Return values
array<string|int, mixed> —getJobApplicantMembershipDefaultData()
Get default job applicant membership data for creating new .
public
getJobApplicantMembershipDefaultData() : array<string|int, mixed>
Return values
array<string|int, mixed> —getJobApplicantMembershipOptions()
Bridge to job applicant membership class getOptions factory.
public
getJobApplicantMembershipOptions( $name[, null $parent = null ]) : bool
Parameters
Return values
bool —getJobApplicantOptions()
Get options for dropdown boxes.
public
getJobApplicantOptions(string $name[, mixed $parent = null ]) : array<string|int, mixed>|bool
Parameters
- $name : string
-
Name of options to return, ie: 'columns', 'type', 'status'
- $parent : mixed = null
-
Parent name/ID of options to return if data is in hierarchical format. (ie: Province)
Return values
array<string|int, mixed>|bool —getJobApplicantReference()
Get job applicant Reference data for one or more.
public
getJobApplicantReference([array<string|int, mixed> $data = null ][, bool $disable_paging = false ]) : array<string|int, mixed>
Parameters
- $data : array<string|int, mixed> = null
-
filter data
- $disable_paging : bool = false
Return values
array<string|int, mixed> —getJobApplicantReferenceDefaultData()
Get default job applicant Reference data.
public
getJobApplicantReferenceDefaultData() : array<string|int, mixed>
Return values
array<string|int, mixed> —getJobApplicantReferenceOptions()
Bridge to job applicant reference class getOptions factory.
public
getJobApplicantReferenceOptions( $name[, null $parent = null ]) : bool
Parameters
Return values
bool —getJobApplicantSkill()
Get job applicant skill data for one or more.
public
getJobApplicantSkill([array<string|int, mixed> $data = null ][, bool $disable_paging = false ]) : array<string|int, mixed>
Parameters
- $data : array<string|int, mixed> = null
-
filter data
- $disable_paging : bool = false
Return values
array<string|int, mixed> —getJobApplicantSkillDefaultData()
Get default job applicant skill data for creating new .
public
getJobApplicantSkillDefaultData() : array<string|int, mixed>
Return values
array<string|int, mixed> —getJobApplicantSkillOptions()
Bridge to job applicant skill class getOptions factory.
public
getJobApplicantSkillOptions( $name[, null $parent = null ]) : bool
Parameters
Return values
bool —getJobApplication()
Get job application data for one or more job application.
public
getJobApplication([array<string|int, mixed> $data = null ][, bool $disable_paging = false ]) : array<string|int, mixed>
Parameters
- $data : array<string|int, mixed> = null
-
filter data
- $disable_paging : bool = false
Return values
array<string|int, mixed> —getMainClassObject()
public
getMainClassObject() : string
Return values
string —getNextInsertID()
public
getNextInsertID() : string
Return values
string —getOptions()
Bridge to main class getOptions factory.
public
getOptions([bool $name = false ][, string|int $parent = null ]) : array<string|int, mixed>|bool
Parameters
- $name : bool = false
- $parent : string|int = null
Return values
array<string|int, mixed>|bool —getOptionsBatch()
Bridge multiple batched requests to main class getOptions factory.
public
getOptionsBatch([array<string|int, mixed> $requested_options = [] ]) : array<string|int, mixed>
Parameters
- $requested_options : array<string|int, mixed> = []
Return values
array<string|int, mixed> —getPagerData()
public
getPagerData() : array<string|int, mixed>|bool
Return values
array<string|int, mixed>|bool —getPagerObject()
public
getPagerObject() : Pager
Return values
Pager —getPermissionChildren()
public
getPermissionChildren() : array<string|int, mixed>
Return values
array<string|int, mixed> —getPermissionObject()
public
getPermissionObject() : bool|null|Permission
Return values
bool|null|Permission —getProgressBarObject()
public
getProgressBarObject() : null|ProgressBar
Return values
null|ProgressBar —getProtocolVersion()
public
getProtocolVersion() : int
Return values
int —getRecruitmentPortalAvailabelFields()
public
getRecruitmentPortalAvailabelFields([null $portal_settings = null ]) : array<string|int, mixed>
Parameters
- $portal_settings : null = null
Return values
array<string|int, mixed> —getRecruitmentPortalConfig()
public
getRecruitmentPortalConfig([null $data = null ][, bool $disable_paging = true ]) : array<string|int, mixed>|bool
Parameters
- $data : null = null
- $disable_paging : bool = true
Return values
array<string|int, mixed>|bool —getRecruitmentPortalConfigOptions()
public
getRecruitmentPortalConfigOptions([bool $name = false ][, null $parent = null ]) : bool
Parameters
- $name : bool = false
- $parent : null = null
Return values
bool —getVariableToFunctionMap()
Bridge to main class getVariableToFunctionMap factory.
public
getVariableToFunctionMap(string $name[, string|int $parent = null ]) : array<string|int, mixed>
Parameters
- $name : string
- $parent : string|int = null
Return values
array<string|int, mixed> —handlePermissionFilterColumns()
In cases where data can be displayed in just a list_view (dropdown boxes), ie: branch, department, job, task in In/Out punch view restrict the dropdown box to just a subset of columns, so not all data is shown.
public
handlePermissionFilterColumns(array<string|int, mixed> $filter_columns, array<string|int, mixed> $allowed_columns) : array<string|int, mixed>|null
Parameters
- $filter_columns : array<string|int, mixed>
- $allowed_columns : array<string|int, mixed>
Return values
array<string|int, mixed>|null —handleRecordValidationResults()
public
handleRecordValidationResults(object|bool $validator, array<string|int, mixed> $validator_stats, int $key, array<string|int, mixed>|bool $save_result[, bool $user_generic_status_batch_id = false ][, mixed $system_job_queue = false ]) : array<string|int, mixed>
Parameters
- $validator : object|bool
- $validator_stats : array<string|int, mixed>
- $key : int
- $save_result : array<string|int, mixed>|bool
- $user_generic_status_batch_id : bool = false
- $system_job_queue : mixed = false
Return values
array<string|int, mixed> —initializeFilterAndPager()
public
initializeFilterAndPager(array<string|int, mixed> $data[, bool $disable_paging = false ]) : array<string|int, mixed>|bool
Parameters
- $data : array<string|int, mixed>
- $disable_paging : bool = false
Return values
array<string|int, mixed>|bool —isProgressBarStarted()
public
isProgressBarStarted() : bool
Return values
bool —returnHandler()
Controls returning information to client in a standard format.
public
returnHandler([bool $retval = true ][, bool $code = false ][, bool $description = false ][, bool $details = false ][, bool $validator_stats = false ][, bool $user_generic_status_batch_id = false ][, bool $request_data = false ][, bool $system_job_queue = false ]) : array<string|int, mixed>|bool
FIXME: Need to return the original request (with any modified values due to restrictions/validation issues) Also need to return paging data variables here too, as JSON can't make multiple calls. In order to do this we need to always return a special data structure that includes this information. static function returnHandler( $retval = TRUE, $args = array( 'code' => FALSE, 'description' => FALSE, 'details' = FALSE, 'validator_stats' => FALSE, 'user_generic_status_batch_id' => FALSE ) ) { The above will require too many changes, just add two more variables at the end, as it will only really be used by API->get*() functions. FIXME: Use a requestHandler() to handle all input requests, so we can parse out things like validate_only, ignore_warning (for user acknowledgable warnings) and handling all parameter parsing in a central place. static function returnHandler( $retval = TRUE, $code = FALSE, $description = FALSE, $details = FALSE, $validator_stats = FALSE, $user_generic_status_batch_id = FALSE, $request = FALSE, $pager = FALSE ) {
Parameters
- $retval : bool = true
- $code : bool = false
- $description : bool = false
- $details : bool = false
- $validator_stats : bool = false
- $user_generic_status_batch_id : bool = false
- $request_data : bool = false
- $system_job_queue : bool = false
Return values
array<string|int, mixed>|bool —setAPIMessageID()
public
setAPIMessageID(string $id) : bool
Parameters
- $id : string
-
UUID
Return values
bool —setDocument()
Set document data for one or more documentes.
public
setDocument(array<string|int, mixed> $data[, bool $validate_only = false ][, bool $ignore_warning = true ]) : array<string|int, mixed>
Parameters
- $data : array<string|int, mixed>
-
document data
- $validate_only : bool = false
- $ignore_warning : bool = true
Return values
array<string|int, mixed> —setJobApplicant()
Set job applicant data for one or more job applicant.
public
setJobApplicant(array<string|int, mixed> $data[, bool $validate_only = false ][, bool $ignore_warning = true ]) : array<string|int, mixed>
Parameters
- $data : array<string|int, mixed>
-
job applicant data
- $validate_only : bool = false
- $ignore_warning : bool = true
Return values
array<string|int, mixed> —setJobApplicantEducation()
Set job applicant education data for one or more.
public
setJobApplicantEducation(array<string|int, mixed> $data[, bool $validate_only = false ][, bool $ignore_warning = true ]) : array<string|int, mixed>
Parameters
- $data : array<string|int, mixed>
-
job applicant education data
- $validate_only : bool = false
- $ignore_warning : bool = true
Return values
array<string|int, mixed> —setJobApplicantEmployment()
Set job applicant Employment data for one or more.
public
setJobApplicantEmployment(array<string|int, mixed> $data[, bool $validate_only = false ][, bool $ignore_warning = true ]) : array<string|int, mixed>
Parameters
- $data : array<string|int, mixed>
-
job applicant Employment data
- $validate_only : bool = false
- $ignore_warning : bool = true
Return values
array<string|int, mixed> —setJobApplicantLanguage()
Set job applicant language data for one or more.
public
setJobApplicantLanguage(array<string|int, mixed> $data[, bool $validate_only = false ][, bool $ignore_warning = true ]) : array<string|int, mixed>
Parameters
- $data : array<string|int, mixed>
-
job applicant language data
- $validate_only : bool = false
- $ignore_warning : bool = true
Return values
array<string|int, mixed> —setJobApplicantLicense()
Set job applicant license data for one or more.
public
setJobApplicantLicense(array<string|int, mixed> $data[, bool $validate_only = false ][, bool $ignore_warning = true ]) : array<string|int, mixed>
Parameters
- $data : array<string|int, mixed>
-
job applicant license data
- $validate_only : bool = false
- $ignore_warning : bool = true
Return values
array<string|int, mixed> —setJobApplicantLocation()
Set job applicant location data for one or more.
public
setJobApplicantLocation(array<string|int, mixed> $data[, bool $validate_only = false ][, bool $ignore_warning = true ]) : array<string|int, mixed>
Parameters
- $data : array<string|int, mixed>
-
job applicant location data
- $validate_only : bool = false
- $ignore_warning : bool = true
Return values
array<string|int, mixed> —setJobApplicantMembership()
Set job applicant membership data for one or more.
public
setJobApplicantMembership(array<string|int, mixed> $data[, bool $validate_only = false ][, bool $ignore_warning = true ]) : array<string|int, mixed>
Parameters
- $data : array<string|int, mixed>
-
job applicant membership data
- $validate_only : bool = false
- $ignore_warning : bool = true
Return values
array<string|int, mixed> —setJobApplicantReference()
Set job applicant Reference data for one or more.
public
setJobApplicantReference(array<string|int, mixed> $data[, bool $validate_only = false ][, bool $ignore_warning = true ]) : array<string|int, mixed>
Parameters
- $data : array<string|int, mixed>
-
job applicant Reference data
- $validate_only : bool = false
- $ignore_warning : bool = true
Return values
array<string|int, mixed> —setJobApplicantSkill()
Set job applicant skill data for one or more.
public
setJobApplicantSkill(array<string|int, mixed> $data[, bool $validate_only = false ][, bool $ignore_warning = true ]) : array<string|int, mixed>
Parameters
- $data : array<string|int, mixed>
-
job applicant skill data
- $validate_only : bool = false
- $ignore_warning : bool = true
Return values
array<string|int, mixed> —setJobApplication()
Set job application data for one or more job application.
public
setJobApplication(array<string|int, mixed> $data[, bool $validate_only = false ][, bool $ignore_warning = true ]) : array<string|int, mixed>
Parameters
- $data : array<string|int, mixed>
-
job application data
- $validate_only : bool = false
- $ignore_warning : bool = true
Return values
array<string|int, mixed> —setMainClassObject()
Allow storing the main class object persistently in memory, so we can build up other variables to help out things like getOptions() Mainly used for the APIReport class.
public
setMainClassObject(object $obj) : bool
Parameters
- $obj : object
Return values
bool —setPagerObject()
public
setPagerObject(object $lf) : bool
Parameters
- $lf : object
Return values
bool —setProgressBarObject()
public
setProgressBarObject( $progress_bar_obj) : bool
Parameters
Return values
bool —setValidationArray()
public
setValidationArray(array<string|int, Validator> $validator_obj_arr[, string $record_label = null ]) : array<string|int, mixed>|bool
Parameters
- $validator_obj_arr : array<string|int, Validator>
-
Array of Validator objects.
- $record_label : string = null
-
Prefix for record label if performing a mass function to differentiate one record from another.
Return values
array<string|int, mixed>|bool —stripReturnHandler()
public
stripReturnHandler(mixed $retarr) : mixed
Parameters
- $retarr : mixed
Return values
mixed —validateDocument()
Validate document data for one or more documentes.
public
validateDocument(array<string|int, mixed> $data) : array<string|int, mixed>
Parameters
- $data : array<string|int, mixed>
-
document data
Return values
array<string|int, mixed> —validateJobApplicant()
Validate job applicant data for one or more job applicant.
public
validateJobApplicant(array<string|int, mixed> $data) : array<string|int, mixed>
Parameters
- $data : array<string|int, mixed>
-
job applicant data
Return values
array<string|int, mixed> —validateJobApplicantEducation()
Validate job applicant education data for one or more.
public
validateJobApplicantEducation(array<string|int, mixed> $data) : array<string|int, mixed>
Parameters
- $data : array<string|int, mixed>
-
job applicant education data
Return values
array<string|int, mixed> —validateJobApplicantEmployment()
Validate job applicant Employment data for one or more.
public
validateJobApplicantEmployment(array<string|int, mixed> $data) : array<string|int, mixed>
Parameters
- $data : array<string|int, mixed>
-
job applicant Employment data
Return values
array<string|int, mixed> —validateJobApplicantLanguage()
Validate job applicant language data for one or more.
public
validateJobApplicantLanguage(array<string|int, mixed> $data) : array<string|int, mixed>
Parameters
- $data : array<string|int, mixed>
-
job applicant language data
Return values
array<string|int, mixed> —validateJobApplicantLicense()
Validate job applicant license data for one or more.
public
validateJobApplicantLicense(array<string|int, mixed> $data) : array<string|int, mixed>
Parameters
- $data : array<string|int, mixed>
-
job applicant license data
Return values
array<string|int, mixed> —validateJobApplicantLocation()
Validate job applicant location data for one or more.
public
validateJobApplicantLocation(array<string|int, mixed> $data) : array<string|int, mixed>
Parameters
- $data : array<string|int, mixed>
-
job applicant location data
Return values
array<string|int, mixed> —validateJobApplicantMembership()
Validate job applicant membership data for one or more.
public
validateJobApplicantMembership(array<string|int, mixed> $data) : array<string|int, mixed>
Parameters
- $data : array<string|int, mixed>
-
job applicant membership data
Return values
array<string|int, mixed> —validateJobApplicantReference()
Validate job applicant Reference data for one or more.
public
validateJobApplicantReference(array<string|int, mixed> $data) : array<string|int, mixed>
Parameters
- $data : array<string|int, mixed>
-
job applicant Reference data
Return values
array<string|int, mixed> —validateJobApplicantSkill()
Validate job applicant skill data for one or more.
public
validateJobApplicantSkill(array<string|int, mixed> $data) : array<string|int, mixed>
Parameters
- $data : array<string|int, mixed>
-
job applicant skill data