LimeSurvey API - Master branch

UpdateForm extends CFormModel

in package

• LimeSurvey
• Backend

Update Form Model

Tags

subpackage

Backend

inheritdoc

Table of Contents

Properties

$build  : string

$view  : string

$path_cookie  : string

$proxy_host_name  : string

$proxy_host_port  : int

$publicdir  : string

$rootdir  : string

$tempdir  : string

Methods

backupDb()  : stdClass

Create a backup of the DataBase

backupFiles()  : stdClass

Create a backup of the files that will be updated

checkUpdateKeyonServer()  : bool

check if a submitted update key exist on the update server and if it's valid

downloadUpdateFile()  : object

This function requests a download to the server

downloadUpdateUpdaterFile()  : object

This function download the file to update the updater to the last version

getChangedFiles()  : mixed|stdClass

This function requests the list of changed file between two build

getChangeLog()  : mixed|stdClass

This function requests the change log between the curent build and the destination build

getFileStatus()  : array<string|int, mixed>

This function provide status information about files presents on the system that will be afected by the update : do they exist ? are they writable ? modified ?

getLocalChecks()  : stdClass

This function check for local errors such as readonly files, available space, php ini config etc.

getLocalChecksForUpdater()  : object

This function check for local arrors such as readonly files/directory to update the updater itself

getUpdateInfo()  : stdClass

First call to the server : This function requests the latest update information from the update server necessary to build the update buttons.

getUpdateNotification()  : object

Check if an update is available, and prints the update notification It also check if the assets need to be republished

getWelcomeMessage()  : string

The server will do some checks and will ask for the correct view to be diplayed.

init()  : mixed

removeDeletedFiles()  : object

Delete the files tagged as deleted in the update

removeTmpFile()  : object

Delete a tmp file

republishAssets()  : mixed

Republish all the assets For now, only for frontEnd templates (backend theme are still based on file assets, not directory assets )

setUpdateKey()  : SettingGlobal|array<string, false|string>

create or update the updateKey to the submitted value

unzipUpdateFile()  : object

Unzip the update file.

unzipUpdateUpdaterFile()  : object

Unzip the update file.

updateVersion()  : null

Update the version file to the destination build version

checkAssets()  : bool

Check if assets needs to be updated

createDbBackup()  : stdClass

Create a backup of the DataBase

fileSystemCheck()  : stdClass

Check if a file / dir is writable AND/OR if it has enough freespace

fileSystemCheckAppath()  : stdClass

build the file / Directory path using APPATH, and then call the check method NB: This method is called by building the method name string in getFileSystemCheckList.

fileSystemCheckConfig()  : stdClass

build the file / Directory path using getConfig(), and then call the check method NB: This method is called by building the method name string in getFileSystemCheckList.

getCheckedFile()  : stdClass

Check if a file (added/deleted/) on the update yet exists on the server, or has been modified

getDbChecks()  : mixed|stdClass

Call the server to get the necessary datas to check the database

getDbTotalSize()  : string

Return the total size of the current database in MB

getFileSystemCheckList()  : array<string|int, mixed>

Call the server to get the list of files and directory to check (and check type : writable / free space)

getModuleChecks()  : stdClass

Get the list of required PHP modules for this update

getMysqlChecks()  : stdClass

getProtocol()  : string

Returns the supported protocol extension (https/http)

getReadOnlyCheckedFile()  : stdClass

Check if a file (added/deleted/modified) from the update exists yet on the server and if it is readonly

performDownload()  : object

This function download a file from the ComfortUpdate and accept redirection

performRequest()  : mixed|stdClass

This function perform the request

phpVerCheck()  : stdClass

Get the required minimal php version for destination build from server, and compare it to local php version.