- <li>Deben mantenerse todas las notas de derechos de autor. Usted puede añadir
- <li>Cada archivo debe certificar que el usuario esté correctamente autenticado,
- utilizando require_login() e isadmin(), isteacher(), iscreator() o isstudent().</li>
- <li>Todo acceso a las bases de datos debe utilizar las funciones incluidas en
- lib/datalib.php en cuanto sea posible --esto permite que sea compatible con
- un amplio rango de bases de datos. Con esas funciones es posible hacer casi
- <li>Todas las cadenas deben ser traducibles --cree nuevos textos en los archivos
- <li>Todos los archivos de ayuda deben ser traducibles --cree nuevos textos en
- if (</font><font color="#0000cc">$numattempts </font><font
-<p align="CENTER"><font size="1">Version: $Id: faq.html,v 1.6 2003/03/30 13:54:28
+<html>
\r<head>
\r<title>Moodle Docs: Coding Guidelines</title>
\r<link rel="stylesheet" href="docstyles.css" type="TEXT/CSS">
\r<meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1">
\r</head>
\r<body bgcolor="#FFFFFF">
\r<h1>Manual de Estilo del Código</h1>
\r<p class="normaltext">Cualquier proyecto colaborativo necesita que que la consistencia
\r y la estabilidad sean fuertes.</p>
\r<p class="normaltext">Esta manual de estilo ha sido escrito para conseguir que
\r todo el código de Moodle cumpla estas características. Es cierto que la parte
\r más antigua del código no cumple lo aquí especificado en algunos casos, pero
\r esto será solucionado en breve. Todo el código nuevo definitivamente deberá
\r adherirse a estos estándares de la forma más exacta posible.</p>
\r<h2>Reglas Generales</h2>
\r<ol class="normaltext">
\r <li class="spaced">Todos los archivos con código deberían utilizar la extensión
\r .php.</li>
\r <li class="spaced">Todas las plantillas deberían utilizar la extensión .html.</li>
\r <li class="spaced">Todos los archivos de texto deberían utilizar el formato
\r de texto Unix (la mayoría de los editores de texto tienen esto como una opción).</li>
\r <li class="spaced">Todas las etiquetas php deben ser 'completas' como <font color="#339900"><?php
\r ?></font> ... no 'reducidas' como <font color="#339900"><?
\r ?></font>.
\r </li>
\r <li class="spaced">Todos los avisos de copyright deben ser mantenidos. Puedes
\r incluir los tuyos propios si resulta necesario.</li>
\r <li class="spaced">Todos los archivos deben incluir el el archivo principal
\r config.php.</li>
\r <li class="spaced">Cada archivo debería comprobar que el usuario está autenticado
\r correctamente, utilizando las funciones require_login() y
\r isadmin(),
\r isteacher(),
\r iscreator()
\r o isstudent().</li>
\r <li class="spaced">Todos los accesos a la base de datos deberían utilizar las
\r funciones de finidas en
\r lib/datalib.php cuando sea posible
\r -
\r esto permite la compatibilidad con un gran número de bases de datos.
\r \r Deberías encontrar que prácticamente todo es posible utilizando estas funciones.
\r Si quieres esribir código SQL entonces deberás comprobar que: funciona en
\r cualquir plataforma; restringido a funciones específicas de tu código (normalmente
\r un archivo lib.php); y claramente comentado.</li>
\r <li class="spaced">No crees o utilices variables globales distintas de las
\r estándar $CFG, $SESSION, $THEME y $USER.</li>
\r <li class="spaced">Todas las variables deberían ser inicializadas o, al menos,
\r comprobada su existencia utilizando isset()
\r o empty()
\r antes de ser utilizadas.</li>
\r <li class="spaced">Todas las cadenas deberían ser traducibles - crea nuevos
\r textos en los archivos "lang/es" files
\r con palabras reducidas en inglés y su traducción completa al Español y recupéralas
\r en tu código utilizando las funciones get_string() or print_string().</li>
\r <li class="spaced">Todos los archivos de ayuda deberían ser traducibles - crea
\r nuevos textos en el directorio "es/help" y llámalos utilizando
\r la función helpbutton().</li>
\r <li class="spaced">La información que llaga desde el navegador (enviada con
\r los métodos GET o POST) automáticamente tiene las "magic_quotes" aplicadas
\r (sin importar la configuración de PHP) por lo que uedes insertarla contotal
\r seguridad en la base de datos. El resto de la información(obtenida desde
\r los archivos, o desde la base de datos)
\r debe ser escapada con la función <font color="#339900">addslashes()</font> antes
\r de insertarla en la base de datos.</li>
\r</ol>
\r<p> </p>
\r<h2>Estilo del Código</h2>
\r<p class="normaltext">Comprendo que puede ser un poco frustrante modificar tu
\r estilo de programación si has trabajado en otras coasa, pero compara esa frustración
\r con la frustración de toda la gente que intente, más adelante, encontrar el
\r sentido del código de Moodle si es una mezcla de estilos. Obviamente, hay muchos
\r puntos a favor y en contra de cada estilo que la gente utiliza, pero el que
\r se detalla aquí es el que deberás utilizar.</p>
\r<ol class="normaltext">
\r <li class="spaced"><strong>El sangrado</strong> del texto debe ser siempre
\r de 4 espacios. No utilices los tabuladosres NUNCA.</li>
\r <li class="spaced"><strong>Los nombres de las variables</strong> tienen que
\r ser siempre fáciles de leer, procurando que sean palabras en minúsculas con
\r significado en Inglés. Si realmente necesitas más de una palabra, ponlas
\r juntas, pero procura mantenerlas tan breves como sea posible. Utiliza nombres
\r en plural para las matrices de objetos.
\r <p class="examplecode"><font color="#006600">BIEN</font><font color="#006600">:
\r $quiz<br>
\r BIEN</font><font color="#006600"></font><font color="#006600">: $errorstring<br>
\r BIEN</font><font color="#006600"></font><font color="#006600">: $assignments
\r (for an array of objects)<br>
\r BIEN</font><font color="#006600"></font><font color="#006600">: $i (but
\r only in little loops)<br>
\r <br />
\r MAL: $Quiz <br>
\r MAL: $aReallyLongVariableNameWithoutAGoodReason<br>
\r MAL: $error_string</font></p>
\r </li>
\r <li class="spaced"><strong>Las constantes</strong> tienen que definirse siempre
\r en mayúsculas, y empezar siempre por el nombre del módulo al que pertenecen.
\r Deberían tener las palabras separadas por guiones bajos.
\r <p class="examplecode"><font color="#006600">define("FORUM_MODE_FLATOLDEST",
\r 1);</font></p>
\r </li>
\r <li class="spaced"><strong>Los nombres de las funciones</strong> tienen que
\r ser palabras sencillas en minúsculas y en Inglés, y empezar con el nombre
\r del módulo al que pertenecen para evitar conflictos entre módulos. Las palabras
\r deberían separarse por guiones bajos. Los parámentros, si es posible, tendrán
\r valores por defecto. Fíjate en que no has espacio entre el nombre de la función
\r y lo siguiente (paréntesis).<br>
\r <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">)
\r {<br />
\r global </font><font color="#0000BB">$USER</font><font color="#007700">,
\r </font><font color="#0000BB">$CFG</font><font color="#007700">;<br />
\r <br />
\r if (</font><font color="#0000BB">$mode</font><font color="#007700">)
\r {<br />
\r </font><font color="#0000BB">$USER</font><font color="#007700">-></font><font color="#0000BB">mode
\r </font><font color="#007700">= </font><font color="#0000BB">$mode</font><font color="#007700">;<br />
\r } else if (empty(</font><font color="#0000BB">$USER</font><font color="#007700">-></font><font color="#0000BB">mode</font><font color="#007700">))
\r {<br />
\r </font><font color="#0000BB">$USER</font><font color="#007700">-></font><font color="#0000BB">mode
\r </font><font color="#007700">= </font><font color="#0000BB">$CFG</font><font color="#007700">-></font><font color="#0000BB">forum_displaymode</font><font color="#007700">;<br />
\r }<br />
\r }</font></p>
\r </li>
\r <li class="spaced"><strong>Los bloques de código</strong> siempre deben
\r estar encerrados por llaves(incluso si solo constan de una línea). Moodle
\r utiliza este estilo:
\r <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">)
\r {<br />
\r if (</font><font color="#0000CC">$numattempts </font><font color="#006600">>
\r </font><font color="#0000CC">$quiz</font><font color="#006600">-></font><font color="#0000CC">attempts</font><font color="#006600">)
\r {<br />
\r </font><font color="#0000CC">error</font><font color="#006600">(</font><font color="#0000BB">$strtoomanyattempts</font><font color="#006600">,
\r </font><font color="#CC0000">"view.php?id=$cm</font><font color="#006600">-></font><font color="#CC0000">id"</font><font color="#006600">);<br />
\r }<br />
\r }</font></p>
\r </li>
\r <li class="spaced"><strong>Las cadenas </strong> tienen que ser definidas utilizando
\r comillas simples siempre que sea posible, para obtener un mejor rendimiento.<br>
\r <p class="examplecode"> <font color="#006600">$var = 'some text without any
\r variables';<br>
\r $var = "with special characters like a new line \n";<br>
\r $var = 'a very, very long string with a '.$single.' variable in it';<br>
\r $var = "some $text with $many variables $within it"; </font></p>
\r </li>
\r <li class="spaced"><strong>Los comentarios</strong> utilizarán dos o tres barras
\r y estarán alineados con el código
\r <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">,
\r </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">)
\r {<br />
\r </font><font color="#FF8000">/// Return the mean rating of a post given
\r to the current user by others.<br />
\r /// Scale is an array of possible ratings in the scale<br />
\r /// Ratings is an optional simple array of actual ratings (just integers)<br />
\r <br />
\r </font><font color="#007700">if (!</font><font color="#0000BB">$ratings</font><font color="#007700">)
\r {<br />
\r </font><font color="#0000BB">$ratings
\r </font><font color="#007700">= array(); </font><font color="#FF8000">//
\r Initialize the empty array</font><font color="#007700"><br />
\r if (</font><font color="#0000BB">$rates
\r </font><font color="#007700">= </font><font color="#0000BB">get_records</font><font color="#007700">(</font><font color="#DD0000">"forum_ratings"</font><font color="#007700">,
\r </font><font color="#DD0000">"post"</font><font color="#007700">, </font><font color="#0000BB">$postid</font><font color="#007700">))
\r {<br>
\r </font><font color="#FF8000">//
\r Process each rating in turn</font><font color="#007700"><br />
\r foreach
\r (</font><font color="#0000BB">$rates </font><font color="#007700">as </font><font color="#0000BB">$rate</font><font color="#007700">)
\r {</font> <br>
\r ....etc </p>
\r </li>
\r <li class="spaced"><strong>El espacio en blanco</strong> se puede utilizar
\r con bastante libertad - no te preocupes por separar las cosas un poco para
\r ganar en claridad. Generalmente, debería haber un espacio entre llaves y
\r líneas normales y ninguno entre llaves y variables o funciones:<br>
\r <p class="examplecode"> <font color="#007700">foreach (</font><font color="#0000BB">$objects
\r </font><font color="#007700">as </font><font color="#0000BB">$key </font><font color="#007700">=></font><font color="#0000BB">
\r $thing</font><font color="#007700">)</font><font color="#006600"> {<br>
\r </font><font color="#007700"> </font><font color="#0000BB">process($thing);</font><font color="#006600">
\r <br>
\r } <br>
\r <br>
\r </font><font color="#007700">if (</font><font color="#0000BB">$x </font><font color="#007700">==
\r </font><font color="#0000BB">$y</font><font color="#007700">)</font><font color="#006600">
\r {<br>
\r </font><font color="#007700"> </font><font color="#0000BB">$a
\r </font><font color="#007700">= </font><font color="#0000BB">$b</font><font color="#007700">;</font><font color="#006600"><br>
\r } else if (</font><font color="#0000BB">$x </font><font color="#007700">==
\r </font><font color="#0000BB">$z</font><font color="#006600">) {<br>
\r </font><font color="#007700"> </font><font color="#0000BB">$a
\r </font><font color="#007700">= </font><font color="#0000BB">$c</font><font color="#007700">;</font><font color="#006600"><br>
\r } else {<br>
\r </font><font color="#007700"> </font><font color="#0000BB">$a
\r </font><font color="#007700">= </font><font color="#0000BB">$d</font><font color="#007700">;</font><font color="#006600"><br>
\r } </font></p>
\r </li>
\r</ol>
\r<p> </p>
\r<h2>Estructuras de la base de datos</h2>
\r<ol class="normaltext">
\r <li class="spaced">Cada tabla debe tener un campo autonumérico <strong>id</strong> (INT10)
\r como clave primaria.</li>
\r <li class="spaced">La tabla principal que contiene instancias de cada módulo
\r debe tener el mismo nombre que el módulo y contener, por lo menos, los siguientes
\r campos:
\r <ul>
\r <li><strong>id</strong> - descrito arriba</li>
\r <li><strong>course</strong> - el identificador del curso al que la instancia
\r pertenece</li>
\r <li><strong>name</strong> - el nombre completo de la instancia</li>
\r </ul>
\r </li>
\r <li class="spaced">El resto de las tablas asociadas con un módulo que contiene
\r información sobre 'cosas', deberían ser llamandas <strong>modulo_cosas</strong>(fíjate
\r en el plural!).</li>
\r <li class="spaced">Los nombres de los campos (columnas) deberían ser sencillos
\r y cortos, siguiendo las mismas reglas que los nombres de las variables.</li>
\r <li class="spaced">Cuando sea posible, las columnas que contengan una referencia
\r al campo id de otra tabla
\r (por ejemplo, <strong>modulo</strong>)
\r debería ser llamado <strong>moduloid</strong>.
\r (fíjate que esta norma es nueva y no es seguida por algunas tablas antiguas).</li>
\r <li class="spaced">Los campos booleanos serán implementados como enteros cortos
\r (por ejemplo, INT4) con los valores 0 o 1,
\r para permitir la futura expansión de los valores si fuera necesario.</li>
\r <li class="spaced">La mayoría de las tablas tienen que tener un campo <strong>timemodified</strong> (INT10)
\r que será actualizado con la fecha actual (timestamp de UNIX) obtenida con
\r la función <strong>time</strong>()
\r de PHP.</li>
\r</ol>
\r<hr>
\r<p align="CENTER"><font size="1"><a href="." target="_top">Moodle Documentation</a></font></p>
\r<p align="CENTER"><font size="1">Version: $Id$</font></p>
\r</body>
\r</html>
\r
projects / moodle.git / commitdiff