GameExporter
extends SingleExporterBase
in package
Exporter for games
A specific exporter, taking care of games and their related data. Exports data from a single Game object.
Tags
Table of Contents
- $modifiers : array<string|int, mixed>
- $object : WithId
- __construct() : mixed
- SingleGameExporter constructor.
- export() : array<string|int, mixed>
- Simple export query without any modifiers
- exportBasic() : array<string|int, mixed>
- Simple export query without any modifiers
- get() : array<string|int, mixed>
- Finish the export query -> get the result
- getBasic() : array<string|int, mixed>
- Gets the basic unmodified data
- getJson() : string
- Return result as json
- getWithObject() : array<string|int, mixed>
- Finish the export query -> get the result including an object reference
- jsonSerialize() : array<string|int, mixed>
- Serialize exported data as JSON
- start() : ExporterInterface
- Start an export query
- applyModifiers() : void
- Apply set modifiers to data array
Properties
$modifiers
protected
array<string|int, mixed>
$modifiers
= []
$object
protected
WithId
$object
Methods
__construct()
SingleGameExporter constructor.
public
__construct(Game $game) : mixed
Parameters
- $game : Game
Tags
Return values
mixed —export()
Simple export query without any modifiers
public
static export(Game $object) : array<string|int, mixed>
Parameters
- $object : Game
Return values
array<string|int, mixed> —exportBasic()
Simple export query without any modifiers
public
static exportBasic(Game $object) : array<string|int, mixed>
Parameters
- $object : Game
Return values
array<string|int, mixed> —The query result including the object reference
get()
Finish the export query -> get the result
public
get() : array<string|int, mixed>
Return values
array<string|int, mixed> —The query result
getBasic()
Gets the basic unmodified data
public
getBasic() : array<string|int, mixed>
Return values
array<string|int, mixed> —getJson()
Return result as json
public
getJson() : string
Tags
Return values
string —getWithObject()
Finish the export query -> get the result including an object reference
public
getWithObject() : array<string|int, mixed>
Return values
array<string|int, mixed> —jsonSerialize()
Serialize exported data as JSON
public
jsonSerialize() : array<string|int, mixed>
Tags
Return values
array<string|int, mixed> —start()
Start an export query
public
static start(Game $object) : ExporterInterface
Parameters
- $object : Game
Return values
ExporterInterface —applyModifiers()
Apply set modifiers to data array
protected
applyModifiers(array<string|int, mixed> &$data) : void
Parameters
- $data : array<string|int, mixed>