mirror of
https://github.com/moodle/moodle.git
synced 2025-02-25 12:33:18 +01:00
193 lines
17 KiB
HTML
193 lines
17 KiB
HTML
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
|
|
"http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
|
|
<html xmlns="http://www.w3.org/1999/xhtml">
|
|
<head>
|
|
<title>Doiciméid Moodle: Treoirlínte Códúcháin</title>
|
|
<link rel="stylesheet" href="docstyles.css" type="TEXT/CSS" />
|
|
<meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1" />
|
|
</head>
|
|
<body>
|
|
|
|
<h1>Treoirlínte Códúcháin Moodle</h1>
|
|
<p class="normaltext">Tá comhsheasmhacht agus forastacht riachtanach le go mbeadh aon thionscadal
|
|
comhoibritheach láidir.</p>
|
|
<p class="normaltext">Cuireann na treoirlínte seo sprioc ar fáil d'úsáideoirí cóid Moodle.
|
|
Is fíor go bhfuil cuid den chód atá ann faoi láthair neamhimleor i roinnt
|
|
réimsí, ach deiseofar é ar fad ar deireadh. Ní mór do gach códú nua
|
|
cloí leis na caighdeáin seo chomh fada agus is féidir é.</p>
|
|
<h2>Rialacha Ginearálta</h2>
|
|
<ol class="normaltext">
|
|
<li class="spaced">Ba cheart do gach comhad cóid leas a bhaint as an iarmhír .php.</li>
|
|
<li class="spaced">Ba cheart do gach comhad teimpléid leas a bhaint as an iarmhír .html.</li>
|
|
<li class="spaced">Ba cheart do gach téacschomhad leas a bhaint as formáid téacs de stíl Unix (tá an rogha
|
|
seo ar fáil le formhór eagarthóirí téacs).</li>
|
|
<li class="spaced">Ní mór do gach clib php a bheith 'iomlán' ar nós <font color="#339900"><?php
|
|
?></font> ... seachas clibeanna 'gearra' ar nós <font color="#339900"><? ?></font>.
|
|
</li>
|
|
<li class="spaced">Ní mór gach fógra cóipchirt a choinneáil. Féadfaidh tú do chuid féin
|
|
a chur leo más gá.</li>
|
|
<li class="spaced">Ba cheart do gach comhad an príomhchomhad config.php a bheith mar chuid de.</li>
|
|
<li class="spaced">Ba cheart do gach comhad a sheiceáil go fíordheimhnítear an t-úsáideoir i gceart,
|
|
trí leas a bhaint as require_login() agus isadmin(), isteacher(), iscreator() nó isstudent().</li>
|
|
<li class="spaced">Ba cheart do gach rochtain ar bhunachair sonraí leas a bhaint as na feidhmeanna atá i lib/datalib.php
|
|
nuair is féidir - ceadaíonn sé seo comhoiriúnach thar réimse leathan bunachar sonraí.
|
|
Ba cheart go bhfeicfeá gur féidir beagnach gach rud a dhéanamh leis na feidhmeanna seo. Má tá ort cód SQL a scríobh cinntigh: go bhfuil sé trasardáin; srianta go feidhmeanna sonrúla
|
|
laistigh de do chód (de ghnáth comhad lib.php); agus go bhfuil sé marcáilte go soiléir.</li>
|
|
<li class="spaced">Ná cruthaigh agus ná húsáid athróga domhanda seachas cinn caighdeánacha
|
|
$CFG, $SESSION, $THEME agus $USER.</li>
|
|
<li class="spaced">Ba cheart gach athróg a thúsú, nó ar a laghad tástáil gur ann dóibh
|
|
trí leas a bhaint as isset() nó empty() sula n-úsáidtear iad.</li>
|
|
<li class="spaced">Ba cheart do gach teaghrán a bheith inaistrithe - cruthaigh téacsanna nua sna comhaid
|
|
"lang/en" agus glao orthu trí leas a bhaint as get_string() nó print_string().</li>
|
|
<li class="spaced">Ba cheart do gachcomhad cabhrach a bheith inaistrithe - cruthaigh téacsanna nua sa chomhadlann
|
|
"en/help" agus glao orthu trí leas a bhaint as helpbutton().</li>
|
|
<li class="spaced">Cuirtear magic_quotes le sonraí a thagann isteach ón mbrabhsálaí (seolta trí GET nó POST) go huathoibríoch
|
|
(aineoinn na socruithe PHP) le gur féidir leat é a chur díreach isteach
|
|
sa bhunachar sonraí go sábháilte. Ní mór gach amhshonra eile (ó chomhaid, nó ó bhunachair sonraí)
|
|
a éalú le <font color="#339900">addslashes()</font> sula gcuirtear isteach sa bhunachar sonraí é.</li>
|
|
</ol>
|
|
<p> </p>
|
|
<h2>Stíl Códúcháin</h2>
|
|
<p class="normaltext">Tá a fhios agam go bhfuil sé beagán achrannach do stíl a athrú
|
|
má tá cleachtadh agat ar rud ar leith, ach cuir i gcomparáid an t-achrann sin leis an achrann a bheadh
|
|
i gceist dá mbeadh daoine ag iarraidh bun nó barr a bhaint as cód Moodle dá mbeadh meascán stíleanna ann.
|
|
Is léir go bhfuil neart buntáistí nó míbhuntáistí le stíleanna a úsáideann daoine éagsúla,
|
|
ach tá an stíl reatha <strong>ann</strong>, agus iarraimid ort cloí leis. </p>
|
|
<ol class="normaltext">
|
|
<li class="spaced"><strong>Eangú:</strong> ba cheart 4 spás a bheith ann go seasmhach.
|
|
Ná bain leas as tábanna AR CHOR AR BITH. </li>
|
|
<li class="spaced"><strong>Ainmneacha athróige:</strong> ba cheart gur focail Bhéarla iad atá éasca le léamh,
|
|
agus brí leo. Má tá sé iomlán riachtanach go mbeadh níos mó ná focal amháin agat
|
|
rith le chéile iad, ach coinnigh chomh gairid agus is féidir iad. Úsáid
|
|
ainmneacha iolra le haghaidh eagair d'oibiachtaí.
|
|
<p class="examplecode"><font color="#006600">GO MAITH: $quiz<br />
|
|
GO MAITH: $errorstring<br />
|
|
GO MAITH: $assignments (le haghaidh eagar d'oibiachtaí)<br />
|
|
GO MAITH: $i (ach i lúba beaga amháin)<br />
|
|
<br />
|
|
GO DONA: $Quiz <br />
|
|
GO DONA: $aReallyLongVariableNameWithoutAGoodReason<br />
|
|
GO DONA: $error_string</font></p>
|
|
</li>
|
|
<li class="spaced"><strong>Tairisigh:</strong> ba cheart iad a bheith i gceannlitreacha i gcónaí,
|
|
agus tosú i gcónaí le hainm an mhodúil. Ba cheart na focail a roinnt
|
|
le fostríoc.
|
|
<p class="examplecode"><font color="#006600">define("FORUM_MODE_FLATOLDEST",
|
|
1);</font></p>
|
|
</li>
|
|
<li class="spaced"><strong>Ainmneacha feidhme:</strong> ba cheart gur focail simplí Béarla a bheadh iontu,
|
|
agus go dtosóidis le hainm an mhodúil le coinbhleacht a sheachaint idir na modúil.
|
|
Ba cheart focail a roinnt le fostríocanna. Ba cheart réamhshocrú ciallmhar a bheith ag paraiméadair i gcónaí
|
|
más féidir. Tabhair faoi deara nach bhfuil spás ar bith idir ainm na feidhme agus na
|
|
(lúibíní) a leanann é. <br />
|
|
<p class="examplecode"> <font color="#007700">function </font><font color="#0000BB">forum_set_display_mode</font><font color="#007700">(</font><font color="#0000BB">$mode</font><font color="#007700">=</font><font color="#0000BB">0</font><font color="#007700">)
|
|
{<br />
|
|
global </font><font color="#0000BB">$USER</font><font color="#007700">,
|
|
</font><font color="#0000BB">$CFG</font><font color="#007700">;<br />
|
|
<br />
|
|
if (</font><font color="#0000BB">$mode</font><font color="#007700">)
|
|
{<br />
|
|
</font><font color="#0000BB">$USER</font><font color="#007700">-></font><font color="#0000BB">mode
|
|
</font><font color="#007700">= </font><font color="#0000BB">$mode</font><font color="#007700">;<br />
|
|
} else if (empty(</font><font color="#0000BB">$USER</font><font color="#007700">-></font><font color="#0000BB">mode</font><font color="#007700">))
|
|
{<br />
|
|
</font><font color="#0000BB">$USER</font><font color="#007700">-></font><font color="#0000BB">mode
|
|
</font><font color="#007700">= </font><font color="#0000BB">$CFG</font><font color="#007700">-></font><font color="#0000BB">forum_displaymode</font><font color="#007700">;<br />
|
|
}<br />
|
|
}</font></p>
|
|
</li>
|
|
<li class="spaced"><strong>Blocanna:</strong> ní mór iad a chur idir lúibíní 'catacha'
|
|
(fiú muna bhfuil ann ach líne amháin). Úsáideann Moodle an stíl seo:
|
|
<p class="examplecode"> <font color="#006600">if (</font><font color="#0000CC">$quiz</font><font color="#006600">-></font><font color="#0000CC">attempts</font><font color="#006600">)
|
|
{<br />
|
|
if (</font><font color="#0000CC">$numattempts </font><font color="#006600">>
|
|
</font><font color="#0000CC">$quiz</font><font color="#006600">-></font><font color="#0000CC">attempts</font><font color="#006600">)
|
|
{<br />
|
|
</font><font color="#0000CC">error</font><font color="#006600">(</font><font color="#0000BB">$strtoomanyattempts</font><font color="#006600">,
|
|
</font><font color="#CC0000">"view.php?id=$cm</font><font color="#006600">-></font><font color="#CC0000">id"</font><font color="#006600">);<br />
|
|
}<br />
|
|
}</font></p>
|
|
</li>
|
|
<li class="spaced"><strong>Teaghráin:</strong> ba cheart iad a shainmhíniú laistigh de uaschamóga singil
|
|
nuair is féidir é, ar mhaithe le luas.<br />
|
|
<p class="examplecode"> <font color="#006600">$var = 'some text without any
|
|
variables';<br />
|
|
$var = "with special characters like a new line \n";<br />
|
|
$var = 'a very, very long string with a '.$single.' variable in it';<br />
|
|
$var = "some $text with $many variables $within it"; </font></p>
|
|
</li>
|
|
<li class="spaced"><strong>Nótaí tráchta:</strong> ba cheart dóibh dhá slais nó trí a úsáid
|
|
agus teacht le chéile go néata leis an gcód.
|
|
<p class="examplecode"><font color="#006600">function </font><font color="#0000BB">forum_get_ratings_mean</font><font color="#007700">(</font><font color="#0000BB">$postid</font><font color="#007700">,
|
|
</font><font color="#0000BB">$scale</font><font color="#007700">, </font><font color="#0000BB">$ratings</font><font color="#007700">=</font><font color="#0000BB">NULL</font><font color="#007700">)
|
|
{<br />
|
|
</font><font color="#FF8000">/// Return the mean rating of a post given
|
|
to the current user by others.<br />
|
|
/// Scale is an array of possible ratings in the scale<br />
|
|
/// Ratings is an optional simple array of actual ratings (just integers)<br />
|
|
<br />
|
|
</font><font color="#007700">if (!</font><font color="#0000BB">$ratings</font><font color="#007700">)
|
|
{<br />
|
|
</font><font color="#0000BB">$ratings
|
|
</font><font color="#007700">= array(); </font><font color="#FF8000">//
|
|
Initialize the empty array</font><font color="#007700"><br />
|
|
if (</font><font color="#0000BB">$rates
|
|
</font><font color="#007700">= </font><font color="#0000BB">get_records</font><font color="#007700">(</font><font color="#DD0000">"forum_ratings"</font><font color="#007700">,
|
|
</font><font color="#DD0000">"post"</font><font color="#007700">, </font><font color="#0000BB">$postid</font><font color="#007700">))
|
|
{<br />
|
|
</font><font color="#FF8000">//
|
|
Process each rating in turn</font><font color="#007700"><br />
|
|
foreach
|
|
(</font><font color="#0000BB">$rates </font><font color="#007700">as </font><font color="#0000BB">$rate</font><font color="#007700">)
|
|
{</font> <br />
|
|
....srl </p>
|
|
</li>
|
|
<li class="spaced"><strong>Spás:</strong> ba cheart bheith flaithiúil leis - ná bíodh faitíos ort
|
|
rudaí a scaipeadh amach roinnt éigin ar mhaithe le soiléireacht. Go ginearálta, ba cheart go mbeadh
|
|
spás amháin idir lúibíní agus gnáth ráitis, agus gan spás ar bith idir lúibíní agus
|
|
athróga nó feidhmeanna:<br />
|
|
<p class="examplecode"> <font color="#007700">foreach (</font><font color="#0000BB">$objects
|
|
</font><font color="#007700">as </font><font color="#0000BB">$key </font><font color="#007700">=></font><font color="#0000BB">
|
|
$thing</font><font color="#007700">)</font><font color="#006600"> {<br />
|
|
</font><font color="#007700"> </font><font color="#0000BB">process($thing);</font><font color="#006600">
|
|
<br />
|
|
} <br />
|
|
<br />
|
|
</font><font color="#007700">if (</font><font color="#0000BB">$x </font><font color="#007700">==
|
|
</font><font color="#0000BB">$y</font><font color="#007700">)</font><font color="#006600">
|
|
{<br />
|
|
</font><font color="#007700"> </font><font color="#0000BB">$a
|
|
</font><font color="#007700">= </font><font color="#0000BB">$b</font><font color="#007700">;</font><font color="#006600"><br />
|
|
} else if (</font><font color="#0000BB">$x </font><font color="#007700">==
|
|
</font><font color="#0000BB">$z</font><font color="#006600">) {<br />
|
|
</font><font color="#007700"> </font><font color="#0000BB">$a
|
|
</font><font color="#007700">= </font><font color="#0000BB">$c</font><font color="#007700">;</font><font color="#006600"><br />
|
|
} else {<br />
|
|
</font><font color="#007700"> </font><font color="#0000BB">$a
|
|
</font><font color="#007700">= </font><font color="#0000BB">$d</font><font color="#007700">;</font><font color="#006600"><br />
|
|
} </font></p>
|
|
</li>
|
|
</ol>
|
|
<p> </p>
|
|
<h2>Struchtúr Bunachair Sonraí:</h2>
|
|
<ol class="normaltext">
|
|
<li class="spaced">Ní mór do gach tábla réimse <strong>id</strong> (INT10) uath-incriminteach a bheith aige mar innéacs príomhúil.</li>
|
|
<li class="spaced">Ní mór don phríomhtábla in dtarlaíonn gach modúl an t-ainm céanna a bheith air is atá ar an modúl (m.sh. <strong>widget</strong>) agus ar a laghad na réimsí seo a leanas a bheith ann:
|
|
<ul>
|
|
<li><strong>id</strong> - mar a sonraíodh thuas</li>
|
|
<li><strong>course</strong> - id an chúrsa a mbaineann gach ásc leis</li>
|
|
<li><strong>name</strong> - ainm iomlán gach ásc den mhodúl</li>
|
|
</ul>
|
|
</li>
|
|
<li class="spaced">Ba cheart táblaí eile atá gaolmhar le modúl, a bhfuil eolas iontu faoi 'things', ba cheart <strong>widget_things</strong> a thabhairt orthu (tabhair faoi deara an t-iolra).</li>
|
|
<li class="spaced">Ba cheart ainmneacha na gcolún a choinneáil gairid agus simplí, agus na rialacha céanna á leanúint is atá ann d'ainmneacha athróige.</li>
|
|
<li class="spaced">Nuair is féidir é, má tá tagairt i gcolún do réimse id i dtábla eile (m.sh. <strong>widget</strong>), ba cheart <strong>widgetid</strong> a ghlaoch air. (Tabhair faoi deara gur nós réasúnta nua é seo agus nach leantar é i roinnt sean-táblaí)</li>
|
|
<li class="spaced">Ba cheart réimsí Boole a chur i bhfeidhm mar réimsí beaga slánuimhreacha (m.sh. INT4) a bhfuil 0 nó 1 iontu, le leathnú ar luachanna a éascú ar ball más gá.</li>
|
|
<li class="spaced">Ba cheart do formhór na dtáblaí réimse <strong>timemodified</strong> (INT10) a bheith acu a nuashonraítear le ham-stampa reatha trí an bhfeidhm PHP <strong>time ()</strong> a úsáid.</li>
|
|
</ol>
|
|
<hr />
|
|
<p align="center"><font size="1"><a href="." target="_top">Doiciméid Moodle</a></font></p>
|
|
<p align="center"><font size="1">Leagan: $Id$</font></p>
|
|
</body>
|
|
</html>
|