Esta web utiliza cookies propias y de terceros para su funcionamiento. ¿Aceptas? Leer más
Desarrollo sobre FacturaScripts 2018

Antes de empezar a programar

Antes de que empiece a programar o modificar el código de FacturaScripts, es necesario que tenga claros algunos conceptos.

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.

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 Articulo pertenece al espacio de nombres FacturaScripts\Core\Model\Articulo 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}