ilObjCourseGrouping Class Reference

Class ilObj<module_name> More...

Collaboration diagram for ilObjCourseGrouping:

Public Member Functions
	__construct ($a_id=0)
	Constructor public. More...
	setId ($a_id)
	getId ()
	setContainerRefId ($a_ref_id)
	getContainerRefId ()
	setContainerObjId ($a_obj_id)
	getContainerObjId ()
	getContainerType ()
	setContainerType ($a_type)
	setType ($a_type)
	getType ()
	setTitle ($a_title)
	getTitle ()
	setDescription ($a_desc)
	getDescription ()
	setUniqueField ($a_uni)
	getUniqueField ()
	getCountAssignedItems ()
	getAssignedItems ()
	delete ()
	create ($a_course_ref_id, $a_course_id)
	update ()
	isAssigned ($a_course_id)
	read ()
	_checkAccess ($grouping_id)
	assign ($a_crs_ref_id, $a_course_id)
	deassign ($a_crs_ref_id, $a_course_id)
	cloneGrouping ($a_target_id, $a_copy_id)
	__addCondition ($a_target_ref_id, $a_target_obj_id)

Static Public Member Functions
static	_getVisibleGroupings ($a_obj_id)
static	_deleteAll ($a_course_id)
static	_getGroupings ($a_course_id)
static	_checkCondition ($trigger_obj_id, $operator, $value, $a_usr_id=0)
static	_getGroupingCourseIds ($a_course_ref_id, $a_course_id)
	Get all ids of courses that are grouped with another course static. More...
static	getAssignedObjects ()
	Alway call checkGroupingDependencies before. More...
static	_checkGroupingDependencies (&$container_obj, $a_user_id=null)
static	_getGroupingItems ($container_obj)
	Get courses/groups that are assigned to the same membership limitation. More...

Data Fields
	$db

Static Protected Attributes
static	$assignedObjects = array()

Private Attributes
	$logger = null

Detailed Description

Class ilObj<module_name>

Author

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

Version

$Id$

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

Constructor & Destructor Documentation

__construct()

ilObjCourseGrouping::__construct

(

$a_id = 0

)

Constructor public.

Parameters

int	reference_id or object_id

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

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

    {
        global $DIC;

        $ilDB = $DIC['ilDB'];

        $this->logger = $DIC->logger()->crs();

        $this->setType('crsg');
        $this->db = $ilDB;

        $this->setId($a_id);

        if ($a_id) {
            $this->read();
        }
    }

Here is the call graph for this function:

Member Function Documentation

__addCondition()

ilObjCourseGrouping::__addCondition	(		$a_target_ref_id,
			$a_target_obj_id
	)

Definition at line 453 of file class.ilObjCourseGrouping.php.

References ilObject\_lookupType(), getId(), and getUniqueField().

Referenced by assign().

    {
        include_once './Services/Conditions/classes/class.ilConditionHandler.php';

        $tmp_condh = new ilConditionHandler();
        $tmp_condh->enableAutomaticValidation(false);

        $tmp_condh->setTargetRefId($a_target_ref_id);
        $tmp_condh->setTargetObjId($a_target_obj_id);
        $tmp_condh->setTargetType(\ilObject::_lookupType($a_target_obj_id));
        $tmp_condh->setTriggerRefId(0);
        $tmp_condh->setTriggerObjId($this->getId());
        $tmp_condh->setTriggerType('crsg');
        $tmp_condh->setOperator('not_member');
        $tmp_condh->setValue($this->getUniqueField());

        if (!$tmp_condh->checkExists()) {
            $tmp_condh->storeCondition();

            return true;
        }
        return false;
    }

Here is the call graph for this function:

Here is the caller graph for this function:

_checkAccess()

ilObjCourseGrouping::_checkAccess

(

$grouping_id

)

Definition at line 290 of file class.ilObjCourseGrouping.php.

References $DIC, and $tree.

    {
        global $DIC;

        $ilAccess = $DIC['ilAccess'];
        $tree = $DIC['tree'];

        $tmp_grouping_obj = new ilObjCourseGrouping($grouping_id);

        $found_invisible = false;
        foreach ($tmp_grouping_obj->getAssignedItems() as $condition) {
            if (!$ilAccess->checkAccess('write', '', $condition['target_ref_id'])) {
                $found_invisible = true;
                break;
            }
        }
        return $found_invisible ? false : true;
    }

_checkCondition()

static ilObjCourseGrouping::_checkCondition (   $trigger_obj_id,   $operator,   $value,   $a_usr_id = 0  )

static

Definition at line 519 of file class.ilObjCourseGrouping.php.

Referenced by ilConditionHandler\_checkCondition().

    {
        // in the moment i alway return true, there are some problems with presenting the condition if it fails,
        // only course register class check manually if this condition is fullfilled
        return true;
    }

Here is the caller graph for this function:

_checkGroupingDependencies()

static ilObjCourseGrouping::_checkGroupingDependencies ( &  $container_obj,   $a_user_id = null  )

static

Definition at line 566 of file class.ilObjCourseGrouping.php.

References $DIC, $ilUser, $lng, $tree, ilGroupParticipants\_getInstanceByObjId(), ilCourseParticipants\_getInstanceByObjId(), ilConditionHandler\_getPersistedConditionsOfTarget(), ilConditionHandler\_getPersistedConditionsOfTrigger(), ilObjGroup\_isMember(), and ilObjUser\lookupMatriculation().

Referenced by ilRegistrationGUI\fillMembershipLimitation(), ilWaitingListTableGUI\fillRow(), and ilSubscriberTableGUI\fillRow().

    {
        global $DIC;

        $ilUser = $DIC['ilUser'];
        $lng = $DIC['lng'];
        $tree = $DIC['tree'];

        include_once './Services/Conditions/classes/class.ilConditionHandler.php';
        
        $user_id = is_null($a_user_id) ? $ilUser->getId() : $a_user_id;
        

        $trigger_ids = array();
        foreach (ilConditionHandler::_getPersistedConditionsOfTarget(
            $container_obj->getRefId(),
            $container_obj->getId(),
            $container_obj->getType()
        ) as $condition) {
            if ($condition['operator'] == 'not_member') {
                $trigger_ids[] = $condition['trigger_obj_id'];
                break;
            }
        }
        if (!count($trigger_ids)) {
            return true;
        }
        $matriculation_message = $assigned_message = '';
        self::$assignedObjects = array();
        foreach ($trigger_ids as $trigger_id) {
            foreach (ilConditionHandler::_getPersistedConditionsOfTrigger('crsg', $trigger_id) as $condition) {
                // Handle deleted items
                if ($tree->isDeleted($condition['target_ref_id'])) {
                    continue;
                }
                if ($condition['operator'] == 'not_member') {
                    switch ($condition['value']) {
                        case 'matriculation':
                            if (!strlen(ilObjUser::lookupMatriculation($user_id))) {
                                if (!$matriculation_message) {
                                    $matriculation_message = $lng->txt('crs_grp_matriculation_required');
                                }
                            }
                    }
                    if ($container_obj->getType() == 'crs') {
                        include_once('Modules/Course/classes/class.ilCourseParticipants.php');
                        $members = ilCourseParticipants::_getInstanceByObjId($condition['target_obj_id']);
                        if ($members->isGroupingMember($user_id, $condition['value'])) {
                            if (!$assigned_message) {
                                self::$assignedObjects[] = $condition['target_obj_id'];
                                $assigned_message = $lng->txt('crs_grp_already_assigned');
                            }
                        }
                    } elseif ($container_obj->getType() == 'grp') {
                        include_once('Modules/Group/classes/class.ilGroupParticipants.php');
                        $members = ilGroupParticipants::_getInstanceByObjId($condition['target_obj_id']);
                        if ($members->isGroupingMember($user_id, $condition['value'])) {
                            if (!$assigned_message) {
                                self::$assignedObjects[] = $condition['target_obj_id'];
                                $assigned_message = $lng->txt('grp_grp_already_assigned');
                            }
                        }
                    } else {
                        if (ilObjGroup::_isMember($user_id, $condition['target_ref_id'], $condition['value'])) {
                            if (!$assigned_message) {
                                self::$assignedObjects[] = $condition['target_obj_id'];
                                $assigned_message = $lng->txt('crs_grp_already_assigned');
                            }
                        }
                    }
                }
            }
        }
        if ($matriculation_message) {
            $container_obj->appendMessage($matriculation_message);
            return false;
        } elseif ($assigned_message) {
            $container_obj->appendMessage($assigned_message);
            return false;
        }
        return true;
    }

Here is the call graph for this function:

Here is the caller graph for this function:

_deleteAll()

static ilObjCourseGrouping::_deleteAll (   $a_course_id )

static

Definition at line 478 of file class.ilObjCourseGrouping.php.

References $DIC, $ilDB, $query, $res, and _getGroupings().

Referenced by ilObjCourse\delete().

    {
        global $DIC;

        $ilDB = $DIC['ilDB'];

        // DELETE CONDITIONS
        foreach ($groupings = ilObjCourseGrouping::_getGroupings($a_course_id) as $grouping_id) {
            include_once './Services/Conditions/classes/class.ilConditionHandler.php';

            $condh = new ilConditionHandler();
            $condh->deleteByObjId($grouping_id);
        }

        $query = "DELETE FROM crs_groupings " .
            "WHERE crs_id = " . $ilDB->quote($a_course_id, 'integer') . " ";
        $res = $ilDB->manipulate($query);

        return true;
    }

Here is the call graph for this function:

Here is the caller graph for this function:

_getGroupingCourseIds()

static ilObjCourseGrouping::_getGroupingCourseIds (   $a_course_ref_id,   $a_course_id  )

static

Get all ids of courses that are grouped with another course static.

Parameters

integer	object_id of one course
array	integer ids of courses or empty array if course is not in grouping

Definition at line 533 of file class.ilObjCourseGrouping.php.

References $DIC, $tree, ilConditionHandler\_getPersistedConditionsOfTarget(), and ilConditionHandler\_getPersistedConditionsOfTrigger().

    {
        global $DIC;

        $tree = $DIC['tree'];

        include_once './Services/Conditions/classes/class.ilConditionHandler.php';

        // get all grouping ids the course is assigned to
        foreach (ilConditionHandler::_getPersistedConditionsOfTarget($a_course_ref_id, $a_course_id, 'crs') as $condition) {
            if ($condition['trigger_type'] == 'crsg') {
                foreach (ilConditionHandler::_getPersistedConditionsOfTrigger('crsg', $condition['trigger_obj_id']) as $target_condition) {
                    if ($tree->isDeleted($target_condition['target_ref_id'])) {
                        continue;
                    }
                    $course_ids[] = array('id' => $target_condition['target_obj_id'],
                                          'unique' => $target_condition['value']);
                }
            }
        }
        return $course_ids ? $course_ids : array();
    }

Here is the call graph for this function:

_getGroupingItems()

static ilObjCourseGrouping::_getGroupingItems (   $container_obj )

static

Get courses/groups that are assigned to the same membership limitation.

Parameters

object

container object

Returns

array array of reference ids

Definition at line 656 of file class.ilObjCourseGrouping.php.

References $DIC, $tree, ilConditionHandler\_getPersistedConditionsOfTarget(), and ilConditionHandler\_getPersistedConditionsOfTrigger().

Referenced by ilRegistrationGUI\fillMembershipLimitation().

    {
        global $DIC;

        $tree = $DIC['tree'];
        $ilObjDataCache = $DIC['ilObjDataCache'];
        $ilAccess = $DIC['ilAccess'];
        $tree = $DIC['tree'];

        include_once './Services/Conditions/classes/class.ilConditionHandler.php';

        $trigger_ids = array();
        foreach (ilConditionHandler::_getPersistedConditionsOfTarget(
            $container_obj->getRefId(),
            $container_obj->getId(),
            $container_obj->getType()
        ) as $condition) {
            if ($condition['operator'] == 'not_member') {
                $trigger_ids[] = $condition['trigger_obj_id'];
            }
        }
        if (!count($trigger_ids)) {
            return false;
        }
        $hash_table = array();
        foreach ($trigger_ids as $trigger_id) {
            foreach (ilConditionHandler::_getPersistedConditionsOfTrigger('crsg', $trigger_id) as $condition) {
                // Continue if trigger is deleted
                if ($tree->isDeleted($condition['target_ref_id'])) {
                    continue;
                }

                if ($condition['operator'] == 'not_member') {
                    if (!$hash_table[$condition['target_ref_id']]) {
                        $items[] = $condition['target_ref_id'];
                    }
                    $hash_table[$condition['target_ref_id']] = true;
                }
            }
        }
        return $items ? $items : array();
    }

Here is the call graph for this function:

Here is the caller graph for this function:

_getGroupings()

static ilObjCourseGrouping::_getGroupings (   $a_course_id )

static

Parameters

$a_course_id

Returns

int[]

Definition at line 503 of file class.ilObjCourseGrouping.php.

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

Referenced by _deleteAll(), ilObjGroup\cloneDependencies(), and ilObjCourse\cloneDependencies().

    {
        global $DIC;

        $ilDB = $DIC['ilDB'];

        $query = "SELECT * FROM crs_groupings " .
            "WHERE crs_id = " . $ilDB->quote($a_course_id, 'integer') . " ";

        $res = $ilDB->query($query);
        while ($row = $res->fetchRow(ilDBConstants::FETCHMODE_OBJECT)) {
            $groupings[] = $row->crs_grp_id;
        }
        return $groupings ? $groupings : array();
    }

Here is the caller graph for this function:

_getVisibleGroupings()

static ilObjCourseGrouping::_getVisibleGroupings (   $a_obj_id )

static

Parameters

int

$a_obj_id

Returns

array

Returns a list of all groupings for which the current user hast write permission on all assigned objects. Or groupings the given object id is assigned to.

Definition at line 317 of file class.ilObjCourseGrouping.php.

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

Referenced by ilCourseGroupingTableGUI\getItems().

    {
        global $DIC;

        $ilObjDataCache = $DIC['ilObjDataCache'];
        $ilAccess = $DIC['ilAccess'];
        $ilDB = $DIC['ilDB'];

        $container_type = $ilObjDataCache->lookupType($a_obj_id) == 'grp' ? 'grp' : 'crs';


        // First get all groupings
        $query = "SELECT * FROM object_data WHERE type = 'crsg' ORDER BY title";
        $res = $ilDB->query($query);
        $groupings = array();
        while ($row = $res->fetchRow(ilDBConstants::FETCHMODE_OBJECT)) {
            $groupings[] = $row->obj_id;
        }

        //check access
        foreach ($groupings as $grouping_id) {
            $tmp_grouping_obj = new ilObjCourseGrouping($grouping_id);

            // Check container type
            if ($tmp_grouping_obj->getContainerType() != $container_type) {
                continue;
            }
            // Check if container is current container
            if ($tmp_grouping_obj->getContainerObjId() == $a_obj_id) {
                $visible_groupings[] = $grouping_id;
                continue;
            }
            // check if items are assigned
            if (count($items = $tmp_grouping_obj->getAssignedItems())) {
                foreach ($items as $condition_data) {
                    if ($ilAccess->checkAccess('write', '', $condition_data['target_ref_id'])) {
                        $visible_groupings[] = $grouping_id;
                        break;
                    }
                }
            }
        }
        return $visible_groupings ? $visible_groupings : array();
    }

Here is the caller graph for this function:

assign()

ilObjCourseGrouping::assign	(		$a_crs_ref_id,
			$a_course_id
	)

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

References __addCondition(), getContainerObjId(), and getContainerRefId().

    {
        // Add the parent course of grouping
        $this->__addCondition($this->getContainerRefId(), $this->getContainerObjId());
        $this->__addCondition($a_crs_ref_id, $a_course_id);

        return true;
    }

Here is the call graph for this function:

cloneGrouping()

ilObjCourseGrouping::cloneGrouping	(		$a_target_id,
			$a_copy_id
	)

Parameters

int	$a_target_id
int	$a_copy_id

Definition at line 399 of file class.ilObjCourseGrouping.php.

References ilCopyWizardOptions\_getInstance(), ilObject\_lookupObjId(), ilObject\_lookupType(), getContainerRefId(), getDescription(), ilObjectFactory\getInstanceByRefId(), getTitle(), and getUniqueField().

    {
        $this->logger->debug('Start cloning membership limitations...');
        $mappings = \ilCopyWizardOptions::_getInstance($a_copy_id)->getMappings();
        $target_ref_id = 0;
        $target_obj_id = 0;

        if (array_key_exists($this->getContainerRefId(), $mappings) && $mappings[$this->getContainerRefId()]) {
            $target_ref_id = $mappings[$this->getContainerRefId()];
            $target_obj_id = \ilObject::_lookupObjId($target_ref_id);
            $this->logger->dump($target_ref_id);
            $this->logger->dump($target_obj_id);
        }
        if (!$target_ref_id || !$target_obj_id) {
            $this->logger->debug('No target ref_id found.');
            return false;
        }

        $new_grouping = new \ilObjCourseGrouping();
        $new_grouping->setTitle($this->getTitle());
        $new_grouping->setDescription($this->getDescription());
        $new_grouping->setContainerRefId($target_ref_id);
        $new_grouping->setContainerObjId($target_obj_id);
        $new_grouping->setContainerType(\ilObject::_lookupType($target_obj_id));
        $new_grouping->setUniqueField($this->getUniqueField());
        $new_grouping->create($target_ref_id, $target_obj_id);

        $obj_instance = \ilObjectFactory::getInstanceByRefId($this->getContainerRefId(), false);
        if (!$obj_instance instanceof \ilObject) {
            $this->logger->info('Cannot create object instance for membership limitation');
            return false;
        }
        $limitation_items = self::_getGroupingItems($obj_instance);
        $this->logger->dump($limitation_items);

        foreach ($limitation_items as $item_ref_id) {
            $target_item_ref_id = 0;
            $target_item_obj_id = 0;
            if (array_key_exists($item_ref_id, $mappings) && $mappings[$item_ref_id]) {
                $target_item_ref_id = $mappings[$item_ref_id];
                $target_item_obj_id = \ilObject::_lookupObjId($target_item_ref_id);
            }
            if (!$target_item_ref_id || !$target_item_obj_id) {
                $this->logger->info('No mapping found for: ' . $item_ref_id);
                continue;
            }
            $new_grouping->assign($target_item_ref_id, $target_item_obj_id);
        }

        return true;
    }

Here is the call graph for this function:

create()

ilObjCourseGrouping::create	(		$a_course_ref_id,
			$a_course_id
	)

Definition at line 180 of file class.ilObjCourseGrouping.php.

References $DIC, $ilDB, $ilUser, $query, $res, getDescription(), getId(), getTitle(), getUniqueField(), and setId().

    {
        global $DIC;

        $ilUser = $DIC['ilUser'];
        $ilDB = $DIC['ilDB'];

        // INSERT IN object_data
        $this->setId($ilDB->nextId("object_data"));
        $query = "INSERT INTO object_data " .
            "(obj_id, type,title,description,owner,create_date,last_update) " .
            "VALUES " .
            "(" .
            $ilDB->quote($this->getId(), "integer") . "," .
            $ilDB->quote($this->type, "text") . "," .
            $ilDB->quote($this->getTitle(), "text") . "," .
            $ilDB->quote($this->getDescription(), "text") . "," .
            $ilDB->quote($ilUser->getId(), "integer") . "," .
            $ilDB->now() . "," .
            $ilDB->now() .
            ')';
            
        $ilDB->manipulate($query);

        // INSERT in crs_groupings
        $query = "INSERT INTO crs_groupings (crs_grp_id,crs_ref_id,crs_id,unique_field) " .
            "VALUES (" .
            $ilDB->quote($this->getId(), 'integer') . ", " .
            $ilDB->quote($a_course_ref_id, 'integer') . ", " .
            $ilDB->quote($a_course_id, 'integer') . ", " .
            $ilDB->quote($this->getUniqueField(), 'text') . " " .
            ")";
        $res = $ilDB->manipulate($query);
        
        return $this->getId();
    }

Here is the call graph for this function:

deassign()

ilObjCourseGrouping::deassign	(		$a_crs_ref_id,
			$a_course_id
	)

Definition at line 371 of file class.ilObjCourseGrouping.php.

References ilConditionHandler\_getPersistedConditionsOfTrigger(), and getId().

    {
        include_once './Services/Conditions/classes/class.ilConditionHandler.php';


        $condh = new ilConditionHandler();

        // DELETE also original course if its the last
        if ($this->getCountAssignedCourses() == 2) {
            $condh->deleteByObjId($this->getId());

            return true;
        }
        
        foreach (ilConditionHandler::_getPersistedConditionsOfTrigger('crsg', $this->getId()) as $cond_data) {
            if ($cond_data['target_ref_id'] == $a_crs_ref_id and
               $cond_data['target_obj_id'] == $a_course_id) {
                $condh->deleteCondition($cond_data['id']);
            }
        }

        return true;
    }

Here is the call graph for this function:

delete()

ilObjCourseGrouping::delete

(

)

Definition at line 155 of file class.ilObjCourseGrouping.php.

References $DIC, $ilDB, $query, $res, getId(), and getType().

    {
        global $DIC;

        $ilDB = $DIC['ilDB'];
        
        include_once './Services/Conditions/classes/class.ilConditionHandler.php';

        if ($this->getId() and $this->getType() === 'crsg') {
            $query = "DELETE FROM object_data WHERE obj_id = " . $ilDB->quote($this->getId(), 'integer') . " ";
            $res = $ilDB->manipulate($query);

            $query = "DELETE FROM crs_groupings " .
                "WHERE crs_grp_id = " . $ilDB->quote($this->getId(), 'integer') . " ";
            $res = $ilDB->manipulate($query);

            // Delete conditions
            $condh = new ilConditionHandler();
            $condh->deleteByObjId($this->getId());

            return true;
        }
        return false;
    }

Here is the call graph for this function:

getAssignedItems()

ilObjCourseGrouping::getAssignedItems

(

)

Definition at line 137 of file class.ilObjCourseGrouping.php.

References $DIC, $tree, ilConditionHandler\_getPersistedConditionsOfTrigger(), getId(), and getType().

Referenced by getCountAssignedItems(), and isAssigned().

    {
        global $DIC;

        $tree = $DIC['tree'];

        include_once './Services/Conditions/classes/class.ilConditionHandler.php';
        $condition_data = ilConditionHandler::_getPersistedConditionsOfTrigger($this->getType(), $this->getId());
        $conditions = array();
        foreach ($condition_data as $condition) {
            if ($tree->isDeleted($condition['target_ref_id'])) {
                continue;
            }
            $conditions[] = $condition;
        }
        return count($conditions) ? $conditions : array();
    }

Here is the call graph for this function:

Here is the caller graph for this function:

getAssignedObjects()

static ilObjCourseGrouping::getAssignedObjects ( )

static

Alway call checkGroupingDependencies before.

Returns

array Assigned objects

Definition at line 561 of file class.ilObjCourseGrouping.php.

Referenced by ilSubscriberTableGUI\fillRow(), and ilWaitingListTableGUI\fillRow().

    {
        return self::$assignedObjects ? self::$assignedObjects : array();
    }

Here is the caller graph for this function:

getContainerObjId()

ilObjCourseGrouping::getContainerObjId

(

)

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

Referenced by assign().

    {
        return $this->obj_id;
    }

Here is the caller graph for this function:

getContainerRefId()

ilObjCourseGrouping::getContainerRefId

(

)

Definition at line 77 of file class.ilObjCourseGrouping.php.

Referenced by assign(), and cloneGrouping().

    {
        return $this->ref_id;
    }

Here is the caller graph for this function:

getContainerType()

ilObjCourseGrouping::getContainerType

(

)

Definition at line 89 of file class.ilObjCourseGrouping.php.

    {
        return $this->container_type;
    }

getCountAssignedItems()

ilObjCourseGrouping::getCountAssignedItems

(

)

Definition at line 132 of file class.ilObjCourseGrouping.php.

References getAssignedItems().

    {
        return count($this->getAssignedItems());
    }

Here is the call graph for this function:

getDescription()

ilObjCourseGrouping::getDescription

(

)

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

References $description.

Referenced by cloneGrouping(), create(), and update().

    {
        return $this->description;
    }

Here is the caller graph for this function:

getId()

ilObjCourseGrouping::getId

(

)

Definition at line 68 of file class.ilObjCourseGrouping.php.

References $id.

Referenced by __addCondition(), create(), deassign(), delete(), getAssignedItems(), read(), and update().

    {
        return $this->id;
    }

Here is the caller graph for this function:

getTitle()

ilObjCourseGrouping::getTitle

(

)

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

References $title.

Referenced by cloneGrouping(), create(), and update().

    {
        return $this->title;
    }

Here is the caller graph for this function:

getType()

ilObjCourseGrouping::getType

(

)

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

References $type.

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

    {
        return $this->type;
    }

Here is the caller graph for this function:

getUniqueField()

ilObjCourseGrouping::getUniqueField

(

)

Definition at line 127 of file class.ilObjCourseGrouping.php.

Referenced by __addCondition(), cloneGrouping(), create(), and update().

    {
        return $this->unique_field;
    }

Here is the caller graph for this function:

isAssigned()

ilObjCourseGrouping::isAssigned

(

$a_course_id

)

Definition at line 250 of file class.ilObjCourseGrouping.php.

References getAssignedItems().

    {
        foreach ($this->getAssignedItems() as $condition_data) {
            if ($a_course_id == $condition_data['target_obj_id']) {
                return true;
            }
        }
        return false;
    }

Here is the call graph for this function:

read()

ilObjCourseGrouping::read

(

)

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

References $DIC, $ilDB, $query, $res, $row, ilDBConstants\FETCHMODE_OBJECT, getId(), setContainerObjId(), setContainerRefId(), setContainerType(), setDescription(), setTitle(), and setUniqueField().

Referenced by __construct().

    {
        global $DIC;

        $ilObjDataCache = $DIC['ilObjDataCache'];
        $ilDB = $DIC['ilDB'];

        $query = "SELECT * FROM object_data " .
            "WHERE obj_id = " . $ilDB->quote($this->getId(), 'integer') . " ";

        $res = $this->db->query($query);
        while ($row = $res->fetchRow(ilDBConstants::FETCHMODE_OBJECT)) {
            $this->setTitle($row->title);
            $this->setDescription($row->description);
        }

        $query = "SELECT * FROM crs_groupings " .
            "WHERE crs_grp_id = " . $ilDB->quote($this->getId(), 'integer') . " ";
        $res = $ilDB->query($query);

        while ($row = $res->fetchRow(ilDBConstants::FETCHMODE_OBJECT)) {
            $this->setUniqueField($row->unique_field);
            $this->setContainerRefId($row->crs_ref_id);
            $this->setContainerObjId($row->crs_id);
            $this->setContainerType($ilObjDataCache->lookupType($this->getContainerObjId()));
        }

        return true;
    }

Here is the call graph for this function:

Here is the caller graph for this function:

setContainerObjId()

ilObjCourseGrouping::setContainerObjId

(

$a_obj_id

)

Definition at line 81 of file class.ilObjCourseGrouping.php.

Referenced by read().

    {
        $this->obj_id = $a_obj_id;
    }

Here is the caller graph for this function:

setContainerRefId()

ilObjCourseGrouping::setContainerRefId

(

$a_ref_id

)

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

Referenced by read().

    {
        $this->ref_id = $a_ref_id;
    }

Here is the caller graph for this function:

setContainerType()

ilObjCourseGrouping::setContainerType

(

$a_type

)

Definition at line 93 of file class.ilObjCourseGrouping.php.

References $a_type.

Referenced by read().

    {
        $this->container_type = $a_type;
    }

Here is the caller graph for this function:

setDescription()

ilObjCourseGrouping::setDescription

(

$a_desc

)

Definition at line 115 of file class.ilObjCourseGrouping.php.

Referenced by read().

    {
        $this->description = $a_desc;
    }

Here is the caller graph for this function:

setId()

ilObjCourseGrouping::setId

(

$a_id

)

Definition at line 64 of file class.ilObjCourseGrouping.php.

Referenced by __construct(), and create().

    {
        $this->id = $a_id;
    }

Here is the caller graph for this function:

setTitle()

ilObjCourseGrouping::setTitle

(

$a_title

)

Definition at line 107 of file class.ilObjCourseGrouping.php.

Referenced by read().

    {
        $this->title = $a_title;
    }

Here is the caller graph for this function:

setType()

ilObjCourseGrouping::setType

(

$a_type

)

Definition at line 98 of file class.ilObjCourseGrouping.php.

References $a_type.

Referenced by __construct().

    {
        $this->type = $a_type;
    }

Here is the caller graph for this function:

setUniqueField()

ilObjCourseGrouping::setUniqueField

(

$a_uni

)

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

Referenced by read().

    {
        $this->unique_field = $a_uni;
    }

Here is the caller graph for this function:

update()

ilObjCourseGrouping::update

(

)

Definition at line 217 of file class.ilObjCourseGrouping.php.

References $DIC, $ilDB, $query, $res, getDescription(), getId(), getTitle(), getType(), and getUniqueField().

    {
        global $DIC;

        $ilDB = $DIC['ilDB'];
        
        if ($this->getId() and $this->getType() === 'crsg') {
            // UPDATe object_data
            $query = "UPDATE object_data " .
                "SET title = " . $ilDB->quote($this->getTitle(), 'text') . ", " .
                "description = " . $ilDB->quote($this->getDescription(), 'text') . " " .
                "WHERE obj_id = " . $ilDB->quote($this->getId(), 'integer') . " " .
                "AND type = " . $ilDB->quote($this->getType(), 'text') . " ";
            $res = $ilDB->manipulate($query);

            // UPDATE crs_groupings
            $query = "UPDATE crs_groupings " .
                "SET unique_field = " . $ilDB->quote($this->getUniqueField(), 'text') . " " .
                "WHERE crs_grp_id = " . $ilDB->quote($this->getId(), 'integer') . " ";
            $res = $ilDB->manipulate($query);

            // UPDATE conditions
            $query = "UPDATE conditions " .
                "SET value = " . $ilDB->quote($this->getUniqueField(), 'text') . " " .
                "WHERE trigger_obj_id = " . $ilDB->quote($this->getId(), 'integer') . " " .
                "AND trigger_type = 'crsg'";
            $res = $ilDB->manipulate($query);

            return true;
        }
        return false;
    }

Here is the call graph for this function:

Field Documentation

$assignedObjects

ilObjCourseGrouping::$assignedObjects = array()

staticprotected

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

$db

ilObjCourseGrouping::$db

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

$logger

ilObjCourseGrouping::$logger = null

private

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

---

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

• Modules/Course/classes/class.ilObjCourseGrouping.php