\Imagen

Permite trabajar con imágenes.

Requiere que la extensión de PHP GD esté habilitada.

Summary

Methods
Properties
Constants
crear()
abrir()
ancho()
alto()
cambiarAncho()
cambiarAlto()
cambiarTamanio()
liberar()
enviar()
No public properties found
TAMANIOXDEFECTO
METODO_REDIMENSION_RESIZE
METODO_REDIMENSION_RESAMPLE
No protected methods found
No protected properties found
N/A
No private methods found
No private properties found
N/A

Constants

TAMANIOXDEFECTO

TAMANIOXDEFECTO

Se usa para indicar que se debe aplicar un valor por defecto.

En la documentación de los métodos está detallado cómo se puede utilizar.

METODO_REDIMENSION_RESIZE

METODO_REDIMENSION_RESIZE

Constante usada en los métodos que redimensionan la imagen.

Indica que se debe usar una forma rápida, menos precisa.

METODO_REDIMENSION_RESAMPLE

METODO_REDIMENSION_RESAMPLE

Constante usada en los métodos que redimensionan la imagen.

Indica que se debe usar una forma más precisa, pero más lenta.

Methods

crear()

crear(\Configuracion  $configuracion, integer  $ancho, integer  $alto, callback  $renderer = null, array  $params = array()) : \Imagen

Crea una imagen del tamaño indicado, en formato true color.

La creación del contenido se delega a la función $renderer. Esta función debe recibir los siguientes parámetros:

$renderer(Configuracion $configuracion, resource $img, int $ancho, int $alto, array $params).
Si no se provee un valor o no es un nombre de función válido, se usa una por defecto. Los parámetros adicionales que necesite $renderer se pueden pasar en $params. La función por defecto puede recibir los valores listados a continuación. Todos son opcionales; para los que no están presentes se usa el parámetro de configuración indicado. - 'text': texto a mostrar; por defecto = imagen_def_generada_texto - 'fontsize': tamaño del texto; por defecto = imagen_def_generada_tam_fuente - 'bg': color de fondo en formato hexadecimal (RRGGBB); por defecto = imagen_def_generada_color_fondo - 'fg': color de frente en formato hexadecimal (RRGGBB); por defecto = imagen_def_generada_color_frente

Parameters

\Configuracion $configuracion
integer $ancho

el ancho de la imagen a crear; si es Imagen::TAMANIOXDEFECTO, se usa el valor del parámetro de configuración imagen_ancho_def

integer $alto

el alto de la imagen a crear; si es Imagen::TAMANIOXDEFECTO, se usa el valor del parámetro de configuración imagen_alto_def

callback $renderer

nombre de la función usada para crear el contenido de la imagen

array $params

parámetros extra para pasar a la función $renderer

Returns

\Imagen

la imagen creada, o false si hay un error, lo que ocurre si la extensión GD de PHP no está habilitada, o si $ancho, $alto no tienen valores válidos

abrir()

abrir(\Configuracion  $configuracion, string  $file, integer  $ancho = null, integer  $alto = null,   $metodo_redimensionado = self::METODO_REDIMENSION_RESAMPLE) : \Imagen

Abre y retorna una imagen desde el archivo <var>$file</var>.

Los parámetros $ancho y $alto permiten redimensionar la imagen.

  • Si los dos son nulos, se retorna en su tamaño original.
  • Si uno es nulo, se lleva esa dimensión al tamaño indicado, manteniendo la proporción original.
  • Si ninguno es nulo, se lleva la imagen al tamaño indicado, pudiendo cambiar su proporción.

Parameters

\Configuracion $configuracion
string $file

nombre del archivo

integer $ancho

ancho de la imagen a cargar si es Imagen::TAMANIOXDEFECTO, se usa el valor del parámetro de configuración imagen_ancho_def

integer $alto

el alto de la imagen a cargar; si es Imagen::TAMANIOXDEFECTO, se usa el valor del parámetro de configuración imagen_alto_def

$metodo_redimensionado

Returns

\Imagen

la imagen cargada, o false si hubo algún error

ancho()

ancho() : integer

Devuelve el ancho de la imagen.

Returns

integer

alto()

alto() : integer

Devuelve el alto de la imagen.

Returns

integer

cambiarAncho()

cambiarAncho(integer  $nuevo_ancho, integer  $metodo = self::METODO_REDIMENSION_RESAMPLE) 

Lleva la imagen al ancho indicado, ajustando el alto para mantener la proporción.

Parameters

integer $nuevo_ancho

el ancho al que se debe llevar la imagen; si es Imagen::TAMANIOXDEFECTO, se usa el valor del parámetro de configuración imagen_ancho_def

integer $metodo

método a usar para redimensionar; una de las constantes Imagen::METODOREDIMENSION*

Throws

\ExcepcionXGAP

si la instancia no es válida o ya fue liberada

cambiarAlto()

cambiarAlto(integer  $nuevo_alto, integer  $metodo = self::METODO_REDIMENSION_RESAMPLE) 

Lleva la imagen al alto indicado, ajustando el ancho para mantener la proporción.

Parameters

integer $nuevo_alto

el alto al que se debe llevar la imagen; si es Imagen::TAMANIOXDEFECTO, se usa el valor del parámetro de configuración imagen_alto_def

integer $metodo

método a usar para redimensionar; una de las constantes Imagen::METODOREDIMENSION*

Throws

\ExcepcionXGAP

si la instancia no es válida o ya fue liberada

cambiarTamanio()

cambiarTamanio(integer  $nuevo_ancho, integer  $nuevo_alto, integer  $metodo = self::METODO_REDIMENSION_RESAMPLE) 

Lleva la imagen al tamaño indicado.

Parameters

integer $nuevo_ancho

el ancho al que se debe llevar la imagen; si es Imagen::TAMANIOXDEFECTO, se usa el valor del parámetro de configuración imagen_ancho_def

integer $nuevo_alto

el alto al que se debe llevar la imagen; si es Imagen::TAMANIOXDEFECTO, se usa el valor del parámetro de configuración imagen_alto_def

integer $metodo

método a usar para redimensionar; una de las constantes Imagen::METODOREDIMENSION*

Throws

\ExcepcionXGAP

si la instancia no es válida o ya fue liberada

liberar()

liberar() 

Libera los recursos usados por la imagen.

Luego del llamado ya no se puede operar sobre esta instancia.

Throws

\ExcepcionXGAP

si la instancia no es válida o ya fue liberada

enviar()

enviar(boolean  $permitir_cache = false, string  $nombre_archivo = 'imagen') 

Envía la imagen al cliente, libera los recursos que ocupa y termina el script.

Parameters

boolean $permitir_cache

¿se deben enviar cabeceras HTTP para permitir el uso del cache del navegador o no?

string $nombre_archivo

nombre del archivo que se envía

Throws

\ExcepcionXGAP

si ya se enviaron las cabeceras HTTP, o si la instancia no es válida o ya fue liberada