Descarga de php helpers - Descarga del código fuente php helpers

Acerca de

La biblioteca clausnz/php-helpers es una colección de 45 funciones auxiliares de PHP útiles (PHP 5.6, 7.*) .
Después de la instalación con composer , se puede acceder a las funciones globales desde cualquier lugar de su código:

Instalación

composer require clausnz/php-helpers

Ejemplo

 <?php

dump ( ' any content ' );

Si una función con el mismo nombre ya existe en la lista de funciones definidas de su proyecto (integradas y definidas por el usuario), simplemente no se registrará en su entorno. Por lo tanto, no aparecerán conflictos con las funciones existentes.

Sin embargo, aún se puede acceder a todas las funciones de forma estática con la declaración de uso adecuada:

Ejemplo

 <?php

use CNZ  Helpers  Util as util ;

util:: dump ( ' any content ' );

CRÉDITOS

Esta biblioteca hace uso de las siguientes bibliotecas brillantes y conocidas:

https://github.com/serbanghita/Mobile-Detect
https://github.com/JayBizzle/Crawler-Detect
https://github.com/mustangostang/spyc

Pruebas

Todas las funciones se prueban con varias pruebas unitarias y versiones de PHP.

Instalar

Instale la última biblioteca clausnz/php-helper con Composer:

composer require clausnz/php-helpers

También asegúrese de solicitar el archivo de carga automática de su compositor:

 require __DIR__ . ' /vendor/autoload.php ' ;

Después de la instalación, las nuevas funciones globales de PHP están disponibles en todas partes de su código. Para acceder a las funciones estáticas (casi idénticas) en las clases auxiliares, agregue la declaración de uso adecuada a su archivo:

Ejemplo

 <?php

use CNZ  Helpers  Dev as dev ;

if ( dev:: isIphone () ) {
   // Do something here
}

Funciones PHP disponibles

Tabla de contenido

Dispositivo
- es_movil
- es_smartphone
- es_tableta
- es_desktop
- es_robot
- is_ios
- es_android
- es_iphone
- es_samsung
Formación
- matriz_obtener
- conjunto_matriz
- matriz_primero
- matriz_último
- to_array
- a_objeto
- es_assoc
Cadena
- str_antes
- str_después
- str_después_último
- str_entre
- str_insertar
- str_limit
- str_limit_palabras
- str_contiene
- str_icontains
- str_starts_with
- str_istarts_with
- str_ends_with
- str_iends_con
Utilidades
- IP
- es_correo electrónico
- vertedero
- dd
- contraseña_cripta
- es_contraseña
Yml
- to_yml
- a_yml_file
- yml_parse
- yml_parse_file
- es_yml
- es_yml_file
- yml_get
- yml_get_file
- conjunto_yml
- yml_set_file

Documentación API

Tabla de contenido

Arr
- esAssoc
- al objeto
- vertedero
- primero
- último
- conseguir
- colocar
desarrollador
- esSmartphone
- es móvil
- detección móvil
- es tableta
- es escritorio
- esRobot
- rastreadorDetectar
- es Android
- es Iphone
- es Samsung
- isIOS
str
- insertar
- entre
- después
- antes
- límite de palabras
- límite
- contiene
- contieneIgnorarCase
- comienza con
- comienza con ignorar caso
- termina con
- termina con ignorar caso
- después del último
utilitario
- escorreo electrónico
- IP
- criptaContraseña
- esContraseña
- dd
- vertedero
Yml
- es un archivo válido
- es válido
- analizar gramaticalmente
- conseguir
- obtener archivo
- analizar archivo
- establecer archivo
- volcado de archivo
- vertedero
- colocar

Arr

Clase auxiliar que proporciona fácil acceso a útiles funciones de matriz de PHP.

Clase Arr

Nombre completo: CNZHelpersArr

esAssoc

Detecta si el valor dado es una matriz asociativa.

Arr:: isAssoc ( array $ array ): boolean

es_assoc

Función global relacionada (ver descripción arriba).

 is_assoc ( array $ array ): boolean

Ejemplo

 $ array = [
    ' foo ' => ' bar '
];

is_assoc ( $ array );

// bool(true)

Este método es estático . Parámetros:

Parámetro	Tipo	Descripción
`$array`	formación	Cualquier tipo de matriz.

Valor de retorno:

Verdadero si la matriz es asociativa; falso en caso contrario.

al objeto

Convierte una matriz en un objeto.

Arr:: toObject ( array $ array ): object| null

a_objeto

Función global relacionada (ver descripción arriba).

 to_object ( array $ array ): object| null

Ejemplo

 $ array = [
    ' foo ' => [
         ' bar ' => ' baz '
    ]
];

$ obj = to_object ( $ array );
echo $ obj -> foo -> bar ;

// baz

Este método es estático . Parámetros:

Parámetro	Tipo	Descripción
`$array`	formación	La matriz que se va a convertir.

Valor de retorno:

Una representación de objeto estándar de la matriz convertida.

vertedero

Convierte una cadena o un objeto en una matriz.

Arr:: dump ( string|object $ var ): array| null

to_array

Función global relacionada (ver descripción arriba).

 to_array ( string|object $ var ): array| null

Ejemplo 1 (cadena)

 $ var = ' php ' ;
to_array ( $ var );

// (
//     [0] => p
//     [1] => h
//     [2] => p
// )

Ejemplo 2 (objeto)

 $ var = new stdClass ;
$ var -> foo = ' bar ' ;

to_array ( $ var );

// (
//     [foo] => bar
// )

Este método es estático . Parámetros:

Parámetro	Tipo	Descripción
`$var`	cadena\|objeto	Cuerda u objeto.

Valor de retorno:

Una representación de matriz de la cadena u objeto convertido. Devuelve nulo en caso de error.

primero

Devuelve el primer elemento de una matriz.

Arr:: first ( array $ array ): mixed

matriz_primero

Función global relacionada (ver descripción arriba).

 array_first ( array $ array ): mixed

Ejemplo

 $ array = [
     ' foo ' => ' bar ' ,
     ' baz ' => ' qux '
];

array_first ( $ array )

// bar

Este método es estático . Parámetros:

Parámetro	Tipo	Descripción
`$array`	formación	La matriz en cuestión.

Valor de retorno:

El valor del primer elemento, sin clave. Tipo mixto.

último

Devuelve el último elemento de una matriz.

Arr:: last ( array $ array ): mixed

matriz_último

Función global relacionada (ver descripción arriba).

 array_last ( array $ array ): mixed

Ejemplo

 $ array = [
     ' foo ' => ' bar ' ,
     ' baz ' => ' qux '
];

array_last ( $ array )

// qux

Este método es estático . Parámetros:

Parámetro	Tipo	Descripción
`$array`	formación	La matriz en cuestión.

Valor de retorno:

El valor del último elemento, sin clave. Tipo mixto.

conseguir

Obtiene un valor en una matriz mediante notación de puntos para las claves.

Arr:: get ( string $ key , array $ array ): mixed

matriz_obtener

Función global relacionada (ver descripción arriba).

 array_get ( string key, array $ array ): mixed

Ejemplo

 $ array = [
     ' foo ' => ' bar ' ,
     ' baz ' => [
         ' qux => ' foobar'
     ]
];

array_get ( ' baz.qux ' , $ array );

// foobar

Este método es estático . Parámetros:

Parámetro	Tipo	Descripción
`$key`	cadena	La clave por notación de puntos.
`$array`	formación	La matriz en la que buscar.

Valor de retorno:

El valor buscado, nulo en caso contrario.

colocar

Establece un valor en una matriz usando la notación de puntos.

Arr:: set ( string $ key , mixed $ value , array & $ array ): boolean

conjunto_matriz

Función global relacionada (ver descripción arriba).

 array_set ( string key, mixed value, array $ array ): boolean

Ejemplo 1

 $ array = [
     ' foo ' => ' bar ' ,
     ' baz ' => [
         ' qux => ' foobar'
     ]
];

array_set ( ' baz.qux ' , ' bazqux ' , $ array );

// (
//     [foo] => bar
//     [baz] => [
//         [qux] => bazqux
//     ]
// )

Ejemplo 2

 $ array = [
     ' foo ' => ' bar ' ,
     ' baz ' => [
         ' qux => ' foobar'
     ]
];

array_set ( ' baz.foo ' , ' bar ' , $ array );

// (
//     [foo] => bar
//     [baz] => [
//         [qux] => bazqux
//         [foo] => bar
//     ]
// )

Este método es estático . Parámetros:

Parámetro	Tipo	Descripción
`$key`	cadena	La clave para configurar usando notación de puntos.
`$value`	mezclado	El valor que se establecerá en la clave especificada.
`$array`	formación	La matriz en cuestión.

Valor de retorno:

Verdadero si el nuevo valor se estableció correctamente; falso en caso contrario.

desarrollador

Clase auxiliar que proporciona fácil acceso a funciones PHP útiles junto con el agente de usuario.

Desarrollo de clase

Nombre completo: CNZHelpersDev

esSmartphone

Determina si el dispositivo actual es un teléfono inteligente.

Dev:: isSmartphone (  ): boolean

es_smartphone

Función global relacionada (ver descripción arriba).

 is_smartphone (  ): boolean

Ejemplo

 if ( is_smartphone () ) {
     // I am a smartphone
}

Este método es estático .

Valor de retorno:

Verdadero si el visitante actual usa un teléfono inteligente; falso en caso contrario.

es móvil

Detecta si el visitante actual utiliza un dispositivo móvil (Smartphone/Tablet/Handheld).

Dev:: isMobile (  ): boolean

es_movil

Función global relacionada (ver descripción arriba).

 is_mobile (  ): boolean

Ejemplo

 if ( is_mobile () ) {
     // I am a mobile device (smartphone/tablet or handheld)
}

Este método es estático .

Valor de retorno:

Verdadero si el visitante actual utiliza un dispositivo móvil; falso en caso contrario.

detección móvil

Obtenga un objeto MobileDetect único para llamar a todos los métodos que proporciona.

Dev::mobileDetect(  ):  Detection  MobileDetect

Acceso público para uso fuera de esta clase. Documento de Mobile_Detect: https://github.com/serbanghita/Mobile-Detect

¡Este método no tiene ninguna función global relacionada!

Ejemplo

Dev:: mobileDetect ()-> version ( ' Android ' );

// 8.1

Este método es estático .

Valor de retorno:

Un objeto MobileDetect singleton para llamar a todos los métodos que proporciona.

es tableta

Determina si el visitante actual utiliza una tableta.

Dev:: isTablet (  ): boolean

es_tableta

Función global relacionada (ver descripción arriba).

 is_tablet (  ): boolean

Ejemplo

 if ( is_tablet () ) {
     // I am a tablet
}

Este método es estático .

Valor de retorno:

Verdadero si el visitante actual utiliza una tableta; en caso contrario, falso.

es escritorio

Determina si el visitante actual utiliza una computadora de escritorio.

Dev:: isDesktop (  ): boolean

es_desktop

Función global relacionada (ver descripción arriba).

 is_desktop (  ): boolean

Ejemplo

 if ( is_desktop () ) {
     // I am a desktop computer (Mac, Linux, Windows)
}

Este método es estático .

Valor de retorno:

Verdadero si el visitante actual utiliza una computadora de escritorio; falso en caso contrario.

esRobot

Determina si el visitante actual es un motor de búsqueda/bot/rastreador/araña.

Dev:: isRobot (  ): boolean

es_robot

Función global relacionada (ver descripción arriba).

 is_robot (  ): boolean

Ejemplo

 if ( is_robot () ) {
     // I am a robot (search engine, bot, crawler, spider)
}

Este método es estático .

Valor de retorno:

Verdadero si el visitante actual es un motor de búsqueda/bot/rastreador/araña; falso en caso contrario.

rastreadorDetectar

Obtenga un objeto CrawlerDetect singleton para llamar a todos los métodos que proporciona.

Dev::crawlerDetect(  ):  Jaybizzle  CrawlerDetect  CrawlerDetect

Acceso público para uso fuera de esta clase. Documental sobre detección de rastreadores: https://github.com/JayBizzle/Crawler-Detect

¡Este método no tiene ninguna función global relacionada!

Ejemplo

Dev:: crawlerDetect ()-> getMatches ();

// Output the name of the bot that matched (if any)

Este método es estático .

es Android

Determina si el dispositivo actual ejecuta un sistema operativo Android.

Dev:: isAndroid (  ): boolean

es_android

Función global relacionada (ver descripción arriba).

 is_android (  ): boolean

Ejemplo

 if ( is_android () ) {
     // I am an Android based device
}

Este método es estático .

Valor de retorno:

Verdadero si el visitante actual utiliza un dispositivo basado en Android; falso en caso contrario.

es Iphone

Determina si el dispositivo actual es un iPhone.

Dev:: isIphone (  ): boolean

es_iphone

Función global relacionada (ver descripción arriba).

 is_iphone (  ): boolean

Ejemplo

 if ( is_iphone () ) {
     // I am an iPhone
}

Este método es estático .

Valor de retorno:

Verdadero si el visitante actual usa un iPhone; falso en caso contrario.

es Samsung

Determina si el dispositivo actual es de Samsung.

Dev:: isSamsung (  ): boolean

es_samsung

Función global relacionada (ver descripción arriba).

 is_samsung (  ): boolean

Ejemplo

 if ( is_samsung () ) {
     // I am a device from Samsung
}

Este método es estático .

Valor de retorno:

Verdadero si el visitante actual utiliza un dispositivo Samsung; falso en caso contrario.

isIOS

Determina si el dispositivo actual ejecuta un sistema operativo iOS.

Dev:: isIOS (  ): boolean

is_ios

Función global relacionada (ver descripción arriba).

 is_ios (  ): boolean

Ejemplo

 if ( is_ios () ) {
     // I am an iOS based device
}

Este método es estático .

Valor de retorno:

Verdadero si el visitante actual utiliza un dispositivo iOS; en caso contrario, falso.

str

Clase auxiliar que proporciona fácil acceso a funciones útiles de cadenas de PHP.

Clase str

Nombre completo: CNZHelpersStr

insertar

Inserta una o más cadenas en otra cadena en una posición definida.

Str:: insert ( array $ keyValue , string $ string ): string

str_insertar

Función global relacionada (ver descripción arriba).

 str_insert ( array $ keyValue , string $ string ): string

Ejemplo

 $ keyValue = [
     ' :color ' => ' brown ' ,
     ' :animal ' => ' dog '
]
$ string = ' The quick :color fox jumps over the lazy :animal. ' ;

str_insert ( $ keyValue , $ string );

// The quick brown fox jumps over the lazy dog.

Este método es estático . Parámetros:

Parámetro	Tipo	Descripción
`$keyValue`	formación	Una matriz asociativa con pares clave => valor.
`$string`	cadena	El texto con las cadenas que se van a reemplazar.

Valor de retorno:

La cuerda reemplazada.

entre

Devuelve el contenido en una cadena entre un elemento izquierdo y derecho.

Str:: between ( string $ left , string $ right , string $ string ): array

str_entre

Función global relacionada (ver descripción arriba).

 str_between ( string $ left , string $ right , string $ string ): array

Ejemplo

 $ string = ' <tag>foo</tag>foobar<tag>bar</tag> '

str_between ( ' <tag> ' , ' </tag> ' $ string );

// (
//     [0] => foo
//     [1] => bar
// )

Este método es estático . Parámetros:

Parámetro	Tipo	Descripción
`$left`	cadena	El elemento izquierdo de la cadena a buscar.
`$right`	cadena	El elemento correcto de la cadena a buscar.
`$string`	cadena	La cadena en la que buscar.

Valor de retorno:

Una matriz de resultados con todas las coincidencias de la búsqueda.

después

Devuelve la parte de una cadena después de un valor dado.

Str:: after ( string $ search , string $ string ): string

str_después

Función global relacionada (ver descripción arriba).

 str_after ( string $ search , string $ string ): string

Ejemplo

 $ string = ' The quick brown fox jumps over the lazy dog ' ;

str_after ( ' fox ' $ string );

// jumps over the lazy dog

Este método es estático . Parámetros:

Parámetro	Tipo	Descripción
`$search`	cadena	La cadena a buscar.
`$string`	cadena	La cadena en la que buscar.

Valor de retorno:

La cadena encontrada después de la cadena de búsqueda. Se eliminarán los espacios en blanco al principio.

antes

Obtiene la parte de una cadena antes de un valor determinado.

Str:: before ( string $ search , string $ string ): string

str_antes

Función global relacionada (ver descripción arriba).

 str_before ( string $ search , string $ string ): string

Ejemplo

 $ string = ' The quick brown fox jumps over the lazy dog ' ;

str_before ( ' fox ' $ string );

// The quick brown

Este método es estático . Parámetros:

Parámetro	Tipo	Descripción
`$search`	cadena	La cadena a buscar.
`$string`	cadena	La cadena en la que buscar.

Valor de retorno:

La cadena encontrada antes de la cadena de búsqueda. Se eliminarán los espacios en blanco al final.

límite de palabras

Limite el número de palabras en una cadena. Ponga el valor de $end al final de la cadena.

Str:: limitWords ( string $ string , integer $ limit = 10 , string $ end = ' ... ' ): string

str_limit_palabras

Función global relacionada (ver descripción arriba).

 str_limit_words ( string $ string , int $ limit = 10 , string $ end = ' ... ' ): string

Ejemplo

 $ string = ' The quick brown fox jumps over the lazy dog ' ;

str_limit_words ( $ string , 3 );

// The quick brown...

Este método es estático . Parámetros:

Parámetro	Tipo	Descripción
`$string`	cadena	La cadena para limitar las palabras.
`$limit`	entero	El número de palabras a limitar. El valor predeterminado es 10.
`$end`	cadena	La cuerda para terminar la cuerda cortada. El valor predeterminado es '...'

Valor de retorno:

La cadena limitada con $end al final.

límite

Limite el número de caracteres en una cadena. Ponga el valor de $end al final de la cadena.

Str:: limit ( string $ string , integer $ limit = 100 , string $ end = ' ... ' ): string

str_limit

Función global relacionada (ver descripción arriba).

 str_limit ( string $ string , int $ limit = 100 , string $ end = ' ... ' ): string

Ejemplo

 $ string = ' The quick brown fox jumps over the lazy dog ' ;

str_limit ( $ string , 15 );

// The quick brown...

Este método es estático . Parámetros:

Parámetro	Tipo	Descripción
`$string`	cadena	La cadena para limitar los caracteres.
`$limit`	entero	El número de caracteres a limitar. El valor predeterminado es 100.
`$end`	cadena	La cuerda para terminar la cuerda cortada. El valor predeterminado es '...'

Valor de retorno:

La cadena limitada con $end al final.

contiene

Prueba si una cadena contiene un elemento determinado

Str:: contains ( string|array $ needle , string $ haystack ): boolean

str_contiene

Función global relacionada (ver descripción arriba).

 str_contains ( string|array $ needle , string $ haystack ): boolean

Ejemplo

 $ string = ' The quick brown fox jumps over the lazy dog ' ;
$ array = [
     ' cat ' ,
     ' fox '
];

str_contains ( $ array , $ string );

// bool(true)

Este método es estático . Parámetros:

Parámetro	Tipo	Descripción
`$needle`	cadena\|matriz	Una cadena o una serie de cadenas.
`$haystack`	cadena	La cadena en la que buscar.

Valor de retorno:

Verdadero si se encuentra $needle, falso en caso contrario.

contieneIgnorarCase

Prueba si una cadena contiene un elemento determinado. Ignore la distinción entre mayúsculas y minúsculas.

Str:: containsIgnoreCase ( string|array $ needle , string $ haystack ): boolean

str_icontains

Función global relacionada (ver descripción arriba).

 str_icontains ( string|array $ needle , string $ haystack ): boolean

Ejemplo

 $ string = ' The quick brown fox jumps over the lazy dog ' ;
$ array = [
     ' Cat ' ,
     ' Fox '
];

str_icontains ( $ array , $ string );

// bool(true)

Este método es estático . Parámetros:

Parámetro	Tipo	Descripción
`$needle`	cadena\|matriz	Una cadena o una serie de cadenas.
`$haystack`	cadena	La cadena en la que buscar.

Valor de retorno:

Verdadero si se encuentra $needle, falso en caso contrario.

comienza con

Determine si una cadena determinada comienza con una subcadena determinada.

Str:: startsWith ( string|array $ needle , string $ haystack ): boolean

str_starts_with

Función global relacionada (ver descripción arriba).

 str_starts_with ( string|array $ needle , string $ haystack ): boolean

Ejemplo

 $ string = ' The quick brown fox jumps over the lazy dog ' ;
$ array = [
     ' Cat ' ,
     ' The '
];

str_starts_with ( $ array , $ string );

// bool(true)

Este método es estático . Parámetros:

Parámetro	Tipo	Descripción
`$needle`	cadena\|matriz	La cadena o conjunto de cadenas que se buscarán.
`$haystack`	cadena	La cadena en la que buscar.

Valor de retorno:

Verdadero si se encontró $needle; falso en caso contrario.

comienza con ignorar caso

Determine si una cadena determinada comienza con una subcadena determinada. Ignore la distinción entre mayúsculas y minúsculas.

Str:: startsWithIgnoreCase ( string|array $ needle , string $ haystack ): boolean

str_istarts_with

Función global relacionada (ver descripción arriba).

 str_istarts_with ( string|array $ needle , string $ haystack ): boolean

Ejemplo

 $ string = ' The quick brown fox jumps over the lazy dog ' ;
$ array = [
     ' cat ' ,
     ' the '
];

str_istarts_with ( $ array , $ string );

// bool(true)

Este método es estático . Parámetros:

Parámetro	Tipo	Descripción
`$needle`	cadena\|matriz	La cadena o conjunto de cadenas que se buscarán.
`$haystack`	cadena	La cadena en la que buscar.

Valor de retorno:

Verdadero si se encontró $needle; falso en caso contrario.

termina con

Determinar si una cadena determinada termina con una subcadena determinada.

Str:: endsWith ( string|array $ needle , string $ haystack ): boolean

str_ends_with

Función global relacionada (ver descripción arriba).

 str_ends_with ( string|array $ needle , string $ haystack ): boolean

Ejemplo

 $ string = ' The quick brown fox jumps over the lazy dog ' ;
$ array = [
     ' cat ' ,
     ' dog '
];

str_ends_with ( $ array , $ string );

// bool(true)

Este método es estático . Parámetros:

Parámetro	Tipo	Descripción
`$needle`	cadena\|matriz	La cadena o conjunto de cadenas que se buscarán.
`$haystack`	cadena	La cadena en la que buscar.

Valor de retorno:

Verdadero si se encontró $needle; falso en caso contrario.

termina con ignorar caso

Determinar si una cadena determinada termina con una subcadena determinada.

Str:: endsWithIgnoreCase ( string|array $ needle , string $ haystack ): boolean

str_iends_con

Función global relacionada (ver descripción arriba).

 str_iends_with ( string|array $ needle , string $ haystack ): boolean

Ejemplo

 $ string = ' The quick brown fox jumps over the lazy dog ' ;
$ array = [
     ' Cat ' ,
     ' Dog '
];

str_iends_with ( $ array , $ string );

// bool(true)

Este método es estático . Parámetros:

Parámetro	Tipo	Descripción
`$needle`	cadena\|matriz	La cadena o conjunto de cadenas que se buscarán.
`$haystack`	cadena	La cadena en la que buscar.

Valor de retorno:

Verdadero si se encontró $needle; falso en caso contrario.

después del último

Devuelve la parte de una cadena después de la última aparición de un valor de búsqueda determinado.

Str:: afterLast ( string $ search , string $ string ): string

str_después_último

Función global relacionada (ver descripción arriba).

 str_after_last ( string $ search , string $ string ): string

Ejemplo

 $ path = " /var/www/html/public/img/image.jpg " ;

str_after_last ( ' / ' $ path );

// image.jpg

Este método es estático . Parámetros:

Parámetro	Tipo	Descripción
`$search`	cadena	La cadena a buscar.
`$string`	cadena	La cadena en la que buscar.

Valor de retorno:

La cadena encontrada después de la última aparición de la cadena de búsqueda. Se eliminarán los espacios en blanco al principio.

utilitario

Clase auxiliar que proporciona fácil acceso a funciones útiles de PHP comunes.

Utilidad de clase

Nombre completo: CNZHelpersUtil

escorreo electrónico

Validar una dirección de correo electrónico determinada.

Util:: isEmail ( string $ email ): boolean

es_correo electrónico

Función global relacionada (ver descripción arriba).

 is_email ( string $ email ): boolean

Ejemplo

 $ email = ' [email protected] ' ;

is_email ( $ email );

// bool(true)

Este método es estático . Parámetros:

Parámetro	Tipo	Descripción
`$email`	cadena	La dirección de correo electrónico para realizar la prueba.

Valor de retorno:

Verdadero si la cadena proporcionada es una dirección de correo electrónico válida; falso en caso contrario.

IP

Obtenga la dirección IP actual del usuario.

Util:: ip (  ): string| null

ip_usuario

Función global relacionada (ver descripción arriba).

 ip (  ): null|string

Ejemplo

 echo ip ();

// 127.0.0.1

Este método es estático .

Valor de retorno:

La dirección IP detectada, nula si no se detectó la IP.

criptaContraseña

Crea un hash seguro a partir de una contraseña determinada. Utiliza el algoritmo CRYPT_BLOWFISH.

Util:: cryptPassword ( string $ password ): string

Nota: ¡Se recomiendan 255 caracteres para la columna de la base de datos!

contraseña_cripta

Función global relacionada (ver descripción arriba).

 crypt_password ( string $ password ): string

Ejemplo

 $ password = ' foobar ' ;

crypt_password ( $ password );

// $2y$10$6qKwbwTgwQNcmcaw04eSf.QpP3.4T0..bEnY62dd1ozM8L61nb8AC

Este método es estático . Parámetros:

Parámetro	Tipo	Descripción
`$password`	cadena	La contraseña para cifrar.

Valor de retorno:

La contraseña cifrada.

esContraseña

Verifica que una contraseña coincida con una contraseña cifrada (algoritmo CRYPT_BLOWFISH).

Util:: isPassword ( string $ password , string $ cryptedPassword ): boolean

es_contraseña

Función global relacionada (ver descripción arriba).

 is_password ( string $ password , string $ cryptedPassword ): boolean

Ejemplo

 $ password = ' foobar ' ;
$ cryptedPassword = ' $2y$10$6qKwbwTgwQNcmcaw04eSf.QpP3.4T0..bEnY62dd1ozM8L61nb8AC ' ;

is_password ( $ password , $ cryptedPassword );

// bool(true)

Este método es estático . Parámetros:

Parámetro	Tipo	Descripción
`$password`	cadena	La contraseña para probar.
`$cryptedPassword`	cadena	La contraseña cifrada (por ejemplo, almacenada en la base de datos).

dd

Vuelca el contenido de la variable dada y sale del script.

Util:: dd ( mixed $ var )

dd

Función global relacionada (ver descripción arriba).

 dd ( mixed $ var )

Ejemplo

 $ array = [
     ' foo ' => ' bar ' ,
     ' baz ' => ' qux '
];

dd ( $ array );

// (
//     [foo] => bar
//     [baz] => qux
// )

Este método es estático . Parámetros:

Parámetro	Tipo	Descripción
`$var`	mezclado	La var a volcar.

vertedero

Vuelca el contenido de la variable dada. El script NO se detiene después de la llamada.

Util:: dump ( mixed $ var )

vertedero

Función global relacionada (ver descripción arriba).

 dump ( mixed $ var )

Ejemplo

 $ array = [
     ' foo ' => ' bar ' ,
     ' baz ' => ' qux '
];

dump ( $ array );

// (
//     [foo] => bar
//     [baz] => qux
// )

Este método es estático . Parámetros:

Parámetro	Tipo	Descripción
`$var`	mezclado	La var a volcar.

Yml

Clase auxiliar que proporciona fácil acceso a funciones útiles de php yml.

Clase Yml

Nombre completo: CNZHelpersYml

es un archivo válido

Valida si un archivo determinado contiene sintaxis yaml.

Yml:: isValidFile ( string $ file ): boolean

es_yml_file

Función global relacionada (ver descripción arriba).

 is_yml_file ( string $ file ): boolean

Ejemplo

 $ file = /path/to/file.yml

is_yml_file ( $ file );

// bool(true)

Este método es estático . Parámetros:

Parámetro	Tipo	Descripción
`$file`	cadena	El archivo para probar la sintaxis de yaml.

Valor de retorno:

Verdadero si el archivo contiene sintaxis yaml; falso en caso contrario.

es válido

Comprueba si la sintaxis de una cadena determinada es yaml.

Yml:: isValid ( string $ string ): boolean

es_yml

Función global relacionada (ver descripción arriba).

 is_yml ( string $ string ): boolean

Ejemplo

 $ string = "
     foo: bar
     baz: qux
     foobar:
         foo: bar
" ;

is_yml ( $ string );

// bool(true)

Este método es estático . Parámetros:

Parámetro	Tipo	Descripción
`$string`	cadena	La cadena para probar la sintaxis de yaml.

Valor de retorno:

Verdadero si la cadena es yaml; falso en caso contrario.

analizar gramaticalmente

Transforma una cadena yaml determinada en una matriz.

Yml:: parse ( string $ yml ): array| null

yml_parse

Función global relacionada (ver descripción arriba).

 yml_parse ( string $ yml ): array| null

Ejemplo

 $ yml = "
     foo: bar
     baz: qux
     foobar:
         foo: bar
" ;

yml_parse ( $ yml );

// (
//       [foo] => bar
//       [baz] => qux
//       [foobar] => (
//           [foo] => bar
//       )
// )

Este método es estático . Parámetros:

Parámetro	Tipo	Descripción
`$yml`	cadena	La cadena yaml que se va a analizar.

Valor de retorno:

La matriz transformada, nula en caso de error.

conseguir

Obtiene un valor en una cadena yaml usando la notación de puntos.

Yml:: get ( string $ key , string $ yml ): mixed

yml_get

Función global relacionada (ver descripción arriba).

 yml_get ( string $ key , string $ yml ): mixed

Ejemplo

 $ yml = "
     foo: bar
     baz: qux
     foobar:
         foo: bar
" ;

yml_get ( ' foobar.foo ' , $ yml );

// bar

Este método es estático . Parámetros:

Parámetro	Tipo	Descripción
`$key`	cadena	La clave para buscar usando notación de puntos (por ejemplo, 'foo.bar.baz').
`$yml`	cadena	La cadena yml para buscar.

Valor de retorno:

El valor encontrado, nulo en caso contrario.

obtener archivo

Obtiene un valor en un archivo yaml usando la notación de puntos.

Yml:: getFile ( string $ key , string $ ymlfile ): mixed

yml_get_file

Función global relacionada (ver descripción arriba).

 yml_get_file ( string $ key , string $ ymlfile ): mixed

Ejemplo

 $ ymlfile = ' /path/to/file.yml ' ;

yml_get_file ( ' foobar.foo ' , $ ymlfile );

// bar

Este método es estático . Parámetros:

Parámetro	Tipo	Descripción
`$key`	cadena	La clave para buscar usando notación de puntos (por ejemplo, 'foo.bar.baz').
`$ymlfile`	cadena	El archivo yml para buscar.

Valor de retorno:

El valor encontrado, nulo en caso contrario.

analizar archivo

Carga el contenido de un archivo yaml en una matriz.

Yml:: parseFile ( string $ ymlfile ): array

yml_parse_file

Función global relacionada (ver descripción arriba).

 yml_parse_file ( string $ ymlfile ): array| null

Ejemplo

 $ ymlfile = ' /path/to/file.yml ' ;

yml_parse_file ( $ ymlfile );

// (
//       [foo] => bar
//       [baz] => qux
//       [foobar] => (
//           [foo] => bar
//       )
// )

Este método es estático . Parámetros:

Parámetro	Tipo	Descripción
`$ymlfile`	cadena	La ruta del archivo para leer.

Valor de retorno:

La matriz analizada.

establecer archivo

Establece un valor en un archivo yaml usando la notación de puntos. Nota: ¡se eliminarán todos los comentarios del archivo!

Yml:: setFile ( string $ key , mixed $ value , string $ ymlfile ): boolean

yml_set_file

Función global relacionada (ver descripción arriba).

 yml_set_file ( string $ key , mixed $ value , string $ ymlfile ): boolean

Ejemplo

 $ ymlfile = ' /path/to/file.yml ' ;

yml_set_file ( ' foobar.foo ' , ' baz ' , $ ymlfile );

//   foo: bar
//   baz: qux
//   foobar:
//       foo: baz

Este método es estático . Parámetros:

Parámetro	Tipo	Descripción
`$key`	cadena	La cadena a buscar con notación de puntos.
`$value`	mezclado	El valor que se establecerá en la clave especificada.
`$ymlfile`	cadena	El archivo yml para establecer el valor.

Valor de retorno:

Verdadero si el valor se estableció correctamente en yamlfile; falso en caso contrario.

volcado de archivo

Transforma una matriz determinada a sintaxis yaml y coloca su contenido en un archivo determinado. Nota: si el archivo existe, ¡se sobrescribirá!

Yml:: dumpFile ( array|object $ var , string $ filename , integer $ indent = 2 , integer $ wordwrap , boolean $ openingDashes = false ): boolean

a_yml_file

Función global relacionada (ver descripción arriba).

 to_yml_file ( array|object $ var , string $ filename , int $ indent = 2 , int $ wordwrap = 0 , bool $ openingDashes = false ): boolean

Ejemplo

 $ array = [
     ' foo ' => ' bar ' ,
     ' baz ' => ' qux '
];

to_yml_file ( $ array , ' /path/to/file.yml ' );

//   foo: bar
//   baz: qux

Este método es estático . Parámetros:

Parámetro	Tipo	Descripción
`$var`	matriz\|objeto	La matriz u objeto a transformar.
`$filename`	cadena	La ruta al archivo en el que escribir la cadena yaml. Nota: si el archivo ya existe, ¡se sobrescribirá!
`$indent`	entero	La sangría del yaml convertido. El valor predeterminado es 2.
`$wordwrap`	entero	Después del número dado se envolverá una cadena. El valor predeterminado es 0 (sin ajuste de palabras).
`$openingDashes`	booleano	True si la cadena yaml debe comenzar con guiones de apertura. El valor predeterminado es falso.

Valor de retorno:

Verdadero en caso de éxito, falso en caso contrario.

vertedero

Transforma una matriz u objeto determinado en una cadena yaml.

Yml:: dump ( array|object $ var , integer $ indent = 2 , integer $ wordwrap , boolean $ openingDashes = false ): string| null

to_yml

Función global relacionada (ver descripción arriba).

 to_yml ( array|object $ array , string $ filename , int $ indent = 2 , int $ wordwrap = 0 , bool $ openingDashes = false ): string| null

Ejemplo

 $ array = [
     ' foo ' => ' bar ' ,
     ' baz ' => ' qux ' ,
     ' foobar ' => [
         ' foo ' => ' bar '
     ]
];

to_yml ( $ array );

//   foo: bar
//   baz: qux
//   foobar:
//     foo: bar

Este método es estático . Parámetros:

Parámetro	Tipo	Descripción
`$var`	matriz\|objeto	La matriz u objeto a transformar.
`$indent`	entero	La sangría del yaml convertido. El valor predeterminado es 2.
`$wordwrap`	entero	Después del número dado se envolverá una cadena. El valor predeterminado es 0 (sin ajuste de palabras).
`$openingDashes`	booleano	True si la cadena yaml debe comenzar con guiones de apertura. El valor predeterminado es falso.

Valor de retorno:

La cadena yaml convertida. En caso de errores, se devuelve nulo.

colocar

Establece un valor en una cadena yaml usando la notación de puntos.

Yml:: set ( string $ key , mixed $ value , string & $ yml ): boolean

conjunto_yml

Función global relacionada (ver descripción arriba).

 yml_set ( string $ key , mixed $ value , string & $ yml ): boolean

Ejemplo

 $ yml = "
     foo: bar
     baz: qux
     foobar:
         foo: bar
" ;

yml_set ( ' foobar.foo ' , ' baz ' , $ yml );

//   foo: bar
//   baz: qux
//   foobar:
//       foo: baz

Este método es estático . Parámetros:

Parámetro	Tipo	Descripción
`$key`	cadena	La cadena a buscar con notación de puntos.
`$value`	mezclado	El valor que se establecerá en la clave especificada.
`$yml`	cadena	La cadena yml para buscar. Nota: ¡se eliminarán todos los comentarios en la cadena!

Valor de retorno:

Verdadero si el valor se estableció correctamente; falso en caso contrario.

Expandir