ilECSCategoryMappingRule Class Reference

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

Collaboration diagram for ilECSCategoryMappingRule:

Public Member Functions
	__construct (int $a_mapping_id=0)
	Constructor. More...
	getMappingId ()
	get mapping id More...
	setContainerId (int $a_id)
	set container id More...
	getContainerId ()
	get container id More...
	setDateRangeStart (ilDate $start)
	set date range start More...
	getDateRangeStart ()
	get date range start More...
	setDateRangeEnd (ilDate $end)
	set date range end More...
	getDateRangeEnd ()
	get date range end More...
	setFieldName (string $a_field)
	set field name More...
	getFieldName ()
	get field name More...
	setMappingType (int $a_type)
	set mapping type More...
	getMappingType ()
	get mapping type More...
	setMappingValue (string $a_value)
	set mapping value More...
	getMappingValue ()
	get mapping value More...
	getMappingAsArray ()
	get mapping values as array More...
	setByType (string $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 string 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 (int $a_id)
	set mapping id More...
	matchesValue ($a_value, int $a_type)
	Check if value matches. More...
	read ()
	Read entries. More...

Private Attributes
ilDBInterface	$db
ilLanguage	$language
ilLogger	$logger
int	$mapping_id
int	$container_id = null
string	$field_name = null
int	$mapping_type = ilECSCategoryMappingRule::TYPE_FIXED
string	$mapping_value = null
ilDate	$range_dt_start = null
ilDate	$range_dt_end = null
string	$by_type = null

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

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

Constructor & Destructor Documentation

__construct()

ilECSCategoryMappingRule::__construct

(

int

$a_mapping_id = 0

)

Constructor.

Parameters

int	mapping id

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

References $DIC, ILIAS\UI\examples\Symbol\Glyph\Language\language(), ILIAS\Repository\logger(), and read().

    {
        global $DIC;

        $this->db = $DIC->database();
        $this->language = $DIC->language();
        $this->logger = $DIC->logger()->wsrv();

        $this->mapping_id = $a_mapping_id;

        $this->read();
    }

Here is the call graph for this function:

Member Function Documentation

conditionToString()

ilECSCategoryMappingRule::conditionToString

(

)

condition to string

Returns

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

References ilDatePresentation\formatPeriod(), getByType(), getDateRangeEnd(), getDateRangeStart(), getFieldName(), getMappingType(), getMappingValue(), ILIAS\UI\examples\Symbol\Glyph\Language\language(), and participantsToString().

                                       : string
    {
        switch ($this->getMappingType()) {
            case self::TYPE_FIXED:

                if ($this->getFieldName() === 'part_id') {
                    return $this->language->txt('ecs_field_' . $this->getFieldName()) . ': ' . $this->participantsToString();
                }
                return $this->language->txt('ecs_field_' . $this->getFieldName()) . ': ' . $this->getMappingValue();

            case self::TYPE_DURATION:
                return $this->language->txt('ecs_field_' . $this->getFieldName()) . ': ' . ilDatePresentation::formatPeriod(
                    $this->getDateRangeStart(),
                    $this->getDateRangeEnd()
                );

            case self::TYPE_BY_TYPE:
                return $this->language->txt('type') . ': ' . $this->language->txt('obj_' . $this->getByType());
        }
        return "";
    }

Here is the call graph for this function:

delete()

ilECSCategoryMappingRule::delete

(

)

delete rule

Todo:

move to repository class

Returns

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

References getMappingId().

Referenced by ilECSSettingsGUI\deleteCategoryMappings().

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

Here is the call graph for this function:

Here is the caller graph for this function:

getByType()

ilECSCategoryMappingRule::getByType

(

)

get mapping by type

Returns

string

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

References $by_type.

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

                               : ?string
    {
        return $this->by_type;
    }

Here is the caller graph for this function:

getContainerId()

ilECSCategoryMappingRule::getContainerId

(

)

get container id

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

References $container_id.

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

                                    : ?int
    {
        return $this->container_id;
    }

Here is the caller graph for this function:

getDateRangeEnd()

ilECSCategoryMappingRule::getDateRangeEnd

(

)

get date range end

Returns

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

References $range_dt_end, getDateRangeStart(), and IL_CAL_MONTH.

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

                                     : ilDate
    {
        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;
    }

Here is the call graph for this function:

Here is the caller graph for this function:

getDateRangeStart()

ilECSCategoryMappingRule::getDateRangeStart

(

)

get date range start

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

References IL_CAL_UNIX.

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

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

Here is the caller graph for this function:

getFieldName()

ilECSCategoryMappingRule::getFieldName

(

)

get field name

Returns

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

References $field_name.

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

                                  : ?string
    {
        return $this->field_name;
    }

Here is the caller graph for this function:

getMappingAsArray()

ilECSCategoryMappingRule::getMappingAsArray

(

)

get mapping values as array

Returns

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

References getMappingValue().

Referenced by matchesValue().

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

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 84 of file class.ilECSCategoryMappingRule.php.

References $mapping_id.

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

                                  : int
    {
        return $this->mapping_id;
    }

Here is the caller graph for this function:

getMappingType()

ilECSCategoryMappingRule::getMappingType

(

)

get mapping type

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

References $mapping_type.

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

                                    : int
    {
        return $this->mapping_type;
    }

Here is the caller graph for this function:

getMappingValue()

ilECSCategoryMappingRule::getMappingValue

(

)

get mapping value

Returns

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

References $mapping_value.

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

                                     : ?string
    {
        return $this->mapping_value;
    }

Here is the caller graph for this function:

matches()

ilECSCategoryMappingRule::matches

(

array

$a_matchable_content

)

Check if rule matches a specific econtent.

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

References getFieldName(), and matchesValue().

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

Here is the call graph for this function:

matchesValue()

ilECSCategoryMappingRule::matchesValue (   $a_value, int  $a_type  )

protected

Check if value matches.

Parameters

mixed	$a_value	Econtent value
int	$a_type	Parameter type

Returns

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

References ilDateTime\_after(), ilDateTime\_before(), getDateRangeEnd(), getDateRangeStart(), getMappingAsArray(), getMappingType(), getMappingValue(), IL_CAL_UNIX, and ILIAS\Repository\logger().

Referenced by matches().

                                                          : bool
    {
        switch ($a_type) {
            case self::ATTR_ARRAY:
                $values = explode(',', $a_value);
                $this->logger->info(__METHOD__ . ': Checking for value: ' . $a_value);
                $this->logger->info(__METHOD__ . ': Checking against attribute values: ' . $this->getMappingValue());
                break;

            case self::ATTR_INT:
                $this->logger->info(__METHOD__ . ': Checking for value: ' . $a_value);
                $this->logger->info(__METHOD__ . ': Checking against attribute values: ' . $this->getMappingValue());
                $values = array((string)$a_value);
                break;

            case self::ATTR_STRING:
                $values = array($a_value);
                break;
        }

        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:
                    $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;
    }

Here is the call graph for this function:

Here is the caller graph for this function:

participantsToString()

ilECSCategoryMappingRule::participantsToString

(

)

get string presentation of participants

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

References ilECSCommunityReader\getInstanceByServerId(), and getMappingValue().

Referenced by conditionToString().

                                          : string
    {
        $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);
            $name = (count($part_id_arr) === 2) ? ilECSCommunityReader::getInstanceByServerId((int) $part_id_arr[0])
                ->getParticipantNameByMid((int) $part_id_arr[1]) : "Broken mapping entry in database";
            if ($name) {
                $part_string .= $name;
            } else {
                $part_string .= $part_id;
            }
            $part_string .= '"';
        }
        return $part_string;
    }

Here is the call graph for this function:

Here is the caller graph for this function:

read()

ilECSCategoryMappingRule::read ( )

protected

Read entries.

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

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

Referenced by __construct().

                             : bool
    {
        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((int) $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((int) $row->mapping_type);
            $this->setFieldName($row->field_name);
            $this->setContainerId((int) $row->container_id);

            if ($this->getMappingType() === self::TYPE_BY_TYPE) {
                $this->setByType($row->mapping_value);
            } else {
                $this->setMappingValue($row->mapping_value);
            }
        }
        return true;
    }

Here is the call graph for this function:

Here is the caller graph for this function:

save()

ilECSCategoryMappingRule::save

(

)

save

Returns

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

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

                          : void
    {
        if ($this->getMappingType() === self::TYPE_BY_TYPE) {
            $mapping_value = $this->getByType();
        } else {
            $mapping_value = $this->getMappingValue();
        }

        $mapping_id = $this->db->nextId('ecs_container_mapping');
        $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))
        );
    }

Here is the call graph for this function:

setByType()

ilECSCategoryMappingRule::setByType

(

string

$a_type

)

set mapping by type

Parameters

string

$type

Mapping type

Returns

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

Referenced by read().

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

Here is the caller graph for this function:

setContainerId()

ilECSCategoryMappingRule::setContainerId

(

int

$a_id

)

set container id

Parameters

int

$a_id

$a_container_id

Returns

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

Referenced by read().

                                             : void
    {
        $this->container_id = $a_id;
    }

Here is the caller graph for this function:

setDateRangeEnd()

ilECSCategoryMappingRule::setDateRangeEnd

(

ilDate

$end

)

set date range end

Parameters

object

$start

ilDate

Returns

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

Referenced by read().

                                                : void
    {
        $this->range_dt_end = $end;
    }

Here is the caller graph for this function:

setDateRangeStart()

ilECSCategoryMappingRule::setDateRangeStart

(

ilDate

$start

)

set date range start

Parameters

object

$start

ilDate

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

Referenced by read().

                                                    : void
    {
        $this->range_dt_start = $start;
    }

Here is the caller graph for this function:

setFieldName()

ilECSCategoryMappingRule::setFieldName

(

string

$a_field

)

set field name

Parameters

string

$a_field

field name

Returns

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

Referenced by read().

                                                 : void
    {
        $this->field_name = $a_field;
    }

Here is the caller graph for this function:

setMappingId()

ilECSCategoryMappingRule::setMappingId ( int  $a_id )

protected

set mapping id

Parameters

int

$a_mapping_id

mapping id

Returns

void

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

Referenced by read().

                                              : void
    {
        $this->mapping_id = $a_id;
    }

Here is the caller graph for this function:

setMappingType()

ilECSCategoryMappingRule::setMappingType

(

int

$a_type

)

set mapping type

Parameters

int

$a_type

Mapping type

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

Referenced by read().

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

Here is the caller graph for this function:

setMappingValue()

ilECSCategoryMappingRule::setMappingValue

(

string

$a_value

)

set mapping value

Parameters

string

$val

Mapping value

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

Referenced by read().

                                                    : void
    {
        $this->mapping_value = $a_value;
    }

Here is the caller graph for this function:

update()

ilECSCategoryMappingRule::update

(

)

update

Returns

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

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

                            : void
    {
        if ($this->getMappingType() === self::TYPE_BY_TYPE) {
            $mapping_value = $this->getByType();
        } else {
            $mapping_value = $this->getMappingValue();
        }

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

Here is the call graph for this function:

validate()

ilECSCategoryMappingRule::validate

(

)

validate rule

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

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

                              : string
    {
        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 && !$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 '';
    }

Here is the call graph for this function:

Field Documentation

$by_type

string ilECSCategoryMappingRule::$by_type = null

private

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

Referenced by getByType().

$container_id

int ilECSCategoryMappingRule::$container_id = null

private

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

Referenced by getContainerId().

$db

ilDBInterface ilECSCategoryMappingRule::$db

private

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

$field_name

string ilECSCategoryMappingRule::$field_name = null

private

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

Referenced by getFieldName().

$language

ilLanguage ilECSCategoryMappingRule::$language

private

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

$logger

ilLogger ilECSCategoryMappingRule::$logger

private

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

$mapping_id

int ilECSCategoryMappingRule::$mapping_id

private

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

Referenced by getMappingId().

$mapping_type

int ilECSCategoryMappingRule::$mapping_type = ilECSCategoryMappingRule::TYPE_FIXED

private

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

Referenced by getMappingType().

$mapping_value

string ilECSCategoryMappingRule::$mapping_value = null

private

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

Referenced by getMappingValue().

$range_dt_end

ilDate ilECSCategoryMappingRule::$range_dt_end = null

private

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

Referenced by getDateRangeEnd().

$range_dt_start

ilDate ilECSCategoryMappingRule::$range_dt_start = null

private

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

ATTR_ARRAY

const ilECSCategoryMappingRule::ATTR_ARRAY = 3

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

Referenced by ilECSUtils\getMatchableContent().

ATTR_INT

const ilECSCategoryMappingRule::ATTR_INT = 2

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

Referenced by ilECSUtils\getMatchableContent().

ATTR_STRING

const ilECSCategoryMappingRule::ATTR_STRING = 1

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

Referenced by ilECSUtils\getMatchableContent().

ERR_INVALID_DATES

const ilECSCategoryMappingRule::ERR_INVALID_DATES = 'ecs_err_invalid_dates'

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

ERR_INVALID_TYPE

const ilECSCategoryMappingRule::ERR_INVALID_TYPE = 'ecs_err_invalid_type'

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

ERR_MISSING_BY_TYPE

const ilECSCategoryMappingRule::ERR_MISSING_BY_TYPE = 'ecs_err_invalid_by_type'

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

ERR_MISSING_VALUE

const ilECSCategoryMappingRule::ERR_MISSING_VALUE = 'ecs_err_missing_value'

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

TYPE_BY_TYPE

const ilECSCategoryMappingRule::TYPE_BY_TYPE = 2

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

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

TYPE_DURATION

const ilECSCategoryMappingRule::TYPE_DURATION = 1

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

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

TYPE_FIXED

const ilECSCategoryMappingRule::TYPE_FIXED = 0

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

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

---

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

• components/ILIAS/WebServices/ECS/classes/class.ilECSCategoryMappingRule.php