UsersManager Class Reference

Collaboration diagram for UsersManager:

Public Member Functions
	__construct (mysqli $mysqli)
	GetUserByID ($id)
	FindAllActiveUsersOrderByLastNameAsc ()
	FindAllInactiveUsersOrderByLastNameAsc ()
	FindAllRegisteredTeamMembersForTheCup ($cupId, $teamId)
	FindAllTeamMembers ($teamId)
	FindAllUsers ()
	FindAllRegisteredUsersForTheCup ($cupId)
	FindPairedUsersOnCupForPosition ($cupId, $position)
	GetClubAbbreviationByAffiliationID ($id)
	GetClubNameByAffiliationID ($id)
	GetUserFullNameByID ($userID)
	FindAllRefereeRanks ()
	GetRefereeRank ($id)
	IsComing ($cupID, $userID)
	RetComingCSSClass ($cupID, $userID)
	RetStringComingFlag ($cupID, $userID)
	GetUserEmailByID ($userID)
	SetPasswordForUser ($uid, $passwd)
	SetLoginEmailForUser ($uid, $email)
	SetRefereeRankForUser ($uid, $rank)
	SetAvailabilityRegister ($uid, $cid)
	SetAvailabilityCanGo ($uid, $cid)
	SetAvailabilityCantGo ($uid, $cid)
	IsEmailPresentAlready ($email)
	IsUserWithIDPresentAlready ($id)
	RegisterUser ($first_name, $last_name, $email, $password, $rights, $refRank, $klubaffil)
	EmailNewPersonRegistered ($email, $password)
	SetApprovedForUser ($userID)
	CountCupsAttendanceOfUserGivenYear ($userID, $year)
	CountOverallStatisticsOfUserGivenYear ($userID, $year)
	CountClubSeasonalStatistics ($clubID, $year)
	LoginCandidateToBeAuthorized ($email)

Detailed Description

UsersManager has API functions to handle User object/s and delivers is through web application.

Constructor & Destructor Documentation

__construct()

UsersManager::__construct

(

mysqli

$mysqli

)

Initialize UsersManager with live database connection.

Parameters

mysqli

$mysqli

Member Function Documentation

CountClubSeasonalStatistics()

UsersManager::CountClubSeasonalStatistics	(		$clubID,
			$year
	)

Stats function that returns User attendances for cups in given year.

Parameters

int	$clubID
int	$year

Returns

array<StatUserCnt>

CountCupsAttendanceOfUserGivenYear()

UsersManager::CountCupsAttendanceOfUserGivenYear	(		$userID,
			$year
	)

Stats function that returns howmany cups User has attended for given year.

Parameters

int	$userID
int	$year

Returns

int

CountOverallStatisticsOfUserGivenYear()

UsersManager::CountOverallStatisticsOfUserGivenYear	(		$userID,
			$year
	)

Stats function that returns pairs StatPositionCnt of User for given year.

Parameters

int	$userID
int	$year

Returns

array<StatPositionCnt>

EmailNewPersonRegistered()

UsersManager::EmailNewPersonRegistered	(		$email,
			$password
	)

TODO - function that e-mails person and notifies him/her that registration to our web application happened.

Parameters

mixed	$email
mixed	$password

Returns

bool

FindAllActiveUsersOrderByLastNameAsc()

UsersManager::FindAllActiveUsersOrderByLastNameAsc

(

)

Get list of active users alphabetically.

Returns

array<User>

FindAllInactiveUsersOrderByLastNameAsc()

UsersManager::FindAllInactiveUsersOrderByLastNameAsc

(

)

Get list of inactive user alphabetically.

Returns

array<User>

FindAllRefereeRanks()

UsersManager::FindAllRefereeRanks

(

)

Find all referee ranks in the web application.

Returns

array<RefereeRank>

FindAllRegisteredTeamMembersForTheCup()

UsersManager::FindAllRegisteredTeamMembersForTheCup	(		$cupId,
			$teamId
	)

Get list of inactive users alphabetically.

Parameters

int	$cupId
int	$teamId

Returns

array<User>

FindAllRegisteredUsersForTheCup()

UsersManager::FindAllRegisteredUsersForTheCup

(

$cupId

)

List of registered users for Cup.

Parameters

int

$cupId

Returns

array<User>

FindAllTeamMembers()

UsersManager::FindAllTeamMembers

(

$teamId

)

List of registered User teammates for desired Cup.

Parameters

int

$teamId

Returns

array<User>

FindAllUsers()

UsersManager::FindAllUsers

(

)

List of all users from the web application.

Returns

array<User>

FindPairedUsersOnCupForPosition()

UsersManager::FindPairedUsersOnCupForPosition	(		$cupId,
			$position
	)

Get list of User s that are on Cup on Position.

Parameters

int	$cupId
int	$position

Returns

array<User>

GetClubAbbreviationByAffiliationID()

UsersManager::GetClubAbbreviationByAffiliationID

(

$id

)

Retrieve club abbreviation - short name code, provided Club id.

Parameters

int

$id

Returns

string

GetClubNameByAffiliationID()

UsersManager::GetClubNameByAffiliationID

(

$id

)

Retrieve Club name by id.

Parameters

int

$id

Returns

string

GetRefereeRank()

UsersManager::GetRefereeRank

(

$id

)

Get referee rank name by its id.

Parameters

int

$id

Returns

string

GetUserByID()

UsersManager::GetUserByID

(

$id

)

Get User by provided id.

Parameters

int

$id

Returns

User|null

GetUserEmailByID()

UsersManager::GetUserEmailByID

(

$userID

)

Retrieve e-mail of User based on his id.

Parameters

mixed

$userID

Returns

mixed

GetUserFullNameByID()

UsersManager::GetUserFullNameByID

(

$userID

)

Retrieve full name (first_name + last_name) of User by provided id.

Parameters

int

$userID

Returns

string

IsComing()

UsersManager::IsComing	(		$cupID,
			$userID
	)

Answer T/F if User is coming to Cup.

Parameters

int	$cupID
int	$userID

Returns

bool

IsEmailPresentAlready()

UsersManager::IsEmailPresentAlready

(

$email

)

Ask if User with this e-mail is already present in the system.

Parameters

string

$email

Returns

bool

IsUserWithIDPresentAlready()

UsersManager::IsUserWithIDPresentAlready

(

$id

)

Ask if User with this id is already present in the system.

Parameters

mixed

$id

Returns

bool

LoginCandidateToBeAuthorized()

UsersManager::LoginCandidateToBeAuthorized

(

$email

)

TODO LoginCandidateToBeAuthorized / mby depr.

Parameters

string

$email

Returns

array|bool|null

RegisterUser()

UsersManager::RegisterUser	(		$first_name,
			$last_name,
			$email,
			$password,
			$rights,
			$refRank,
			$klubaffil
	)

Register new user in the web application.

Parameters

string	$first_name
string	$last_name
string	$email
string	$password
int	$rights
int	$refRank
int	$klubaffil

Returns

bool

RetComingCSSClass()

UsersManager::RetComingCSSClass	(		$cupID,
			$userID
	)

Return CSS class for element if User is/not coming for Cup.

Parameters

int	$cupID
int	$userID

Returns

string

RetStringComingFlag()

UsersManager::RetStringComingFlag	(		$cupID,
			$userID
	)

Return string flag of coming/not coming as "1" or "0"

Parameters

int	$cupID
int	$userID

Returns

string

SetApprovedForUser()

UsersManager::SetApprovedForUser

(

$userID

)

Set approved flag for new User so he/she can use the system.

Parameters

int

$userID

Returns

bool

SetAvailabilityCanGo()

UsersManager::SetAvailabilityCanGo	(		$uid,
			$cid
	)

Flag available User as can go - TRUE.

Parameters

int	$uid
int	$cid

Returns

bool

SetAvailabilityCantGo()

UsersManager::SetAvailabilityCantGo	(		$uid,
			$cid
	)

Flag available User as can't go - FALSE.

Parameters

int	$uid
int	$cid

Returns

bool

SetAvailabilityRegister()

UsersManager::SetAvailabilityRegister	(		$uid,
			$cid
	)

Set User's availability for cup.

Parameters

int	$uid
int	$cid

Returns

bool

SetLoginEmailForUser()

UsersManager::SetLoginEmailForUser	(		$uid,
			$email
	)

Set new login email for User as sysadmin.

Parameters

int	$uid
string	$email

Returns

bool

SetPasswordForUser()

UsersManager::SetPasswordForUser	(		$uid,
			$passwd
	)

Set new password for User as sysadmin.

Parameters

int	$uid
string	$passwd

Returns

bool

SetRefereeRankForUser()

UsersManager::SetRefereeRankForUser	(		$uid,
			$rank
	)

Set new referee rank for User as sysadmin.

Parameters

int	$uid
int	$rank

Returns

bool

---

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

• model/UsersManager.php