Inheritance diagram for ilDclSelectionOption:

Collaboration diagram for ilDclSelectionOption:

Public Member Functions
	getId ()

	setId (int $id)

	getFieldId ()

	setFieldId (int $field_id)

	getOptId ()

	setOptId (int $opt_id)

	getValue ()

	setValue (string $value)

	getSorting ()

	setSorting (int $sorting)

	cloneOption (ilDclSelectionOption $original_option)

Public Member Functions inherited from ActiveRecord
	getArConnector ()

	getArFieldList ()

	getConnectorContainerName ()
	Return the Name of your Connector Table More...

	setConnectorContainerName (string $connector_container_name)

	getPrimaryFieldValue ()

	setPrimaryFieldValue ($value)

	__construct (mixed $primary_key=0)

	storeObjectToCache ()

	asStdClass ()

	asArray ()

	buildFromArray (array $array)

	fixDateField ($field_name, string $value)

	sleep ($field_name)

	wakeUp ($field_name, $field_value)

	getArrayForConnector ()

	installConnector ()

	store ()

	save ()

	create ()

	copy (int $new_id=0)

	afterObjectLoad ()

	read ()

	update ()

	delete ()

	__call ($name, $arguments)

Static Public Member Functions
static	returnDbTableName ()

static	flushOptions (int $field_id)

static	getAllForField (int $field_id)

static	getValues (int $field_id, $opt_ids)

Static Public Member Functions inherited from ActiveRecord
static	returnDbTableName ()

static	installDB ()

static	renameDBField (string $old_name, string $new_name)

static	tableExists ()

static	fieldExists (string $field_name)

static	removeDBField (string $field_name)

static	updateDB ()

static	resetDB ()

static	truncateDB ()

static	flushDB ()
	never use in ILIAS Core, Plugins only More...

static	preloadObjects ()

static	additionalParams (array $additional_params)

static	findOrFail ($primary_key, array $add_constructor_args=[])
	Tries to find the object and throws an Exception if object is not found, instead of returning null. More...

static	findOrGetInstance ($primary_key, array $add_constructor_args=[])

static	where ($where, $operator=null)

static	innerjoinAR (ActiveRecord $activeRecord, $on_this, string $on_external, array $fields=[' *'], string $operator='=', bool $both_external=false)

static	innerjoin (string $tablename, $on_this, string $on_external, array $fields=[' *'], string $operator='=', bool $both_external=false)

static	leftjoin (string $tablename, $on_this, string $on_external, array $fields=[' *'], string $operator='=', bool $both_external=false)

static	orderBy (string $orderBy, string $orderDirection='ASC')

static	dateFormat (string $date_format='d.m.Y - H:i:s')

static	limit (int $start, int $end)

static	affectedRows ()

static	count ()

static	get ()

static	debug ()

static	first ()

static	getCollection ()

static	last ()

static	getFirstFromLastQuery ()

static	connector (arConnector $arConnector)

static	raw (bool $set_raw=true)

static	getArray (?string $key=null, string\|array\|null $values=null)

static	_toCamelCase (string $str, bool $capitalise_first_char=false)

Data Fields
const	DB_TABLE_NAME = "il_dcl_sel_opts"

Protected Attributes
int	$id

int	$field_id

int	$opt_id

int	$sorting

string	$value

Protected Attributes inherited from ActiveRecord
bool	$ar_safe_read = true

string	$connector_container_name = ''

bool	$is_new = true

Additional Inherited Members
Protected Member Functions inherited from ActiveRecord
	installDatabase ()

Static Protected Member Functions inherited from ActiveRecord
static	getCalledClass ()
	Returns an instance of the instatiated calling active record (needs to be done in static methods) : This should be cached somehow More...

static	fromCamelCase (string $str)

Detailed Description

Definition at line 21 of file class.ilDclSelectionOption.php.

Member Function Documentation

◆ cloneOption()

ilDclSelectionOption::cloneOption ( ilDclSelectionOption $original_option )

Parameters

ilDclSelectionOption $original_option

Definition at line 182 of file class.ilDclSelectionOption.php.

References getOptId(), getSorting(), getValue(), setOptId(), setSorting(), and setValue().

                                                                       : void
     {
         $this->setValue($original_option->getValue());
         $this->setSorting($original_option->getSorting());
         $this->setOptId($original_option->getOptId());
     }

Here is the call graph for this function:

◆ flushOptions()

static ilDclSelectionOption::flushOptions ( int $field_id )

static

Definition at line 138 of file class.ilDclSelectionOption.php.

Referenced by ilDclSelectionFieldModel\setProperty().

                                                       : void
     {
         foreach (self::getAllForField($field_id) as $option) {
             $option->delete();
         }
     }

Here is the caller graph for this function:

◆ getAllForField()

static ilDclSelectionOption::getAllForField ( int $field_id )

static

Returns: self[]

Definition at line 148 of file class.ilDclSelectionOption.php.

Referenced by ilDclSelectionFieldRepresentation\addFilterInputFieldToTable(), ilDclSelectionFieldRepresentation\buildFieldCreationInput(), ilDclSelectionFieldModel\cloneProperties(), ilDclSelectionFieldModel\doDelete(), ilDclSelectionFieldModel\fillPropertiesForm(), ilDclSelectionFieldModel\getProperty(), and ilDclSelectionFieldModel\reorderExistingValues().

                                                         : array
     {
         return self::where(["field_id" => $field_id])->orderBy('sorting')->get();
     }

Here is the caller graph for this function:

◆ getFieldId()

ilDclSelectionOption::getFieldId ( )

Definition at line 84 of file class.ilDclSelectionOption.php.

References $field_id.

                                 : int
     {
         return $this->field_id;
     }

◆ getId()

ilDclSelectionOption::getId ( )

Definition at line 74 of file class.ilDclSelectionOption.php.

References $id.

                            : int
     {
         return $this->id;
     }

◆ getOptId()

ilDclSelectionOption::getOptId ( )

Definition at line 94 of file class.ilDclSelectionOption.php.

References $opt_id.

Referenced by cloneOption().

                               : int
     {
         return $this->opt_id;
     }

Here is the caller graph for this function:

◆ getSorting()

ilDclSelectionOption::getSorting ( )

Definition at line 114 of file class.ilDclSelectionOption.php.

References $sorting.

Referenced by cloneOption().

                                 : int
     {
         return $this->sorting;
     }

Here is the caller graph for this function:

◆ getValue()

ilDclSelectionOption::getValue ( )

Definition at line 104 of file class.ilDclSelectionOption.php.

References $value.

Referenced by cloneOption().

                               : string
     {
         return $this->value;
     }

Here is the caller graph for this function:

◆ getValues()

static ilDclSelectionOption::getValues	(	int	$field_id,
			$opt_ids
	)

static

Parameters

array | string | int $opt_ids

Exceptions

arException

Definition at line 157 of file class.ilDclSelectionOption.php.

References ActiveRecord\orderBy().

Referenced by ilDclSelectionRecordRepresentation\getHTML(), ilDclDateSelectionRecordFieldModel\parseExportValue(), and ilDclSelectionRecordFieldModel\parseExportValue().

                                                              : array
     {
         $operators = ['field_id' => '='];
         if (is_array($opt_ids)) {
             if (empty($opt_ids)) {
                 return [];
             }
             $operators['opt_id'] = 'IN';
         } else {
             $operators['opt_id'] = '=';
         }
         $return = [];
         foreach (self::where(
             ["field_id" => $field_id, "opt_id" => $opt_ids],
             $operators
         )->orderBy('sorting')->get() as $opt) {
             $return[] = $opt->getValue();
         }
 
         return $return;
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ returnDbTableName()

static ilDclSelectionOption::returnDbTableName ( )

static

Definition at line 25 of file class.ilDclSelectionOption.php.

                                               : string
     {
         return self::DB_TABLE_NAME;
     }

◆ setFieldId()

ilDclSelectionOption::setFieldId ( int $field_id )

Definition at line 89 of file class.ilDclSelectionOption.php.

References $field_id.

                                              : void
     {
         $this->field_id = $field_id;
     }

◆ setId()

ilDclSelectionOption::setId ( int $id )

Definition at line 79 of file class.ilDclSelectionOption.php.

References $id.

                                   : void
     {
         $this->id = $id;
     }

◆ setOptId()

ilDclSelectionOption::setOptId ( int $opt_id )

Definition at line 99 of file class.ilDclSelectionOption.php.

References $opt_id.

Referenced by cloneOption().

                                          : void
     {
         $this->opt_id = $opt_id;
     }

Here is the caller graph for this function:

◆ setSorting()

ilDclSelectionOption::setSorting ( int $sorting )

Definition at line 119 of file class.ilDclSelectionOption.php.

References $sorting.

Referenced by cloneOption().

                                             : void
     {
         $this->sorting = $sorting;
     }

Here is the caller graph for this function:

◆ setValue()

ilDclSelectionOption::setValue ( string $value )

Definition at line 109 of file class.ilDclSelectionOption.php.

References $value.

Referenced by cloneOption().

                                            : void
     {
         $this->value = $value;
     }

Here is the caller graph for this function:

Field Documentation

◆ $field_id

int ilDclSelectionOption::$field_id

protected

Definition at line 48 of file class.ilDclSelectionOption.php.

Referenced by getFieldId(), and setFieldId().

◆ $id

int ilDclSelectionOption::$id

protected

Definition at line 40 of file class.ilDclSelectionOption.php.

Referenced by getId(), and setId().

◆ $opt_id

int ilDclSelectionOption::$opt_id

protected

Definition at line 56 of file class.ilDclSelectionOption.php.

Referenced by getOptId(), and setOptId().

◆ $sorting

int ilDclSelectionOption::$sorting

protected

Definition at line 64 of file class.ilDclSelectionOption.php.

Referenced by getSorting(), and setSorting().

◆ $value

string ilDclSelectionOption::$value

protected

Definition at line 72 of file class.ilDclSelectionOption.php.

Referenced by getValue(), and setValue().

◆ DB_TABLE_NAME

const ilDclSelectionOption::DB_TABLE_NAME = "il_dcl_sel_opts"

Definition at line 23 of file class.ilDclSelectionOption.php.

The documentation for this class was generated from the following file:

components/ILIAS/DataCollection/classes/Fields/Selection/class.ilDclSelectionOption.php

Public Member Functions

Static Public Member Functions

Data Fields

Protected Attributes

Additional Inherited Members

Detailed Description

Member Function Documentation

◆ cloneOption()

◆ flushOptions()

◆ getAllForField()

◆ getFieldId()

◆ getId()

◆ getOptId()

◆ getSorting()

◆ getValue()

◆ getValues()

◆ returnDbTableName()

◆ setFieldId()

◆ setId()

◆ setOptId()

◆ setSorting()

◆ setValue()

Field Documentation

◆ $field_id

◆ $id

◆ $opt_id

◆ $sorting

◆ $value

◆ DB_TABLE_NAME