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

\naigc\v25CompetitionGymEvent

Functions related to CompetitionGymEvents.

Summary

Methods
Properties
Constants
__construct()
competitionGym()
disciplineEvent()
clubNames()
judges()
levels()
qualifications()
awardsCategories()
routinesLastScored()
routine()
routines()
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\ICompetitionGym  $competitionGym, \naigc\v25\IDisciplineEvent  $disciplineEvent) : mixed

Creates a new CompetitionGymEvent object.

Parameters

\naigc\v25\util\IMysql $mysql

The database.
\naigc\v25\ICompetitionGym $competitionGym

The CompetitionGym the CompetitionGymEvent is in.
\naigc\v25\IDisciplineEvent $disciplineEvent

The DisciplineEvent the CompetitionGymEvent is on.

Returns

mixed

competitionGym()

competitionGym() : \naigc\v25\ICompetitionGym

Gets the CompetitionGym the CompetitionGymEvent is in.

Returns

\naigc\v25\ICompetitionGym —

The CompetitionGym.

disciplineEvent()

disciplineEvent() : \naigc\v25\IDisciplineEvent

Gets the DisciplineEvent the CompetitionGymEvent is on.

Returns

\naigc\v25\IDisciplineEvent —

The DisciplineEvent.

clubNames()

clubNames(\naigc\v25\ISession|null  $session = null) : string[]

Gets the Club Names being competed on the CompetitionGymEvent.

Parameters

\naigc\v25\ISession|null $session

Optional. A Session to filter by.

Throws

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

Returns

string[] —

The Club Names.

judges()

judges() : \naigc\v25\IJudge[]

Gets an array Judges available for Scoring.

Throws

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

Returns

\naigc\v25\IJudge[] —

The array of Judges.

levels()

levels() : array

Gets levels from routines in the gym

Throws

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

Returns

array

qualifications()

qualifications() : array

Gets All Qualification types

Throws

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

Returns

array

awardsCategories()

awardsCategories() : array

Gets awardsCategories from routines in the gym

Throws

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

Returns

array

routinesLastScored()

routinesLastScored(int  $limit = null) : \naigc\v25\IRoutine[]

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

Parameters

int $limit

Optional. The maximum number to return.

Returns

\naigc\v25\IRoutine[] —

The Routines.

routine()

routine(\naigc\v25\ICompetitor  $competitor) : \naigc\v25\IRoutine|null

Gets the Routine for a Competitor on the CompetitionGymEvent.

Parameters

\naigc\v25\ICompetitor $competitor

The Competitor.

Throws

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

Returns

\naigc\v25\IRoutine|null —

The Routine. TODO: This will not always return a unique result.

routines()

routines(\naigc\v25\ISession|null  $session = null, string|null  $clubName = null) : \naigc\v25\IRoutine[]

Gets the Routines being competed on the CompetitionGymEvent.

Parameters

\naigc\v25\ISession|null $session

Optional. A Session to filter by.
string|null $clubName

Optional. A club name to filter by.

Throws

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

Returns

\naigc\v25\IRoutine[] —

The Routines.