report/participation/lib.php

   1 <?php
   2 // This file is part of Moodle - http://moodle.org/
   3 //
   4 // Moodle is free software: you can redistribute it and/or modify
   5 // it under the terms of the GNU General Public License as published by
   6 // the Free Software Foundation, either version 3 of the License, or
   7 // (at your option) any later version.
   8 //
   9 // Moodle is distributed in the hope that it will be useful,
  10 // but WITHOUT ANY WARRANTY; without even the implied warranty of
  11 // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  12 // GNU General Public License for more details.
  13 //
  14 // You should have received a copy of the GNU General Public License
  15 // along with Moodle.  If not, see <http://www.gnu.org/licenses/>.
  16
  17 /**
  18  * This file contains functions used by the participation report
  19  *
  20  * @package    report
  21  * @subpackage participation
  22  * @copyright  2009 Sam Hemelryk
  23  * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
  24  */
  25
  26 defined('MOODLE_INTERNAL') || die;
  27
  28 /**
  29  * This function extends the navigation with the report items
  30  *
  31  * @param navigation_node $navigation The navigation node to extend
  32  * @param stdClass $course The course to object for the report
  33  * @param stdClass $context The context of the course
  34  */
  35 function report_participation_extend_navigation_course($navigation, $course, $context) {
  36     global $CFG, $OUTPUT;
  37     if (has_capability('report/participation:view', $context)) {
  38         $url = new moodle_url('/report/participation/index.php', array('id'=>$course->id));
  39         $navigation->add(get_string('pluginname', 'report_participation'), $url, navigation_node::TYPE_SETTING, null, null, new pix_icon('i/report', ''));
  40     }
  41 }
  42
  43 /**
  44  * Return a list of page types
  45  * @param string $pagetype current page type
  46  * @param stdClass $parentcontext Block's parent context
  47  * @param stdClass $currentcontext Current context of block
  48  * @return array
  49  */
  50 function report_participation_page_type_list($pagetype, $parentcontext, $currentcontext) {
  51     $array = array(
  52         '*'                          => get_string('page-x', 'pagetype'),
  53         'report-*'                   => get_string('page-report-x', 'pagetype'),
  54         'report-participation-*'     => get_string('page-report-participation-x',  'report_participation'),
  55         'report-participation-index' => get_string('page-report-participation-index',  'report_participation'),
  56     );
  57     return $array;
  58 }
  59
  60 /**
  61  * Callback to verify if the given instance of store is supported by this report or not.
  62  *
  63  * @param string $instance store instance.
  64  *
  65  * @return bool returns true if the store is supported by the report, false otherwise.
  66  */
  67 function report_participation_supports_logstore($instance) {
  68     if ($instance instanceof \core\log\sql_internal_table_reader || $instance instanceof \logstore_legacy\log\store) {
  69         return true;
  70     }
  71     return false;
  72 }