markbaker/tries

PHP Classes for Trie datastructures

Tries

A PHP implementation of the Trie, RadixTrie and SuffixTrie data structures, _(*1)

Master: , _(*2)

Develop: , _(*3)

Requirements

• PHP version 7.2 or higher

Installation

We recommend installing this package with Composer., _(*4)

Via composer

In your project root folder, execute, _(*5)

composer require markbaker/tries:dev-master

You should now have the files composer.json and composer.lock as well as the directory vendor in your project directory., _(*6)

You can then require the Composer autoloader from your code, _(*7)

require 'vendor/autoload.php';

Or, if you already have a composer.json file, then require this package in that file, _(*8)

"require": {
    "markbaker/tries": "dev-master"
}

and update composer., _(*9)

composer update

From Phar

Although we strongly recommend using Composer, we also provide a Phar archive builder that will create a Phar file containing all of the library code., _(*10)

The phar builder script is in the repository root folder, and can be run using, _(*11)

php buildPhar.php

To use the archive, just require it from your script:, _(*12)

require 'Tries.phar';

Standard Autoloader

If you want to run the code without using composer's autoloader, and don't want to build the phar, then required the bootstrap.php file from the repository in your code, and this will enable the autoloader for the library., _(*13)

require 'bootstrap.php';

Want to contribute?

Fork this library!, _(*14)

License

Tries is licensed under an MIT LICENSE), _(*15)

Examples

The /examples folder has two examples to demonstrate their use:, _(*16)

• playerSearch.php
• playerSearchRadixTrie.php

• playerSearchSuffixTrie.php, _(*17)

  allows a search on Wigan Warriors rugby league players based on surname, displaying the record of those that match the entered search criteria, _(*18)

  usage:, _(*19)

  php playerSearch <name> <limit>

  or, _(*20)

  php playerSearchRadixTrie <name> <limit>

  or, _(*21)

  php playerSearchSuffixTrie <name> <limit>

  where, _(*22)

  name     the first few characters of the surname you want to
           search for (or characters from anywhere in the name
           if using the Suffix Trie search)
  limit    optional (default 8) limits the number of results
           returned

• wordSearch.php, _(*23)

• wordSearchRadixTrie.php, _(*24)

  searches an English dictionary for words, displaying those that match the entered search criteria, _(*25)

  usage:, _(*26)

  php wordSearch <searchterm> <limit>

  or, _(*27)

  php wordSearchRadixTrie <searchterm> <limit>

  where, _(*28)

  searchterm   can be a prefix*
                   e.g. "aba*" will return words beginning with "aba"
               a *suffix
                   e.g. "*ose" will return words ending in "ose"
               or a split*search criteria
                   e.g. "t*ly" will return words beginning with "t" 
                        and ending in "ly"
  limit        optional (default 8) limits the number of results
               returned

  Note that the dictionary of 160k words will take some time to load, depending on your system, _(*29)