ilECSCategoryMapping Class Reference

Collaboration diagram for ilECSCategoryMapping:

Static Public Member Functions
static	getActiveRules ()
	get active rules More...
static	getMatchingCategory (int $a_server_id, array $a_matchable_content)
	get matching category More...
static	handleUpdate (int $a_obj_id, int $a_server_id, array $a_matchable_content)
	Handle update of ecs content and create references. More...
static	lookupHandledCategories ()
static	getPossibleFields ()

Static Private Attributes
static array	$cached_active_rules = null

Detailed Description

Author

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

Definition at line 24 of file class.ilECSCategoryMapping.php.

Member Function Documentation

getActiveRules()

static ilECSCategoryMapping::getActiveRules ( )

static

get active rules

Returns

ilECSCategoryMappingRule[]

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

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

Referenced by ilECSSettingsGUI\showRulesTable().

                                           : array
    {
        global $DIC;

        $ilDB = $DIC['ilDB'];
        $rules = [];
        $res = $ilDB->query('SELECT mapping_id FROM ecs_container_mapping');
        while ($row = $res->fetchRow(ilDBConstants::FETCHMODE_OBJECT)) {
            $rules[] = new ilECSCategoryMappingRule((int) $row->mapping_id);
        }
        return $rules;
    }

Here is the caller graph for this function:

getMatchingCategory()

static ilECSCategoryMapping::getMatchingCategory ( int  $a_server_id, array  $a_matchable_content  )

static

get matching category

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

References $DIC, and ilECSSetting\getInstanceByServerId().

Referenced by ilRemoteObjectBase\createFromECSEContent().

                                                                                            : ?int
    {
        global $DIC;

        $logger = $DIC->logger()->wsrv();

        if (is_null(self::$cached_active_rules)) {
            self::$cached_active_rules = self::getActiveRules();
        }
        foreach (self::$cached_active_rules as $rule) {
            if ($rule->matches($a_matchable_content)) {
                $logger->info(__METHOD__ . ': Found assignment for field type: ' . $rule->getFieldName());
                return $rule->getContainerId();
            }
            $logger->error(__METHOD__ . ': Category assignment failed for field: ' . $rule->getFieldName());
        }
        // Return default container
        $logger->info(__METHOD__ . ': Using default container');

        return ilECSSetting::getInstanceByServerId($a_server_id)->getImportId();
    }

Here is the call graph for this function:

Here is the caller graph for this function:

getPossibleFields()

static ilECSCategoryMapping::getPossibleFields ( )

static

Returns

array<string,string> tthe possible fields with translation

Definition at line 142 of file class.ilECSCategoryMapping.php.

References $DIC, $lng, and ilECSUtils\_getOptionalECourseFields().

Referenced by ilECSSettingsGUI\initCategoryMappingForm().

                                              : array
    {
        global $DIC;

        $lng = $DIC['lng'];

        $options = array(
            "community" => $lng->txt("ecs_field_community"),
            "part_id" => $lng->txt("ecs_field_part_id"),
            "type" => $lng->txt("type")
        );

        // will be handled by server soon?

        // only courses for now
        $course_fields = ilECSUtils::_getOptionalECourseFields();
        foreach ($course_fields as $field) {
            $options[$field] = $lng->txt("obj_rcrs") . " - " . $lng->txt("ecs_field_" . $field);
        }

        return $options;
    }

Here is the call graph for this function:

Here is the caller graph for this function:

handleUpdate()

static ilECSCategoryMapping::handleUpdate ( int  $a_obj_id, int  $a_server_id, array  $a_matchable_content  )

static

Handle update of ecs content and create references.

Definition at line 74 of file class.ilECSCategoryMapping.php.

References $DIC, $ref_id, ilObject\_getAllReferences(), ilObject\_lookupObjId(), and ilObjectFactory\getInstanceByRefId().

Referenced by ilRemoteObjectBase\updateFromECSContent().

                                                                                                    : bool
    {
        global $DIC;

        $tree = $DIC->repositoryTree();
        $logger = $DIC->logger()->wsrv();

        $cat = self::getMatchingCategory($a_server_id, $a_matchable_content);

        $a_ref_id = current(ilObject::_getAllReferences($a_obj_id));
        $references = ilObject::_getAllReferences(ilObject::_lookupObjId($a_ref_id));
        $all_cats = self::lookupHandledCategories();

        $exists = false;
        foreach (array_keys($references) as $ref_id) {
            if ($tree->getParentId($ref_id) === $cat) {
                $exists = true;
            }
        }
        $logger->info(__METHOD__ . ': Creating/Deleting references...');

        if (!$exists) {
            $logger->info(__METHOD__ . ': Add new reference. STEP 1');

            if ($obj_data = ilObjectFactory::getInstanceByRefId($a_ref_id, false)) {
                $obj_data->createReference();
                $obj_data->putInTree($cat);
                $obj_data->setPermissions($cat);
                $logger->info(__METHOD__ . ': Add new reference.');
            }
        }
        // Now delete old references
        foreach (array_keys($references) as $ref_id) {
            $parent = $tree->getParentId($ref_id);
            if ($parent === $cat) {
                continue;
            }
            if (!in_array($parent, $all_cats, true)) {
                continue;
            }
            if ($to_delete = ilObjectFactory::getInstanceByRefId($ref_id)) {
                $to_delete->delete();
                $logger->write(__METHOD__ . ': Deleted deprecated reference.');
            }
        }
        return true;
    }

Here is the call graph for this function:

Here is the caller graph for this function:

lookupHandledCategories()

static ilECSCategoryMapping::lookupHandledCategories ( )

static

Returns

int[] the container ids for the ecs container mapping

Definition at line 125 of file class.ilECSCategoryMapping.php.

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

                                                    : array
    {
        global $DIC;

        $ilDB = $DIC->database();

        $ref_ids = [];
        $res = $ilDB->query("SELECT container_id FROM ecs_container_mapping ");
        while ($row = $res->fetchRow(ilDBConstants::FETCHMODE_OBJECT)) {
            $ref_ids[] = $row->container_id;
        }
        return $ref_ids;
    }

Field Documentation

$cached_active_rules

array ilECSCategoryMapping::$cached_active_rules = null

staticprivate

Definition at line 26 of file class.ilECSCategoryMapping.php.

---

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

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