BristolSU\Support\Testing\Authentication\SessionAuthentication Class Reference

Inheritance diagram for BristolSU\Support\Testing\Authentication\SessionAuthentication:

Collaboration diagram for BristolSU\Support\Testing\Authentication\SessionAuthentication:

Public Member Functions
	__construct (Session $session, GroupRepository $groupRepository, UserRepository $userRepository, RoleRepository $roleRepository)
	getGroup ()
	getRole ()
	getUser ()
	setGroup (Group $group)
	setRole (Role $role)
	setUser (User $user)
	reset ()

Private Attributes
	$session
	$groupRepository
	$userRepository
	$roleRepository

Detailed Description

Authentication for getting a user, group or role from the session

Definition at line 18 of file SessionAuthentication.php.

Constructor & Destructor Documentation

__construct()

BristolSU\Support\Testing\Authentication\SessionAuthentication::__construct	(	Session	$session,
		GroupRepository	$groupRepository,
		UserRepository	$userRepository,
		RoleRepository	$roleRepository
	)

Initialise the session

Parameters

Session	$session	Session
GroupRepository	$groupRepository	Group Repository
UserRepository	$userRepository	User Repository
UserAuthentication	$userAuthentication	Database User Authentication

Definition at line 58 of file SessionAuthentication.php.

References BristolSU\Support\Testing\Authentication\SessionAuthentication\$groupRepository, BristolSU\Support\Testing\Authentication\SessionAuthentication\$roleRepository, BristolSU\Support\Testing\Authentication\SessionAuthentication\$session, and BristolSU\Support\Testing\Authentication\SessionAuthentication\$userRepository.

Member Function Documentation

getGroup()

BristolSU\Support\Testing\Authentication\SessionAuthentication::getGroup

(

)

Get the group

Returns the group belonging to a role if logged into a role, otherwise the group logged in

Returns

Group|null

Implements BristolSU\Support\Authentication\Contracts\Authentication.

Definition at line 73 of file SessionAuthentication.php.

References BristolSU\Support\Testing\Authentication\SessionAuthentication\getRole().

getRole()

BristolSU\Support\Testing\Authentication\SessionAuthentication::getRole

(

)

Get the role

Returns

Role|null

Implements BristolSU\Support\Authentication\Contracts\Authentication.

Definition at line 93 of file SessionAuthentication.php.

Referenced by BristolSU\Support\Testing\Authentication\SessionAuthentication\getGroup().

getUser()

BristolSU\Support\Testing\Authentication\SessionAuthentication::getUser

(

)

Get the user

Returns

User|null

Implements BristolSU\Support\Authentication\Contracts\Authentication.

Definition at line 109 of file SessionAuthentication.php.

reset()

BristolSU\Support\Testing\Authentication\SessionAuthentication::reset

(

)

Unset the user, group and role

Returns

void

Implements BristolSU\Support\Authentication\Contracts\Authentication.

Definition at line 158 of file SessionAuthentication.php.

setGroup()

BristolSU\Support\Testing\Authentication\SessionAuthentication::setGroup

(

Group

$group

)

Set the group

Parameters

Group

$group

Returns

void

Implements BristolSU\Support\Authentication\Contracts\Authentication.

Definition at line 126 of file SessionAuthentication.php.

setRole()

BristolSU\Support\Testing\Authentication\SessionAuthentication::setRole

(

Role

$role

)

Set the role

Parameters

Role

$role

Returns

void

Implements BristolSU\Support\Authentication\Contracts\Authentication.

Definition at line 137 of file SessionAuthentication.php.

setUser()

BristolSU\Support\Testing\Authentication\SessionAuthentication::setUser

(

User

$user

)

Set the user

Parameters

User

$user

Returns

void

Implements BristolSU\Support\Authentication\Contracts\Authentication.

Definition at line 148 of file SessionAuthentication.php.

Member Data Documentation

$groupRepository

BristolSU\Support\Testing\Authentication\SessionAuthentication::$groupRepository

private

Definition at line 34 of file SessionAuthentication.php.

Referenced by BristolSU\Support\Testing\Authentication\SessionAuthentication\__construct().

$roleRepository

BristolSU\Support\Testing\Authentication\SessionAuthentication::$roleRepository

private

Definition at line 47 of file SessionAuthentication.php.

Referenced by BristolSU\Support\Testing\Authentication\SessionAuthentication\__construct().

$session

BristolSU\Support\Testing\Authentication\SessionAuthentication::$session

private

Definition at line 26 of file SessionAuthentication.php.

Referenced by BristolSU\Support\Testing\Authentication\SessionAuthentication\__construct().

$userRepository

BristolSU\Support\Testing\Authentication\SessionAuthentication::$userRepository

private

Definition at line 40 of file SessionAuthentication.php.

Referenced by BristolSU\Support\Testing\Authentication\SessionAuthentication\__construct().

---

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

• src/Testing/Authentication/SessionAuthentication.php