sanderspaas/word-search

Word search generator.

dev-master 2024-02-19 15:36 UTC

Requires

• php: >=5.6.0

Requires (Dev)

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

Suggests

• ext-mbstring: *

MIT

• Sander Spaas

README

Word search generator written in PHP.

Features:

• Supports multiple words and grid sizes
• Supports horizontal and vertical words
• Supports intersecting words
• English, Hebrew, Arabic 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 sanderspaas/word-search "^1.0"

Usage

In English:

use WordSearch\Factory;
use WordSearch\Alphabet\English;

$puzzle = Factory::create(['foo', 'bar'], 15, new English);

In Hebrew with reversing the words:

use WordSearch\Factory;
use WordSearch\Alphabet\Hebrew;

$puzzle = Factory::create(['אבג', 'דהו'], 15, new Hebrew, true);

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

Credits

This package is a fork of xmeltrut's Word Search.