XGAP - Generated Documentation (phpDocumentor 2)
\

\GeneradorBcompiler

Compila los fuentes de la aplicación usando la extensión PECL bcompiler.

Espera que exista un directorio con nombre DIR_APP_RESULTADOS dentro del directorio con los fuentes de la aplicación a generar, que tenga permiso de escritura por el usuario con que está ejecutando el servidor web.

Summary

Methods
Properties
Constants
__construct()
nombrePaso()
nombreCompletoArchivoResultado()
ejecutar()
duracionPaso()
linksParaAbrir()
esUsable()
causaNoUsable()
No public properties found
DIR_APP_RESULTADOS
EXTENSION_ARCHIVO_COMPILADO
existeArchivoAplicacion()
obtenerArchivoAplicacion()
generarCodigoParaVariables()
guardarResultado()
ejecutarInterno()
antesEjecutar()
despuesEjecutar()
$motor
$version_motor
$aplicacion
$dir_origen
$dir_origen_dir_sep_estandar
$dir_app_resultados
$parametros
N/A
No private methods found
No private properties found
N/A

Constants

DIR_APP_RESULTADOS

DIR_APP_RESULTADOS

EXTENSION_ARCHIVO_COMPILADO

EXTENSION_ARCHIVO_COMPILADO

Properties

$version_motor

$version_motor : string

Type

string

$aplicacion

$aplicacion : string

Type

string

$dir_origen

$dir_origen : string

Type

string

$dir_origen_dir_sep_estandar

$dir_origen_dir_sep_estandar : string

Contiene el mismo valor que <var>$this->dir_origen</var>, pero usando el separador de directorio estandarizado '/' (para usos donde no se permite '\'; por ejemplo, el procesador XSL no encuentra archivos cargados con document() si tienen '\' en el path (Windows)).

Type

string

$dir_app_resultados

$dir_app_resultados : string

Type

string

$parametros

$parametros : array

Type

array

Methods

__construct()

__construct(\MotorGeneracion  $motor, array  $parametros)

Parameters

\MotorGeneracion $motor
array $parametros

nombrePaso()

nombrePaso() : string

Devuelve el nombre del paso de generación.

Returns

string

nombreCompletoArchivoResultado()

nombreCompletoArchivoResultado(  $aplicacion, string  $nombre_arch)

Devuelve el path completo (relativo a APPS_DIR) de un archivo guardado con guardarResultado().

Parameters

$aplicacion
string $nombre_arch

el nombre del archivo

ejecutar()

ejecutar()

Realiza la ejecución del paso.

duracionPaso()

duracionPaso() : string

Devuelve el tiempo que demoró la ejecución del paso

Returns

string

linksParaAbrir()

linksParaAbrir() : \array[LinkResultado]

Devuelve un arreglo con los links que llevan a los resultados del paso.

Returns

\array[LinkResultado]

esUsable()

esUsable() : boolean

¿Este paso se puede usar?

Returns

boolean

causaNoUsable()

causaNoUsable() : string

Si el paso no es usable, retorna un string que indica la causa.

Caso contrario, retorna NULL.

Returns

string

existeArchivoAplicacion()

existeArchivoAplicacion() : boolean

Returns

boolean

obtenerArchivoAplicacion()

obtenerArchivoAplicacion() : \DOMDocument

Abre el archivo de definición de la aplicación y lo devuelve como un documento DOM.

Dispara una excepción ExcepcionXGAP si el archivo existe, pero no lo puede abrir.

Returns

\DOMDocument —

con los contenidos del archivo si existe, o vacío si no

generarCodigoParaVariables()

generarCodigoParaVariables(array  $variables)

Parameters

array $variables

guardarResultado()

guardarResultado(string  $nombre, string  $contenido) : string

Guarda un archivo con resultados de la generación.

Dispara una excepción si ocurre algún problema.

Parameters

string $nombre

nombre del archivo, relativo al directorio self::DIR_APP_RESULTADOS
string $contenido

contenido a colocar en el archivo

Returns

string —

el nombre del archivo, relativo a APPS_DIR

ejecutarInterno()

ejecutarInterno()

Implementación del cuerpo del paso de generación.

antesEjecutar()

antesEjecutar()

Método hook que se invoca antes de comenzar a ejecutar el paso.

La implementación por defecto está vacía.

despuesEjecutar()

despuesEjecutar()

Método hook que se invoca después de terminar de ejecutar el paso.

La implementación por defecto está vacía.