MDL-18111 improving file api comments and docs, fixing license header

This commit is contained in:
skodak 2009-05-21 09:44:26 +00:00
parent 4cd9dfda7b
commit 8265a51db6

View file

@ -1,13 +1,35 @@
<?php // $Id$
// This script fetches files from the dataroot directory
<?php
// This file is part of Moodle - http://moodle.org/
//
// You should use the get_file_url() function, available in lib/filelib.php, to link to file.php.
// This ensures proper formatting and offers useful options.
// 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.
//
// Syntax: file.php/courseid/dir/dir/dir/filename.ext
// file.php/courseid/dir/dir/dir/filename.ext?forcedownload=1 (download instead of inline)
// file.php/courseid/dir (returns index.html from dir)
// Workaround: file.php?file=/courseid/dir/dir/dir/filename.ext
// 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/>.
/**
* This script fetches legacy files from the course files in dataroot directory
*
* You should use the get_file_url() function, available in lib/filelib.php, to link to file.php.
* This ensures proper formatting and offers useful options.
* Syntax: file.php/courseid/dir/dir/dir/filename.ext
* file.php/courseid/dir/dir/dir/filename.ext?forcedownload=1 (download instead of inline)
* file.php/courseid/dir (returns index.html from dir)
* Workaround: file.php?file=/courseid/dir/dir/dir/filename.ext
*
* @package moodlecore
* @subpackage file
* @copyright 1999 onwards Martin Dougiamas (http://dougiamas.com)
* @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
*/
require_once('config.php');
require_once('lib/filelib.php');