LimeSurvey API - Master branch

Update extends DynamicSurveyCommonAction
in package

Table of Contents

Methods

backup()  : string
backup files
changeLog()  : string
Display change log
checkLocalErrors()  : string
returns the "Checking basic requirements" step
db()  : mixed
Update database
deleteKey()  : mixed
fileSystem()  : string
diaplay the result of the changed files check
getbothbuttons()  : string
This function return the update buttons for all versions
getnewkey()  : string
This return the subscribe message
getstablebutton()  : string
This function return the update buttons for stable branch
getwelcome()  : string|null
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.
index()  : mixed
First function to be called, when coming to admin/update
managekey()  : mixed
manageSubmitkey()  : mixed
notificationstate()  : mixed
This function change the notification state : big alert notification 1, or small one 0 It's called via ajax from view adminmenu
step4()  : string
Display step4
step4b()  : mixed
For updates from the old updater.
submitkey()  : string
This function create or update the LS update key
updateUpdater()  : string
This function update the updater It is called from the view _updater_update.
renderWrappedTemplate()  : mixed
Backward compatibility function for updates to 5.3 from any previous version
getButtons()  : mixed
this function render the update buttons
parseToView()  : string
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.
renderError()  : string
This method renders the error view
renderErrorString()  : string
This method convert a string to an error object, and then render the error view
renderWelcome()  : mixed
This method render the welcome/subscribe/key_updated message

Methods

backup()

backup files

public backup() : string
Return values
string

changeLog()

Display change log

public changeLog() : string
Return values
string

checkLocalErrors()

returns the "Checking basic requirements" step

public checkLocalErrors() : string
Return values
string —

the welcome message

db()

Update database

public db([mixed $continue = null ]) : mixed
Parameters
$continue : mixed = null

deleteKey()

public deleteKey() : mixed

fileSystem()

diaplay the result of the changed files check

public fileSystem() : string
Return values
string —

HTML

getbothbuttons()

This function return the update buttons for all versions

public getbothbuttons() : string
Return values
string —

the buttons code

getnewkey()

This return the subscribe message

public getnewkey() : string
Return values
string —

the welcome message

getstablebutton()

This function return the update buttons for stable branch

public getstablebutton() : string
Return values
string —

html the button code

getwelcome()

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.

public getwelcome() : string|null

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

Return values
string|null —

the welcome message

index()

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

public index() : mixed

managekey()

public managekey() : mixed

manageSubmitkey()

public manageSubmitkey() : mixed

notificationstate()

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

public notificationstate([mixed $state = '0' ]) : mixed
Parameters
$state : mixed = '0'

step4()

Display step4

public step4() : string
Return values
string

step4b()

For updates from the old updater.

public step4b() : mixed

submitkey()

This function create or update the LS update key

public submitkey() : string
Return values
string

updateUpdater()

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

public 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.

Return values
string —

the welcome message

renderWrappedTemplate()

Backward compatibility function for updates to 5.3 from any previous version

protected renderWrappedTemplate([mixed $sAction = '' ][, mixed $aViewUrls = array() ][, mixed $aData = array() ][, mixed $sRenderFile = false ]) : mixed
Parameters
$sAction : mixed = ''
$aViewUrls : mixed = array()
$aData : mixed = array()
$sRenderFile : mixed = false
Tags
inheritDoc

getButtons()

this function render the update buttons

private getButtons(string $crosscheck) : mixed
Parameters
$crosscheck : string

parseToView()

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.

private parseToView(array<string|int, mixed> $updateinfos) : string
Parameters
$updateinfos : array<string|int, mixed>

the udpadte infos array returned by the update server

Return values
string

renderError()

This method renders the error view

private renderError(object $errorObject) : string
Parameters
$errorObject : object
Return values
string

renderErrorString()

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

private renderErrorString(string $error[, mixed $message = null ]) : string
Parameters
$error : string

the error message

$message : mixed = null
Return values
string

renderWelcome()

This method render the welcome/subscribe/key_updated message

private renderWelcome(obj $serverAnswer) : mixed
Parameters
$serverAnswer : obj

the answer return by the server


        

        
    




    

    

                                

                

                                
    

        On this page

        
    


                

                            

            

    

        

            
Search results