README

Generador de código PHP.

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/php-generator usando este manejador de paquetes se debe ejecutar:

composer require jf/php-generator

Dependencias

Cuando el proyecto es instalado, adicionalmente se instalan las siguientes dependencias:

Paquete	Versión
jf/assert	^3.1
jf/base	^4.0
jf/collection	^2.0
psr/log	^3.0

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/jfPhpGenerator.git
cd jfPhpGenerator
composer install

Archivos disponibles

Clases

Nombre	Descripción
jf\php\generator\ABase	Clase base para el resto de clases del proyecto.
jf\php\generator\Attribute	Representa un atributo de PHP.
jf\php\generator\ClassObject	Genera una clase.
jf\php\generator\Classname	Renderiza cada uno de los items que representan un nombre de clase.
jf\php\generator\EnumObject	Genera una enumeración.
jf\php\generator\Exception	Excepciones lanzadas por la aplicación.
jf\php\generator\File	Clase para manipular archivos.
jf\php\generator\Formatter	Clase con utilidades para manipular textos.
jf\php\generator\FunctionItem	Genera una función de PHP.
jf\php\generator\Generator	Clase para manipular archivos.
jf\php\generator\Helpers	Clase con métodos de ayuda para realizar diversas operaciones.
jf\php\generator\InterfaceObject	Genera una interfaz.
jf\php\generator\Method	Método de una clase.
jf\php\generator\Param	Parámetro de un método.
jf\php\generator\Property	Propiedad de una clase.
jf\php\generator\Tag	Representa una etiqueta para documentar un elemento.
jf\php\generator\Tags	Representa un grupo de etiquetas para documentar un elemento.
jf\php\generator\TraitItem	Renderiza cada uno de los items que representan un trait y que generan las sentencias `use XXXX;` en la definición de las clases.
jf\php\generator\TraitMethod	Representa un método de un trait que se usa y que debe ser renombrado para evitar una colisión.
jf\php\generator\TraitObject	Genera un trait.
jf\php\generator\Variable	Representa una variable PHP.
jf\php\generator\collection\ACollection	Clase base de las colecciones.
jf\php\generator\collection\Attributes	Colección de atributos.
jf\php\generator\collection\Classes	Colección de clases.
jf\php\generator\collection\Classnames	Colección de nombres de clases.
jf\php\generator\collection\Functions	Colección de funciones.
jf\php\generator\collection\Methods	Colección de métodos de una clase.
jf\php\generator\collection\Params	Colección de parámetros de un método o función.
jf\php\generator\collection\Properties	Colección de propiedades de una clase.
jf\php\generator\collection\TraitItems	Colección de traits que se agregan a un elemento.
jf\php\generator\collection\TraitMethods	Colección de traits que se agregan a una clases o trait.

Enumeraciones

Nombre	Descripción
jf\php\generator\ObjectType	Enumera los tipos de elementos que se pueden crear.

Interfaces

Nombre	Descripción
jf\php\generator\IAttributes	Interfaz para las clases que requieren gestionar los atributos.
jf\php\generator\IExtends	Interfaz para las clases que requieren gestionar los elementos de los que extiende la clase o interfaz.
jf\php\generator\IGenerator	Interfaz para los elementos que generan código tales como clases, enumeraciones, interfaces y traits.
jf\php\generator\IImplements	Interfaz para las clases que requieren gestionar los elementos que implementa la clase.
jf\php\generator\IMethods	Interfaz para las clases que requieren gestionar los métodos.
jf\php\generator\IParams	Interfaz para las clases que requieren gestionar los parámetros del método.
jf\php\generator\IProperties	Interfaz para las clases que requieren gestionar las propiedades.
jf\php\generator\ITraits	Interfaz para las clases que requieren gestionar los traits.
jf\php\generator\IUses	Interfaz para aquellas clases cuyo contenido que pueden hacer referencia a otros elementos en otros espacios de nombres.

Traits

Nombre	Descripción
jf\php\generator\TAttributes	Gestiona los atributos del elemento.
jf\php\generator\TCollectionItem	Trait para los elementos que se gestionan mediante las colecciones.
jf\php\generator\TDescription	Gestiona la descripción del elemento.
jf\php\generator\TDocDescription	Documenta el elemento agregando su descripción.
jf\php\generator\TDocTags	Gestiona las etiquetas PHPDoc del elemento.
jf\php\generator\TDocType	Documenta el tipo de datos de un elemento.
jf\php\generator\TExtends	Gestiona los elementos de los que extiende la clase o interfaz del elemento.
jf\php\generator\TFile	Trait para manipular archivos.
jf\php\generator\TGenerator	Trait para las clases que generan código de elementos tales como clases, enumeraciones, interfaces y traits.
jf\php\generator\TImplements	Gestiona los elementos que implementa la clase del elemento.
jf\php\generator\TMethods	Gestiona los métodos del elemento.
jf\php\generator\TModifiers	Modificadores de un elemento.
jf\php\generator\TName	Gestiona un nombre que puede pertenecer a un espacio de nombres y tener un alias.
jf\php\generator\TParams	Gestiona los parámetros del método del elemento.
jf\php\generator\TProperties	Gestiona las propiedades del elemento.
jf\php\generator\TTags	Gestiona las etiquetas PHPDoc del elemento.
jf\php\generator\TTraits	Gestiona los traits del elemento.
jf\php\generator\TTranslations	Trait para gestiona las traducciones de los textos.
jf\php\generator\TType	Gestiona el tipo de una variable, propieadad o parámetro.
jf\php\generator\TUses	Gestiona los elementos a importar.
jf\php\generator\TValue	Trait que gestiona el valor del elemento.
jf\php\generator\collection\TType	Trait para agregar un tipo por defecto en los elementos de algunas colecciones.

Scripts

scripts/_common.php

Funciones comunes para otros scripts.

Ver archivo scripts/_common.php.

scripts/add-to-generator.php

Agrega la configuración al archivo generator.yaml.

Ver archivo scripts/add-to-generator.php.

scripts/build-config.php

Construye el archivo generator.yaml analizando las clases de un directorio que todavía no lo tenga creado.

Ver archivo scripts/build-config.php.

scripts/coverage

Muestra por pantalla la cobertura de aquellas clases que no llegan al 100% usando la opción -p del visor.

Ver archivo scripts/coverage.

scripts/create-test

Genera los tests básicos a partir del análisis de una clase.

Ver archivo scripts/create-test.

scripts/generate

Genera el código fuente de todo los archivos del repositorio dentro de directorio src.

Ver archivo scripts/generate.

scripts/tests

Realiza pruebas exhaustivas cubriendo el 100% del código. La prueba más completa es la generación del código de todos los archivos del repositorio y comparando el resultado con el contenido del archivo actual.

Ver archivo scripts/tests.

jf / php-generator

Maintainers

Details