LimeSurvey API - Master branch

htmleditor_helper.php

Table of Contents

Functions

initKcfinder()  : mixed
sTranslateLangCode2CK()  : mixed
PrepareEditorScript()  : mixed
getEditor()  : string
Returns Editor.
getPopupEditor()  : string
getModalEditor()  : string
getInlineEditor()  : mixed
getLoaderHTML()  : mixed

Functions

sTranslateLangCode2CK()

sTranslateLangCode2CK(mixed $sLanguageCode) : mixed
Parameters
$sLanguageCode : mixed

PrepareEditorScript()

PrepareEditorScript([mixed $load = false ][, CController $controller = null ]) : mixed
Parameters
$load : mixed = false
$controller : CController = null

TODO: Allow to be called automatically (and only load once) from getEditor, or from a widget.

getEditor()

Returns Editor.

getEditor(string $fieldtype, string $fieldname, mixed $fieldtext[, int|null $surveyID = null ][, int|null $gID = null ][, int|null $qID = null ][, string $action = null ]) : string

PrepareEditorScript function must be called first. If getting a JS error about missing CKEditor files, please review if PrepareEditorScript was called.

Parameters
$fieldtype : string

Field Type

$fieldname : string

Field Name, the id attribute of the textarea

$fieldtext : mixed
$surveyID : int|null = null

Survey ID

$gID : int|null = null

Group ID

$qID : int|null = null

Question ID

$action : string = null

Action

Return values
string

getPopupEditor()

getPopupEditor( $fieldtype,  $fieldname,  $fieldtext[,  $surveyID = null ][,  $gID = null ][,  $qID = null ][,  $action = null ]) : string
Parameters
$fieldtype :
$fieldname :
$fieldtext :
$surveyID : = null
$gID : = null
$qID : = null
$action : = null
Return values
string

getModalEditor()

getModalEditor( $fieldtype,  $fieldname,  $fieldtext[,  $surveyID = null ][,  $gID = null ][,  $qID = null ][,  $action = null ]) : string
Parameters
$fieldtype :
$fieldname :
$fieldtext :
$surveyID : = null
$gID : = null
$qID : = null
$action : = null
Return values
string

getInlineEditor()

getInlineEditor(mixed $fieldtype, mixed $fieldname, mixed $fieldtext[, mixed $surveyID = null ][, mixed $gID = null ][, mixed $qID = null ][, mixed $action = null ]) : mixed
Parameters
$fieldtype : mixed
$fieldname : mixed
$fieldtext : mixed
$surveyID : mixed = null
$gID : mixed = null
$qID : mixed = null
$action : mixed = null

getLoaderHTML()

getLoaderHTML(mixed $fieldname) : mixed
Parameters
$fieldname : mixed 

        

        
    




    

    

                                

                

                            
    

        On this page

        
    


                

                            

            

    

        

            
Search results