Download the PHP package spatie/regex without Composer
On this page you can find all versions of the php package spatie/regex. It is possible to download/install these versions without Composer. Possible dependencies are resolved automatically.
Package regex
Short Description A sane interface for php's built in preg_* functions
License MIT
Homepage https://github.com/spatie/regex
Informations about the package regex
Making regex great again
Php's built in preg_*
functions require some odd patterns like passing variables by reference and treating false
or null
values as errors. spatie/regex
provides a cleaner interface for preg_match
, preg_match_all
, preg_replace
and preg_replace_callback
.
Spatie is a webdesign agency based in Antwerp, Belgium. You'll find an overview of all our open source projects on our website.
Support us
We invest a lot of resources into creating best in class open source packages. You can support us by buying one of our paid products.
We highly appreciate you sending us a postcard from your hometown, mentioning which of our package(s) you are using. You'll find our address on our contact page. We publish all received postcards on our virtual postcard wall.
Installation
You can install the package via composer:
Usage
Matching a pattern once
Matches a pattern on a subject. Returns a MatchResult
object for the first match.
MatchResult::hasMatch(): bool
Checks if the pattern matches the subject.
MatchResult::result(): string
Return the full match that was made. Returns null
if no match was made.
MatchResult::group(int $id): string
Return the contents of a captured group (with a 1-based index). Throws a RegexFailed
exception if the group doesn't exist.
Matching all occurences of a pattern
Matches a pattern on a subject. Returns a MatchAllResult
object containing all matches.
MatchAllResult::hasMatch(): bool
Checks if the pattern matches the subject.
MatchAllResult::results(): array
Returns an array of MatchResult
objects.
Replacing a pattern in a subject
Replaces a pattern in a subject. Returns a ReplaceResult
object.
ReplaceResult::result(): mixed
Regex::replace
also works with callables. The callable will receive a MatchResult
instance as it's argument.
Patterns, replacements and subjects can also be arrays. Regex::replace
behaves exactly like preg_replace
in those instances.
Error handling
If anything goes wrong in a Regex
method, a RegexFailed
exception gets thrown. No need for checking preg_last_error()
.
Testing
Changelog
Please see CHANGELOG for more information on what has changed recently.
Contributing
Please see CONTRIBUTING for details.
Security Vulnerabilities
Please review our security policy on how to report security vulnerabilities.
Postcardware
You're free to use this package, but if it makes it to your production environment we highly appreciate you sending us a postcard from your hometown, mentioning which of our package(s) you are using.
Our address is: Spatie, Kruikstraat 22, 2018 Antwerp, Belgium.
We publish all received postcards on our company website.
Credits
- Sebastian De Deyne
- All Contributors
License
The MIT License (MIT). Please see License File for more information.