README

PHP Wildcards

PHP Wildcards is a PHP library that converts wildcards to regular expressions.

Installation

composer require okapi/wildcards

Usage

<?php

use Okapi\Wildcards\Regex;

// Simple wildcard
$regex = Regex::fromWildcard('*.php');
$regex->matches('index.php'); // true
$regex->matches('index.html'); // false

// Wildcard with groups
$regex = Regex::fromWildcard('(*.php)|(*.html)');
$regex->matches('index.php'); // true
$regex->matches('index.html'); // true
$regex->matches('index.js'); // false

// Wildcard with optional characters
$regex = Regex::fromWildcard('index[*].php');
$regex->matches('index.php'); // true
$regex->matches('index.test.php'); // true
$regex->matches('index_2.php'); // true

Supported Wildcards

• * = any number of characters
  
• ? = any single character
  
• [ ] = optional characters
  
• ( ) = group
  
• | = or
  

Testing

• Run composer run-script test
  or
• Run composer run-script test-coverage

Show your support

Give a ⭐ if this project helped you!

📝 License

Copyright © 2023 Valentin Wotschel.
This project is MIT licensed.