Nueva clase ToolBox para agrupar log, traductor y varias herramientas más

Al comienzo del desarrollo evaluamos usar un contenedor para almacenar las herramientas más utilizadas, como son el logger y el traductor. Pero esa solución tenía un problema, al hacer $this->get('logger') NetBeans no sabía que eso devuelve un objeto de la clase MiniLog y por tanto no mostraba la lista de métodos disponibles. Por este motivo se descartó.

Esta semana hemos estado modificando el logger y hemos buscado una solución alternativa para agrupar estas herramientas: la clase ToolBox, que tiene un método para cada una de las herramientas más utilizadas. Hemos añadido el método toolBox() a controladores y modelos (a las clases base) para poder acceder más cómodamente. Estos cambios estarán disponibles a partir de FacturaScripts 2018.9.

Obtener el traductor desde un controlador o modelo

$i18n = $this->toolBox()->i18n();

También podemos pasar el código de un idioma como parámetro para obtener un traductor para ese idioma:

$i18n = $this->toolBox()->i18n('en_EN');

Obtener la traducción (al idioma predeterminado) de una cadena, por ejemplo 'no-data':

$translation = $this->toolBox()->i18n()->trans('no-data');

Añadir un mensaje de error al log

$this->toolBox()->log()->error('mi mensaje');

También permite especificar un canal como parámetro:

$this->toolBox()->log('mi-canal')->error('mi mensaje');

Añadir un mensaje de error al log, pero con traducción automática

Sucede que la mayoría de veces que queremos escribir algo en el log, lo queremos traducido. En estos casos debíamos combinar una llamada al log con una al traductor. Para hacernos la vida más fácil hemos creado una clase que traduce automáticamente los mensajes antes de añadirlos al log. Y esta clase se puede llamar directamente desde toolBox():

$this->toolBox()->i18nLog()->error('my-message');

También permite especificar un canal como parámetro:

$this->toolBox()->i18nLog('mi-canal')->error('my-message');

Obtener valores de las preferencias de la aplicación

La divisa predeterminada, la forma de pago, etc... se configuran desde las preferencias de la aplicación en el panel de control. Podemos obtener estos valores con la clase AppSettings, que ahora también es accesible desde toolBox().

Vamos a obtener la divisa predeterminada:

$coddivisa = $this->toolBox()->appSettings()->get('default', 'coddivisa');

Acceso a la caché

Podemos guardar valores en caché:

$this->toolBox()->cache()->set('mi-clave', 1234);

Y por supuesto, también podemos leerlos:

$value = $this->toolBox()->cache()->get('mi-clave');

Operaciones con divisas

Podemos formatear una cantidad en la divisa predeterminada:

$string = $this->toolBox()->coins()->format(1234.56);
/// 1 234,55 €

O convertir una cantidad de euros a USD:

$string = $this->toolBox()->coins()->convert(100, 'EUR', 'USD');

Todos los métodos disponibles en toolBox()

• appSettings() : acceso a las preferencias de la aplicación.
• cache() : acceso a la caché.
• coins() : operaciones con divisas.
• events() : acceso al gestor de eventos.
• files() : operaciones con archivos o carpetas.
• i18n() : traductor.
• i18nLog() : logger con traducción automática.
• ipFilter() : operaciones con IP.
• log() : logger.
• numbers() : operaciones con números.
• utils() : conjunto de funciones random.