APIInstall - staffcheck/api GitHub Wiki

APIInstall

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

Properties

$main_class

protected mixed $main_class = 'Install'
  • Visibility: protected

$data

public mixed $data = array()
  • Visibility: public

$main_class_obj

protected mixed $main_class_obj = NULL
  • Visibility: protected

$AMF_message_id

protected mixed $AMF_message_id = NULL
  • Visibility: protected

$pager_obj

protected mixed $pager_obj = NULL
  • Visibility: protected

$current_company

protected mixed $current_company = NULL
  • Visibility: protected

$current_user

protected mixed $current_user = NULL
  • Visibility: protected

$current_user_prefs

protected mixed $current_user_prefs = NULL
  • Visibility: protected

$permission

protected mixed $permission = NULL
  • Visibility: protected

$progress_bar_obj

protected mixed $progress_bar_obj = NULL
  • Visibility: protected

Methods

__construct

mixed APIFactory::__construct()

APIFactory constructor.

  • Visibility: public
  • This method is defined by APIFactory

getLicense

array|boolean APIInstall::getLicense()
  • Visibility: public

getRequirements

array|boolean APIInstall::getRequirements(integer $external_installer)
  • Visibility: public

Arguments

  • $external_installer integer

testConnection

array|boolean APIInstall::testConnection($data)
  • Visibility: public

Arguments

  • $data mixed

getDatabaseConfig

array|boolean APIInstall::getDatabaseConfig()
  • Visibility: public

createDatabase

array|boolean APIInstall::createDatabase($data)
  • Visibility: public

Arguments

  • $data mixed

getDatabaseSchema

array|boolean APIInstall::getDatabaseSchema()
  • Visibility: public

setDatabaseSchema

array|boolean APIInstall::setDatabaseSchema(integer $external_installer)
  • Visibility: public

Arguments

  • $external_installer integer

postUpgrade

array|boolean APIInstall::postUpgrade()
  • Visibility: public

installDone

array|boolean APIInstall::installDone($upgrade)
  • Visibility: public

Arguments

  • $upgrade mixed

setSystemSettings

array|boolean APIInstall::setSystemSettings($data, integer $external_installer)
  • Visibility: public

Arguments

  • $data mixed
  • $external_installer integer

getSystemSettings

array|boolean APIInstall::getSystemSettings()
  • Visibility: public

getCompany

array|boolean APIInstall::getCompany(string $company_id)
  • Visibility: public

Arguments

  • $company_id string - UUID

setCompany

array|boolean APIInstall::setCompany($company_data)
  • Visibility: public

Arguments

  • $company_data mixed

getUser

array|boolean APIInstall::getUser(string $company_id, string $user_id)
  • Visibility: public

Arguments

  • $company_id string - UUID
  • $user_id string - UUID

setUser

array|boolean APIInstall::setUser($user_data, integer $external_installer)
  • Visibility: public

Arguments

  • $user_data mixed
  • $external_installer integer

getProvinceOptions

array|boolean APIInstall::getProvinceOptions($country)
  • Visibility: public

Arguments

  • $country mixed

getMaintenanceJobs

array|boolean APIInstall::getMaintenanceJobs(null $data)
  • Visibility: public

Arguments

  • $data null

getProtocolVersion

integer APIFactory::getProtocolVersion()
  • Visibility: public
  • This method is defined by APIFactory

getAMFMessageID

boolean|null APIFactory::getAMFMessageID()
  • Visibility: public
  • This method is defined by APIFactory

setAMFMessageID

boolean APIFactory::setAMFMessageID(string $id)
  • Visibility: public
  • This method is defined by APIFactory

Arguments

  • $id string - UUID

getCurrentCompanyObject

boolean|\CompanyFactory APIFactory::getCurrentCompanyObject()
  • Visibility: public
  • This method is defined by APIFactory

getCurrentUserObject

boolean|\UserFactory APIFactory::getCurrentUserObject()
  • Visibility: public
  • This method is defined by APIFactory

getCurrentUserPreferenceObject

boolean|\UserPreferenceFactory APIFactory::getCurrentUserPreferenceObject()
  • Visibility: public
  • This method is defined by APIFactory

getPermissionObject

boolean|null|\Permission APIFactory::getPermissionObject()
  • Visibility: public
  • This method is defined by APIFactory

getProgressBarObject

null|\ProgressBar APIFactory::getProgressBarObject()
  • Visibility: public
  • This method is defined by APIFactory

setPagerObject

boolean APIFactory::setPagerObject(object $lf)
  • Visibility: public
  • This method is defined by APIFactory

Arguments

  • $lf object

getPagerData

array|boolean APIFactory::getPagerData()
  • Visibility: public
  • This method is defined by APIFactory

setMainClassObject

boolean APIFactory::setMainClassObject(object $obj)
  • Visibility: public
  • This method is defined by APIFactory

Arguments

  • $obj object

getMainClassObject

string APIFactory::getMainClassObject()
  • Visibility: public
  • This method is defined by APIFactory

initializeFilterAndPager

array|boolean APIFactory::initializeFilterAndPager(array $data, boolean $disable_paging)
  • Visibility: public
  • This method is defined by APIFactory

Arguments

  • $data array
  • $disable_paging boolean

handlePermissionFilterColumns

array|null APIFactory::handlePermissionFilterColumns(array $filter_columns, array $allowed_columns)
  • Visibility: public
  • This method is defined by APIFactory

Arguments

  • $filter_columns array
  • $allowed_columns array

convertToSingleRecord

mixed APIFactory::convertToSingleRecord(array $data)
  • Visibility: public
  • This method is defined by APIFactory

Arguments

  • $data array

convertToMultipleRecords

array APIFactory::convertToMultipleRecords(array $data)
  • Visibility: public
  • This method is defined by APIFactory

Arguments

  • $data array

exportRecords

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

Arguments

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

getNextInsertID

string APIFactory::getNextInsertID()
  • Visibility: public
  • This method is defined by APIFactory

getPermissionChildren

array APIFactory::getPermissionChildren()
  • Visibility: public
  • This method is defined by APIFactory

returnHandler

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

Arguments

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

stripReturnHandler

mixed APIFactory::stripReturnHandler(mixed $retarr)
  • Visibility: public
  • This method is defined by APIFactory

Arguments

  • $retarr mixed

getOptions

array|boolean APIFactory::getOptions(boolean $name, string|integer $parent)
  • Visibility: public
  • This method is defined by APIFactory

Arguments

  • $name boolean
  • $parent string|integer

getVariableToFunctionMap

array APIFactory::getVariableToFunctionMap(string $name, string|integer $parent)
  • Visibility: public
  • This method is defined by APIFactory

Arguments

  • $name string
  • $parent string|integer

convertAPIReturnHandlerToValidatorObject

boolean|\Validator APIFactory::convertAPIReturnHandlerToValidatorObject($api_retarr, boolean $validator_obj)
  • Visibility: public
  • This method is defined by APIFactory

Arguments

  • $api_retarr mixed
  • $validator_obj boolean

setValidationArray

array|boolean APIFactory::setValidationArray(string $primary_validator, string $secondary_validator, boolean $tertiary_validator)
  • Visibility: public
  • This method is defined by APIFactory

Arguments

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

handleRecordValidationResults

array APIFactory::handleRecordValidationResults(object|boolean $validator, array $validator_stats, integer $key, array|boolean $save_result)
  • Visibility: public
  • This method is defined by APIFactory

Arguments

  • $validator object|boolean
  • $validator_stats array
  • $key integer
  • $save_result array|boolean
⚠️ **GitHub.com Fallback** ⚠️