\naigc\v25ITeam

Functions related to Teams.

Summary

Methods

Constants

addToAwardsCategory()
removeFromAwardsCategory()
refreshAwardsCategories()
awardsCategories()
club()
createCompetitor()
competitors()
initials()
meet()
designation()
session()
setInitials()
setSession()
id()

No constants found

No protected methods found

N/A

No private methods found

N/A

Methods

addToAwardsCategory()

addToAwardsCategory(string  $awardsCategoryName) : \naigc\v25\IAwardsCategory|null

Adds the Team to a new AwardsCategory.

Parameters

string

$awardsCategoryName

The AwardsCategory to add the Competitor to.

Returns

\naigc\v25\IAwardsCategory|null —

The newly added AwardsCategory.

removeFromAwardsCategory()

removeFromAwardsCategory(\naigc\v25\IAwardsCategory  $awardsCategory) : \naigc\v25\ITeam

Removes the Team from an AwardsCategory.

Parameters

\naigc\v25\IAwardsCategory

$awardsCategory

The AwardsCategory remove the Competitor from.

Returns

\naigc\v25\ITeam —

The Team.

refreshAwardsCategories()

refreshAwardsCategories() : \naigc\v25\ITeam

Uses the Elibility of each TeamMember to set the correct TeamEligibility.

Returns

\naigc\v25\ITeam —

The Team.

awardsCategories()

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

Gets all of the AwardsCategories the Team is eligible for.

Returns

\naigc\v25\IAwardsCategory[] —

The list of AwardsCategories.

club()

club() : \naigc\v25\IClub

Gets the Club the Team is part of.

Returns

\naigc\v25\IClub —

The Club the Team is part of.

createCompetitor()

createCompetitor(int  $personId) : \naigc\v25\ICompetitor|null

Creates a new Competitor on the Team.

Finds or creates a Competitor using the personID and uses them to create a TeamMember.

Parameters

int

$personId

The ID of the Person who will be competing.

Returns

\naigc\v25\ICompetitor|null —

The created/found Competitor.

competitors()

competitors() : \naigc\v25\ICompetitor[]

Gets all of the Competitors on the Team.

Returns

\naigc\v25\ICompetitor[] —

The list of Competitors.

initials()

initials() : string

Gets the initials of the Team.

Returns

string —

The initials of the Team.

meet()

meet() : \naigc\v25\IMeet

Gets the Meet the Team is competing in.

Returns

\naigc\v25\IMeet —

The Meet the Team is competing in.

designation()

designation() : string

Gets the designation of the Team.

Returns

string —

The designation of the Team.

session()

session() : \naigc\v25\ISession|null

Gets the Session the Team is assigned to.

Returns

\naigc\v25\ISession|null —

The Session the Team is assigned to.

setInitials()

setInitials(string  $initials) : \naigc\v25\ITeam

Sets the initials for the Team.

Parameters

string

$initials

The new initials.

Returns

\naigc\v25\ITeam —

The Team.

setSession()

setSession(string  $session) : \naigc\v25\ITeam

Sets the Session for a team.

Parameters

string

$session

The Session the Team is assigned to.

Returns

\naigc\v25\ITeam —

The Team.

id()

id() : int

Gets the ID of the Team.

Returns

int —

The ID.

Inherited from: \naigc\v25\ITeam