\naigc\v25\RoutineById

Functions related to IRoutines.

Summary

Methods

Properties

Constants

competitionEvent()
competitorBracket()
name()
nameFirst()
nameLast()
id()
awardScore()
refreshFinalScore()
verifyScore()
unVerifyScore()
scores()
scorePanels()
judges()
qualifications()
addQualification()
removeQualification()
disciplineName()
levelName()
clubName()
competitionNumber()
finalScore()
verifiedByName()
jsonSerialize()
__construct()

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

File: src/naigc/v25/Routine/ById.class.php
Package: Default
Class hierarchy: normal

\naigc\v25\Routine\ById
Implements: \naigc\v25\IRoutine

Methods

competitionEvent()

competitionEvent() : \naigc\v25\ICompetitionEvent

Gets the CompetitionEvent of the Routine.

Returns

\naigc\v25\ICompetitionEvent —

The CompetitionEvent.

competitorBracket()

competitorBracket() : \naigc\v25\ICompetitorBracket

Gets the CompetitorBracket of the Routine.

Returns

\naigc\v25\ICompetitorBracket —

The CompetitorBracket.

name()

name() : string

Gets the the first and last name of the Competitor.

Returns

string —

the first and last name.

nameFirst()

nameFirst() : string

Gets the first name of the Competitor.

Returns

string —

the first name.

nameLast()

nameLast() : string

Gets the last name of the Competitor.

Returns

string —

the last name.

id()

id() : int

Gets the ID of the Routine.

Returns

int —

The ID.

Inherited from: \naigc\v25\Routine

Tags

SuppressWarnings	(PHPMD.ShortMethodName)

awardScore()

awardScore(\naigc\v25\IJudge  $judge, \naigc\v25\IScorePanel  $scorePanel, float  $score, \naigc\v25\IPerson  $scoredBy) : \naigc\v25\IRoutine

Awards a score to the Routine and adjusts the finalScore.

Checks to make sure the Routine's finalScore has not been verified. If it has not then it creates a Score and updates the finalScore.

Parameters

\naigc\v25\IJudge	$judge	The Judge awarding the Score.
\naigc\v25\IScorePanel	$scorePanel	The ScorePanel the Score is for.
float	$score	The Score.
\naigc\v25\IPerson	$scoredBy	The person entering the score.

Throws

\naigc\v25\exception\FailedMysqliPrepare
\naigc\v25\exception\FailedMysqliExecute
\naigc\v25\exception\Verified: when the score has already been verified.

Returns

\naigc\v25\IRoutine —

The Routine.

refreshFinalScore()

refreshFinalScore(\naigc\v25\IPerson  $scoredBy) : \naigc\v25\IRoutine

Recalculates the FinalScore based on the Scores.

Parameters

\naigc\v25\IPerson

$scoredBy

The person entering the score.

Throws

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

Returns

\naigc\v25\IRoutine —

The Routine.

verifyScore()

verifyScore(\naigc\v25\IPerson  $verifiedBy) : \naigc\v25\IRoutine

{@inheritDoc}

Parameters

\naigc\v25\IPerson

$verifiedBy

{@inheritDoc}

Returns

\naigc\v25\IRoutine

unVerifyScore()

unVerifyScore() : \naigc\v25\IRoutine

{@inheritDoc}

Throws

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

Returns

\naigc\v25\IRoutine

scores()

scores() : \naigc\v25\IScore[]

Gets the Scores awarded to this Routine.

Throws

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

Returns

\naigc\v25\IScore[] —

The array of Scores.

scorePanels()

scorePanels() : \naigc\v25\IScorePanel[]

Gets an array ScorePanels available for Scoring.

Throws

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

Returns

\naigc\v25\IScorePanel[] —

The array of ScorePanels.

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.

qualifications()

qualifications() : \naigc\v25\IQualification[]

Gets the list of things the Routine is a Qualification for.

Throws

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

Returns

\naigc\v25\IQualification[] —

The array of Qualifications.

addQualification()

addQualification(\naigc\v25\IQualification  $qualification) : \naigc\v25\IRoutine

Adds a new Qualification method to the Routine.

Parameters

\naigc\v25\IQualification

$qualification

The Qualification to add.

Throws

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

Returns

\naigc\v25\IRoutine —

The Routine.

removeQualification()

removeQualification(\naigc\v25\IQualification  $qualification) : \naigc\v25\IRoutine

Removes a Qualification method from the Routine.

Parameters

\naigc\v25\IQualification

$qualification

The Qualification to remove.

Throws

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

Returns

\naigc\v25\IRoutine —

The Routine.

disciplineName()

disciplineName() : string

Gets the name of the Discipline the Routine is competed in.

Throws

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

Returns

string —

The name of the Discipline.

levelName()

levelName() : string

Gets the name of the Level the Routine is competed in.

Throws

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

Returns

string —

The name of the Level.

clubName()

clubName() : string

Gets the name of the Club the Competitor performing the Routine belongs to.

Throws

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

Returns

string —

The name of the Club.

competitionNumber()

competitionNumber() : string|null

Gets the CompetitionNumber of the Competitor performing the Routine.

Throws

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

Returns

string|null —

The CompetitionNumber.

finalScore()

finalScore() : string

Gets the final score of the Routine.

Throws

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

Returns

string —

The finals score.

verifiedByName()

verifiedByName() : string

Gets who verified the Routine.

Throws

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

Returns

string —

The verifiedBy.

jsonSerialize()

jsonSerialize() : array

Serializes object into json format for available properties

Returns

array

__construct()

__construct(\naigc\v25\util\IMysql  $mysql, int  $routineId) : mixed

Creates a new Routine object from routineID or associated keys.

Parameters

\naigc\v25\util\IMysql	$mysql	The database.
int	$routineId	The ID of the Routine.

Throws

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

Returns

mixed