immutable

#RegExp

This class is here to help make sure that a string is a regular expression so you can safely type against this class.

#::of()

This is the named cosntructor for this class.

RegExp::of('/foo/') instanceof RegExp; // true
RegExp::of('foo'); // throws Innmind\Immutable\Exception\LogicException

#->matches()

Both examples do the same thing.

RegExp::of('/^a/')->matches(Str::of('abcdef'));
Str::of('abcdef')->matches('/^a/');

#->capture()

Both examples do the same thing.

RegExp::of('@^(?:http://)?(?P[^/]+)@i')->capture(Str::of('http://www.php.net/index.html'));
Str::of('http://www.php.net/index.html')->capture('@^(?:http://)?(?P[^/]+)@i');

#->toString()

Return the string representation of the regular expression.

RegExp::of('/foo/')->toString(); // '/foo/'