dirBase()
dirBase() : string
Retorna el directorio base para los uploads.
Por defecto corresponde a la ruta absoluta de XGAP_CONF_UPLOAD_DIR, pero se puede cambiar mediante \cambiarDirBase().
Permite trabajar con un archivo subido mediante un campo de formulario.
prepararDir(string $dir)
Comprueba que el directorio <var>$dir</var> exista y tenga permiso de escritura.
Si no existe, intenta crearlo.
| string | $dir | el directorio a comprobar |
si el directorio no existe y no se puede crear
si el directorio no tiene permiso de escritura
prepararDirBase()
Comprueba que el directorio base exista y tenga permiso de escritura.
Si no existe, intenta crearlo.
si el directorio no existe y no se puede crear
si el directorio no tiene permiso de escritura
rutaAbsolutaUpload(string $archivo = null) : string
Retorna la ruta absoluta para un upload de la aplicación.
| string | $archivo | la ruta del archivo, relativa al {@link Upload::dirBase() directorio base}; si es vacío, el resultado es la ruta absoluta del directorio base |
__construct(string $nombre, string $dir_destino = null, boolean $dir_destino_relativo = null, boolean $sobreescribir = true)
Crea una instancia para un campo del formulario y directorio destino determinados.
No se debe intentar crear una instancia de esta clase si no se hizo el envío de un formulario con al menos un input de tipo file.
| string | $nombre | nombre del campo de formulario que corresponde al upload |
| string | $dir_destino | directorio destino del upload; si es null o vacío, se usa el directorio base |
| boolean | $dir_destino_relativo | ¿el directorio destino se debe tomar como relativo al {@link dirBase() directorio base}? si es true, se toma como subdirectorio del base; si es false, el base se ignora; si es null, se toma como relativo o no dependiendo de si $dir_destino no comienza o sí con DIR_SEP, respectivamente |
| boolean | $sobreescribir | ¿se debe sobreescribir el archivo en caso de existir en el directorio destino? |
si no está disponible la variable $_FILES o si no contiene una entrada con clave $nombre
linkArchivo(string $ruta_archivo, boolean $ruta_archivo_es_relativa = null) : string
Retorna la ruta de un link para acceder via web a un archivo cargado por esta clase.
| string | $ruta_archivo | la ruta del archivo (valor del campo de formulario). |
| boolean | $ruta_archivo_es_relativa | ¿la ruta del archivo se debe tomar como relativa al {@link dirBase() directorio base}? si es true, se toma como relativa al base; si es false, el base se ignora; si es null, se toma como relativa o no dependiendo de si $ruta_archivo no comienza o sí con DIR_SEP, respectivamente |
cambiarDirDestino(string $dir_destino = null, boolean $dir_destino_relativo = null)
Permite cambiar el directorio destino del upload.
| string | $dir_destino | nuevo directorio destino; si es null o vacío, se usa el directorio base |
| boolean | $dir_destino_relativo | ¿el directorio destino se debe tomar como relativo al {@link dirBase() directorio base}? si es true, se toma como subdirectorio del base; si es false, el base se ignora; si es null, se toma como relativo o no dependiendo de si $dir_destino no comienza o sí con DIR_SEP, respectivamente |
si el archivo ya {@link FormFileUpload::fueMovido() fue movido} a su destino
cambiarNombreArchivo(string $nombre_archivo)
Cambia el nombre que va a tener el archivo al subirlo al destino.
| string | $nombre_archivo | nombre del archivo destino; si es vacío se usa el nombre original; |
si el archivo ya {@link FormFileUpload::fueMovido() fue movido} a su destino
nombreArchivo() : string
Retorna el nombre destino para el archivo subido, sin incluir el directorio destino.
Se usa el nombre original, saneado para evitar problemas.
el nombre destino, o vacío si el upload no fue {@link esValido() válido}
moverADestino()
Mueve el archivo subido al directorio destino.
No tiene efecto si el usuario no hizo un upload o si hubo un error en éste; tampoco si se lo invoca más de una vez.
si el directorio destino no existe y no se puede crear
si el directorio destino no tiene permiso de escritura
si hay algún error al procesar el archivo subido
tipo() : string|false
Permite obtener el tipo de contenido MIME del archivo subido.
Requiere que esté cargada la extensión "fileinfo".
si hay un problema con el archivo subido
el tipo de contenido (ej: 'text/plain') si lo pudo detectar; false si por algún motivo no pudo o el upload no es válido
contenido(integer $desplazamiento = -1, integer $long_maxima = NULL) : string
Devuelve el contenido del archivo subido, como un string.
| integer | $desplazamiento | desplazamiento a partir del cual se debe empezar a leer el contenido |
| integer | $long_maxima | longitud máxima de datos a leer; por defecto se lee hasta el final del archivo |
si el upload es inválido
el contenido del archivo; FALSE si el upload no es válido o no se puede leer
contenidoLineas(boolean $incluir_fin_linea = TRUE, boolean $saltear_lineas_vacias = FALSE) : string
Devuelve el contenido del archivo subido, como un array de líneas.
| boolean | $incluir_fin_linea | ¿se debe incluir el fin de línea en cada elemento del array? |
| boolean | $saltear_lineas_vacias | ¿se deben saltear las líneas vacías? |
si el upload es inválido
el contenido del archivo; FALSE si el upload no es válido o no se puede leer
dirCondicional(string $dir, boolean $relativo = null) : string
Retorna el directorio terminado en el separador de directorios, posiblemente relativo al {@link dirBase() directorio base}.
Si $dir es relativo, el directorio devuelto es la concatenación de self::dirBase() y $dir; si es absoluto, es el propio $dir; si es vacío, es self::dirBase().
| string | $dir | |
| boolean | $relativo | ¿el directorio se debe tomar como relativo al {@link dirBase() directorio base}? si es true, se toma como subdirectorio del base; si es false, el base se ignora; si es null, se toma como relativo o no dependiendo de si $dir no comienza o sí con DIR_SEP, respectivamente |