verbalexpressions / phpverbalexpressions Goto Github PK

View Code? Open in Web Editor NEW

2.4K 2.4K 145.0 83 KB

PHP Regular expressions made easy

License: MIT License

PHP 100.00%

regular-expression verbalexpressions

phpverbalexpressions's Introduction

PHPVerbalExpressions

ported from VerbalExpressions

VerbalExpressions is a PHP library that helps to construct hard regular expressions.

Installation

The project supports Composer so you have to install Composer first, before project setup.

$ composer require  verbalexpressions/php-verbal-expressions:dev-master

Examples

<?php
// some tests
require './vendor/autoload.php';
use VerbalExpressions\PHPVerbalExpressions\VerbalExpressions;

$regex = new VerbalExpressions();

$regex->startOfLine()
      ->then("http")
      ->maybe("s")
      ->then("://")
      ->maybe("www.")
      ->anythingBut(" ")
      ->endOfLine();


if ($regex->test("http://github.com")) {
    echo "valid url". '<br>';
} else {
    echo "invalid url". '<br>';
}

if (preg_match($regex, 'http://github.com')) {
    echo 'valid url';
} else {
    echo 'invalid url';
}


echo "<pre>". $regex->getRegex() ."</pre>";

echo $regex->clean(array("modifiers" => "m", "replaceLimit" => 4))
           ->find(' ')
           ->replace("This is a small test http://somesite.com and some more text.", "-");

More examples are available in the following files:

Business readable language expression definition

$definition = 'start, then "http", maybe "s", then "://", maybe "www.", anything but " ", end';
$regex = new VerbalExpressionsScenario($definition);

Methods list

Name	Description	Usage
add	add values to the expression	add('abc')
startOfLine	mark expression with ^	startOfLine(false)
endOfLine	mark the expression with $	endOfLine()
then	add a string to the expression	add('foo')
find	alias for then	find('foo')
maybe	define a string that might appear once or not	maybe('.com')
anything	accept any string	anything()
anythingBut	accept any string but the specified char	anythingBut(',')
something	accept any non-empty string	something()
somethingBut	anything non-empty except for these chars	somethingBut('a')
replace	shorthand for preg_replace()	replace($source, $val)
lineBreak	match \r \n	lineBreak()
br	shorthand for lineBreak	br()
tab	match tabs \t	tab()
word	match \w+	word()
anyOf	any of the listed chars	anyOf('abc')
any	shorthand for anyOf	any('abc')
range	adds a range to the expression	range(a,z,0,9)
withAnyCase	match case default case sensitive	withAnyCase()
stopAtFirst	toggles the g modifiers	stopAtFirst()
addModifier	add a modifier	addModifier('g')
removeModifier	remove a mofier	removeModifier('g')
searchOneLine	Toggles m modifier	searchOneLine()
multiple	adds the multiple modifier	multiple('*')
_or	wraps the expression in an `or` with the provided value	_or('bar')
limit	adds char limit	limit(1,3)
test	performs a preg_match	test('[email protected]')

For all the above method (except test) you could use the VerbalExpressionsScenario.

Other Implementations

You can see an up to date list of all ports on VerbalExpressions.github.io.

Building the project and running the tests

The project supports Composer so you have to install Composer first before project setup.

curl -sS https://getcomposer.org/installer | php
php composer.phar install --dev
ln -s vendor/phpunit/phpunit/phpunit.php phpunit
./phpunit

phpverbalexpressions's People

Contributors

Stargazers

Watchers

Forkers

yienge martinsv ahmedsaoudi web5design signpostmarv cywang886 wordpressdev dxnabeel brianjsitz okwinza fmitchell vodd atticusbrooks frastel blogaristic geekybeaver object90 italoveloso bjzhush fachriza rrmodi88 talissonb npanasenko evheniy heatherevens coolcloud loaikh matiasnamendola vb2005xu mariquit mnishihan gauravparmar thomasalexander justinreeve stanleyinc npnikhil devlato brayancruces donglinkang fsann theneiam niklongstone zartata osub muhammad97 guidolearning filipeforattini malkakritter zitaarlen ddmler princelo growthaddict mishuvolan remitmaster ad3n brucezhang1993 imjerrybao bavragor geovanif halimbimantara eriksmets fhferreira nik4152 eric0808 mohamedsharaf iosifch shycool nobject pushpesh4u riboci infinitely-young platinumtechsolutions aganeshbabu83 leandromagela pandahisham jcsama denisalliswell tusharvikky kun-cockpit-tech jhorlima donozone trieg ikarius6 iamlos cynhard dilson-bd klimis baiyinnamula iruwl heera will-ashworth chuganghong visonwang taytus citycx bapijun mzf bryant1410 srmkliveforks jeanpaulruiz

phpverbalexpressions's Issues

InvalidArgumentException not exists

Also need addshort alias for class and some methods (endOfLine = eol, , removeModifier = rmMod and ets.)

Providing a tagged version?

I'm wondering if the library is by now stable enough to be given a tag - likely 1.0.0 - so it's less risky to depend on this library.
Having a version just makes it way easier to tie down a specific api.

Support for PHP 5.3-5.5

I was wondering if support for 5.3 to 5.5 would be an option, if the slow func_get_args would be just a different implementation of the single method, provided in another class.

A (new) abstract class would use: protected function range(array $args)
The existing class would just call parent::range($args)
A new class for older php would use parent::range(func_get_args())

That would allow older versions to work without negatively impacting the performance of newer versions of php and the change would not break current code.
Tests would need to be expanded to check that both range-implementations work the same if covering the single new line is desired.

If desired I'll write the required code, I'd like to have a 5.3 compatible version in any case.

anythingBut and a range doesn't work

Hello,

It seems it's not possible to do something like:

$regex->anythingBut('0-9')

since the sanitize method add systematically a "\" behind the "-" which break the regex range expression.
That giving us:

(?:[^0\-9]*)
instead of
(?:[^0-9]*)

Thanks a lot,
Aurélien

Inform in composer.json the minimum PHP version

Hi, it would be important to describe in composer.json which PHP versions is minimum for using this package (as described on http://getcomposer.org/doc/02-libraries.md#platform-packages)

Example:

{
    // ...
    "require": {
        // ...
        "php": ">=5.2"
    }
}

Using stopAtFirst in Business Readable language expression

Hello,

I am trying to use the Verbal Expressions to extract data from https://gist.github.com/ssmusoke/7a5e27ef80887e096b9886f5d2a83b7b

I am using the verbal expression

'start, then "🥇 |", something, then "<br> </a><br>", end'

However the
appears multiple times in the text so I would like to stop at the first occurance of the text, how can I do this as nothing that I have tried seems to work

Thank you in advance

Length restrictions?

Hey, does phpve support length restrictions like: \d{3}[A-Z]{2} ? I couldn't find it.

query regarding getRegex testing

I've noticed that JSVerbalExpressions & PHPVerbalExpressions don't produce the same output for the same input; Which of the VerbalExpressions projects is considered the "master" to test against?

example:
input:
regex->startOfLine()->range(0, 9, 'a', 'z', 'A', 'Z')->multiple('')

$js = '/^[0-9a-zA-Z](?:)*/gm';

$php = '/^[0-9a-zA-Z]+/m';

(variables edited to clarify language)