Central entry point for users of the service. More...

Collaboration diagram for ilKioskModeService:

Public Member Functions
	__construct (ilCtrl $ctrl, ilLanguage $language, ilAccess $access, ilObjectDefinition $obj_definition)

	getViewFor (ilObject $object)
	Try to get a kiosk mode view for the given object. More...

	hasKioskMode (string $object_type)
	Check if objects of a certain type provides kiosk mode in general. More...

Protected Member Functions
	getClassNameForType (string $object_type)

Protected Attributes
ilCtrl	$ctrl

ilLanguage	$language

ilAccess	$access

ilObjectDefinition	$obj_definition

Detailed Description

Central entry point for users of the service.

Definition at line 10 of file class.ilKioskModeService.php.

Constructor & Destructor Documentation

◆ __construct()

ilKioskModeService::__construct	(	ilCtrl	$ctrl,
		ilLanguage	$language,
		ilAccess	$access,
		ilObjectDefinition	$obj_definition
	)

Definition at line 17 of file class.ilKioskModeService.php.

References $access, $ctrl, $language, $obj_definition, ILIAS\Repository\access(), ILIAS\Repository\ctrl(), and ILIAS\UI\examples\Symbol\Glyph\Language\language().

       {
         $this->ctrl = $ctrl;
         $this->language = $language;
         $this->access = $access;
         $this->obj_definition = $obj_definition;
     }

Here is the call graph for this function:

Member Function Documentation

◆ getClassNameForType()

ilKioskModeService::getClassNameForType ( string $object_type )

protected

Returns: string classname of type-specific kiosk view.

Definition at line 63 of file class.ilKioskModeService.php.

Referenced by getViewFor(), and hasKioskMode().

                                                                : string
     {
         $class = $this->obj_definition->getClassName($object_type);
         return "il" . $class . "KioskModeView";
     }

Here is the caller graph for this function:

◆ getViewFor()

ilKioskModeService::getViewFor ( ilObject $object )

Try to get a kiosk mode view for the given object.

Definition at line 32 of file class.ilKioskModeService.php.

References ILIAS\Repository\access(), ILIAS\Repository\ctrl(), getClassNameForType(), ilObject\getType(), hasKioskMode(), and ILIAS\UI\examples\Symbol\Glyph\Language\language().

                                                 : ?ilKioskModeView
     {
         $object_type = $object->getType();
         if (!$this->hasKioskMode($object_type)) {
             return null;
         }
 
         $class_name = $this->getClassNameForType($object_type);
 
         return new $class_name(
             $object,
             $this->ctrl,
             $this->language,
             $this->access
         );
     }

Here is the call graph for this function:

◆ hasKioskMode()

ilKioskModeService::hasKioskMode ( string $object_type )

Check if objects of a certain type provides kiosk mode in general.

Parameters

string $object_type needs to be a valid object type

Definition at line 54 of file class.ilKioskModeService.php.

References getClassNameForType().

Referenced by getViewFor().

                                                      : bool
     {
         $class_name = $this->getClassNameForType($object_type);
         return class_exists($class_name);
     }