Cómo crear plugins con fsmaker

fsmaker es nuestra herramienta en línea de comandos para crear rápidamente plugins para FacturaScripts, además de modelos, controladores, etc. Es una herramienta muy sencilla con la que ahorrará incontables horas de desarrollo.

Para instalar solamente necesita PHP y Composer.

Instalar Código fuente

Con fsmaker puede:

Crear modelos, con sus correspondientes tablas y controladores.
Crear extensiones para modelos y controladores.
Crear el archivo Cron.
Crear el archivo Init.
Crear tests unitarios.
Descargar las últimas traducciones de la web.
Empaquetar el plugin y crear el ZIP.

$ fsmaker
FacturaScripts Maker v1.3

crear:
$ fsmaker plugin
$ fsmaker model
$ fsmaker controller
$ fsmaker extension
$ fsmaker gitignore
$ fsmaker cron
$ fsmaker init
$ fsmaker test

descargar:
$ fsmaker translations

comprimir:
$ fsmaker zip

Ejemplo de uso de fsmaker

A continuación crearemos un plugin sencillo con fsmaker. Para ello abrimos un terminal en la carpeta Plugins de FacturaScripts. A continuación llamamos a fsmaker para crear el plugin.

fsmaker plugin

fsmaker nos pedirá el nombre del plugin, que debe comenzar por mayúscula y no contener ningún espacio. Para este ejemplo escribiremos: MisNotas

Se creará automáticamente una carpeta con el nombre del plugin en la carpeta Plugins. Dentro tenemos la estructura de directorios típica de un plugin de FacturaScripts, junto a los archivos facturascripts.ini, Init.php y Cron.php

Siguiendo con el ejemplo del plugin de notas, vamos a crear un modelo para las notas. Paran ello nos colocamos en el directorio del plugin y llamamos a fsmaker con la opción de model, para crear un nuevo modelo.

cd MisNotas
fsmaker model

fsmaker nos pedirá el nombre del modelo, que debe ser un nombre en singular, comenzar por mayúsculas y no contener espacios. Para este ejemplo escribiremos MiNota. A continuación nos pedirá el nombre de la tabla de la base de datos, este nombre debe ser en minúsculas y sin espacios. Para este ejemplo escribiremos mis_notas. Por último nos pedirá los nombres y tipos de las columnas de la tabla. Para este ejemplo elegiremos estas columnas:

id, serial
creation_date, timestamp
last_mod, timestamp
nick, varchar(50)
body, text
done, bool

Por último fsmaker nos pedirá si queremos crear los controladores. Seleccionamos que si y elegimos el menú notas y el título notas. Una vez completado se crearán los correspondientes archivos:

Controller/EditMiNota.php
Controller/ListMiNota.php
Model/MiNota.php
Table/mis_notas.xml
XMLView/EditMiNota.xml
XMLView/ListMiNota.xml

Cómo instalar composer y fsmaker

Composer es un gestor de dependencias de PHP. Si no tiene instalado composer, puede instalarlo fácilmente siguiendo estos ejemplos. Tenemos uno para Linux y otro para Windows:

Instalar en Linux

Para instalar composer en Linux, puede seguir la guía oficial de instalación en Linux. O si está usando Ubuntu o derivados, simplemente abra un terminal y ejecutar:

sudo apt install composer

Una vez instalado composer ya puede instalar fsmaker con estos comandos:

composer global require facturascripts/fsmaker
sudo ln -s ~/.config/composer/vendor/bin/fsmaker /usr/local/bin/fsmaker

Ahora ya puede ejecutar fsmaker desde cualquier carpeta. Simplemente abra un terminal y ejecute:

fsmaker

Instalar en Windows

Para instalar en windows puede seguir la guía oficial de instalación en windows.

Una vez instalado composer ya puede instalar fsmaker con este comando:

composer global require facturascripts/fsmaker

Ahora ya puede ejecutar fsmaker desde cualquier carpeta. Simplemente abra un terminal y ejecute:

composer global exec fsmaker

Cómo actualizar fsmaker

Al estar instalado fsmaker con composer, simplemente debemos llamar a composer para actualizar. Esto descargará e instalará cualquier nueva versión de fsmaker que lancemos.

composer global update