ilECSCategoryMappingRule Class Reference

Defines a rule for the assignment of ECS remote courses to categories. More...

Collaboration diagram for ilECSCategoryMappingRule:

Public Member Functions
	__construct ($a_mapping_id=0)
	Constructor. More...
	getMappingId ()
	get mapping id More...
	setContainerId ($a_id)
	set container id More...
	getContainerId ()
	get container id More...
	setDateRangeStart ($start)
	set date range start More...
	getDateRangeStart ()
	get date range start More...
	setDateRangeEnd ($end)
	set date range end More...
	getDateRangeEnd ()
	get date range end More...
	setFieldName ($a_field)
	set field name More...
	getFieldName ()
	get field name More...
	setMappingType ($a_type)
	set mapping type More...
	getMappingType ()
	get mapping type More...
	setMappingValue ($a_value)
	set mapping value More...
	getMappingValue ()
	get mapping value More...
	getMappingAsArray ()
	get mapping values as array More...
	setByType ($a_type)
	set mapping by type More...
	getByType ()
	get mapping by type More...
	delete ()
	delete rule More...
	update ()
	update More...
	save ()
	save More...
	validate ()
	validate rule More...
	conditionToString ()
	condition to string More...
	participantsToString ()
	get strong presentation of participants More...
	matches (array $a_matchable_content)
	Check if rule matches a specific econtent. More...

Data Fields
const	ATTR_STRING = 1
const	ATTR_INT = 2
const	ATTR_ARRAY = 3
const	TYPE_FIXED = 0
const	TYPE_DURATION = 1
const	TYPE_BY_TYPE = 2
const	ERR_MISSING_VALUE = 'ecs_err_missing_value'
const	ERR_INVALID_DATES = 'ecs_err_invalid_dates'
const	ERR_INVALID_TYPE = 'ecs_err_invalid_type'
const	ERR_MISSING_BY_TYPE = 'ecs_err_invalid_by_type'

Protected Member Functions
	setMappingId ($a_id)
	set mapping id More...
	matchesValue ($a_value, $a_type)
	Check if value matches. More...
	read ()
	Read entries. More...

Protected Attributes
	$db

Private Attributes
	$mapping_id
	$container_id
	$field_name
	$mapping_type
	$mapping_value
	$range_dt_start
	$range_dt_end
	$by_type

Detailed Description

Defines a rule for the assignment of ECS remote courses to categories.

Author

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

Version

$Id$

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

Constructor & Destructor Documentation

__construct()

ilECSCategoryMappingRule::__construct

(

$a_mapping_id = 0

)

Constructor.

Parameters

int	mapping id

Definition at line 65 of file class.ilECSCategoryMappingRule.php.

    {
        global $DIC;
 
        $ilDB = $DIC['ilDB'];
        
        $this->mapping_id = $a_mapping_id;
        
        $this->db = $ilDB;
        $this->read();
    }

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

Here is the call graph for this function:

Member Function Documentation

conditionToString()

ilECSCategoryMappingRule::conditionToString

(

)

condition to string

Returns

Definition at line 354 of file class.ilECSCategoryMappingRule.php.

    {
        global $DIC;
 
        $lng = $DIC['lng'];
        
        switch ($this->getMappingType()) {
            case self::TYPE_FIXED:
 
                if ($this->getFieldName() == 'part_id') {
                    return $lng->txt('ecs_field_' . $this->getFieldName()) . ': ' . $this->participantsToString();
                }
                return $lng->txt('ecs_field_' . $this->getFieldName()) . ': ' . $this->getMappingValue();
                
            case self::TYPE_DURATION:
                return $lng->txt('ecs_field_' . $this->getFieldName()) . ': ' . ilDatePresentation::formatPeriod(
                    $this->getDateRangeStart(),
                    $this->getDateRangeEnd()
                );
                
            case self::TYPE_BY_TYPE:
                return $lng->txt('type') . ': ' . $lng->txt('obj_' . $this->getByType());
        }
    }

References $DIC, $lng, ilDatePresentation\formatPeriod(), getByType(), getDateRangeEnd(), getDateRangeStart(), getFieldName(), getMappingType(), getMappingValue(), participantsToString(), TYPE_BY_TYPE, TYPE_DURATION, and TYPE_FIXED.

Here is the call graph for this function:

delete()

ilECSCategoryMappingRule::delete

(

)

delete rule

Returns

Definition at line 247 of file class.ilECSCategoryMappingRule.php.

    {
        $sta = $this->db->manipulateF(
            'DELETE FROM ecs_container_mapping WHERE mapping_id = %s ',
            array('integer'),
            array($this->getMappingId())
        );
    }

References getMappingId().

Here is the call graph for this function:

getByType()

ilECSCategoryMappingRule::getByType

(

)

get mapping by type

Returns

string

Definition at line 238 of file class.ilECSCategoryMappingRule.php.

    {
        return $this->by_type;
    }

References $by_type.

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

Here is the caller graph for this function:

getContainerId()

ilECSCategoryMappingRule::getContainerId

(

)

get container id

Returns

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

    {
        return $this->container_id;
    }

References $container_id.

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

Here is the caller graph for this function:

getDateRangeEnd()

ilECSCategoryMappingRule::getDateRangeEnd

(

)

get date range end

Returns

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

    {
        if ($this->range_dt_end) {
            return $this->range_dt_end;
        }
        $this->range_dt_end = $this->getDateRangeStart();
        $this->range_dt_end->increment(IL_CAL_MONTH, 6);
        return $this->range_dt_end;
    }

References $range_dt_end, getDateRangeStart(), and IL_CAL_MONTH.

Referenced by conditionToString(), matchesValue(), save(), update(), and validate().

Here is the call graph for this function:

Here is the caller graph for this function:

getDateRangeStart()

ilECSCategoryMappingRule::getDateRangeStart

(

)

get date range start

Returns

Definition at line 129 of file class.ilECSCategoryMappingRule.php.

    {
        return $this->range_dt_start ? $this->range_dt_start : new ilDate(time(), IL_CAL_UNIX);
    }

References IL_CAL_UNIX.

Referenced by conditionToString(), getDateRangeEnd(), matchesValue(), save(), update(), and validate().

Here is the caller graph for this function:

getFieldName()

ilECSCategoryMappingRule::getFieldName

(

)

get field name

Returns

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

    {
        return $this->field_name;
    }

References $field_name.

Referenced by conditionToString(), matches(), save(), update(), and validate().

Here is the caller graph for this function:

getMappingAsArray()

ilECSCategoryMappingRule::getMappingAsArray

(

)

get mapping values as array

Returns

Definition at line 219 of file class.ilECSCategoryMappingRule.php.

    {
        return explode(',', $this->getMappingValue());
    }

References getMappingValue().

Referenced by matchesValue().

Here is the call graph for this function:

Here is the caller graph for this function:

getMappingId()

ilECSCategoryMappingRule::getMappingId

(

)

get mapping id

Returns

Definition at line 91 of file class.ilECSCategoryMappingRule.php.

    {
        return $this->mapping_id;
    }

References $mapping_id.

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

Here is the caller graph for this function:

getMappingType()

ilECSCategoryMappingRule::getMappingType

(

)

get mapping type

Returns

Definition at line 191 of file class.ilECSCategoryMappingRule.php.

    {
        return $this->mapping_type;
    }

References $mapping_type.

Referenced by conditionToString(), matchesValue(), read(), save(), update(), and validate().

Here is the caller graph for this function:

getMappingValue()

ilECSCategoryMappingRule::getMappingValue

(

)

get mapping value

Returns

Definition at line 210 of file class.ilECSCategoryMappingRule.php.

    {
        return $this->mapping_value;
    }

References $mapping_value.

Referenced by conditionToString(), getMappingAsArray(), matchesValue(), participantsToString(), save(), update(), and validate().

Here is the caller graph for this function:

matches()

ilECSCategoryMappingRule::matches

(

array

$a_matchable_content

)

Check if rule matches a specific econtent.

Parameters

array

$a_matchable_content

Returns

bool

Definition at line 413 of file class.ilECSCategoryMappingRule.php.

    {
        if (isset($a_matchable_content[$this->getFieldName()])) {
            $value = $a_matchable_content[$this->getFieldName()];
            return $this->matchesValue($value[0], $value[1]);
        }
        return false;
    }

References getFieldName(), and matchesValue().

Here is the call graph for this function:

matchesValue()

ilECSCategoryMappingRule::matchesValue (   $a_value,   $a_type  )

protected

Check if value matches.

Parameters

mixed	$a_value	Econtent value
int	$a_type	Parameter type

Returns

Definition at line 428 of file class.ilECSCategoryMappingRule.php.

    {
        global $DIC;
 
        $ilLog = $DIC['ilLog'];
        
        
        switch ($a_type) {
            case self::ATTR_ARRAY:
                $values = explode(',', $a_value);
                $ilLog->write(__METHOD__ . ': Checking for value: ' . $a_value);
                $ilLog->write(__METHOD__ . ': Checking against attribute values: ' . $this->getMappingValue());
                break;
                
            case self::ATTR_INT:
                $ilLog->write(__METHOD__ . ': Checking for value: ' . $a_value);
                $ilLog->write(__METHOD__ . ': Checking against attribute values: ' . $this->getMappingValue());
                $values = array($a_value);
                break;
                
            case self::ATTR_STRING:
                $values = array($a_value);
                break;
        }
        $values = explode(',', $a_value);
        
        foreach ($values as $value) {
            $value = trim($value);
            switch ($this->getMappingType()) {
                case self::TYPE_FIXED:
                    
                    foreach ($this->getMappingAsArray() as $attribute_value) {
                        $attribute_value = trim($attribute_value);
                        if (strcasecmp($attribute_value, $value) == 0) {
                            return true;
                        }
                    }
                    break;
                    
                case self::TYPE_DURATION:
                    include_once './Services/Calendar/classes/class.ilDateTime.php';
                    $tmp_date = new ilDate($a_value, IL_CAL_UNIX);
                    return ilDateTime::_after($tmp_date, $this->getDateRangeStart()) and
                        ilDateTime::_before($tmp_date, $this->getDateRangeEnd());
            }
        }
        return false;
    }

References $a_type, $DIC, $ilLog, $values, ilDateTime\_after(), ilDateTime\_before(), ATTR_ARRAY, ATTR_INT, ATTR_STRING, getDateRangeEnd(), getDateRangeStart(), getMappingAsArray(), getMappingType(), getMappingValue(), IL_CAL_UNIX, TYPE_DURATION, and TYPE_FIXED.

Referenced by matches().

Here is the call graph for this function:

Here is the caller graph for this function:

participantsToString()

ilECSCategoryMappingRule::participantsToString

(

)

get strong presentation of participants

Parameters

return

Definition at line 384 of file class.ilECSCategoryMappingRule.php.

    {
        include_once './Services/WebServices/ECS/classes/class.ilECSUtils.php';
        
        $part_string = "";
        $part = explode(',', $this->getMappingValue());
        $counter = 0;
        foreach ($part as $part_id) {
            if ($counter++) {
                $part_string .= ', ';
            }
            $part_string .= '"';
            
            $part_id_arr = explode('_', $part_id);
            if ($name = ilECSUtils::lookupParticipantName($part_id_arr[1], $part_id_arr[0])) {
                $part_string .= $name;
            } else {
                $part_string .= $part_id;
            }
            $part_string .= '"';
        }
        return $part_string;
    }

References $name, getMappingValue(), and ilECSUtils\lookupParticipantName().

Referenced by conditionToString().

Here is the call graph for this function:

Here is the caller graph for this function:

read()

ilECSCategoryMappingRule::read ( )

protected

Read entries.

Returns

Definition at line 481 of file class.ilECSCategoryMappingRule.php.

    {
        if (!$this->getMappingId()) {
            return false;
        }
        $res = $this->db->queryF(
            'SELECT * FROM ecs_container_mapping WHERE mapping_id = %s',
            array('integer'),
            array($this->getMappingId())
        );
        while ($row = $this->db->fetchObject($res)) {
            $this->setMappingId($row->mapping_id);
            $this->setDateRangeStart($row->date_range_start ? new ilDate($row->date_range_start, IL_CAL_UNIX) : null);
            $this->setDateRangeEnd($row->date_range_end ? new ilDate($row->date_range_end, IL_CAL_UNIX) : null);
            $this->setMappingType($row->mapping_type);
            $this->setFieldName($row->field_name);
            $this->setContainerId($row->container_id);
            
            if ($this->getMappingType() == self::TYPE_BY_TYPE) {
                $this->setByType($row->mapping_value);
            } else {
                $this->setMappingValue($row->mapping_value);
            }
        }
        return true;
    }

References $res, $row, getMappingId(), getMappingType(), IL_CAL_UNIX, setByType(), setContainerId(), setDateRangeEnd(), setDateRangeStart(), setFieldName(), setMappingId(), setMappingType(), and setMappingValue().

Referenced by __construct().

Here is the call graph for this function:

Here is the caller graph for this function:

save()

ilECSCategoryMappingRule::save

(

)

save

Returns

Definition at line 293 of file class.ilECSCategoryMappingRule.php.

    {
        global $DIC;
 
        $ilDB = $DIC['ilDB'];
        
        if ($this->getMappingType() == self::TYPE_BY_TYPE) {
            $mapping_value = $this->getByType();
        } else {
            $mapping_value = $this->getMappingValue();
        }
        
        $mapping_id = $ilDB->nextId('ecs_container_mapping');
        $sta = $this->db->manipulateF(
            'INSERT INTO ecs_container_mapping  ' .
            '(mapping_id,container_id,field_name,mapping_type,mapping_value,date_range_start,date_range_end) ' .
            'VALUES(%s,%s,%s,%s,%s,%s,%s) ',
            array('integer','integer','text','integer','text','integer','integer'),
            array(
                $mapping_id,
                $this->getContainerId(),
                $this->getFieldName(),
                $this->getMappingType(),
                $mapping_value,
                $this->getDateRangeStart()->get(IL_CAL_UNIX),
                $this->getDateRangeEnd()->get(IL_CAL_UNIX))
        );
    }

References $DIC, $ilDB, $mapping_id, $mapping_value, getByType(), getContainerId(), getDateRangeEnd(), getDateRangeStart(), getFieldName(), getMappingType(), getMappingValue(), and IL_CAL_UNIX.

Here is the call graph for this function:

setByType()

ilECSCategoryMappingRule::setByType

(

$a_type

)

set mapping by type

Parameters

string

$type

Mapping type

Returns

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

    {
        $this->by_type = $a_type;
    }

References $a_type.

Referenced by read().

Here is the caller graph for this function:

setContainerId()

ilECSCategoryMappingRule::setContainerId

(

$a_id

)

set container id

Parameters

int

$a_id

$a_container_id

Returns

Definition at line 101 of file class.ilECSCategoryMappingRule.php.

    {
        $this->container_id = $a_id;
    }

Referenced by read().

Here is the caller graph for this function:

setDateRangeEnd()

ilECSCategoryMappingRule::setDateRangeEnd

(

$end

)

set date range end

Parameters

object

$start

ilDate

Returns

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

    {
        $this->range_dt_end = $end;
    }

References $end.

Referenced by read().

Here is the caller graph for this function:

setDateRangeStart()

ilECSCategoryMappingRule::setDateRangeStart

(

$start

)

set date range start

Parameters

object

$start

ilDate

Returns

Definition at line 120 of file class.ilECSCategoryMappingRule.php.

    {
        $this->range_dt_start = $start;
    }

References $start.

Referenced by read().

Here is the caller graph for this function:

setFieldName()

ilECSCategoryMappingRule::setFieldName

(

$a_field

)

set field name

Parameters

string

$a_field

field name

Returns

Definition at line 163 of file class.ilECSCategoryMappingRule.php.

    {
        $this->field_name = $a_field;
    }

Referenced by read().

Here is the caller graph for this function:

setMappingId()

ilECSCategoryMappingRule::setMappingId (   $a_id )

protected

set mapping id

Parameters

int

$a_mapping_id

mapping id

Returns

void

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

    {
        $this->mapping_id = $a_id;
    }

Referenced by read().

Here is the caller graph for this function:

setMappingType()

ilECSCategoryMappingRule::setMappingType

(

$a_type

)

set mapping type

Parameters

int

$type

Mapping type

Returns

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

    {
        $this->mapping_type = $a_type;
    }

References $a_type.

Referenced by read().

Here is the caller graph for this function:

setMappingValue()

ilECSCategoryMappingRule::setMappingValue

(

$a_value

)

set mapping value

Parameters

string

$val

Mapping value

Returns

Definition at line 201 of file class.ilECSCategoryMappingRule.php.

    {
        $this->mapping_value = $a_value;
    }

Referenced by read().

Here is the caller graph for this function:

update()

ilECSCategoryMappingRule::update

(

)

update

Returns

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

    {
        if ($this->getMappingType() == self::TYPE_BY_TYPE) {
            $mapping_value = $this->getByType();
        } else {
            $mapping_value = $this->getMappingValue();
        }
        
        $sta = $this->db->manipulateF(
            'UPDATE ecs_container_mapping SET ' .
            'container_id = %s, ' .
            'field_name = %s, ' .
            'mapping_type = %s, ' .
            'mapping_value = %s, ' .
            'date_range_start = %s,' .
            'date_range_end = %s ' .
            'WHERE mapping_id = %s',
            array('integer','text','integer','text','integer','integer','integer'),
            array(
            $this->getContainerId(),
            $this->getFieldName(),
            $this->getMappingType(),
            $mapping_value,
            $this->getDateRangeStart()->get(IL_CAL_UNIX),
            $this->getDateRangeEnd()->get(IL_CAL_UNIX),
            $this->getMappingId())
        );
    }

References $mapping_value, getByType(), getContainerId(), getDateRangeEnd(), getDateRangeStart(), getFieldName(), getMappingId(), getMappingType(), getMappingValue(), and IL_CAL_UNIX.

Here is the call graph for this function:

validate()

ilECSCategoryMappingRule::validate

(

)

validate rule

Returns

Definition at line 326 of file class.ilECSCategoryMappingRule.php.

    {
        if (ilObject::_lookupType(ilObject::_lookupObjId($this->getContainerId())) != 'cat') {
            return self::ERR_INVALID_TYPE;
        }
        if (!ilDateTime::_after($this->getDateRangeEnd(), $this->getDateRangeStart(), IL_CAL_DAY)) {
            return self::ERR_INVALID_DATES;
        }
        if ($this->getMappingType() == self::TYPE_DURATION && !in_array($this->getFieldName(), array('begin', 'end'))) {
            return self::ERR_MISSING_VALUE;
        }
        // handled by form gui?
        if ($this->getMappingType() == self::TYPE_FIXED and !$this->getMappingValue()) {
            return self::ERR_MISSING_VALUE;
        }
        if ($this->getMappingType() == self::TYPE_BY_TYPE && $this->getFieldName() != 'type') {
            return self::ERR_MISSING_BY_TYPE;
        }
        if ($this->getMappingType() != self::TYPE_BY_TYPE && $this->getFieldName() == 'type') {
            return self::ERR_MISSING_VALUE;
        }
        return 0;
    }

References ilDateTime\_after(), ilObject\_lookupObjId(), ilObject\_lookupType(), ERR_INVALID_DATES, ERR_INVALID_TYPE, ERR_MISSING_BY_TYPE, ERR_MISSING_VALUE, getContainerId(), getDateRangeEnd(), getDateRangeStart(), getFieldName(), getMappingType(), getMappingValue(), and IL_CAL_DAY.

Here is the call graph for this function:

Field Documentation

$by_type

ilECSCategoryMappingRule::$by_type

private

Definition at line 59 of file class.ilECSCategoryMappingRule.php.

Referenced by getByType().

$container_id

ilECSCategoryMappingRule::$container_id

private

Definition at line 53 of file class.ilECSCategoryMappingRule.php.

Referenced by getContainerId().

$db

ilECSCategoryMappingRule::$db

protected

Definition at line 50 of file class.ilECSCategoryMappingRule.php.

$field_name

ilECSCategoryMappingRule::$field_name

private

Definition at line 54 of file class.ilECSCategoryMappingRule.php.

Referenced by getFieldName().

$mapping_id

ilECSCategoryMappingRule::$mapping_id

private

Definition at line 52 of file class.ilECSCategoryMappingRule.php.

Referenced by getMappingId(), and save().

$mapping_type

ilECSCategoryMappingRule::$mapping_type

private

Definition at line 55 of file class.ilECSCategoryMappingRule.php.

Referenced by getMappingType().

$mapping_value

ilECSCategoryMappingRule::$mapping_value

private

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

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

$range_dt_end

ilECSCategoryMappingRule::$range_dt_end

private

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

Referenced by getDateRangeEnd().

$range_dt_start

ilECSCategoryMappingRule::$range_dt_start

private

Definition at line 57 of file class.ilECSCategoryMappingRule.php.

ATTR_ARRAY

const ilECSCategoryMappingRule::ATTR_ARRAY = 3

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

Referenced by ilECSUtils\getMatchableContent(), and matchesValue().

ATTR_INT

const ilECSCategoryMappingRule::ATTR_INT = 2

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

Referenced by ilECSUtils\getMatchableContent(), and matchesValue().

ATTR_STRING

const ilECSCategoryMappingRule::ATTR_STRING = 1

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

Referenced by ilECSUtils\getMatchableContent(), and matchesValue().

ERR_INVALID_DATES

const ilECSCategoryMappingRule::ERR_INVALID_DATES = 'ecs_err_invalid_dates'

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

Referenced by validate().

ERR_INVALID_TYPE

const ilECSCategoryMappingRule::ERR_INVALID_TYPE = 'ecs_err_invalid_type'

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

Referenced by validate().

ERR_MISSING_BY_TYPE

const ilECSCategoryMappingRule::ERR_MISSING_BY_TYPE = 'ecs_err_invalid_by_type'

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

Referenced by validate().

ERR_MISSING_VALUE

const ilECSCategoryMappingRule::ERR_MISSING_VALUE = 'ecs_err_missing_value'

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

Referenced by validate().

TYPE_BY_TYPE

const ilECSCategoryMappingRule::TYPE_BY_TYPE = 2

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

Referenced by ilECSSettingsGUI\addCategoryMapping(), conditionToString(), ilECSSettingsGUI\initCategoryMappingForm(), and ilECSSettingsGUI\updateCategoryMapping().

TYPE_DURATION

const ilECSCategoryMappingRule::TYPE_DURATION = 1

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

Referenced by ilECSSettingsGUI\addCategoryMapping(), conditionToString(), ilECSSettingsGUI\initCategoryMappingForm(), matchesValue(), and ilECSSettingsGUI\updateCategoryMapping().

TYPE_FIXED

const ilECSCategoryMappingRule::TYPE_FIXED = 0

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

Referenced by ilECSSettingsGUI\addCategoryMapping(), conditionToString(), ilECSSettingsGUI\initCategoryMappingForm(), matchesValue(), and ilECSSettingsGUI\updateCategoryMapping().

---

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

• Services/WebServices/ECS/classes/class.ilECSCategoryMappingRule.php