NooNoo Fluent Regex

DEPRECEATION

This repo is no longer maintained - I highly recommend you move your code usage over to https://github.com/selvinortiz/flux - it features a very similar API!

What

Build Regex expressions using fluent setters and English language terms

$regex = new Regex();

//regex for a url
$regex->start()
      ->then("http")
      ->maybe("s")
      ->then("://")
      ->maybe("www.")
      ->oneOrMore()
      ->slugchar()
      ->either(".co", ".com")
      ->zeroOrMore()
      ->slugchar()
      ->end();

echo $regex; // ^(http)(s)?(\:\/\/)(www\.)?([a-zA-Z0-9-_\/]+)(\.co|\.com)([a-zA-Z0-9-_\/]*)$

Docs

Please see DOCS.md for full details on the API documentation

Changelog

• 0.0.2

  • I've not touched this in 4 years! Figured it was time I improved things a little :smile:
  • Moved code around
  • Improved doc blocks
  • Improved README
  • Started putting together some proper API docs

• 0.0.1

  • First major release, landed on Github

Roadmap

Please see ROADMAP.md for further details on upcoming featuresa

Examples

Exclusive! Build your Regex using Yorkshire Slang!

Here's the above example, but this time, a bit more...~~Northern~~ Better

$regex->eyUp()
      ->goOnThen("http")
      ->couldAppen("s")
      ->goOnThen("://")
      ->couldAppen("www.")
      ->oneOrMore()
      ->slugchar()
      ->oneOrTother(".co", ".com")
      ->zeroOrMore()
      ->slugchar()
      ->thatllDo();

Finding Matches

We can use the Match class to return capture groups for an input and a Regex pattern (as well as checking that the pattern matches the text, obviously)

Simple Match

$regex = new Regex();

$regex->start()
        ->then("Hello, ")
        ->then("world!")
        ->end();

$match = new Match("Hello, world!", $regex);

$match->isMatch(); // returns true

//thanks to invoke, you can also just check against the object itself

//ex. this returns true
if ($match)
    return true;
else
    return false;

If you build your pattern using a NooNooFluentRegex Regex object, each "chunk" that could contain characters will be its own capture group.

$regex->start()
      ->then("http")
      ->maybe("s")
      ->then("://")
      ->maybe("www.")
      ->oneOrMore()
      ->slugchar()
      ->either(".co", ".com")
      ->zeroOrMore()
      ->slugchar()
      ->end();

$match = new Match("http://www.example.com/example_page", $regex);

echo $match->getGroup(5); // echos "example"

You can also return groups using specified names

$regex = new Regex();

$regex->start()
    ->lowercase("lowercase")
    ->uppercase("uppercase")
    ->raw("[A-Z][a-z]+", "name")
    ->digit("number1")
    ->digit("number2") // number 2...hehehehe
    ->end();

$match = new Match("aZTom69", $regex);

echo $match->getGroup("name"); // echos "Tom"
echo $match->getGroup("uppercase"); // echos "Z"

Doing Replacements

We can use the Replacer class to do both mass replacements and individual, case-by-case replacements.

$regex = new Regex();

$regex->start()
        ->raw("[A-Z][a-z]+")
        ->end();

//we set up the replacer with a pattern, and a replacement to use
$replacer = new Replacer($regex, "Tom");

//now that those 2 are set up, you can start doing mass replacements

echo $replacer->replace("Sam went to play football"); //echos out "Tom went to play football";
echo $replacer->replace("Dave goes to the shop"); //echos out "Tom goes to the shop";

You can pass in an optional argument to the replace function to do case by case replacements.

//using the same variables as before

echo $replacer->replace("Martin plays too much Starcraft", "Sally"); // "Sally plays too much Starcraft"
echo $replacer->replace("Martin plays too much Starcraft"); // "Tom plays too much Starcraft"