Class Template
package | Default |
---|
attributeLabels(): array
array
customized attribute labels (name=>label)
behaviors(): array
Below is a list of all behaviors we register:
see | \PluginEventBehavior\CTimestampBehavior |
---|---|
array
checkExtendsItSelf(): boolean
Throws |
|
---|
boolean
checkIfTemplateExists(string $sTemplateName): boolean
string
boolean
checkTemplate(): boolean
Throws |
|
---|
boolean
checkTemplateExtends(): boolean
Throws |
|
---|
boolean
checkTemplateXML(string $sTemplateFolder): boolean
TODO | : check api version |
---|
string
the template forder name where to look for the XML
boolean
decrypt( $value = '')
decryptEncryptAttributes( $action = 'decrypt')
decryptSingle(string $value = ''): string
string
String value which needs to be decrypted
string
the decrypted string
decryptSingleOld(string $value = ''): string
string
String value which needs to be decrypted
string
the decrypted string
deleteAllByAttributes(array $attributes,string $condition = '',array $params = array()): integer
todo | This should also be moved to the behavior at some point. This method overrides the parent in order to raise PluginEvents for Bulk delete operations. Filter Criteria are wrapped into a CDBCriteria instance so we have a single instance responsible for holding the filter criteria to be passed to the PluginEvent, this also enables us to pass the fully configured CDBCriteria instead of the original Parameters. See {@link find()} for detailed explanation about $condition and $params. |
---|
array
list of attribute values (indexed by attribute names) that the active records should match. An attribute value can be an array which will be used to generate an IN condition.
string
query condition or criteria.
array
parameters to be bound to an SQL statement.
integer
number of rows affected by the execution.
deleteAssetVersion(): integer
integer
(0|1)
dispatchPluginModelEvent(string $sEventName,\CDbCriteria $criteria = null,array $eventParams = []): \PluginEvent
string
\CDbCriteria
array
\PluginEvent
encrypt()
encryptAttributeValues(array $attributes = null, $bEncryptedOnly = false, $bReplaceValues = true): array
array
list of attribute values (indexed by attribute names) that the active records should match. An attribute value can be an array which will be used to generate an IN condition.
array
attributes array with encrypted atrribute values is returned
encryptSave( $runValidation = false)
encryptSingle(string $value = '')
string
String value which needs to be encrypted
findAllAsArray(mixed $condition = '',array $params = array()): array
See \find() for detailed explanation about $condition and $params.
mixed
query condition or criteria.
array
parameters to be bound to an SQL statement.
array
list of active records satisfying the specified condition. An empty array is returned if none is found.
findAllByAttributes(array $attributes,mixed $condition = '',array $params = array()): array<mixed,static>
array
list of attribute values (indexed by attribute names) that the active records should match. An attribute value can be an array which will be used to generate an IN condition.
mixed
query condition or criteria.
array
parameters to be bound to an SQL statement.
array<mixed,static>
the records found. An empty array is returned if none is found.
findByAttributes(array $attributes,mixed $condition = '',array $params = array()): static|null
array
list of attribute values (indexed by attribute names) that the active record should match. An attribute value can be an array which will be used to generate an IN condition.
mixed
query condition or criteria.
array
parameters to be bound to an SQL statement.
static|null
the record found. Null if none is found.
forceAssets(): void
getAllEncryptedAttributes(integer $iSurveyId,string $sClassName): array
integer
string
array
TODO: Should be split into seperate functions in the appropiate model or helper class TODO: Make an interface for records that support encryption.
getAllTemplatesDirectories()
getBrokenThemes( $sFolder = null)
getDeprecatedTemplates()
getInstance(string $sTemplateName = null,integer|string $iSurveyId = null,integer|string $iSurveyGroupId = null,boolean $bForceXML = null, $abstractInstance = false,boolean $last = false): self
Will instantiate the template object first time it is called.
NOTE 1: This function will call prepareTemplateRendering that 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 use this one. Call it only before rendering anything related to the template. NOTE 3: If you need to get the related configuration to this template, rather use: getTemplateConfiguration() NOTE 4: If you want the lastest generated theme, just call Template::getLastInstance()
string
integer|string
integer|string
boolean
boolean
if you want to get the last instace without providing template name or sid
self
getLastInstance(boolean $bAutoGenerate = true): self
boolean
: should the function try to generate an instance if it doesn't exist?
self
getMaxId(string $field = null,boolean $forceRefresh = false): false|integer
This is a convenience method, that uses the primary key of the model to retrieve the highest value.
Throws |
|
---|
string
The field that contains the Id, when null primary key is used if it is a single field
boolean
Don't use value from static cache but always requery the database
false|integer
getMinId(string $field = null,boolean $forceRefresh = false): false|integer
This is a convenience method, that uses the primary key of the model to retrieve the highest value.
Throws |
|
---|
string
The field that contains the Id, when null primary key is used if it is a single field
boolean
Don't use value from static cache but always requery the database
false|integer
getOtherFiles(string $filesDir): array
string
array
getStandardTemplateList(): array<mixed,string>
deprecated | Use SurveyThemeHelper::getStandardTemplateList() instead. |
---|---|
Throws |
|
array<mixed,string>
getTemplateConfiguration(string $sTemplateName = null,integer $iSurveyId = null, $iSurveyGroupId = null,boolean $bForceXML = false, $abstractInstance = false): \TemplateConfiguration
It checks if the required template is a core one or a user one. If it's a user template, it will check if it's an old 2.0x template to provide default configuration values corresponding to the old template system If it's not an old template, it will check if it has a configuration file to load its datas. If it's not the case (template probably doesn't exist), it will load the default template configuration TODO : more tests should be done, with a call to private function _is_valid_template(), testing not only if it has a config.xml, but also id this file is correct, if the files refered in css exist, etc.
string
the name of the template to load. The string come from the template selector in survey settings
integer
the id of the survey.
boolean
the id of the survey.
\TemplateConfiguration
getTemplateInFolder( $sFolder)
deprecated | Use SurveyThemeHelper::getTemplateInFolder() instead. |
---|---|
getTemplateInStandard()
deprecated | Use SurveyThemeHelper::getTemplateInStandard() instead. |
---|---|
getTemplateInUpload()
deprecated | Use SurveyThemeHelper::getTemplateInUpload() instead. |
---|---|
getTemplateList(): array
TODO: replace the calls to that function by a data provider based on search
array
getTemplateListWithPreviews(): array
array
TODO: replace the calls to that function by a data provider based on search
getTemplatePath(string $sTemplateName = ""): string
string
string
template path
getTemplatesFileFolder(string $sTemplateName = ""): string
string
string
template url
getTemplateURL(string $sTemplateName = ""): string
string
string
template url
hasInheritance( $sTemplateName)
isCorrectInstance(string $sTemplateName = null): boolean
string
boolean
isStandardTemplate(mixed $sTemplateName): boolean
deprecated | Use SurveyThemeHelper::getStandardTemplateList() instead. |
---|
mixed
template name to look for
boolean
True if standard template, otherwise false
model(string $className = __CLASS__): \Template
Please note that you should have this exact method in all your CActiveRecord descendants!
string
active record class name.
\Template
the static model class
primaryKey(): string
access | public |
---|---|
string
query(\CDbCriteria $criteria,boolean $all = false,boolean $asAR = true): mixed
Performs the actual DB query and populates the AR objects with the query result. This method is mainly internally used by other AR query methods.
since | 1.1.7 |
---|
\CDbCriteria
the query criteria
boolean
whether to return all data
boolean
mixed
the AR objects populated with the query result
relations(): array
array
relational rules.
renameTo(string $sNewName)
string
The newname of the template
resetAssetVersion(): void
resetInstance()
rules(): array
array
validation rules for model attributes.
search(): \CActiveDataProvider
Typical usecase:
\CActiveDataProvider
the data provider that can return the models based on the search/filter conditions.
setEncryptedAttributeLabel(integer $surveyId,string $className,string $attributeName): string
Throws |
|
---|
integer
string
string
string
tableName(): string
string
the associated database table name
templateNameFilter(string $sTemplateName): string
string
string
existing $sTemplateName
updateAll(array $attributes,mixed $condition = '',array $params = array()): integer
XSS filtering is enforced for attributes listed in model's $xssFilterAttributes property. See \find() for detailed explanation about $condition and $params. Note, the attributes are not checked for safety and no validation is done.
array
list of attributes (name=>$value) to be updated
mixed
query condition or criteria.
array
parameters to be bound to an SQL statement.
integer
the number of rows being updated
aAllTemplatesDir :array
var | cache for the method getAllTemplatesDirectories |
---|
array
aTemplatesFileFolder :array
var | cache for the method getTemplateFilesFolder |
---|
array
aNamesFiltered :array
var | cache for the method templateNameFilter |
---|
array
instance :\Template
xssFilterAttributes :array<mixed,string>
var | Array of attributes that should be XSS filtered on mass updates |
---|
array<mixed,string>
bEncryption :
name :string
Template name
string
folder :string
Template folder name eg: 'default'
string
title :string
string
creation_date :string
string
copyright :string
string
license :string
string
version :string
string
view_folder :string
string
files_folder :string
string
description :string
string
last_update :string
string
api_version :string
string
owner_id :integer
integer
extends :string
string