LimeSurvey API - Master branch

InstallerConfigForm extends CFormModel
in package

Class InstallerConfigForm

Table of Contents

Constants

DB_TYPE_DBLIB  = 'dblib'
DB_TYPE_MSSQL  = 'mssql'
DB_TYPE_MYSQL  = 'mysql'
DB_TYPE_MYSQLI  = 'mysqli'
DB_TYPE_ODBC  = 'odbc'
DB_TYPE_PGSQL  = 'pgsql'
DB_TYPE_SQLSRV  = 'sqlsrv'
ENGINE_TYPE_INNODB  = 'INNODB'
ENGINE_TYPE_MYISAM  = 'MYISAM'
MINIMUM_MEMORY_LIMIT  = 128
MINIMUM_PHP_VERSION  = '7.4.0'

Properties

$adminEmail  : string
$adminLoginName  : string
$adminLoginPwd  : string
$adminName  : string
$confirmPwd  : string
$db  : DbConnection
$db_names  : array<string|int, mixed>
$dbengine  : string
$dbEngines  : array<string|int, mixed>
$dbExists  : bool
$dblocation  : string
$dbname  : string
$dbport  : string
$dbprefix  : string
$dbpwd  : string
$dbtype  : string
$dbuser  : string
$hasMinimumRequirements  : bool
$isCollatorPresent  : bool
$isConfigDirWriteable  : bool
$isConfigPresent  : bool
$isMemoryLimitOK  : bool
$isMSSql  : bool
$isMysql  : bool
$isPhpFileInfoPresent  : bool
$isPhpGdPresent  : bool
$isPhpImapPresent  : bool
$isPhpJsonPresent  : bool
$isPhpLdapPresent  : bool
$isPhpMbStringPresent  : bool
$isPhpVersionOK  : bool
$isPhpZipPresent  : bool
$isPhpZlibPresent  : bool
$isSodiumPresent  : bool
$isTmpDirWriteable  : bool
$isUploadDirWriteable  : bool
$memoryLimit  : float|int
$phpGdHasJpegSupport  : bool
$siteName  : string
$supportedDbTypes  : array<string|int, string>
$surveylang  : string
$tablesExist  : bool
$useDbName  : bool

Methods

__construct()  : mixed
InstallerConfigForm constructor.
attributeHints()  : mixed
attributeLabels()  : mixed
createDatabase()  : void
dbConnect()  : bool
Connect to the database
getDataBaseName()  : mixed
getDbEngines()  : array<string|int, mixed>
getDbPort()  : string
Get the default port if database port is not set
getDsn()  : string
Get the dsn for the database connection
getHasMinimumRequirements()  : bool
Chek whether system meets minimum requirements
getIsConfigDirWriteable()  : bool
getIsMSSql()  : bool
getIsMysql()  : bool
getIsTmpDirWriteable()  : bool
getIsUploadDirWriteable()  : bool
getMemoryLimit()  : float|int
Memory limit in MB
getSupportedDbTypes()  : array<string|int, mixed>
Get the array of supported DB type
isInnoDbLargeFilePrefixEnabled()  : mixed
isWritableRecursive()  : bool
rules()  : mixed
setupTables()  : array<string|int, string>|bool
Function that actually modify the database.
validate()  : mixed
validateDBEngine()  : mixed
checkMemoryLimit()  : bool
checkStatus()  : mixed
createDbQuery()  : string
dbTest()  : bool
getDbDefaultPort()  : string
getMssqlDsn()  : string
getMySqlConfigValue()  : string
getMysqlDsn()  : string
getPgsqlDsn()  : string
isInnoDbBarracudaFileFormat()  : bool
setInitialEngine()  : mixed
setMySQLDefaultEngine()  : mixed

Constants

Properties

$db_names

public array<string|int, mixed> $db_names = array(self::DB_TYPE_MYSQL => 'MySQL', self::DB_TYPE_MYSQLI => 'MySQL (newer driver)', self::DB_TYPE_SQLSRV => 'Microsoft SQL Server (sqlsrv)', self::DB_TYPE_MSSQL => 'Microsoft SQL Server (mssql)', self::DB_TYPE_DBLIB => 'Microsoft SQL Server (dblib)', self::DB_TYPE_PGSQL => 'PostgreSQL')

$dbEngines

public array<string|int, mixed> $dbEngines

the MySQL database engines as [value=>'label']

Methods

__construct()

InstallerConfigForm constructor.

public __construct([string $scenario = 'database' ]) : mixed
Parameters
$scenario : string = 'database'

getDbEngines()

public getDbEngines() : array<string|int, mixed>
Return values
array<string|int, mixed>

getDbPort()

Get the default port if database port is not set

public getDbPort() : string
Return values
string

getDsn()

Get the dsn for the database connection

public getDsn() : string
Tags
throws
Exception
Return values
string

getHasMinimumRequirements()

Chek whether system meets minimum requirements

public getHasMinimumRequirements() : bool
Return values
bool

getIsConfigDirWriteable()

public getIsConfigDirWriteable() : bool
Return values
bool

getIsUploadDirWriteable()

public getIsUploadDirWriteable() : bool
Return values
bool

getMemoryLimit()

Memory limit in MB

public getMemoryLimit() : float|int
Return values
float|int

getSupportedDbTypes()

Get the array of supported DB type

public getSupportedDbTypes() : array<string|int, mixed>
Return values
array<string|int, mixed>

isWritableRecursive()

public static isWritableRecursive(string $sDirectory) : bool
Parameters
$sDirectory : string
Return values
bool

setupTables()

Function that actually modify the database.

public setupTables() : array<string|int, string>|bool
Return values
array<string|int, string>|bool

True if everything was okay, otherwise error message.

validate()

public validate([mixed $attributes = null ][, mixed $clearErrors = true ]) : mixed
Parameters
$attributes : mixed = null
$clearErrors : mixed = true

validateDBEngine()

public validateDBEngine(mixed $attribute) : mixed
Parameters
$attribute : mixed

getMySqlConfigValue()

private getMySqlConfigValue( $itemName) : string
Parameters
$itemName :
Return values
string

isInnoDbBarracudaFileFormat()

private isInnoDbBarracudaFileFormat() : bool
Return values
bool

setMySQLDefaultEngine()

private setMySQLDefaultEngine(string $dbEngine) : mixed
Parameters
$dbEngine : string
Tags
throws
CDbException

        
On this page

Search results