Collaboration diagram for ilCourseDefinedFieldDefinition:

Public Member Functions
	__construct ($a_obj_id, $a_field_id=0)
	Constructor. More...

	getObjId ()

	getId ()

	getType ()

	setType ($a_type)

	getName ()

	setName ($a_name)

	getValues ()

	setValues ($a_values)

	getValueById ($a_id)

	getIdByValue ($a_value)

	isRequired ()

	enableRequired ($a_status)

	setValueOptions ($a_options)

	getValueOptions ()

	prepareSelectBox ()
	Prepare an array of options for ilUtil::formSelect() More...

	prepareValues ($a_values)
	Prepare values from POST. More...

	appendValues ($a_values)
	Append Values. More...

	deleteValue ($a_id)
	Delete value by id. More...

	save ()
	Save. More...

	update ()
	Update a field. More...

	delete ()
	Delete a field. More...

Static Public Member Functions
static	_clone ($a_source_id, $a_target_id)
	Clone fields. More...

static	_deleteByContainer ($a_container_id)
	Delete all fields of a container. More...

static	_hasFields ($a_container_id)
	Check if there are any define fields. More...

static	_getFields ($a_container_id, $a_sort=IL_CDF_SORT_NAME)
	Get all fields of a container. More...

static	_getRequiredFieldIds ($a_obj_id)
	Get required filed id's. More...

static	_fieldsToInfoString ($a_obj_id)
	Fields to info string. More...

static	_getFieldIds ($a_container_id, $a_sort=IL_CDF_SORT_ID)
	Get all field ids of a container. More...

static	_lookupName ($a_field_id)
	Lookup field name. More...

Private Member Functions
	read ()
	Read DB entries. More...

Private Attributes
	$db

	$obj_id

	$id

	$name

	$type

	$values

	$value_options = array()

	$required

Detailed Description

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

Version: $Id$

/

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

Constructor & Destructor Documentation

◆ __construct()

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

Constructor.

@access public

Parameters

int	course obj_id
int	field_id

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

    {
        global $DIC;
 
        $ilDB = $DIC['ilDB'];
        
        $this->db = $ilDB;
        $this->obj_id = $a_obj_id;
        $this->id = $a_field_id;
        
        if ($this->id) {
            $this->read();
        }
    }

References $DIC, $ilDB, and read().

Here is the call graph for this function:

Member Function Documentation

◆ _clone()

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

static

Clone fields.

@access public

Parameters

int	source obj id
int	target obj_id

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

    {
        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();
        }
    }

References _getFields().

Referenced by ilObjCourse\cloneObject().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ _deleteByContainer()

static ilCourseDefinedFieldDefinition::_deleteByContainer ( $a_container_id )

static

Delete all fields of a container.

@access public

Parameters

int	container_id

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

    {
        global $DIC;
 
        $ilDB = $DIC['ilDB'];
        
        // Delete user entries
        include_once('Modules/Course/classes/Export/class.ilCourseUserData.php');
        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);
    }

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

Referenced by ilObjCourse\delete().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ _fieldsToInfoString()

static ilCourseDefinedFieldDefinition::_fieldsToInfoString ( $a_obj_id )

static

Fields to info string.

@access public

Parameters

int obj_id

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

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

References $DIC, $ilDB, $query, and $res.

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

Here is the caller graph for this function:

◆ _getFieldIds()

static ilCourseDefinedFieldDefinition::_getFieldIds	(	$a_container_id,
		$a_sort = `IL_CDF_SORT_ID`
	)

static

Get all field ids of a container.

@access public

Parameters

int	container obj_id

Returns: array array of field ids

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

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

References $DIC, $ilDB, $query, $res, and IL_CDF_SORT_ID.

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

Here is the caller graph for this function:

◆ _getFields()

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

static

Get all fields of a container.

@access public

Parameters

int	container obj_id

Returns: ilCourseDefinedFieldDefinitions[]

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

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

References _getFieldIds(), and IL_CDF_SORT_ID.

Referenced by _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().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ _getRequiredFieldIds()

static ilCourseDefinedFieldDefinition::_getRequiredFieldIds ( $a_obj_id )

static

Get required filed id's.

@access public

Parameters

int	container id

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

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

References $DIC, $ilDB, $query, and $res.

Referenced by ilCourseUserData\_checkRequired().

Here is the caller graph for this function:

◆ _hasFields()

static ilCourseDefinedFieldDefinition::_hasFields ( $a_container_id )

static

Check if there are any define fields.

@access public

Parameters

int	container_id

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

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

References _getFields().

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

Here is the call graph for this function:

Here is the caller graph for this function:

◆ _lookupName()

static ilCourseDefinedFieldDefinition::_lookupName ( $a_field_id )

static

Lookup field name.

@access public

Parameters

int field_id

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

    {
        global $DIC;
 
        $ilDB = $DIC['ilDB'];
        
        $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 ? $row->field_name : '';
    }

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

Referenced by ilMemberExport\write().

Here is the caller graph for this function:

◆ appendValues()

ilCourseDefinedFieldDefinition::appendValues ( $a_values )

Append Values.

@access public

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

    {
        if (!is_array($a_values)) {
            return false;
        }
        $this->values = array_unique(array_merge($this->values, $a_values));
        #sort($this->values);
        return true;
    }

◆ delete()

ilCourseDefinedFieldDefinition::delete ( )

Delete a field.

@access public

Parameters

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

    {
        global $DIC;
 
        $ilDB = $DIC['ilDB'];
        
        include_once('Modules/Course/classes/Export/class.ilCourseUserData.php');
        ilCourseUserData::_deleteByField($this->getId());
        
        $query = "DELETE FROM crs_f_definitions " .
            "WHERE field_id = " . $this->db->quote($this->getId(), 'integer') . " ";
        $res = $ilDB->manipulate($query);
    }

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

Here is the call graph for this function:

◆ deleteValue()

ilCourseDefinedFieldDefinition::deleteValue ( $a_id )

Delete value by id.

@access public

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

    {
        if (!isset($this->values[$a_id])) {
            return false;
        }
        unset($this->values[$a_id]);
        array_merge($this->values);
        $this->update();
        return true;
    }

References update().

Here is the call graph for this function:

◆ enableRequired()

ilCourseDefinedFieldDefinition::enableRequired ( $a_status )

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

    {
        $this->required = $a_status;
    }

Referenced by read().

Here is the caller graph for this function:

◆ getId()

ilCourseDefinedFieldDefinition::getId ( )

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

    {
        return $this->id;
    }

References $id.

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

Here is the caller graph for this function:

◆ getIdByValue()

ilCourseDefinedFieldDefinition::getIdByValue ( $a_value )

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

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

◆ getName()

ilCourseDefinedFieldDefinition::getName ( )

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

    {
        return $this->name;
    }

References $name.

Referenced by save(), and update().

Here is the caller graph for this function:

◆ getObjId()

ilCourseDefinedFieldDefinition::getObjId ( )

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

    {
        return $this->obj_id;
    }

References $obj_id.

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

Here is the caller graph for this function:

◆ getType()

ilCourseDefinedFieldDefinition::getType ( )

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

    {
        return $this->type;
    }

References $type.

Referenced by save(), and update().

Here is the caller graph for this function:

◆ getValueById()

ilCourseDefinedFieldDefinition::getValueById ( $a_id )

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

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

◆ getValueOptions()

ilCourseDefinedFieldDefinition::getValueOptions ( )

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

    {
        return (array) $this->value_options;
    }

References $value_options.

Referenced by save(), and update().

Here is the caller graph for this function:

◆ getValues()

ilCourseDefinedFieldDefinition::getValues ( )

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

    {
        return $this->values ? $this->values : array();
    }

Referenced by save(), and update().

Here is the caller graph for this function:

◆ isRequired()

ilCourseDefinedFieldDefinition::isRequired ( )

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

    {
        return (bool) $this->required;
    }

References $required.

Referenced by save(), and update().

Here is the caller graph for this function:

◆ prepareSelectBox()

ilCourseDefinedFieldDefinition::prepareSelectBox ( )

Prepare an array of options for ilUtil::formSelect()

@access public

Parameters

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

    {
        global $DIC;
 
        $lng = $DIC['lng'];
        
        $options = array();
        $options[''] = $lng->txt('select_one');
        
        foreach ($this->values as $key => $value) {
            $options[$this->getId() . '_' . $key] = $value;
        }
        return $options;
    }

References $DIC, $lng, and getId().

Here is the call graph for this function:

◆ prepareValues()

ilCourseDefinedFieldDefinition::prepareValues ( $a_values )

Prepare values from POST.

Parameters

array array of values @access public

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

    {
        $tmp_values = array();
        
        if (!is_array($a_values)) {
            return false;
        }
        foreach ($a_values as $idx => $value) {
            if (strlen($value)) {
                $tmp_values[$idx] = $value;
            }
        }
        return $tmp_values ? $tmp_values : array();
    }

◆ read()

ilCourseDefinedFieldDefinition::read ( )

private

Read DB entries.

@access private

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

    {
        $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($row->field_name);
        $this->setType($row->field_type);
        $this->setValues(unserialize($row->field_values));
        $this->setValueOptions(unserialize($row->field_values_opt));
        $this->enableRequired($row->field_required);
    }

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

Referenced by __construct().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ save()

ilCourseDefinedFieldDefinition::save ( )

Save.

@access public

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

    {
        global $DIC;
 
        $ilDB = $DIC['ilDB'];
        
        $next_id = $ilDB->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 ( " .
            $ilDB->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') . ", " .
            $ilDB->quote($this->isRequired(), 'integer') . ", " .
            $ilDB->quote(serialize($this->getValueOptions()), 'text') . ' ' .
            ") ";
        $res = $ilDB->manipulate($query);
        $this->id = $next_id;
            
        return true;
    }

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

Here is the call graph for this function:

◆ setName()

ilCourseDefinedFieldDefinition::setName ( $a_name )

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

    {
        $this->name = $a_name;
    }

Referenced by read().

Here is the caller graph for this function:

◆ setType()

ilCourseDefinedFieldDefinition::setType ( $a_type )

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

    {
        $this->type = $a_type;
    }

Referenced by read().

Here is the caller graph for this function:

◆ setValueOptions()

ilCourseDefinedFieldDefinition::setValueOptions ( $a_options )

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

    {
        $this->value_options = $a_options;
    }

Referenced by read().

Here is the caller graph for this function:

◆ setValues()

ilCourseDefinedFieldDefinition::setValues ( $a_values )

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

    {
        $this->values = $a_values;
    }

Referenced by read().

Here is the caller graph for this function:

◆ update()

ilCourseDefinedFieldDefinition::update ( )

Update a field.

@access public

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

    {
        global $DIC;
 
        $ilDB = $DIC['ilDB'];
        
        $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 = " . $ilDB->quote($this->isRequired(), 'integer') . ", " .
            'field_values_opt = ' . $ilDB->quote(serialize($this->getValueOptions()), 'text') . ' ' .
            "WHERE field_id = " . $this->db->quote($this->getId(), 'integer') . " " .
            "AND obj_id = " . $this->db->quote($this->getObjId(), 'integer');
        $res = $ilDB->manipulate($query);
        return true;
    }

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

Referenced by deleteValue().

Here is the call graph for this function:

Here is the caller graph for this function:

Field Documentation

◆ $db

ilCourseDefinedFieldDefinition::$db

private

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

◆ $id

ilCourseDefinedFieldDefinition::$id

private

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

Referenced by getId().

◆ $name

ilCourseDefinedFieldDefinition::$name

private

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

Referenced by getName().

◆ $obj_id

ilCourseDefinedFieldDefinition::$obj_id

private

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

Referenced by getObjId().

◆ $required

ilCourseDefinedFieldDefinition::$required

private

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

Referenced by isRequired().

◆ $type

ilCourseDefinedFieldDefinition::$type

private

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

Referenced by getType().

◆ $value_options

ilCourseDefinedFieldDefinition::$value_options = array()

private

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

Referenced by getValueOptions().

◆ $values

ilCourseDefinedFieldDefinition::$values

private

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

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

Modules/Course/classes/Export/class.ilCourseDefinedFieldDefinition.php

Public Member Functions

Static Public Member Functions

Private Member Functions

Private Attributes

Detailed Description

Constructor & Destructor Documentation

◆ __construct()

Member Function Documentation

◆ _clone()

◆ _deleteByContainer()

◆ _fieldsToInfoString()

◆ _getFieldIds()

◆ _getFields()

◆ _getRequiredFieldIds()

◆ _hasFields()

◆ _lookupName()

◆ appendValues()

◆ delete()

◆ deleteValue()

◆ enableRequired()

◆ getId()

◆ getIdByValue()

◆ getName()

◆ getObjId()

◆ getType()

◆ getValueById()

◆ getValueOptions()

◆ getValues()

◆ isRequired()

◆ prepareSelectBox()

◆ prepareValues()

◆ read()

◆ save()

◆ setName()

◆ setType()

◆ setValueOptions()

◆ setValues()

◆ update()

Field Documentation

◆ $db

◆ $id

◆ $name

◆ $obj_id

◆ $required

◆ $type

◆ $value_options

◆ $values