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

\naigc\v25\CompetitorById

Functions related to Competitors.

Summary

Methods
Properties
Constants
addToAwardsCategory()
removeFromAwardsCategory()
refreshAwardsCategories()
addToDecathlon()
addToBracket()
removeFromBracket()
addToTeam()
removeFromTeam()
teams()
awardsCategories()
brackets()
competitionNumber()
delete()
meet()
name()
nameFirst()
nameLast()
id()
person()
clubName()
setCompetitionNumber()
setClubName()
setName()
v2Eligibility()
setV2Eligibility()
isDecathlete()
__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

Methods

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.

Throws

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

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.

Throws

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

Returns

\naigc\v25\ICompetitor —

The Competitor.

refreshAwardsCategories()

refreshAwardsCategories() : \naigc\v25\ICompetitor

Refreshes the AwardsCategories the Competitor is in.

Throws

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

TODO: Don't hardcode so much stuff.

Returns

\naigc\v25\ICompetitor —

The Competitor.

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.

Throws

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

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.

Throws

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

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.

Throws

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

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.

Throws

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

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.

Throws

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

Returns

\naigc\v25\ICompetitor —

The Competitor.

teams()

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

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

Throws

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

Returns

\naigc\v25\ITeam[] —

The list of Teams.

awardsCategories()

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

Gets all of the AwardsCategories the Competitor is eligible for.

Throws

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

Returns

\naigc\v25\IAwardsCategory[] —

The list of AwardsCategories.

brackets()

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

Gets all of the Brackets the Competitor is in.

Throws

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

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.

Throws

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

meet()

meet() : \naigc\v25\IMeet

Gets the Meet the Competitor is competing in.

Throws

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

Returns

\naigc\v25\IMeet —

The meet.

name()

name() : string

Gets the first 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

Returns the ID of the Competitor.

Returns

int —

The ID.

person()

person() : \naigc\v25\IPerson

Gets the Person associated with the Competitor.

Throws

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

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.

Throws

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

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.

Throws

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

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.

Throws

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

Returns

\naigc\v25\ICompetitor —

The Competitor.

v2Eligibility()

v2Eligibility() : string

Gets the v2Eligibility of the Competitor.

Throws

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

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.

Throws

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

Returns

\naigc\v25\ICompetitor —

The Competitor.

isDecathlete()

isDecathlete() : bool

Returns true if the Competitor is competing in the Decathlon.

Throws

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

Returns

bool

__construct()

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

Creates a new Competitor object.

Parameters

\naigc\v25\util\IMysql $mysql

The database.
int $competitorId

The ID of the Competitor.

Throws

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

Returns

mixed