modules/Teams/TeamSetManager.php
inherited
Constants
Functions
Classes
Constants
\TeamSetManager
Properties
$_setHash= 'array()'
array()Details- Type
- n/a
$instance= ''
- Type
- n/a
Methods
__construct(
)
:
voidConstructor for TrackerManager. Declared private for singleton pattern.
add(
\$team_set_id $team_set_id, \$module $table_name
)
:
voidAdd a team_set_id and module combination to the hash for later flushing to the db.
| Name | Type | Description |
|---|---|---|
| $team_set_id | \$team_set_id |
|
| $table_name | \$module |
|
addTeamSetMD5(
$team_set_id, $md5
)
:
void| Name | Type | Description |
|---|---|---|
| $team_set_id | ||
| $md5 |
cleanUp(
)
:
voidGo through each of the team_sets_modules and find sets that are no longer in use
flushBackendCache(
)
:
voidclear out the cache
getCommaDelimitedTeams(
\id $team_set_id, \id $primary_team_id
=
'', boolean $for_display
=
false
)
:
stringReturn a comma delimited list of teams for display purposes
| Name | Type | Description |
|---|---|---|
| $team_set_id | \id | |
| $primary_team_id | \id | |
| $for_display | boolean |
| Type | Description |
|---|---|
| string |
getFormattedTeamNames(
$teams_arr
=
array()
)
:
void| Name | Type | Description |
|---|---|---|
| $teams_arr |
getInstance(
)
:
voidgetInstance Singleton method to return static instance of TrackerManager
- Returns
- static TrackerManager instance
getTeamSetIdFromMD5(
\unknown_type $md5
)
:
\unknownCheck if we have an md5 relationship to a team set id
| Name | Type | Description |
|---|---|---|
| $md5 | \unknown_type |
| Type | Description |
|---|---|
| \unknown |
getTeamsFromSet(
\$team_set_id $team_set_id
)
:
arrayRetrieve a list of team associated with a set for display purposes
| Name | Type | Description |
|---|---|---|
| $team_set_id | \$team_set_id | string |
| Type | Description |
|---|---|
| array | of teams array('id', 'name'); |
getUnformattedTeamsFromSet(
\$team_set_id $team_set_id
)
:
arrayRetrieve a list of team associated with a set
| Name | Type | Description |
|---|---|---|
| $team_set_id | \$team_set_id | string |
| Type | Description |
|---|---|
| array | of teams array('id', 'name'); |
rebuildTeamSets(
)
:
\theRebuild the team_sets_teams relationship and remove any teams that have been deleted from the system from the team set Go through each team set and check if each team on the set is still in the teams table.
| Type | Description |
|---|---|
| \the | team sets that have been affected as well as the team ids within those team sets |
removeTeamFromSets(
string $team_id
)
:
ArrayGiven a particular team id, remove the team from all team sets that it belongs to
| Name | Type | Description |
|---|---|---|
| $team_id | string | The team's id to remove from the team sets |
| Type | Description |
|---|---|
| Array | of team_set ids that were affected |
save(
)
:
voidSave the data in the hash to the database using TeamSetModule object
saveTeamSetModule(
\guid $teamSetId, string $tableName
)
:
voidThe above method "save" will flush the entire cache, saveTeamSetModule will just save one entry.
| Name | Type | Description |
|---|---|---|
| $teamSetId | \guid | the GUID of the team set id we wish to save |
| $tableName | string | the corresponding table name |