\naigc\v25IRoutine

Functions related to Routines.

Summary

Methods

Constants

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

No constants found

No protected methods found

N/A

No private methods found

N/A

Methods

name()

name() : string

Gets the the first and last name of the Competitor.

Returns

string —

the first and last name.

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.

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\IRoutine

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.

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.

Returns

\naigc\v25\IRoutine —

The Routine.

scores()

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

Gets the Scores awarded to this Routine.

Returns

\naigc\v25\IScore[] —

The array of Scores.

scorePanels()

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

Gets an array ScorePanels available for Scoring.

Returns

\naigc\v25\IScorePanel[] —

The array of ScorePanels.

judges()

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

Gets an array Judges available for Scoring.

Returns

\naigc\v25\IJudge[] —

The array of Judges.

qualifications()

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

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

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.

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.

Returns

\naigc\v25\IRoutine —

The Routine.

disciplineName()

disciplineName() : string

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

Returns

string —

The name of the Discipline.

levelName()

levelName() : string

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

Returns

string —

The name of the Level.

clubName()

clubName() : string

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

Returns

string —

The name of the Club.

competitionNumber()

competitionNumber() : string|null

Gets the CompetitionNumber of the Competitor performing the Routine.

Returns

string|null —

The CompetitionNumber.

finalScore()

finalScore() : string

Gets the final score of the Routine.

Returns

string —

The finals score.

verifiedByName()

verifiedByName() : string

Gets who verified the Routine.

Returns

string —

The verifiedBy.

jsonSerialize()

jsonSerialize() : array

Serializes object into json format for available properties

Returns

array