Skip to content
This repository has been archived by the owner on Oct 10, 2023. It is now read-only.

phpdoc util

Gabriel edited this page Jun 12, 2021 · 20 revisions

\util

Clase de utilidades.

Métodos

separarRuta($ruta) (estático)

Separa una cadena en un objeto con las propiedades 'nombre' y 'ruta' equivalentes a basename() y dirname() respectivamente pero en forma independiente del sistema de archivos local y admitiendo únicamente / como separador. Nota: No limpia la cadena de entrada.

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

Devuelve: object

limpiarValor($cadena[,$admiteBarra,$admitePunto,$otrosAdmitidos]) (estático)

Limpia un valor para ser utilizado como ruta, nombre de aplicación, nombre de clase, nombre de método y afines, removiendo caracteres no seguros, como caracteres de control, ASCII extendido, unicode, caracteres codificados, entre otros.

Parámetro Tipo Descripción Opcional Predeterminado
$cadena string Cadena a procesar.
$admiteBarra bool Determina si debe admitir barras (/, \) en la cadena. Si false
$admitePunto bool Determina si debe admitir puntos (.) en la cadena. Si false
$otrosAdmitidos string Otros caracteres admitidos. Escapar de acuerdo a expresiones regulares. Si ''

Devuelve: string

convertirGuiones($cadena) (estático)

Dada una cadena, removerá los guiones con el formato: nombre-metodo -> nombreMetodo. Se recomienda utilizar limpiarValor() previamente.

Parámetro Tipo Descripción Opcional Predeterminado
$cadena string Cadena a procesar. Nota: No limpia la cadena de entrada.

Devuelve: string

cadenaAzar([$longitud]) (estático)

Genera y devuelve una cadena alfanumerica al azar.

Parámetro Tipo Descripción Opcional Predeterminado
$longitud int Longitud. Si 10

Devuelve: string

formatoNumero($valor[,$decimales,$ocultarDecimales]) (estático)

Aplica un formato estándar a un valor numérico.

Parámetro Tipo Descripción Opcional Predeterminado
$valor int|float Valor a formatear.
$decimales int Cantidad de decimales. Si 2
$ocultarDecimales bool Trunca los decimales cuando el valor es .00. Si false

Devuelve: string

minutosAHoras($min) (estático)

Convierte el número de minutos en H:i.

Parámetro Tipo Descripción Opcional Predeterminado
$min integer Minutos. Admite valores negativos.

Devuelve: string

extraerPropiedad($listado,$propiedad) (estático)

Dado un listado de objetos (incluso entidades) o arrays asociativos, devuelve un listado conteniendo los valores de la propiedad especificada de cada uno.

Parámetro Tipo Descripción Opcional Predeterminado
$listado array|object Listado a procesar.
$propiedad string Nombre de la propiedad (o clave, si $listado contiene arrays asociativos).

Devuelve: array

obtenerMinutosZonaHoraria([$zona]) (estático)

Devuelve la cantidad de minutos correspondiente al desplazamiento (offset) de la zona horaria especificada.

Parámetro Tipo Descripción Opcional Predeterminado
$zona string Zona horaria. Por defecto, el valor de configuracion::zonaHoraria. Si null

Devuelve: int

Clone this wiki locally