PETDeckCardInterface

interface SwHawk\ProgressEvolutionOfTechnologySWH\Modules\Interfaces\PETDeckCardInterface

This interface is meant to be used by any class interacting with the Deck component. It complies with the specifications
given in BGA docs (https://en.doc.boardgamearena.com/Deck#The_5_properties_of_each_card). All methods described in
this interface only apply to object, care is needed to persist the object to the DB.

Source: modules/php/Interface/PETDeckCardInterface.php#24
Parent: JsonSerializable

Summary

Methods

public getDeckId()
public setDeckId($deckId)
public getDeckType()
public setDeckType($deckType)
public getLocation()
public setLocation($location)
public getLocationArg()
public setLocationArg($locationArg)
public toDeckCreateCardArray($playerCount)
public toDeckCardArray()

Methods

public SwHawk\ProgressEvolutionOfTechnologySWH\Modules\Interfaces\PETDeckCardInterface::getDeckId()

Returns the object's deck id

Source: modules/php/Interface/PETDeckCardInterface.php#31
Returns: int | null

public SwHawk\ProgressEvolutionOfTechnologySWH\Modules\Interfaces\PETDeckCardInterface::setDeckId($deckId)

Used by DB hydrator to set the id of the object

Source

modules/php/Interface/PETDeckCardInterface.php#40

Parameters

$deckId (int)

Returns

$this

public SwHawk\ProgressEvolutionOfTechnologySWH\Modules\Interfaces\PETDeckCardInterface::getDeckType()

Returns the object's deck type

Source: modules/php/Interface/PETDeckCardInterface.php#47
Returns: int | null

public SwHawk\ProgressEvolutionOfTechnologySWH\Modules\Interfaces\PETDeckCardInterface::setDeckType($deckType)

Sets the object's deck type

Source

modules/php/Interface/PETDeckCardInterface.php#56

Parameters

$deckType (int)

Returns

$this

public SwHawk\ProgressEvolutionOfTechnologySWH\Modules\Interfaces\PETDeckCardInterface::getLocation()

Returns the object's location ine the Deck sense

Source: modules/php/Interface/PETDeckCardInterface.php#63
Returns: string | null

public SwHawk\ProgressEvolutionOfTechnologySWH\Modules\Interfaces\PETDeckCardInterface::setLocation($location)

Sets the object's location

Source

modules/php/Interface/PETDeckCardInterface.php#72

Parameters

$location (string)

Returns

$this

public SwHawk\ProgressEvolutionOfTechnologySWH\Modules\Interfaces\PETDeckCardInterface::getLocationArg()

Return the object's location_arg

Source: modules/php/Interface/PETDeckCardInterface.php#79
Returns: int | null

public SwHawk\ProgressEvolutionOfTechnologySWH\Modules\Interfaces\PETDeckCardInterface::setLocationArg($locationArg)

Sets the object's location_arg

Source

modules/php/Interface/PETDeckCardInterface.php#88

Parameters

$locationArg (int)

Returns

$this

public SwHawk\ProgressEvolutionOfTechnologySWH\Modules\Interfaces\PETDeckCardInterface::toDeckCreateCardArray($playerCount)

Returns an array that can be used as argument for Deck's createCards method

Source

modules/php/Interface/PETDeckCardInterface.php#97

Parameters

$playerCount (int)

Returns

array

public SwHawk\ProgressEvolutionOfTechnologySWH\Modules\Interfaces\PETDeckCardInterface::toDeckCardArray()

Returns an array that is used in notifications and getAllDatas methods

Source: modules/php/Interface/PETDeckCardInterface.php#104
Returns: array