Skip to content
melissamillares edited this page Jul 17, 2019 · 17 revisions

Lineamientos Módulo ASES

Es un plugin de moodle de tipo bloque, que está diseñado para sistematizar el proceso de seguimiento estudiantil que se realiza dentro de la estrategia ASES. Es una aplicación web que sirve para gestionar la información de la estrategia ASES. El Módulo ASES permite:

  • Gestión de usuarios pertenecientes a la estrategia, cada uno con sus respectivos roles.
  • Registrar en detalle todo el proceso socioeducativo que se le hace a los beneficiarios del programa.
  • Realizar reportes con el fin de mostrar información relevante respecto a los seguimientos socioeducativos.

Al inicio de cada función se debe incluir una descripción general de lo que esta hace y también incluir la siguiente información:
@author
@see
@param
@return

Para cambiar el servidor de pruebas de rama se deben seguir los siguientes pasos:

  1. Ejecutar el comando ssh root@direccion_ip_servidor (ej. ssh [email protected])
  2. Desde el directorio raíz entrar a root y buscar el archivo pullAses.sh (aquí está la rama sincronizada con el servidor de pruebas)
  3. Modificar la línea de moodle35_ases con el nombre de la rama que estará en el servidor de pruebas

El proyecto se divide en las siguientes carpetas:

  • classes
  • managers
  • amd
  • view
  • style
  • templates
  • Core

Managers

  • Para los archivos lib:

    • El prefijo para los archivos debe ser: pref_*
    • Las funciones internas deben iniciar con guión bajo ( _ )
  • Para los archivos api:

    • No debe tener consultas en la base de datos (no hace uso de la base de datos)
    • No define funciones
    • No más de tres (3) líneas
    • El api sólo puede llamar a su lib (no puede llamar a otro lib)
    • Comentar la función, incluir parámetros y validaciones
  • Agregar Cohorte al Reporte Icetex:
    Cuando se registra una cohorte nueva, cuyos estudiantes van a tener resolución Icetex, para que aparezcan en el reporte Histórico Icetex se debe cambiar la consulta en la función get_array_students_with_resolution, en el archivo icetex_reports_lib.php:

    • ... WHERE cohorts.idnumber LIKE 'SPP%' AND ...

    Se debe modificar esta línea e incluir el prefijo de la nueva cohorte. Esto se debe hacer también cuando se cambie el prefijo de las cohortes.

Amd

  • Carpeta src:
    • Los componentes inician con guión bajo ( _ )
    • Los archivos javascript principales de la vista deben tener el mismo nombre del view seguido de _main
    • Los archivos se deben minificar

Views

  • Se debe incluir en los archivos la configuración de la vista
  • Se instancian las variables (etiquetas) que se envían por contexto desde el servidor
  • Se deben dar permisos de lectura y escritura a carpeta archivos subidos

Style

  • Dependiendo de la vista se hace el estilo para pantalla y para impresión

Templates

  • En esta carpeta se encuentran las plantillas de vistas o componentes
  • Los archivos deben tener el mismo nombre de la vista
  • Para los archivos .mustache:
    • Se deben definir los permisos de la vista
    • No se debe incluir código en javascript, ni estilos, en las plantillas

Core

  • En esta carpeta se incluyen archivos por consenso general (Security, Core_DB, Formularios, Periodo)
  • Las funciones deben utilizar sólo los parámetros que ingresen
  • No modifica estados (variables)
  • El prefijo para los archivos debe ser: core_*

Cada módulo se divide en un archivo de interfaz y diversas carpetas de versiones con la implementación:

  • interfaz.php

  • Carpeta de versión v1:

    • implementación.php
  • Carpeta de versión v2:

    • implementación.php
  • En el Core para caché se implementan las siguientes funcionalidades:

    • cc_get_value(...)
    • cc_put_value(...)
    • cc_update_value(...)
    • cc_delete(...)

El caché no debería ser fundamental en el desarrollo de una funcionalidad

Glosario

  • ASES: estrategia de acompañamiento y seguimiento estudiantil que brinda apoyo a estudiantes beneficiarios de programas del gobierno, como Ser Pilo Paga, Generación E y condiciones de excepción.
  • Moodle: Es una plataforma de aprendizaje diseñada para brindar a los educadores, administradores y alumnos un único sistema sólido, seguro e integrado para crear entornos de aprendizaje personalizados. (https://docs.moodle.org/37/en/About_Moodle)
  • Módulo en la aplicación: