Template

Extends \LSActiveRecord

Methods

Returns the static model of Settings table

model(string $class = __CLASS__) : \CActiveRecord
static
static
access

public

Arguments

$class

string

Response

\CActiveRecord

Returns the setting's table name to be used by the model

tableName() : string
access

public

Response

string

Returns this table's primary key

primaryKey() : string
access

public

Response

string

Filter the template name : test if template if exist

templateNameFilter(string $sTemplateName) : string
static

Arguments

$sTemplateName

string

Response

string

existing $sTemplateName

checkIfTemplateExists

checkIfTemplateExists($sTemplateName) 
static

Arguments

$sTemplateName

Get the template path for any template : test if template if exist

getTemplatePath(string $sTemplateName = "") : string
static

Arguments

$sTemplateName

string

Response

string

template path

This method construct a template object, having all the needed configuration datas.

getTemplateConfiguration(string $sTemplateName = '', integer $iSurveyId = '') : \StdClass
static

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 it has the needed pstpl files, if the files refered in css exist, etc.

Arguments

$sTemplateName

string

the name of the template to load. The string come from the template selector in survey settings

$iSurveyId

integer

the id of the survey. If

Response

\StdClass

Return the list of ALL files present in the file directory

getOtherFiles($filesdir) 
static

Arguments

$filesdir

This function returns the complete URL path to a given template name

getTemplateURL(string $sTemplateName = "") : string
static

Arguments

$sTemplateName

string

Response

string

template url

Returns an array of all available template names - does a basic check if the template might be valid

getTemplateList() 
static

getTemplateListWithPreviews

getTemplateListWithPreviews() 
static

isStandardTemplate returns true if a template is a standard template This function does not check if a template actually exists

isStandardTemplate(mixed $sTemplateName) : bool
static

Arguments

$sTemplateName

mixed

template name to look for

Response

bool

True if standard template, otherwise false

Get instance of template object.

getInstance(string $sTemplateName = '', int $iSurveyId = '') : \TemplateConfiguration
static

Will instantiate the template object first time it is called. Please use this instead of global variable.

Arguments

$sTemplateName

string

$iSurveyId

int

Response

\TemplateConfiguration

Touch each directory in standard template directory to force assset manager to republish them

forceAssets() 
static

Lists the behaviors of this model

behaviors() : array
inherited

Below is a list of all behaviors we register:

see \CTimestampBehavior \PluginEventBehavior

Response

array

Modified version that default to do the same as the original, but allows via a third parameter to retrieve the result as array instead of active records. This solves a joining problem. Usage via findAllAsArray method

query(\CDbCriteria $criteria, boolean $all = false, $asAR = true) : mixed
inherited

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

Arguments

$criteria

\CDbCriteria

the query criteria

$all

boolean

whether to return all data

$asAR

Response

mixed

the AR objects populated with the query result

Finds all active records satisfying the specified condition but returns them as array

findAllAsArray(mixed $condition = '', array $params = array()) : array
inherited

See {@link find()} for detailed explanation about $condition and $params.

Arguments

$condition

mixed

query condition or criteria.

$params

array

parameters to be bound to an SQL statement.

Response

array

list of active records satisfying the specified condition. An empty array is returned if none is found.

Return the max value for a field

getMaxId(string $field = null, boolean $forceRefresh = false) : false|int
inherited

This is a convenience method, that uses the primary key of the model to retrieve the highest value.

Arguments

$field

string

The field that contains the Id, when null primary key is used if it is a single field

$forceRefresh

boolean

Don't use value from static cache but always requery the database

Response

false|int

Return the min value for a field

getMinId(string $field = null, boolean $forceRefresh = false) : false|int
inherited

This is a convenience method, that uses the primary key of the model to retrieve the highest value.

Arguments

$field

string

The field that contains the Id, when null primary key is used if it is a single field

$forceRefresh

boolean

Don't use value from static cache but always requery the database

Response

false|int

deleteAllByAttributes

deleteAllByAttributes(array $attributes, mixed $condition = '', array $params = array()) : integer
inherited
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.

Arguments

$attributes

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.

$condition

mixed

query condition or criteria.

$params

array

parameters to be bound to an SQL statement.

Response

integer

number of rows affected by the execution.

Properties

- The instance of template object

instance : \Template
static
var
  • The instance of template object

Type(s)

\Template