moodle/moodle
3
0
Fork 0
mirror of https://github.com/moodle/moodle.git synced 2025-08-06 01:16:44 +02:00
Code Issues Projects Releases Packages Wiki Activity Actions

Made a small start on the coding guidelines

Browse source
This commit is contained in:
moodler 2003-07-04 13:24:10 +00:00
parent b1a09588e4
commit 163c84ef63
1 changed files with 164 additions and 0 deletions
Download patch file Download diff file Expand all files Collapse all files

164
lang/en/docs/coding.html Executable file
View file

@ -0,0 +1,164 @@
<html>
<head>
<title>Moodle Docs: Coding Guidelines</title>
<link rel="stylesheet" href="../theme/standard/styles.php" type="TEXT/CSS">
<meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1">
<style type="text/css">
<!--
li {
padding-top: 10px;
}
.question {
font-size: medium;
font-weight: bold;
font-family: "Trebuchet MS", Verdana, Arial, Helvetica, sans-serif;
border: 1px dotted;
padding: 10px;
background-color: #EEEEEE;
}
.answer {
font-family: "Trebuchet MS", Verdana, Arial, Helvetica, sans-serif;
font-size: medium;
border: none;
padding-left: 40px;
}
-->
</style>
<style type="text/css">
<!--
.normaltext {
font-family: "Trebuchet MS", Verdana, Arial, Helvetica, sans-serif;
font-size: medium;
border: none;
padding-left: 10px;
}
.answercode {
font-family: "Courier New", Courier, mono;
font-size: small;
border: none;
padding-left: 60px;
}
.questionlink {
font-family: "Trebuchet MS", Verdana, Arial, Helvetica, sans-serif;
font-size: medium;
border: none;
padding-left: 40px;
}
-->
</style>
<style type="text/css">
<!--
.examplecode {
font-family: "Courier New", Courier, mono;
font-size: small;
border: thin dashed #999999;
background-color: #FBFBFB;
margin: auto;
padding: 30px;
height: auto;
width: auto;
}
-->
</style>
</head>
<body bgcolor="#FFFFFF">
<h2>Moodle Coding Guidelines</h2>
<h2 class="normaltext">General Rules</h2>
<ol class="normaltext">
<li>All files should use the .php extension.</li>
<li>All copyright notices should be retained. You can add your own if necessary.</li>
<li>Each file should include the main config.php file.</li>
<li>Each file should check that the user is authenticated correctly, using require_login()
and isadmin(), isteacher(), iscreator() or isstudent().</li>
<li>All access to databases should use the functions in lib/datalib.php whenever
possible - this allows compatibility across a wide range of databases. You
should find that almost anything is possible using these functions. Any other
SQL statements should be: cross-platform; restricted to specific functions
within your code (usally a lib.php file); and clearly marked.</li>
<li>All strings should be translatable - create new texts in the &quot;lang/en&quot;
files and call them using get_string() or print_string().</li>
<li>All help files should be translatable - create new texts in the &quot;en/help&quot;
directory and call them using helpbutton().</li>
</ol>
<p>&nbsp;</p>
<h2 class="normaltext">Coding Style</h2>
<ol class="normaltext">
<li>Don't use tabs at all. Use consistent indenting with 4 spaces.</li>
<li>Braces must always be used for blocks of code (even if there is only one
line). Moodle uses this style:
<p class="examplecode"> </font><font color="#006600">if (</font><font color="#0000CC">$quiz</font><font color="#006600">-&gt;</font><font color="#0000CC">attempts</font><font color="#006600">)
{<br />
&nbsp;&nbsp;&nbsp;&nbsp;if (</font><font color="#0000CC">$numattempts </font><font color="#006600">&gt;
</font><font color="#0000CC">$quiz</font><font color="#006600">-&gt;</font><font color="#0000CC">attempts</font><font color="#006600">)
{<br />
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</font><font color="#0000CC">error</font><font color="#006600">(</font><font color="#CC0000">$strtoomanyattempts</font><font color="#006600">,
</font><font color="#CC0000">"view.php?id=$cm</font><font color="#006600">-&gt;</font><font color="#CC0000">id"</font><font color="#006600">);<br />
&nbsp;&nbsp;&nbsp;&nbsp;}<br />
}</font></p>
</li>
<li>more to come here .... this document is not nearly finished yet!</li>
</ol>
<p align="center" class="normaltext">&nbsp;</p>
<hr>
<p align="CENTER"><font size="1"><a href="." target="_top">Moodle Documentation</a></font></p>
<p align="CENTER"><font size="1">Version: $Id: faq.html,v 1.6 2003/03/30 13:54:28
moodler Exp $</font></p>
</body>
</html>