LimeSurvey API - Master branch

Box extends CActiveRecord
in package

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

The following are the available columns in table '{{boxes}}':

Table of Contents

Properties

$desc  : string
$ico  : string
$id  : int
$page  : string
$position  : int
$title  : string
$url  : string
$usergroup  : int

Methods

attributeLabels()  : mixed
getbuttons()  : string
Returns the Buttons for the Grid View
getIconName()  : string
Search the iconName for current icon
getIcons()  : array<string|int, mixed>
List of all icons available for user [['id' => 1, 'icon' => 'name'],...] Command to generate this list: grep -oh "icon-[a-z]*" styles/Sea_Green/css/fonts.css | sort -u > ~/my_icon_list.txt
getIcons_length()  : int
getSpanIcon()  : string
getUsergroupname()  : mixed|string
model()  : Box
relations()  : mixed
restoreDefaults()  : bool
Method to restore the default surveymenu entries This method will fail if the surveymenus have been tempered, or wrongly set
rules()  : mixed
search()  : CActiveDataProvider
Retrieves a list of models based on the current search/filter conditions.
tableName()  : mixed

Properties

$desc

public string $desc

Description

$ico

public string $ico

the icon ID

$id

public int $id

Primary key

$page

public string $page

$position

public int $position

$title

public string $title

$url

public string $url

$usergroup

public int $usergroup

UserGroup ID

Methods

attributeLabels()

public attributeLabels() : mixed
Tags
inheritdoc

getbuttons()

Returns the Buttons for the Grid View

public getbuttons() : string
Return values
string

getIconName()

Search the iconName for current icon

public getIconName() : string
Return values
string

getIcons()

List of all icons available for user [['id' => 1, 'icon' => 'name'],...] Command to generate this list: grep -oh "icon-[a-z]*" styles/Sea_Green/css/fonts.css | sort -u > ~/my_icon_list.txt

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

getIcons_length()

public getIcons_length() : int
Return values
int

getSpanIcon()

public getSpanIcon() : string
Return values
string

getUsergroupname()

public getUsergroupname() : mixed|string
Return values
mixed|string

model()

public static model([mixed $className = __CLASS__ ]) : Box
Parameters
$className : mixed = __CLASS__
Tags
inheritdoc
Return values
Box

the static model class

relations()

public relations() : mixed
Tags
inheritdoc

restoreDefaults()

Method to restore the default surveymenu entries This method will fail if the surveymenus have been tempered, or wrongly set

public restoreDefaults() : bool
Return values
bool

rules()

public rules() : mixed
Tags
inheritdoc

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

public search() : CActiveDataProvider

Typical usecase:

  • Initialize the model fields with values from filter form.
  • Execute this method to get CActiveDataProvider instance which will filter models according to data in model fields.
  • Pass data provider to CGridView, CListView or any similar widget.
Return values
CActiveDataProvider

the data provider that can return the models based on the search/filter conditions.

tableName()

public tableName() : mixed
Tags
inheritdoc

        
On this page

Search results