Fluent regular expressions in PHP
by Selvin Ortiz
Fluent Regular Expressions in PHP inspired by and largely based on VerbalExpressions:JS by Jesse Luoto
@see inspiration & credits below for more info.
Flux is available as a package via composer
"selvinortiz/flux": "dev-master"require_once 'path/to/vendor/autoload.php'use SelvinOrtiz\Utils\Flux\Flux;$flux = Flux::getInstance();You can additionally clone/download this repo and do whatever you want: )
This simple example illustrates the way you would use flux and it's fluent interface to build complex patterns.
…For other examples, please see the /etc directory.
length() method which adds or replaces the modifier used in the previous callgetLastSegmentKey()Factory class for optimized, often used patternsphpunit.xmlREADME and example files Pull Request #10getSegments() which was not included in 0.5.0 Issue #5removeSegment() which can be used in unit tests as welllineBreak() and br() which matches a new line (DOS/Unix)clear() which allows you to clear out the pattern and start from scratchgetPattern() which compiles the expression and returns itadd() and raw()orTry() methodchangeloggetSegments() to improve testability Issue #5dev branchSortiz\Tools to SelvinOrtiz\Utils\FluxaddSeed() and removeSeed() methods Issue #4getInstance() static methodFluxUrlExample.php, FluxDateExample.php, and FluxPhoneExample.phpgetSeed() to get the seed without forcing __toString on the objectgetSegment() to extract a segment (capturing group) from the patternPSR-2 Compliance (Tabs over Spaces)seed on match() and replace() Issue #4example.php and defines them elsewhere/etc and defines one example per fileFlux to the Sortiz\Tools namespacePSR-2 Compliance (Tabs over Spaces)Flux and this readme fileexample.phpfluxphone/date examplesletters() methodnumbers() method to digits()digits()ignoreCase() and promotes it above inAnyCase()Thought hard about changing the name to FluentX any thoughts?
either( $option1, $option2 [, $option3 ...] ) method to handle OR casesInitial preview release
Flux (*)The flux API was designed to give you a fluent chainable object to build patterns with.
startOfLine()Adds a beginning of line ^ modifier
endOfLine()Adds an end of line $ modifier
find( $val ) & then( $val )Allows you to augment the pattern with a required segment and it escapes regular expression characters
maybe( $val )Allows you to augment the pattern with an optional segment
any( $val ) & anyOf( $val )Allows you to create a set of characters to match
anything()Adds a wild card (.*) segment to the pattern but it does not make dotAll() explicit
anythingBut( $val )Will match anything but the characters in $val which is opposite of any() and anyOf
br() & lineBreak()Allows you to match a new line (DOS/Unix)
tab()Adds a (\t) to the pattern which will match a tab
word()Adds (\w+) to the pattern which will match a single word
letters( $min=null, $max=null )Only matches characters in the alphabet and uses $min and $max to create a quantifier
digits( $mix=null, $max=null )Only matches digits and uses $min and $max to create a quantifier like word()
range( $from, $to [, $from, $to ...])Allows you to create a range character class like a-z0-9 by calling range('a', 'z', 0, 9)
orTry( $val='' )Allows you to create OR cases (this)|(else) and retain the capturing order to use in replace()
ignoreCase() & inAnyCase()Adds the i modifier to the pattern which will allow you to match in a case insensitive manner
matchNewLine() & dotAll()Adds the s modifier to the pattern which will allow you to match a new line when using anything()
multiline()Adds the m modifier to the pattern which will allow you to search across multiple lines
oneLine() & searchOneLine()Removes the modifier added by multiline() if it was previously called
match( $subject )Simply takes your $subject in, compares it against the pattern, and returns whether a it matched or not
replace( $replacement, $subject )You can replace matched segments by using the $x format where x is the (int) position of the matched segment
getPattern()Returns the compiled pattern which you can also get by using the flux instance in a context where __toString() will be called
clear()Clears the created pattern along with the modifiers, prefixes, and suffixes
There is a straight port of Flux for NodeJS by James Brooks whom has also collaborated on this project.
This is something that started as a weekend experiment but I would love to take it further so if you have any suggestions, please fire away!
The best way to get in touch with me is via twitter @selvinortiz we'll take if from there :)
dev branch or branch offThis project is inspired and largely based on VerbalExpressions:JS by Jesse Luoto whom on July 20, 2013 started a weekend project that generated a lot of interest in the developer community and that project has proven to have a lot of potential.
Flux is not a straight port of VerbalExpressions but if you're interested in a straight VerbalExpressions port for PHP you should checkout VerbalExpressions:PHP by Mark Wilson
VerbalExpressions has also been ported to Ruby, Java, Groovy as of this update (July 25, 2013).
For a little background as to why flux was created and why you should use it, please refer to Issue #7 for a discussion on that matter.
Flux is released under the MIT license which pretty much means you can do with it as you please and I won't get mad because I'm that nice; )
No open issues yet, or sync has not completed.