TeamsExporter
extends ExporterBase
in package
Exporter for teams
A specific exporter for teams and their related data. Exports all teams from a hierarchy object.
Tags
Table of Contents
- $modifiers : array<string|int, mixed>
- $object : WithId
- __construct() : mixed
- TeamExporter constructor.
- export() : 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
- jsonSerialize() : array<string|int, mixed>
- Serialize exported data as JSON
- start() : ExporterInterface
- Start an export query
- withScores() : TeamsExporter
- Include team scores in the result set
- applyModifiers() : void
- Apply set modifiers to data array
Properties
$modifiers
protected
array<string|int, mixed>
$modifiers
= []
$object
protected
WithId
$object
Methods
__construct()
TeamExporter constructor.
public
__construct(HierarchyBase $object) : mixed
Parameters
- $object : HierarchyBase
Return values
mixed —export()
Simple export query without any modifiers
public
static export(HierarchyBase $object) : array<string|int, mixed>
Parameters
- $object : HierarchyBase
Return values
array<string|int, mixed> —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 —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(HierarchyBase $object) : ExporterInterface
Parameters
- $object : HierarchyBase
Return values
ExporterInterface —withScores()
Include team scores in the result set
public
withScores() : TeamsExporter
Tags
Return values
TeamsExporter —applyModifiers()
Apply set modifiers to data array
protected
applyModifiers(array<string|int, mixed> &$data) : void
Parameters
- $data : array<string|int, mixed>