Class ilTermsOfServiceAcceptanceHistoryGUI. More...

Inheritance diagram for ilTermsOfServiceAcceptanceHistoryGUI:

Collaboration diagram for ilTermsOfServiceAcceptanceHistoryGUI:

Public Member Functions
	__construct (\ilObjTermsOfService $tos, \ilTermsOfServiceCriterionTypeFactoryInterface $criterionTypeFactory, \ilTemplate $tpl, \ilCtrl $ctrl, \ilLanguage $lng, \ilRbacSystem $rbacsystem, \ilErrorHandling $error, ServerRequestInterface $request, Factory $uiFactory, Renderer $uiRenderer, ilTermsOfServiceTableDataProviderFactory $tableDataProviderFactory)
	ilTermsOfServiceDocumentGUI constructor. More...

	executeCommand ()
	The implemented class should be \ilCtrl enabled and execute or forward the given command. More...

	executeCommand ()
	The implemented class should be \ilCtrl enabled and execute or forward the given command. More...

Protected Member Functions
	getAcceptanceHistoryTable ()

	showAcceptanceHistory ()

	applyAcceptanceHistoryFilter ()

	resetAcceptanceHistoryFilter ()

	addUserAutoComplete ()
	Show auto complete results. More...

Protected Attributes
	$tableDataProviderFactory

	$tos

	$tpl

	$ctrl

	$lng

	$rbacsystem

	$error

	$uiFactory

	$uiRenderer

	$request

	$criterionTypeFactory

Detailed Description

Class ilTermsOfServiceAcceptanceHistoryGUI.

Author: Michael Jansen mjans.nosp@m.en@d.nosp@m.ataba.nosp@m.y.de

Definition at line 12 of file class.ilTermsOfServiceAcceptanceHistoryGUI.php.

Constructor & Destructor Documentation

◆ __construct()

ilTermsOfServiceAcceptanceHistoryGUI::__construct	(	\ilObjTermsOfService	$tos,
		\ilTermsOfServiceCriterionTypeFactoryInterface	$criterionTypeFactory,
		\ilTemplate	$tpl,
		\ilCtrl	$ctrl,
		\ilLanguage	$lng,
		\ilRbacSystem	$rbacsystem,
		\ilErrorHandling	$error,
		ServerRequestInterface	$request,
		Factory	$uiFactory,
		Renderer	$uiRenderer,
		ilTermsOfServiceTableDataProviderFactory	$tableDataProviderFactory
	)

ilTermsOfServiceDocumentGUI constructor.

Parameters

\ilObjTermsOfService	$tos
\ilTermsOfServiceCriterionTypeFactoryInterface	$criterionTypeFactory
\ilTemplate	$tpl
\ilCtrl	$ctrl
\ilLanguage	$lng
\ilRbacSystem	$rbacsystem
\ilErrorHandling	$error
ServerRequestInterface	$request
Factory	$uiFactory
Renderer	$uiRenderer
\ilTermsOfServiceTableDataProviderFactory	$tableDataProviderFactory

Definition at line 61 of file class.ilTermsOfServiceAcceptanceHistoryGUI.php.

      {
        $this->tos = $tos;
        $this->criterionTypeFactory = $criterionTypeFactory;
        $this->tpl = $tpl;
        $this->ctrl = $ctrl;
        $this->lng = $lng;
        $this->rbacsystem = $rbacsystem;
        $this->error = $error;
        $this->request = $request;
        $this->uiFactory = $uiFactory;
        $this->uiRenderer = $uiRenderer;
        $this->tableDataProviderFactory = $tableDataProviderFactory;
    }

References $criterionTypeFactory, $ctrl, $error, $lng, $rbacsystem, $request, $tableDataProviderFactory, $tos, $tpl, $uiFactory, $uiRenderer, and error().

Here is the call graph for this function:

Member Function Documentation

◆ addUserAutoComplete()

ilTermsOfServiceAcceptanceHistoryGUI::addUserAutoComplete ( )

protected

Show auto complete results.

Definition at line 170 of file class.ilTermsOfServiceAcceptanceHistoryGUI.php.

    {
        $auto = new \ilUserAutoComplete();
        $auto->setSearchFields(array('login', 'firstname', 'lastname', 'email'));
        $auto->enableFieldSearchableCheck(false);
        $auto->setMoreLinkAvailable(true);
 
        $isFetchAllRequest = $this->request->getQueryParams()['fetchall'] ?? false;
        if ((bool) $isFetchAllRequest) {
            $auto->setLimit(ilUserAutoComplete::MAX_ENTRIES);
        }
 
        $query = \ilUtil::stripSlashes($this->request->getQueryParams()['term'] ?? '');
        echo $auto->getList($query);
        exit();
    }

References $query, exit, ilUserAutoComplete\MAX_ENTRIES, and ilUtil\stripSlashes().

Here is the call graph for this function:

◆ applyAcceptanceHistoryFilter()

ilTermsOfServiceAcceptanceHistoryGUI::applyAcceptanceHistoryFilter ( )

protected

Definition at line 146 of file class.ilTermsOfServiceAcceptanceHistoryGUI.php.

    {
        $table = $this->getAcceptanceHistoryTable();
        $table->resetOffset();
        $table->writeFilterToSession();
 
        $this->showAcceptanceHistory();
    }

References $table, getAcceptanceHistoryTable(), and showAcceptanceHistory().

Here is the call graph for this function:

◆ executeCommand()

ilTermsOfServiceAcceptanceHistoryGUI::executeCommand ( )

The implemented class should be \ilCtrl enabled and execute or forward the given command.

Implements ilTermsOfServiceControllerEnabled.

Definition at line 90 of file class.ilTermsOfServiceAcceptanceHistoryGUI.php.

    {
        $nextClass = $this->ctrl->getNextClass($this);
        $cmd = $this->ctrl->getCmd();
 
        if (
            !$this->rbacsystem->checkAccess('read', $this->tos->getRefId()) ||
            !$this->rbacsystem->checkAccess('read', USER_FOLDER_ID)
        ) {
            $this->error->raiseError($this->lng->txt('permission_denied'), $this->error->MESSAGE);
        }
 
        switch (strtolower($nextClass)) {
            default:
                if ($cmd == '' || !method_exists($this, $cmd)) {
                    $cmd = 'showAcceptanceHistory';
                }
                $this->$cmd();
                break;
        }
    }

References error(), and USER_FOLDER_ID.

Here is the call graph for this function:

◆ getAcceptanceHistoryTable()

ilTermsOfServiceAcceptanceHistoryGUI::getAcceptanceHistoryTable ( )

protected

Returns: ilTermsOfServiceAcceptanceHistoryTableGUI

Exceptions

ilTermsOfServiceMissingDatabaseAdapterException

Definition at line 116 of file class.ilTermsOfServiceAcceptanceHistoryGUI.php.

                                                   : \ilTermsOfServiceAcceptanceHistoryTableGUI
    {
        $table = new \ilTermsOfServiceAcceptanceHistoryTableGUI(
            $this,
            'showAcceptanceHistory',
            $this->criterionTypeFactory,
            $this->uiFactory,
            $this->uiRenderer
        );
        $table->setProvider($this->tableDataProviderFactory->getByContext(\ilTermsOfServiceTableDataProviderFactory::CONTEXT_ACCEPTANCE_HISTORY));
 
        return $table;
    }

References $table, and ilTermsOfServiceTableDataProviderFactory\CONTEXT_ACCEPTANCE_HISTORY.

Referenced by applyAcceptanceHistoryFilter(), resetAcceptanceHistoryFilter(), and showAcceptanceHistory().

Here is the caller graph for this function:

◆ resetAcceptanceHistoryFilter()

ilTermsOfServiceAcceptanceHistoryGUI::resetAcceptanceHistoryFilter ( )

protected

Definition at line 158 of file class.ilTermsOfServiceAcceptanceHistoryGUI.php.

    {
        $table = $this->getAcceptanceHistoryTable();
        $table->resetOffset();
        $table->resetFilter();
 
        $this->showAcceptanceHistory();
    }

References $table, getAcceptanceHistoryTable(), and showAcceptanceHistory().

Here is the call graph for this function:

◆ showAcceptanceHistory()

ilTermsOfServiceAcceptanceHistoryGUI::showAcceptanceHistory ( )

protected

Definition at line 133 of file class.ilTermsOfServiceAcceptanceHistoryGUI.php.

    {
        $table = $this->getAcceptanceHistoryTable();
 
        $table->populate();
 
        $this->tpl->setContent($table->getHTML());
    }

References $table, and getAcceptanceHistoryTable().

Referenced by applyAcceptanceHistoryFilter(), and resetAcceptanceHistoryFilter().

Here is the call graph for this function:

Here is the caller graph for this function:

Field Documentation

◆ $criterionTypeFactory

ilTermsOfServiceAcceptanceHistoryGUI::$criterionTypeFactory

protected

Definition at line 45 of file class.ilTermsOfServiceAcceptanceHistoryGUI.php.

Referenced by __construct().

◆ $ctrl

ilTermsOfServiceAcceptanceHistoryGUI::$ctrl

protected

Definition at line 24 of file class.ilTermsOfServiceAcceptanceHistoryGUI.php.

Referenced by __construct().

◆ $error

ilTermsOfServiceAcceptanceHistoryGUI::$error

protected

Definition at line 33 of file class.ilTermsOfServiceAcceptanceHistoryGUI.php.

Referenced by __construct().

◆ $lng

ilTermsOfServiceAcceptanceHistoryGUI::$lng

protected

Definition at line 27 of file class.ilTermsOfServiceAcceptanceHistoryGUI.php.

Referenced by __construct().

◆ $rbacsystem

ilTermsOfServiceAcceptanceHistoryGUI::$rbacsystem

protected

Definition at line 30 of file class.ilTermsOfServiceAcceptanceHistoryGUI.php.

Referenced by __construct().

◆ $request

ilTermsOfServiceAcceptanceHistoryGUI::$request

protected

Definition at line 42 of file class.ilTermsOfServiceAcceptanceHistoryGUI.php.

Referenced by __construct().

◆ $tableDataProviderFactory

ilTermsOfServiceAcceptanceHistoryGUI::$tableDataProviderFactory

protected

Definition at line 15 of file class.ilTermsOfServiceAcceptanceHistoryGUI.php.

Referenced by __construct().

◆ $tos

ilTermsOfServiceAcceptanceHistoryGUI::$tos

protected

Definition at line 18 of file class.ilTermsOfServiceAcceptanceHistoryGUI.php.

Referenced by __construct().

◆ $tpl

ilTermsOfServiceAcceptanceHistoryGUI::$tpl

protected

Definition at line 21 of file class.ilTermsOfServiceAcceptanceHistoryGUI.php.

Referenced by __construct().

◆ $uiFactory

ilTermsOfServiceAcceptanceHistoryGUI::$uiFactory

protected

Definition at line 36 of file class.ilTermsOfServiceAcceptanceHistoryGUI.php.

Referenced by __construct().

◆ $uiRenderer

ilTermsOfServiceAcceptanceHistoryGUI::$uiRenderer

protected

Definition at line 39 of file class.ilTermsOfServiceAcceptanceHistoryGUI.php.

Referenced by __construct().

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

Services/TermsOfService/classes/History/class.ilTermsOfServiceAcceptanceHistoryGUI.php

Public Member Functions

Protected Member Functions

Protected Attributes

Detailed Description

Constructor & Destructor Documentation

◆ __construct()

Member Function Documentation

◆ addUserAutoComplete()

◆ applyAcceptanceHistoryFilter()

◆ executeCommand()

◆ getAcceptanceHistoryTable()

◆ resetAcceptanceHistoryFilter()

◆ showAcceptanceHistory()

Field Documentation

◆ $criterionTypeFactory

◆ $ctrl

◆ $error

◆ $lng

◆ $rbacsystem

◆ $request

◆ $tableDataProviderFactory

◆ $tos

◆ $tpl

◆ $uiFactory

◆ $uiRenderer