BasicPHPFileTemplates

From Mahara Wiki
Revision as of 10:54, 13 May 2011 by WikiSysop (talk | contribs)

Jump to: navigation, search

These are the templates for all new PHP files. There is a different template depending on whether you file is able to be publicly hittable or not. The templates are available in /examples in version control, and should be considered the most up to date versions of these files.

This project uses PHPDoc for API documentation. This project is also licensed under the GPL, which causes some header bloat (it is a requirement of licensing your program under the GPL, see http://www.gnu.org/copyleft/gpl.html ).

Template for files you expect to be hit by visitors

.
  *
  * @package    mahara
  * @subpackage core
  * @author     Firstname Lastname
  * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL
  * @copyright  (C) 2010 Firstname Lastname
  *
  */

 define('INTERNAL', 1);
 require('init.php');

 // Your code here :)

Template for files you do NOT want to be hit by visitors

.
  *
  * @package    mahara
  * @subpackage core or plugintype/pluginname
  * @author     Firstname Lastname
  * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL
  * @copyright  (C) 2010 Firstname Lastname
  *
  */

 defined('INTERNAL') || die();
 require('init.php');

 // Your code here :)

Notes:

  • Omit the closing php tag "?>"
  • Catalyst employees should assign copyright to "Catalyst IT Ltd File:Http.pnghttp://catalyst.net.nz", if they are working on the project in company time.