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
	$ctrl

	$language

	$access

	$obj_definition

Detailed Description

Central entry point for users of the service.

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

Constructor & Destructor Documentation

◆ __construct()

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

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

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

References $access, $ctrl, $language, $obj_definition, and language().

Here is the call graph for this function:

Member Function Documentation

◆ getClassNameForType()

ilKioskModeService::getClassNameForType ( string $object_type )

protected

Returns: classname of type-specific kiosk view.

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

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

Referenced by getViewFor(), and hasKioskMode().

Here is the caller graph for this function:

◆ getViewFor()

ilKioskModeService::getViewFor ( \ilObject $object )

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

Returns: ilKioskModeView|null

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

    {
        $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
        );
    }

References getClassNameForType(), ilObject\getType(), hasKioskMode(), and language().

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 68 of file class.ilKioskModeService.php.

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