Merge branch 'wip-mdl-31023' of git://github.com/rajeshtaneja/moodle

This commit is contained in:
Dan Poltawski
2012-07-23 13:13:47 +08:00
4 changed files with 1 additions and 471 deletions
-1
View File
@@ -41,7 +41,6 @@ $string['missingconfigversion'] = 'Config table does not contain version, can no
$string['modulenotexist'] = '{$a} module doesn\'t exist';
$string['morethanonerecordinfetch'] = 'Found more than one record in fetch() !';
$string['mustbeoveride'] = 'Abstract {$a} method must be overridden.';
$string['noactivityname'] = 'Page object derived from page_generic_activity but did not define $this->activityname';
$string['noadminrole'] = 'No admin role could be found';
$string['noblocks'] = 'No blocks installed!';
$string['nocate'] = 'No categories!';
-29
View File
@@ -1960,35 +1960,6 @@ function blocks_delete_all_on_page($pagetype, $pageid) {
return false;
}
/**
* Dispite what this function is called, it seems to be mostly used to populate
* the default blocks when a new course (or whatever) is created.
*
* @deprecated since 2.0
*
* @param object $page the page to add default blocks to.
* @return boolean success or failure.
*/
function blocks_repopulate_page($page) {
global $CFG;
debugging('Call to deprecated function blocks_repopulate_page. ' .
'Use a more specific method like blocks_add_default_course_blocks, ' .
'or just call $PAGE->blocks->add_blocks()', DEBUG_DEVELOPER);
/// If the site override has been defined, it is the only valid one.
if (!empty($CFG->defaultblocks_override)) {
$blocknames = $CFG->defaultblocks_override;
} else {
$blocknames = $page->blocks_get_default();
}
$blocks = blocks_parse_default_blocks_list($blocknames);
$page->blocks->add_blocks($blocks);
return true;
}
/**
* Get the block record for a particular blockid - that is, a particular type os block.
*
-14
View File
@@ -925,20 +925,6 @@ function current_theme() {
return $PAGE->theme->name;
}
/**
* @todo Remove this deprecated function when no longer used
* @deprecated since Moodle 2.0 - use $PAGE->pagetype instead of the .
*
* @param string $getid used to return $PAGE->pagetype.
* @param string $getclass used to return $PAGE->legacyclass.
*/
function page_id_and_class(&$getid, &$getclass) {
global $PAGE;
debugging('Call to deprecated function page_id_and_class. Please use $PAGE->pagetype instead.', DEBUG_DEVELOPER);
$getid = $PAGE->pagetype;
$getclass = $PAGE->legacyclass;
}
/**
* Prints some red text using echo
*
+1 -427
View File
@@ -312,14 +312,6 @@ class moodle_page {
*/
protected $_periodicrefreshdelay = null;
/**
* @var stdClass This is simply to improve backwards compatibility. If old
* code relies on a page class that implements print_header, or complex logic
* in user_allowed_editing then we stash an instance of that other class here,
* and delegate to it in certain situations.
*/
protected $_legacypageobject = null;
/**
* @var array Associative array of browser shortnames (as used by check_browser_version)
* and their minimum required versions
@@ -650,16 +642,6 @@ class moodle_page {
return $this->_devicetypeinuse;
}
/**
* Please do not call this method directly, use the ->legacythemeinuse syntax. {@link moodle_page::__get()}.
* @deprecated since 2.1
* @return bool
*/
protected function magic_get_legacythemeinuse() {
debugging('$PAGE->legacythemeinuse is a deprecated property - please use $PAGE->devicetypeinuse and check if it is equal to legacy.', DEBUG_DEVELOPER);
return ($this->devicetypeinuse == 'legacy');
}
/**
* Please do not call this method directly use the ->periodicrefreshdelay syntax
* {@link moodle_page::__get()}
@@ -802,9 +784,6 @@ class moodle_page {
* @return bool
*/
public function user_allowed_editing() {
if ($this->_legacypageobject) {
return $this->_legacypageobject->user_allowed_editing();
}
return has_any_capability($this->all_editing_caps(), $this->_context);
}
@@ -1168,9 +1147,6 @@ class moodle_page {
if (is_null($this->_pagetype)) {
$this->initialise_default_pagetype($shorturl);
}
if (!is_null($this->_legacypageobject)) {
$this->_legacypageobject->set_url($url, $params);
}
}
/**
@@ -1779,192 +1755,6 @@ class moodle_page {
return $caps;
}
// Deprecated fields and methods for backwards compatibility ==================
/**
* Returns the page type.
*
* @deprecated since Moodle 2.0 - use $PAGE->pagetype instead.
* @return string page type.
*/
public function get_type() {
debugging('Call to deprecated method moodle_page::get_type. Please use $PAGE->pagetype instead.');
return $this->get_pagetype();
}
/**
* Returns the page type.
*
* @deprecated since Moodle 2.0 - use $PAGE->pagetype instead.
* @return string this is what page_id_and_class used to return via the $getclass parameter.
*/
public function get_format_name() {
return $this->get_pagetype();
}
/**
* Returns the course associated with this page.
*
* @deprecated since Moodle 2.0 - use $PAGE->course instead.
* @return stdClass course.
*/
public function get_courserecord() {
debugging('Call to deprecated method moodle_page::get_courserecord. Please use $PAGE->course instead.');
return $this->get_course();
}
/**
* Returns the legacy page class.
*
* @deprecated since Moodle 2.0
* @return string this is what page_id_and_class used to return via the $getclass parameter.
*/
public function get_legacyclass() {
if (is_null($this->_legacyclass)) {
$this->initialise_standard_body_classes();
}
debugging('Call to deprecated method moodle_page::get_legacyclass.');
return $this->_legacyclass;
}
/**
* Returns an array of block regions on this page.
*
* @deprecated since Moodle 2.0 - use $PAGE->blocks->get_regions() instead
* @return array the places on this page where blocks can go.
*/
function blocks_get_positions() {
debugging('Call to deprecated method moodle_page::blocks_get_positions. Use $PAGE->blocks->get_regions() instead.');
return $this->blocks->get_regions();
}
/**
* Returns the default block region.
*
* @deprecated since Moodle 2.0 - use $PAGE->blocks->get_default_region() instead
* @return string the default place for blocks on this page.
*/
function blocks_default_position() {
debugging('Call to deprecated method moodle_page::blocks_default_position. Use $PAGE->blocks->get_default_region() instead.');
return $this->blocks->get_default_region();
}
/**
* Returns the default block to use of the page.
* This function no longer does anything. DO NOT USE.
*
* @deprecated since Moodle 2.0 - no longer used.
*/
function blocks_get_default() {
debugging('Call to deprecated method moodle_page::blocks_get_default. This method has no function any more.');
}
/**
* Moves a block.
* This function no longer does anything. DO NOT USE.
*
* @deprecated since Moodle 2.0 - no longer used.
*/
function blocks_move_position(&$instance, $move) {
debugging('Call to deprecated method moodle_page::blocks_move_position. This method has no function any more.');
}
/**
* Returns the URL parameters for the current page.
*
* @deprecated since Moodle 2.0 - use $this->url->params() instead.
* @return array URL parameters for this page.
*/
function url_get_parameters() {
debugging('Call to deprecated method moodle_page::url_get_parameters. Use $this->url->params() instead.');
return $this->url->params();
}
/**
* Returns the URL path of the current page.
*
* @deprecated since Moodle 2.0 - use $this->url->params() instead.
* @return string URL for this page without parameters.
*/
function url_get_path() {
debugging('Call to deprecated method moodle_page::url_get_path. Use $this->url->out() instead.');
return $this->url->out();
}
/**
* Returns the full URL for this page.
*
* @deprecated since Moodle 2.0 - use $this->url->out() instead.
* @return string full URL for this page.
*/
function url_get_full($extraparams = array()) {
debugging('Call to deprecated method moodle_page::url_get_full. Use $this->url->out() instead.');
return $this->url->out(true, $extraparams);
}
/**
* Returns the legacy page object.
*
* @deprecated since Moodle 2.0 - just a backwards compatibility hook.
* @return moodle_page
*/
function set_legacy_page_object($pageobject) {
return $this->_legacypageobject = $pageobject;
}
/**
* Prints a header... DO NOT USE!
*
* @deprecated since Moodle 2.0 - page objects should no longer be doing print_header.
* @param mixed $_ ...
*/
function print_header($_) {
if (is_null($this->_legacypageobject)) {
throw new coding_exception('You have called print_header on $PAGE when there is not a legacy page class present.');
}
debugging('You should not longer be doing print_header via a page class.', DEBUG_DEVELOPER);
$args = func_get_args();
call_user_func_array(array($this->_legacypageobject, 'print_header'), $args);
}
/**
* Returns the ID for this page. DO NOT USE!
*
* @deprecated since Moodle 2.0
* @return the 'page id'. This concept no longer exists.
*/
function get_id() {
debugging('Call to deprecated method moodle_page::get_id(). It should not be necessary any more.', DEBUG_DEVELOPER);
if (!is_null($this->_legacypageobject)) {
return $this->_legacypageobject->get_id();
}
return 0;
}
/**
* Returns the ID for this page. DO NOT USE!
*
* @deprecated since Moodle 2.0
* @return the 'page id'. This concept no longer exists.
*/
function get_pageid() {
debugging('Call to deprecated method moodle_page::get_pageid(). It should not be necessary any more.', DEBUG_DEVELOPER);
if (!is_null($this->_legacypageobject)) {
return $this->_legacypageobject->get_id();
}
return 0;
}
/**
* Returns the module record for this page.
*
* @deprecated since Moodle 2.0 - user $PAGE->cm instead.
* @return $this->cm;
*/
function get_modulerecord() {
return $this->cm;
}
/**
* Returns true if the page URL has beem set.
*
@@ -2001,220 +1791,4 @@ class moodle_page {
public function set_popup_notification_allowed($allowed) {
$this->_popup_notification_allowed = $allowed;
}
}
/**
* Not needed any more. DO NOT USE!
*
* @deprecated since Moodle 2.0
* @param string $path the folder path
* @return array an array of page types.
*/
function page_import_types($path) {
global $CFG;
debugging('Call to deprecated function page_import_types.', DEBUG_DEVELOPER);
}
/**
* Do not use this any more. The global $PAGE is automatically created for you.
* If you need custom behaviour, you should just set properties of that object.
*
* @deprecated since Moodle 2.0
* @param integer $instance legacy page instance id.
* @return moodle_page The global $PAGE object.
*/
function page_create_instance($instance) {
global $PAGE;
return page_create_object($PAGE->pagetype, $instance);
}
/**
* Do not use this any more. The global $PAGE is automatically created for you.
* If you need custom behaviour, you should just set properties of that object.
*
* @deprecated since Moodle 2.0
* @return moodle_page The global $PAGE object.
*/
function page_create_object($type, $id = NULL) {
global $CFG, $PAGE, $SITE, $ME;
debugging('Call to deprecated function page_create_object.', DEBUG_DEVELOPER);
$data = new stdClass;
$data->pagetype = $type;
$data->pageid = $id;
$classname = page_map_class($type);
if (!$classname) {
return $PAGE;
}
$legacypage = new $classname;
$legacypage->init_quick($data);
$course = $PAGE->course;
if ($course->id != $SITE->id) {
$legacypage->set_course($course);
} else {
try {
$category = $PAGE->category;
} catch (coding_exception $e) {
// Was not set before, so no need to try to set it again.
$category = false;
}
if ($category) {
$legacypage->set_category_by_id($category->id);
} else {
$legacypage->set_course($SITE);
}
}
$legacypage->set_pagetype($type);
$legacypage->set_url($ME);
$PAGE->set_url(str_replace($CFG->wwwroot . '/', '', $legacypage->url_get_full()));
$PAGE->set_pagetype($type);
$PAGE->set_legacy_page_object($legacypage);
return $PAGE;
}
/**
* You should not be writing page subclasses any more. Just set properties on the
* global $PAGE object to control its behaviour.
*
* @deprecated since Moodle 2.0
* @return mixed Null if there is not a valid page mapping, or the mapping if
* it has been set.
*/
function page_map_class($type, $classname = NULL) {
global $CFG;
static $mappings = array(
PAGE_COURSE_VIEW => 'page_course',
);
if (!empty($type) && !empty($classname)) {
$mappings[$type] = $classname;
}
if (!isset($mappings[$type])) {
debugging('Page class mapping requested for unknown type: '.$type);
return null;
} else if (empty($classname) && !class_exists($mappings[$type])) {
debugging('Page class mapping for id "'.$type.'" exists but class "'.$mappings[$type].'" is not defined');
return null;
}
return $mappings[$type];
}
/**
* Parent class from which all Moodle page classes derive
*
* @deprecated since Moodle 2.0
* @package core
* @category page
* @copyright 1999 onwards Martin Dougiamas {@link http://moodle.com}
* @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
*/
class page_base extends moodle_page {
/**
* @var int The numeric identifier of the page being described.
*/
public $id = null;
/**
* Returns the page id
* @deprecated since Moodle 2.0
* @return int Returns the id of the page.
*/
public function get_id() {
return $this->id;
}
/**
* Initialize the data members of the parent class
* @param scalar $data
*/
public function init_quick($data) {
$this->id = $data->pageid;
}
/**
* DOES NOTHING... DO NOT USE.
* @deprecated since Moodle 2.0
*/
public function init_full() {}
}
/**
* Class that models the behavior of a moodle course.
* Although this does nothing, this class declaration should be left for now
* since there may be legacy class doing class page_... extends page_course
*
* @deprecated since Moodle 2.0
* @package core
* @category page
* @copyright 1999 onwards Martin Dougiamas {@link http://moodle.com}
* @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
*/
class page_course extends page_base {}
/**
* Class that models the common parts of all activity modules
*
* @deprecated since Moodle 2.0
* @package core
* @category page
* @copyright 1999 onwards Martin Dougiamas {@link http://moodle.com}
* @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
*/
class page_generic_activity extends page_base {
/**
* Although this function is deprecated, it should be left here because
* people upgrading legacy code need to copy it. See
* http://docs.moodle.org/dev/Migrating_your_code_to_the_2.0_rendering_API
*
* @param string $title
* @param array $morenavlinks
* @param string $bodytags
* @param string $meta
*/
function print_header($title, $morenavlinks = NULL, $bodytags = '', $meta = '') {
global $USER, $CFG, $PAGE, $OUTPUT;
$this->init_full();
$replacements = array(
'%fullname%' => format_string($this->activityrecord->name)
);
foreach ($replacements as $search => $replace) {
$title = str_replace($search, $replace, $title);
}
$buttons = '<table><tr><td>'.$OUTPUT->update_module_button($this->modulerecord->id, $this->activityname).'</td>';
if ($this->user_allowed_editing()) {
$buttons .= '<td><form method="get" action="view.php"><div>'.
'<input type="hidden" name="id" value="'.$this->modulerecord->id.'" />'.
'<input type="hidden" name="edit" value="'.($this->user_is_editing()?'off':'on').'" />'.
'<input type="submit" value="'.get_string($this->user_is_editing()?'blockseditoff':'blocksediton').'" /></div></form></td>';
}
$buttons .= '</tr></table>';
if (!empty($morenavlinks) && is_array($morenavlinks)) {
foreach ($morenavlinks as $navitem) {
if (is_array($navitem) && array_key_exists('name', $navitem)) {
$link = null;
if (array_key_exists('link', $navitem)) {
$link = $navitem['link'];
}
$PAGE->navbar->add($navitem['name'], $link);
}
}
}
$PAGE->set_title($title);
$PAGE->set_heading($this->course->fullname);
$PAGE->set_button($buttons);
echo $OUTPUT->header();
}
}
}