Tournament Generator

TeamExporter extends SingleExporterBase

Exporter for teams

A specific exporter, taking care of teams and their related data. Exports a single team object.

Tags
author

Tomáš Vojík vojik@wboy.cz

since
0.5

Table of Contents

$modifiers  : array<string|int, mixed>
$object  : WithId
__construct()  : mixed
SingleTeamExporter 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
withScores()  : TeamExporter
Include team scores in the result set
applyModifiers()  : void
Apply set modifiers to data array

Properties

$modifiers

protected array<string|int, mixed> $modifiers = []

Methods

__construct()

SingleTeamExporter constructor.

public __construct(Team $team) : mixed
Parameters
$team : Team
Tags
noinspection

MagicMethodsValidityInspection

noinspection

PhpMissingParentConstructorInspection

Return values
mixed

export()

Simple export query without any modifiers

public static export(Team $object) : array<string|int, mixed>
Parameters
$object : Team
Return values
array<string|int, mixed>

exportBasic()

Simple export query without any modifiers

public static exportBasic(Team $object) : array<string|int, mixed>
Parameters
$object : Team
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>

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
see
json_encode()
Return values
array<string|int, mixed>

applyModifiers()

Apply set modifiers to data array

protected applyModifiers(array<string|int, mixed> &$data) : void
Parameters
$data : array<string|int, mixed>
Return values
void

Search results