Info

Solo disponible en BuenasTareas
  • Páginas : 11 (2564 palabras )
  • Descarga(s) : 0
  • Publicado : 20 de febrero de 2012
Leer documento completo
Vista previa del texto
Manual de Estilo de Código
Cualquier proyecto colaborativo necesita que la consistencia y la estabilidad sean fuertes.
Este manual de estilo ha sido escrito para conseguir que todo el código de Moodle cumpla estas características. Es cierto que la parte más antigua del código no cumple lo aquí especificado en algunos casos, pero esto será solucionado gradualmente. Todo el código nuevodefinitivamente deberá adherirse a estos estándares de la forma más exacta posible.

Contenido * 1 Reglas Generales * 2 Estilo del Código * 3 Estructuras de la base de datos * 4 Normas de Seguridad (y control de la información de formularios y URLs) |
Reglas Generales
1. Todos los ARCHIVOS DE CÓDIGO deberían utilizar la extensión .php.
2. Todas las PLANTILLAS deberían utilizar laextensión .html.
3. Todos los ARCHIVOS DE TEXTO deberían utilizar el formato de texto Unix (la mayoría de los editores de texto tienen esto como una opción).
4. Todas las ETIQUETAS php deben ser 'completas' como <?php ?> ... no 'reducidas' como <? ?>.
5. Todos los AVISOS DE COPYRIGHT deben ser mantenidos. Puede incluir los suyos propios si resulta necesario.
6. Todoslos ARCHIVOS deben incluir el archivo principal config.php.
7. Cualquier otro include/require debería utilizar una RUTA absoluta que comience por $CFG->dirroot o $CFG->libdir, nunca relativos, ya que estos en algunas ocasiones funcionan de forma extraña en PHP.
8. Cada archivo debería comprobar que el usuario está AUTENTICADO correctamente, utilizando las funciones require_login()y isadmin(), isteacher(), iscreator() o isstudent().
9. Todos los ACCESOS A LA BASE DE DATOS deberían utilizar las funciones definidas en lib/datalib.php cuando sea posible - esto permite la compatibilidad con un gran número de bases de datos. Debería encontrar que prácticamente todo es posible utilizando estas funciones. Si quiere escribir código SQL entonces deberá comprobar que: funcionaen cualquier plataforma; restringido a funciones específicas de su código (normalmente un archivo lib.php); y claramente comentado.
10. No cree o utilice VARIABLES globales distintas de las estándar $CFG, $SESSION, $THEME, $SITE, $COURSE y $USER.
11. Todas las VARIABLES deberían ser inicializadas o, al menos, comprobada su existencia utilizando isset() o empty() antes de ser utilizadas.12. Todas las CADENAS deberían ser traducibles - cree nuevos textos en los archivos "lang/es_utf8" con palabras reducidas en inglés y su traducción completa al Español y recupérelas en su código utilizando las funciones get_string() or print_string().
13. Todos los ERRORES deberían ser visualizados utilizando la función print_error() para maximizar la traducción y ayudar a los usuarios(Automáticamente se enlaza con Moodle Docs).
14. Todos los FICHEROS DE AYUDA deben ser traducibles - cree nuevos textos en el directorio "lang/es_utf8/help" y llámelos utilizando la función helpbutton(). Si necesita actualizar un fichero de ayuda:
* para un pequeño CAMBIO, donde la traducción antigua del fichero podría tener todavía sentido, está permitido que haga el cambio, perodebería notificárselo a translation@moodle.org
* para un CAMBIO importante tendrá que crear un nuevo fichero añadiéndole en el nombre un número incrementado (p.ej. filename2.html) para que los traductores puedan ver fácilmente que se trata de una nueva versión del archivo. Obviamente el nuevo código y los índices de las páginas de ayuda deben ser modificados para apuntar a las versiones másrecientes.
15. La INFORMACIÓN que llega desde el navegador (enviada con los métodos GET o POST) automáticamente tiene las "magic_quotes" aplicadas (sin importar la configuración de PHP) por lo que puedes insertarla con total seguridad en la base de datos. El resto de la información(obtenida desde los archivos, o desde la base de datos) debe ser escapada con la función addslashes() antes de...
tracking img