Die Bibliothek clausnz/php-helpers
ist eine Sammlung von 45 nützlichen PHP-Hilfsfunktionen (PHP 5.6, 7.*)
.
Nach der Installation mit composer
sind die globalen Funktionen von überall in Ihrem Code aus zugänglich:
composer require clausnz/php-helpers
<?php
dump ( ' any content ' );
Wenn eine Funktion mit demselben Namen bereits in der Liste der definierten Funktionen Ihres Projekts (integriert und benutzerdefiniert) vorhanden ist, wird sie einfach nicht in Ihrer Umgebung registriert. Daher treten keine Konflikte mit vorhandenen Funktionen auf.
Dennoch ist jede Funktion mit der richtigen use-Anweisung weiterhin statisch zugänglich:
<?php
use CNZ Helpers Util as util ;
util:: dump ( ' any content ' );
Diese Bibliothek nutzt die folgenden brillanten und bekannten Bibliotheken:
Alle Funktionen werden anhand einer Reihe von Unit-Tests und PHP-Versionen getestet.
Installieren Sie die neueste clausnz/php-helper
Bibliothek mit Composer:
composer require clausnz/php-helpers
Stellen Sie außerdem sicher, dass Ihre Composer-Autoload-Datei erforderlich ist:
require __DIR__ . ' /vendor/autoload.php ' ;
Nach der Installation sind die neuen globalen PHP-Funktionen überall in Ihrem Code verfügbar. Um auf die (fast identischen) statischen Funktionen in den Hilfsklassen zuzugreifen, fügen Sie Ihrer Datei die entsprechende use-Anweisung hinzu:
<?php
use CNZ Helpers Dev as dev ;
if ( dev:: isIphone () ) {
// Do something here
}
Hilfsklasse, die einfachen Zugriff auf nützliche PHP-Array-Funktionen bietet.
Klasse Arr
Erkennt, ob der angegebene Wert ein assoziatives Array ist.
Arr:: isAssoc ( array $ array ): boolean
Zugehörige globale Funktion (Beschreibung siehe oben).
(zurückspringen)
is_assoc ( array $ array ): boolean
$ array = [
' foo ' => ' bar '
];
is_assoc ( $ array );
// bool(true)
Parameter | Typ | Beschreibung |
---|---|---|
$array | Array | Jede Art von Array. |
Rückgabewert:
True, wenn das Array assoziativ ist, andernfalls false.
Konvertiert ein Array in ein Objekt.
Arr:: toObject ( array $ array ): object| null
Zugehörige globale Funktion (Beschreibung siehe oben).
(zurückspringen)
to_object ( array $ array ): object| null
$ array = [
' foo ' => [
' bar ' => ' baz '
]
];
$ obj = to_object ( $ array );
echo $ obj -> foo -> bar ;
// baz
Parameter | Typ | Beschreibung |
---|---|---|
$array | Array | Das zu konvertierende Array. |
Rückgabewert:
Eine Standardobjektdarstellung des konvertierten Arrays.
Konvertiert einen String oder ein Objekt in ein Array.
Arr:: dump ( string|object $ var ): array| null
Zugehörige globale Funktion (Beschreibung siehe oben).
(zurückspringen)
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
// )
Parameter | Typ | Beschreibung |
---|---|---|
$var | Zeichenfolge|Objekt | String oder Objekt. |
Rückgabewert:
Eine Array-Darstellung der konvertierten Zeichenfolge oder des konvertierten Objekts. Gibt bei einem Fehler null zurück.
Gibt das erste Element eines Arrays zurück.
Arr:: first ( array $ array ): mixed
Zugehörige globale Funktion (Beschreibung siehe oben).
(zurückspringen)
array_first ( array $ array ): mixed
$ array = [
' foo ' => ' bar ' ,
' baz ' => ' qux '
];
array_first ( $ array )
// bar
Parameter | Typ | Beschreibung |
---|---|---|
$array | Array | Das betroffene Array. |
Rückgabewert:
Der Wert des ersten Elements, ohne Schlüssel. Gemischter Typ.
Gibt das letzte Element eines Arrays zurück.
Arr:: last ( array $ array ): mixed
Zugehörige globale Funktion (Beschreibung siehe oben).
(zurückspringen)
array_last ( array $ array ): mixed
$ array = [
' foo ' => ' bar ' ,
' baz ' => ' qux '
];
array_last ( $ array )
// qux
Parameter | Typ | Beschreibung |
---|---|---|
$array | Array | Das betroffene Array. |
Rückgabewert:
Der Wert des letzten Elements, ohne Schlüssel. Gemischter Typ.
Ruft einen Wert in einem Array in Punktnotation für die Schlüssel ab.
Arr:: get ( string $ key , array $ array ): mixed
Zugehörige globale Funktion (Beschreibung siehe oben).
(zurückspringen)
array_get ( string key, array $ array ): mixed
$ array = [
' foo ' => ' bar ' ,
' baz ' => [
' qux => ' foobar'
]
];
array_get ( ' baz.qux ' , $ array );
// foobar
Parameter | Typ | Beschreibung |
---|---|---|
$key | Zeichenfolge | Der Schlüssel durch Punktnotation. |
$array | Array | Das Array, in dem gesucht werden soll. |
Rückgabewert:
Der gesuchte Wert, andernfalls null.
Legt einen Wert in einem Array mithilfe der Punktnotation fest.
Arr:: set ( string $ key , mixed $ value , array & $ array ): boolean
Zugehörige globale Funktion (Beschreibung siehe oben).
(zurückspringen)
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
// ]
// )
Parameter | Typ | Beschreibung |
---|---|---|
$key | Zeichenfolge | Der Schlüssel, der mithilfe der Punktnotation festgelegt werden soll. |
$value | gemischt | Der Wert, der für den angegebenen Schlüssel festgelegt werden soll. |
$array | Array | Das betroffene Array. |
Rückgabewert:
True, wenn der neue Wert erfolgreich festgelegt wurde, andernfalls false.
Hilfsklasse, die in Verbindung mit dem Benutzeragenten einfachen Zugriff auf nützliche PHP-Funktionen ermöglicht.
Klassenentwickler
Bestimmt, ob das aktuelle Gerät ein Smartphone ist.
Dev:: isSmartphone ( ): boolean
Zugehörige globale Funktion (Beschreibung siehe oben).
(zurückspringen)
is_smartphone ( ): boolean
if ( is_smartphone () ) {
// I am a smartphone
}
Rückgabewert:
True, wenn der aktuelle Besucher ein Smartphone verwendet, andernfalls false.
Erkennt, ob der aktuelle Besucher ein mobiles Gerät (Smartphone/Tablet/Handheld) verwendet.
Dev:: isMobile ( ): boolean
Zugehörige globale Funktion (Beschreibung siehe oben).
(zurückspringen)
is_mobile ( ): boolean
if ( is_mobile () ) {
// I am a mobile device (smartphone/tablet or handheld)
}
Rückgabewert:
True, wenn der aktuelle Besucher ein mobiles Gerät verwendet, andernfalls false.
Holen Sie sich ein Singleton-MobileDetect-Objekt, um jede bereitgestellte Methode aufzurufen.
Dev::mobileDetect( ): Detection MobileDetect
Öffentlicher Zugriff zur Verwendung außerhalb dieser Klasse. Mobile_Detect-Doku: https://github.com/serbanghita/Mobile-Detect
Diese Methode hat keine zugehörige globale Funktion!
(zurückspringen)
Dev:: mobileDetect ()-> version ( ' Android ' );
// 8.1
Rückgabewert:
Ein Singleton-MobileDetect-Objekt zum Aufrufen aller bereitgestellten Methoden.
Bestimmt, ob der aktuelle Besucher ein Tablet-Gerät verwendet.
Dev:: isTablet ( ): boolean
Zugehörige globale Funktion (Beschreibung siehe oben).
(zurückspringen)
is_tablet ( ): boolean
if ( is_tablet () ) {
// I am a tablet
}
Rückgabewert:
True, wenn der aktuelle Besucher ein Tablet-Gerät verwendet, andernfalls false.
Bestimmt, ob der aktuelle Besucher einen Desktop-Computer verwendet.
Dev:: isDesktop ( ): boolean
Zugehörige globale Funktion (Beschreibung siehe oben).
(zurückspringen)
is_desktop ( ): boolean
if ( is_desktop () ) {
// I am a desktop computer (Mac, Linux, Windows)
}
Rückgabewert:
True, wenn der aktuelle Besucher einen Desktop-Computer verwendet, andernfalls false.
Bestimmt, ob der aktuelle Besucher eine Suchmaschine/Bot/Crawler/Spider ist.
Dev:: isRobot ( ): boolean
Zugehörige globale Funktion (Beschreibung siehe oben).
(zurückspringen)
is_robot ( ): boolean
if ( is_robot () ) {
// I am a robot (search engine, bot, crawler, spider)
}
Rückgabewert:
True, wenn der aktuelle Besucher eine Suchmaschine/ein Bot/Crawler/Spider ist, andernfalls false.
Holen Sie sich ein Singleton-CrawlerDetect-Objekt, um jede bereitgestellte Methode aufzurufen.
Dev::crawlerDetect( ): Jaybizzle CrawlerDetect CrawlerDetect
Öffentlicher Zugriff zur Verwendung außerhalb dieser Klasse. Crawler-Detect-Doku: https://github.com/JayBizzle/Crawler-Detect
Diese Methode hat keine zugehörige globale Funktion!
(zurückspringen)
Dev:: crawlerDetect ()-> getMatches ();
// Output the name of the bot that matched (if any)
Bestimmt, ob auf dem aktuellen Gerät ein Android-Betriebssystem ausgeführt wird.
Dev:: isAndroid ( ): boolean
Zugehörige globale Funktion (Beschreibung siehe oben).
(zurückspringen)
is_android ( ): boolean
if ( is_android () ) {
// I am an Android based device
}
Rückgabewert:
True, wenn der aktuelle Besucher ein Android-basiertes Gerät verwendet, andernfalls false.
Bestimmt, ob das aktuelle Gerät ein iPhone ist.
Dev:: isIphone ( ): boolean
Zugehörige globale Funktion (Beschreibung siehe oben).
(zurückspringen)
is_iphone ( ): boolean
if ( is_iphone () ) {
// I am an iPhone
}
Rückgabewert:
True, wenn der aktuelle Besucher ein iPhone verwendet, andernfalls false.
Ermittelt, ob das aktuelle Gerät von Samsung stammt.
Dev:: isSamsung ( ): boolean
Zugehörige globale Funktion (Beschreibung siehe oben).
(zurückspringen)
is_samsung ( ): boolean
if ( is_samsung () ) {
// I am a device from Samsung
}
Rückgabewert:
True, wenn der aktuelle Besucher ein Samsung-Gerät verwendet, andernfalls false.
Bestimmt, ob auf dem aktuellen Gerät ein iOS-Betriebssystem ausgeführt wird.
Dev:: isIOS ( ): boolean
Zugehörige globale Funktion (Beschreibung siehe oben).
(zurückspringen)
is_ios ( ): boolean
if ( is_ios () ) {
// I am an iOS based device
}
Rückgabewert:
True, wenn der aktuelle Besucher ein iOS-Gerät verwendet, andernfalls false.
Hilfsklasse, die einfachen Zugriff auf nützliche PHP-String-Funktionen bietet.
Klassenstr
Fügt einen oder mehrere Strings an einer definierten Position in einen anderen String ein.
Str:: insert ( array $ keyValue , string $ string ): string
Zugehörige globale Funktion (Beschreibung siehe oben).
(zurückspringen)
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.
Parameter | Typ | Beschreibung |
---|---|---|
$keyValue | Array | Ein assoziatives Array mit Schlüssel => Wertpaaren. |
$string | Zeichenfolge | Der Text mit den zu ersetzenden Zeichenfolgen. |
Rückgabewert:
Die ersetzte Zeichenfolge.
Gibt den Inhalt in einer Zeichenfolge zwischen einem linken und einem rechten Element zurück.
Str:: between ( string $ left , string $ right , string $ string ): array
Zugehörige globale Funktion (Beschreibung siehe oben).
(zurückspringen)
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
// )
Parameter | Typ | Beschreibung |
---|---|---|
$left | Zeichenfolge | Das linke Element der zu suchenden Zeichenfolge. |
$right | Zeichenfolge | Das richtige Element der zu suchenden Zeichenfolge. |
$string | Zeichenfolge | Die Zeichenfolge, in der gesucht werden soll. |
Rückgabewert:
Ein Ergebnisarray mit allen Treffern der Suche.
Gibt den Teil einer Zeichenfolge nach einem bestimmten Wert zurück.
Str:: after ( string $ search , string $ string ): string
Zugehörige globale Funktion (Beschreibung siehe oben).
(zurückspringen)
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
Parameter | Typ | Beschreibung |
---|---|---|
$search | Zeichenfolge | Die Zeichenfolge, nach der gesucht werden soll. |
$string | Zeichenfolge | Die Zeichenfolge, in der gesucht werden soll. |
Rückgabewert:
Die gefundene Zeichenfolge nach der Suchzeichenfolge. Leerzeichen am Anfang werden entfernt.
Rufen Sie den Teil einer Zeichenfolge vor einem bestimmten Wert ab.
Str:: before ( string $ search , string $ string ): string
Zugehörige globale Funktion (Beschreibung siehe oben).
(zurückspringen)
str_before ( string $ search , string $ string ): string
$ string = ' The quick brown fox jumps over the lazy dog ' ;
str_before ( ' fox ' $ string );
// The quick brown
Parameter | Typ | Beschreibung |
---|---|---|
$search | Zeichenfolge | Die Zeichenfolge, nach der gesucht werden soll. |
$string | Zeichenfolge | Die Zeichenfolge, in der gesucht werden soll. |
Rückgabewert:
Die gefundene Zeichenfolge vor der Suchzeichenfolge. Leerzeichen am Ende werden entfernt.
Begrenzen Sie die Anzahl der Wörter in einer Zeichenfolge. Setzen Sie den Wert $end an das Ende der Zeichenfolge.
Str:: limitWords ( string $ string , integer $ limit = 10 , string $ end = ' ... ' ): string
Zugehörige globale Funktion (Beschreibung siehe oben).
(zurückspringen)
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...
Parameter | Typ | Beschreibung |
---|---|---|
$string | Zeichenfolge | Die Zeichenfolge zur Begrenzung der Wörter. |
$limit | ganze Zahl | Die Anzahl der zu begrenzenden Wörter. Der Standardwert ist 10. |
$end | Zeichenfolge | Die Zeichenfolge zum Beenden der ausgeschnittenen Zeichenfolge. Standardmäßig ist '...' |
Rückgabewert:
Die begrenzte Zeichenfolge mit $end am Ende.
Begrenzen Sie die Anzahl der Zeichen in einer Zeichenfolge. Setzen Sie den Wert $end an das Ende der Zeichenfolge.
Str:: limit ( string $ string , integer $ limit = 100 , string $ end = ' ... ' ): string
Zugehörige globale Funktion (Beschreibung siehe oben).
(zurückspringen)
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...
Parameter | Typ | Beschreibung |
---|---|---|
$string | Zeichenfolge | Die Zeichenfolge zur Begrenzung der Zeichen. |
$limit | ganze Zahl | Die Anzahl der zu begrenzenden Zeichen. Der Standardwert ist 100. |
$end | Zeichenfolge | Die Zeichenfolge zum Beenden der ausgeschnittenen Zeichenfolge. Standardmäßig ist '...' |
Rückgabewert:
Die begrenzte Zeichenfolge mit $end am Ende.
Testet, ob eine Zeichenfolge ein bestimmtes Element enthält
Str:: contains ( string|array $ needle , string $ haystack ): boolean
Zugehörige globale Funktion (Beschreibung siehe oben).
(zurückspringen)
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)
Parameter | Typ | Beschreibung |
---|---|---|
$needle | string|array | Eine Zeichenfolge oder ein Array von Zeichenfolgen. |
$haystack | Zeichenfolge | Die Zeichenfolge, in der gesucht werden soll. |
Rückgabewert:
True, wenn $needle gefunden wird, andernfalls false.
Testet, ob eine Zeichenfolge ein bestimmtes Element enthält. Groß- und Kleinschreibung ignorieren.
Str:: containsIgnoreCase ( string|array $ needle , string $ haystack ): boolean
Zugehörige globale Funktion (Beschreibung siehe oben).
(zurückspringen)
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)
Parameter | Typ | Beschreibung |
---|---|---|
$needle | string|array | Eine Zeichenfolge oder ein Array von Zeichenfolgen. |
$haystack | Zeichenfolge | Die Zeichenfolge, in der gesucht werden soll. |
Rückgabewert:
True, wenn $needle gefunden wird, andernfalls false.
Bestimmen Sie, ob eine bestimmte Zeichenfolge mit einer bestimmten Teilzeichenfolge beginnt.
Str:: startsWith ( string|array $ needle , string $ haystack ): boolean
Zugehörige globale Funktion (Beschreibung siehe oben).
(zurückspringen)
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)
Parameter | Typ | Beschreibung |
---|---|---|
$needle | string|array | Die Zeichenfolge oder das Array von Zeichenfolgen, nach der gesucht werden soll. |
$haystack | Zeichenfolge | Die Zeichenfolge, in der gesucht werden soll. |
Rückgabewert:
True, wenn $needle gefunden wurde, andernfalls false.
Bestimmen Sie, ob eine bestimmte Zeichenfolge mit einer bestimmten Teilzeichenfolge beginnt. Groß- und Kleinschreibung ignorieren.
Str:: startsWithIgnoreCase ( string|array $ needle , string $ haystack ): boolean
Zugehörige globale Funktion (Beschreibung siehe oben).
(zurückspringen)
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)
Parameter | Typ | Beschreibung |
---|---|---|
$needle | string|array | Die Zeichenfolge oder das Array von Zeichenfolgen, nach der gesucht werden soll. |
$haystack | Zeichenfolge | Die Zeichenfolge, in der gesucht werden soll. |
Rückgabewert:
True, wenn $needle gefunden wurde, andernfalls false.
Bestimmen Sie, ob eine bestimmte Zeichenfolge mit einer bestimmten Teilzeichenfolge endet.
Str:: endsWith ( string|array $ needle , string $ haystack ): boolean
Zugehörige globale Funktion (Beschreibung siehe oben).
(zurückspringen)
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)
Parameter | Typ | Beschreibung |
---|---|---|
$needle | string|array | Die Zeichenfolge oder das Array von Zeichenfolgen, nach der gesucht werden soll. |
$haystack | Zeichenfolge | Die Zeichenfolge, in der gesucht werden soll. |
Rückgabewert:
True, wenn $needle gefunden wurde, andernfalls false.
Bestimmen Sie, ob eine bestimmte Zeichenfolge mit einer bestimmten Teilzeichenfolge endet.
Str:: endsWithIgnoreCase ( string|array $ needle , string $ haystack ): boolean
Zugehörige globale Funktion (Beschreibung siehe oben).
(zurückspringen)
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)
Parameter | Typ | Beschreibung |
---|---|---|
$needle | string|array | Die Zeichenfolge oder das Array von Zeichenfolgen, nach der gesucht werden soll. |
$haystack | Zeichenfolge | Die Zeichenfolge, in der gesucht werden soll. |
Rückgabewert:
True, wenn $needle gefunden wurde, andernfalls false.
Gibt den Teil einer Zeichenfolge nach dem letzten Vorkommen eines bestimmten Suchwerts zurück.
Str:: afterLast ( string $ search , string $ string ): string
Zugehörige globale Funktion (Beschreibung siehe oben).
(zurückspringen)
str_after_last ( string $ search , string $ string ): string
$ path = " /var/www/html/public/img/image.jpg " ;
str_after_last ( ' / ' $ path );
// image.jpg
Parameter | Typ | Beschreibung |
---|---|---|
$search | Zeichenfolge | Die Zeichenfolge, nach der gesucht werden soll. |
$string | Zeichenfolge | Die Zeichenfolge, in der gesucht werden soll. |
Rückgabewert:
Die gefundene Zeichenfolge nach dem letzten Vorkommen der Suchzeichenfolge. Leerzeichen am Anfang werden entfernt.
Hilfsklasse, die einfachen Zugriff auf nützliche allgemeine PHP-Funktionen bietet.
Klasse Util
Bestätigen Sie eine bestimmte E-Mail-Adresse.
Util:: isEmail ( string $ email ): boolean
Zugehörige globale Funktion (Beschreibung siehe oben).
(zurückspringen)
is_email ( string $ email ): boolean
$ email = ' [email protected] ' ;
is_email ( $ email );
// bool(true)
Parameter | Typ | Beschreibung |
---|---|---|
$email | Zeichenfolge | Die zu testende E-Mail-Adresse. |
Rückgabewert:
True, wenn die angegebene Zeichenfolge eine gültige E-Mail-Adresse ist, andernfalls false.
Rufen Sie die aktuelle IP-Adresse des Benutzers ab.
Util:: ip ( ): string| null
Zugehörige globale Funktion (Beschreibung siehe oben).
(zurückspringen)
ip ( ): null|string
echo ip ();
// 127.0.0.1
Rückgabewert:
Die erkannte IP-Adresse, null, wenn die IP nicht erkannt wurde.
Erstellt einen sicheren Hash aus einem bestimmten Passwort. Verwendet den CRYPT_BLOWFISH-Algorithmus.
Util:: cryptPassword ( string $ password ): string
Hinweis: 255 Zeichen für Datenbankspalte empfohlen!
Zugehörige globale Funktion (Beschreibung siehe oben).
(zurückspringen)
crypt_password ( string $ password ): string
$ password = ' foobar ' ;
crypt_password ( $ password );
// $2y$10$6qKwbwTgwQNcmcaw04eSf.QpP3.4T0..bEnY62dd1ozM8L61nb8AC
Parameter | Typ | Beschreibung |
---|---|---|
$password | Zeichenfolge | Das Passwort zum Verschlüsseln. |
Rückgabewert:
Das verschlüsselte Passwort.
Überprüft, ob ein Passwort mit einem verschlüsselten Passwort übereinstimmt (CRYPT_BLOWFISH-Algorithmus).
Util:: isPassword ( string $ password , string $ cryptedPassword ): boolean
Zugehörige globale Funktion (Beschreibung siehe oben).
(zurückspringen)
is_password ( string $ password , string $ cryptedPassword ): boolean
$ password = ' foobar ' ;
$ cryptedPassword = ' $2y$10$6qKwbwTgwQNcmcaw04eSf.QpP3.4T0..bEnY62dd1ozM8L61nb8AC ' ;
is_password ( $ password , $ cryptedPassword );
// bool(true)
Parameter | Typ | Beschreibung |
---|---|---|
$password | Zeichenfolge | Das zu testende Passwort. |
$cryptedPassword | Zeichenfolge | Das verschlüsselte Passwort (z. B. in der Datenbank gespeichert). |
Gibt den Inhalt der angegebenen Variablen aus und beendet das Skript.
Util:: dd ( mixed $ var )
Zugehörige globale Funktion (Beschreibung siehe oben).
(zurückspringen)
dd ( mixed $ var )
$ array = [
' foo ' => ' bar ' ,
' baz ' => ' qux '
];
dd ( $ array );
// (
// [foo] => bar
// [baz] => qux
// )
Parameter | Typ | Beschreibung |
---|---|---|
$var | gemischt | Die zu löschende Variable. |
Gibt den Inhalt der angegebenen Variablen aus. Das Skript stoppt nach dem Aufruf NICHT.
Util:: dump ( mixed $ var )
Zugehörige globale Funktion (Beschreibung siehe oben).
(zurückspringen)
dump ( mixed $ var )
$ array = [
' foo ' => ' bar ' ,
' baz ' => ' qux '
];
dump ( $ array );
// (
// [foo] => bar
// [baz] => qux
// )
Parameter | Typ | Beschreibung |
---|---|---|
$var | gemischt | Die zu löschende Variable. |
Hilfsklasse, die einfachen Zugriff auf nützliche PHP-YML-Funktionen bietet.
Klasse Yml
Überprüft, ob eine bestimmte Datei Yaml-Syntax enthält.
Yml:: isValidFile ( string $ file ): boolean
Zugehörige globale Funktion (Beschreibung siehe oben).
(zurückspringen)
is_yml_file ( string $ file ): boolean
$ file = /path/to/file.yml
is_yml_file ( $ file );
// bool(true)
Parameter | Typ | Beschreibung |
---|---|---|
$file | Zeichenfolge | Die Datei, die auf Yaml-Syntax getestet werden soll. |
Rückgabewert:
True, wenn die Datei Yaml-Syntax enthält, andernfalls false.
Testet, ob die Syntax einer bestimmten Zeichenfolge Yaml ist.
Yml:: isValid ( string $ string ): boolean
Zugehörige globale Funktion (Beschreibung siehe oben).
(zurückspringen)
is_yml ( string $ string ): boolean
$ string = "
foo: bar
baz: qux
foobar:
foo: bar
" ;
is_yml ( $ string );
// bool(true)
Parameter | Typ | Beschreibung |
---|---|---|
$string | Zeichenfolge | Die Zeichenfolge, die auf Yaml-Syntax getestet werden soll. |
Rückgabewert:
True, wenn die Zeichenfolge Yaml ist, andernfalls false.
Wandelt einen gegebenen Yaml-String in ein Array um.
Yml:: parse ( string $ yml ): array| null
Zugehörige globale Funktion (Beschreibung siehe oben).
(zurückspringen)
yml_parse ( string $ yml ): array| null
$ yml = "
foo: bar
baz: qux
foobar:
foo: bar
" ;
yml_parse ( $ yml );
// (
// [foo] => bar
// [baz] => qux
// [foobar] => (
// [foo] => bar
// )
// )
Parameter | Typ | Beschreibung |
---|---|---|
$yml | Zeichenfolge | Der zu analysierende Yaml-String. |
Rückgabewert:
Das transformierte Array, null bei Fehler.
Ruft einen Wert in einer Yaml-Zeichenfolge unter Verwendung der Punktnotation ab.
Yml:: get ( string $ key , string $ yml ): mixed
Zugehörige globale Funktion (Beschreibung siehe oben).
(zurückspringen)
yml_get ( string $ key , string $ yml ): mixed
$ yml = "
foo: bar
baz: qux
foobar:
foo: bar
" ;
yml_get ( ' foobar.foo ' , $ yml );
// bar
Parameter | Typ | Beschreibung |
---|---|---|
$key | Zeichenfolge | Der Schlüssel für die Suche mit Punktnotation (z. B. „foo.bar.baz“). |
$yml | Zeichenfolge | Die YML-Zeichenfolge, in der gesucht werden soll. |
Rückgabewert:
Der gefundene Wert, andernfalls null.
Ruft mithilfe der Punktnotation einen Wert in einer Yaml-Datei ab.
Yml:: getFile ( string $ key , string $ ymlfile ): mixed
Zugehörige globale Funktion (Beschreibung siehe oben).
(zurückspringen)
yml_get_file ( string $ key , string $ ymlfile ): mixed
$ ymlfile = ' /path/to/file.yml ' ;
yml_get_file ( ' foobar.foo ' , $ ymlfile );
// bar
Parameter | Typ | Beschreibung |
---|---|---|
$key | Zeichenfolge | Der Schlüssel für die Suche mit Punktnotation (z. B. „foo.bar.baz“). |
$ymlfile | Zeichenfolge | Die YML-Datei, in der gesucht werden soll. |
Rückgabewert:
Der gefundene Wert, andernfalls null.
Lädt den Inhalt einer Yaml-Datei in ein Array.
Yml:: parseFile ( string $ ymlfile ): array
Zugehörige globale Funktion (Beschreibung siehe oben).
(zurückspringen)
yml_parse_file ( string $ ymlfile ): array| null
$ ymlfile = ' /path/to/file.yml ' ;
yml_parse_file ( $ ymlfile );
// (
// [foo] => bar
// [baz] => qux
// [foobar] => (
// [foo] => bar
// )
// )
Parameter | Typ | Beschreibung |
---|---|---|
$ymlfile | Zeichenfolge | Der Pfad der Datei, aus der gelesen werden soll. |
Rückgabewert:
Das analysierte Array.
Legt einen Wert in einer Yaml-Datei mithilfe der Punktnotation fest. Hinweis: Alle Kommentare in der Datei werden entfernt!
Yml:: setFile ( string $ key , mixed $ value , string $ ymlfile ): boolean
Zugehörige globale Funktion (Beschreibung siehe oben).
(zurückspringen)
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
Parameter | Typ | Beschreibung |
---|---|---|
$key | Zeichenfolge | Die zu durchsuchende Zeichenfolge mit Punktnotation |
$value | gemischt | Der Wert, der für den angegebenen Schlüssel festgelegt werden soll. |
$ymlfile | Zeichenfolge | Die YML-Datei, in der der Wert festgelegt werden soll. |
Rückgabewert:
True, wenn der Wert erfolgreich in der Yaml-Datei festgelegt wurde, andernfalls false.
Wandelt ein bestimmtes Array in Yaml-Syntax um und fügt seinen Inhalt in eine bestimmte Datei ein. Hinweis: Wenn die Datei vorhanden ist, wird sie überschrieben!
Yml:: dumpFile ( array|object $ var , string $ filename , integer $ indent = 2 , integer $ wordwrap , boolean $ openingDashes = false ): boolean
Zugehörige globale Funktion (Beschreibung siehe oben).
(zurückspringen)
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
Parameter | Typ | Beschreibung |
---|---|---|
$var | Array|Objekt | Das zu transformierende Array oder Objekt. |
$filename | Zeichenfolge | Der Pfad zur Datei, in die der Yaml-String geschrieben werden soll. Hinweis: Wenn die Datei bereits existiert, wird sie überschrieben! |
$indent | ganze Zahl | Der Einzug des konvertierten Yaml. Standardmäßig ist 2. |
$wordwrap | ganze Zahl | Nach der angegebenen Zahl wird ein String umbrochen. Standardmäßig 0 (kein Zeilenumbruch). |
$openingDashes | Boolescher Wert | True, wenn die Yaml-Zeichenfolge mit öffnenden Bindestrichen beginnen soll. Der Standardwert ist „false“. |
Rückgabewert:
Bei Erfolg wahr, andernfalls falsch.
Wandelt ein bestimmtes Array oder Objekt in einen Yaml-String um.
Yml:: dump ( array|object $ var , integer $ indent = 2 , integer $ wordwrap , boolean $ openingDashes = false ): string| null
Zugehörige globale Funktion (Beschreibung siehe oben).
(zurückspringen)
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
Parameter | Typ | Beschreibung |
---|---|---|
$var | Array|Objekt | Das zu transformierende Array oder Objekt. |
$indent | ganze Zahl | Der Einzug des konvertierten Yaml. Standardmäßig ist 2. |
$wordwrap | ganze Zahl | Nach der angegebenen Zahl wird ein String umbrochen. Standardmäßig 0 (kein Zeilenumbruch). |
$openingDashes | Boolescher Wert | True, wenn die Yaml-Zeichenfolge mit öffnenden Bindestrichen beginnen soll. Der Standardwert ist „false“. |
Rückgabewert:
Der konvertierte Yaml-String. Bei Fehlern wird null zurückgegeben.
Legt einen Wert in einer Yaml-Zeichenfolge mithilfe der Punktnotation fest.
Yml:: set ( string $ key , mixed $ value , string & $ yml ): boolean
Zugehörige globale Funktion (Beschreibung siehe oben).
(zurückspringen)
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
Parameter | Typ | Beschreibung |
---|---|---|
$key | Zeichenfolge | Die zu durchsuchende Zeichenfolge mit Punktnotation |
$value | gemischt | Der Wert, der für den angegebenen Schlüssel festgelegt werden soll. |
$yml | Zeichenfolge | Die YML-Zeichenfolge, in der gesucht werden soll. Hinweis: Alle Kommentare in der Zeichenfolge werden entfernt! |
Rückgabewert:
True, wenn der Wert erfolgreich festgelegt wurde, andernfalls false.
Dieses Dokument wurde am 22.01.2018 automatisch aus Quellcodekommentaren mit phpDocumentor und cvuorinen/phpdoc-markdown-public generiert