Alinmang proyekto na pinagtutulungtulungan ng maraming tao ay nangangailangan ng pagiging consistent at stable para manatiling matatag.
Ibinibigay ang mga alituntuning ito para maging pamantayan ng lahat ng koda ng Moodle. May ilang matatandang koda na hindi aabot sa pamantayang ito, pero inaasahan natin na maaayos din ang mga ito sa hinaharap. Ang lahat naman ng bagong koda ay kailangang mahigpit na sumunod sa mga istandard na ito hangga't maaari.
Kung kailangan mong magbago ng isang sakong tulong:
Alam kong medyo nakakainis na magbago ng estilo lalo pa't kung sanay ka na sa sarili mong estilo, pero isipin mo na lang ang pagkainis naman ng ibang tao na naghihirap sa pagbasa ng mga koda ng Moodle na iba-iba ang estilo. Mayroon siyempreng kagalingan at kahinaan ang anumang estilo na ginagamit ng mga tao, pero ang kasalukuyang estilo ay hindi na pinagtatalunan kundi basta ito ang estilo, kaya pakisunod naman.
TAMA: $quiz
TAMA: $errorstring
TAMA: $assignments (para sa isang array ng mga object)
TAMA: $i (pero gamitin lamang sa maiigsing loop)
MALI: $Quiz
MALI: $aReallyLongVariableNameWithoutAGoodReason
MALI: $error_string
define("FORUM_MODE_FLATOLDEST", 1);
function forum_set_display_mode($mode=0)
{
global $USER,
$CFG;
if ($mode)
{
$USER->mode
= $mode;
} else if (empty($USER->mode))
{
$USER->mode
= $CFG->forum_displaymode;
}
}
if ($quiz->attempts)
{
if ($numattempts >
$quiz->attempts)
{
error($strtoomanyattempts,
"view.php?id=$cm->id");
}
}
$var = 'some text without any
variables';
$var = "with special characters like a new line \n";
$var = 'a very, very long string with a '.$single.' variable in it';
$var = "some $text with $many variables $within it";
/**
* The description should be first, with asterisks laid out exactly
* like this example. If you want to refer to a another function,
* do it like this: {@link clean_param()}. Then, add descriptions
* for each parameter as follows.
*
* @param int $postid The PHP type is followed by the variable name
* @param array $scale The PHP type is followed by the variable name
* @param array $ratings The PHP type is followed by the variable name
* @return mixed
*/
function forum_get_ratings_mean($postid,
$scale, $ratings=NULL)
{
if (!$ratings)
{
$ratings
= array(); //
Initialize the empty array
if ($rates
= get_records("forum_ratings",
"post", $postid))
{
//
Process each rating in turn
foreach
($rates as $rate)
{
....etc
foreach ($objects
as $key =>
$thing) {
process($thing);
}
if ($x ==
$y)
{
$a
= $b;
} else if ($x ==
$z) {
$a
= $c;
} else {
$a
= $d;
}
$a = array()
o $obj = new stdClass();
.optional_variable()
na function. Sa halip ay gamitin ang optional_param()
na function. Piliin ang wastong halaga na PARAM_XXXX para sa uri ng datos na inaasahan mo. Para matsek at maiset ang isang opsiyonal na halaga para sa isang variable, gamitin ang function na set_default()
.require_variable()
. Sa halip ay gamitin ang function na required_param()
. Piliin ang wastong halaga na
PARAM_XXXX para sa uri ng datos na inaasahan mo.data_submitted()
. Kailangan munang linisin ang datos bago gamitin$_GET
, $_POST
o $_REQUEST
. Gamitin ang angkop na required_param()
o optional_param()
na angkop sa pangangailangan mo.if (isset($_GET['something']))
. Gamitin ang e.g., $something = optional_param( 'something',-1,PARAM_INT )
at pagkatapos ay gawin ang angkop na test para matiyak kung nasa inaasahang range ng value ito e.g., if ($something>=0) {...
.required_param()
, optional_param()
mo at iba pang pag-initialise ng baryabol sa simula ng bawat sako, para madali matagpuan ang mga ito.<input type="hidden" name="sesskey" value="<?php echo sesskey(); ?>" />
.
Kapag iprinoseso mo ang form tsekin sa pamamagitan ng if (!confirm_sesskey()) {error('Bad Session Key');}
.clean_filename()
, kung hindi pa ito nagagawa sa pamamagitan ng angkop na paggamit ng required_param()
o optional_param()
addslashes()
bago ito isulat pabalik sa datosan. Maaaring tirahin ang isang buong object ng datos sa isang iglap sa pamamagitan ng addslashes_object()
.POST
data (mula sa isang fom na may method="POST"
) sa halip na GET
data (ab, datos mula sa URL line).$_SERVER
hangga't maiiwasan. May mga suliranin ito sa potability.
clean_param()
sa pamamagitan ng angkop na PARAM_XXXX para sa uri ng datos.Version: $Id$