SetupExporter
extends ExporterBase
in package
Class SetupExporter
Tags
Table of Contents
- $modifiers : array<string|int, mixed>
- $object : WithId
- __construct() : mixed
- export() : array<string|int, mixed>
- get() : array<string|int, mixed>
- Finish the export query -> get the result
- getBasic() : array<string|int, mixed>
- getJson() : string
- Return result as json
- jsonSerialize() : array<string|int, mixed>
- Serialize exported data as JSON
- start() : ExporterInterface
- applyModifiers() : void
- Apply set modifiers to data array
- getCategoriesData() : void
- Get all setup information for categories
- getCategoryData() : object
- Get all setup information from a Category class
- getGroupData() : object
- Get all setup information from a Group class
- getGroupsData() : void
- Get all setup information for groups and progressions
- getProgressionData() : object
- Get all setup information from a Progression class
- getRoundData() : object
- Get all setup information from a Round class
- getRoundsData() : void
- Get all setup information for rounds
- getTeamFilterData() : object
- Get all setup information from a TeamFilter class
- getTournamentData() : void
- Get all setup information from a Tournament class
Properties
$modifiers
protected
array<string|int, mixed>
$modifiers
= []
$object
protected
WithId
$object
Methods
__construct()
public
__construct(WithId $object) : mixed
Parameters
- $object : WithId
Return values
mixed —export()
public
static export(WithId $object) : array<string|int, mixed>
Parameters
- $object : WithId
Tags
Return values
array<string|int, mixed> —get()
Finish the export query -> get the result
public
get() : array<string|int, mixed>
Tags
Return values
array<string|int, mixed> —The query result
getBasic()
public
getBasic() : array<string|int, mixed>
Tags
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()
public
static start(WithId $object) : ExporterInterface
Parameters
- $object : WithId
Tags
Return values
ExporterInterface —applyModifiers()
Apply set modifiers to data array
protected
applyModifiers(array<string|int, mixed> &$data) : void
Parameters
- $data : array<string|int, mixed>
Return values
void —getCategoriesData()
Get all setup information for categories
protected
getCategoriesData(array<string|int, mixed> &$data) : void
Parameters
- $data : array<string|int, mixed>
Tags
Return values
void —getCategoryData()
Get all setup information from a Category class
protected
getCategoryData(Category $category) : object
Parameters
- $category : Category
-
Category class to export
Tags
Return values
object —getGroupData()
Get all setup information from a Group class
protected
getGroupData(Group $group) : object
Parameters
- $group : Group
-
Group class to export
Tags
Return values
object —getGroupsData()
Get all setup information for groups and progressions
protected
getGroupsData(array<string|int, mixed> &$data) : void
Parameters
- $data : array<string|int, mixed>
Tags
Return values
void —getProgressionData()
Get all setup information from a Progression class
protected
getProgressionData(Progression $progression) : object
Parameters
- $progression : Progression
-
Progression class to export
Return values
object —getRoundData()
Get all setup information from a Round class
protected
getRoundData(Round $round) : object
Parameters
- $round : Round
-
Round class to export
Tags
Return values
object —getRoundsData()
Get all setup information for rounds
protected
getRoundsData(array<string|int, mixed> &$data) : void
Parameters
- $data : array<string|int, mixed>
Tags
Return values
void —getTeamFilterData()
Get all setup information from a TeamFilter class
protected
getTeamFilterData(TeamFilter $filter) : object
Parameters
- $filter : TeamFilter
-
TeamFilter class to export
Return values
object —getTournamentData()
Get all setup information from a Tournament class
protected
getTournamentData(array<string|int, mixed> &$data) : void
Parameters
- $data : array<string|int, mixed>