LimeSurvey API - Master branch
Back to top  

InstallerController

Extends\CController

Installer

package

LimeSurvey
copyright

2019
access

public

Methods

Contains a number of extensions that can be expected to be installed by default, but maybe not on BSD systems etc.

checkDefaultExtensions(): void

Check them silently and die if they are missing.

check if directory exists and is writeable, returns via parameters by reference

checkDirectoryWriteable(string $directory,string &$data,string $base,string $keyError, $bRecursive = false): boolean

Arguments

$directory

string

to check

$data

string

to manipulate

$base

string

key for data manipulation

$keyError

string

key for error data

$bRecursive

Response

boolean

result of check (that it is writeable which implies existance)

check if file exists and is writeable, returns via parameters by reference

checkFileWriteable(string $file,string &$data,string $base,string $keyError): boolean

Arguments

$file

string

to check

$data

string

to manipulate

$base

string

key for data manipulation

$keyError

string

key for error data

Response

boolean

result of check (that it is writeable which implies existance)

Installer::checkInstallation()

checkInstallation(): void

Based on existance of 'sample_installer_file.txt' file, check if installation should proceed further or not.

check if file or directory exists and is writeable, returns via parameters by reference

checkPathWriteable(string $path,integer $type,string &$aData,string $base,string $keyError, $bRecursive = false): boolean

Arguments

$path

string

file or directory to check

$type

integer

0:undefined (invalid), 1:file, 2:directory

$aData

string

$base

string

key for data manipulation

$keyError

string

key for error data

$bRecursive

Response

boolean

result of check (that it is writeable which implies existance)

Check for a specific PHP Function or class, updates HTML image

checkPHPFunctionOrClass(string $sFunctionName,string &$sImage): boolean

Arguments

$sFunctionName

string

Function or class name

$sImage

string

HTML string for related image to show

Response

boolean

True if exists, otherwise false

check requirements

checkRequirements( &$aData): boolean
todo

Not used? Compare models/InstallerConfigForm::getHasMinimumRequirements

Arguments

$aData

Response

boolean

requirements met

check image HTML template

chekHtmlImage(boolean $result): string

Arguments

$result

boolean

Response

string

Span with check if $result is true; otherwise a span with warning

clear the session from installation information

clearSession()

Executes an SQL file

executeSQLFile(string $sFileName,string $sDatabasePrefix)

Arguments

$sFileName

string

$sDatabasePrefix

string

Use with \Yii::app()->setComponent() to set connection at runtime.

getDatabaseConfigArray(): array

Response

array

getModelFromSession

getModelFromSession( $scenario = null): \InstallerConfigForm

Arguments

$scenario

Response

\InstallerConfigForm

Create a random ASCII string

getRandomString( $iTotalChar = 64): string

Arguments

$iTotalChar

Response

string

isWritableRecursive

isWritableRecursive(string $sDirectory)

Arguments

$sDirectory

string

Loads a helper

loadHelper(string $helper): void
access

public

Arguments

$helper

string

Loads a library

loadLibrary( $library): void
access

public

Arguments

$library

Checks for action specific authorization and then executes an action

run(string $action = 'index'): void
access

public

Arguments

$action

string

Load and set session vars

sessioncontrol(): void
access

protected

Installer::stepCreateDb() Create database.

stepCreateDb(): void
Throws
\Exception

Configure database screen

stepDatabaseConfiguration()

Display license

stepLicense()

Optional settings screen

stepOptionalConfiguration()

Installer::stepPopulateDb() Function to populate the database.

stepPopulateDb(): void

check a few writing permissions and optional settings

stepPreInstallationCheck()

display the license file as IIS for example does not display it via the server.

stepViewLicense()

welcome and language selection install step

stepWelcome()

Function to write given database settings in APPPATH.'config/config.php'

writeConfigFile()

Properties

connection

connection :\CDbConnection
var

Type(s)

\CDbConnection

clang

lang :

Type(s)

layout

layout :

Type(s)