MDL-35770 Include file defining base class in order to work correctly in cron
[moodle.git] / course / format / social / lib.php
CommitLineData
7d2a0492 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/**
bf1a9494 18 * This file contains main class for the course format Social
7d2a0492 19 *
bf1a9494
MG
20 * @since 2.0
21 * @package format_social
7d2a0492 22 * @copyright 2009 Sam Hemelryk
23 * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
24 */
25
399ad6bf
MG
26defined('MOODLE_INTERNAL') || die();
27require_once($CFG->dirroot. '/course/format/lib.php');
28
7d2a0492 29/**
bf1a9494 30 * Main class for the Social course format
7d2a0492 31 *
bf1a9494
MG
32 * @package format_social
33 * @copyright 2012 Marina Glancy
34 * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
7d2a0492 35 */
bf1a9494 36class format_social extends format_base {
7d2a0492 37
bf1a9494
MG
38 /**
39 * The URL to use for the specified course
40 *
41 * @param int|stdClass $section Section object from database or just field course_sections.section
42 * if null the course view page is returned
43 * @param array $options options for view URL. At the moment core uses:
44 * 'navigation' (bool) if true and section has no separate page, the function returns null
45 * 'sr' (int) used by multipage formats to specify to which section to return
46 * @return null|moodle_url
47 */
48 public function get_view_url($section, $options = array()) {
49 if (!empty($options['navigation']) && $section !== null) {
50 return null;
51 }
52 return new moodle_url('/course/view.php', array('id' => $this->courseid));
53 }
7d2a0492 54
bf1a9494
MG
55 /**
56 * Loads all of the course sections into the navigation
57 *
58 * @param global_navigation $navigation
59 * @param navigation_node $node The course node within the navigation
60 */
61 public function extend_course_navigation($navigation, navigation_node $node) {
62 // Social course format does not extend navigation, it uses social_activities block instead
63 }
4bd1108f 64
bf1a9494
MG
65 /**
66 * Returns the list of blocks to be automatically added for the newly created course
67 *
68 * @return array of default blocks, must contain two keys BLOCK_POS_LEFT and BLOCK_POS_RIGHT
69 * each of values is an array of block names (for left and right side columns)
70 */
71 public function get_default_blocks() {
72 return array(
73 BLOCK_POS_LEFT => array(),
74 BLOCK_POS_RIGHT => array('search_forums', 'calendar_upcoming', 'social_activities',
75 'recent_activity', 'course_list')
76 );
77 }
7d2a0492 78}