moodle/admin/tool/assignmentupgrade/upgradableassignmentstable.php

<?php
// This file is part of Moodle - http://moodle.org/
//
// Moodle is free software: you can redistribute it and/or modify
// it under the terms of the GNU General Public License as published by
// the Free Software Foundation, either version 3 of the License, or
// (at your option) any later version.
//
// Moodle is distributed in the hope that it will be useful,
// but WITHOUT ANY WARRANTY; without even the implied warranty of
// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
// GNU General Public License for more details.
//
// You should have received a copy of the GNU General Public License
// along with Moodle.  If not, see <http://www.gnu.org/licenses/>.

/**
 * This file contains the definition for the grading table which subclassses easy_table
 *
 * @package   tool_assignmentupgrade
 * @copyright 2012 NetSpot {@link http://www.netspot.com.au}
 * @license   http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
 */

defined('MOODLE_INTERNAL') || die();

require_once($CFG->libdir.'/tablelib.php');
require_once($CFG->libdir.'/gradelib.php');
require_once($CFG->dirroot.'/mod/assign/locallib.php');

/**
 * Extends table_sql to provide a table of assignment submissions
 *
 * @package   tool_assignmentupgrade
 * @copyright 2012 NetSpot {@link http://www.netspot.com.au}
 * @license   http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
 */
class tool_assignmentupgrade_assignments_table extends table_sql implements renderable {
    /** @var int $perpage */
    private $perpage = 10;
    /** @var int $rownum (global index of current row in table) */
    private $rownum = -1;
    /** @var renderer_base for getting output */
    private $output = null;
    /** @var boolean anyupgradableassignments - True if there is one or more assignments that can upgraded */
    public $anyupgradableassignments = false;

    /**
     * This table loads a list of the old assignment instances and tests them to see if they can be upgraded
     *
     * @param int $perpage How many per page
     * @param int $rowoffset The starting row for pagination
     */
    function __construct($perpage, $rowoffset=0) {
        global $PAGE;
        parent::__construct('tool_assignmentupgrade_assignments');
        $this->perpage = $perpage;
        $this->output = $PAGE->get_renderer('tool_assignmentupgrade');

        $this->define_baseurl(new moodle_url('/admin/tool/assignmentupgrade/listnotupgraded.php'));

        $this->anyupgradableassignments = tool_assignmentupgrade_any_upgradable_assignments();

        // do some business - then set the sql
        if ($rowoffset) {
            $this->rownum = $rowoffset - 1;
        }

        $fields = 'a.id as id, a.name as name, a.assignmenttype as type, c.shortname as courseshortname, c.id as courseid, COUNT(s.id) as submissioncount';
        $from = '{assignment} a JOIN {course} c ON a.course = c.id ' .
                        ' LEFT JOIN {assignment_submissions} s ON a.id = s.assignment';

        $where = '1 = 1';
        $where .= ' GROUP BY a.id, a.name, a.assignmenttype, c.shortname, c.id ';

        $this->set_sql($fields, $from, $where, array());
        $this->set_count_sql('SELECT COUNT(*) FROM {assignment} a JOIN {course} c ON a.course = c.id', array());

        $columns = array();
        $headers = array();

        $columns[] = 'select';
        $headers[] = get_string('select', 'tool_assignmentupgrade') . '<div class="selectall"><input type="checkbox" name="selectall" title="' . get_string('selectall') . '"/></div>';
        $columns[] = 'upgradable';
        $headers[] = get_string('upgradable', 'tool_assignmentupgrade');
        $columns[] = 'id';
        $headers[] = get_string('assignmentid', 'tool_assignmentupgrade');
        $columns[] = 'courseshortname';
        $headers[] = get_string('course');
        $columns[] = 'name';
        $headers[] = get_string('name');
        $columns[] = 'type';
        $headers[] = get_string('assignmenttype', 'tool_assignmentupgrade');
        $columns[] = 'submissioncount';
        $headers[] = get_string('submissions', 'tool_assignmentupgrade');

        // set the columns
        $this->define_columns($columns);
        $this->define_headers($headers);
        $this->no_sorting('upgradable');
        $this->no_sorting('select');
    }

    /**
     * Return the number of rows to display on a single page
     *
     * @return int The number of rows per page
     */
    function get_rows_per_page() {
        return $this->perpage;
    }

    /**
     * Format a link to the assignment instance
     *
     * @param stdClass $row
     * @return string
     */
    function col_name(stdClass $row) {
        return html_writer::link(new moodle_url('/mod/assignment/view.php',
                array('a' => $row->id)), $row->name);
    }


    /**
     * Format a link to the upgrade single tool
     *
     * @param stdClass $row (contains cached result from previous upgradable check)
     * @return string
     */
    function col_upgradable(stdClass $row) {
        if ($row->upgradable) {
            return html_writer::link(new moodle_url('/admin/tool/assignmentupgrade/upgradesingleconfirm.php',
                    array('id' => $row->id, 'sesskey' => sesskey())), get_string('supported', 'tool_assignmentupgrade'));
        } else {
            return get_string('notsupported', 'tool_assignmentupgrade');
        }
    }

    /**
     * Insert a checkbox for selecting the current row for batch operations
     *
     * @param stdClass $row
     * @return string
     */
    function col_select(stdClass $row) {
        global $CFG;
        $version = get_config('assignment_' . $row->type, 'version');
        require_once($CFG->dirroot . '/mod/assign/locallib.php');
        if (assign::can_upgrade_assignment($row->type, $version)) {
            $row->upgradable = true;
            return '<input type="checkbox" name="selectedassignment" value="' . $row->id . '"/>';
        }
        $row->upgradable = false;
        return '';
    }

    /**
     * Override the table show_hide_link to not show for select column
     *
     * @param string $column the column name, index into various names.
     * @param int $index numerical index of the column.
     * @return string HTML fragment.
     */
    protected function show_hide_link($column, $index) {
        if ($index > 0) {
            return parent::show_hide_link($column, $index);
        }
        return '';
    }
}