package API\Core
inherited_from \APIFactory

 Methods

__construct()

__construct() 
inherited_from \APIFactory::__construct()

__construct()

__construct() 
Inherited

convertAPIReturnHandlerToValidatorObject()

convertAPIReturnHandlerToValidatorObject($api_retarr, $validator_obj = FALSE
Inherited

Parameters

$api_retarr

$validator_obj

convertToMultipleRecords()

convertToMultipleRecords($data) 
Inherited

Parameters

$data

convertToSingleRecord()

convertToSingleRecord($data) 
Inherited

Parameters

$data

createDatabase()

createDatabase($data) 

Parameters

$data

downloaded a result_set as a csv.

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

Parameters

$format

$file_name

$result

$filter_columns

Returns

arrayboolean

getAMFMessageID()

getAMFMessageID() 
Inherited

getCompany()

getCompany($company_id = NULL

Parameters

$company_id

getCurrentCompanyObject()

getCurrentCompanyObject() 
Inherited

getCurrentUserObject()

getCurrentUserObject() 
Inherited

getCurrentUserPreferenceObject()

getCurrentUserPreferenceObject() 
Inherited

getDatabaseConfig()

getDatabaseConfig() 

getDatabaseSchema()

getDatabaseSchema() 

getLicense()

getLicense() 

getMainClassObject()

getMainClassObject() 
Inherited

getMaintenanceJobs()

getMaintenanceJobs($data = NULL

Parameters

$data

getNextInsertID()

getNextInsertID() 
Inherited

getOptions()

getOptions($name = FALSE, $parent = NULL
Inherited

Parameters

$name

$parent

getPagerData()

getPagerData() 
Inherited

getPermissionChildren()

getPermissionChildren() 
Inherited

getPermissionObject()

getPermissionObject() 
Inherited

getProgressBarObject()

getProgressBarObject() 
Inherited

getProtocolVersion()

getProtocolVersion() 
Inherited

getProvinceOptions()

getProvinceOptions($country) 

Parameters

$country

getRequirements()

getRequirements($external_installer = 0

Parameters

$external_installer

getSystemSettings()

getSystemSettings() 

getUser()

getUser($company_id, $user_id) 

Parameters

$company_id

$user_id

getVariableToFunctionMap()

getVariableToFunctionMap($name, $parent = NULL
Inherited

Parameters

$name

$parent

handlePermissionFilterColumns()

handlePermissionFilterColumns($filter_columns, $allowed_columns) 
Inherited

Parameters

$filter_columns

$allowed_columns

handleRecordValidationResults()

handleRecordValidationResults($validator, $validator_stats, $key, $save_result) 
Inherited

Parameters

$validator

$validator_stats

$key

$save_result

initializeFilterAndPager()

initializeFilterAndPager($data, $disable_paging = FALSE
Inherited

Parameters

$data

$disable_paging

installDone()

installDone($upgrade) 

Parameters

$upgrade

postUpgrade()

postUpgrade() 

returnHandler()

returnHandler($retval = TRUE, $code = FALSE, $description = FALSE, $details = FALSE, $validator_stats = FALSE, $user_generic_status_batch_id = FALSE, $request_data = FALSE
Inherited

Parameters

$retval

$code

$description

$details

$validator_stats

$user_generic_status_batch_id

$request_data

setAMFMessageID()

setAMFMessageID($id) 
Inherited

Parameters

$id

setCompany()

setCompany($company_data) 

Parameters

$company_data

setDatabaseSchema()

setDatabaseSchema($external_installer = 0

Parameters

$external_installer

setMainClassObject()

setMainClassObject($obj) 
Inherited

Parameters

$obj

setPagerObject()

setPagerObject($lf) 
Inherited

Parameters

$lf

setSystemSettings()

setSystemSettings($data, $external_installer = 0

Parameters

$data

$external_installer

setUser()

setUser($user_data, $external_installer = 0

Parameters

$user_data

$external_installer

setValidationArray()

setValidationArray($primary_validator, $secondary_validator, $tertiary_validator = FALSE
Inherited

Parameters

$primary_validator

$secondary_validator

$tertiary_validator

stripReturnHandler()

stripReturnHandler($retarr) 
Inherited

Parameters

$retarr

testConnection()

testConnection($data) 

Parameters

$data

 Properties

 

$data

$data 

Default

array()
 

$AMF_message_id

$AMF_message_id 

Default

NULL
 

$current_company

$current_company 

Default

NULL
 

$current_user

$current_user 

Default

NULL
 

$current_user_prefs

$current_user_prefs 

Default

NULL
 

$main_class

$main_class 

Default

'Install'
 

$main_class_obj

$main_class_obj 

Default

NULL
 

$pager_obj

$pager_obj 

Default

NULL
 

$permission

$permission 

Default

NULL
 

$progress_bar_obj

$progress_bar_obj 

Default

NULL