InstallSchema - staffcheck/api GitHub Wiki

InstallSchema

  • Class name: InstallSchema
  • Namespace:
  • Parent class: Install

Properties

$schema_version

protected mixed $schema_version = NULL
  • Visibility: protected

$obj

protected mixed $obj = NULL
  • Visibility: protected

$temp_db

protected mixed $temp_db = NULL
  • Visibility: protected

$config_vars

public mixed $config_vars = NULL
  • Visibility: public

$database_driver

protected mixed $database_driver = NULL
  • Visibility: protected

$is_upgrade

protected mixed $is_upgrade = FALSE
  • Visibility: protected

$extended_error_messages

protected mixed $extended_error_messages = NULL
  • Visibility: protected

$versions

protected mixed $versions = array('system_version' => APPLICATION_VERSION)
  • Visibility: protected

$progress_bar_obj

protected mixed $progress_bar_obj = NULL
  • Visibility: protected

$AMF_message_id

protected mixed $AMF_message_id = NULL
  • Visibility: protected

$critical_disabled_functions

protected mixed $critical_disabled_functions = array()
  • Visibility: protected

Methods

__construct

mixed Install::__construct()

Install constructor.

  • Visibility: public
  • This method is defined by Install

getSQLFileDirectory

string InstallSchema::getSQLFileDirectory()
  • Visibility: public

getSchemaSQLFilename

string InstallSchema::getSchemaSQLFilename()
  • Visibility: public

getSchemaSQLFileData

mixed InstallSchema::getSchemaSQLFileData()
  • Visibility: public

getObject

boolean|null InstallSchema::getObject()
  • Visibility: private

__call

boolean|mixed InstallSchema::__call($function_name, array $args)
  • Visibility: public

Arguments

  • $function_name mixed
  • $args array

getDatabaseDriver

null Install::getDatabaseDriver()
  • Visibility: public
  • This method is defined by Install

setDatabaseDriver

boolean Install::setDatabaseDriver($driver)
  • Visibility: public
  • This method is defined by Install

Arguments

  • $driver mixed

getProgressBarObject

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

getAMFMessageID

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

setAMFMessageID

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

Arguments

  • $id string - UUID

isInstallMode

boolean Install::isInstallMode()

Read .ini file.

Make sure setup_mode is enabled.

  • Visibility: public
  • This method is defined by Install

setExtendedErrorMessage

boolean Install::setExtendedErrorMessage($key, $msg)
  • Visibility: public
  • This method is defined by Install

Arguments

  • $key mixed
  • $msg mixed

getExtendedErrorMessage

boolean|null|string Install::getExtendedErrorMessage(null $key)
  • Visibility: public
  • This method is defined by Install

Arguments

  • $key null

getTTProductEdition

integer Install::getTTProductEdition()
  • Visibility: public
  • This method is defined by Install

getFullApplicationVersion

string Install::getFullApplicationVersion()
  • Visibility: public
  • This method is defined by Install

getLicenseText

boolean|string Install::getLicenseText()
  • Visibility: public
  • This method is defined by Install

setIsUpgrade

mixed Install::setIsUpgrade($val)
  • Visibility: public
  • This method is defined by Install

Arguments

  • $val mixed

getIsUpgrade

boolean Install::getIsUpgrade()
  • Visibility: public
  • This method is defined by Install

setDatabaseConnection

boolean Install::setDatabaseConnection(object $db_obj)
  • Visibility: public
  • This method is defined by Install

Arguments

  • $db_obj object

getDatabaseConnection

boolean|null Install::getDatabaseConnection()
  • Visibility: public
  • This method is defined by Install

setNewDatabaseConnection

boolean Install::setNewDatabaseConnection($type, $host, $user, $password, $database_name)
  • Visibility: public
  • This method is defined by Install

Arguments

  • $type mixed
  • $host mixed
  • $user mixed
  • $password mixed
  • $database_name mixed

HumanBoolean

string Install::HumanBoolean($bool)
  • Visibility: public
  • This method is defined by Install

Arguments

  • $bool mixed

writeConfigFile

boolean|mixed Install::writeConfigFile($new_config_vars)
  • Visibility: public
  • This method is defined by Install

Arguments

  • $new_config_vars mixed

setVersions

boolean Install::setVersions()
  • Visibility: public
  • This method is defined by Install

checkDatabaseExists

boolean Install::checkDatabaseExists($database_name)
  • Visibility: public
  • This method is defined by Install

Arguments

  • $database_name mixed

createDatabase

boolean Install::createDatabase($database_name)
  • Visibility: public
  • This method is defined by Install

Arguments

  • $database_name mixed

checkTableExists

boolean Install::checkTableExists($table_name)
  • Visibility: public
  • This method is defined by Install

Arguments

  • $table_name mixed

checkSystemSettingTableExists

boolean Install::checkSystemSettingTableExists()
  • Visibility: public
  • This method is defined by Install

getAllSchemaVersions

array Install::getAllSchemaVersions(array $group)
  • Visibility: public
  • This method is defined by Install

Arguments

  • $group array

handleSchemaGroupChange

boolean Install::handleSchemaGroupChange()
  • Visibility: public
  • This method is defined by Install

createSchemaRange

boolean Install::createSchemaRange(null $start_version, null $end_version, array $group)
  • Visibility: public
  • This method is defined by Install

Arguments

  • $start_version null
  • $end_version null
  • $group array

createSchema

boolean Install::createSchema($version)
  • Visibility: public
  • This method is defined by Install

Arguments

  • $version mixed

postCreateSchema

mixed Install::postCreateSchema($schema_version, $create_schema_result)
  • Visibility: public
  • This method is defined by Install

Arguments

  • $schema_version mixed
  • $create_schema_result mixed

initializeSequence

boolean Install::initializeSequence(object $obj, $table, $class, $db_conn)
  • Visibility: public
  • This method is defined by Install

Arguments

  • $obj object
  • $table mixed
  • $class mixed
  • $db_conn mixed

initializeSequences

boolean Install::initializeSequences()
  • Visibility: public
  • This method is defined by Install

getPHPVersion

string Install::getPHPVersion()
  • Visibility: public
  • This method is defined by Install

checkPHPVersion

integer Install::checkPHPVersion(null $php_version)
  • Visibility: public
  • This method is defined by Install

Arguments

  • $php_version null

getDatabaseType

integer|string Install::getDatabaseType(null $type)
  • Visibility: public
  • This method is defined by Install

Arguments

  • $type null

getMemoryLimit

mixed|null Install::getMemoryLimit()
  • Visibility: public
  • This method is defined by Install

getPHPConfigFile

string Install::getPHPConfigFile()
  • Visibility: public
  • This method is defined by Install

getConfigFile

mixed|string Install::getConfigFile()
  • Visibility: public
  • This method is defined by Install

getPHPIncludePath

string Install::getPHPIncludePath()
  • Visibility: public
  • This method is defined by Install

getDatabaseVersion

array|boolean|null Install::getDatabaseVersion()
  • Visibility: public
  • This method is defined by Install

getDatabaseTypeArray

array Install::getDatabaseTypeArray()
  • Visibility: public
  • This method is defined by Install

checkFilePermissions

integer Install::checkFilePermissions()
  • Visibility: public
  • This method is defined by Install

checkFileChecksums

integer Install::checkFileChecksums()
  • Visibility: public
  • This method is defined by Install

checkDatabaseType

integer Install::checkDatabaseType()
  • Visibility: public
  • This method is defined by Install

checkDatabaseVersion

integer Install::checkDatabaseVersion()
  • Visibility: public
  • This method is defined by Install

checkDatabaseSchema

boolean|integer Install::checkDatabaseSchema()
  • Visibility: public
  • This method is defined by Install

isSUDOinstalled

boolean Install::isSUDOinstalled()
  • Visibility: public
  • This method is defined by Install

getWebServerUser

boolean Install::getWebServerUser()
  • Visibility: public
  • This method is defined by Install

getScheduleMaintenanceJobsCommand

boolean|string Install::getScheduleMaintenanceJobsCommand()
  • Visibility: public
  • This method is defined by Install

ScheduleMaintenanceJobs

integer Install::ScheduleMaintenanceJobs()
  • Visibility: public
  • This method is defined by Install

getBaseURL

string Install::getBaseURL()
  • Visibility: public
  • This method is defined by Install

getRecommendedBaseURL

mixed Install::getRecommendedBaseURL()
  • Visibility: public
  • This method is defined by Install

checkBaseURL

integer Install::checkBaseURL()
  • Visibility: public
  • This method is defined by Install

getPHPOpenBaseDir

string Install::getPHPOpenBaseDir()
  • Visibility: public
  • This method is defined by Install

getPHPCLIDirectory

string Install::getPHPCLIDirectory()
  • Visibility: public
  • This method is defined by Install

checkPHPOpenBaseDir

integer Install::checkPHPOpenBaseDir()
  • Visibility: public
  • This method is defined by Install

getPHPCLI

boolean Install::getPHPCLI()
  • Visibility: public
  • This method is defined by Install

checkPHPCLIBinary

integer Install::checkPHPCLIBinary()
  • Visibility: public
  • This method is defined by Install

checkDiskSpace

integer Install::checkDiskSpace()
  • Visibility: public
  • This method is defined by Install

getPHPCLIRequirementsCommand

string Install::getPHPCLIRequirementsCommand()
  • Visibility: public
  • This method is defined by Install

checkPHPCLIRequirements

integer Install::checkPHPCLIRequirements()
  • Visibility: public
  • This method is defined by Install

checkPEAR

integer Install::checkPEAR()
  • Visibility: public
  • This method is defined by Install

checkPEARHTTP_Download

integer Install::checkPEARHTTP_Download()
  • Visibility: public
  • This method is defined by Install

checkPEARValidate

integer Install::checkPEARValidate()
  • Visibility: public
  • This method is defined by Install

checkPEARValidate_Finance

integer Install::checkPEARValidate_Finance()
  • Visibility: public
  • This method is defined by Install

checkPEARValidate_Finance_CreditCard

integer Install::checkPEARValidate_Finance_CreditCard()
  • Visibility: public
  • This method is defined by Install

checkPEARNET_Curl

integer Install::checkPEARNET_Curl()
  • Visibility: public
  • This method is defined by Install

checkPEARMail

integer Install::checkPEARMail()
  • Visibility: public
  • This method is defined by Install

checkPEARMail_Mime

integer Install::checkPEARMail_Mime()
  • Visibility: public
  • This method is defined by Install

checkZIP

integer Install::checkZIP()
  • Visibility: public
  • This method is defined by Install

checkMAIL

integer Install::checkMAIL()
  • Visibility: public
  • This method is defined by Install

checkGETTEXT

integer Install::checkGETTEXT()
  • Visibility: public
  • This method is defined by Install

checkINTL

integer Install::checkINTL()
  • Visibility: public
  • This method is defined by Install

checkBCMATH

integer Install::checkBCMATH()
  • Visibility: public
  • This method is defined by Install

checkMBSTRING

integer Install::checkMBSTRING()
  • Visibility: public
  • This method is defined by Install

checkCALENDAR

integer Install::checkCALENDAR()
  • Visibility: public
  • This method is defined by Install

checkSOAP

integer Install::checkSOAP()
  • Visibility: public
  • This method is defined by Install

checkOpenSSL

integer Install::checkOpenSSL()
  • Visibility: public
  • This method is defined by Install

checkGD

integer Install::checkGD()
  • Visibility: public
  • This method is defined by Install

checkJSON

integer Install::checkJSON()
  • Visibility: public
  • This method is defined by Install

checkCURL

integer Install::checkCURL()
  • Visibility: public
  • This method is defined by Install

checkSimpleXML

integer Install::checkSimpleXML()
  • Visibility: public
  • This method is defined by Install

checkWritableConfigFile

integer Install::checkWritableConfigFile()
  • Visibility: public
  • This method is defined by Install

checkWritableCacheDirectory

integer Install::checkWritableCacheDirectory()
  • Visibility: public
  • This method is defined by Install

checkSafeCacheDirectory

integer Install::checkSafeCacheDirectory()
  • Visibility: public
  • This method is defined by Install

cleanCacheDirectory

boolean Install::cleanCacheDirectory(string $exclude_regex_filter)
  • Visibility: public
  • This method is defined by Install

Arguments

  • $exclude_regex_filter string

cleanOrphanFiles

boolean Install::cleanOrphanFiles()
  • Visibility: public
  • This method is defined by Install

checkCleanCacheDirectory

integer Install::checkCleanCacheDirectory()
  • Visibility: public
  • This method is defined by Install

checkWritableStorageDirectory

integer Install::checkWritableStorageDirectory()
  • Visibility: public
  • This method is defined by Install

checkSafeStorageDirectory

integer Install::checkSafeStorageDirectory()
  • Visibility: public
  • This method is defined by Install

checkWritableLogDirectory

integer Install::checkWritableLogDirectory()
  • Visibility: public
  • This method is defined by Install

checkSafeLogDirectory

integer Install::checkSafeLogDirectory()
  • Visibility: public
  • This method is defined by Install

getCriticalFunctionList

array Install::getCriticalFunctionList()
  • Visibility: public
  • This method is defined by Install

getCriticalDisabledFunctionList

string Install::getCriticalDisabledFunctionList()
  • Visibility: public
  • This method is defined by Install

checkPHPDisabledFunctions

integer Install::checkPHPDisabledFunctions()

Check to see if they have disabled functions in there PHP.ini file.

This can cause all sorts of strange failures, but most often they have system(), exec() and other OS/file system related functions disabled that completely breaks things.

  • Visibility: public
  • This method is defined by Install

checkPHPSafeMode

integer Install::checkPHPSafeMode()
  • Visibility: public
  • This method is defined by Install

checkPHPAllowURLFopen

integer Install::checkPHPAllowURLFopen()
  • Visibility: public
  • This method is defined by Install

checkPHPMemoryLimit

integer Install::checkPHPMemoryLimit()
  • Visibility: public
  • This method is defined by Install

checkPHPMagicQuotesGPC

integer Install::checkPHPMagicQuotesGPC()
  • Visibility: public
  • This method is defined by Install

getCurrentVersion

string Install::getCurrentVersion()
  • Visibility: public
  • This method is defined by Install

getLatestVersion

boolean Install::getLatestVersion()
  • Visibility: public
  • This method is defined by Install

checkVersion

integer Install::checkVersion()
  • Visibility: public
  • This method is defined by Install

checkAllRequirements

integer Install::checkAllRequirements(boolean $post_install_requirements_only, boolean $exclude_check)
  • Visibility: public
  • This method is defined by Install

Arguments

  • $post_install_requirements_only boolean
  • $exclude_check boolean

getFailedRequirements

array|boolean Install::getFailedRequirements(boolean $post_install_requirements_only, boolean $exclude_check)
  • Visibility: public
  • This method is defined by Install

Arguments

  • $post_install_requirements_only boolean
  • $exclude_check boolean

regexConvertToUUIDNoHash

boolean|integer|string Install::regexConvertToUUIDNoHash($matches)

Used by InstallSchema_1100*

  • Visibility: public
  • This method is defined by Install

Arguments

  • $matches mixed

regexConvertToUUID

boolean|integer|string Install::regexConvertToUUID($matches, $include_hash)
  • Visibility: public
  • This method is defined by Install

Arguments

  • $matches mixed
  • $include_hash mixed

convertArrayElementsToUUID

array Install::convertArrayElementsToUUID($array)

Used by InstallSchema_1100* takes a listfactory result set as first argument.

  • Visibility: public
  • This method is defined by Install

Arguments

  • $array mixed

processColumns

mixed Install::processColumns($columns_data)
  • Visibility: public
  • This method is defined by Install

Arguments

  • $columns_data mixed
⚠️ **GitHub.com Fallback** ⚠️