CupsManager Class Reference

Collaboration diagram for CupsManager:

Public Member Functions
	__construct (mysqli $mysqli)
	FindAllUpcomingCupsEarliestFirst ()
	FindAllPastCupsMostRecentFirst ()
	FindPairingsForThisCup ($cupID)
	GetPairingHashForThisCup ($cupID)
	GetNewCupIDByInfo ($name, $date_begin, $date_end)
	IsUserAvailableForTheCup ($userID, $cupID)
	GetEarliestCupYear ()
	GetMaximumCupYear ()
	GetCupByID ($cupID)
	InsertNewCup ($name, $date_begin, $date_end, $club, $content)
	DeleteOldAvailability ($cupID)
	InsertNewAvailability ($cupID, $userID, $attendanceFlag)
	DeleteOldPairing ($cupID)
	InsertNewPairing ($cupID, $posID, $userID)

Detailed Description

CupsManager has API functions to handle Cup object/s and delivers it through web application.

Constructor & Destructor Documentation

__construct()

CupsManager::__construct

(

mysqli

$mysqli

)

Initialize CupsManager with live database connection.

Parameters

mysqli

$mysqli

Member Function Documentation

DeleteOldAvailability()

CupsManager::DeleteOldAvailability

(

$cupID

)

Deletes availabilities for Cup.

Parameters

int

$cupID

Returns

bool

DeleteOldPairing()

CupsManager::DeleteOldPairing

(

$cupID

)

Delete old pairings for Cup.

Parameters

int

$cupID

Returns

bool

FindAllPastCupsMostRecentFirst()

CupsManager::FindAllPastCupsMostRecentFirst

(

)

Find past cups and sort by the most recent first.

Returns

array<Cup>

FindAllUpcomingCupsEarliestFirst()

CupsManager::FindAllUpcomingCupsEarliestFirst

(

)

Find future cups and sort by earliest first.

Returns

array<Cup>

FindPairingsForThisCup()

CupsManager::FindPairingsForThisCup

(

$cupID

)

Retrieve existing pairings list PairPositionUser that is ready for this Cup.

Parameters

int

$cupID

Returns

array<PairPositionUser>

GetCupByID()

CupsManager::GetCupByID

(

$cupID

)

Get Cup by id.

Parameters

int

$cupID

Returns

Cup|null

GetEarliestCupYear()

CupsManager::GetEarliestCupYear

(

)

Get year of most early Cup in web application.

Returns

int

GetMaximumCupYear()

CupsManager::GetMaximumCupYear

(

)

Get most recent year.

Returns

int

GetNewCupIDByInfo()

CupsManager::GetNewCupIDByInfo	(		$name,
			$date_begin,
			$date_end
	)

Return Cup based on its information.

Parameters

string	$name
string	$date_begin
string	$date_end

Returns

Cup|null

GetPairingHashForThisCup()

CupsManager::GetPairingHashForThisCup

(

$cupID

)

Get hash of database result of pairing for this Cup.

Parameters

int

$cupID

Returns

string

InsertNewAvailability()

CupsManager::InsertNewAvailability	(		$cupID,
			$userID,
			$attendanceFlag
	)

Insert new availability.

Parameters

int	$cupID
int	$userID
bool	$attendanceFlag

Returns

bool

InsertNewCup()

CupsManager::InsertNewCup	(		$name,
			$date_begin,
			$date_end,
			$club,
			$content
	)

Create new cup in the web application.

Parameters

string	$name
string	$date_begin
string	$date_end
int	$club
string	$content

Returns

bool

InsertNewPairing()

CupsManager::InsertNewPairing	(		$cupID,
			$posID,
			$userID
	)

Insert new pairing for Cup.

Parameters

int	$cupID
int	$posID
int	$userID

Returns

bool

IsUserAvailableForTheCup()

CupsManager::IsUserAvailableForTheCup	(		$userID,
			$cupID
	)

Check if User is available for the Cup.

Parameters

int	$userID
int	$cupID

Exceptions

RuntimeException

Returns

bool

---

The documentation for this class was generated from the following file:

• model/CupsManager.php