moodle/my/lib.php

121 lines
4.4 KiB
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/>.
/**
* My Moodle -- a user's personal dashboard
*
* This file contains common functions for the dashboard and profile pages.
*
* @package moodlecore
* @subpackage my
* @copyright 2010 Remote-Learner.net
* @author Hubert Chathi <hubert@remote-learner.net>
* @author Olav Jordan <olav.jordan@remote-learner.net>
* @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
*/
define('MY_PAGE_PUBLIC', 0);
define('MY_PAGE_PRIVATE', 1);
require_once("$CFG->libdir/blocklib.php");
/*
* For a given user, this returns the $page information for their My Moodle page
*
*/
function my_get_page($userid, $private=MY_PAGE_PRIVATE) {
global $DB, $CFG;
if (empty($CFG->forcedefaultmymoodle) && $userid) { // Ignore custom My Moodle pages if admin has forced them
// Does the user have their own page defined? If so, return it.
if ($customised = $DB->get_record('my_pages', array('userid' => $userid, 'private' => $private))) {
return $customised;
}
}
// Otherwise return the system default page
return $DB->get_record('my_pages', array('userid' => null, 'name' => '__default', 'private' => $private));
}
/*
* This copies a system default page to the current user
*
*/
function my_copy_page($userid, $private=MY_PAGE_PRIVATE, $pagetype='my-index') {
global $DB;
if ($customised = $DB->record_exists('my_pages', array('userid' => $userid, 'private' => $private))) {
return $customised; // We're done!
}
// Get the system default page
if (!$systempage = $DB->get_record('my_pages', array('userid' => null, 'private' => $private))) {
return false; // error
}
// Clone the basic system page record
$page = clone($systempage);
unset($page->id);
$page->userid = $userid;
if (!$page->id = $DB->insert_record('my_pages', $page)) {
return false;
}
// Clone ALL the associated blocks as well
$systemcontext = get_context_instance(CONTEXT_SYSTEM);
$usercontext = get_context_instance(CONTEXT_USER, $userid);
$blockinstances = $DB->get_records('block_instances', array('parentcontextid' => $systemcontext->id,
'pagetypepattern' => $pagetype,
'subpagepattern' => $systempage->id));
foreach ($blockinstances as $instance) {
unset($instance->id);
$instance->parentcontextid = $usercontext->id;
$instance->subpagepattern = $page->id;
if ($instance->id = $DB->insert_record('block_instances', $instance)) {
$blockcontext = get_context_instance(CONTEXT_BLOCK, $instance->id); // Just creates the context record
}
}
// FIXME: block position overrides should be merged in with block instance
//$blockpositions = $DB->get_records('block_positions', array('subpage' => $page->name));
//foreach($blockpositions as $positions) {
// $positions->subpage = $page->name;
// $DB->insert_record('block_positions', $tc);
//}
return $page;
}
class my_syspage_block_manager extends block_manager {
// HACK WARNING!
// TODO: figure out a better way to do this
/**
* Load blocks using the system context, rather than the user's context.
*
* This is needed because the My Moodle pages set the page context to the
* user's context for access control, etc. But the blocks for the system
* pages are stored in the system context.
*/
public function load_blocks($includeinvisible = null) {
$origcontext = $this->page->context;
$this->page->context = get_context_instance(CONTEXT_SYSTEM);
parent::load_blocks($includeinvisible);
$this->page->context = $origcontext;
}
}