From 9fe1fbcccbbabbc2ad03d7b0b89cd0312fe242fb Mon Sep 17 00:00:00 2001 From: Petr Skoda Date: Sun, 25 Jul 2010 11:12:16 +0000 Subject: [PATCH] MDL-21249 improved php docs and adding copyright blocks in mod/folder --- .../backup_folder_activity_task.class.php | 10 ++++---- .../backup/moodle2/backup_folder_stepslib.php | 14 +++++------ mod/folder/db/access.php | 9 +++++--- mod/folder/db/install.php | 9 +++++--- mod/folder/db/upgrade.php | 9 +++++--- mod/folder/db/upgradelib.php | 9 +++++--- mod/folder/edit.php | 7 +++--- mod/folder/edit_form.php | 7 +++--- mod/folder/index.php | 7 +++--- mod/folder/lang/en/folder.php | 7 +++--- mod/folder/lib.php | 7 +++--- mod/folder/locallib.php | 7 +++--- mod/folder/mod_form.php | 11 ++++----- mod/folder/module.js | 7 +++--- mod/folder/readme.txt | 2 -- mod/folder/renderer.php | 23 +++++++++++++++++++ mod/folder/settings.php | 7 +++--- mod/folder/version.php | 9 +++++--- mod/folder/view.php | 7 +++--- 19 files changed, 107 insertions(+), 61 deletions(-) diff --git a/mod/folder/backup/moodle2/backup_folder_activity_task.class.php b/mod/folder/backup/moodle2/backup_folder_activity_task.class.php index b9acd3cb859..004382e70cf 100644 --- a/mod/folder/backup/moodle2/backup_folder_activity_task.class.php +++ b/mod/folder/backup/moodle2/backup_folder_activity_task.class.php @@ -16,12 +16,14 @@ // along with Moodle. If not, see . /** - * @package moodlecore - * @subpackage backup-moodle2 - * @copyright 2010 onwards Eloy Lafuente (stronk7) {@link http://stronk7.com} - * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later + * @package mod + * @subpackage folder + * @copyright 2010 onwards Eloy Lafuente (stronk7) {@link http://stronk7.com} + * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later */ +defined('MOODLE_INTERNAL') || die(); + require_once($CFG->dirroot . '/mod/folder/backup/moodle2/backup_folder_stepslib.php'); // Because it exists (must) /** diff --git a/mod/folder/backup/moodle2/backup_folder_stepslib.php b/mod/folder/backup/moodle2/backup_folder_stepslib.php index d715b802057..1ee4f0c1564 100644 --- a/mod/folder/backup/moodle2/backup_folder_stepslib.php +++ b/mod/folder/backup/moodle2/backup_folder_stepslib.php @@ -16,15 +16,15 @@ // along with Moodle. If not, see . /** - * @package moodlecore - * @subpackage backup-moodle2 - * @copyright 2010 onwards Eloy Lafuente (stronk7) {@link http://stronk7.com} - * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later + * Define all the backup steps that will be used by the backup_folder_activity_task + * + * @package mod + * @subpackage folder + * @copyright 2010 onwards Eloy Lafuente (stronk7) {@link http://stronk7.com} + * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later */ -/** - * Define all the backup steps that will be used by the backup_folder_activity_task - */ +defined('MOODLE_INTERNAL') || die(); /** * Define the complete folder structure for backup, with file and id annotations diff --git a/mod/folder/db/access.php b/mod/folder/db/access.php index 560c1910304..557d1a56be9 100644 --- a/mod/folder/db/access.php +++ b/mod/folder/db/access.php @@ -18,11 +18,14 @@ /** * Capability definitions for the folder module. * - * @package mod-folder - * @copyright 2009 Petr Skoda (http://skodak.org) - * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later + * @package mod + * @subpackage folder + * @copyright 2009 Petr Skoda {@link http://skodak.org} + * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later */ +defined('MOODLE_INTERNAL') || die(); + $capabilities = array( /* TODO: review public portfolio API first! 'mod/folder:portfolioexport' => array( diff --git a/mod/folder/db/install.php b/mod/folder/db/install.php index b5c9c9e0be4..b9b67593740 100644 --- a/mod/folder/db/install.php +++ b/mod/folder/db/install.php @@ -23,11 +23,14 @@ * - lib.php/modulename_install() post installation hook * - partially defaults.php * - * @package mod-folder - * @copyright 2009 Petr Skoda (http://skodak.org) - * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later + * @package mod + * @subpackage folder + * @copyright 2009 Petr Skoda {@link http://skodak.org} + * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later */ +defined('MOODLE_INTERNAL') || die(); + function xmldb_folder_install() { global $CFG; diff --git a/mod/folder/db/upgrade.php b/mod/folder/db/upgrade.php index bebb7a68d62..3ea086f8035 100644 --- a/mod/folder/db/upgrade.php +++ b/mod/folder/db/upgrade.php @@ -38,11 +38,14 @@ * Please do not forget to use upgrade_set_timeout() * before any action that may take longer time to finish. * - * @package mod-folder - * @copyright 2009 Petr Skoda (http://skodak.org) - * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later + * @package mod + * @subpackage folder + * @copyright 2009 Petr Skoda {@link http://skodak.org} + * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later */ +defined('MOODLE_INTERNAL') || die(); + function xmldb_folder_upgrade($oldversion) { global $CFG, $DB; diff --git a/mod/folder/db/upgradelib.php b/mod/folder/db/upgradelib.php index 3092d8a2df6..7f532425fd8 100644 --- a/mod/folder/db/upgradelib.php +++ b/mod/folder/db/upgradelib.php @@ -18,11 +18,14 @@ /** * Folder module upgrade related helper functions * - * @package mod-folder - * @copyright 2009 Petr Skoda (http://skodak.org) - * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later + * @package mod + * @subpackage folder + * @copyright 2009 Petr Skoda {@link http://skodak.org} + * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later */ +defined('MOODLE_INTERNAL') || die(); + /** * Migrate folder module data from 1.9 resource_old table to new older table * @return void diff --git a/mod/folder/edit.php b/mod/folder/edit.php index e0cd67d0520..fc931994244 100644 --- a/mod/folder/edit.php +++ b/mod/folder/edit.php @@ -18,9 +18,10 @@ /** * Manage files in folder module instance * - * @package mod_folder - * @copyright 2010 Dongsheng Cai - * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later + * @package mod + * @subpackage folder + * @copyright 2010 Dongsheng Cai + * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later */ require('../../config.php'); diff --git a/mod/folder/edit_form.php b/mod/folder/edit_form.php index 9cf73119229..69f79ce8dc3 100644 --- a/mod/folder/edit_form.php +++ b/mod/folder/edit_form.php @@ -18,9 +18,10 @@ /** * A moodle form to manage folder files * - * @package mod_folder - * @copyright 2010 Dongsheng Cai - * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later + * @package mod + * @subpackage folder + * @copyright 2010 Dongsheng Cai + * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later */ defined('MOODLE_INTERNAL') || die(); diff --git a/mod/folder/index.php b/mod/folder/index.php index 9a54a501eb8..5a3597dd795 100644 --- a/mod/folder/index.php +++ b/mod/folder/index.php @@ -18,9 +18,10 @@ /** * List of file folders in course * - * @package mod-folder - * @copyright 2009 onwards Martin Dougiamas (http://dougiamas.com) - * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later + * @package mod + * @subpackage folder + * @copyright 2009 onwards Martin Dougiamas (http://dougiamas.com) + * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later */ require('../../config.php'); diff --git a/mod/folder/lang/en/folder.php b/mod/folder/lang/en/folder.php index f06f78a0990..2d77ba101ce 100644 --- a/mod/folder/lang/en/folder.php +++ b/mod/folder/lang/en/folder.php @@ -18,9 +18,10 @@ /** * Strings for component 'folder', language 'en', branch 'MOODLE_20_STABLE' * - * @package folder - * @copyright 1999 onwards Martin Dougiamas {@link http://moodle.com} - * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later + * @package mod + * @subpackage folder + * @copyright 1999 onwards Martin Dougiamas {@link http://moodle.com} + * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later */ $string['contentheader'] = 'Content'; diff --git a/mod/folder/lib.php b/mod/folder/lib.php index 6fe2861229b..0e7c3647276 100644 --- a/mod/folder/lib.php +++ b/mod/folder/lib.php @@ -18,9 +18,10 @@ /** * Mandatory public API of folder module * - * @package mod-folder - * @copyright 2009 Petr Skoda (http://skodak.org) - * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later + * @package mod + * @subpackage folder + * @copyright 2009 Petr Skoda {@link http://skodak.org} + * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later */ defined('MOODLE_INTERNAL') || die(); diff --git a/mod/folder/locallib.php b/mod/folder/locallib.php index aac77a10711..abf5eadb51c 100644 --- a/mod/folder/locallib.php +++ b/mod/folder/locallib.php @@ -18,9 +18,10 @@ /** * Private folder module utility functions * - * @package mod-folder - * @copyright 2009 Petr Skoda (http://skodak.org) - * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later + * @package mod + * @subpackage folder + * @copyright 2009 Petr Skoda {@link http://skodak.org} + * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later */ defined('MOODLE_INTERNAL') || die(); diff --git a/mod/folder/mod_form.php b/mod/folder/mod_form.php index dc2bd4f0e11..f0705a19ab7 100644 --- a/mod/folder/mod_form.php +++ b/mod/folder/mod_form.php @@ -18,14 +18,13 @@ /** * Folder configuration form * - * @package mod-folder - * @copyright 2009 Petr Skoda (http://skodak.org) - * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later + * @package mod + * @subpackage folder + * @copyright 2009 Petr Skoda {@link http://skodak.org} + * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later */ -if (!defined('MOODLE_INTERNAL')) { - die('Direct access to this script is forbidden.'); /// It must be included from a Moodle page -} +defined('MOODLE_INTERNAL') || die(); require_once ($CFG->dirroot.'/course/moodleform_mod.php'); diff --git a/mod/folder/module.js b/mod/folder/module.js index 2c9a94d1cf9..2b442440bf3 100644 --- a/mod/folder/module.js +++ b/mod/folder/module.js @@ -16,9 +16,10 @@ /** * Javascript helper function for Folder module * - * @package mod-folder - * @copyright 2009 Petr Skoda (http://skodak.org) - * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later + * @package mod + * @subpackage folder + * @copyright 2009 Petr Skoda {@link http://skodak.org} + * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later */ M.mod_folder = {}; diff --git a/mod/folder/readme.txt b/mod/folder/readme.txt index d3ca89d4d9a..0c3c321d372 100644 --- a/mod/folder/readme.txt +++ b/mod/folder/readme.txt @@ -26,7 +26,5 @@ This module is intended for distribution of large number of documents. TODO: * reimplement portfolio support (MDL-20070) - * implement subdirectory support in File picker (MDL-20071) * new backup/restore and old restore transformation (MDL-20072) - * improve folder view UI (MDL-20073) diff --git a/mod/folder/renderer.php b/mod/folder/renderer.php index 1e249a085cb..276765fb732 100644 --- a/mod/folder/renderer.php +++ b/mod/folder/renderer.php @@ -1,5 +1,28 @@ . + +/** + * Folder module renderer + * + * @package mod + * @subpackage folder + * @copyright 2009 Petr Skoda {@link http://skodak.org} + * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later + */ defined('MOODLE_INTERNAL') || die(); class mod_folder_renderer extends plugin_renderer_base { diff --git a/mod/folder/settings.php b/mod/folder/settings.php index 46839bf0c31..c0034bd8ec0 100644 --- a/mod/folder/settings.php +++ b/mod/folder/settings.php @@ -18,9 +18,10 @@ /** * Folder module admin settings and defaults * - * @package mod-folder - * @copyright 2009 Petr Skoda (http://skodak.org) - * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later + * @package mod + * @subpackage folder + * @copyright 2009 Petr Skoda {@link http://skodak.org} + * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later */ defined('MOODLE_INTERNAL') || die; diff --git a/mod/folder/version.php b/mod/folder/version.php index bc17f077173..bd1ac1fdc40 100644 --- a/mod/folder/version.php +++ b/mod/folder/version.php @@ -18,11 +18,14 @@ /** * Folder module version information * - * @package mod-folder - * @copyright 2009 Petr Skoda (http://skodak.org) - * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later + * @package mod + * @subpackage folder + * @copyright 2009 Petr Skoda {@link http://skodak.org} + * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later */ +defined('MOODLE_INTERNAL') || die(); + $module->version = 2010072200; $module->requires = 2009073101; // Requires this Moodle version $module->cron = 0; diff --git a/mod/folder/view.php b/mod/folder/view.php index 117ba31d1b3..7984f60dc6c 100644 --- a/mod/folder/view.php +++ b/mod/folder/view.php @@ -18,9 +18,10 @@ /** * Folder module main user interface * - * @package mod-folder - * @copyright 2009 Petr Skoda (http://skodak.org) - * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later + * @package mod + * @subpackage folder + * @copyright 2009 Petr Skoda {@link http://skodak.org} + * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later */ require('../../config.php');