pagrom/poker

Poker

dev-master 2018-10-31 12:39 UTC

Requires

• php: >=7.1

Requires (Dev)

• phpunit/phpunit: ^7.5@dev

MIT

• Pavel Grom

README

A PHP-based Texas Hold'em Poker library capable of hand calculations, determine wining hand and preparing hands data.

Install

composer require pagrom/poker

Usage

use Pagrom\Poker\Card;
use Pagrom\Poker\Combination\WinnerDeterminant;
use Pagrom\Poker\Player;
use Pagrom\Poker\PokerHelper;
use Pagrom\Poker\Table;

$pokerHelper = new PokerHelper();

$table = new Table();

$table->addPlayer(new Player('Dean'));
$table->addPlayer(new Player('Sam'));

$table->dealCards();

$pokerHelper->determineCombinations($table);

$winnerDeterminant = new WinnerDeterminant($table);
$winners = $winnerDeterminant->getWinners();

Configuration

See src/config/config.php For using custom config:

$pokerHelper = new PokerHelper($customConfig);

Placeholders will be replaced with their values:

• :priority - card priority
• :priority_* - card priorities ordered by desc
• :suit - card suit
• :card_* - cards names, ordered by priority desc
• :kicker - first kicker
• :second_kicker - second kicker

Manually dealing cards

$dean = $table->getPlayer('Dean');
$sam = $table->getPlayer('Sam');

$table->dealCard($dean, $pokerHelper->getPriorityByName('Q'), $pokerHelper->getSuitByName('Spade'));
$table->dealCard($dean, $pokerHelper->getPriorityByName('A'), $pokerHelper->getSuitByName('Spade'));

$table->dealCard($sam, $pokerHelper->getPriorityByName('4'), $pokerHelper->getSuitByName('Spade'));
$table->dealCard($sam, $pokerHelper->getPriorityByName('7'), $pokerHelper->getSuitByName('Club'));

$table->dealCard($table, $pokerHelper->getPriorityByName('5'), $pokerHelper->getSuitByName('Heart'));
$table->dealCard($table, $pokerHelper->getPriorityByName('2'), $pokerHelper->getSuitByName('Spade'));
$table->dealCard($table, $pokerHelper->getPriorityByName('2'), $pokerHelper->getSuitByName('Diamond'));
$table->dealCard($table, $pokerHelper->getPriorityByName('3'), $pokerHelper->getSuitByName('Heart'));
$table->dealCard($table, $pokerHelper->getPriorityByName('4'), $pokerHelper->getSuitByName('Club'));

Use custom player instance

Custom player class should implements PlayerInterface. Traits HasCardsTrait and HasCombinationTrait can help.

use Pagrom\Poker\Interfaces\PlayerInterface;
use Pagrom\Poker\Traits\HasCardsTrait;
use Pagrom\Poker\Traits\HasCombinationTrait;

class CustomPlayer implements PlayerInterface
{
    use HasCardsTrait, HasCombinationTrait;
    
    /**
     * @var string $name
     */
    private $name;
    
    /**
     * @return string
     */
    public function getName(): string
    {
        return $this->name;
    }
}

$table->addPlayer($customPlayer);

Custom randomizer for dealing cards

$randomizerCallback = function(array $cardsKeys): int {
    return $cardsKeys[array_rand($cardsKeys)];
};

$table = new Table($randomizerCallback);

Get hand data

$handData = $pokerHelper->getCombinationData($winner->getCombination(), $winnerDeterminant)