LimeSurvey API - Master branch

LsDefaultDataSets
in package

A collection of default data sets, like surveymenus, surveymenuentries, and tutorials

This class is important for installation (all datasets will be inserted to database tables and to reset to a default setting (if user want to...)

Table of Contents

Methods

getBaseLabelSets()  : mixed
getBaseQuestionThemeEntries()  : mixed
getBoxesData()  : mixed
getDefaultPluginsData()  : array<string|int, mixed>
Get data for plugins installed by default.
getDefaultUserAdministrationSettings()  : array<string|int, mixed>
Email content for registration email (subject and body) Default user administration global configuration settings
getDefaultUserSettings()  : mixed
getSurveygroupData()  : mixed
getSurveyMenuData()  : mixed
getSurveyMenuEntryData()  : mixed
getTemplateConfigurationData()  : array<string|int, mixed>
Returns Template Configuration Data as Array.
getTemplateDefaultTexts()  : mixed
getTemplatesData()  : array<string|int, array<string|int, mixed>>
Provides the default set of theme/template metadata used by the application to update database.
getTutorialData()  : mixed
getTutorialEntryData()  : mixed
mockTranslateArrayContainer()  : mixed
All translations that are used in files that can or should not be searched by the translation script.

Methods

getBaseLabelSets()

public static getBaseLabelSets([mixed $language = 'en' ]) : mixed
Parameters
$language : mixed = 'en'

getBaseQuestionThemeEntries()

public static getBaseQuestionThemeEntries() : mixed

getDefaultPluginsData()

Get data for plugins installed by default.

public static getDefaultPluginsData() : array<string|int, mixed>

Also install all core plugins, but set to inactive.

Return values
array<string|int, mixed>

getDefaultUserAdministrationSettings()

Email content for registration email (subject and body) Default user administration global configuration settings

public static getDefaultUserAdministrationSettings() : array<string|int, mixed>
Return values
array<string|int, mixed> —

with user administration default setting ['sendadmincreationemail'] set to 1, to indicate that email should be send?

getTemplateConfigurationData()

Returns Template Configuration Data as Array.

public static getTemplateConfigurationData() : array<string|int, mixed>
Return values
array<string|int, mixed>

getTemplateDefaultTexts()

public static getTemplateDefaultTexts(mixed $mode[, mixed $language = 'en' ]) : mixed
Parameters
$mode : mixed
$language : mixed = 'en'

getTemplatesData()

Provides the default set of theme/template metadata used by the application to update database.

public static getTemplatesData() : array<string|int, array<string|int, mixed>>

Each element is an associative array describing a template/theme and includes the following keys:

  • name: internal template identifier
  • folder: template folder name
  • title: human-readable title
  • creation_date: creation timestamp (YYYY-MM-DD HH:MM:SS)
  • author, author_email, author_url: author metadata
  • copyright: copyright notice
  • license: license information
  • version: template version
  • api_version: compatible API/version marker
  • view_folder: folder for view files
  • files_folder: folder for asset files
  • description: localized or HTML description
  • last_update: last update timestamp or null
  • owner_id: owner user id
  • extends: name of a parent template this one extends (empty if none)
Return values
array<string|int, array<string|int, mixed>> —

Array of template metadata records.

mockTranslateArrayContainer()

All translations that are used in files that can or should not be searched by the translation script.

public static mockTranslateArrayContainer() : mixed

This function has no functionality except for being searchable by the translation script.


        

        
    




    

    

                                

                

                                
    

        On this page

        
    


                

                            

            

    

        

            
Search results