class.ilLPCollection.php

Go to the documentation of this file.

<?php

/* Copyright (c) 1998-2010 ILIAS open source, Extended GPL, see docs/LICENSE */

abstract class ilLPCollection
{
        protected $obj_id; // [int]
        protected $mode; // [int]
        protected $items; // [array]

        public function __construct($a_obj_id, $a_mode)
        {
                $this->obj_id = $a_obj_id;
                $this->mode = $a_mode;  
                
                if($a_obj_id)
                {
                        $this->read($a_obj_id);
                }
        }
        
        public static function getInstanceByMode($a_obj_id, $a_mode)
        {
                $path = "Services/Tracking/classes/collection/";
                
                switch($a_mode)
                {
                        case ilLPObjSettings::LP_MODE_COLLECTION:
                        case ilLPObjSettings::LP_MODE_MANUAL_BY_TUTOR:          
                                include_once $path."class.ilLPCollectionOfRepositoryObjects.php";
                                return new ilLPCollectionOfRepositoryObjects($a_obj_id, $a_mode);               

                        case ilLPObjSettings::LP_MODE_OBJECTIVES:
                                include_once $path."class.ilLPCollectionOfObjectives.php";
                                return new ilLPCollectionOfObjectives($a_obj_id, $a_mode);              

                        case ilLPObjSettings::LP_MODE_SCORM:    
                                include_once $path."class.ilLPCollectionOfSCOs.php";
                                return new ilLPCollectionOfSCOs($a_obj_id, $a_mode);            

                        case ilLPObjSettings::LP_MODE_COLLECTION_MANUAL:        
                        case ilLPObjSettings::LP_MODE_COLLECTION_TLT:   
                                include_once $path."class.ilLPCollectionOfLMChapters.php";
                                return new ilLPCollectionOfLMChapters($a_obj_id, $a_mode);              
                                
                        case ilLPObjSettings::LP_MODE_COLLECTION_MOBS:
                                include_once $path."class.ilLPCollectionOfMediaObjects.php";
                                return new ilLPCollectionOfMediaObjects($a_obj_id, $a_mode);    
                }
        }
        
        public static function getCollectionModes()
        {
                return array(
                        ilLPObjSettings::LP_MODE_COLLECTION
                        ,ilLPObjSettings::LP_MODE_COLLECTION_TLT
                        ,ilLPObjSettings::LP_MODE_COLLECTION_MANUAL
                        ,ilLPObjSettings::LP_MODE_SCORM
                        ,ilLPObjSettings::LP_MODE_OBJECTIVES
                        ,ilLPObjSettings::LP_MODE_COLLECTION_MOBS
                );
        }
        
        public function hasSelectableItems()
        {
                return true;
        }
        
        public function cloneCollection($a_target_id, $a_copy_id)
        {
                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.');
        }
        
        
        //
        // CRUD
        //
        
        public function getItems()
        {
                return $this->items;
        }
        
        protected function read($a_obj_id)
        {
                global $ilDB;
                
                $items = array();
                
                $res = $ilDB->query("SELECT * FROM ut_lp_collections".
                        " WHERE obj_id = ".$ilDB->quote($a_obj_id, "integer"));
                while($row = $res->fetchRow(ilDBConstants::FETCHMODE_OBJECT))
                {
                        if($this->validateEntry($row->item_id))
                        {
                                $items[] = $row->item_id;
                        }
                        else
                        {
                                $this->deleteEntry($row->item_id);
                        }
                }
                
                $this->items = $items;                          
        }
        
        public function delete()
        {
                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;
        }

        //
        // ENTRIES
        //
                        
        protected function validateEntry($a_item_id)
        {
                return true;
        }                       
                
        public function isAssignedEntry($a_item_id)
        {
                if(is_array($this->items))
                {
                        return (bool)in_array($a_item_id, $this->items);
                }
                return false;
        }

        protected function addEntry($a_item_id)
        {
                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;
        }
        
        protected function deleteEntry($a_item_id)
        {
                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;
        }
        
        public function deactivateEntries(array $a_item_ids)
        {               
                foreach($a_item_ids as $item_id)
                {
                        $this->deleteEntry($item_id);
                }               
        }

        public function activateEntries(array $a_item_ids)
        {               
                foreach($a_item_ids as $item_id)
                {
                        $this->addEntry($item_id);              
                }               
        }
}

?>