README

Repositorios con clases y traits de utilidad para realizar composición y/o herencia.

Instalación

Composer

Este proyecto usa como gestor de dependencias Composer el cual puede ser instalado siguiendo las instrucciones especificadas en la documentación oficial del proyecto.

Para instalar el paquete jf/base usando este manejador de paquetes se debe ejecutar:

composer require jf/base

Control de versiones

Este proyecto puede ser instalado usando git. Primero se debe clonar el proyecto y luego instalar las dependencias:

git clone https://www.gitlab.com/jfphp/jfBase.git
cd jfBase
composer install

Archivos disponibles

Clases

Nombre	Descripción
jf\Base\AAssign	Clase que aporta la misma funcionalidad que `jf\Base\ASerializable` pero con un método `toArray()` más potente y que además implementa `jf\Base\IAssign` para facilitar la asignación de propiedades.
jf\Base\AAssignExtras	Clase que aporta la misma funcionalidad que `jf\Base\AAsign` permitiendo adicionalmente almacenar aquellos valores que se trataron de asignar pero que no corresponden con propiedades de la clase.
jf\Base\ABase	Clase que puede ser usada como base para algunos proyectos que implementa `Stringable` y aporta un método `new` así algunos métodos para obtener el nombre de la clase en diferentes formatos así como su espacio de nombres.
jf\Base\Exception	Excepciones del paquete `jf/base`.
jf\Base\File\File	Lee/escribe contenido desde/a un archivo.
jf\Base\File\Json	Clase que sirve de base para aquellos objetos que hacen uso intenso de archivos JSON.
jf\Base\File\Yaml	Clase que sirve de base para aquellos objetos que hacen uso intenso de archivos YAML.
jf\Base\Serializable\ASerializable	Clase base para aquellos objetos que necesitan serialización.

Interfaces

Nombre	Descripción
jf\Base\IAssign	Interfaz para detectar el uso de los métodos `assign` y `fromArray`.
jf\Base\IId	Interfaz para los elementos que requieren un identificador.
jf\Base\IParent	Gestiona el acceso a una instancia padre.
jf\Base\ISingleton	Interfaz para los singletons.
jf\Base\IStringable	Interfaz para detectar aquellas clases que se pueden convertir a `string` pero que no aceptan la interfaz `Stringable`.
jf\Base\IToArray	Interfaz para detectar el uso del método `toArray` y poder serializar un objeto.

Traits

Nombre	Descripción
jf\Base\Array\TArray	Trait que permite implementar las interfaces `ArrayAccess`, `Countable`, `Iterator` e `IteratorAggregate` en una clase que se quiera usar como un array.
jf\Base\Array\TArrayAccess	Trait que permite implementar la interfaz `ArrayAccess`.
jf\Base\Array\TArrayCountable	Trait que permite implementar la interfaz `Countable`.
jf\Base\Array\TArrayIterator	Trait que permite implementar la interfaz `Iterator`.
jf\Base\Array\TArrayIteratorAggregate	Trait que permite implementar la interfaz `IteratorAggregate`.
jf\Base\File\TFile	Agrega funcionalidad básica a clases que requieren leer/escribir archivos.
jf\Base\File\TJson	Trait para gestionar archivos JSON.
jf\Base\File\TYaml	Trait para gestionar archivos YAML.
jf\Base\Serializable\TAssign	Implementa la interfaz `jf\Base\IAssign` de manera simple asignando solamente las propiedades.
jf\Base\Serializable\TJson	Trait para serializar datos en formato JSON.
jf\Base\Serializable\TJsonSerializable	Trait que permite implementar la interfaz `JsonSerializable`.
jf\Base\Serializable\TSerializable	Trait que permite implementar de manera muy simple y rápida la serialización de objetos en arrays así como inicializar el objeto desde un array.
jf\Base\Serializable\TToArray	Serializa el contenido de la instancia iterando sobre todas las propiedades y devolviendo los valores escalares, nulos y arrays.
jf\Base\Serializable\TYaml	Trait para gestionar datos en formato YAML.
jf\Base\String\TString	Trait para agrupar todos los traits que gestionan las cadenas de texto como arrays.
jf\Base\String\TStringAccess	Trait que permite implementar la interfaz `ArrayAccess` con una cadena de texto.
jf\Base\String\TStringCountable	Trait que permite implementar la interfaz `Countable` con una cadena de texto.
jf\Base\String\TStringIterator	Trait que permite implementar la interfaz `Iterator` en una cadena de texto.
jf\Base\String\TStringable	Trait simple para implementar la interfaz `Stringable` devolviendo como texto el nombre dela clase.
jf\Base\TAssign	Permite asignar propiedades a una instancia a partir de un array.
jf\Base\TAssignExtras	Permite asignar propiedades a una instancia a partir de un array y almacenar aquellas que no pudieron asignarse.
jf\Base\TClass	Aporta algunos métodos y propiedades útiles para obtener el nombre de la clase y su espacio de nombres.
jf\Base\TDasherize	Aporta métodos para obtener el nombre de la clase y/o su espacio de nombre en formato `kebab-case`.
jf\Base\TId	Permite implementar la interfaz `jf\Base\IId`.
jf\Base\TOffset	Trait para calcular el offset en las clases que implementan `ArrayAccess` y aceptan el formato `[from:to]` para acceder a los valores.
jf\Base\TParent	Gestiona el acceso a una instancia padre.
jf\Base\TPascalize	Aporta un método para convertir un texto a formato `PascalCase`.
jf\Base\TSingleton	Contiene algunos métodos y propiedades útiles en las clases diseñadas como singleton.
jf\Base\TToArray	Serializa el contenido de la instancia iterando sobre todas las propiedades y analizando sus valores.

jf / base

Maintainers

Details