APIInstall
extends APIFactory
in package
Table of Contents
- $data : mixed
- $api_message_id : mixed
- $current_company : mixed
- $current_user : mixed
- $current_user_prefs : mixed
- $main_class : mixed
- $main_class_obj : mixed
- $pager_obj : mixed
- $permission : mixed
- $progress_bar_obj : mixed
- __construct() : mixed
- APIInstall constructor.
- 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
- createDatabase() : array<string|int, mixed>|bool
- exportRecords() : array<string|int, mixed>|bool
- Download a result_set as a csv.
- getAPIMessageID() : bool|null
- Returns the API messageID for each individual call.
- getCompany() : array<string|int, mixed>|bool
- getCurrentCompanyObject() : bool|CompanyFactory
- getCurrentUserObject() : bool|UserFactory
- getCurrentUserPreferenceObject() : bool|UserPreferenceFactory
- getDatabaseConfig() : array<string|int, mixed>|bool
- getDatabaseSchema() : array<string|int, mixed>|bool
- getLicense() : array<string|int, mixed>|bool
- getMainClassObject() : string
- getMaintenanceJobs() : array<string|int, mixed>|bool
- 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
- getProvinceOptions() : array<string|int, mixed>|bool
- getRequirements() : array<string|int, mixed>|bool
- getSystemSettings() : array<string|int, mixed>|bool
- getUser() : array<string|int, mixed>|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
- installDone() : array<string|int, mixed>|bool
- isProgressBarStarted() : bool
- postUpgrade() : array<string|int, mixed>|bool
- returnHandler() : array<string|int, mixed>|bool
- Controls returning information to client in a standard format.
- setAPIMessageID() : bool
- setCompany() : array<string|int, mixed>|bool
- setDatabaseSchema() : array<string|int, mixed>|bool
- 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
- setSystemSettings() : array<string|int, mixed>|bool
- setUser() : array<string|int, mixed>|bool
- setValidationArray() : array<string|int, mixed>|bool
- stripReturnHandler() : mixed
- testConnection() : array<string|int, mixed>|bool
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
$main_class
protected
mixed
$main_class
= 'Install'
$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
Methods
__construct()
APIInstall constructor.
public
__construct() : mixed
Return values
mixed —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 —createDatabase()
public
createDatabase( $data) : array<string|int, mixed>|bool
Parameters
Return values
array<string|int, mixed>|bool —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 —getCompany()
public
getCompany([string $company_id = null ]) : array<string|int, mixed>|bool
Parameters
- $company_id : string = null
-
UUID
Return values
array<string|int, mixed>|bool —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 —getDatabaseConfig()
public
getDatabaseConfig() : array<string|int, mixed>|bool
Return values
array<string|int, mixed>|bool —getDatabaseSchema()
public
getDatabaseSchema() : array<string|int, mixed>|bool
Return values
array<string|int, mixed>|bool —getLicense()
public
getLicense() : array<string|int, mixed>|bool
Return values
array<string|int, mixed>|bool —getMainClassObject()
public
getMainClassObject() : string
Return values
string —getMaintenanceJobs()
public
getMaintenanceJobs([null $data = null ]) : array<string|int, mixed>|bool
Parameters
- $data : null = null
Return values
array<string|int, mixed>|bool —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 —getProvinceOptions()
public
getProvinceOptions( $country) : array<string|int, mixed>|bool
Parameters
Return values
array<string|int, mixed>|bool —getRequirements()
public
getRequirements(int $external_installer) : array<string|int, mixed>|bool
Parameters
- $external_installer : int
Return values
array<string|int, mixed>|bool —getSystemSettings()
public
getSystemSettings() : array<string|int, mixed>|bool
Return values
array<string|int, mixed>|bool —getUser()
public
getUser(string $company_id, string $user_id) : array<string|int, mixed>|bool
Parameters
- $company_id : string
-
UUID
- $user_id : string
-
UUID
Return values
array<string|int, mixed>|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 —installDone()
public
installDone( $upgrade) : array<string|int, mixed>|bool
Parameters
Return values
array<string|int, mixed>|bool —isProgressBarStarted()
public
isProgressBarStarted() : bool
Return values
bool —postUpgrade()
public
postUpgrade() : array<string|int, mixed>|bool
Return values
array<string|int, mixed>|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 —setCompany()
public
setCompany( $company_data) : array<string|int, mixed>|bool
Parameters
Return values
array<string|int, mixed>|bool —setDatabaseSchema()
public
setDatabaseSchema(int $external_installer) : array<string|int, mixed>|bool
Parameters
- $external_installer : int
Return values
array<string|int, mixed>|bool —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 —setSystemSettings()
public
setSystemSettings( $data, int $external_installer) : array<string|int, mixed>|bool
Parameters
Return values
array<string|int, mixed>|bool —setUser()
public
setUser( $user_data, int $external_installer) : array<string|int, mixed>|bool
Parameters
Return values
array<string|int, mixed>|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 —testConnection()
public
testConnection( $data) : array<string|int, mixed>|bool