class.ilLPObjectStatisticsGUI.php

Go to the documentation of this file.

<?php

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

include_once "Services/Tracking/classes/class.ilLearningProgressBaseGUI.php";

class ilLPObjectStatisticsGUI extends ilLearningProgressBaseGUI
{

    protected $dic;

    public function __construct($a_mode, $a_ref_id = 0)
    {
        global $DIC;

        $this->dic = $DIC;
        parent::__construct($a_mode, $a_ref_id);
    
        if (!$this->ref_id) {
            $this->ref_id = (int) $_REQUEST["ref_id"];
        }
    }

    protected function setTabs()
    {
        global $DIC;

        $ilAccess = $DIC['ilAccess'];
        
        $this->tabs_gui->addSubTab(
            'trac_object_stat_access',
            $this->lng->txt('trac_object_stat_access'),
            $this->ctrl->getLinkTarget($this, 'accessFilter')
        );
        $this->tabs_gui->addSubTab(
            'trac_object_stat_daily',
            $this->lng->txt('trac_object_stat_daily'),
            $this->ctrl->getLinkTarget($this, 'dailyFilter')
        );
        $this->tabs_gui->addSubTab(
            'trac_object_stat_lp',
            $this->lng->txt('trac_object_stat_lp'),
            $this->ctrl->getLinkTarget($this, 'learningProgressFilter')
        );
        $this->tabs_gui->addSubTab(
            'trac_object_stat_types',
            $this->lng->txt('trac_object_stat_types'),
            $this->ctrl->getLinkTarget($this, 'typesFilter')
        );

        if ($this->dic->rbac()->system()->checkAccess("visible,read", $this->ref_id)) {
            $this->tabs_gui->addSubTab(
                'trac_object_stat_admin',
                $this->lng->txt('trac_object_stat_admin'),
                $this->ctrl->getLinkTarget($this, 'admin')
            );
        }
    }
    
    public function executeCommand()
    {
        $this->ctrl->setReturn($this, "");
        
        $this->setTabs();

        switch ($this->ctrl->getNextClass()) {
            default:
                $cmd = $this->__getDefaultCommand();
                $this->$cmd();
        }

        return true;
    }

    public function applyAccessFilter()
    {
        include_once("./Services/Tracking/classes/object_statistics/class.ilLPObjectStatisticsTableGUI.php");
        $lp_table = new ilLPObjectStatisticsTableGUI($this, "access", null, false);
        $lp_table->resetOffset();
        $lp_table->writeFilterToSession();
        $this->access();
    }

    public function resetAccessFilter()
    {
        include_once("./Services/Tracking/classes/object_statistics/class.ilLPObjectStatisticsTableGUI.php");
        $lp_table = new ilLPObjectStatisticsTableGUI($this, "access", null, false);
        $lp_table->resetOffset();
        $lp_table->resetFilter();
        $this->access();
    }

    public function accessFilter()
    {
        $this->access(false);
    }

    public function access($a_load_data = true)
    {
        global $DIC;

        $tpl = $DIC['tpl'];
        
        $this->tabs_gui->activateSubTab('trac_object_stat_access');
        
        $this->showAggregationInfo();

        include_once("./Services/Tracking/classes/object_statistics/class.ilLPObjectStatisticsTableGUI.php");
        $lp_table = new ilLPObjectStatisticsTableGUI($this, "access", null, $a_load_data);
        
        if (!$a_load_data) {
            $lp_table->disable("content");
            $lp_table->disable("header");
        }
        
        $tpl->setContent($lp_table->getHTML());
    }

    public function showAccessGraph()
    {
        global $DIC;

        $lng = $DIC['lng'];
        $tpl = $DIC['tpl'];
        
        if (!$_POST["item_id"]) {
            ilUtil::sendFailure($lng->txt("no_checkbox"));
            return $this->access();
        }
        
        $this->tabs_gui->activateSubTab('trac_object_stat_access');

        include_once("./Services/Tracking/classes/object_statistics/class.ilLPObjectStatisticsTableGUI.php");
        $lp_table = new ilLPObjectStatisticsTableGUI($this, "access", $_POST["item_id"]);

        $tpl->setContent($lp_table->getGraph($_POST["item_id"]) . $lp_table->getHTML());
    }

    public function applyTypesFilter()
    {
        include_once("./Services/Tracking/classes/object_statistics/class.ilLPObjectStatisticsTypesTableGUI.php");
        $lp_table = new ilLPObjectStatisticsTypesTableGUI($this, "types", null, false);
        $lp_table->resetOffset();
        $lp_table->writeFilterToSession();
        $this->types();
    }

    public function resetTypesFilter()
    {
        include_once("./Services/Tracking/classes/object_statistics/class.ilLPObjectStatisticsTypesTableGUI.php");
        $lp_table = new ilLPObjectStatisticsTypesTableGUI($this, "types", null, false);
        $lp_table->resetOffset();
        $lp_table->resetFilter();
        $this->types();
    }

    public function typesFilter()
    {
        $this->types(false);
    }

    public function types($a_load_data = true)
    {
        global $DIC;

        $tpl = $DIC['tpl'];
        
        $this->tabs_gui->activateSubTab('trac_object_stat_types');
        
        $this->showCronJobInfo();

        include_once("./Services/Tracking/classes/object_statistics/class.ilLPObjectStatisticsTypesTableGUI.php");
        $lp_table = new ilLPObjectStatisticsTypesTableGUI($this, "types", null, $a_load_data);

        if (!$a_load_data) {
            $lp_table->disable("content");
            $lp_table->disable("header");
        }
        
        $tpl->setContent($lp_table->getHTML());
    }

    public function showTypesGraph()
    {
        global $DIC;

        $lng = $DIC['lng'];
        $tpl = $DIC['tpl'];

        if (!$_POST["item_id"]) {
            ilUtil::sendFailure($lng->txt("no_checkbox"));
            return $this->types();
        }
        
        $this->tabs_gui->activateSubTab('trac_object_stat_types');

        include_once("./Services/Tracking/classes/object_statistics/class.ilLPObjectStatisticsTypesTableGUI.php");
        $lp_table = new ilLPObjectStatisticsTypesTableGUI($this, "types", $_POST["item_id"]);

        $tpl->setContent($lp_table->getGraph($_POST["item_id"]) . $lp_table->getHTML());
    }

    public function applyDailyFilter()
    {
        include_once("./Services/Tracking/classes/object_statistics/class.ilLPObjectStatisticsDailyTableGUI.php");
        $lp_table = new ilLPObjectStatisticsDailyTableGUI($this, "daily", null, false);
        $lp_table->resetOffset();
        $lp_table->writeFilterToSession();
        $this->daily();
    }

    public function resetDailyFilter()
    {
        include_once("./Services/Tracking/classes/object_statistics/class.ilLPObjectStatisticsDailyTableGUI.php");
        $lp_table = new ilLPObjectStatisticsDailyTableGUI($this, "daily", null, false);
        $lp_table->resetOffset();
        $lp_table->resetFilter();
        $this->daily();
    }

    public function dailyFilter()
    {
        $this->daily(false);
    }

    public function daily($a_load_data = true)
    {
        global $DIC;

        $tpl = $DIC['tpl'];
        
        $this->tabs_gui->activateSubTab('trac_object_stat_daily');
        
        $this->showAggregationInfo();

        include_once("./Services/Tracking/classes/object_statistics/class.ilLPObjectStatisticsDailyTableGUI.php");
        $lp_table = new ilLPObjectStatisticsDailyTableGUI($this, "daily", null, $a_load_data);

        if (!$a_load_data) {
            $lp_table->disable("content");
            $lp_table->disable("header");
        }
        
        $tpl->setContent($lp_table->getHTML());
    }

    public function showDailyGraph()
    {
        global $DIC;

        $lng = $DIC['lng'];
        $tpl = $DIC['tpl'];

        if (!$_POST["item_id"]) {
            ilUtil::sendFailure($lng->txt("no_checkbox"));
            return $this->daily();
        }
        
        $this->tabs_gui->activateSubTab('trac_object_stat_daily');

        include_once("./Services/Tracking/classes/object_statistics/class.ilLPObjectStatisticsDailyTableGUI.php");
        $lp_table = new ilLPObjectStatisticsDailyTableGUI($this, "daily", $_POST["item_id"]);

        $tpl->setContent($lp_table->getGraph($_POST["item_id"]) . $lp_table->getHTML());
    }

    public function admin()
    {
        global $DIC;

        $tpl = $DIC['tpl'];
        $ilToolbar = $DIC['ilToolbar'];
        $lng = $DIC['lng'];
        $ilCtrl = $DIC['ilCtrl'];
        $ilAccess = $DIC['ilAccess'];
        
        $this->tabs_gui->activateSubTab('trac_object_stat_admin');
        
        $this->showAggregationInfo(false);

        if ($this->dic->rbac()->system()->checkAccess('write', $this->ref_id)) {
            $ilToolbar->addButton(
                $lng->txt("trac_sync_obj_stats"),
                $ilCtrl->getLinkTarget($this, "adminSync")
            );
        }

        if ($ilAccess->checkAccess("delete", "", $this->ref_id)) {
            include_once("./Services/Tracking/classes/object_statistics/class.ilLPObjectStatisticsAdminTableGUI.php");
            $lp_table = new ilLPObjectStatisticsAdminTableGUI($this, "admin");

            $tpl->setContent($lp_table->getHTML());
        }
    }

    public function adminSync()
    {
        global $DIC;

        $ilCtrl = $DIC['ilCtrl'];
        $lng = $DIC['lng'];
        
        include_once "Services/Tracking/classes/class.ilChangeEvent.php";
        ilChangeEvent::_syncObjectStats(time(), 1);

        ilUtil::sendSuccess($lng->txt("trac_sync_obj_stats_success"), true);
        $ilCtrl->redirect($this, "admin");
    }

    public function confirmDeleteData()
    {
        global $DIC;

        $lng = $DIC['lng'];
        $tpl = $DIC['tpl'];
        $ilTabs = $DIC['ilTabs'];
        $ilCtrl = $DIC['ilCtrl'];

        if (!$_POST["item_id"]) {
            ilUtil::sendFailure($lng->txt("no_checkbox"));
            return $this->admin();
        }

        $ilTabs->clearTargets();
        $ilTabs->setBackTarget(
            $lng->txt("back"),
            $ilCtrl->getLinkTarget($this, "admin")
        );

        // display confirmation message
        include_once("./Services/Utilities/classes/class.ilConfirmationGUI.php");
        $cgui = new ilConfirmationGUI();
        $cgui->setFormAction($ilCtrl->getFormAction($this));
        $cgui->setHeaderText($lng->txt("trac_sure_delete_data"));
        $cgui->setCancel($lng->txt("cancel"), "admin");
        $cgui->setConfirm($lng->txt("delete"), "deleteData");

        // list objects that should be deleted
        foreach ($_POST["item_id"] as $i) {
            $caption = $lng->txt("month_" . str_pad(substr($i, 5), 2, "0", STR_PAD_LEFT) . "_long") .
            " " . substr($i, 0, 4);
            
            $cgui->addItem("item_id[]", $i, $caption);
        }

        $tpl->setContent($cgui->getHTML());
    }

    public function deleteData()
    {
        global $DIC;

        $lng = $DIC['lng'];
        
        if (!$_POST["item_id"]) {
            ilUtil::sendFailure($lng->txt("no_checkbox"));
            return $this->admin();
        }

        include_once "Services/Tracking/classes/class.ilTrQuery.php";
        ilTrQuery::deleteObjectStatistics($_POST["item_id"]);
        ilUtil::sendSuccess($lng->txt("trac_data_deleted"));
        $this->admin();
    }
    
    public function applyLearningProgressFilter()
    {
        include_once("./Services/Tracking/classes/object_statistics/class.ilLPObjectStatisticsLPTableGUI.php");
        $lp_table = new ilLPObjectStatisticsLPTableGUI($this, "learningProgress", null, false);
        $lp_table->resetOffset();
        $lp_table->writeFilterToSession();
        $this->learningProgress();
    }

    public function resetLearningProgressFilter()
    {
        include_once("./Services/Tracking/classes/object_statistics/class.ilLPObjectStatisticsLPTableGUI.php");
        $lp_table = new ilLPObjectStatisticsLPTableGUI($this, "learningProgress", null, false);
        $lp_table->resetOffset();
        $lp_table->resetFilter();
        $this->learningProgress();
    }
    
    public function learningProgressFilter()
    {
        $this->learningProgress(false);
    }

    public function learningProgress($a_load_data = true)
    {
        global $DIC;

        $tpl = $DIC['tpl'];
        
        $this->tabs_gui->activateSubTab('trac_object_stat_lp');
        
        $this->showCronJobInfo();

        include_once("./Services/Tracking/classes/object_statistics/class.ilLPObjectStatisticsLPTableGUI.php");
        $lp_table = new ilLPObjectStatisticsLPTableGUI($this, "learningProgress", null, $a_load_data);
        
        if (!$a_load_data) {
            $lp_table->disable("content");
            $lp_table->disable("header");
        }
        
        $tpl->setContent($lp_table->getHTML());
    }

    public function showLearningProgressGraph()
    {
        global $DIC;

        $lng = $DIC['lng'];
        $tpl = $DIC['tpl'];
        
        if (!$_POST["item_id"]) {
            ilUtil::sendFailure($lng->txt("no_checkbox"));
            return $this->learningProgress();
        }
        
        $this->tabs_gui->activateSubTab('trac_object_stat_lp');

        include_once("./Services/Tracking/classes/object_statistics/class.ilLPObjectStatisticsLPTableGUI.php");
        $lp_table = new ilLPObjectStatisticsLPTableGUI($this, "learningProgress", $_POST["item_id"], true, true);
                
        $tpl->setContent($lp_table->getGraph($_POST["item_id"]) . $lp_table->getHTML());
    }

    public function showLearningProgressDetails()
    {
        include_once("./Services/Tracking/classes/object_statistics/class.ilLPObjectStatisticsLPTableGUI.php");
        $lp_table = new ilLPObjectStatisticsLPTableGUI($this, "showLearningProgressDetails", array($_GET["item_id"]), true, false, true);
        
        $a_tpl = new ilTemplate("tpl.lp_object_statistics_lp_details.html", true, true, "Services/Tracking");
        $a_tpl->setVariable("CONTENT", $lp_table->getHTML());
        $a_tpl->setVariable('CLOSE_IMG_TXT', $this->lng->txt('close'));
        echo $a_tpl->get();
        exit();
    }
    
    protected function showAggregationInfo($a_show_link = true)
    {
        global $DIC;

        $ilAccess = $DIC['ilAccess'];
        $lng = $DIC['lng'];
        $ilCtrl = $DIC['ilCtrl'];
        
        include_once "Services/Tracking/classes/class.ilTrQuery.php";
        $info = ilTrQuery::getObjectStatisticsLogInfo();
        $info_date = ilDatePresentation::formatDate(new ilDateTime($info["tstamp"], IL_CAL_UNIX));
                    
        $link = "";
        if ($a_show_link && $ilAccess->checkAccess("write", "", $this->ref_id)) {
            $link = " <a href=\"" . $ilCtrl->getLinkTarget($this, "admin") . "\">&raquo;" .
                $lng->txt("trac_log_info_link") . "</a>";
        }
        
        ilUtil::sendInfo(sprintf($lng->txt("trac_log_info"), $info_date, $info["counter"]) . $link);
    }
    
    protected function showCronJobInfo()
    {
        global $DIC;

        $lng = $DIC['lng'];
        
        include_once "Services/Cron/classes/class.ilCronManager.php";
        if (!ilCronManager::isJobActive("lp_object_statistics")) {
            ilUtil::sendInfo($lng->txt("trac_cron_info"));
        }
    }
}