The cards package extends the gamebetr/provable package to provide a provably fair way to shuffle and utilize decks of cards.

composer require gamebetr/cards ^1.0

$deck = new Gamebetr\Cards\Deck();

or

$deck = Gamebetr\Cards\Deck::init();

$clientSeed - This is the client seed used to generate the provably fair shuffle. The default value of null will cause the Provable class to auto generate a client seed.

$serverSeed - This is the server seed used to generate the provably fair shuffle. The default value of null will cause the Provable class to auto generate a server seed.

$deckCount - This is the amount of card decks to use. The default is 1.

$jokers - This parameter determines whether jokers will be included in the deck. The default is false.

This method is just a static constructor to make it cleaner when instanciating the Deck class. This will return a Deck class.

This method will return the Gamebetr\Provable\Provable instance used to shuffle the deck.

This method will return the top Gamebetr\Cards\Card in the deck.

This method will burn the top card in the deck.

This method will return the full, original shuffled values of the deck. The values in this array are the numeric values used to create the Gamebetr\Cards\Card objects.

This method will return an array of all remaining Gamebetr\Cards\Card in the deck.

This method will return an array of all of the dealt Gamebetr\Cards\Card in the deck.

This method will return an array of all of the burnt Gamebetr\Cards\Card in the deck.

$value - This is the value of the card.

This method is just a static constructor for the Card object. This will return a Card class.

This method will return true of the Card is a joker.

This method will return an integer representation of the card suit. 0 = clubs, 1 = diamonds, 2 = hearts, 3 = spades.

This method will return the name of the card suit.

This method will return an integer representation of the card rank. -1 = joker, 0 = 2, 1 = 3, 2 = 4, 3 = 5, 4 = 6, 5 = 7, 6 = 8, 7 = 9, 8 = 10, 9 = jack, 10 = queen, 11 = king, 12 = ace.

This method will return the name of the card rank.

This method will return the integer value for the card. joker = 0, 2-9 = the face value, 10-king = 10, ace = 11.

This method is an alias of rankName().

This method returns the full name of the card (e.g. two of diamonds).

This method will compare the card against a different card and return true if the current card is of greater value. By specifying true for the $useSuitValue, it will rank two matching cards by suit.

This method will compare the card against a different card and return true if the current card is of lesser value. By specifying true for the $useSuitValue, it will rank two matching cards by suit.

This method will compare the card against a different card and return true if the current card is of the same value. By specifying true for the $useSuitValue, it will rank two matching cards by suit.

This method will compare the card against a different card and return -1 if the card is of lesser value, 0 if the cards have the same value, and 1 if the card is of greater value. By specifying true for the $useSuitValue, it will rank two matching cards by suit.

This method is an alias of getName().