LimeSurvey API - Master branch

TemplateConfiguration extends TemplateConfig

in package

• LimeSurvey
• Backend

This is the model class for table "{{template_configuration}}".

Tags

subpackage

Backend

Table of Contents

Properties

$aInstancesFromTemplateName  : array<string|int, mixed>

$aPreparedToRender  : array<string|int, mixed>

$bJustCreated  : mixed

$bUseMagicInherit  : mixed

$config  : SimpleXMLElement

$cssFramework  : object

$cssframework_css  : string

$cssframework_js  : string

$cssframework_name  : string

$files_css  : string

$files_js  : string

$files_print_css  : string

$filesPath  : string

$generalFilesPath  : mixed

$gsid  : int

$id  : int

$isStandard  : bool

$oMotherTemplate  : TemplateConfiguration

$oOptionAttributes  : mixed

$oOptions  : object

$oParentTemplate  : TemplateConfiguration

$options  : string

$options_page  : mixed

$packages_ltr  : string

$packages_rtl  : string

$packages_to_load  : string

$path  : string

$showpopups  : int

$sid  : int

$sPackageName  : string

$sPreviewImgTag  : string

$sTemplateName  : string

$sTemplateurl  : string

$template  : Template

$template_description  : mixed

$template_extends  : mixed

$template_name  : string

$template_type  : mixed

$uid  : int

$viewPath  : string

$aCssFrameworkReplacement  : array<string|int, mixed>

$apiVersion  : int

$depends  : array<string|int, string>

$hasConfigFile  : string

$iSurveyId  : int

$packages  : array<string|int, string>

$xmlFile  : string

$aFilesTo  : array<string|int, mixed>

$aFrameworkAssetsToReplace  : array<string|int, mixed>

$aReplacements  : array<string|int, mixed>

$bTemplateCheckResult  : bool

$Ofiles  : array<string|int, mixed>

$sTypeIcon  : string

Methods

__get()  : mixed

Proxy for the AR method to manage the inheritance If one of the field that can be inherited is set to "inherit", then it will return the value of its parent NOTE: this is recursive, if the parent field itself is set to inherit, then it will the value of the parent of the parent, etc

__toString()  : string

addFileReplacement()  : bool|void

Add a file replacement in the field `file_{css|js|print_css}` in table {{template_configuration}}, eg: {"replace": [ {original files to replace here...}, "css/template.css",]} In general, should be called from TemplateManifest, after adding a file replacement inside the manifest.

addOptionFromXMLToLiveTheme()  : void

Apply options from XML configuration for all missing template options

addOptionToLiveTheme()  : void

Add an option definition to the current theme.

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

checkAndcreateSurveyConfig()  : TemplateConfiguration

For a given survey, it checks if its theme have a all the needed configuration entries (survey + survey group).

checkTemplate()  : bool

Check if the template exists and is valid

convertOptionsToJson()  : string

Extracts option values from theme options node (XML) into a json key-value map.

defaultScope()  : mixed

formatToJsonArray()  : string

Convert the values to a json.

getAllDbTemplateFolders()  : array<string|int, mixed>|null

Returns an array of all unique template folders that are registered in the database

getApiVersion()  : int

get the template API version

getButtons()  : string

Displays survey theme action buttons

getClassAndAttributes()  : mixed

Core config and attributes

getDescription()  : mixed

Twig statements can be used in Theme description

getGlobalParent()  : TemplateConfiguration

Get the global template configuration with same name as $this.

getHasOptionPage()  : bool

Returns true if this theme or any mothertemplate has a TemplateConfiguration set

getInstance()  : TemplateConfiguration

Get an instance of a fitting TemplateConfiguration NOTE: for rendering prupose, you should never call this function directly, but rather Template::getInstance.

getInstanceFromSurveyGroup()  : TemplateConfiguration

Returns a TemplateConfiguration Object based on a surveygroup ID If no instance is existing, it will create one.

getInstanceFromSurveyId()  : TemplateConfiguration

Returns a TemplateConfiguration Object based on a surveyID If no instance is existing, it will create one.

getInstanceFromTemplateName()  : TemplateConfiguration

Gets an instance of a templateconfiguration by name

getOptionPage()  : mixed

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

getParentConfiguration()  : TemplateConfiguration

getPreview()  : array<string|int, mixed>|mixed|string|null

getshowpopups()  : mixed

Get showpopups value from config or template configuration

getTemplateAndMotherNames()  : string

getTemplateForAsset()  : TemplateConfiguration|bool

Find which template should be used to render a given view

getTemplateForFile()  : TemplateConfig

Get the template for a given file. It checks if a file exist in the current template or in one of its mother templates Can return a 302 redirect (this is not really a throw …

getTemplatesWithNoDb()  : array<string|int, TemplateConfiguration>

Returns an array with uninstalled and/or incompatible survey themes

getTemplateURL()  : string

Returns the complete URL path to a given template name

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

Returns a Theme options array based on a surveyID

getTypeIcon()  : string

importManifest()  : bool

Create a new entry in {{templates}} and {{template_configuration}} table using the template manifest

isCompatible()  : bool|null

Checks if theme is compatible with the current limesurvey version

model()  : TemplateConfiguration

Returns the static model of the specified AR class.

prepareTemplateRendering()  : self

Prepare all the needed datas to render the temple If any problem (like template doesn't exist), it will load the default theme configuration NOTE 1: This function will create/update all the packages needed to render the template, which imply to do the same for all mother templates NOTE 2: So if you just want to access the TemplateConfiguration AR Object, you don't need to call it. Call it only before rendering anything related to the template.

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

removeFiles()  : mixed

Remove the css/js files defined in theme config, from any package (even the core ones) The file should have the exact same name as in the package (see: application/config/packages.php and application/config/vendor.php) eg: to remove awesome-bootstrap-checkbox.css, in the theme config file add <remove>awesome-bootstrap-checkbox/awesome-bootstrap-checkbox.css</remove>

rename()  : mixed

Change the template name inside the configuration entries (called from template editor) NOTE: all tests (like template exist, etc) are done from template controller.

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

sanitizeImagePathsOnJson()  : mixed

Sanitizes the theme options making sure that paths are valid.

search()  : CActiveDataProvider

Retrieves a list of models based on the current search/filter conditions.

searchGrid()  : CActiveDataProvider

Retrieves a list of models based on the current search/filter conditions.

setBasics()  : mixed

Sets bUseMagicInherit sTemplate isStandard and path of the theme

setGlobalOption()  : void

Set a value on a given option at global setting level (survey level not affected).

setOption()  : void

Set option (unless if options is set to "inherit").

setOptionKeysToInherit()  : mixed

Set each option key value to 'inherit' instead of having only one 'inherit' value for options.

setToInherit()  : mixed

tableName()  : string

throwConsoleError()  : mixed

uninstall()  : bool|int

Uninstalls the selected surveytheme and deletes database entry and configuration

uninstallThemesRecursive()  : void

Uninstalls all surveythemes that are being extended from the supplied surveytheme name

validateTheme()  : bool

Checks if a theme is valid Can be extended with more checks in the future if needed

addMotherTemplatePackage()  : array<string|int, string>

loads the main theme template from the parent theme that it is extending, as a package. Ready to be registered

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

Change the mother template configuration depending on template settings

createTemplatePackage()  : mixed

Create a package for the asset manager.

getDependsPackages()  : array<string|int, string>

Get the depends package

getFilePath()  : string|false

Get the file path for a given template.

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

From a list of json files in db it will generate a PHP array ready to use by removeFileFromPackage()

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

Get the list of file replacement from Engine Framework

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

Get the list of file replacement from Engine Framework

getOfiles()  : bool|mixed

Get the json files (to load/replace/remove) from a theme, and checks if its correctly formated

getOptionKey()  : mixed

Search through the inheritence chain and find the inherited value for theme option

getTemplateConfigurationForAttribute()  : TemplateConfiguration

Get the closest template in the hierarchy that has the definition for $attribute

removeFileFromPackage()  : void

Proxy for Yii::app()->clientScript->removeFileFromPackage()

removeFilesFromPackage()  : mixed

Checks if some files are inside a package, and remove them.

setIsStandard()  : void

Check if this template is a standard template and save it in current model $this->isStandard

setMotherTemplates()  : mixed

Configure the mother template (and its mother templates) This is an object recursive call to TemplateConfiguration::prepareTemplateRendering()

setOptionInheritance()  : void

Loop through all theme options defined, trigger check for inheritance and write the new value back to the options object

setOptions()  : void

Decodes json string from the database field "options" and stores it inside $this->oOptions Also triggers inheritence checks

setThisTemplate()  : void

Set the default configuration values for the template, and use the motherTemplate value if needed

uninstallIncorectTheme()  : mixed

Uninstall a theme and, display error message, and redirect to theme list

getAttributeValue()  : mixed

Returns the value of the specified attribute ($attributeName) from the closest Template in the hierarchy.

getImageInfo()  : array<string|int, mixed>|null

Return image information

getRelatedTemplate()  : Template|null

Returns the related Template.

getRelativePath()  : string

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

When rtl language is chosen: if a css file in folder variations is in array cssFiles, then it will be replaced with the *-rtl version

setCssFramework()  : void