LimeSurvey API - Master branch
Back to top  

Update

Extends\DynamicSurveyCommonAction

package

LimeSurvey

Methods

backup files

backup(): string

Response

string

Display change log

changeLog(): string

Response

string

returns the "Checking basic requirements" step

checkLocalErrors(): string

Response

string

the welcome message

Update database

db( $continue = null)

Arguments

$continue

deleteKey

deleteKey()

diaplay the result of the changed files check

fileSystem(): string

Response

string

HTML

This function return the update buttons for all versions

getbothbuttons(): string

Response

string

the buttons code

this function render the update buttons

getButtons(string $crosscheck)

Arguments

$crosscheck

string

This return the subscribe message

getnewkey(): string

Response

string

the welcome message

This function return the update buttons for stable branch

getstablebutton(): string

Response

string

html the button code

This function has a special rendering, because the ComfortUpdate server can choose what it's going to show : the welcome message or the subscribe message or the updater update, etc.

getwelcome(): string|null

The same system is used for the static views (update key, etc.)

Response

string|null

the welcome message

First function to be called, when coming to admin/update

index()

managekey

managekey()

manageSubmitkey

manageSubmitkey()

This function change the notification state : big alert notification 1, or small one 0 It's called via ajax from view adminmenu

notificationstate( $state = '0')

Arguments

$state

This function convert the huge updateinfos array to a base64 string, so it can be parsed to the view to be inserted in an hidden input element.

parseToView(array $updateinfos): \$string

Arguments

$updateinfos

array

the udpadte infos array returned by the update server

Response

\$string

This method renders the error view

renderError(object $errorObject): string

Arguments

$errorObject

object

Response

string

This method convert a string to an error object, and then render the error view

renderErrorString(string $error, $message = null): string

Arguments

$error

string

the error message

$message

Response

string

This method render the welcome/subscribe/key_updated message

renderWelcome(\obj $serverAnswer)

Arguments

$serverAnswer

\obj

the answer return by the server

Backward compatibility function for updates to 5.3 from any previous version

renderWrappedTemplate( $sAction = '', $aViewUrls = array(), $aData = array(), $sRenderFile = false)
inheritDoc

Arguments

$sAction

$aViewUrls

$aData

$sRenderFile

Display step4

step4(): string

Response

string

For updates from the old updater.

step4b()

This function create or update the LS update key

submitkey(): string

Response

string

This function update the updater It is called from the view _updater_update.

updateUpdater(): string

The view _updater_update is called by the ComfortUpdate server during the getWelcome step if the updater version is not the minimal required one.

Response

string

the welcome message