Comus Party 1.0.0
Application web de mini-jeux en ligne
Chargement...
Recherche...
Aucune correspondance
Référence de la classe Penalty

Classe Penalty. Plus de détails...

Fonctions membres publiques

 __construct (?int $id=null, ?string $createdBy=null, ?string $cancelledBy=null, ?string $penalizedUuid=null, ?string $reason=null, ?int $duration=null, ?PenaltyType $type=null, ?DateTime $cancelledAt=null, ?DateTime $createdAt=null, ?DateTime $updatedAt=null)
 Constructeur de la classe Penalty.
 
 getId ()
 Retourne l'identifiant de la sanction.
 
 setId (?int $id)
 Modifie l'identifiant de la sanction.
 
 getCreatedBy ()
 Retourne l'identifiant du modérateur ayant créé la sanction.
 
 setCreatedBy (?string $createdBy)
 Modifie l'identifiant du modérateur ayant créé la sanction.
 
 getCancelledBy ()
 Retourne l'identifiant du modérateur ayant annulé la sanction.
 
 setCancelledBy (?string $cancelledBy)
 Modifie l'identifiant du modérateur ayant annulé la sanction.
 
 getPenalizedUuid ()
 Retourne l'identifiant du joueur sanctionné
 
 setPenalizedUuid (?string $penalizedUuid)
 Modifie l'identifiant du joueur sanctionné
 
 getReason ()
 Retourne la raison de la sanction.
 
 setReason (?string $reason)
 Modifie la raison de la sanction.
 
 getDuration ()
 Retourne la durée de la sanction.
 
 setDuration (?int $duration)
 Modifie la durée de la sanction.
 
 getType ()
 Retourne le type de la sanction.
 
 setType (?PenaltyType $type)
 Modifie le type de la sanction.
 
 getCancelledAt ()
 Retourne la date d'annulation de la sanction.
 
 setCancelledAt (?DateTime $cancelledAt)
 Modifie la date d'annulation de la sanction.
 
 getCreatedAt ()
 Retourne la date de création de la sanction.
 
 setCreatedAt (?DateTime $createdAt)
 Modifie la date de création de la sanction.
 
 getUpdatedAt ()
 Retourne la date de mise à jour de la sanction.
 
 setUpdatedAt (?DateTime $updatedAt)
 Modifie la date de mise à jour de la sanction.
 

Attributs privés

int $id
 
string $createdBy
 
string $cancelledBy
 
string $penalizedUuid
 
string $reason
 
int $duration
 
PenaltyType $type
 
DateTime $cancelledAt
 
DateTime $createdAt
 
DateTime $updatedAt
 

Description détaillée

Classe Penalty.

La classe Penalty permet de représenter les sanctions appliquées aux joueurs sur la plateforme

Définition à la ligne 40 du fichier penalty.class.php.

Documentation des constructeurs et destructeur

◆ __construct()

__construct ( ?int $id = null,
?string $createdBy = null,
?string $cancelledBy = null,
?string $penalizedUuid = null,
?string $reason = null,
?int $duration = null,
?PenaltyType $type = null,
?DateTime $cancelledAt = null,
?DateTime $createdAt = null,
?DateTime $updatedAt = null )

Constructeur de la classe Penalty.

Paramètres
int | null$idIdentifiant de la sanction
string | null$createdByIdentifiant du modérateur ayant créé la sanction
string | null$cancelledByIdentifiant du modérateur ayant annulé la sanction
string | null$penalizedUuidIdentifiant du joueur sanctionné
string | null$reasonRaison de la sanction
int | null$durationDurée de la sanction
PenaltyType | null$typeType de la sanction
DateTime | null$cancelledAtDate d'annulation de la sanction
DateTime | null$createdAtDate de création de la sanction
DateTime | null$updatedAtDate de mise à jour de la sanction

Définition à la ligne 115 du fichier penalty.class.php.

Documentation des fonctions membres

◆ getCancelledAt()

getCancelledAt ( )

Retourne la date d'annulation de la sanction.

Renvoie
DateTime|null La date d'annulation de la sanction

Définition à la ligne 269 du fichier penalty.class.php.

◆ getCancelledBy()

getCancelledBy ( )

Retourne l'identifiant du modérateur ayant annulé la sanction.

Renvoie
string|null L'identifiant du modérateur ayant annulé la sanction

Définition à la ligne 179 du fichier penalty.class.php.

◆ getCreatedAt()

getCreatedAt ( )

Retourne la date de création de la sanction.

Renvoie
DateTime|null La date de création de la sanction

Définition à la ligne 287 du fichier penalty.class.php.

◆ getCreatedBy()

getCreatedBy ( )

Retourne l'identifiant du modérateur ayant créé la sanction.

Renvoie
string|null L'identifiant du modérateur ayant créé la sanction

Définition à la ligne 161 du fichier penalty.class.php.

◆ getDuration()

getDuration ( )

Retourne la durée de la sanction.

Renvoie
int|null La durée de la sanction

Définition à la ligne 233 du fichier penalty.class.php.

◆ getId()

getId ( )

Retourne l'identifiant de la sanction.

Renvoie
int|null L'identifiant de la sanction

Définition à la ligne 143 du fichier penalty.class.php.

◆ getPenalizedUuid()

getPenalizedUuid ( )

Retourne l'identifiant du joueur sanctionné

Renvoie
string|null L'identifiant du joueur sanctionné

Définition à la ligne 197 du fichier penalty.class.php.

◆ getReason()

getReason ( )

Retourne la raison de la sanction.

Renvoie
string|null La raison de la sanction

Définition à la ligne 215 du fichier penalty.class.php.

◆ getType()

getType ( )

Retourne le type de la sanction.

Renvoie
PenaltyType|null Le type de la sanction

Définition à la ligne 251 du fichier penalty.class.php.

◆ getUpdatedAt()

getUpdatedAt ( )

Retourne la date de mise à jour de la sanction.

Renvoie
DateTime|null La date de mise à jour de la sanction

Définition à la ligne 305 du fichier penalty.class.php.

◆ setCancelledAt()

setCancelledAt ( ?DateTime $cancelledAt)

Modifie la date d'annulation de la sanction.

Paramètres
DateTime | null$cancelledAtLa nouvelle date d'annulation de la sanction

Définition à la ligne 278 du fichier penalty.class.php.

◆ setCancelledBy()

setCancelledBy ( ?string $cancelledBy)

Modifie l'identifiant du modérateur ayant annulé la sanction.

Paramètres
string | null$cancelledByLe nouvel identifiant du modérateur ayant annulé la sanction

Définition à la ligne 188 du fichier penalty.class.php.

◆ setCreatedAt()

setCreatedAt ( ?DateTime $createdAt)

Modifie la date de création de la sanction.

Paramètres
DateTime | null$createdAtLa nouvelle date de création de la sanction

Définition à la ligne 296 du fichier penalty.class.php.

◆ setCreatedBy()

setCreatedBy ( ?string $createdBy)

Modifie l'identifiant du modérateur ayant créé la sanction.

Paramètres
string | null$createdByLe nouvel identifiant du modérateur ayant créé la sanction

Définition à la ligne 170 du fichier penalty.class.php.

◆ setDuration()

setDuration ( ?int $duration)

Modifie la durée de la sanction.

Paramètres
int | null$durationLa nouvelle durée de la sanction

Définition à la ligne 242 du fichier penalty.class.php.

◆ setId()

setId ( ?int $id)

Modifie l'identifiant de la sanction.

Paramètres
int | null$idLe nouvel identifiant de la sanction

Définition à la ligne 152 du fichier penalty.class.php.

◆ setPenalizedUuid()

setPenalizedUuid ( ?string $penalizedUuid)

Modifie l'identifiant du joueur sanctionné

Paramètres
string | null$penalizedUuidLe nouvel identifiant du joueur sanctionné

Définition à la ligne 206 du fichier penalty.class.php.

◆ setReason()

setReason ( ?string $reason)

Modifie la raison de la sanction.

Paramètres
string | null$reasonLa nouvelle raison de la sanction

Définition à la ligne 224 du fichier penalty.class.php.

◆ setType()

setType ( ?PenaltyType $type)

Modifie le type de la sanction.

Paramètres
PenaltyType | null$typeLe nouveau type de la sanction

Définition à la ligne 260 du fichier penalty.class.php.

◆ setUpdatedAt()

setUpdatedAt ( ?DateTime $updatedAt)

Modifie la date de mise à jour de la sanction.

Paramètres
DateTime | null$updatedAtLa nouvelle date de mise à jour de la sanction

Définition à la ligne 314 du fichier penalty.class.php.

Documentation des champs

◆ $cancelledAt

DateTime $cancelledAt
private

Définition à la ligne 88 du fichier penalty.class.php.

◆ $cancelledBy

string $cancelledBy
private

Définition à la ligne 58 du fichier penalty.class.php.

◆ $createdAt

DateTime $createdAt
private

Définition à la ligne 94 du fichier penalty.class.php.

◆ $createdBy

string $createdBy
private

Définition à la ligne 52 du fichier penalty.class.php.

◆ $duration

int $duration
private

Définition à la ligne 76 du fichier penalty.class.php.

◆ $id

int $id
private

Définition à la ligne 46 du fichier penalty.class.php.

◆ $penalizedUuid

string $penalizedUuid
private

Définition à la ligne 64 du fichier penalty.class.php.

◆ $reason

string $reason
private

Définition à la ligne 70 du fichier penalty.class.php.

◆ $type

PenaltyType $type
private

Définition à la ligne 82 du fichier penalty.class.php.

◆ $updatedAt

DateTime $updatedAt
private

Définition à la ligne 100 du fichier penalty.class.php.


La documentation de cette classe a été générée à partir du fichier suivant :