regex

Делаем регулярное выражение снова отличным

Встроенные в PHP функции preg_* требуют некоторых странных шаблонов, таких как передача переменных по ссылке и обработка false или null значений как ошибок. spatie/regex обеспечивает более чистый интерфейс для preg_match , preg_match_all , preg_replace и preg_replace_callback .

 use Spatie  Regex  Regex ;

// Using `match`
Regex:: match ( ' /a/ ' , ' abc ' ); // `MatchResult` object
Regex:: match ( ' /a/ ' , ' abc ' )-> hasMatch (); // true
Regex:: match ( ' /a/ ' , ' abc ' )-> result (); // 'a'

// Capturing groups with `match`
Regex:: match ( ' /a(b)/ ' , ' abc ' )-> result (); // 'ab'
Regex:: match ( ' /a(b)/ ' , ' abc ' )-> group ( 1 ); // 'b'

// Setting defaults
Regex:: match ( ' /a(b)/ ' , ' xyz ' )-> resultOr ( ' default ' ); // 'default'
Regex:: match ( ' /a(b)/ ' , ' xyz ' )-> groupOr ( 1 , ' default ' ); // 'default'

// Using `matchAll`
Regex:: matchAll ( ' /a/ ' , ' abcabc ' )-> hasMatch (); // true
Regex:: matchAll ( ' /a/ ' , ' abcabc ' )-> results (); // Array of `MatchResult` objects

// Using replace
Regex:: replace ( ' /a/ ' , ' b ' , ' abc ' )-> result (); // 'bbc' ;
Regex:: replace ( ' /a/ ' , function ( MatchResult $ result ) {
    return $ result -> result () . ' Hello! ' ;
}, ' abc ' )-> result (); // 'aHello!bc' ;

Spatie — агентство веб-дизайна, базирующееся в Антверпене, Бельгия. На нашем сайте вы найдете обзор всех наших проектов с открытым исходным кодом.

Поддержите нас

Мы вкладываем много ресурсов в создание лучших в своем классе пакетов с открытым исходным кодом. Вы можете поддержать нас, купив один из наших платных продуктов.

Мы очень признательны вам за отправку нам открытки из вашего родного города с указанием того, какой из наших пакетов вы используете. Наш адрес вы найдете на странице контактов. Все полученные открытки мы публикуем на нашей виртуальной стене открыток.

Установка

Вы можете установить пакет через композитор:

composer require spatie/regex

Использование

Сопоставление шаблона один раз

Соответствует образцу на предмете. Возвращает объект MatchResult для первого совпадения.

 / * *
 * @ param string $ pattern
 * @ param string $ subject
 *
 * @ return  Spatie  Regex  MatchResult
 * /
Regex:: match (string $ pattern , string $ subject ): MatchResult

MatchResult::hasMatch(): bool

Проверяет, соответствует ли шаблон теме.

Regex:: match ( ' /abc/ ' , ' abc ' )-> hasMatch (); // true
Regex:: match ( ' /def/ ' , ' abc ' )-> hasMatch (); // false 

MatchResult::result(): string

Верните полное совпадение, которое было найдено. Возвращает null если совпадений не обнаружено.

Regex:: match ( ' /abc/ ' , ' abc ' )-> result (); // 'abc'
Regex:: match ( ' /def/ ' , ' abc ' )-> result (); // null 

MatchResult::group(int $id): string

Возвращает содержимое захваченной группы (с индексом, отсчитываемым от 1). Выдает исключение RegexFailed , если группа не существует.

Regex:: match ( ' /a(b)c/ ' , ' abc ' )-> group ( 1 ); // 'b'
Regex:: match ( ' /a(b)c/ ' , ' abc ' )-> group ( 2 ); // `RegexFailed` exception

Сопоставление всех вхождений шаблона

Соответствует образцу на предмете. Возвращает объект MatchAllResult содержащий все совпадения.

 / * *
 * @ param string $ pattern
 * @ param string $ subject
 *
 * @ return  Spatie  Regex  MatchAllResult
 * /
public static function matchAll( string $ pattern , string $ subject ): MatchAllResult 

MatchAllResult::hasMatch(): bool

Проверяет, соответствует ли шаблон теме.

Regex:: matchAll ( ' /abc/ ' , ' abc ' )-> hasMatch (); // true
Regex:: matchAll ( ' /abc/ ' , ' abcabc ' )-> hasMatch (); // true
Regex:: matchAll ( ' /def/ ' , ' abc ' )-> hasMatch (); // false 

MatchAllResult::results(): array

Возвращает массив объектов MatchResult .

 $ results = Regex:: matchAll ( ' /ab([a-z])/ ' , ' abcabd ' )-> results ();

$ results [ 0 ]-> result (); // 'abc'
$ results [ 0 ]-> group ( 1 ); // 'c'
$ results [ 1 ]-> result (); // 'abd'
$ results [ 1 ]-> group ( 1 ); // 'd'

Замена рисунка в теме

Заменяет шаблон в теме. Возвращает объект ReplaceResult .

 / * *
 * @ param string | array $ pattern
 * @ param string | array | callable $ replacement
 * @ param string | array $ subject
 * @ param int $ limit
 *
 * @ return  Spatie  Regex  ReplaceResult
 * /
public static function replace( $ pattern , $ replacement , $ subject , $ limit = - 1 ): ReplaceResult 

ReplaceResult::result(): mixed

Regex:: replace ( ' /a/ ' , ' b ' , ' abc ' )-> result (); // 'bbc'

Regex::replace также работает с вызываемыми объектами. Вызываемый объект получит экземпляр MatchResult в качестве аргумента.

Regex:: replace ( ' /a/ ' , function ( MatchResult $ matchResult ) {
    return str_repeat ( $ matchResult -> result (), 2 );
}, ' abc ' )-> result (); // 'aabc'

Шаблоны, замены и предметы также могут быть массивами. В этих случаях Regex::replace ведет себя точно так же, как preg_replace .

Обработка ошибок

Если в методе Regex что-то пойдет не так, генерируется исключение RegexFailed . Нет необходимости проверять preg_last_error() .

Тестирование

$ composer test 

Журнал изменений

Пожалуйста, посетите CHANGELOG для получения дополнительной информации о том, что изменилось за последнее время.

Содействие

Пожалуйста, смотрите ВКЛАД для получения подробной информации.

Уязвимости безопасности

Пожалуйста, ознакомьтесь с нашей политикой безопасности, чтобы узнать, как сообщать об уязвимостях безопасности.

Открытки

Вы можете свободно использовать этот пакет, но если он попадет в вашу производственную среду, мы будем очень признательны, если вы отправите нам открытку из вашего родного города с указанием того, какой из наших пакетов вы используете.

Наш адрес: Spatie, Kruikstraat 22, 2018, Антверпен, Бельгия.

Все полученные открытки мы публикуем на сайте нашей компании.

Кредиты

• Себастьян Де Дейн
• Все участники

Лицензия

Лицензия MIT (MIT). Дополнительную информацию см. в файле лицензии.