La bibliothèque clausnz/php-helpers
est une collection de 45 fonctions d'assistance PHP utiles (PHP 5.6, 7.*)
.
Après installation avec composer
, les fonctions globales sont accessibles de partout dans votre code :
composer require clausnz/php-helpers
<?php
dump ( ' any content ' );
Si une fonction du même nom existe déjà dans la liste des fonctions définies de votre projet (intégrées et définies par l'utilisateur), elle ne sera tout simplement pas enregistrée dans votre environnement. Par conséquent, aucun conflit avec les fonctions existantes n’apparaîtra.
Néanmoins, chaque fonction est toujours accessible de manière statique avec la déclaration d'utilisation appropriée :
<?php
use CNZ Helpers Util as util ;
util:: dump ( ' any content ' );
Cette bibliothèque utilise les bibliothèques brillantes et bien connues suivantes :
Toutes les fonctions sont testées par rapport à un certain nombre de tests unitaires et de versions PHP.
Installez la dernière bibliothèque clausnz/php-helper
avec composer :
composer require clausnz/php-helpers
Assurez-vous également d'exiger le chargement automatique de votre fichier composer :
require __DIR__ . ' /vendor/autoload.php ' ;
Après installation, les nouvelles fonctions PHP globales sont disponibles partout dans votre code. Pour accéder aux fonctions statiques (presque identiques) dans les classes d'assistance, ajoutez l'instruction d'utilisation appropriée à votre fichier :
<?php
use CNZ Helpers Dev as dev ;
if ( dev:: isIphone () ) {
// Do something here
}
Classe d'assistance qui fournit un accès facile aux fonctions utiles du tableau php.
Classe Arr
Détecte si la valeur donnée est un tableau associatif.
Arr:: isAssoc ( array $ array ): boolean
Fonction globale associée (description voir ci-dessus).
(revenir en arrière)
is_assoc ( array $ array ): boolean
$ array = [
' foo ' => ' bar '
];
is_assoc ( $ array );
// bool(true)
Paramètre | Taper | Description |
---|---|---|
$array | tableau | Tout type de tableau. |
Valeur de retour :
Vrai si le tableau est associatif, faux sinon.
Convertit un tableau en objet.
Arr:: toObject ( array $ array ): object| null
Fonction globale associée (description voir ci-dessus).
(revenir en arrière)
to_object ( array $ array ): object| null
$ array = [
' foo ' => [
' bar ' => ' baz '
]
];
$ obj = to_object ( $ array );
echo $ obj -> foo -> bar ;
// baz
Paramètre | Taper | Description |
---|---|---|
$array | tableau | Le tableau à convertir. |
Valeur de retour :
Une représentation d'objet std du tableau converti.
Convertit une chaîne ou un objet en tableau.
Arr:: dump ( string|object $ var ): array| null
Fonction globale associée (description voir ci-dessus).
(revenir en arrière)
to_array ( string|object $ var ): array| null
$ var = ' php ' ;
to_array ( $ var );
// (
// [0] => p
// [1] => h
// [2] => p
// )
$ var = new stdClass ;
$ var -> foo = ' bar ' ;
to_array ( $ var );
// (
// [foo] => bar
// )
Paramètre | Taper | Description |
---|---|---|
$var | chaîne|objet | Chaîne ou objet. |
Valeur de retour :
Une représentation matricielle de la chaîne ou de l'objet converti. Renvoie null en cas d'erreur.
Renvoie le premier élément d'un tableau.
Arr:: first ( array $ array ): mixed
Fonction globale associée (description voir ci-dessus).
(revenir en arrière)
array_first ( array $ array ): mixed
$ array = [
' foo ' => ' bar ' ,
' baz ' => ' qux '
];
array_first ( $ array )
// bar
Paramètre | Taper | Description |
---|---|---|
$array | tableau | Le tableau concerné. |
Valeur de retour :
La valeur du premier élément, sans clé. Type mixte.
Renvoie le dernier élément d'un tableau.
Arr:: last ( array $ array ): mixed
Fonction globale associée (description voir ci-dessus).
(revenir en arrière)
array_last ( array $ array ): mixed
$ array = [
' foo ' => ' bar ' ,
' baz ' => ' qux '
];
array_last ( $ array )
// qux
Paramètre | Taper | Description |
---|---|---|
$array | tableau | Le tableau concerné. |
Valeur de retour :
La valeur du dernier élément, sans clé. Type mixte.
Obtient une valeur dans un tableau par notation par points pour les clés.
Arr:: get ( string $ key , array $ array ): mixed
Fonction globale associée (description voir ci-dessus).
(revenir en arrière)
array_get ( string key, array $ array ): mixed
$ array = [
' foo ' => ' bar ' ,
' baz ' => [
' qux => ' foobar'
]
];
array_get ( ' baz.qux ' , $ array );
// foobar
Paramètre | Taper | Description |
---|---|---|
$key | chaîne | La clé par notation par points. |
$array | tableau | Le tableau dans lequel effectuer la recherche. |
Valeur de retour :
La valeur recherchée, nulle sinon.
Définit une valeur dans un tableau en utilisant la notation par points.
Arr:: set ( string $ key , mixed $ value , array & $ array ): boolean
Fonction globale associée (description voir ci-dessus).
(revenir en arrière)
array_set ( string key, mixed value, array $ array ): boolean
$ array = [
' foo ' => ' bar ' ,
' baz ' => [
' qux => ' foobar'
]
];
array_set ( ' baz.qux ' , ' bazqux ' , $ array );
// (
// [foo] => bar
// [baz] => [
// [qux] => bazqux
// ]
// )
$ array = [
' foo ' => ' bar ' ,
' baz ' => [
' qux => ' foobar'
]
];
array_set ( ' baz.foo ' , ' bar ' , $ array );
// (
// [foo] => bar
// [baz] => [
// [qux] => bazqux
// [foo] => bar
// ]
// )
Paramètre | Taper | Description |
---|---|---|
$key | chaîne | La clé à définir en utilisant la notation par points. |
$value | mixte | La valeur à définir sur la clé spécifiée. |
$array | tableau | Le tableau concerné. |
Valeur de retour :
True si la nouvelle valeur a été définie avec succès, false sinon.
Classe d'assistance qui fournit un accès facile aux fonctions php utiles en conjonction avec l'agent utilisateur.
Développement de classe
Détermine si l'appareil actuel est un smartphone.
Dev:: isSmartphone ( ): boolean
Fonction globale associée (description voir ci-dessus).
(revenir en arrière)
is_smartphone ( ): boolean
if ( is_smartphone () ) {
// I am a smartphone
}
Valeur de retour :
Vrai si le visiteur actuel utilise un smartphone, faux sinon.
Détecte si le visiteur actuel utilise un appareil mobile (smartphone/tablette/ordinateur de poche).
Dev:: isMobile ( ): boolean
Fonction globale associée (description voir ci-dessus).
(revenir en arrière)
is_mobile ( ): boolean
if ( is_mobile () ) {
// I am a mobile device (smartphone/tablet or handheld)
}
Valeur de retour :
Vrai si le visiteur actuel utilise un appareil mobile, faux dans le cas contraire.
Obtenez un objet MobileDetect singleton pour appeler chaque méthode qu'il fournit.
Dev::mobileDetect( ): Detection MobileDetect
Accès public pour une utilisation en dehors de cette classe. Document Mobile_Detect : https://github.com/serbanghita/Mobile-Detect
Cette méthode n'a pas de fonction globale associée !
(revenir en arrière)
Dev:: mobileDetect ()-> version ( ' Android ' );
// 8.1
Valeur de retour :
Un objet MobileDetect singleton pour appeler chaque méthode qu'il fournit.
Détermine si le visiteur actuel utilise une tablette.
Dev:: isTablet ( ): boolean
Fonction globale associée (description voir ci-dessus).
(revenir en arrière)
is_tablet ( ): boolean
if ( is_tablet () ) {
// I am a tablet
}
Valeur de retour :
Vrai si le visiteur actuel utilise une tablette, faux dans le cas contraire.
Détermine si le visiteur actuel utilise un ordinateur de bureau.
Dev:: isDesktop ( ): boolean
Fonction globale associée (description voir ci-dessus).
(revenir en arrière)
is_desktop ( ): boolean
if ( is_desktop () ) {
// I am a desktop computer (Mac, Linux, Windows)
}
Valeur de retour :
Vrai si le visiteur actuel utilise un ordinateur de bureau, faux dans le cas contraire.
Détermine si le visiteur actuel est un moteur de recherche/bot/crawler/spider.
Dev:: isRobot ( ): boolean
Fonction globale associée (description voir ci-dessus).
(revenir en arrière)
is_robot ( ): boolean
if ( is_robot () ) {
// I am a robot (search engine, bot, crawler, spider)
}
Valeur de retour :
Vrai si le visiteur actuel est un moteur de recherche/bot/crawler/spider, faux sinon.
Obtenez un objet Singleton CrawlerDetect pour appeler chaque méthode qu'il fournit.
Dev::crawlerDetect( ): Jaybizzle CrawlerDetect CrawlerDetect
Accès public pour une utilisation en dehors de cette classe. Document Crawler-Detect : https://github.com/JayBizzle/Crawler-Detect
Cette méthode n'a pas de fonction globale associée !
(revenir en arrière)
Dev:: crawlerDetect ()-> getMatches ();
// Output the name of the bot that matched (if any)
Détermine si l'appareil actuel exécute un système d'exploitation Android.
Dev:: isAndroid ( ): boolean
Fonction globale associée (description voir ci-dessus).
(revenir en arrière)
is_android ( ): boolean
if ( is_android () ) {
// I am an Android based device
}
Valeur de retour :
Vrai si le visiteur actuel utilise un appareil Android, faux dans le cas contraire.
Détermine si l'appareil actuel est un iPhone.
Dev:: isIphone ( ): boolean
Fonction globale associée (description voir ci-dessus).
(revenir en arrière)
is_iphone ( ): boolean
if ( is_iphone () ) {
// I am an iPhone
}
Valeur de retour :
Vrai si le visiteur actuel utilise un iPhone, faux sinon.
Détermine si l'appareil actuel provient de Samsung.
Dev:: isSamsung ( ): boolean
Fonction globale associée (description voir ci-dessus).
(revenir en arrière)
is_samsung ( ): boolean
if ( is_samsung () ) {
// I am a device from Samsung
}
Valeur de retour :
Vrai si le visiteur actuel utilise un appareil Samsung, faux sinon.
Détermine si l'appareil actuel exécute un système d'exploitation iOS.
Dev:: isIOS ( ): boolean
Fonction globale associée (description voir ci-dessus).
(revenir en arrière)
is_ios ( ): boolean
if ( is_ios () ) {
// I am an iOS based device
}
Valeur de retour :
Vrai si le visiteur actuel utilise un appareil iOS, faux dans le cas contraire.
Classe d'assistance qui fournit un accès facile aux fonctions de chaîne php utiles.
Classe Str
Insère une ou plusieurs chaînes dans une autre chaîne à une position définie.
Str:: insert ( array $ keyValue , string $ string ): string
Fonction globale associée (description voir ci-dessus).
(revenir en arrière)
str_insert ( array $ keyValue , string $ string ): string
$ 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.
Paramètre | Taper | Description |
---|---|---|
$keyValue | tableau | Un tableau associatif avec des paires clé => valeur. |
$string | chaîne | Le texte avec les chaînes à remplacer. |
Valeur de retour :
La chaîne remplacée.
Renvoie le contenu d'une chaîne entre un élément gauche et droit.
Str:: between ( string $ left , string $ right , string $ string ): array
Fonction globale associée (description voir ci-dessus).
(revenir en arrière)
str_between ( string $ left , string $ right , string $ string ): array
$ string = ' <tag>foo</tag>foobar<tag>bar</tag> '
str_between ( ' <tag> ' , ' </tag> ' $ string );
// (
// [0] => foo
// [1] => bar
// )
Paramètre | Taper | Description |
---|---|---|
$left | chaîne | L'élément gauche de la chaîne à rechercher. |
$right | chaîne | Le bon élément de la chaîne à rechercher. |
$string | chaîne | La chaîne dans laquelle rechercher. |
Valeur de retour :
Un tableau de résultats avec toutes les correspondances de la recherche.
Renvoie la partie d'une chaîne après une valeur donnée.
Str:: after ( string $ search , string $ string ): string
Fonction globale associée (description voir ci-dessus).
(revenir en arrière)
str_after ( string $ search , string $ string ): string
$ string = ' The quick brown fox jumps over the lazy dog ' ;
str_after ( ' fox ' $ string );
// jumps over the lazy dog
Paramètre | Taper | Description |
---|---|---|
$search | chaîne | La chaîne à rechercher. |
$string | chaîne | La chaîne dans laquelle rechercher. |
Valeur de retour :
La chaîne trouvée après la chaîne de recherche. Les espaces au début seront supprimés.
Récupère la partie d'une chaîne avant une valeur donnée.
Str:: before ( string $ search , string $ string ): string
Fonction globale associée (description voir ci-dessus).
(revenir en arrière)
str_before ( string $ search , string $ string ): string
$ string = ' The quick brown fox jumps over the lazy dog ' ;
str_before ( ' fox ' $ string );
// The quick brown
Paramètre | Taper | Description |
---|---|---|
$search | chaîne | La chaîne à rechercher. |
$string | chaîne | La chaîne dans laquelle rechercher. |
Valeur de retour :
La chaîne trouvée avant la chaîne de recherche. Les espaces à la fin seront supprimés.
Limitez le nombre de mots dans une chaîne. Mettez la valeur de $end à la fin de la chaîne.
Str:: limitWords ( string $ string , integer $ limit = 10 , string $ end = ' ... ' ): string
Fonction globale associée (description voir ci-dessus).
(revenir en arrière)
str_limit_words ( string $ string , int $ limit = 10 , string $ end = ' ... ' ): string
$ string = ' The quick brown fox jumps over the lazy dog ' ;
str_limit_words ( $ string , 3 );
// The quick brown...
Paramètre | Taper | Description |
---|---|---|
$string | chaîne | La chaîne pour limiter les mots. |
$limit | entier | Le nombre de mots à limiter. La valeur par défaut est 10. |
$end | chaîne | La chaîne pour terminer la chaîne coupée. La valeur par défaut est '...' |
Valeur de retour :
La chaîne limitée avec $end à la fin.
Limitez le nombre de caractères dans une chaîne. Mettez la valeur de $end à la fin de la chaîne.
Str:: limit ( string $ string , integer $ limit = 100 , string $ end = ' ... ' ): string
Fonction globale associée (description voir ci-dessus).
(revenir en arrière)
str_limit ( string $ string , int $ limit = 100 , string $ end = ' ... ' ): string
$ string = ' The quick brown fox jumps over the lazy dog ' ;
str_limit ( $ string , 15 );
// The quick brown...
Paramètre | Taper | Description |
---|---|---|
$string | chaîne | La chaîne pour limiter les caractères. |
$limit | entier | Le nombre de caractères à limiter. La valeur par défaut est 100. |
$end | chaîne | La chaîne pour terminer la chaîne coupée. La valeur par défaut est '...' |
Valeur de retour :
La chaîne limitée avec $end à la fin.
Teste si une chaîne contient un élément donné
Str:: contains ( string|array $ needle , string $ haystack ): boolean
Fonction globale associée (description voir ci-dessus).
(revenir en arrière)
str_contains ( string|array $ needle , string $ haystack ): boolean
$ string = ' The quick brown fox jumps over the lazy dog ' ;
$ array = [
' cat ' ,
' fox '
];
str_contains ( $ array , $ string );
// bool(true)
Paramètre | Taper | Description |
---|---|---|
$needle | chaîne|tableau | Une chaîne ou un tableau de chaînes. |
$haystack | chaîne | La chaîne dans laquelle rechercher. |
Valeur de retour :
Vrai si $needle est trouvé, faux sinon.
Teste si une chaîne contient un élément donné. Ignorez la sensibilité à la casse.
Str:: containsIgnoreCase ( string|array $ needle , string $ haystack ): boolean
Fonction globale associée (description voir ci-dessus).
(revenir en arrière)
str_icontains ( string|array $ needle , string $ haystack ): boolean
$ string = ' The quick brown fox jumps over the lazy dog ' ;
$ array = [
' Cat ' ,
' Fox '
];
str_icontains ( $ array , $ string );
// bool(true)
Paramètre | Taper | Description |
---|---|---|
$needle | chaîne|tableau | Une chaîne ou un tableau de chaînes. |
$haystack | chaîne | La chaîne dans laquelle rechercher. |
Valeur de retour :
Vrai si $needle est trouvé, faux sinon.
Détermine si une chaîne donnée commence par une sous-chaîne donnée.
Str:: startsWith ( string|array $ needle , string $ haystack ): boolean
Fonction globale associée (description voir ci-dessus).
(revenir en arrière)
str_starts_with ( string|array $ needle , string $ haystack ): boolean
$ string = ' The quick brown fox jumps over the lazy dog ' ;
$ array = [
' Cat ' ,
' The '
];
str_starts_with ( $ array , $ string );
// bool(true)
Paramètre | Taper | Description |
---|---|---|
$needle | chaîne|tableau | La chaîne ou le tableau de chaînes à rechercher. |
$haystack | chaîne | La chaîne dans laquelle rechercher. |
Valeur de retour :
Vrai si $needle a été trouvé, faux sinon.
Détermine si une chaîne donnée commence par une sous-chaîne donnée. Ignorez la sensibilité à la casse.
Str:: startsWithIgnoreCase ( string|array $ needle , string $ haystack ): boolean
Fonction globale associée (description voir ci-dessus).
(revenir en arrière)
str_istarts_with ( string|array $ needle , string $ haystack ): boolean
$ string = ' The quick brown fox jumps over the lazy dog ' ;
$ array = [
' cat ' ,
' the '
];
str_istarts_with ( $ array , $ string );
// bool(true)
Paramètre | Taper | Description |
---|---|---|
$needle | chaîne|tableau | La chaîne ou le tableau de chaînes à rechercher. |
$haystack | chaîne | La chaîne dans laquelle rechercher. |
Valeur de retour :
Vrai si $needle a été trouvé, faux sinon.
Détermine si une chaîne donnée se termine par une sous-chaîne donnée.
Str:: endsWith ( string|array $ needle , string $ haystack ): boolean
Fonction globale associée (description voir ci-dessus).
(revenir en arrière)
str_ends_with ( string|array $ needle , string $ haystack ): boolean
$ string = ' The quick brown fox jumps over the lazy dog ' ;
$ array = [
' cat ' ,
' dog '
];
str_ends_with ( $ array , $ string );
// bool(true)
Paramètre | Taper | Description |
---|---|---|
$needle | chaîne|tableau | La chaîne ou le tableau de chaînes à rechercher. |
$haystack | chaîne | La chaîne dans laquelle rechercher. |
Valeur de retour :
Vrai si $needle a été trouvé, faux sinon.
Détermine si une chaîne donnée se termine par une sous-chaîne donnée.
Str:: endsWithIgnoreCase ( string|array $ needle , string $ haystack ): boolean
Fonction globale associée (description voir ci-dessus).
(revenir en arrière)
str_iends_with ( string|array $ needle , string $ haystack ): boolean
$ string = ' The quick brown fox jumps over the lazy dog ' ;
$ array = [
' Cat ' ,
' Dog '
];
str_iends_with ( $ array , $ string );
// bool(true)
Paramètre | Taper | Description |
---|---|---|
$needle | chaîne|tableau | La chaîne ou le tableau de chaînes à rechercher. |
$haystack | chaîne | La chaîne dans laquelle rechercher. |
Valeur de retour :
Vrai si $needle a été trouvé, faux sinon.
Renvoie la partie d'une chaîne après la dernière occurrence d'une valeur de recherche donnée.
Str:: afterLast ( string $ search , string $ string ): string
Fonction globale associée (description voir ci-dessus).
(revenir en arrière)
str_after_last ( string $ search , string $ string ): string
$ path = " /var/www/html/public/img/image.jpg " ;
str_after_last ( ' / ' $ path );
// image.jpg
Paramètre | Taper | Description |
---|---|---|
$search | chaîne | La chaîne à rechercher. |
$string | chaîne | La chaîne dans laquelle rechercher. |
Valeur de retour :
Chaîne trouvée après la dernière occurrence de la chaîne recherchée. Les espaces au début seront supprimés.
Classe d'assistance qui fournit un accès facile aux fonctions PHP courantes utiles.
Classe Util
Validez une adresse email donnée.
Util:: isEmail ( string $ email ): boolean
Fonction globale associée (description voir ci-dessus).
(revenir en arrière)
is_email ( string $ email ): boolean
$ email = ' [email protected] ' ;
is_email ( $ email );
// bool(true)
Paramètre | Taper | Description |
---|---|---|
$email | chaîne | L'adresse email à tester. |
Valeur de retour :
True si la chaîne donnée est une adresse e-mail valide, false sinon.
Obtenez l'adresse IP actuelle de l'utilisateur.
Util:: ip ( ): string| null
Fonction globale associée (description voir ci-dessus).
(revenir en arrière)
ip ( ): null|string
echo ip ();
// 127.0.0.1
Valeur de retour :
L'adresse IP détectée, nulle si l'adresse IP n'a pas été détectée.
Crée un hachage sécurisé à partir d'un mot de passe donné. Utilise l'algorithme CRYPT_BLOWFISH.
Util:: cryptPassword ( string $ password ): string
Remarque : 255 caractères recommandés pour la colonne de base de données !
Fonction globale associée (description voir ci-dessus).
(revenir en arrière)
crypt_password ( string $ password ): string
$ password = ' foobar ' ;
crypt_password ( $ password );
// $2y$10$6qKwbwTgwQNcmcaw04eSf.QpP3.4T0..bEnY62dd1ozM8L61nb8AC
Paramètre | Taper | Description |
---|---|---|
$password | chaîne | Le mot de passe à chiffrer. |
Valeur de retour :
Le mot de passe crypté.
Vérifie qu'un mot de passe correspond à un mot de passe crypté (algorithme CRYPT_BLOWFISH).
Util:: isPassword ( string $ password , string $ cryptedPassword ): boolean
Fonction globale associée (description voir ci-dessus).
(revenir en arrière)
is_password ( string $ password , string $ cryptedPassword ): boolean
$ password = ' foobar ' ;
$ cryptedPassword = ' $2y$10$6qKwbwTgwQNcmcaw04eSf.QpP3.4T0..bEnY62dd1ozM8L61nb8AC ' ;
is_password ( $ password , $ cryptedPassword );
// bool(true)
Paramètre | Taper | Description |
---|---|---|
$password | chaîne | Le mot de passe à tester. |
$cryptedPassword | chaîne | Le mot de passe crypté (par exemple stocké dans la base de données). |
Vide le contenu de la variable donnée et quitte le script.
Util:: dd ( mixed $ var )
Fonction globale associée (description voir ci-dessus).
(revenir en arrière)
dd ( mixed $ var )
$ array = [
' foo ' => ' bar ' ,
' baz ' => ' qux '
];
dd ( $ array );
// (
// [foo] => bar
// [baz] => qux
// )
Paramètre | Taper | Description |
---|---|---|
$var | mixte | La variable à vider. |
Vide le contenu de la variable donnée. Le script ne s'arrête PAS après l'appel.
Util:: dump ( mixed $ var )
Fonction globale associée (description voir ci-dessus).
(revenir en arrière)
dump ( mixed $ var )
$ array = [
' foo ' => ' bar ' ,
' baz ' => ' qux '
];
dump ( $ array );
// (
// [foo] => bar
// [baz] => qux
// )
Paramètre | Taper | Description |
---|---|---|
$var | mixte | La variable à vider. |
Classe d'assistance qui fournit un accès facile aux fonctions utiles de php yml.
Classe Yml
Valide si un fichier donné contient la syntaxe yaml.
Yml:: isValidFile ( string $ file ): boolean
Fonction globale associée (description voir ci-dessus).
(revenir en arrière)
is_yml_file ( string $ file ): boolean
$ file = /path/to/file.yml
is_yml_file ( $ file );
// bool(true)
Paramètre | Taper | Description |
---|---|---|
$file | chaîne | Le fichier pour tester la syntaxe yaml. |
Valeur de retour :
True si le fichier contient la syntaxe yaml, false sinon.
Teste si la syntaxe d'une chaîne donnée est yaml.
Yml:: isValid ( string $ string ): boolean
Fonction globale associée (description voir ci-dessus).
(revenir en arrière)
is_yml ( string $ string ): boolean
$ string = "
foo: bar
baz: qux
foobar:
foo: bar
" ;
is_yml ( $ string );
// bool(true)
Paramètre | Taper | Description |
---|---|---|
$string | chaîne | La chaîne pour tester la syntaxe yaml. |
Valeur de retour :
True si la chaîne est yaml, false sinon.
Transforme une chaîne yaml donnée en un tableau.
Yml:: parse ( string $ yml ): array| null
Fonction globale associée (description voir ci-dessus).
(revenir en arrière)
yml_parse ( string $ yml ): array| null
$ yml = "
foo: bar
baz: qux
foobar:
foo: bar
" ;
yml_parse ( $ yml );
// (
// [foo] => bar
// [baz] => qux
// [foobar] => (
// [foo] => bar
// )
// )
Paramètre | Taper | Description |
---|---|---|
$yml | chaîne | La chaîne yaml à analyser. |
Valeur de retour :
Le tableau transformé, nul en cas d'erreur.
Obtient une valeur dans une chaîne yaml en utilisant la notation par points.
Yml:: get ( string $ key , string $ yml ): mixed
Fonction globale associée (description voir ci-dessus).
(revenir en arrière)
yml_get ( string $ key , string $ yml ): mixed
$ yml = "
foo: bar
baz: qux
foobar:
foo: bar
" ;
yml_get ( ' foobar.foo ' , $ yml );
// bar
Paramètre | Taper | Description |
---|---|---|
$key | chaîne | La clé pour rechercher en utilisant la notation par points (par exemple 'foo.bar.baz'). |
$yml | chaîne | La chaîne yml dans laquelle effectuer la recherche. |
Valeur de retour :
La valeur trouvée, nulle sinon.
Obtient une valeur dans un fichier yaml en utilisant la notation par points.
Yml:: getFile ( string $ key , string $ ymlfile ): mixed
Fonction globale associée (description voir ci-dessus).
(revenir en arrière)
yml_get_file ( string $ key , string $ ymlfile ): mixed
$ ymlfile = ' /path/to/file.yml ' ;
yml_get_file ( ' foobar.foo ' , $ ymlfile );
// bar
Paramètre | Taper | Description |
---|---|---|
$key | chaîne | La clé pour rechercher en utilisant la notation par points (par exemple 'foo.bar.baz'). |
$ymlfile | chaîne | Le fichier yml dans lequel effectuer la recherche. |
Valeur de retour :
La valeur trouvée, nulle sinon.
Charge le contenu d'un fichier yaml dans un tableau.
Yml:: parseFile ( string $ ymlfile ): array
Fonction globale associée (description voir ci-dessus).
(revenir en arrière)
yml_parse_file ( string $ ymlfile ): array| null
$ ymlfile = ' /path/to/file.yml ' ;
yml_parse_file ( $ ymlfile );
// (
// [foo] => bar
// [baz] => qux
// [foobar] => (
// [foo] => bar
// )
// )
Paramètre | Taper | Description |
---|---|---|
$ymlfile | chaîne | Le chemin du fichier à lire. |
Valeur de retour :
Le tableau analysé.
Définit une valeur dans un fichier yaml en utilisant la notation par points. Remarque : tous les commentaires du fichier seront supprimés !
Yml:: setFile ( string $ key , mixed $ value , string $ ymlfile ): boolean
Fonction globale associée (description voir ci-dessus).
(revenir en arrière)
yml_set_file ( string $ key , mixed $ value , string $ ymlfile ): boolean
$ ymlfile = ' /path/to/file.yml ' ;
yml_set_file ( ' foobar.foo ' , ' baz ' , $ ymlfile );
// foo: bar
// baz: qux
// foobar:
// foo: baz
Paramètre | Taper | Description |
---|---|---|
$key | chaîne | La chaîne à rechercher avec la notation par points |
$value | mixte | La valeur à définir sur la clé spécifiée. |
$ymlfile | chaîne | Le fichier yml dans lequel définir la valeur. |
Valeur de retour :
True si la valeur a été définie avec succès dans le fichier yaml, false sinon.
Transforme un tableau donné en syntaxe yaml et place son contenu dans un fichier donné. Attention : si le fichier existe, il sera écrasé !
Yml:: dumpFile ( array|object $ var , string $ filename , integer $ indent = 2 , integer $ wordwrap , boolean $ openingDashes = false ): boolean
Fonction globale associée (description voir ci-dessus).
(revenir en arrière)
to_yml_file ( array|object $ var , string $ filename , int $ indent = 2 , int $ wordwrap = 0 , bool $ openingDashes = false ): boolean
$ array = [
' foo ' => ' bar ' ,
' baz ' => ' qux '
];
to_yml_file ( $ array , ' /path/to/file.yml ' );
// foo: bar
// baz: qux
Paramètre | Taper | Description |
---|---|---|
$var | tableau|objet | Le tableau ou l'objet à transformer. |
$filename | chaîne | Le chemin d'accès au fichier dans lequel écrire la chaîne yaml. Attention : si le fichier existe déjà, il sera écrasé ! |
$indent | entier | Le retrait du yaml converti. La valeur par défaut est 2. |
$wordwrap | entier | Après le numéro donné, une chaîne sera enveloppée. La valeur par défaut est 0 (pas de retour à la ligne). |
$openingDashes | booléen | Vrai si la chaîne yaml doit commencer par des tirets ouvrants. La valeur par défaut est false. |
Valeur de retour :
Vrai en cas de succès, faux sinon.
Transforme un tableau ou un objet donné en chaîne yaml.
Yml:: dump ( array|object $ var , integer $ indent = 2 , integer $ wordwrap , boolean $ openingDashes = false ): string| null
Fonction globale associée (description voir ci-dessus).
(revenir en arrière)
to_yml ( array|object $ array , string $ filename , int $ indent = 2 , int $ wordwrap = 0 , bool $ openingDashes = false ): string| null
$ array = [
' foo ' => ' bar ' ,
' baz ' => ' qux ' ,
' foobar ' => [
' foo ' => ' bar '
]
];
to_yml ( $ array );
// foo: bar
// baz: qux
// foobar:
// foo: bar
Paramètre | Taper | Description |
---|---|---|
$var | tableau|objet | Le tableau ou l'objet à transformer. |
$indent | entier | Le retrait du yaml converti. La valeur par défaut est 2. |
$wordwrap | entier | Après le numéro donné, une chaîne sera enveloppée. La valeur par défaut est 0 (pas de retour à la ligne). |
$openingDashes | booléen | Vrai si la chaîne yaml doit commencer par des tirets ouvrants. La valeur par défaut est false. |
Valeur de retour :
La chaîne yaml convertie. En cas d'erreur, null est renvoyé.
Définit une valeur dans une chaîne yaml en utilisant la notation par points.
Yml:: set ( string $ key , mixed $ value , string & $ yml ): boolean
Fonction globale associée (description voir ci-dessus).
(revenir en arrière)
yml_set ( string $ key , mixed $ value , string & $ yml ): boolean
$ yml = "
foo: bar
baz: qux
foobar:
foo: bar
" ;
yml_set ( ' foobar.foo ' , ' baz ' , $ yml );
// foo: bar
// baz: qux
// foobar:
// foo: baz
Paramètre | Taper | Description |
---|---|---|
$key | chaîne | La chaîne à rechercher avec la notation par points |
$value | mixte | La valeur à définir sur la clé spécifiée. |
$yml | chaîne | La chaîne yml dans laquelle rechercher. Remarque : tous les commentaires de la chaîne seront supprimés ! |
Valeur de retour :
True si la valeur a été définie avec succès, false sinon.
Ce document a été généré automatiquement à partir des commentaires sur le code source du 22/01/2018 en utilisant phpDocumentor et cvuorinen/phpdoc-markdown-public