Documentation

PieceSquadro
in package

Class PieceSquadro

Représente une pièce du jeu Squadro.

Chaque pièce a une couleur et une direction. Les couleurs possibles sont :

  • BLANC (0)
  • NOIR (1)
  • VIDE (-1)
  • NEUTRE (-2)

Les directions possibles sont :

  • NORD (0)
  • EST (1)
  • SUD (2)
  • OUEST (3)

Des méthodes statiques permettent d'instancier des pièces spécifiques ainsi que des cases (vides ou neutres) pour initialiser le plateau.

La classe inclut également des méthodes de conversion vers et depuis JSON.

Table of Contents

Constants

BLANC  = 0
EST  = 1
NEUTRE  = -2
NOIR  = 1
NORD  = 0
OUEST  = 3
SUD  = 2
VIDE  = -1

Properties

$couleur  : int
$direction  : int

Methods

__toString()  : string
Retourne une représentation sous forme de texte de la pièce.
fromJson()  : PieceSquadro
Crée une pièce à partir d'une représentation JSON.
getCouleur()  : int
Retourne la couleur de la pièce.
getDirection()  : int
Retourne la direction actuelle de la pièce.
initBlancEst()  : PieceSquadro
Crée une pièce blanche qui commence à gauche et va vers la droite (est).
initBlancOuest()  : PieceSquadro
Crée une pièce blanche qui commence à droite et va vers la gauche (ouest).
initNeutre()  : PieceSquadro
Crée une case neutre.
initNoirNord()  : PieceSquadro
Crée une pièce noire qui commence en bas et monte (vers le nord).
initNoirSud()  : PieceSquadro
Crée une pièce noire qui commence en haut et descend (vers le sud).
initVide()  : PieceSquadro
Crée une case vide.
inverseDirection()  : void
Inverse la direction de la pièce lorsqu'elle atteint un point de retournement.
toJson()  : string
Convertit l'objet en JSON.
__construct()  : mixed
Constructeur privé pour éviter une instanciation directe incorrecte.

Constants

Properties

$couleur

protected int $couleur

La couleur de la pièce.

$direction

protected int $direction

La direction actuelle de la pièce.

Methods

__toString()

Retourne une représentation sous forme de texte de la pièce.

public __toString() : string
Return values
string

La représentation textuelle de la pièce.

fromJson()

Crée une pièce à partir d'une représentation JSON.

public static fromJson(string $json) : PieceSquadro
Parameters
$json : string

La chaîne JSON contenant les informations de la pièce.

Tags
throws
InvalidArgumentException

Si le JSON ne contient pas les clés nécessaires.

Return values
PieceSquadro

La pièce créée à partir du JSON.

getCouleur()

Retourne la couleur de la pièce.

public getCouleur() : int
Return values
int

La couleur de la pièce.

getDirection()

Retourne la direction actuelle de la pièce.

public getDirection() : int
Return values
int

La direction actuelle de la pièce.

initBlancEst()

Crée une pièce blanche qui commence à gauche et va vers la droite (est).

public static initBlancEst() : PieceSquadro
Return values
PieceSquadro

Une pièce blanche orientée vers l'est.

initBlancOuest()

Crée une pièce blanche qui commence à droite et va vers la gauche (ouest).

public static initBlancOuest() : PieceSquadro
Return values
PieceSquadro

Une pièce blanche orientée vers l'ouest.

initNoirNord()

Crée une pièce noire qui commence en bas et monte (vers le nord).

public static initNoirNord() : PieceSquadro
Return values
PieceSquadro

Une pièce noire orientée vers le nord.

initNoirSud()

Crée une pièce noire qui commence en haut et descend (vers le sud).

public static initNoirSud() : PieceSquadro
Return values
PieceSquadro

Une pièce noire orientée vers le sud.

inverseDirection()

Inverse la direction de la pièce lorsqu'elle atteint un point de retournement.

public inverseDirection() : void

Par exemple, une pièce allant vers l'Est passera à l'Ouest.

Tags
throws
InvalidArgumentException

Si la direction actuelle est invalide et ne peut pas être inversée.

toJson()

Convertit l'objet en JSON.

public toJson() : string
Return values
string

La représentation JSON de la pièce.

__construct()

Constructeur privé pour éviter une instanciation directe incorrecte.

private __construct(int $couleur, int $direction) : mixed
Parameters
$couleur : int

La couleur de la pièce (BLANC, NOIR, VIDE, NEUTRE).

$direction : int

La direction de la pièce (NORD, EST, SUD, OUEST, VIDE, NEUTRE).

Tags
throws
InvalidArgumentException

Si la couleur ou la direction est invalide.


        
On this page

Search results