LP collection base class. More...

Inheritance diagram for ilLPCollection:

Collaboration diagram for ilLPCollection:

Public Member Functions
	__construct ($a_obj_id, $a_mode)

	hasSelectableItems ()

	cloneCollection ($a_target_id, $a_copy_id)

	getItems ()

	delete ()

	isAssignedEntry ($a_item_id)

	deactivateEntries (array $a_item_ids)

	activateEntries (array $a_item_ids)

Protected Member Functions
	read ()

	validateEntry ($a_item_id)

	addEntry ($a_item_id)

	deleteEntry ($a_item_id)

Protected Attributes
	$obj_id

	$mode

	$items

Detailed Description

LP collection base class.

Author: Jörg Lützenkirchen luetz.nosp@m.enki.nosp@m.rchen.nosp@m.@lei.nosp@m.fos.c.nosp@m.om

Version

Id: class.ilLPCollections.php 40326 2013-03-05 11:39:24Z jluetzen

Definition at line 14 of file class.ilLPCollection.php.

Constructor & Destructor Documentation

◆ __construct()

ilLPCollection::__construct	(	$a_obj_id,
		$a_mode
	)

Definition at line 20 of file class.ilLPCollection.php.

        {
                $this->obj_id = $a_obj_id;
                $this->mode = $a_mode;  
                
                if($a_obj_id)
                {
                        $this->read($a_obj_id);
                }
        }

References read().

Here is the call graph for this function:

Member Function Documentation

◆ activateEntries()

ilLPCollection::activateEntries ( array $a_item_ids )

Reimplemented in ilLPCollectionOfRepositoryObjects.

Definition at line 167 of file class.ilLPCollection.php.

        {               
                foreach($a_item_ids as $item_id)
                {
                        $this->addEntry($item_id);              
                }               
        }

References addEntry().

Here is the call graph for this function:

◆ addEntry()

ilLPCollection::addEntry ( $a_item_id )

protected

Reimplemented in ilLPCollectionOfRepositoryObjects.

Definition at line 130 of file class.ilLPCollection.php.

        {
                global $ilDB;
                
                if(!$this->isAssignedEntry($a_item_id))
                {
                        $query = "INSERT INTO ut_lp_collections".
                                " (obj_id, lpmode, item_id)".
                                " VALUES (".$ilDB->quote($this->obj_id , "integer").
                                ", ".$ilDB->quote($this->mode, "integer").
                                ", ".$ilDB->quote($a_item_id , "integer").                              
                                ")";
                        $ilDB->manipulate($query);
                        $this->items[] = $a_item_id;
                }
                return true;
        }

References $ilDB, $query, and isAssignedEntry().

Referenced by activateEntries().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ cloneCollection()

ilLPCollection::cloneCollection	(	$a_target_id,
		$a_copy_id
	)

Reimplemented in ilLPCollectionOfRepositoryObjects.

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

        {
                global $ilLog;
                
                $target_obj_id = ilObject::_lookupObjId($a_target_id);
                
                include_once('Services/CopyWizard/classes/class.ilCopyWizardOptions.php');
                $cwo = ilCopyWizardOptions::_getInstance($a_copy_id);
                $mappings = $cwo->getMappings();
                
                // #12067
                $new_collection = new static($target_obj_id, $this->mode);
                foreach($this->items as $item)
                {
                        if(!isset($mappings[$item]) or !$mappings[$item])
                        {
                                continue;
                        }
                        
                        $new_collection->addEntry($mappings[$item]);                    
                }
                
                $ilLog->write(__METHOD__.': cloned learning progress collection.');
        }

References $ilLog, $mode, ilCopyWizardOptions\_getInstance(), and ilObject\_lookupObjId().

Here is the call graph for this function:

◆ deactivateEntries()

ilLPCollection::deactivateEntries ( array $a_item_ids )

Reimplemented in ilLPCollectionOfRepositoryObjects.

Definition at line 159 of file class.ilLPCollection.php.

        {               
                foreach($a_item_ids as $item_id)
                {
                        $this->deleteEntry($item_id);
                }               
        }

References deleteEntry().

Here is the call graph for this function:

◆ delete()

ilLPCollection::delete ( )

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

        {
                global $ilDB;
 
                $query = "DELETE FROM ut_lp_collections".
                        " WHERE obj_id = ".$ilDB->quote($this->obj_id ,"integer");
                $ilDB->manipulate($query);
                
                $query = "DELETE FROM ut_lp_coll_manual".
                        " WHERE obj_id = ".$ilDB->quote($this->obj_id, "integer");
                $ilDB->manipulate($query);
                
                // #15462 - reset internal data
                $this->items = array();
 
                return true;
        }

References $ilDB, and $query.

◆ deleteEntry()

ilLPCollection::deleteEntry ( $a_item_id )

protected

Reimplemented in ilLPCollectionOfRepositoryObjects.

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

        {
                global $ilDB;
                
                $query = "DELETE FROM ut_lp_collections".
                        " WHERE obj_id = ".$ilDB->quote($this->obj_id, "integer").
                        " AND item_id = ".$ilDB->quote($a_item_id, "integer");
                $ilDB->manipulate($query);
                return true;
        }

References $ilDB, and $query.

Referenced by deactivateEntries(), and read().

Here is the caller graph for this function:

◆ getItems()

ilLPCollection::getItems ( )

Definition at line 66 of file class.ilLPCollection.php.

        {
                return $this->items;
        }

References $items.

Referenced by ilLPCollectionOfRepositoryObjects\getGroupedItemsForLPStatus().

Here is the caller graph for this function:

◆ hasSelectableItems()

ilLPCollection::hasSelectableItems ( )

Reimplemented in ilLPCollectionOfObjectives.

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

        {
                return true;
        }

◆ isAssignedEntry()

ilLPCollection::isAssignedEntry ( $a_item_id )

Definition at line 121 of file class.ilLPCollection.php.

        {
                if(is_array($this->items))
                {
                        return (bool)in_array($a_item_id, $this->items);
                }
                return false;
        }

Referenced by addEntry(), ilLPCollectionOfRepositoryObjects\addEntry(), ilLPCollectionOfRepositoryObjects\getPossibleItems(), ilLPCollectionOfLMChapters\getTableGUIData(), ilLPCollectionOfSCOs\getTableGUIData(), and ilLPCollectionOfRepositoryObjects\parseTableGUIItem().

Here is the caller graph for this function:

◆ read()

ilLPCollection::read ( )

protected

Reimplemented in ilLPCollectionOfRepositoryObjects.

Definition at line 71 of file class.ilLPCollection.php.

        {
                global $ilDB;
                
                $items = array();
                
                $res = $ilDB->query("SELECT * FROM ut_lp_collections".
                        " WHERE obj_id = ".$ilDB->quote($this->obj_id, "integer"));
                while($row = $res->fetchRow(DB_FETCHMODE_OBJECT))
                {
                        if($this->validateEntry($row->item_id))
                        {
                                $items[] = $row->item_id;
                        }
                        else
                        {
                                $this->deleteEntry($row->item_id);
                        }
                }
                
                $this->items = $items;                          
        }

References $ilDB, $items, $res, $row, DB_FETCHMODE_OBJECT, deleteEntry(), and validateEntry().

Referenced by __construct().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ validateEntry()

ilLPCollection::validateEntry ( $a_item_id )

protected

Definition at line 116 of file class.ilLPCollection.php.

        {
                return true;
        }                       

Referenced by read().

Here is the caller graph for this function:

Field Documentation

◆ $items

ilLPCollection::$items

protected

Definition at line 18 of file class.ilLPCollection.php.

Referenced by ilLPCollectionOfRepositoryObjects\getGroupedItemsForLPStatus(), getItems(), ilLPCollectionOfLMChapters\getPossibleItems(), ilLPCollectionOfSCOs\getPossibleItems(), ilLPCollectionOfRepositoryObjects\getTableGUIData(), ilLPCollectionOfRepositoryObjects\getTableGUItemGroup(), read(), and ilLPCollectionOfRepositoryObjects\read().

◆ $mode

ilLPCollection::$mode

protected

Definition at line 17 of file class.ilLPCollection.php.

Referenced by cloneCollection(), and ilLPCollectionOfRepositoryObjects\cloneCollection().

◆ $obj_id

ilLPCollection::$obj_id

protected

Definition at line 16 of file class.ilLPCollection.php.

Referenced by ilLPCollectionOfLMChapters\getPossibleItems(), and ilLPCollectionOfSCOs\getPossibleItems().

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

Services/Tracking/classes/collection/class.ilLPCollection.php

Public Member Functions

Protected Member Functions

Protected Attributes

Detailed Description

Constructor & Destructor Documentation

◆ __construct()

Member Function Documentation

◆ activateEntries()

◆ addEntry()

◆ cloneCollection()

◆ deactivateEntries()

◆ delete()

◆ deleteEntry()

◆ getItems()

◆ hasSelectableItems()

◆ isAssignedEntry()

◆ read()

◆ validateEntry()

Field Documentation

◆ $items

◆ $mode

◆ $obj_id