Class ilTermsOfServiceAcceptanceHistoryGUI. More...

Inheritance diagram for ilTermsOfServiceAcceptanceHistoryGUI:

Collaboration diagram for ilTermsOfServiceAcceptanceHistoryGUI:

Public Member Functions
	__construct (ilObjTermsOfService $tos, ilTermsOfServiceCriterionTypeFactoryInterface $criterionTypeFactory, ilGlobalPageTemplate $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...

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,
		ilGlobalPageTemplate	$tpl,
		ilCtrl	$ctrl,
		ilLanguage	$lng,
		ilRbacSystem	$rbacsystem,
		ilErrorHandling	$error,
		ServerRequestInterface	$request,
		Factory	$uiFactory,
		Renderer	$uiRenderer,
		ilTermsOfServiceTableDataProviderFactory	$tableDataProviderFactory
	)

ilTermsOfServiceDocumentGUI constructor.

Parameters

ilObjTermsOfService	$tos
ilTermsOfServiceCriterionTypeFactoryInterface	$criterionTypeFactory
ilGlobalPageTemplate	$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.

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

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

Member Function Documentation

◆ addUserAutoComplete()

ilTermsOfServiceAcceptanceHistoryGUI::addUserAutoComplete ( )

protected

Show auto complete results.

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

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

                                              : void
     {
         $auto = new ilUserAutoComplete();
         $auto->setSearchFields(['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();
     }

Here is the call graph for this function:

◆ applyAcceptanceHistoryFilter()

ilTermsOfServiceAcceptanceHistoryGUI::applyAcceptanceHistoryFilter ( )

protected

Exceptions

ilTermsOfServiceMissingDatabaseAdapterException

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

References getAcceptanceHistoryTable(), and showAcceptanceHistory().

                                                       : void
     {
         $table = $this->getAcceptanceHistoryTable();
         $table->resetOffset();
         $table->writeFilterToSession();
 
         $this->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.

References USER_FOLDER_ID.

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

◆ getAcceptanceHistoryTable()

ilTermsOfServiceAcceptanceHistoryGUI::getAcceptanceHistoryTable ( )

protected

Returns: ilTermsOfServiceAcceptanceHistoryTableGUI

Exceptions

ilTermsOfServiceMissingDatabaseAdapterException

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

References ilTermsOfServiceTableDataProviderFactory\CONTEXT_ACCEPTANCE_HISTORY.

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

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

Here is the caller graph for this function:

◆ resetAcceptanceHistoryFilter()

ilTermsOfServiceAcceptanceHistoryGUI::resetAcceptanceHistoryFilter ( )

protected

Exceptions

ilTermsOfServiceMissingDatabaseAdapterException

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

References getAcceptanceHistoryTable(), and showAcceptanceHistory().

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

Here is the call graph for this function:

◆ showAcceptanceHistory()

ilTermsOfServiceAcceptanceHistoryGUI::showAcceptanceHistory ( )

protected

Exceptions

ilTermsOfServiceMissingDatabaseAdapterException

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

References getAcceptanceHistoryTable().

Referenced by applyAcceptanceHistoryFilter(), and resetAcceptanceHistoryFilter().

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