ilLPListOfProgressGUI Class Reference

Inheritance diagram for ilLPListOfProgressGUI:

Collaboration diagram for ilLPListOfProgressGUI:

Public Member Functions
	ilLPListOfProgressGUI ($a_mode, $a_ref_id, $a_user_id=0)
&	executeCommand ()
	execute command
	show ()
	details ()
	__showProgressList ()
	__initUser ($a_usr_id=0)
	__initDetails ($a_details_id)
Public Member Functions inherited from ilLearningProgressBaseGUI
	ilLearningProgressBaseGUI ($a_mode, $a_ref_id=0, $a_usr_id=0)
	activePDF ()
	__checkPDF ()
	isAnonymized ()
	isObjectAnonymized ()
	getMode ()
	getRefId ()
	getObjId ()
	getUserId ()
	activateStatistics ($a_act=true)
	__getDefaultCommand ()
	__setSubTabs ($a_active)
	__buildFooter ()
	__buildHeader ()
	__insertPath (&$a_tpl, $a_ref_id)
	insert path
	__showImageByStatus (&$tpl, $a_status, $tpl_prefix="")
	_getImagePathForStatus ($a_status)
	Get image path for status.
	_getStatusText ($a_status)
	Get status alt text.
&	__initTableGUI ()
	__showObjectDetails (&$info, $item_id=0)
	show details about current object.
	__appendUserInfo (&$info, $a_user)
	__appendLPDetails (&$info, $item_id, $user_id)
	__readStatus ($a_obj_id, $user_id)
	__showButton ($a_link, $a_text, $a_target= '')
	__sort ($a_ids, $a_table, $a_field, $a_id_name)
	Function that sorts ids by a given table field using WHERE IN E.g: __sort(array(6,7),'usr_data','lastname','usr_id') => sorts by lastname.
	__getPercent ($max, $reached)
	__readItemStatusInfo ($a_items)
	__getLegendHTML ()
	__showEditUser ($a_user_id, $a_ref_id, $a_cancel, $a_sub_id=false)
	__updateUser ($user_id, $obj_id)

Data Fields
	$tracked_user = null
	$details_id = 0
	$details_type = ''
	$details_mode = 0
Data Fields inherited from ilLearningProgressBaseGUI
	$tpl = null
	$ctrl = null
	$lng = null
	$ref_id = 0
	$mode = 0
	$statistics_activated = false

Additional Inherited Members
Static Public Member Functions inherited from ilLearningProgressBaseGUI
static	_showImageByStatus (&$tpl, $a_status, $tpl_prefix="")

Detailed Description

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

Member Function Documentation

ilLPListOfProgressGUI::__initDetails

(

$a_details_id

)

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

References ilObject\_getAllReferences(), ilLPObjSettings\_lookupMode(), and ilLearningProgressBaseGUI\getRefId().

Referenced by ilLPListOfProgressGUI(), and show().

        {
                global $ilObjDataCache;

                if(!$a_details_id)
                {
                        $a_details_id = $this->getRefId();
                }
                if($a_details_id)
                {
                        $ref_ids = ilObject::_getAllReferences($a_details_id);
                        
                        $this->details_id = $a_details_id;
                        $this->details_obj_id = $ilObjDataCache->lookupObjId($this->details_id);
                        $this->details_type = $ilObjDataCache->lookupType($this->details_obj_id);
                        $this->details_mode = ilLPObjSettings::_lookupMode($this->details_obj_id);
                }
        }

Here is the call graph for this function:

Here is the caller graph for this function:

ilLPListOfProgressGUI::__initUser

(

$a_usr_id = 0

)

Definition at line 201 of file class.ilLPListOfProgressGUI.php.

References $_POST, ilObjectFactory\getInstanceByObjId(), and LP_MODE_USER_FOLDER.

Referenced by ilLPListOfProgressGUI(), and show().

        {
                global $ilUser,$rbacreview,$rbacsystem;

                if($_POST['user_id'])
                {
                        $a_usr_id = $_POST['user_id'];
                        $this->ctrl->setParameter($this,'user_id',$_POST['user_id']);
                }

                if($a_usr_id)
                {
                        $this->tracked_user = ilObjectFactory::getInstanceByObjId($a_usr_id);
                }
                else
                {
                        $this->tracked_user = $ilUser;
                }
                
                // #8762: see ilObjUserGUI->getTabs()
                if($this->mode == LP_MODE_USER_FOLDER && $rbacsystem->checkAccess('read',$this->ref_id))
                {
                        return true;
                }
                
                // Check access
                if(!$rbacreview->isAssigned($ilUser->getId(),SYSTEM_ROLE_ID))
                {
                        $this->tracked_user = $ilUser;
                }
                
                return true;
        }

Here is the call graph for this function:

Here is the caller graph for this function:

ilLPListOfProgressGUI::__showProgressList

(

)

Definition at line 160 of file class.ilLPListOfProgressGUI.php.

References $ilCtrl, ilLearningProgressBaseGUI\__appendUserInfo(), and ilLearningProgressBaseGUI\__getLegendHTML().

Referenced by show().

        {
                global $ilUser,$ilObjDataCache,$ilCtrl;

                $this->tpl->addBlockFile('ADM_CONTENT','adm_content','tpl.lp_list_progress.html','Services/Tracking');
                
                // User info
                include_once("./Services/InfoScreen/classes/class.ilInfoScreenGUI.php");
                $info = new ilInfoScreenGUI($this);
                $info->setFormAction($ilCtrl->getFormAction($this));
                
                if ($this->__appendUserInfo($info, $this->tracked_user))
                {
                        $this->tpl->setCurrentBlock("info_user");
                        $this->tpl->setVariable("USER_INFO",$info->getHTML());
                        $this->tpl->parseCurrentBlock();
                }

                /*
                if($this->activePDF())
                {
                        $this->__showButton($this->ctrl->getLinkTargetByClass('ilpdfpresentation','createList'),$this->lng->txt('pdf_export'));
                }
                 */

                /*
                // Output filter limit info
                if($this->filter->limitReached())
                {
                        $info = sprintf($this->lng->txt('trac_filter_limit_reached'),$this->filter->getLimit());
                        $tpl->setVariable("LIMIT_REACHED",$info);
                }
                 */
        
                include_once("./Services/Tracking/classes/class.ilLPProgressTableGUI.php");
                $lp_table = new ilLPProgressTableGUI($this, "", $this->tracked_user);
                $this->tpl->setVariable("LP_OBJECTS", $lp_table->getHTML());

                $this->tpl->setVariable("LEGEND", $this->__getLegendHTML());
        }

Here is the call graph for this function:

Here is the caller graph for this function:

ilLPListOfProgressGUI::details

(

)

Definition at line 97 of file class.ilLPListOfProgressGUI.php.

References $_GET, $ilCtrl, ilLearningProgressBaseGUI\$ref_id, ilLearningProgressBaseGUI\__appendLPDetails(), ilLearningProgressBaseGUI\__appendUserInfo(), ilLearningProgressBaseGUI\__getLegendHTML(), ilLearningProgressBaseGUI\__showButton(), ilLearningProgressBaseGUI\__showObjectDetails(), ilLPCollectionCache\_getItems(), ilObject\_lookupObjectId(), ilLearningProgressBaseGUI\getMode(), ilLearningProgressBaseGUI\getRefId(), LP_MODE_ADMINISTRATION, LP_MODE_OBJECTIVES, LP_MODE_PERSONAL_DESKTOP, LP_MODE_SCORM, and LP_MODE_USER_FOLDER.

Referenced by show().

        {
                global $ilObjDataCache, $ilCtrl, $rbacsystem;

                // Show back button to crs if called from crs. Otherwise if called from personal desktop or administration
                // show back to list
                if((int)$_GET['crs_id'])
                {
                        $this->ctrl->setParameter($this,'details_id',(int) $_GET['crs_id']);
                        $this->__showButton($this->ctrl->getLinkTarget($this,'details'),$this->lng->txt('trac_view_crs'));
                }
                elseif($this->getMode() == LP_MODE_PERSONAL_DESKTOP or
                           $this->getMode() == LP_MODE_ADMINISTRATION or
                           $this->getMode() == LP_MODE_USER_FOLDER)
                {
                        $this->__showButton($this->ctrl->getLinkTarget($this,'show'),$this->lng->txt('trac_view_list'));
                }

                /*
                if($this->activePDF())
                {
                        $this->__showButton($this->ctrl->getLinkTargetByClass('ilpdfpresentation','createDetails'),$this->lng->txt('pdf_export'));
                }
                 */

                $this->tpl->addBlockFile('ADM_CONTENT','adm_content','tpl.lp_progress_container.html','Services/Tracking');

                include_once("./Services/InfoScreen/classes/class.ilInfoScreenGUI.php");
                $info = new ilInfoScreenGUI($this);
                $info->setFormAction($ilCtrl->getFormAction($this));
                $this->__appendUserInfo($info, $this->tracked_user);
                $this->__showObjectDetails($info,$this->details_obj_id);
                $this->__appendLPDetails($info,$this->details_obj_id,$this->tracked_user->getId());
                
                // Finally set template variable
                $this->tpl->setVariable("LM_INFO",$info->getHTML());

                include_once './Services/Tracking/classes/class.ilLPCollectionCache.php';
                $obj_ids = array();
                foreach(ilLPCollectionCache::_getItems($this->details_obj_id) as $ref_id)
                {
                        switch($this->details_mode)                     
                        {                       
                                case LP_MODE_SCORM:                                     
                                case LP_MODE_OBJECTIVES:
                                        $obj_ids[] = $ref_id;
                                        break;
                                
                                default:
                                        $obj_ids[ilObject::_lookupObjectId($ref_id)] = array($ref_id);
                                        break;
                        }
                }

                $personal_only = !$rbacsystem->checkAccess('edit_learning_progress',$this->getRefId());
        
                include_once("./Services/Tracking/classes/class.ilLPProgressTableGUI.php");
                $lp_table = new ilLPProgressTableGUI($this, "details", $this->tracked_user, $obj_ids, true, $this->details_mode, $personal_only, $this->details_obj_id);
                $this->tpl->setVariable("LP_OBJECTS", $lp_table->getHTML());
                
                $this->tpl->setVariable("LEGEND",$this->__getLegendHTML());
        }

Here is the call graph for this function:

Here is the caller graph for this function:

& ilLPListOfProgressGUI::executeCommand

(

)

execute command

Definition at line 43 of file class.ilLPListOfProgressGUI.php.

References $cmd, ilLearningProgressBaseGUI\__getDefaultCommand(), and ilLearningProgressBaseGUI\getUserId().

        {
                global $ilUser;
                
                $this->ctrl->setReturn($this, "show");
                $this->ctrl->saveParameter($this,'user_id',$this->getUserId());
                switch($this->ctrl->getNextClass())
                {
                        case 'illpprogresstablegui':
                                include_once './Services/Tracking/classes/class.ilLPProgressTableGUI.php';
                            $table_gui = new ilLPProgressTableGUI($this, "", $this->tracked_user);
                                $this->ctrl->setReturn($this,'show');
                                $this->ctrl->forwardCommand($table_gui);
                                break;

                        /*
                        case 'ilpdfpresentation':
                                include_once './Services/Tracking/classes/class.ilPDFPresentation.php';
                                $pdf_gui = new ilPDFPresentation($this->getMode(),$this->details_id,$this->getUserId(),$this->tracked_user->getId());
                                $pdf_gui->setType(LP_ACTIVE_PROGRESS);
                                $this->ctrl->setReturn($this,'show');
                                $this->ctrl->forwardCommand($pdf_gui);
                                break;
                         */

                        default:
                                $cmd = $this->__getDefaultCommand();
                                $this->$cmd();

                }
                return true;
        }

Here is the call graph for this function:

ilLPListOfProgressGUI::ilLPListOfProgressGUI	(		$a_mode,
			$a_ref_id,
			$a_user_id = 0
	)

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

References $_GET, $_REQUEST, __initDetails(), __initUser(), and ilLearningProgressBaseGUI\ilLearningProgressBaseGUI().

        {
                parent::ilLearningProgressBaseGUI($a_mode,$a_ref_id,$a_user_id);
                // $this->__checkPDF();

                $this->__initUser($a_user_id);
                
                // Set item id for details
                $this->__initDetails((int) $_GET['details_id']);
                $this->ctrl->saveParameter($this,'details_id',$_REQUEST['details_id']);
        }

Here is the call graph for this function:

ilLPListOfProgressGUI::show

(

)

Definition at line 76 of file class.ilLPListOfProgressGUI.php.

References __initDetails(), __initUser(), __showProgressList(), details(), ilLearningProgressBaseGUI\getMode(), ilLearningProgressBaseGUI\getRefId(), ilLearningProgressBaseGUI\getUserId(), LP_MODE_REPOSITORY, and LP_MODE_USER_FOLDER.

        {
                global $ilObjDataCache;

                switch($this->getMode())
                {
                        // Show only detail of current repository item if called from repository
                        case LP_MODE_REPOSITORY:
                                $this->__initDetails($this->getRefId());
                                return $this->details();

                        case LP_MODE_USER_FOLDER:
                                // if called from user folder obj_id is id of current user
                                $this->__initUser($this->getUserId());
                                break;
                }

                // not called from repository
                $this->__showProgressList();
        }

Here is the call graph for this function:

Field Documentation

ilLPListOfProgressGUI::$details_id = 0

Definition at line 23 of file class.ilLPListOfProgressGUI.php.

ilLPListOfProgressGUI::$details_mode = 0

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

ilLPListOfProgressGUI::$details_type = ''

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

ilLPListOfProgressGUI::$tracked_user = null

Definition at line 22 of file class.ilLPListOfProgressGUI.php.

---

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

• Services/Tracking/classes/class.ilLPListOfProgressGUI.php