xmeltrut/word-search

Word search generator.

1.0.3 2016-08-09 22:05 UTC

Requires

• php: >=5.6.0

Requires (Dev)

• phpunit/phpunit: 4.8.*
• squizlabs/php_codesniffer: 2.6.*

Suggests

• ext-mbstring: *

MIT

• Chris Worfolk

README

Word search generator written in PHP.

Features:

• Supports multiple words and grid sizes
• Supports horizontal and vertical words
• Supports intersecting words
• English and Finnish alphabets

Produces a grid for you to output, and list of answers.

HHEOÖ
EÖBAR
LSJFD
LLTOK
OPÖOU

Install

Install via Composer:

$ composer require xmeltrut/WordSearch "^1.0"

Usage

In English:

$puzzle = WordSearch\Factory::create(['foo', 'bar']);

In Finnish, with a custom grid size:

$puzzle = WordSearch\Factory::create(
    ['mansikka', 'omena', banaani'],
    10,
    'fi'
);

The Puzzle object contains a toArray method for the puzzle grid and an iterable WordList object with the answers in. You can use these to output the puzzle yourself, or use the HTML transformer.

$transformer = new WordSearch\Transformer\HtmlTransformer($puzzle);
echo $transformer->grid();
echo $transformer->wordList();

Development

Tests can be run via Ant:

ant