Collaboration diagram for ilAdvancedMDSubstitution:

Public Member Functions
	sortDefinitions (array $a_definitions)
	Sort definitions. More...

	isActive ()

	isDescriptionEnabled ()

	enableDescription (bool $a_status)

	enabledFieldNames ()

	enableFieldNames (bool $a_status)

	getParsedSubstitutions (int $a_ref_id, int $a_obj_id)

	resetSubstitutions ()

	appendSubstitution (int $a_field_id, bool $a_bold=false, bool $a_newline=false)
	append field to substitutions @access public More...

	getSubstitutions ()

	isSubstituted (int $a_field_id)

	isBold (int $a_field_id)

	hasNewline (int $a_field_id)

	update ()
	update @access public More...

Static Public Member Functions
static	_getInstanceByObjectType (string $a_type)

Protected Attributes
ilDBInterface	$db

string	$type

array	$substitutions

array	$bold = array()

array	$newline = array()

bool	$enabled_desc = true

bool	$enabled_field_names = true

bool	$active = false

array	$date_fields = array()

array	$datetime_fields = array()

array	$active_fields = array()

Private Member Functions
	__construct (string $a_type)

	parseValue (int $a_field_id, array $a_values_records)

	read ()
	Read db entries @access private. More...

	initECSMappings ()

Static Private Attributes
static array	$instances = null

static array	$mappings = null

Detailed Description

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

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

Constructor & Destructor Documentation

◆ __construct()

ilAdvancedMDSubstitution::__construct ( string $a_type )

private

Definition at line 49 of file class.ilAdvancedMDSubstitution.php.

    {
        global $DIC;
 
        $this->db = $DIC->database();
        $this->type = $a_type;
 
        $this->initECSMappings();
        $this->read();
    }

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

Here is the call graph for this function:

Member Function Documentation

◆ _getInstanceByObjectType()

static ilAdvancedMDSubstitution::_getInstanceByObjectType ( string $a_type )

static

Definition at line 62 of file class.ilAdvancedMDSubstitution.php.

                                                                   : ilAdvancedMDSubstitution
    {
        if (isset(self::$instances[$a_type])) {
            return self::$instances[$a_type];
        }
        return self::$instances[$a_type] = new ilAdvancedMDSubstitution($a_type);
    }

Referenced by ilObjCategoryListGUI\init(), ilObjCategoryReferenceListGUI\init(), ilObjCourseListGUI\init(), ilObjCourseReferenceListGUI\init(), ilObjExerciseListGUI\init(), ilObjGroupListGUI\init(), ilObjGroupReferenceListGUI\init(), ilObjIndividualAssessmentListGUI\init(), ilObjRemoteCategoryListGUI\init(), ilObjRemoteCourseListGUI\init(), ilObjRemoteFileListGUI\init(), ilObjRemoteGlossaryListGUI\init(), ilObjRemoteGroupListGUI\init(), ilObjRemoteLearningModuleListGUI\init(), ilObjRemoteTestListGUI\init(), ilObjRemoteWikiListGUI\init(), ilObjSessionListGUI\init(), ilObjStudyProgrammeReferenceListGUI\init(), ilAdvancedMDSettingsGUI\initFormSubstitutions(), ilAdvancedMDRecordGUI\parseAppointmentPresentationa(), and ilAdvancedMDSettingsGUI\updateSubstitutions().

Here is the caller graph for this function:

◆ appendSubstitution()

ilAdvancedMDSubstitution::appendSubstitution	(	int	$a_field_id,
		bool	$a_bold = `false`,
		bool	$a_newline = `false`
	)

append field to substitutions @access public

Parameters

int field id

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

                                                                                                      : void
    {
        $this->substitutions[] = $a_field_id;
        if ($a_bold) {
            $this->bold[] = $a_field_id;
        }
        if ($a_newline) {
            $this->newline[] = $a_field_id;
        }
    }

◆ enableDescription()

ilAdvancedMDSubstitution::enableDescription ( bool $a_status )

Definition at line 95 of file class.ilAdvancedMDSubstitution.php.

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

◆ enabledFieldNames()

ilAdvancedMDSubstitution::enabledFieldNames ( )

Definition at line 100 of file class.ilAdvancedMDSubstitution.php.

                                       : bool
    {
        return $this->enabled_field_names;
    }

References $enabled_field_names.

Referenced by getParsedSubstitutions(), and update().

Here is the caller graph for this function:

◆ enableFieldNames()

ilAdvancedMDSubstitution::enableFieldNames ( bool $a_status )

Definition at line 105 of file class.ilAdvancedMDSubstitution.php.

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

◆ getParsedSubstitutions()

ilAdvancedMDSubstitution::getParsedSubstitutions	(	int	$a_ref_id,
		int	$a_obj_id
	)

Definition at line 110 of file class.ilAdvancedMDSubstitution.php.

                                                                        : array
    {
        if (!count($this->getSubstitutions())) {
            return array();
        }
 
        $values_records = ilAdvancedMDValues::preloadedRead($this->type, $a_obj_id);
 
        $counter = 0;
        $substituted = [];
        foreach ($this->getSubstitutions() as $field_id) {
            if (!isset($this->active_fields[$field_id])) {
                continue;
            }
 
            $value = $this->parseValue($field_id, $values_records);
 
            if ($value === null) {
                if ($this->hasNewline($field_id) and $counter) {
                    $substituted[$counter - 1]['newline'] = true;
                }
                continue;
            }
 
            $substituted[$counter]['name'] = $this->active_fields[$field_id];
            $substituted[$counter]['value'] = $value;
            $substituted[$counter]['bold'] = $this->isBold($field_id);
            if ($this->hasNewline($field_id)) {
                $substituted[$counter]['newline'] = true;
            } else {
                $substituted[$counter]['newline'] = false;
            }
            $substituted[$counter]['show_field'] = $this->enabledFieldNames();
            $counter++;
        }
        return $substituted;
    }

References enabledFieldNames(), getSubstitutions(), hasNewline(), isBold(), parseValue(), and ilAdvancedMDValues\preloadedRead().

Here is the call graph for this function:

◆ getSubstitutions()

ilAdvancedMDSubstitution::getSubstitutions ( )

Definition at line 184 of file class.ilAdvancedMDSubstitution.php.

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

References $substitutions.

Referenced by getParsedSubstitutions(), and isSubstituted().

Here is the caller graph for this function:

◆ hasNewline()

ilAdvancedMDSubstitution::hasNewline ( int $a_field_id )

Definition at line 199 of file class.ilAdvancedMDSubstitution.php.

                                               : bool
    {
        return in_array($a_field_id, $this->newline);
    }

Referenced by getParsedSubstitutions(), and update().

Here is the caller graph for this function:

◆ initECSMappings()

ilAdvancedMDSubstitution::initECSMappings ( )

private

Definition at line 284 of file class.ilAdvancedMDSubstitution.php.

                                      : void
    {
    }

Referenced by __construct().

Here is the caller graph for this function:

◆ isActive()

ilAdvancedMDSubstitution::isActive ( )

Definition at line 85 of file class.ilAdvancedMDSubstitution.php.

                              : bool
    {
        return $this->active;
    }

References $active.

◆ isBold()

ilAdvancedMDSubstitution::isBold ( int $a_field_id )

Definition at line 194 of file class.ilAdvancedMDSubstitution.php.

                                           : bool
    {
        return in_array($a_field_id, $this->bold);
    }

Referenced by getParsedSubstitutions(), and update().

Here is the caller graph for this function:

◆ isDescriptionEnabled()

ilAdvancedMDSubstitution::isDescriptionEnabled ( )

Definition at line 90 of file class.ilAdvancedMDSubstitution.php.

                                          : bool
    {
        return $this->enabled_desc;
    }

References $enabled_desc.

Referenced by update().

Here is the caller graph for this function:

◆ isSubstituted()

ilAdvancedMDSubstitution::isSubstituted ( int $a_field_id )

Definition at line 189 of file class.ilAdvancedMDSubstitution.php.

                                                  : bool
    {
        return in_array($a_field_id, $this->getSubstitutions());
    }

References getSubstitutions().

Here is the call graph for this function:

◆ parseValue()

ilAdvancedMDSubstitution::parseValue	(	int	$a_field_id,
		array	$a_values_records
	)

private

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

                                                                         : ?string
    {
        foreach ($a_values_records as $a_values) {
            if ($a_values->getADTGroup()->hasElement((string) $a_field_id)) {
                $element = $a_values->getADTGroup()->getElement((string) $a_field_id);
                if (!$element->isNull()) {
                    return ilADTFactory::getInstance()->getPresentationBridgeForInstance($element)->getList();
                }
            }
        }
        return null;
    }

References ilADTFactory\getInstance().

Referenced by getParsedSubstitutions().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ read()

ilAdvancedMDSubstitution::read ( )

private

Read db entries @access private.

Definition at line 240 of file class.ilAdvancedMDSubstitution.php.

                           : void
    {
        global $DIC;
 
        $ilDB = $DIC['ilDB'];
 
        // Check active status
        $query = "SELECT active,field_id,amfd.title FROM adv_md_record amr " .
            "JOIN adv_md_record_objs amro ON amr.record_id = amro.record_id " .
            "JOIN adv_mdf_definition amfd ON amr.record_id = amfd.record_id " .
            "WHERE active = 1 " .
            "AND obj_type = " . $this->db->quote($this->type, 'text') . " ";
        $res = $this->db->query($query);
        $this->active = $res->numRows() ? true : false;
        while ($row = $res->fetchRow(ilDBConstants::FETCHMODE_OBJECT)) {
            $this->active_fields[(int) $row->field_id] = (string) $row->title;
        }
 
        $query = "SELECT * FROM adv_md_substitutions " .
            "WHERE obj_type = " . $this->db->quote($this->type, 'text') . " ";
        $res = $this->db->query($query);
        $this->substitutions = array();
        $this->bold = array();
        $this->newline = array();
        while ($row = $res->fetchRow(ilDBConstants::FETCHMODE_OBJECT)) {
            $tmp_substitutions = unserialize((string) $row->substitution);
            if (is_array($tmp_substitutions)) {
                foreach ($tmp_substitutions as $substitution) {
                    if ($substitution['field_id']) {
                        $this->substitutions[] = $substitution['field_id'];
                    }
                    if ($substitution['bold']) {
                        $this->bold[] = $substitution['field_id'];
                    }
                    if ($substitution['newline']) {
                        $this->newline[] = $substitution['field_id'];
                    }
                }
            }
            $this->enabled_desc = !$row->hide_description;
            $this->enabled_field_names = !$row->hide_field_names;
        }
    }

References $DIC, $ilDB, $query, $res, ilDBConstants\FETCHMODE_OBJECT, ILIAS\Repository\int(), and true.

Referenced by __construct().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ resetSubstitutions()

ilAdvancedMDSubstitution::resetSubstitutions ( )

Definition at line 161 of file class.ilAdvancedMDSubstitution.php.

                                        : void
    {
        $this->substitutions = array();
        $this->bold = array();
        $this->newline = array();
    }

◆ sortDefinitions()

ilAdvancedMDSubstitution::sortDefinitions ( array $a_definitions )

Sort definitions.

Definition at line 73 of file class.ilAdvancedMDSubstitution.php.

                                                         : array
    {
        $sorted = array();
        foreach ($this->substitutions as $field_id) {
            if (isset($a_definitions[$field_id])) {
                $sorted[$field_id] = $a_definitions[$field_id];
                unset($a_definitions[$field_id]);
            }
        }
        return array_merge($sorted, $a_definitions);
    }

◆ update()

ilAdvancedMDSubstitution::update ( )

update @access public

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

                            : void
    {
        global $DIC;
 
        $ilDB = $DIC['ilDB'];
 
        $counter = 0;
        $substitutions = array();
 
        foreach ($this->substitutions as $field_id) {
            $substitutions[$counter]['field_id'] = $field_id;
            $substitutions[$counter]['bold'] = $this->isBold($field_id);
            $substitutions[$counter]['newline'] = $this->hasNewline($field_id);
            $counter++;
        }
 
        $query = "DELETE FROM adv_md_substitutions WHERE obj_type = " . $ilDB->quote($this->type, 'text');
        $res = $ilDB->manipulate($query);
 
        $values = array(
            'obj_type' => array('text', $this->type),
            'substitution' => array('clob', serialize($substitutions)),
            'hide_description' => array('integer', !$this->isDescriptionEnabled()),
            'hide_field_names' => array('integer', !$this->enabledFieldNames())
        );
        $ilDB->insert('adv_md_substitutions', $values);
    }