regex

Regex wieder großartig machen

Die in PHP integrierten preg_* Funktionen erfordern einige seltsame Muster, wie die Übergabe von Variablen als Referenz und die Behandlung false oder null als Fehler. spatie/regex bietet eine übersichtlichere Schnittstelle für preg_match , preg_match_all , preg_replace und preg_replace_callback .

 use Spatie  Regex  Regex ;

// Using `match`
Regex:: match ( ' /a/ ' , ' abc ' ); // `MatchResult` object
Regex:: match ( ' /a/ ' , ' abc ' )-> hasMatch (); // true
Regex:: match ( ' /a/ ' , ' abc ' )-> result (); // 'a'

// Capturing groups with `match`
Regex:: match ( ' /a(b)/ ' , ' abc ' )-> result (); // 'ab'
Regex:: match ( ' /a(b)/ ' , ' abc ' )-> group ( 1 ); // 'b'

// Setting defaults
Regex:: match ( ' /a(b)/ ' , ' xyz ' )-> resultOr ( ' default ' ); // 'default'
Regex:: match ( ' /a(b)/ ' , ' xyz ' )-> groupOr ( 1 , ' default ' ); // 'default'

// Using `matchAll`
Regex:: matchAll ( ' /a/ ' , ' abcabc ' )-> hasMatch (); // true
Regex:: matchAll ( ' /a/ ' , ' abcabc ' )-> results (); // Array of `MatchResult` objects

// Using replace
Regex:: replace ( ' /a/ ' , ' b ' , ' abc ' )-> result (); // 'bbc' ;
Regex:: replace ( ' /a/ ' , function ( MatchResult $ result ) {
    return $ result -> result () . ' Hello! ' ;
}, ' abc ' )-> result (); // 'aHello!bc' ;

Spatie ist eine Webdesign-Agentur mit Sitz in Antwerpen, Belgien. Eine Übersicht aller unserer Open-Source-Projekte finden Sie auf unserer Website.

Unterstützen Sie uns

Wir investieren viele Ressourcen in die Erstellung erstklassiger Open-Source-Pakete. Sie können uns unterstützen, indem Sie eines unserer kostenpflichtigen Produkte kaufen.

Wir freuen uns sehr, dass Sie uns eine Postkarte aus Ihrer Heimatstadt schicken und erwähnen, welches unserer Pakete Sie verwenden. Unsere Adresse finden Sie auf unserer Kontaktseite. Wir veröffentlichen alle erhaltenen Postkarten auf unserer virtuellen Postkartenwand.

Installation

Sie können das Paket über Composer installieren:

composer require spatie/regex

Verwendung

Einmal ein Muster abgleichen

Entspricht einem Muster zu einem Thema. Gibt ein MatchResult Objekt für die erste Übereinstimmung zurück.

 / * *
 * @ param string $ pattern
 * @ param string $ subject
 *
 * @ return  Spatie  Regex  MatchResult
 * /
Regex:: match (string $ pattern , string $ subject ): MatchResult

MatchResult::hasMatch(): bool

Überprüft, ob das Muster mit dem Motiv übereinstimmt.

Regex:: match ( ' /abc/ ' , ' abc ' )-> hasMatch (); // true
Regex:: match ( ' /def/ ' , ' abc ' )-> hasMatch (); // false 

MatchResult::result(): string

Gibt die vollständige Übereinstimmung zurück, die erstellt wurde. Gibt null zurück, wenn keine Übereinstimmung gefunden wurde.

Regex:: match ( ' /abc/ ' , ' abc ' )-> result (); // 'abc'
Regex:: match ( ' /def/ ' , ' abc ' )-> result (); // null 

MatchResult::group(int $id): string

Gibt den Inhalt einer erfassten Gruppe zurück (mit einem 1-basierten Index). Löst eine RegexFailed Ausnahme aus, wenn die Gruppe nicht existiert.

Regex:: match ( ' /a(b)c/ ' , ' abc ' )-> group ( 1 ); // 'b'
Regex:: match ( ' /a(b)c/ ' , ' abc ' )-> group ( 2 ); // `RegexFailed` exception

Alle Vorkommen eines Musters abgleichen

Entspricht einem Muster zu einem Thema. Gibt ein MatchAllResult Objekt zurück, das alle Übereinstimmungen enthält.

 / * *
 * @ param string $ pattern
 * @ param string $ subject
 *
 * @ return  Spatie  Regex  MatchAllResult
 * /
public static function matchAll( string $ pattern , string $ subject ): MatchAllResult 

MatchAllResult::hasMatch(): bool

Überprüft, ob das Muster mit dem Motiv übereinstimmt.

Regex:: matchAll ( ' /abc/ ' , ' abc ' )-> hasMatch (); // true
Regex:: matchAll ( ' /abc/ ' , ' abcabc ' )-> hasMatch (); // true
Regex:: matchAll ( ' /def/ ' , ' abc ' )-> hasMatch (); // false 

MatchAllResult::results(): array

Gibt ein Array von MatchResult -Objekten zurück.

 $ results = Regex:: matchAll ( ' /ab([a-z])/ ' , ' abcabd ' )-> results ();

$ results [ 0 ]-> result (); // 'abc'
$ results [ 0 ]-> group ( 1 ); // 'c'
$ results [ 1 ]-> result (); // 'abd'
$ results [ 1 ]-> group ( 1 ); // 'd'

Ersetzen eines Musters in einem Motiv

Ersetzt ein Muster in einem Betreff. Gibt ein ReplaceResult Objekt zurück.

 / * *
 * @ param string | array $ pattern
 * @ param string | array | callable $ replacement
 * @ param string | array $ subject
 * @ param int $ limit
 *
 * @ return  Spatie  Regex  ReplaceResult
 * /
public static function replace( $ pattern , $ replacement , $ subject , $ limit = - 1 ): ReplaceResult 

ReplaceResult::result(): mixed

Regex:: replace ( ' /a/ ' , ' b ' , ' abc ' )-> result (); // 'bbc'

Regex::replace funktioniert auch mit Callables. Der Callable erhält eine MatchResult Instanz als Argument.

Regex:: replace ( ' /a/ ' , function ( MatchResult $ matchResult ) {
    return str_repeat ( $ matchResult -> result (), 2 );
}, ' abc ' )-> result (); // 'aabc'

Muster, Ersetzungen und Subjekte können ebenfalls Arrays sein. Regex::replace verhält sich in diesen Fällen genau wie preg_replace .

Fehlerbehandlung

Wenn in einer Regex -Methode etwas schief geht, wird eine RegexFailed Ausnahme ausgelöst. Eine Überprüfung von preg_last_error() ist nicht erforderlich.

Testen

$ composer test 

Änderungsprotokoll

Weitere Informationen zu den letzten Änderungen finden Sie im CHANGELOG.

Mitwirken

Weitere Informationen finden Sie unter BEITRAGEN.

Sicherheitslücken

Bitte lesen Sie unsere Sicherheitsrichtlinie zum Melden von Sicherheitslücken.

Postkartenartikel

Es steht Ihnen frei, dieses Paket zu verwenden, aber wenn es in Ihre Produktionsumgebung gelangt, würden wir uns sehr freuen, wenn Sie uns eine Postkarte aus Ihrer Heimatstadt schicken und erwähnen, welches unserer Pakete Sie verwenden.

Unsere Adresse lautet: Spatie, Kruikstraat 22, 2018 Antwerpen, Belgien.

Wir veröffentlichen alle erhaltenen Postkarten auf unserer Firmenwebsite.

Credits

• Sebastian De Deyne
• Alle Mitwirkenden

Lizenz

Die MIT-Lizenz (MIT). Weitere Informationen finden Sie in der Lizenzdatei.