L-electron-Rare/moodle
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

MDL-15402: add a repository type functionality in the administration: enable/disable course and user repository setting

Browse Source
This commit is contained in:
jerome
2008-10-09 03:02:26 +00:00
parent d4fda077a2
commit f48fb4d692
6 changed files with 125 additions and 45 deletions
Download Patch File Download Diff File Expand all files Collapse all files
admin/repository.php
+17 -1
View File
@@ -72,6 +72,21 @@ if (!empty($edit) || !empty($new)) {
foreach($configs as $config) {
$settings[$config] = $fromform->$config;
}
$instanceoptionnames = repository_static_function($edit, 'get_instance_option_names');
if (!empty($instanceoptionnames)) {
if (array_key_exists('enablecourseinstances', $fromform)) {
$settings['enablecourseinstances'] = $fromform->enablecourseinstances;
}
else {
$settings['enablecourseinstances'] = 0;
}
if (array_key_exists('enableuserinstances', $fromform)) {
$settings['enableuserinstances'] = $fromform->enableuserinstances;
}
else {
$settings['enableuserinstances'] = 0;
}
}
$success = $repositorytype->update_options($settings);
} else {
$type = new repository_type($plugin,(array)$fromform);
@@ -94,7 +109,8 @@ if (!empty($edit) || !empty($new)) {
$displaysettingform = true;
if ($edit) {
$typeoptionnames = repository_static_function($edit, 'get_type_option_names');
if (empty($typeoptionnames)) {
$instanceoptionnames = repository_static_function($edit, 'get_instance_option_names');
if (empty($typeoptionnames) && empty($instanceoptionnames)) {
$displaysettingform = false;
}
}
blocks/admin/block_admin.php
+3 -1
View File
@@ -187,7 +187,9 @@ class block_admin extends block_list {
}
/// Repository Instances
if ($course->id !== SITEID && has_capability('moodle/course:update', $context)) {
require_once($CFG->dirroot.'/repository/lib.php');
$editabletypes = repository_get_editable_types($context);
if ($course->id !== SITEID && has_capability('moodle/course:update', $context) && !empty($editabletypes)) {
$this->content->items[]='<a href="'.$CFG->wwwroot.'/repository/manage_instances.php?contextid='.$context->id.'">'.get_string('repositories').'</a>';
$this->content->icons[]='<img src="'.$CFG->pixpath.'/i/repository.png" alt=""/>';
}
lang/en_utf8/repository.php
+2
View File
@@ -33,6 +33,8 @@ $string['download'] = 'Download';
$string['downloadsucc'] = 'The file has been downloaded successfully';
$string['editrepositoryinstance'] = 'Edit repository instance';
$string['emptytype'] = 'Cannot create repository type: type name is empty';
$string['enablecourseinstances'] = 'Enable course repositories';
$string['enableuserinstances'] = 'Enable user repositories';
$string['error'] = 'An unknown error occurred!';
$string['existingrepository'] = 'This repository already exists';
$string['filename'] = 'Filename';
repository/lib.php
+99 -40
View File
@@ -95,6 +95,29 @@ class repository_type {
*/
private $_sortorder;
/**
* Return if the instance is visible in a context
* TODO: check if the context visibility has been overwritten by the plugin creator
* (need to create special functions to be overvwritten in repository class)
* @param objet $contextlevel - context level
* @return boolean
*/
public function get_contextvisibility($contextlevel) {
if ($contextlevel == CONTEXT_COURSE) {
return $this->_options['enablecourseinstances'];
}
if ($contextlevel == CONTEXT_USER) {
return $this->_options['enableuserinstances'];
}
//the context is SITE
return true;
}
/**
* repository_type constructor
* @global <type> $CFG
@@ -123,6 +146,16 @@ class repository_type {
}
}
}
//retrieve visibility from option
if (array_key_exists('enablecourseinstances',$typeoptions)) {
$this->_options['enablecourseinstances'] = $typeoptions['enablecourseinstances'];
}
if (array_key_exists('enableuserinstances',$typeoptions)) {
$this->_options['enableuserinstances'] = $typeoptions['enableuserinstances'];
}
}
/**
@@ -580,6 +613,25 @@ abstract class repository {
}
}
/**
* Return is the instance is visible
* (is the type visible ? is the context enable ?)
* @return boolean
*/
public function is_visible() {
$type = repository_get_type_by_id($this->typeid);
$instanceoptions = repository_static_function($type->get_typename(), 'get_instance_option_names');
if ($type->get_visible()) {
//if the instance is unique so it's visible, otherwise check if the instance has a enabled context
if (empty($instanceoptions) || $type->get_contextvisibility($this->context->contextlevel)) {
return true;
}
}
return false;
}
/**
* Return the name of this instance, can be overridden.
* @global <type> $DB
@@ -981,16 +1033,24 @@ function repository_check_context($ctx_id) {
/**
* Return all types that you a user can create/edit and which are also visible
* Note: Mostly used in order to know if at least one editable type has been set
* @param object $context the context for which we want the editable types
* @return array types
*/
function repository_get_editable_types() {
function repository_get_editable_types($context = null) {
if (empty($context)) {
$context = get_system_context();
}
$types= repository_get_types(true);
$editabletypes = array();
foreach ($types as $type) {
$instanceoptionnames = repository_static_function($type->get_typename(), 'get_instance_option_names');
if (!empty($instanceoptionnames)) {
$editabletypes[]=$type;
}
if ($type->get_contextvisibility($context->contextlevel)) {
$editabletypes[]=$type;
}
}
}
return $editabletypes;
}
@@ -1054,8 +1114,12 @@ function repository_get_instances($contexts=array(), $userid = null, $onlyvisibl
$options['name'] = $repo->name;
$options['type'] = $repo->repositorytype;
$options['typeid'] = $repo->typeid;
$classname = 'repository_' . $repo->repositorytype;
$ret[] = new $classname($repo->id, $repo->contextid, $options, $repo->readonly);
$classname = 'repository_' . $repo->repositorytype;//
$repository = new $classname($repo->id, $repo->contextid, $options, $repo->readonly);
if (!$onlyvisible || $repository->is_visible()) {
$ret[] = $repository;
}
}
return $ret;
}
@@ -1247,18 +1311,17 @@ final class repository_instance_form extends moodleform {
$mform->addElement('text', 'name', get_string('name'), 'maxlength="100" size="30"');
$mform->addRule('name', $strrequired, 'required', null, 'client');
if (!$this->instance->readonly) {
//add fields
if (!$this->instance) {
$result = repository_static_function($this->plugin, 'instance_config_form', $mform);
} else {
$result = $this->instance->instance_config_form($mform);
}
// and set the data if we have some.
if ($this->instance) {
$data = array();
$data['name'] = $this->instance->name;
//add fields
if (!$this->instance) {
$result = repository_static_function($this->plugin, 'instance_config_form', $mform);
}
else {
$data = array();
$data['name'] = $this->instance->name;
if (!$this->instance->readonly) {
$result = $this->instance->instance_config_form($mform);
// and set the data if we have some.
foreach ($this->instance->get_instance_option_names() as $config) {
if (!empty($this->instance->$config)) {
$data[$config] = $this->instance->$config;
@@ -1266,15 +1329,8 @@ final class repository_instance_form extends moodleform {
$data[$config] = '';
}
}
$this->set_data($data);
}
}
else {
if ($this->instance) {
$data = array();
$data['name'] = $this->instance->name;
$this->set_data($data);
}
$this->set_data($data);
}
$this->add_action_buttons(true, get_string('save','repository'));
@@ -1294,15 +1350,6 @@ final class repository_instance_form extends moodleform {
$errors = array('name' => get_string('err_uniquename', 'repository'));
}
$pluginerrors = array();
if ($this->instance) {
//$pluginerrors = $this->instance->admin_config_validation($data);
} else {
//$pluginerrors = repository_static_function($this->plugin, 'admin_config_validation', $data);
}
if (is_array($pluginerrors)) {
$errors = array_merge($errors, $pluginerrors);
}
return $errors;
}
}
@@ -1341,10 +1388,22 @@ final class repository_type_form extends moodleform {
$result = call_user_func(array($classname,'type_config_form'),$mform);
}
// and set the data if we have some.
//add "enable course/user instances" checkboxes if multiple instances are allowed
$instanceoptionnames = repository_static_function($this->plugin, 'get_instance_option_names');
if (!empty($instanceoptionnames)){
$mform->addElement('checkbox', 'enablecourseinstances', get_string('enablecourseinstances', 'repository'));
$mform->addElement('checkbox', 'enableuserinstances', get_string('enableuserinstances', 'repository'));
}
// set the data if we have some.
if ($this->instance) {
$data = array();
$option_names = call_user_func(array($classname,'get_type_option_names'));
if (!empty($instanceoptionnames)){
$option_names[] = 'enablecourseinstances';
$option_names[] = 'enableuserinstances';
}
$instanceoptions = $this->instance->get_options();
foreach ($option_names as $config) {
if (!empty($instanceoptions[$config])) {
@@ -1355,6 +1414,7 @@ final class repository_type_form extends moodleform {
}
$this->set_data($data);
}
$this->add_action_buttons(true, get_string('save','repository'));
}
}
@@ -1386,7 +1446,6 @@ function repository_display_instances_list($context, $typename = null) {
$settingsstr = get_string('settings');
$deletestr = get_string('delete');
$updown = get_string('updown', 'repository');
$plugins = get_list_of_plugins('repository');
//retrieve list of instances. In administration context we want to display all
//instances of a type, even if this type is not visible. In course/user context we
//want to display only visible instances, but for every type types. The repository_get_instances()
@@ -1433,13 +1492,13 @@ function repository_display_instances_list($context, $typename = null) {
$instancehtml .= '<h3>';
$instancehtml .= get_string('createrepository', 'repository');
$instancehtml .= '</h3><ul>';
foreach ($plugins as $p) {
$type = repository_get_type_by_typename($p);
$types = repository_get_editable_types($context);
foreach ($types as $type) {
if (!empty($type) && $type->get_visible()) {
$instanceoptionnames = repository_static_function($p, 'get_instance_option_names');
$instanceoptionnames = repository_static_function($type->get_typename(), 'get_instance_option_names');
if (!empty($instanceoptionnames)) {
$instancehtml .= '<li><a href="'.$baseurl.'&amp;new='.$p.'">'.get_string('create', 'repository')
.' "'.get_string('repositoryname', 'repository_'.$p).'" '
$instancehtml .= '<li><a href="'.$baseurl.'&amp;new='.$type->get_typename().'">'.get_string('create', 'repository')
.' "'.get_string('repositoryname', 'repository_'.$type->get_typename()).'" '
.get_string('instance', 'repository').'</a></li>';
$addable++;
}
repository/manage_instances.php
+3 -2
View File
@@ -46,13 +46,14 @@
} else {
// throw an error here
print_error('wrongcontextid');
exit;
}
$baseurl = $CFG->wwwroot . '/repository/manage_instances.php?contextid=' . $contextid . '&amp;sesskey='. sesskey();
/// Security: we cannot perform any action if the type is not visible
/// Security: we cannot perform any action if the type is not visible or if the context has been disabled
if (!empty($new)){
$type = repository_get_type_by_typename($new);
} else if (!empty($edit)){
@@ -62,7 +63,7 @@
$instance = repository_get_instance($delete);
$type = repository_get_type_by_id($instance->typeid);
}
if (isset($type) && !$type->get_visible()) {
if (isset($type) && ( !$type->get_visible() || (!$type->get_contextvisibility($context->contextlevel)) ) ) {
print_error('typenotvisible', 'repository', $baseurl);
}
user/tabs.php
+1 -1
View File
@@ -259,7 +259,7 @@
if (!empty($user) and $user->id == $USER->id) {
require_once($CFG->dirroot . '/repository/lib.php');
$usercontext = get_context_instance(CONTEXT_USER,$user->id);
$editabletypes = repository_get_editable_types();
$editabletypes = repository_get_editable_types($usercontext);
if (!empty($usercontext) && $usercontext->contextlevel == CONTEXT_USER && !empty($editabletypes)) {
$toprow[] = new tabobject('repositories', $CFG->wwwroot .'/repository/manage_instances.php?contextid='.$usercontext->id, get_string('repositories', 'repository'));
}