$nombre_constante
$nombre_constante
| iFirmaOperacion | Interfaz para clases que permiten realizar firma electrónica de operaciones. |
| iOperacion | Representa una operación que se puede realizar en una página de una aplicación XGAP. |
| iSeguridad | Define la interfaz que deben implementar la clase que provee la seguridad para una aplicación. |
| iSeguridadConexion | Interfaz que deben implementar las clases que proveen seguridad a conexiones a bases de datos. |
| iXgapPublicKeyInfrastructure | Interfaz que deben proveer las clases de soporte de Infraestructura de Clave Pública (PKI) en XGAP. |
| iXgapStoredPublicKeyInfrastructure | Interfaz que deben proveer las clases de soporte de Infraestructura de Clave Pública (PKI) en XGAP, que guardan en la aplicación las claves asociadas al usuario. |
| iXgapVarConvert | Interfaz para convertir una variable en otro formato. |
| AdministradorHistorial | AdministradorHistorial es la clase usada por el motor para manejar el historial de navegación. |
| AplicacionXgap | Provee métodos para operar con la aplicación generada. |
| Auditor | Auditor que escribe mensajes a un archivo. |
| AuditorBD | Auditor que guarda los mensajes en la base de datos. |
| BuscadorPersonalizadoSimple | Buscador personalizado simple para listados. |
| Calendario | Clase Calendario |
| Componentes | Contiene métodos estáticos que proveen definiciones de componentes o secciones de alto nivel de XGAP. |
| Conexion | Clase que implementa la capa de conexión con la base de datos. |
| Conexion_oci8 | Clase que implementa la capa de conexion con la base de datos Oracle. |
| Conexion_postgres8 | Clase que implementa la capa de conexion con la base de datos Postgres. |
| Configuracion | Provee métodos para trabajar con la configuración de la aplicación. |
| Contexto | Centraliza el manejo de variables asociadas a la sesión, manteniendo separadas las variables pertenecientes a diferentes aplicaciones de XGAP. |
| Csv | Esta clase se emplea para generar contenido CSV. |
| DescriptorPaginas | Provee métodos estáticos para operar con los descriptores de página. |
| DrawPDF | Clase para dibujar en un documento PDF. |
| ElementosPresentacion | Clase con métodos estáticos, que provee elementos de presentación para el motor. |
| EntradaHistorial | Representa un item en el historial de navegación, es decir, una página visitada. |
| EstructuraPagina | Clase EstructuraPagina |
| Excel | Esta clase se emplea para generar contenido Excel. |
| ExcepcionHistorialNavegacion | Clase ExcepcionHistorialNavegacion |
| ExcepcionXGAP | Clase base para excepciones disparadas por XGAP. |
| ExcepcionXGAPFirmaOperacion | Indica un problema durante el procesamiento de la firma de una operación. |
| ExcepcionXGAPInstanciacionFirmaOperacion | Indica un problema al crear una instancia de una clase que implementa {@link iFirmaOperacion}. |
| ExcepcionXGAPSeguridadFirmaOperacion | Indica un problema de seguridad al realizar el procesamiento de la firma de una operación. |
| ExcepcionXGAPUnserialize | Indica un error de deserialización de un valor. |
| ExcepcionXGAPUploadArchivo | Excepción para errores producidos al procesar archivos subidos. |
| ExcepcionXGAPUploadDir | Excepción base para indicar problemas con directorios al trabajar con uploads. |
| ExcepcionXGAPUploadDirNoCreable | Excepción que indica que no se pudo crear un directorio. |
| ExcepcionXGAPUploadDirNoEscribible | Excepción que indica que no se puede escribir en un directorio. |
| FirmaOperacion | Implementación base de {@link iFirmaOperacion}. |
| FirmaOperacionDefault | Implementación por defecto de {@link iFirmaOperacion}. |
| Flash | Permite pasar información entre un request y el siguiente, registrándola como pares (clave => valor). |
| Form | Clase Form |
| Formateo | Provee métodos estáticos para aplicar formateo a valores. |
| FormFileUpload | Permite trabajar con un archivo subido mediante un campo de formulario. |
| GeneradorBcompiler | Compila los fuentes de la aplicación usando la extensión PECL bcompiler. |
| GeneradorEsquema | Genera, en la subcarpeta metadatos de la aplicación, un archivo xml por cada tabla de la base que contiene los metadatos de todas las columnas |
| GeneradorTemplate | Genera, en la subcarpeta templates de la aplicación, los archivos xml de listado, formulario y master por cada tabla de la base |
| HistorialNavegacion | Implementa un historial de navegación, que permite mantener los URLs de las páginas visitadas. |
| Html | Provee métodos estáticos para trabajar con elementos XHTML 1.0 estricto. |
| Http | Esta clase provee métodos estáticos para trabajar con el protocolo HTTP. |
| Imagen | Permite trabajar con imágenes. |
| INIFile | Implementa toda la funcionalidad para trabajar con archivos .ini. |
| INIFileException | Clase base para excepciones disparadas por la clase INIFile. |
| INIFileOpenException | Excepción disparada por la clase INIFile para indicar un error en la apertura del archivo. |
| INIFileReadException | Excepción disparada por la clase INIFile para indicar un error en la lectura del archivo. |
| INIFileWriteException | Excepción disparada por la clase INIFile para indicar un error en la escritura del archivo. |
| Javascript | Provee métodos para construir código Javascript. |
| Json | Esta clase se emplea para trabajar con formato JSON. |
| LinkResultado | Contiene información sobre un link de resultado de la generación. |
| ListaMensajes | Representa una lista de objetos {@link ObjetoMensaje}. |
| Logger | Define un logger simple, que escribe mensajes en un archivo de texto. |
| Mensaje | Clase encargada de generar los diversos mensajes de la aplicación. |
| MensajeMotor | Describe un mensaje generado por el motor. |
| MotorGeneracion | Implementa el motor de generación de XGAP. |
| MotorPreparacion | Implementa el motor de preparación de generación de XGAP. |
| MultipleFormField | Clase auxiliar usada por los métodos de Form para generar un campo múltiple (uno que aparece múltiples veces en una página con el mismo nombre). |
| ObjetoMensaje | Representa un mensaje de la aplicación. |
| ODFXSLTProcessor | Holds an ODF-XSLT sylesheet and allows mutiple transformations to ODF using different XML documents |
| Operacion | Representa una operación que se puede realizar en una página de una aplicación XGAP. |
| OperacionAgregar | Representa la operación de Agregar en un formulario. |
| OperacionBorrar | Representa la operación de Borrar en un formulario. |
| OperacionEditar | Representa la operación de Editar (guardar cambios de edición) en un formulario. |
| OperacionFormulario | Representa una operación que se realiza en un formulario. |
| Pagina | Estado y comportamiento adicional para una página de la aplicación. |
| PasoGeneracion | Define la interfaz que debe proveer un paso del proceso de generación. |
| ProcesadorDefiniciones | Implementa el procesamiento de los archivos XML de definiciones y la generación de las páginas a partir de ellos. |
| Recursos | Provee acceso centralizado a recursos de la aplicación. |
| Request | Provee métodos para acceder al request. |
| RequestXgap | Provee acceso al request específico para XGAP. |
| Seguridad | Clase que provee la funcionalidad de seguridad de la aplicación. |
| SeguridadConexion | Clase que provee funcionalidad de seguridad en conexiones a la base de datos. |
| SeguridadConexionBase | Clase base para proveer funcionalidad de seguridad en conexiones a la base de datos. |
| SimpleChart | Clase SimpleChart. |
| SmtpEmail | Clase que permite el envío de correo electrónico vía SMTP. |
| Tabla | Provee métodos estáticos para trabajar con tablas HTML. |
| Tooltips | Clase destinada al manejo de tooltips en las páginas. |
| Upload | Clase base para manejo de uploads. |
| Validacion | Provee métodos para validar valores. |
| ValidadorDefiniciones | Implementa la validación de la estructura de los archivos XML de definiciones. |
| VerificadorVersion | Permite trabajar con la versión correcta del motor de acuerdo a la configuración de la aplicación. |
| Webservice | Clase Webservice |
| WsInfo | Clase WsInfo |
| XgapBarChart | Gráfico de barras |
| XgapClassLoader | Autocarga de clases e interfaces provistas por XGAP. |
| XgapCsrf | Provee métodos de protección contra ataques de tipo CSRF. |
| XgapDefaultOpenSslPublicKeyInfrastructure | Clase base para manejar Infraestructura de Clave Pública (PKI) usando OpenSSL y claves guardadas en formato PEM. Implementación por defecto que guarda la información en una estructura predefinida de la base de datos, por lo cual requiere una conexión. |
| XgapFunctionNotImplementedException | Indica que una función de XGAP está definida pero no implementada. |
| XgapGenericFactory | Fábrica genérica de objetos. Puede crear instancias de cualquier clase dada. |
| XgapGenericFactoryException | Excepción disparada por {@link XgapGenericFactory}. |
| XgapIllegalStateException | Indica que se invocó un método o función en un momento inapropiado, en el que la aplicación no puede realizarlo. |
| XgapMethodNotImplementedException | Indica que un método de XGAP está definido pero no implementado. |
| XgapMultipleBarChart | Gráfico de barras múltiples. |
| XgapNotImplementedException | Excepción base para elementos o comportamientos definidos pero no implementados en XGAP. |
| XgapODFXSLTProcessorExt | Extensiones a la clase ODFXSLTProcessor. |
| XgapOpenSslPublicKeyInfrastructure | Clase base para manejar Infraestructura de Clave Pública (PKI) usando OpenSSL y claves guardadas en formato PEM. |
| XgapPublicKeyInfrastructure | Clase base para manejar Infraestructura de Clave Pública (PKI). |
| XgapPublicKeyInfrastructureCheckException | Indica que una clave no tiene un formato reconocido. |
| XgapPublicKeyInfrastructureException | Indica un problema en una operación de la infraestructura de clave pública provista por XGAP. |
| XgapPublicKeyInfrastructureInstantiationException | Indica un error al crear una instancia. |
| XgapPublicKeyInfrastructureKeyMismatchException | Indica que la clave privada y la pública/certificado no se corresponden entre sí. |
| XgapPublicKeyInfrastructureKeyUnavailableException | Indica que se intentó realizar una operación que requiere una clave que no ha sido cargada. |
| XgapPublicKeyInfrastructureLoadException | Indica un problema al cargar una clave. |
| XgapPublicKeyInfrastructureMissingInfoException | Indica que no se contó con toda la información necesaria para realizar una operación. |
| XgapPublicKeyInfrastructureOperationException | Indica un problema genérico al realizar una operación. |
| XgapPublicKeyInfrastructureOwnerMismatchException | Indica el usuario asociado al objeto no corresponde con el asociado a la clave o certificado en el sistema. |
| XgapPublicKeyInfrastructureUnavailableException | Indica que una clase u operación no está disponible para usar. |
| XgapRand | Provee métodos para trabajar con valores pseudo-aleatorios. |
| XgapTableArray | Provee métodos para operar con arrays tratándolos como tablas de datos. |
| XgapVarConvertExported | Codifica variables PHP usando {@link var_export()}. |
| XgapVarConvertJson | Codificación de variables PHP en formato JSON. |
| XgapVarConvertSerialize | Codifica variables PHP en {@link serialize() formato serializado}. |
| XgapVarConvertXml | Codificación de variables PHP en formato XML. |
| XgapVarConvertXmlDecodeParser | Clase auxiliar para XgapVarConvertXml. |
| XgapXml | Provee métodos para trabajar con XML. |
| XgapXmlArray | Permite construir arrays en el formato esperado por {@link XgapXml::arrayToString()}. |
XGAP_VERSION_MOTOR
Número de versión del motor.
Esquema:
2.x.y.z ^ ^ ^ ^ | | | +- Revisión | | +--- Versión menor | +----- Versión mayor +------- Versión principal
agregarParametrosAUrl(string $url, array $parametros = array(), boolean $escapar_caracteres = true) : string
Agrega parámetros al final de un URL.
| string | $url | |
| array | $parametros | |
| boolean | $escapar_caracteres | ¿se deben traducir a entidades HTML los caracteres que tengan una traducción? |
array_tiene_vacios(array $arr, boolean $cero_es_vacio, boolean $trim, boolean $recursivo) : boolean
Permite comprobar si un array tiene al menos un valor vacío.
| array | $arr | el array a comprobar |
| boolean | $cero_es_vacio | ¿el cero se considera vacío? Tiene en cuenta tanto 0 (numérico) como '0' (string) |
| boolean | $trim | ¿recortar los blancos en los extremos de los valores, en caso que sean de tipo string? |
| boolean | $recursivo | ¿se deben comprobar recursivamente los subarrays? |
true si ningún valor dentro de $arr es vacío
array_vacio(array $arr, boolean $cero_es_vacio, boolean $trim, boolean $recursivo) : boolean
Permite comprobar si un array tiene solamente valores vacíos.
| array | $arr | el array a comprobar |
| boolean | $cero_es_vacio | ¿el cero se considera vacío? Tiene en cuenta tanto 0 (numérico) como '0' (string) |
| boolean | $trim | ¿recortar los blancos en los extremos de los valores, en caso que sean de tipo string? |
| boolean | $recursivo | ¿se deben comprobar recursivamente los subarrays? |
true si todos los valores de $arr son vacíos
color_hexrgb(string $strcolor) : array
Parsea un color RGB dado como un string en formato hexadecimal (RRGGBB) y devuelve sus componentes.
Por ejemplo:
$rgb = color_hexrgb('0369CF');
// $rgb == array(0x03, 0x69, 0xCF) -- R: 3, G: 105, B: 207
| string | $strcolor |
un array con los tres componentes R, G y B en ese orden, o false si $strcolor no representa un color válido
color_rgb(string $strcolor) : array
Parsea un color RGB dado como un string con valores decimales separados por comas (r,g,b) y devuelve sus componentes.
Los componentes deben estar este 0 y 255.
Por ejemplo:
$rgb = color_rgb('6,96,192');
// $rgb == array(6, 96, 192) -- R: 6, G: 96, B: 192
| string | $strcolor | el valor a parsear; puede haber blancos entre los números y las comas |
un array con los tres componentes R, G y B en ese orden, o false si $strcolor no representa un color válido
copyr(string $source, string $dest, mixed $directory_mask = 493, mixed $file_mask = 384, string $dir_sep = '/', array $skip = array('.', '..', '.svn', 'CVS', '.cvsignore', '.git', '.gitignore'), $skip_paths = array()) : boolean
Copia a $dest los contenidos del árbol de directorios con raíz en $source.
| string | $source | directorio origen |
| string | $dest | directorio destino; se crea si no existe |
| mixed | $directory_mask | |
| mixed | $file_mask | |
| string | $dir_sep | |
| array | $skip | nombres de archivos y directorios a ignorar; no se tiene en cuenta la ruta, es decir que se ignoran en cualquier rama del árbol |
| $skip_paths |
resultado de la operación
crearDireccionPagina(string $pagina, array $parametros = array(), boolean $escapar_caracteres = true, string $relativa_a = null, boolean $convertir_booleanos = false, boolean $es_interno = true) : string
Crea la dirección de una página para usar en links.
Si la dirección es interna y la página actual es simple, la dirección creada incluye el parámetro
PARAMETRO_ESTRUCTURA_PAGINA_SIMPLE = 'true', a menos que éste ya esté incluido en $parametros.| string | $pagina | nombre de la pagina; por ejemplo 'index.php' |
| array | $parametros | arreglo de parámetros GET a incluir en la dirección;
sus valores también pueden ser arrays; |
| boolean | $escapar_caracteres | ¿se deben traducir a entidades HTML los caracteres que tengan una traducción? |
| string | $relativa_a | ruta respecto a la cual es relativa $pagina; por ejemplo, APP_ROOT |
| boolean | $convertir_booleanos | ¿se deben convertir los valores booleanos en $parametros en las cadenas 'true' y 'false'? |
| boolean | $es_interno | ¿la dirección lleva a una página interna a la aplicación? |
direccionAbsolutaPagina( $pagina) : string
Devuelve la dirección absoluta de <var>$pagina</var>.
Si $pagina ya contiene una dirección absoluta (comienza en '/'), la retorna sin modificaciones.
Asume que $pagina es relativa a la página actual y que contiene sólo una ruta, no un URL completo.
| $pagina | nombre de la página; por ejemplo 'index.php' o 'subdir/index.php' |
la dirección absoluta; por ejemplo '/aplicacion/index.php'
direccionSinConsulta(string $direccion) : string
Devuelve la dirección dada, sin la parte de la consulta, si la tuviera.
Ejemplos:
direccionSinConsulta('/localhost/index.php');
// == '/localhost/index.php'
direccionSinConsulta('/localhost/index.php?x=0&y=0');
// == '/localhost/index.php'
| string | $direccion |
empty2(mixed $v, boolean $cero_es_vacio = false, boolean $trim = false) : boolean
Permite determinar si una variable se considera vacía.
Esta función tiene semántica similar a \empty() de PHP estándar, pero provee algo de flexibilidad para definir lo que se considera vacío.
| mixed | $v | el valor a comprobar |
| boolean | $cero_es_vacio | ¿el cero se considera vacío? Tiene en cuenta tanto 0 (numérico) como '0' (string) |
| boolean | $trim | ¿recortar los blancos de los extremos, en caso que $v sea un string? |
ereg_multi(mixed $patterns, string $string) : mixed
Tiene el mismo comportamiento y valores de retorno que {@link ereg()}, pero si <var>$patterns</var> es un array, hace match en <var>$string</var> con cualquiera de sus elementos.
| mixed | $patterns | patrones a buscar |
| string | $string | el string donde se va a buscar |
la longitud del match o false
esDireccionInterna(String $direccion) : boolean
Permite comprobar si una dirección dada es interna a la aplicación.
Las reglas que sigue son:
| String | $direccion |
extraer_directorio_pagina(string $pagina = null) : string
Retorna la ruta de una página, excluyendo la propia página; es decir, retorna el directorio.
Si $pagina es vacío, retorna la ruta de la página actual.
Ejemplos:
extraer_directorio_pagina('recurso') == extraer_directorio_pagina('pagina.php') == '';
extraer_directorio_pagina('/dir/') == '/dir';
extraer_directorio_pagina('/dir/pagina.php') == '/dir';
extraer_directorio_pagina('http://localhost/dir1/dir2/dir3/recurso') == '/dir1/dir2/dir3';
| string | $pagina |
el directorio de la página sin '/' final (excepto que el directorio sea '/')
find_classes_in_dir(string $dir, boolean $recursive = TRUE, array $php_file_extensions = array('.php'), array $exclude_filenames = array('CVS', '.svn', '.git', '.bzr', '.hg', '_darcs', 'RCS', 'SCCS')) : array
Retorna una lista con todos los nombres de clases, interfaces y traits definidos dentro de un directorio.
El resultado es un array con la estructura:
array(
'class' => array(
array(
'name' => '{nombre de la clase}'
'file' => '{nombre del archivo que la define}'
),
// ...
),
'interface' => array(
array(
'name' => '{nombre de la interfaz}'
'file' => '{nombre del archivo que la define}'
),
// ...
),
'trait' => array(
array(
'name' => '{nombre del trait}'
'file' => '{nombre del archivo que lo define}'
),
// ...
)
)
| string | $dir | directorio a buscar |
| boolean | $recursive | ¿buscar en subdirectorios? |
| array | $php_file_extensions | extensiones de archivos que pueden contener código PHP |
| array | $exclude_filenames | nombres de archivo a excluir en la búsqueda, por coincidencia exacta |
si $dir no es un directorio
info_tipos_pagina_xgap() : array
Retorna un array con información sobre los tipos de página definidos por XGAP.
La estructura que retorna tiene la forma:
array(
$nombre => array( // clave: [string] Nombre del tipo
'descripcion' => $descripcion, // [string] Descripción del tipo
'sufijo' => $sufijo, // [string] Sufijo de los archivos generados para este tipo
'es-html' => $es_html // [boolean] ¿la página genera salida HTML?
'acciones' => array( // Lista de acciones definidas en el tipo
$nombre_accion => array(
'descripcion' => $descripcion_accion // [string] Descripción de la acción
),
...
)
),
...
)
si no se puede cargar la información
limpiar_vacios_array(array $array, boolean $trim = false) : array
Elimina del array dado todas las entradas con valor vacío.
Los valores vacíos se determinan usando \empty().
| array | $array | |
| boolean | $trim | ¿las cadenas compuestas por blancos se deben considerar vacías? |
matrix_2d_transpose(array $matrix) : array
Transpone una matriz bidimensional, es decir, intercambia los índices de sus filas y columnas.
Ejemplo:
$m = array(
array('a' => 'a0', 'b' => 'b0', 'c' => 'c0'),
array('a' => 'a1', 'b' => 'b1', 'c' => 'c1'),
array('a' => 'a2', 'b' => 'b2', 'c' => 'c2'),
array('a' => 'a3', 'b' => 'b3', 'c' => 'c3'),
array('a' => 'a4', 'b' => 'b4', 'c' => 'c4')
);
$m1 = matrix_2d_transpose($m);
// $m1 === array(
// 'a' => array(0 => 'a0', 1 => 'a1', 2 => 'a2', 3 => 'a3', 4 => 'a4'),
// 'b' => array(0 => 'b0', 1 => 'b1', 2 => 'b2', 3 => 'b3', 4 => 'b4'),
// 'c' => array(0 => 'c0', 1 => 'c1', 2 => 'c2', 3 => 'c3', 4 => 'c4')
// )
También se puede usar aunque no todas las celdas tengan valores.
Ejemplo:
$m = array(
array('a' => 'a0'),
array('a' => 'a1', 'c' => 'c1'),
array('c' => 'c2'),
array('a' => 'a3', 'b' => 'b3', 'c' => 'c3'),
array()
);
$m1 = matrix_2d_transpose($m);
// $m1 === array(
// 'a' => array(0 => 'a0', 1 => 'a1', 3 => 'a3'),
// 'b' => array(3 => 'b3'),
// 'c' => array(1 => 'c1', 2 => 'c2', 3 => 'c3')
// )
| array | $matrix | la matriz original |
si $matrix no corresponde a una matriz válida, es decir, si no es un array o alguno de sus elementos no es un array
la matriz transpuesta
mostrar_mensaje(\MensajeMotor $msj, integer $pos)
| \MensajeMotor | $msj | |
| integer | $pos |
nombre_archivo_saneado(string $archivo) : string
Ajusta un nombre de archivo para que sólo contenga caracteres dentro del conjunto [a-zA-Z0-9._-].
Translitera algunos caracteres para llevarlos a la representación más similar dentro del conjunto aceptado; por ejemplo, lleva las vocales acentuadas a la vocal sin acento correspondiente, 'ñ' a 'n' y 'ç' a 'c'. Convierte en '_' los caracteres restantes.
Además se asegura que no empiece ni termine en puntos ni espacios.
| string | $archivo | el nombre de archivo a sanear; debe ser sólo el nombre sin ruta (caso contrario, los separadores de directorio se van a transformar en '_') |
el nombre saneado
obtener_listado_archivos(string $dir, string $extension = 'xml', integer $timestamp_minimo, string $excluir = null) : array
Lista todos los archivos en un directorio que tienen la extensión dada en <var>$extension</var>.
Esta función no escanea los subdirectorios.
| string | $dir | nombre del directorio a listar |
| string | $extension | extensión de los archivos a devolver; no se admite un valor vacío |
| integer | $timestamp_minimo | timestamp (unix) que debe superar la fecha de última modificación de un archivo para que se incluya entre los devueltos |
| string | $excluir | expresión regular que indica patrones de nombres que se deben excluir del resultado; no tiene en cuenta mayúsculas y minúsculas |
nombres de los archivos dentro de $dir que cumplen las condiciones
obtener_listado_archivos_por_patron(string $dir, string $patron = 'xml', string $excluir = null, boolean $case_sensitive = false) : array
Lista todos los archivos en un directorio que tienen el patrón de nombre dado.
Esta función no escanea los subdirectorios.
Los parámetros $patron y $excluir deben ser expresiones regulares PCRE que no incluyan delimitadores ni el caracter '/'.
| string | $dir | nombre del directorio a listar |
| string | $patron | expresion regular que define los archivos a filtrar |
| string | $excluir | expresión regular que indica patrones de nombres que se deben excluir del resultado |
| boolean | $case_sensitive | ¿se deben tener en cuenta mayúsculas y minúsculas en los nombres de archivo? |
nombres de los archivos dentro de $dir que cumplen las condiciones
param2boolean(mixed $param) : boolean
Permite convertir un valor dado en un booleano, de acuerdo a las siguientes reglas:
| mixed | $param | valor a convertir |
$param transformado en un valor booleano
parametrosParaPasar(string $excluidos = PARAMS_EXCLUIDOS_POR_DEFECTO, boolean $quitar_entidad = false) : array
Genera y devuelve un arreglo con los parámetros en <var>$_REQUEST</var>, excluyendo los indicados en <var>$excluidos</var> y los que contienen 'PHP' en el nombre.
| string | $excluidos | lista separada por espacios de los nombres de los parámetros a excluir |
| boolean | $quitar_entidad |
preparar_array_salida(array $str_arr, array $tags_permitidos = array(), string $compactar_blancos = null, boolean $traducir_html = false, boolean $traducir_extras = true)
Prepara un array de strings para salida a una página, de la misma manera que {@link preparar_salida()} lo hace con strings individuales.
$str_arr es el array a preparar, que queda modificado luego del llamado. Los parámetros restantes son iguales que los correspondientes en preparar_salida().
| array | $str_arr | strings a preparar |
| array | $tags_permitidos | un arreglo que indica los nombres de los tags HTML que se deben dejar intactos en $str; un arreglo vacío indica que se deben eliminar todos los tags; un valor nulo indica que se deben dejar pasar todos; por ejemplo: array('img','a','br') deja pasar imágenes, links y saltos de línea |
| string | $compactar_blancos | especifica un string por el que se deben reemplazar las secuencias de blancos consecutivos; un valor nulo indica que los blancos se deben dejar intactos; por ejemplo: $str = " a b\t\t\tc\nd", $compactar_blancos = ' ' --> resultado = " a b c d" |
| boolean | $traducir_html | ¿se deben traducir a entidades los caracteres contemplados por {@link htmlspecialchars()}? Si $str contiene código HTML, este parámetro debe ser false |
| boolean | $traducir_extras | ¿se deben traducir a entidades los caracteres contemplados por {@link htmlentities()}, exceptuando los contemplados por {@link htmlspecialchars()}? |
preparar_parametros_imagen(string $params, $img, $ancho, $alto, $x, $y)
Extrae los parámetros para una imagen de un string dado en un formato espeecífico.
Parsea los parámetros dados en $params y los devuelve en $img, $ancho, $alto, $x y $y.
Los parámetros que no estén definidos o sean inválidos quedan con valor null.
El formato esperado de $params es:
{nombreimagen}&{ancho}x{alto}@{x}x{y}. Cualquier parámetro puede faltar, excepto el nombre de la imagen. Ejemplos: - 'img/milogo.png' --> $img='img/milogo.png', $ancho=$alto=$x=$y=null| string | $params | parámetros de la imagen |
| $img | ||
| $ancho | ||
| $alto | ||
| $x | ||
| $y |
propiedad_plantilla(string $tipo, string $variedad, string $propiedad, string $grupo = 'variedades') : mixed
Permite obtener un valor de una definición de plantilla.
| string | $tipo | tipo de plantilla ('listado', 'formulario', ...) |
| string | $variedad | nombre de la variedad dentro del tipo |
| string | $propiedad | nombre de la propiedad a obtener |
| string | $grupo | grupo de plantillas dentro del tipo ('variedades', 'extras') |
recuperarParametrosComoOcultos(string $excluidos = PARAMS_EXCLUIDOS_POR_DEFECTO_LISTADO_SELECCION) : string
Retorna un string con código HTML que define campos hidden para todas las variables que están en $_REQUEST cuyo nombre no aparece en $excluidos y no contiene la cadena 'PHP'.
| string | $excluidos | lista separada por espacios de los nombres de los parámetros a excluir |
ruta_archivo(array $componentes, string $dir_sep = DIR_SEP, boolean $separador_dir_final = false) : string
Retorna una ruta de archivo construida a partir de sus componentes.
Los componentes pueden representar subrutas, como por ejemplo 'r2/r3/r4'.
Es indistinto que los componentes empiecen o terminen con el separador de directorios,
dado que la ruta final va a contener los componentes separados por un único separador.
La excepción es el primer componente, en el que se respeta la existencia o no
de separador inicial.
Ejemplos:
ruta_archivo(DIR_SEP) == ruta_archivo(array(DIR_SEP)) == DIR_SEP;
ruta_archivo(array('a', 'b', 'c.txt'), '/', false) == 'a/b/c.txt';
ruta_archivo(array('a', 'b', 'c'), '/', true) == 'a/b/c/';
ruta_archivo(array('/a', '/b/c/d/', '/archivo.txt'), '/', false) == '/a/b/c/d/archivo.txt';
| array | $componentes | los componentes de la ruta, dados en el orden del arreglo |
| string | $dir_sep | el separador de directorios a usar |
| boolean | $separador_dir_final | ¿la ruta devuelta debe terminar en el separador de directorios? |
si alguno de los componentes, a excepción del primero, es vacío, contiene sólo espacios o sólo separadores de directorio
la ruta, o el string vacío si $componentes está vacío
str_istarts_with(string $haystack, string $needle) : boolean
Permite comprobar si un string empieza con otro, sin tener en cuenta mayúsculas/minúsculas.
| string | $haystack | string donde se debe buscar |
| string | $needle | string a buscar al principio de $haystack |
strpos_multi(string $haystack, mixed $needles) : array|false
Tiene el mismo comportamiento y valores de retorno que {@link strpos()}, pero si <var>$needles</var> es un array, compara con cada uno de sus elementos hasta que encuentra una coincidencia.
Ejemplo:
strpos_multi('abdefgh', array('cf', 123, 'efg')) == array(2, 3)
| string | $haystack | el string donde se va a buscar |
| mixed | $needles | valores a buscar |
Si ningún valor de $needles coincide con $haystack, devuelve false. Si alguno coincide, devuelve un array con dos valores; el primero es la clave del elemento de $needles que coincidió; el segundo es la posición de $haystack donde empezó la coincidencia.
strptime2(string $valor, boolean $incluye_tiempo, $incluye_segundos = false) : array
Reemplazo de la función estándar {@link strptime()} de PHP.
La función \strptime() de PHP sólo está disponible a partir de PHP 5.1, y no en Windows. Esta función es un reemplazo específico para las necesidades del sistema.
| string | $valor | |
| boolean | $incluye_tiempo | ¿$valor incluye la hora? |
| $incluye_segundos |
si la fecha no tiene el formato correcto
ver valor de retorno de {@link strptime()}
tipo_pagina(string $pagina) : string
Devuelve el tipo de una página. El tipo es el valor de la constante <var>XGAP_TIPO_PAGINA</var> en esa página.
| string | $pagina | dirección de la página; puede o no incluir ruta y/o cadena de consulta |
si hay un error al leer el archivo descriptor de seguridad (XGAP_ARCHIVO_DESCRIPCION_SEGURIDAD)
el tipo de $pagina; si no corresponde a un tipo conocido, devuelve null
uniformizar_separadores_directorio(string $ruta, string $dir_sep = DIR_SEP) : string
Asegura que todos los separadores de directorio en <var>$ruta</var> sean <var>$dir_sep</var>.
El resultado es $ruta, con las secuencias del separador alternativo por reemplazadas por $dir_sep, es decir, '+' por '/' o '/+' por '\'.
Si $dir_sep no es '/+' o '+', retorna $ruta sin modificar.
| string | $ruta | la ruta a uniformizar |
| string | $dir_sep | el separador de directorios a usar |
unserialize_with_exception(string $serialized) : mixed
Intenta deserializar un valor con {@link unserialize() unserialize()} y dispara una excepción si se produce un error.
| string | $serialized | valor a deserializar |
si la deserialización falla
el resultado de la deserialización
urlCompletoPagina(string $pagina, string $servidor = null, string $protocolo = 'http://', integer $puerto = null) : string
Devuelve el URL completo de <var>$pagina</var>, incluyendo el servidor y opcionalmente el protocolo y el puerto.
Si $pagina es una dirección relativa, la convierte en absoluta asumiendo que es relativa a la página actual.
| string | $pagina | ruta de la página |
| string | $servidor | nombre del servidor, por ejemplo 'localhost' o 'www.servidor.net'; si es nulo o la cadena vacía, se usa el {@link Request::host() servidor de la aplicación} |
| string | $protocolo | protocolo del url; si es vacío o nulo, no se incluye |
| integer | $puerto | número de puerto; es vacío o no es un número entero positivo, se usa el {@link Request::puerto() puerto} del servidor de la aplicación |
urlCompletoServidor(string $servidor = null, string $esquema = null, integer $puerto = null, boolean $incluir_esquema = true) : string
Retorna el URL completo de un servidor, en la forma `$esquema://$servidor:$puerto`.
El esquema sólo se incluye si $incluir_esquema. El puerto sólo se incluye si no es el estándar para el esquema.
Ejemplos:
urlCompletoServidor('localhost', 'http', '8000');
// == http://localhost:8000
urlCompletoServidor('www.servidor.net', 'https', '443', true);
// == https://www.servidor.net
urlCompletoServidor('www.servidor.net', 'https', '443', false);
// == www.servidor.net
| string | $servidor | nombre del servidor, por ejemplo 'localhost' o 'www.servidor.net'; si es nulo o la cadena vacía, se usa el {@link Request::host() servidor de la aplicación} |
| string | $esquema | el esquema a usar: 'http' o 'https'; si es vacío, se usa el {@link Request::esquema() esquema del request}; notar que aunque no se incluya en el resultado, se usa para determinar si el puerto es el estándar para el esquema |
| integer | $puerto | número de puerto; es vacío o no es un número entero positivo, se usa el {@link Request::puerto() puerto} del servidor de la aplicación |
| boolean | $incluir_esquema | ¿se debe incluir el esquema en el resultado? |
xgap_array_insert( $array, integer $position, array $insert_array)
Inserta un array en una posición dada de otro.
| $array | ||
| integer | $position | posición de inserción; si es mayor o igual que la longitud de $array, agrega al final |
| array | $insert_array | array a insertar; si no se pasa un array, se crea uno conteniendo el valor de este parámetro |
xgap_convert_encoding(mixed $value, array|string $from_encoding, string $to_encoding) : mixed
Convierte la codificación de caracteres de un valor.
| mixed | $value | valor a convertir |
| array|string | $from_encoding | lista de posibles codificaciones que puede tener $value, dada como un array o un string de nombres separados por comas |
| string | $to_encoding | codificación destino |
si no se puede realizar la conversión
$value convertido en la codificación $to_encoding
xgap_convert_encoding_to_internal(mixed $value, array|string $value_encoding = 'UTF-8, ASCII, ISO-8859-1') : mixed
Convierte la codificación de caracteres de un valor a la interna de PHP.
| mixed | $value | valor a convertir |
| array|string | $value_encoding | lista de posibles codificaciones que puede tener $value, dada como un array o un string de nombres separados por comas |
si no se puede realizar la conversión
$value convertido en la codificación interna
xgap_convert_encoding_to_utf8(mixed $value, array|string $value_encoding = '') : mixed
Convierte la codificación de caracteres de un valor a UTF-8.
| mixed | $value | valor a convertir |
| array|string | $value_encoding | lista de posibles codificaciones que puede tener $value, dada como un array o un string de nombres separados por comas |
si no se puede realizar la conversión
$value convertido en la codificación UTF-8
xgap_get_remote_file_contents(string $url, $offset = -1, array $options = array()) : mixed
Retorna el contenido de un archivo remoto.
Requiere que esté habilitada la extensión cURL o que el parámetro de configuración de PHP allow_url_fopen sea true.
| string | $url | la dirección del archivo a obtener |
| $offset | ||
| array | $options | array de opciones XGAP_GET_REMOTEOPT* |
si hay un error durante la operación. El {@link ExcepcionXGAP::getCode() código} es 0 si el error se produce al obtener el archivo, o 1 si no hay un método disponible para realizar la obtención.