Public Member Functions
	__construct (public bool bool $requirelogin=false, public bool bool $requirecourselogin=false, protected bool ?string $courseattributename=null, public bool bool $autologinguest=true,)
	Create a new instance of the metadata class.

	get_course_attribute_name ()
	Get the course attribute name.

	should_autologin_guest ()
	Whether automatic guest login is enabled.

	should_require_course_login ()
	Whether course login is required.

	should_require_login ()
	Whether login is required.

Constructor & Destructor Documentation

◆ __construct()

core\router\require_login::__construct	(	public bool bool	$requirelogin = false,
		public bool bool	$requirecourselogin = false,
		protected bool ?string	$courseattributename = null,
		public bool bool	$autologinguest = true )

Create a new instance of the metadata class.

Parameters

bool	$requirelogin	Whether login is required
bool	$requirecourselogin	Whether a course login is required
mixed	$courseattributename	The name of the route attribute that the course object can be found in
bool	$autologinguest	Whether to automatically log in as guest

Exceptions

InvalidArgumentException

Parameters

$requirelogin	Whether login is required
$requirecourselogin	Whether a course login is required
$courseattributename	The name of the route attribute that the course object can be found in
$autologinguest	Whether to automatically log in as guest

core\router\require_login::get_course_attribute_name ( )

Get the course attribute name.

Return values

string

core\router\require_login::should_autologin_guest ( )

Whether automatic guest login is enabled.

Return values

bool

core\router\require_login::should_require_course_login ( )

Whether course login is required.

Return values

bool

core\router\require_login::should_require_login ( )

Whether login is required.

Return values

bool

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