phpdoc almacenamiento

\almacenamiento

Clase de asistencia y utilidades para el almacenamiento de archivos.

Métodos

separarNombre($nombre) (estático)

Separa un nombre de archivo o ruta en sus componentes, devolviendo un objeto con las propiedades 'nombre', 'extension' y 'ruta'.

Parámetro	Tipo	Descripción	Opcional	Predeterminado
$nombre	string	Nombre de archivo a procesar.

Devuelve: object

limpiarNombre($nombre) (estático)

Limpia un nombre de archivos para remover caracteres especiales o riesgosos.

Parámetro	Tipo	Descripción	Opcional	Predeterminado
$nombre	string	Nombre a analizar.

Devuelve: string

obtenerNombreLibre($directorio[,$nombre]) (estático)

Reserva y devuelve un nombre de archivo libre. Devuelve solo el nombre de archivo, sin la ruta.

Parámetro	Tipo	Descripción	Opcional	Predeterminado
$directorio	string	Directorio de destino.
$nombre	string	Nombre propuesto.	Si	null

Devuelve: string

almacenarTemporal($contenido) (estático)

Almacena un archivo temporal y devuelve su nombre, o null.

Parámetro	Tipo	Descripción	Opcional	Predeterminado
$contenido	mixed	Contenido del archivo.

Devuelve: string

obtenerTamanoArchivo($ruta) (estático)

Devuelve el tamaño del archivo en MB.

Parámetro	Tipo	Descripción	Opcional	Predeterminado
$ruta	string	Ruta local.

Devuelve: float

obtenerTamanoTemporal($nombre) (estático)

Devuelve el tamaño de un archivo temporal en MB.

Parámetro	Tipo	Descripción	Opcional	Predeterminado
$nombre	string	Nombre del archivo temporal.

Devuelve: float

subirTemporal($archivo) (estático)

Mueve un archivo subido al directorio temporal y devuelve su nombre, o null.

Parámetro	Tipo	Descripción	Opcional	Predeterminado
$archivo	array	Elemento de $__FILES.

Devuelve: string

moverTemporalLocal($temporal,$nombre[,$destino,$mantenerCodificacion]) (estático)

Mueve un archivo temporal al almacenamiento local. Devuelve el nombre final, o null.

Parámetro	Tipo	Descripción	Opcional	Predeterminado
$temporal	string	Nombre del archivo temporal devuelvo por almacenarTemporal().
$nombre	string	Nombre de destino. Será sanitizado y se validará que sea único.
$destino	string	Ruta de destino. Por defecto, será la ruta configurada en rutaArchivos.	Si	null
$mantenerCodificacion	bool	Si es true, el archivo permanecerá codificado. En ese caso, será necesario utilizar obtenerArchivoLocal() para leer el mismo, o implementar un proxy que utilice enviarArchivoLocal() para enviar al cliente.	Si	false

Devuelve: bool

moverLocal($ruta,$nombre[,$destino,$codificar]) (estático)

Mueve un archivo al almacenamiento local. Devuelve el nombre final, o null.

Parámetro	Tipo	Descripción	Opcional	Predeterminado
$ruta	string	Ruta de origen.
$nombre	string	Nombre de destino. Será sanitizado y se validará que sea único.
$destino	string	Ruta de destino. Por defecto, será la ruta configurada en rutaArchivos.	Si	null
$codificar	bool	Si es true, el archivo será codificado. En ese caso, será necesario utilizar obtenerArchivoLocal() para leer el mismo, o implementar un proxy que utilice enviarArchivoLocal() para enviar al cliente.	Si	false

Devuelve: string

almacenarLocal($contenido,$nombre[,$destino,$codificar]) (estático)

Almacena un archivo en el almacenamiento local. Devuelve el nombre final, o null.

Parámetro	Tipo	Descripción	Opcional	Predeterminado
$contenido	mixed	Contenido del archivo.
$nombre	string	Nombre de destino. Será sanitizado y se validará que sea único.
$destino	string	Ruta de destino. Por defecto, será la ruta configurada en rutaArchivos.	Si	null
$codificar	bool	Si es true, el archivo será codificado. En ese caso, será necesario utilizar obtenerArchivoLocal() para leer el mismo, o implementar un proxy que utilice enviarArchivoLocal() para enviar al cliente.	Si	false

Devuelve: string

obtenerArchivoLocal($nombre[,$ruta,$decodificar]) (estático)

Devuelve el contenido de un archivo en el almacenamiento local, o null.

Parámetro	Tipo	Descripción	Opcional	Predeterminado
$nombre	string	Nombre del archivo.
$ruta	string	Ruta de origen. Por defecto, será la ruta configurada en rutaArchivos.	Si	null
$decodificar	bool	Decodifica un archivo almacenado mediante almacenarLocal(), moverLocal() o moverTemporalLocal().	Si	false

Devuelve: mixed

enviarArchivoLocal($nombre[,$ruta,$descargar,$decodificar]) (estático)

Envía un archivo desde el almacenamiento local al cliente. Devuelve null en caso de error.

Parámetro	Tipo	Descripción	Opcional	Predeterminado
$nombre	string	Nombre del archivo.
$ruta	string	Ruta de origen. Por defecto, será la ruta configurada en rutaArchivos.	Si	null
$descargar	bool	Si es true, enviará los encabezados para forzar la descarga del archivo.	Si	false
$decodificar	bool	Decodifica un archivo almacenado mediante almacenarLocal(), moverLocal() o moverTemporalLocal().	Si	false

Devuelve: mixed

mime($ruta[,$incluirCharset]) (estático)

Determina y devuelve el tipo MIME de un archivo a partir de su extensión.

Parámetro	Tipo	Descripción	Opcional	Predeterminado
$ruta	string	Ruta local.
$incluirCharset	bool	Incluye el juego de caracteres en la salida, si corresponde (tipos de texto plano).	Si	false

Devuelve: string