LimeSurvey API - Master branch
Back to top  

InstallerConfigForm

Extends\CFormModel

Class InstallerConfigForm

package

Default

Methods

InstallerConfigForm constructor.

__construct(string $scenario = 'database')

Arguments

$scenario

string

attributeHints

attributeHints()

attributeLabels

attributeLabels()
inheritdoc

checkMemoryLimit

checkMemoryLimit(): boolean

Response

boolean

checkStatus

checkStatus()

createDatabase

createDatabase(): void
Throws
\Exception

createDbQuery

createDbQuery(): string

Response

string

Connect to the database

dbConnect(): boolean

Response

boolean

dbTest

dbTest(): boolean

Response

boolean

if connection is done

getDataBaseName

getDataBaseName(): mixed

Response

mixed

getDbDefaultPort

getDbDefaultPort(): string

Response

string

getDbEngines

getDbEngines(): array

Response

array

Get the default port if database port is not set

getDbPort(): string

Response

string

Get the dsn for the database connection

getDsn(): string
Throws
\Exception

Response

string

Chek whether system meets minimum requirements

getHasMinimumRequirements(): boolean

Response

boolean

getIsConfigDirWriteable

getIsConfigDirWriteable(): boolean

Response

boolean

getIsMSSql

getIsMSSql(): boolean

Response

boolean

getIsMysql

getIsMysql(): boolean

Response

boolean

getIsTmpDirWriteable

getIsTmpDirWriteable(): boolean

Response

boolean

getIsUploadDirWriteable

getIsUploadDirWriteable(): boolean

Response

boolean

Memory limit in MB

getMemoryLimit(): float|integer

Response

float|integer

getMssqlDsn

getMssqlDsn(): string

Response

string

getMySqlConfigValue

getMySqlConfigValue( $itemName): string

Arguments

$itemName

Response

string

getMysqlDsn

getMysqlDsn(): string

Response

string

getPgsqlDsn

getPgsqlDsn(): string

Response

string

Get the array of supported DB type

getSupportedDbTypes(): array

Response

array

is_writable_recursive

is_writable_recursive(string $sDirectory): boolean
static

Arguments

$sDirectory

string

Response

boolean

isInnoDbBarracudaFileFormat

isInnoDbBarracudaFileFormat(): boolean

Response

boolean

isInnoDbLargeFilePrefixEnabled

isInnoDbLargeFilePrefixEnabled()

rules

rules()
inheritdoc

setInitialEngine

setInitialEngine()

setMySQLDefaultEngine

setMySQLDefaultEngine(string $dbEngine)
Throws
\CDbException

Arguments

$dbEngine

string

Function that actually modify the database.

setupTables(): array<mixed,string>|boolean

Response

array<mixed,string>|boolean

True if everything was okay, otherwise error message.

validate

validate( $attributes = null, $clearErrors = true)

Arguments

$attributes

$clearErrors

validateDBEngine

validateDBEngine( $attribute)

Arguments

$attribute

Constants

ENGINE_TYPE_MYISAM

ENGINE_TYPE_MYISAM

ENGINE_TYPE_INNODB

ENGINE_TYPE_INNODB

DB_TYPE_MYSQL

DB_TYPE_MYSQL

DB_TYPE_MYSQLI

DB_TYPE_MYSQLI

DB_TYPE_SQLSRV

DB_TYPE_SQLSRV

DB_TYPE_MSSQL

DB_TYPE_MSSQL

DB_TYPE_DBLIB

DB_TYPE_DBLIB

DB_TYPE_PGSQL

DB_TYPE_PGSQL

DB_TYPE_ODBC

DB_TYPE_ODBC

MINIMUM_MEMORY_LIMIT

MINIMUM_MEMORY_LIMIT

MINIMUM_PHP_VERSION

MINIMUM_PHP_VERSION

Properties

dbtype

dbtype :string
var

Type(s)

string

dblocation

dblocation :string
var

Type(s)

string

dbname

dbname :string
var

Type(s)

string

useDbName

useDbName :boolean
var

Type(s)

boolean

dbuser

dbuser :string
var

Type(s)

string

dbpwd

dbpwd :string
var

Type(s)

string

dbprefix

dbprefix :string
var

Type(s)

string

Database Engine type if DB type is MySQL

dbengine :string
var

Database Engine type if DB type is MySQL

Type(s)

string

db_names

db_names :array
var

Type(s)

array

adminLoginPwd

adminLoginPwd :string
var

Type(s)

string

confirmPwd

confirmPwd :string
var

Type(s)

string

adminLoginName

adminLoginName :string
var

Type(s)

string

adminName

adminName :string
var

Type(s)

string

adminEmail

adminEmail :string
var

Type(s)

string

siteName

siteName :string
var

Type(s)

string

surveylang

surveylang :string
var

Type(s)

string

db

db :\DbConnection
var

Type(s)

\DbConnection

tablesExist

tablesExist :boolean
var

Type(s)

boolean

dbExists

dbExists :boolean
var

dbExists

Type(s)

boolean

isPhpMbStringPresent

isPhpMbStringPresent :boolean
var

Type(s)

boolean

isPhpZlibPresent

isPhpZlibPresent :boolean
var

Type(s)

boolean

isPhpJsonPresent

isPhpJsonPresent :boolean
var

Type(s)

boolean

isMemoryLimitOK

isMemoryLimitOK :boolean
var

Type(s)

boolean

isPhpGdPresent

isPhpGdPresent :boolean
var

Type(s)

boolean

isPhpLdapPresent

isPhpLdapPresent :boolean
var

Type(s)

boolean

isPhpZipPresent

isPhpZipPresent :boolean
var

Type(s)

boolean

isPhpImapPresent

isPhpImapPresent :boolean
var

Type(s)

boolean

isPhpVersionOK

isPhpVersionOK :boolean
var

Type(s)

boolean

isSodiumPresent

isSodiumPresent :boolean
var

Type(s)

boolean

isConfigPresent

isConfigPresent :boolean
var

Type(s)

boolean

dbEngines

dbEngines :array

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

Type(s)

array

isMysql

isMysql :boolean

whether the db type is mysql or mysqli

Type(s)

boolean

isMSSql

isMSSql :boolean

whether the db type is one of MS Sql types

Type(s)

boolean

memoryLimit

memoryLimit :float|integer

Type(s)

float|integer

hasMinimumRequirements

hasMinimumRequirements :boolean

Type(s)

boolean

isConfigDirWriteable

isConfigDirWriteable :boolean

Type(s)

boolean

isUploadDirWriteable

isUploadDirWriteable :boolean

Type(s)

boolean

isTmpDirWriteable

isTmpDirWriteable :boolean

Type(s)

boolean

supportedDbTypes

supportedDbTypes :array<mixed,string>

Type(s)

array<mixed,string>