2017 © Pedro Peláez
 

library regex

A clean interface for building and working with regular expressions. Lightweight wrapper for the built in PCRE library (preg_* functions).

image

tea/regex

A clean interface for building and working with regular expressions. Lightweight wrapper for the built in PCRE library (preg_* functions).

  • Monday, January 9, 2017
  • by davidkyalo
  • Repository
  • 2 Watchers
  • 0 Stars
  • 12 Installations
  • PHP
  • 2 Dependents
  • 0 Suggesters
  • 0 Forks
  • 1 Open issues
  • 1 Versions
  • 0 % Grown

The README.md

Regex

PHP comes with a built-in regular expression library (PCRE), which provides the preg_* functions. Most of the time, these functions require some odd patterns like passing variables by reference and treating false or null values as errors. To make working with regex a bit more developer-friendly, tea/regex provides a clean interface for the preg_* functions as well as a human-readable API for building regular expressions., (*1)

Basic Usage.

To build and work with regular expressions, tea\regex provides a couple of flexible components., (*2)

  • The RegularExpression object which represents a regex pattern and provides various regex methods (match(), replace(), split()).
  • The Builder which provides a human-readable API for building regular expressions.
  • The Regex static facade which provides a static interface for the RegularExpression object.

Getting Started.

To perform regex functions such as match, replace, split, we need to create a RegularExpression instance. There are various ways to do this., (*3)

use Tea\Regex\Regex;
use function Tea\Regex\re;
use Tea\Regex\RegularExpression;

// 1. Creating directly.
$regex = new RegularExpression('^\d+-([A-Za-z]+)-([A-Za-z]+)');
$matches = $regex->match('254-foo-bar-baz'); // 'Tea\Regex\Result\Matches' object

// 2. Using the Regex static facade.
$regex = Regex::create('^\d+'); // 'Tea\Regex\RegularExpression' object
$replaced = $regex->replace('x', '254-foo-bar-baz'); // 'Tea\Regex\Result\Replacement' object

// 3. Using the re() function.
$regex = re('-'); // 'Tea\Regex\RegularExpression' object
$result = $regex->split('254-foo-bar-baz'); // array('254', 'foo', 'bar', 'baz')

Notice that the delimiters and modifiers are missing from the regex patterns used above? Yes. The methods above will throw an error if you provide a pattern with the delimiters and/or any modifiers set. In the examples above, / is be used as the delimiter and the u modifiers is set. / delimiter and u modifier are the default., (*4)

To set the delimiter and modifiers to be used:, (*5)

// Compiles to '#^ \d+ - ([A-Za-z]+) - ([A-Za-z]+)#ix'
$regex = new RegularExpression('^ \d+ - ([A-Za-z]+) - ([A-Za-z]+)', 'ix', '#');

// Compiles to '|^\d+|u'
$regex = Regex::create('^\d+', null, '|');

// Compiles to '/-/'
$regex = re('-', '', '/');

Creating with complete regex patterns., (*6)

$regex = RegularExpression::from('/^\d+/u');
Regex::from(...);
Regex::match(...);
Regex::replace(...);

Match

..., (*7)

MatchAll

..., (*8)

replace

..., (*9)

replaceCallback

..., (*10)

filter

..., (*11)

matches

..., (*12)

replaced

..., (*13)

split

..., (*14)

The Versions

09/01 2017

dev-master

9999999-dev https://github.com/TeaLabs/regex

A clean interface for building and working with regular expressions. Lightweight wrapper for the built in PCRE library (preg_* functions).

  Sources   Download

MIT

The Requires

 

The Development Requires

by David Kyalo

utils regex tea pcre regular expressions preg