Class humhub\modules\user\models\fieldtype\CheckboxList

Inheritancehumhub\modules\user\models\fieldtype\CheckboxList » humhub\modules\user\models\fieldtype\BaseType » yii\base\Model
Available since version2.1.1

CheckboxList profile field for selecting multiple options.

Public Methods

Hide inherited methods

MethodDescriptionDefined By
addFieldType() Add new FieldType to stack humhub\modules\user\models\fieldtype\BaseType
addToProfileTable() Adds the new profile type to the profile table. humhub\modules\user\models\fieldtype\BaseType
beforeProfileSave() humhub\modules\user\models\fieldtype\CheckboxList
delete() humhub\modules\user\models\fieldtype\CheckboxList
getFieldFormDefinition() Return the Form Element to edit the value of the Field humhub\modules\user\models\fieldtype\CheckboxList
getFieldRules() Returns validation rules for field type. humhub\modules\user\models\fieldtype\BaseType
getFieldTypes() Returns a list of all available field type classes. humhub\modules\user\models\fieldtype\BaseType
getFormDefinition() Returns Form Definition for edit/create this field. humhub\modules\user\models\fieldtype\CheckboxList
getLabels() Return array of Labels for Field humhub\modules\user\models\fieldtype\BaseType
getSelectItems() Returns a list of possible options humhub\modules\user\models\fieldtype\CheckboxList
getTypeInstances() Returns an array of instances of all available field types. humhub\modules\user\models\fieldtype\BaseType
getUserValue() Returns value of option humhub\modules\user\models\fieldtype\CheckboxList
loadDefaults() Load field type default settings to the profile humhub\modules\user\models\fieldtype\BaseType
loadFieldConfig() Loads the profile field type settings humhub\modules\user\models\fieldtype\BaseType
rules() humhub\modules\user\models\fieldtype\CheckboxList
save() Saves this Profile Field Type humhub\modules\user\models\fieldtype\CheckboxList
setProfileField() Links a ProfileField to the ProfileFieldType. humhub\modules\user\models\fieldtype\BaseType
validate() Validates a ProfileFieldType humhub\modules\user\models\fieldtype\BaseType

Property Details

$allowOther public property
public boolean $allowOther null
$options public property
public string $options null
$other_value public property
public string $other_value null

Method Details

beforeProfileSave() public method

public void beforeProfileSave ( $values )
$values
delete() public method

public void delete ( )
getFieldFormDefinition() public method

Return the Form Element to edit the value of the Field

public void getFieldFormDefinition ( )
getFormDefinition() public method

Returns Form Definition for edit/create this field.

public Array getFormDefinition ( $definition = [] )
$definition
return Array

Form Definition

getSelectItems() public method

Returns a list of possible options

public Array getSelectItems ( )
getUserValue() public method

Returns value of option

public String getUserValue ( $user, $raw true )
$user \humhub\modules\user\models\fieldtype\User
$raw Boolean

Output Key

rules() public method

public void rules ( )
save() public method

Saves this Profile Field Type

public void save ( )