Documentación para desarrolladores

Antes de empezar a programar

En esta versión hemos hecho cambios radicales respecto a la versión 2017, simplificando enormemente las tareas de desarrollo más comunes. Es importante que lea esta documentación antes de empezar a desarrollar sobre FacturaScripts 2020.

Sus personalizaciones van en plugins

No haga cambios en los archivos de Core. Estos cambios se perderán al actualizar. Coloque sus personalizaciones en un plugin nuevo dentro de la carpeta Plugins. Si sus cambios requieren tal nivel de integración que deben ir en Core, consulte antes de hacer nada con el resto del equipo de desarrolladores para valorar si realmente es conveniente modificar el Core o no.

Curso

También tiene toda esta documentación condensada en el curso de programación, en la sección de cursos, con docenas de vídeos explicativos.

Documentación de clases

La documentación de todas las clases de FacturaScripts la tiene en doc.facturascripts.com

Nombres de clases y archivos:

El nombre del archivo debe coincidir con el nombre de la clase, y un archivo solamente debe contener una clase. Los nombres de las clases deben ser en singular, por ejemplo Artículo, y la primera letra en mayúscula. En concreto debe utilizar la notación CamelCase:

  • Articulo_proveedor: MAL
  • ArticuloProveedor: BIEN
  • Ejercicio->fecha_inicio: MAL
  • Ejercicio->fechainicio: BIEN ¿Por qué? Bueno, Ejercicio es un modelo y las propiedades las lee de la tabla ejercicios. En los nombres de las tablas no se pueden usar mayúsculas, así que si llamamos a la propiedad fechaInicio tendremos problemas.

Si necesita más detalles, puede leer la definición del estándar PSR-1 y PSR-2, que profundiza en más detalles.

Espacios de nombres:

Cada clase debe estar en el espacio de nombres correspondiente a su carpeta, por ejemplo, la clase Producto pertenece al espacio de nombres FacturaScripts\Core\Model\Producto porque está en el directorio Core\Model.

Espacios de nombres en plugins:

Cada plugin tiene su espacio de nombres reservado, que corresponde con FacturaScripts\Plugins\{NOMBRE_DEL_PLUGIN}

Git

No es obligatorio, pero es muy recomendable que se familiarice con git. Aquí encontrará una guía muy sencilla del manejo de git.

Buscar

Necesita identificarse para continuar con esta acción. Haga clic en iniciar sesión o cree una cuenta.

Iniciar sesión
neorazorx_1
neorazorx_1
1627 Puntos 8 años
Fecha de creación 25-04-2018 00:00:00
Última actualización 30-12-2020
Contador de visitas 3941

Copyright (c) 2013-2021 FacturaScripts