ilCourseDefinedFieldDefinition Class Reference

This file is part of ILIAS, a powerful learning management system published by ILIAS open source e-Learning e.V. More...

Collaboration diagram for ilCourseDefinedFieldDefinition:

Public Member Functions
	__construct (int $a_obj_id, int $a_field_id=0)
	getObjId ()
	getId ()
	getType ()
	setType (int $a_type)
	getName ()
	setName (string $a_name)
	getValues ()
	setValues (array $a_values)
	getValueById (int $a_id)
	getIdByValue (string $a_value)
	isRequired ()
	enableRequired (bool $a_status)
	setValueOptions (array $a_options)
	getValueOptions ()
	prepareSelectBox ()
	prepareValues (array $a_values)
	appendValues (array $a_values)
	save ()
	update ()
	delete ()

Static Public Member Functions
static	_clone (int $a_source_id, int $a_target_id)
static	_deleteByContainer (int $a_container_id)
static	_hasFields (int $a_container_id)
	Check if there are any define fields. More...
static	_getFields (int $a_container_id, $a_sort=self::IL_CDF_SORT_NAME)
	Get all fields of a container. More...
static	_getRequiredFieldIds (int $a_obj_id)
	Get required filed id's. More...
static	_fieldsToInfoString (int $a_obj_id)
static	_getFieldIds (int $a_container_id, string $a_sort=self::IL_CDF_SORT_ID)
static	_lookupName (int $a_field_id)

Data Fields
const	IL_CDF_SORT_ID = 'field_id'
const	IL_CDF_SORT_NAME = 'field_name'
const	IL_CDF_TYPE_TEXT = 1
const	IL_CDF_TYPE_SELECT = 2

Protected Attributes
ilDBInterface	$db
ilLanguage	$lng

Private Member Functions
	read ()

Private Attributes
int	$obj_id
int	$id = 0
string	$name = ''
int	$type = 0
array	$values = []
array	$value_options = []
bool	$required = false

Detailed Description

This file is part of ILIAS, a powerful learning management system published by ILIAS open source e-Learning e.V.

ILIAS is licensed with the GPL-3.0, see https://www.gnu.org/licenses/gpl-3.0.en.html You should have received a copy of said license along with the source code, too.

If this is not the case or you just want to try ILIAS, you'll find us at: https://www.ilias.de https://github.com/ILIAS-eLearning

Author

Stefan Meyer meyer.nosp@m.@lei.nosp@m.fos.c.nosp@m.om

Version

$Id$ \/

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

Constructor & Destructor Documentation

__construct()

ilCourseDefinedFieldDefinition::__construct	(	int	$a_obj_id,
		int	$a_field_id = 0
	)

Definition at line 42 of file class.ilCourseDefinedFieldDefinition.php.

References $DIC, ILIAS\Repository\lng(), and read().

    {
        global $DIC;

        $this->db = $DIC->database();
        $this->lng = $DIC->language();
        $this->obj_id = $a_obj_id;
        $this->id = $a_field_id;

        if ($this->id) {
            $this->read();
        }
    }

Here is the call graph for this function:

Member Function Documentation

_clone()

static ilCourseDefinedFieldDefinition::_clone ( int  $a_source_id, int  $a_target_id  )

static

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

References _getFields().

Referenced by ilObjCourse\cloneObject(), and ilObjGroup\read().

                                                                     : void
    {
        foreach (ilCourseDefinedFieldDefinition::_getFields($a_source_id) as $field_obj) {
            $cdf = new ilCourseDefinedFieldDefinition($a_target_id);
            $cdf->setName($field_obj->getName());
            $cdf->setType($field_obj->getType());
            $cdf->setValues($field_obj->getValues());
            $cdf->setValueOptions($field_obj->getValueOptions());
            $cdf->enableRequired($field_obj->isRequired());
            $cdf->save();
        }
    }

Here is the call graph for this function:

Here is the caller graph for this function:

_deleteByContainer()

static ilCourseDefinedFieldDefinition::_deleteByContainer ( int  $a_container_id )

static

Definition at line 69 of file class.ilCourseDefinedFieldDefinition.php.

References $DIC, $ilDB, $res, ilCourseUserData\_deleteByField(), and _getFieldIds().

Referenced by ilObjCourse\delete().

                                                                  : void
    {
        global $DIC;

        $ilDB = $DIC->database();
        // Delete user entries
        foreach (ilCourseDefinedFieldDefinition::_getFieldIds($a_container_id) as $field_id) {
            ilCourseUserData::_deleteByField($field_id);
        }
        $query = "DELETE FROM crs_f_definitions " .
            "WHERE obj_id = " . $ilDB->quote($a_container_id, 'integer') . " ";
        $res = $ilDB->manipulate($query);
    }

Here is the call graph for this function:

Here is the caller graph for this function:

_fieldsToInfoString()

static ilCourseDefinedFieldDefinition::_fieldsToInfoString ( int  $a_obj_id )

static

Definition at line 126 of file class.ilCourseDefinedFieldDefinition.php.

References $DIC, $ilDB, and $res.

Referenced by ilObjCourseGUI\infoScreen(), and ilObjGroupGUI\infoScreen().

                                                             : string
    {
        global $DIC;

        $ilDB = $DIC->database();
        $query = "SELECT field_name FROM crs_f_definitions " .
            "WHERE obj_id = " . $ilDB->quote($a_obj_id, 'integer');
        $res = $ilDB->query($query);
        $fields = [];
        while ($row = $ilDB->fetchObject($res)) {
            $fields[] = $row->field_name;
        }
        return implode('<br />', $fields);
    }

Here is the caller graph for this function:

_getFieldIds()

static ilCourseDefinedFieldDefinition::_getFieldIds ( int  $a_container_id, string  $a_sort = self::IL_CDF_SORT_ID  )

static

Returns

int[]

Definition at line 144 of file class.ilCourseDefinedFieldDefinition.php.

References $DIC, $ilDB, $res, and ILIAS\Repository\int().

Referenced by _deleteByContainer(), _getFields(), and ilCourseUserData\_getValuesByObjId().

                                                                                                 : array
    {
        global $DIC;

        $ilDB = $DIC->database();
        $query = "SELECT field_id FROM crs_f_definitions " .
            "WHERE obj_id = " . $ilDB->quote($a_container_id, 'integer') . " " .
            "ORDER BY " . self::IL_CDF_SORT_ID;
        $res = $ilDB->query($query);
        $field_ids = [];
        while ($row = $ilDB->fetchObject($res)) {
            $field_ids[] = (int) $row->field_id;
        }
        return $field_ids;
    }

Here is the call graph for this function:

Here is the caller graph for this function:

_getFields()

static ilCourseDefinedFieldDefinition::_getFields ( int  $a_container_id,   $a_sort = self::IL_CDF_SORT_NAME  )

static

Get all fields of a container.

Parameters

int	container obj_id

Returns

ilCourseDefinedFieldDefinition[]

Definition at line 96 of file class.ilCourseDefinedFieldDefinition.php.

References _getFieldIds().

Referenced by ilObjectCustomUserFieldsPlaceholderValues\__construct(), _clone(), _hasFields(), ilMemberAgreementGUI\addCustomFields(), ilMemberExport\getOrderedExportableFields(), ilObjectCustomUserFieldsPlaceholderValues\getPlaceholderValuesForPreview(), ilExportFieldsInfo\getSelectableFieldsInfo(), ilObjCourseGUI\infoScreen(), ilObjGroupGUI\infoScreen(), ilObjectCustomUserFieldsPlaceholderDescription\initPlaceholders(), ilMemberExportGUI\initSettingsForm(), ilObjectCustomUserFieldsGUI\listFields(), ilAttendanceList\readOrderedExportableFields(), ilMemberAgreementGUI\saveCourseDefinedFields(), ilObjectCustomUserFieldsGUI\saveFields(), ilMemberAgreementGUI\setCourseDefinedFieldValues(), ilRegistrationGUI\showCustomFields(), and ilRegistrationGUI\validateCustomFields().

                                                                                          : array
    {
        $fields = [];
        foreach (ilCourseDefinedFieldDefinition::_getFieldIds($a_container_id, self::IL_CDF_SORT_ID) as $field_id) {
            $fields[] = new ilCourseDefinedFieldDefinition($a_container_id, $field_id);
        }
        return $fields;
    }

Here is the call graph for this function:

Here is the caller graph for this function:

_getRequiredFieldIds()

static ilCourseDefinedFieldDefinition::_getRequiredFieldIds ( int  $a_obj_id )

static

Get required filed id's.

Returns

int[]

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

References $DIC, $ilDB, $res, and ILIAS\Repository\int().

Referenced by ilCourseUserData\_checkRequired().

                                                              : array
    {
        global $DIC;

        $ilDB = $DIC->database();

        $query = "SELECT * FROM crs_f_definitions " .
            "WHERE obj_id = " . $ilDB->quote($a_obj_id, 'integer') . " " .
            "AND field_required = 1";
        $res = $ilDB->query($query);
        $req_fields = [];
        while ($row = $ilDB->fetchObject($res)) {
            $req_fields[] = (int) $row->field_id;
        }
        return $req_fields;
    }

Here is the call graph for this function:

Here is the caller graph for this function:

_hasFields()

static ilCourseDefinedFieldDefinition::_hasFields ( int  $a_container_id )

static

Check if there are any define fields.

Definition at line 86 of file class.ilCourseDefinedFieldDefinition.php.

References _getFields().

Referenced by ilMemberAgreement\__construct(), ilSubscriberTableGUI\__construct(), ilWaitingListTableGUI\__construct(), ilMemberAgreement\agreementRequired(), ilObjGroupGUI\checkAgreement(), ilObjCourseGUI\checkAgreement(), ilRegistrationGUI\fillAgreement(), ilParticipantTableGUI\initSettings(), ilRegistrationGUI\setAccepted(), ilObjCourseGUI\setSubTabs(), and ilObjGroupGUI\setSubTabs().

                                                          : int
    {
        return count(ilCourseDefinedFieldDefinition::_getFields($a_container_id));
    }

Here is the call graph for this function:

Here is the caller graph for this function:

_lookupName()

static ilCourseDefinedFieldDefinition::_lookupName ( int  $a_field_id )

static

Definition at line 160 of file class.ilCourseDefinedFieldDefinition.php.

References $DIC, $ilDB, $res, and ilDBConstants\FETCHMODE_OBJECT.

Referenced by ilMemberExport\write().

                                                       : string
    {
        global $DIC;

        $ilDB = $DIC->database();
        $query = "SELECT * FROM crs_f_definitions " .
            "WHERE field_id = " . $ilDB->quote($a_field_id, 'integer');

        $res = $ilDB->query($query);
        $row = $res->fetchRow(ilDBConstants::FETCHMODE_OBJECT);
        return $row->field_name ?: '';
    }

Here is the caller graph for this function:

appendValues()

ilCourseDefinedFieldDefinition::appendValues

(

array

$a_values

)

Definition at line 267 of file class.ilCourseDefinedFieldDefinition.php.

                                                 : bool
    {
        $this->values = array_unique(array_merge($this->values, $a_values));
        #sort($this->values);
        return true;
    }

delete()

ilCourseDefinedFieldDefinition::delete

(

)

Definition at line 304 of file class.ilCourseDefinedFieldDefinition.php.

References $res, ilCourseUserData\_deleteByField(), and getId().

                            : void
    {
        ilCourseUserData::_deleteByField($this->getId());
        $query = "DELETE FROM crs_f_definitions " .
            "WHERE field_id = " . $this->db->quote($this->getId(), 'integer') . " ";
        $res = $this->db->manipulate($query);
    }

Here is the call graph for this function:

enableRequired()

ilCourseDefinedFieldDefinition::enableRequired

(

bool

$a_status

)

Definition at line 234 of file class.ilCourseDefinedFieldDefinition.php.

Referenced by read().

                                                  : void
    {
        $this->required = $a_status;
    }

Here is the caller graph for this function:

getId()

ilCourseDefinedFieldDefinition::getId

(

)

Definition at line 178 of file class.ilCourseDefinedFieldDefinition.php.

References $id.

Referenced by delete(), prepareSelectBox(), read(), and update().

                           : int
    {
        return $this->id;
    }

Here is the caller graph for this function:

getIdByValue()

ilCourseDefinedFieldDefinition::getIdByValue

(

string

$a_value

)

Definition at line 224 of file class.ilCourseDefinedFieldDefinition.php.

                                                 : int
    {
        return (($pos = array_search($a_value, $this->values)) === false) ? -1 : $pos;
    }

getName()

ilCourseDefinedFieldDefinition::getName

(

)

Definition at line 193 of file class.ilCourseDefinedFieldDefinition.php.

References $name.

Referenced by save(), and update().

                             : string
    {
        return $this->name;
    }

Here is the caller graph for this function:

getObjId()

ilCourseDefinedFieldDefinition::getObjId

(

)

Definition at line 173 of file class.ilCourseDefinedFieldDefinition.php.

References $obj_id.

Referenced by read(), save(), and update().

                              : int
    {
        return $this->obj_id;
    }

Here is the caller graph for this function:

getType()

ilCourseDefinedFieldDefinition::getType

(

)

Definition at line 183 of file class.ilCourseDefinedFieldDefinition.php.

References $type.

Referenced by save(), and update().

                             : int
    {
        return $this->type;
    }

Here is the caller graph for this function:

getValueById()

ilCourseDefinedFieldDefinition::getValueById

(

int

$a_id

)

Definition at line 213 of file class.ilCourseDefinedFieldDefinition.php.

                                           : string
    {
        if (
            is_array($this->values) &&
            array_key_exists($a_id, $this->values)
        ) {
            return $this->values[$a_id];
        }
        return '';
    }

getValueOptions()

ilCourseDefinedFieldDefinition::getValueOptions

(

)

Definition at line 244 of file class.ilCourseDefinedFieldDefinition.php.

References $value_options.

Referenced by save(), and update().

                                     : array
    {
        return $this->value_options;
    }

Here is the caller graph for this function:

getValues()

ilCourseDefinedFieldDefinition::getValues

(

)

Definition at line 203 of file class.ilCourseDefinedFieldDefinition.php.

References $values.

Referenced by save(), and update().

                               : array
    {
        return $this->values;
    }

Here is the caller graph for this function:

isRequired()

ilCourseDefinedFieldDefinition::isRequired

(

)

Definition at line 229 of file class.ilCourseDefinedFieldDefinition.php.

References $required.

Referenced by save(), and update().

                                : bool
    {
        return $this->required;
    }

Here is the caller graph for this function:

prepareSelectBox()

ilCourseDefinedFieldDefinition::prepareSelectBox

(

)

Definition at line 249 of file class.ilCourseDefinedFieldDefinition.php.

References getId(), and ILIAS\Repository\lng().

                                      : array
    {
        $options = array();
        $options[''] = $this->lng->txt('select_one');

        foreach ($this->values as $key => $value) {
            $options[$this->getId() . '_' . $key] = $value;
        }
        return $options;
    }

Here is the call graph for this function:

prepareValues()

ilCourseDefinedFieldDefinition::prepareValues

(

array

$a_values

)

Definition at line 260 of file class.ilCourseDefinedFieldDefinition.php.

                                                  : array
    {
        $tmp_values = [];
        $tmp_values = array_filter($a_values, 'strlen');
        return $tmp_values;
    }

read()

ilCourseDefinedFieldDefinition::read ( )

private

Definition at line 312 of file class.ilCourseDefinedFieldDefinition.php.

References $res, enableRequired(), ilDBConstants\FETCHMODE_OBJECT, getId(), getObjId(), setName(), setType(), setValueOptions(), and setValues().

Referenced by __construct().

                           : void
    {
        $query = "SELECT * FROM crs_f_definitions " .
            "WHERE field_id = " . $this->db->quote($this->getId(), 'integer') . " " .
            "AND obj_id = " . $this->db->quote($this->getObjId(), 'integer') . " ";

        $res = $this->db->query($query);
        $row = $res->fetchRow(ilDBConstants::FETCHMODE_OBJECT);

        $this->setName((string) $row->field_name);
        $this->setType((int) $row->field_type);
        $this->setValues(unserialize($row->field_values) ?: []);
        $this->setValueOptions(unserialize($row->field_values_opt) ?: []);
        $this->enableRequired((bool) $row->field_required);
    }

Here is the call graph for this function:

Here is the caller graph for this function:

save()

ilCourseDefinedFieldDefinition::save

(

)

Definition at line 274 of file class.ilCourseDefinedFieldDefinition.php.

References $res, getName(), getObjId(), getType(), getValueOptions(), getValues(), and isRequired().

                          : void
    {
        $next_id = $this->db->nextId('crs_f_definitions');
        $query = "INSERT INTO crs_f_definitions (field_id,obj_id,field_name,field_type,field_values,field_required,field_values_opt) " .
            "VALUES ( " .
            $this->db->quote($next_id, 'integer') . ", " .
            $this->db->quote($this->getObjId(), 'integer') . ", " .
            $this->db->quote($this->getName(), "text") . ", " .
            $this->db->quote($this->getType(), 'integer') . ", " .
            $this->db->quote(serialize($this->getValues()), 'text') . ", " .
            $this->db->quote($this->isRequired(), 'integer') . ", " .
            $this->db->quote(serialize($this->getValueOptions()), 'text') . ' ' .
            ") ";
        $res = $this->db->manipulate($query);
        $this->id = $next_id;
    }

Here is the call graph for this function:

setName()

ilCourseDefinedFieldDefinition::setName

(

string

$a_name

)

Definition at line 198 of file class.ilCourseDefinedFieldDefinition.php.

Referenced by read().

                                           : void
    {
        $this->name = $a_name;
    }

Here is the caller graph for this function:

setType()

ilCourseDefinedFieldDefinition::setType

(

int

$a_type

)

Definition at line 188 of file class.ilCourseDefinedFieldDefinition.php.

Referenced by read().

                                        : void
    {
        $this->type = $a_type;
    }

Here is the caller graph for this function:

setValueOptions()

ilCourseDefinedFieldDefinition::setValueOptions

(

array

$a_options

)

Definition at line 239 of file class.ilCourseDefinedFieldDefinition.php.

Referenced by read().

                                                     : void
    {
        $this->value_options = $a_options;
    }

Here is the caller graph for this function:

setValues()

ilCourseDefinedFieldDefinition::setValues

(

array

$a_values

)

Definition at line 208 of file class.ilCourseDefinedFieldDefinition.php.

Referenced by read().

                                              : void
    {
        $this->values = $a_values;
    }

Here is the caller graph for this function:

update()

ilCourseDefinedFieldDefinition::update

(

)

Definition at line 291 of file class.ilCourseDefinedFieldDefinition.php.

References $res, getId(), getName(), getObjId(), getType(), getValueOptions(), getValues(), and isRequired().

                            : void
    {
        $query = "UPDATE crs_f_definitions " .
            "SET field_name = " . $this->db->quote($this->getName(), 'text') . ", " .
            "field_type = " . $this->db->quote($this->getType(), 'integer') . ", " .
            "field_values = " . $this->db->quote(serialize($this->getValues()), 'text') . ", " .
            "field_required = " . $this->db->quote($this->isRequired(), 'integer') . ", " .
            'field_values_opt = ' . $this->db->quote(serialize($this->getValueOptions()), 'text') . ' ' .
            "WHERE field_id = " . $this->db->quote($this->getId(), 'integer') . " " .
            "AND obj_id = " . $this->db->quote($this->getObjId(), 'integer');
        $res = $this->db->manipulate($query);
    }

Here is the call graph for this function:

Field Documentation

$db

ilDBInterface ilCourseDefinedFieldDefinition::$db

protected

Definition at line 30 of file class.ilCourseDefinedFieldDefinition.php.

$id

int ilCourseDefinedFieldDefinition::$id = 0

private

Definition at line 35 of file class.ilCourseDefinedFieldDefinition.php.

Referenced by getId().

$lng

ilLanguage ilCourseDefinedFieldDefinition::$lng

protected

Definition at line 31 of file class.ilCourseDefinedFieldDefinition.php.

$name

string ilCourseDefinedFieldDefinition::$name = ''

private

Definition at line 36 of file class.ilCourseDefinedFieldDefinition.php.

Referenced by getName().

$obj_id

int ilCourseDefinedFieldDefinition::$obj_id

private

Definition at line 33 of file class.ilCourseDefinedFieldDefinition.php.

Referenced by getObjId().

$required

bool ilCourseDefinedFieldDefinition::$required = false

private

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

Referenced by isRequired().

$type

int ilCourseDefinedFieldDefinition::$type = 0

private

Definition at line 37 of file class.ilCourseDefinedFieldDefinition.php.

Referenced by getType().

$value_options

array ilCourseDefinedFieldDefinition::$value_options = []

private

Definition at line 39 of file class.ilCourseDefinedFieldDefinition.php.

Referenced by getValueOptions().

$values

array ilCourseDefinedFieldDefinition::$values = []

private

Definition at line 38 of file class.ilCourseDefinedFieldDefinition.php.

Referenced by getValues().

IL_CDF_SORT_ID

const ilCourseDefinedFieldDefinition::IL_CDF_SORT_ID = 'field_id'

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

IL_CDF_SORT_NAME

const ilCourseDefinedFieldDefinition::IL_CDF_SORT_NAME = 'field_name'

Definition at line 26 of file class.ilCourseDefinedFieldDefinition.php.

IL_CDF_TYPE_SELECT

const ilCourseDefinedFieldDefinition::IL_CDF_TYPE_SELECT = 2

Definition at line 28 of file class.ilCourseDefinedFieldDefinition.php.

Referenced by ilMemberAgreementGUI\addCustomFields(), ilObjectCustomUserFieldsGUI\initFieldForm(), ilObjectCustomUserFieldsTableGUI\parse(), ilMemberAgreementGUI\saveCourseDefinedFields(), ilMemberAgreementGUI\setCourseDefinedFieldValues(), ilRegistrationGUI\showCustomFields(), and ilRegistrationGUI\validateCustomFields().

IL_CDF_TYPE_TEXT

const ilCourseDefinedFieldDefinition::IL_CDF_TYPE_TEXT = 1

Definition at line 27 of file class.ilCourseDefinedFieldDefinition.php.

Referenced by ilMemberAgreementGUI\addCustomFields(), ilObjectCustomUserFieldsGUI\initFieldForm(), ilObjectCustomUserFieldsTableGUI\parse(), ilMemberAgreementGUI\saveCourseDefinedFields(), ilMemberAgreementGUI\setCourseDefinedFieldValues(), ilRegistrationGUI\showCustomFields(), and ilRegistrationGUI\validateCustomFields().

---

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

• components/ILIAS/Course/classes/Export/class.ilCourseDefinedFieldDefinition.php