Collaboration diagram for ilAdvancedMDSubstitution:

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

	isActive ()
	Is substitution active. More...

	isDescriptionEnabled ()
	Is description enabled. More...

	enableDescription ($a_status)
	Enable description presentation. More...

	enabledFieldNames ()
	is field name enabled More...

	enableFieldNames ($a_status)
	enable field names More...

	getParsedSubstitutions ($a_ref_id, $a_obj_id)
	Substitute. More...

	resetSubstitutions ()
	set substitutions More...

	appendSubstitution ($a_field_id, $a_bold=false, $a_newline=false)
	append field to substitutions More...

	getSubstitutions ()
	get substitution string More...

	isSubstituted ($a_field_id)
	is substituted More...

	isBold ($a_field_id)
	is bold More...

	hasNewline ($a_field_id)
	has newline More...

	update ()
	update More...

Static Public Member Functions
static	_getInstanceByObjectType ($a_type)
	Singleton: use this method to get an instance. More...

Protected Attributes
	$db

	$type

	$substitutions

	$bold = array()

	$newline = array()

	$enabled_desc = true

	$enabled_field_names = true

	$active = false

	$date_fields = array()

	$datetime_fields = array()

	$active_fields = array()

Private Member Functions
	__construct ($a_type)

	parseValue ($a_field_id, $a_values_records)
	special handling for date(time) values and ECS dates More...

	read ()
	Read db entries. More...

	initECSMappings ()
	init ECS mappings More...

Static Private Attributes
static	$instances = null

static	$mappings = null

Detailed Description

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

Version: $Id$

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

Constructor & Destructor Documentation

◆ __construct()

ilAdvancedMDSubstitution::__construct ( $a_type )

private

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

    {
        global $DIC;
 
        $ilDB = $DIC['ilDB'];
        
        $this->db = $ilDB;
        $this->type = $a_type;
        
        $this->initECSMappings();
        $this->read();
    }

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

Here is the call graph for this function:

Member Function Documentation

◆ _getInstanceByObjectType()

static ilAdvancedMDSubstitution::_getInstanceByObjectType ( $a_type )

static

Singleton: use this method to get an instance.

Parameters

string ilias object type (3 or 4 characters) @access public

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

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

References $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\parseAppointmentPresentation(), and ilAdvancedMDSettingsGUI\updateSubstitutions().

Here is the caller graph for this function:

◆ appendSubstitution()

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

append field to substitutions

@access public

Parameters

int field id

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

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

◆ enableDescription()

ilAdvancedMDSubstitution::enableDescription ( $a_status )

Enable description presentation.

@access public

Parameters

bool	status description enabled

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

    {
        $this->enabled_desc = $a_status;
    }

◆ enabledFieldNames()

ilAdvancedMDSubstitution::enabledFieldNames ( )

is field name enabled

@access public

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

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

References $enabled_field_names.

Referenced by getParsedSubstitutions(), and update().

Here is the caller graph for this function:

◆ enableFieldNames()

ilAdvancedMDSubstitution::enableFieldNames ( $a_status )

enable field names

@access public

Parameters

bool	enable/disable status

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

    {
        $this->enabled_field_names = $a_status;
    }

◆ getParsedSubstitutions()

ilAdvancedMDSubstitution::getParsedSubstitutions	(	$a_ref_id,
		$a_obj_id
	)

Substitute.

@access public

Parameters

int	ref_id
int	obj_id
string	description

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

    {
        if (!count($this->getSubstitutions())) {
            return array();
        }
        
        include_once('Services/AdvancedMetaData/classes/class.ilAdvancedMDValues.php');
        $values_records = ilAdvancedMDValues::preloadedRead($this->type, $a_obj_id);
                
        $counter = 0;
        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 ? $substituted : array();
    }

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

Here is the call graph for this function:

◆ getSubstitutions()

ilAdvancedMDSubstitution::getSubstitutions ( )

get substitution string

@access public

Parameters

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

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

Referenced by getParsedSubstitutions(), and isSubstituted().

Here is the caller graph for this function:

◆ hasNewline()

ilAdvancedMDSubstitution::hasNewline ( $a_field_id )

has newline

@access public

Parameters

int field_id

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

    {
        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

init ECS mappings

@access private

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

    {
        return true;
 
        include_once('./Services/WebServices/ECS/classes/class.ilECSDataMappingSettings.php');
        
        if (isset(self::$mappings) and is_object(self::$mappings)) {
            return true;
        }
        self::$mappings = ilECSDataMappingSettings::_getInstance();
        return true;
    }

References ilECSDataMappingSettings\_getInstance().

Referenced by __construct().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ isActive()

ilAdvancedMDSubstitution::isActive ( )

Is substitution active.

@access public

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

    {
        return $this->active;
    }

References $active.

◆ isBold()

ilAdvancedMDSubstitution::isBold ( $a_field_id )

is bold

@access public

Parameters

int field_id

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

    {
        #var_dump("<pre>",$this->bold,$a_field_id,"</pre>");
        
        return in_array($a_field_id, $this->bold);
    }

Referenced by getParsedSubstitutions(), and update().

Here is the caller graph for this function:

◆ isDescriptionEnabled()

ilAdvancedMDSubstitution::isDescriptionEnabled ( )

Is description enabled.

@access public

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

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

References $enabled_desc.

Referenced by update().

Here is the caller graph for this function:

◆ isSubstituted()

ilAdvancedMDSubstitution::isSubstituted ( $a_field_id )

is substituted

@access public

Parameters

int field_id

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

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

References getSubstitutions().

Here is the call graph for this function:

◆ parseValue()

ilAdvancedMDSubstitution::parseValue	(	$a_field_id,
		$a_values_records
	)

private

special handling for date(time) values and ECS dates

Parameters

int	$a_field_id	field ID
array	$a_values_records	values @access public

Returns: string parsed value

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

    {
        global $DIC;
 
        $ilUser = $DIC['ilUser'];
        
        if ($this->type == 'crs' or $this->type == 'rcrs') {
            // Special handling for ECS fields
            // @FIXME
            /*
            if($a_field_id == self::$mappings->getMappingByECSName('begin') and
                $end = self::$mappings->getMappingByECSName('end'))
            {
                // Parse a duration
                $start = in_array($a_field_id,$this->date_fields) ?
                    new ilDate($a_values[$a_field_id],IL_CAL_UNIX) :
                    new ilDateTime($a_values[$a_field_id],IL_CAL_UNIX);
                $end = in_array($end,$this->date_fields) ?
                    new ilDate($a_values[$end],IL_CAL_UNIX) :
                    new ilDateTime($a_values[$end],IL_CAL_UNIX);
 
                include_once('./Services/Calendar/classes/class.ilCalendarUtil.php');
                $weekday = ilCalendarUtil::_numericDayToString($start->get(IL_CAL_FKT_DATE,'w',$ilUser->getTimeZone()),false);
 
                ilDatePresentation::setUseRelativeDates(false);
                $value = ilDatePresentation::formatPeriod($start,$end);
                ilDatePresentation::setUseRelativeDates(true);
                return $weekday.', '.$value;
            }
            */
        }
        
        foreach ($a_values_records as $a_values) {
            if ($a_values->getADTGroup()->hasElement($a_field_id)) {
                $element = $a_values->getADTGroup()->getElement($a_field_id);
                if (!$element->isNull()) {
                    return ilADTFactory::getInstance()->getPresentationBridgeForInstance($element)->getList();
                }
            }
        }
    }

References $DIC, $ilUser, and 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 386 of file class.ilAdvancedMDSubstitution.php.

    {
        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[$row->field_id] = $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($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;
        }
 
        if ($this->type == 'crs' or $this->type == 'rcrs') {
            // Handle ECS substitutions
            /*
             if($begin = self::$mappings->getMappingByECSName('begin') and
                 $end = self::$mappings->getMappingByECSName('end'))
             {
                 // Show something like 'Monday, 30.12.2008 9:00 - 12:00'
                 unset($this->active_fields[$end]);
             }
            */
        }
    }

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

Referenced by __construct().

Here is the caller graph for this function:

◆ resetSubstitutions()

ilAdvancedMDSubstitution::resetSubstitutions ( )

set substitutions

@access public

Parameters

array array of field definitions

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

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

◆ sortDefinitions()

ilAdvancedMDSubstitution::sortDefinitions ( $a_definitions )

Sort definitions.

@access public

Parameters

array int field_id

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

    {
        $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 351 of file class.ilAdvancedMDSubstitution.php.

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