NAIGC Website v2
\
naigc
v25
Club
Competitor
displayProjector
exception
Routine
Team
util

\naigc\v25CompetitionGym

Functions related to CompetitionGyms.

Summary

Methods
Properties
Constants
__construct()
name()
disciplines()
disciplineEvents()
competitionGymEvents()
routinesLastScored()
meet()
color()
scoreSheets()
jsonSerialize()
No public properties found
No constants found
No protected methods found
No protected properties found
N/A
No private methods found
No private properties found
N/A

Methods

__construct()

__construct(\naigc\v25\util\IMysql  $mysql, \naigc\v25\IMeet  $meet, string  $name) : mixed

Creates a new CompetitionGym object.

Parameters

\naigc\v25\util\IMysql $mysql

The database.
\naigc\v25\IMeet $meet

The Meet that the CompetitionGym is a site for.
string $name

The name of the CompetitionGym.

Throws

\naigc\v25\exception\FailedMysqliPrepare
\naigc\v25\exception\FailedMysqliExecute
\naigc\v25\exception\Creation

Returns

mixed

name()

name() : string

{@inheritDoc}

Returns

string

disciplines()

disciplines() : \naigc\v25\IDiscipline[]

Gets an ordered array of the Disciplines in the CompetitionGym.

Throws

\naigc\v25\exception\FailedMysqliPrepare
\naigc\v25\exception\FailedMysqliExecute

Returns

\naigc\v25\IDiscipline[] —

The array of Disciplines.

disciplineEvents()

disciplineEvents(\naigc\v25\IDiscipline|null  $discipline = null) : \naigc\v25\IDisciplineEvent[]

Gets an ordered array of the DisciplineEvents in the CompetitionGym.

Parameters

\naigc\v25\IDiscipline|null $discipline

Optional. A Discipline to filter by.

Throws

\naigc\v25\exception\FailedMysqliPrepare
\naigc\v25\exception\FailedMysqliExecute

Returns

\naigc\v25\IDisciplineEvent[] —

The array of DisciplineEvents.

competitionGymEvents()

competitionGymEvents() : \naigc\v25\ICompetitionGymEvent[]

Gets an ordered array of the CompetitionGymEvents in the CompetitionGym.

Throws

\naigc\v25\exception\FailedMysqliPrepare
\naigc\v25\exception\FailedMysqliExecute

Returns

\naigc\v25\ICompetitionGymEvent[] —

The array of CompetitionGymEvents.

routinesLastScored()

routinesLastScored(\naigc\v25\IDisciplineEvent  $disciplineEvent, int|null  $limit = null) : \naigc\v25\IRoutine[]

Gets an array of the Routines most recently awarded a Score on an Event.

Parameters

\naigc\v25\IDisciplineEvent $disciplineEvent

The Event to get Routines on.
int|null $limit

Optional. The maximum number to return.

Throws

\naigc\v25\exception\FailedMysqliPrepare
\naigc\v25\exception\FailedMysqliExecute

Returns

\naigc\v25\IRoutine[] —

The Routines.

meet()

meet() : \naigc\v25\IMeet

Gets the Meet the CompetitionGym is a location for.

Returns

\naigc\v25\IMeet —

The Meet.

color()

color() : string

Gets the hex color associated with the CompetitionGym.

Returns

string —

The hex color.

scoreSheets()

scoreSheets() : \naigc\v25\IScoreSheet[]

Gets the ScoreSheets for the CompetitionGym sorted by Club and Session.

Returns

\naigc\v25\IScoreSheet[] —

The ScoreSheets.

jsonSerialize()

jsonSerialize() : array

Serializes object into json format for available properties

Returns

array