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

\naigc\v25ICompetitor

Functions related to Competitors.

Summary

Methods
Constants
name()
addToAwardsCategory()
removeFromAwardsCategory()
refreshAwardsCategories()
id()
addToDecathlon()
addToBracket()
removeFromBracket()
addToTeam()
removeFromTeam()
teams()
awardsCategories()
brackets()
competitionNumber()
delete()
meet()
nameFirst()
nameLast()
person()
clubName()
setCompetitionNumber()
setClubName()
setName()
v2Eligibility()
setV2Eligibility()
isDecathlete()
No constants found
No protected methods found
N/A
No private methods found
N/A

Methods

name()

name() : string

Gets the first name of the Competitor.

Returns

string —

The first and last name.

addToAwardsCategory()

addToAwardsCategory(string  $awardsCategoryName, bool  $updateTeams = true) : \naigc\v25\IAwardsCategory|null

Adds the Competitor to a new AwardsCategory.

Parameters

string $awardsCategoryName

The AwardsCategory to add the Competitor to.
bool $updateTeams

Optional. Whether all of the Competitor's Teams should also be updated.

Returns

\naigc\v25\IAwardsCategory|null —

The newly added AwardsCategory.

removeFromAwardsCategory()

removeFromAwardsCategory(\naigc\v25\IAwardsCategory  $awardsCategory, bool  $updateTeams = true) : \naigc\v25\ICompetitor

Removes the Competitor from an AwardsCategory.

Parameters

\naigc\v25\IAwardsCategory $awardsCategory

The AwardsCategory to remove the Competitor from.
bool $updateTeams

Optional. Whether all of the Competitor's Teams should also be updated.

Returns

\naigc\v25\ICompetitor —

The Competitor.

refreshAwardsCategories()

refreshAwardsCategories() : \naigc\v25\ICompetitor

Refreshes the AwardsCategories the Competitor is in.

Returns

\naigc\v25\ICompetitor —

The Competitor.

id()

id() : int

Returns the ID of the Competitor.

Returns

int —

The ID.

addToDecathlon()

addToDecathlon(string  $decathlonName) : \naigc\v25\ICompetitor

Adds the Competitor to a Decathlon.

Parameters

string $decathlonName

The name of the Decathlon to add the Competitor to.

Returns

\naigc\v25\ICompetitor —

The Competitor.

addToBracket()

addToBracket(\naigc\v25\IBracket  $bracket, bool  $isEligible = false) : \naigc\v25\ICompetitorBracket|null

Adds the Competitor to a new Bracket.

Parameters

\naigc\v25\IBracket $bracket

The Bracket to add the Competitor to.
bool $isEligible

Optional. Whether the Competitor is eligible for awards in this Bracket.

Returns

\naigc\v25\ICompetitorBracket|null —

The newly created CompetitorBracket.

removeFromBracket()

removeFromBracket(\naigc\v25\IBracket  $bracket) : \naigc\v25\ICompetitor

Removes the Competitor from a Bracket.

Parameters

\naigc\v25\IBracket $bracket

The Bracket to remove the Competitor from.

Returns

\naigc\v25\ICompetitor —

The Competitor.

addToTeam()

addToTeam(\naigc\v25\ITeam  $team) : \naigc\v25\ITeam

Adds the Competitor to a new Team.

Parameters

\naigc\v25\ITeam $team

The Team to add the Competitor to.

Returns

\naigc\v25\ITeam —

The newly added Team.

removeFromTeam()

removeFromTeam(\naigc\v25\ITeam  $team) : \naigc\v25\ICompetitor

Removes the Competitor from a Team.

Parameters

\naigc\v25\ITeam $team

The Team to remove the Competitor from.

Returns

\naigc\v25\ICompetitor —

The Competitor.

teams()

teams() : \naigc\v25\ITeam[]

Gets all of the Teams the Competitor is a member of.

Returns

\naigc\v25\ITeam[] —

The list of Teams.

awardsCategories()

awardsCategories() : \naigc\v25\IAwardsCategory[]

Gets all of the AwardsCategories the Competitor is eligible for.

Returns

\naigc\v25\IAwardsCategory[] —

The list of AwardsCategories.

brackets()

brackets() : \naigc\v25\IBracket[]

Gets all of the Brackets the Competitor is in.

Returns

\naigc\v25\IBracket[] —

The list of Brackets.

competitionNumber()

competitionNumber() : string|null

Gets the CompetitionNumber.

Returns

string|null —

The CompetitionNumber.

delete()

delete() : void

Deletes the competitor.

meet()

meet() : \naigc\v25\IMeet

Gets the Meet the Competitor is competing in.

Returns

\naigc\v25\IMeet —

The meet.

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.

person()

person() : \naigc\v25\IPerson

Gets the Person associated with the Competitor.

Returns

\naigc\v25\IPerson

clubName()

clubName() : string

Gets the name of the Club the Competitor is on.

Returns

string —

The Club name.

setCompetitionNumber()

setCompetitionNumber(string  $competitionNumber) : \naigc\v25\ICompetitor

Sets the CompetitionNumber.

Parameters

string $competitionNumber

The CompetitionNumber to set.

Returns

\naigc\v25\ICompetitor —

The Competitor.

setClubName()

setClubName(string  $clubName) : \naigc\v25\ICompetitor

Sets the name of the Club the Competitor is competing on.

Parameters

string $clubName

The name of the Club.

Returns

\naigc\v25\ICompetitor —

The Competitor.

setName()

setName(string  $nameFirst, string  $nameLast) : \naigc\v25\ICompetitor

Sets the name of the Competitor.

Parameters

string $nameFirst

The first name of the Competitor.
string $nameLast

The last name of the Competitor.

Returns

\naigc\v25\ICompetitor —

The Competitor.

v2Eligibility()

v2Eligibility() : string

Gets the v2Eligibility of the Competitor.

Returns

string —

The eligibility from v2.

setV2Eligibility()

setV2Eligibility(string  $v2Eligibility) : \naigc\v25\ICompetitor

Sets the v2Eligibility of the Competitor.

Parameters

string $v2Eligibility

The eligibility from v2.

Returns

\naigc\v25\ICompetitor —

The Competitor.

isDecathlete()

isDecathlete() : bool

Returns true if the Competitor is competing in the Decathlon.

Returns

bool