ilObjTermsOfServiceGUI Class Reference

Inheritance diagram for ilObjTermsOfServiceGUI:

Collaboration diagram for ilObjTermsOfServiceGUI:

Public Member Functions
	getType ()
	Functions that must be overwritten. More...
	executeCommand ()
	getAdminTabs ()
Public Member Functions inherited from ilObject2GUI
	__construct ($a_id=0, $a_id_type=self::REPOSITORY_NODE_ID, $a_parent_node_id=0)
	Constructor. More...
	executeCommand ()
	execute command More...
	delete ()
	Display delete confirmation form (repository/workspace switch) More...
	confirmedDelete ()
	Delete objects (repository/workspace switch) More...
	getHTML ()
	withReferences ()
	Final/Private declaration of unchanged parent methods. More...
	setCreationMode ($a_mode=true)
	getCreationMode ()
	prepareOutput ($a_show_subobjects=true)
	isVisible ($a_ref_id, $a_type)
	trash ()
	undelete ()
	cancelDelete ()
	removeFromSystem ()
	cloneAll ()
	view ()
	view object content (repository/workspace switch) More...
	getType ()
	Functions that must be overwritten. More...
	create ()
	Deleted in ilObject. More...
	save ()
	edit ()
	update ()
	cancel ()
	importFile ()
	Import. More...
	putObjectInTree (ilObject $a_obj, $a_parent_node_id=null)
	Add object to tree at given position. More...
Public Member Functions inherited from ilObjectGUI
	executeCommand ()
	execute command More...
	withReferences ()
	determines wether objects are referenced or not (got ref ids or not) More...
	setCreationMode ($a_mode=true)
	if true, a creation screen is displayed the current $_GET[ref_id] don't belong to the current class! the mode is determined in ilrepositorygui More...
	getCreationMode ()
	get creation mode More...
	prepareOutput ($a_show_subobjects=true)
	prepare output More...
	getAdminTabs ()
	administration tabs show only permissions and trash folder More...
	getHTML ()
	confirmedDeleteObject ()
	confirmed deletion of object -> objects are moved to trash or deleted immediately, if trash is disabled More...
	cancelDeleteObject ()
	cancel deletion of object More...
	cancelObject ()
	cancel action and go back to previous page public More...
	createObject ()
	create new object form More...
	cancelCreation ()
	cancel create action and go back to repository parent More...
	saveObject ()
	save object More...
	getDidacticTemplateVar ($a_type)
	Get didactic template setting from creation screen. More...
	putObjectInTree (ilObject $a_obj, $a_parent_node_id=null)
	Add object to tree at given position. More...
	editObject ()
	edit object More...
	addExternalEditFormCustom (ilPropertyFormGUI $a_form)
	updateObject ()
	updates object entry in object_data More...
	getFormAction ($a_cmd, $a_formaction="")
	get form action for command (command is method name without "Object", e.g. More...
	isVisible ($a_ref_id, $a_type)
	viewObject ()
	list childs of current object More...
	deleteObject ($a_error=false)
	Display deletion confirmation screen. More...
	cloneAllObject ()
	Clone single (not container object) Method is overwritten in ilContainerGUI. More...

Data Fields
	$lng
	$ctrl
	$object
	$tabs_gui
	$factory
Data Fields inherited from ilObject2GUI
	$tree
const	OBJECT_ID = 0
const	REPOSITORY_NODE_ID = 1
const	WORKSPACE_NODE_ID = 2
const	REPOSITORY_OBJECT_ID = 3
const	WORKSPACE_OBJECT_ID = 4
const	PORTFOLIO_OBJECT_ID = 5
Data Fields inherited from ilObjectGUI
const	COPY_WIZARD_NEEDS_PAGE = 1
	$objDefinition
	$tpl
	$tree
	$lng
	$data
	$object
	$ref_id
	$obj_id
	$maxcount
	$formaction
	$return_location
	$target_frame
	$tab_target_script
	$actions
	$sub_objects
	$omit_locator = false
const	CFORM_NEW = 1
const	CFORM_IMPORT = 2
const	CFORM_CLONE = 3

Protected Member Functions
	initSettingsForm ()
	saveSettings ()
	settings ($init_from_database=true)
	confirmReset ()
	reset ()
	showAgreementByLanguage ()
	showLastResetDate ()
	showMissingDocuments ()
	applyAgreementByLanguageFilter ()
	resetAgreementByLanguageFilter ()
	getAgreementTextByFilenameAsynch ()
	showAcceptanceHistory ()
	getAcceptedContentAsynch ()
	addUserAutoComplete ()
	Show auto complete results. More...
	applyAcceptanceHistoryFilter ()
	resetAcceptanceHistoryFilter ()
Protected Member Functions inherited from ilObject2GUI
	afterConstructor ()
	Do anything that should be done after constructor in here. More...
	assignObject ()
	create object instance as internal property (repository/workspace switch) More...
	getAccessHandler ()
	Get access handler. More...
	setLocator ()
	set Locator More...
	deleteConfirmation ()
	Display delete confirmation form (workspace specific) More...
	deleteConfirmedObjects ()
	Delete objects (workspace specific) More...
	setTitleAndDescription ()
	showUpperIcon ()
	omitLocator ($a_omit=true)
	getTargetFrame ($a_cmd, $a_target_frame="")
	setTargetFrame ($a_cmd, $a_target_frame)
	getCenterColumnHTML ()
	getRightColumnHTML ()
	setColumnSettings (ilColumnGUI $column_gui)
	checkPermission ($a_perm, $a_cmd="", $a_type="", $a_ref_id=null)
	showPossibleSubObjects ()
	redirectToRefId ($a_ref_id, $a_cmd="")
	fillCloneTemplate ($a_tpl_varname, $a_type)
	fillCloneSearchTemplate ($a_tpl_varname, $a_type)
	searchCloneSource ()
	buildCloneSelect ($existing_objs)
	addAdminLocatorItems ($a_do_not_add_object=false)
	setTabs ()
	create tabs (repository/workspace switch) More...
	getReturnLocation ($a_cmd, $a_location="")
	Deprecated functions. More...
	setReturnLocation ($a_cmd, $a_location)
	showActions ()
	getTabs ()
	__showButton ($a_cmd, $a_text, $a_target='')
	hitsperpageObject ()
&	__initTableGUI ()
	__setTableGUIBasicData (&$tbl, &$result_set, $a_from="")
	addLocatorItems ()
	Functions to be overwritten. More...
	initCreationForms ($a_new_type)
	Init creation froms. More...
	checkPermissionBool ($a_perm, $a_cmd="", $a_type="", $a_node_id=null)
	Check permission. More...
	initHeaderAction ($a_sub_type=null, $a_sub_id=null)
	Add header action menu. More...
	redrawHeaderAction ()
	Updating icons after ajax call. More...
	getPermanentLinkWidget ($a_append=null, $a_center=false)
	handleAutoRating (ilObject $a_new_obj)
Protected Member Functions inherited from ilObjectGUI
	assignObject ()
	setTitleAndDescription ()
	called by prepare output More...
	initHeaderAction ($a_sub_type=null, $a_sub_id=null)
	Add header action menu. More...
	insertHeaderAction ($a_list_gui)
	Insert header action into main template. More...
	addHeaderAction ()
	Add header action menu. More...
	redrawHeaderActionObject ()
	Ajax call: redraw action header only. More...
	showMountWebfolderIcon ()
	setTabs ()
	set admin tabs public More...
	setAdminTabs ()
	set admin tabs public More...
	setLocator ()
	set Locator More...
	addLocatorItems ()
	should be overwritten to add object specific items (repository items are preloaded) More...
	omitLocator ($a_omit=true)
	addAdminLocatorItems ($a_do_not_add_object=false)
	should be overwritten to add object specific items (repository items are preloaded) More...
	initCreationForms ($a_new_type)
	Init creation froms. More...
	getCreationFormsHTML (array $a_forms)
	Get HTML for creation forms (accordion) More...
	initCreateForm ($a_new_type)
	Init object creation form. More...
	initDidacticTemplate (ilPropertyFormGUI $form)
	Show didactic template types. More...
	addDidacticTemplateOptions (array &$a_options)
	Add custom templates. More...
	afterSave (ilObject $a_new_object)
	Post (successful) object creation hook. More...
	initEditForm ()
	Init object edit form. More...
	initEditCustomForm (ilPropertyFormGUI $a_form)
	Add custom fields to update form. More...
	getEditFormValues ()
	Get values for edit form. More...
	getEditFormCustomValues (array &$a_values)
	Add values to custom edit fields. More...
	validateCustom (ilPropertyFormGUI $a_form)
	Validate custom values (if not possible with checkInput()) More...
	updateCustom (ilPropertyFormGUI $a_form)
	Insert custom update form values into object. More...
	afterUpdate ()
	Post (successful) object update hook. More...
	initImportForm ($a_new_type)
	Init object import form. More...
	importFileObject ($parent_id=null, $a_catch_errors=true)
	Import. More...
	afterImport (ilObject $a_new_object)
	Post (successful) object import hook. More...
	setFormAction ($a_cmd, $a_formaction)
	set specific form action for command More...
	getReturnLocation ($a_cmd, $a_location="")
	get return location for command (command is method name without "Object", e.g. More...
	setReturnLocation ($a_cmd, $a_location)
	set specific return location for command More...
	getTargetFrame ($a_cmd, $a_target_frame="")
	get target frame for command (command is method name without "Object", e.g. More...
	setTargetFrame ($a_cmd, $a_target_frame)
	set specific target frame for command More...
	showPossibleSubObjects ()
	show possible subobjects (pulldown menu) More...
	getTemplateFile ($a_cmd, $a_type="")
	get a template blockfile format: tpl. More...
	getTabs ()
	get tabs abstract method. More...
	__showButton ($a_cmd, $a_text, $a_target='')
	hitsperpageObject ()
&	__initTableGUI ()
	__setTableGUIBasicData (&$tbl, &$result_set, $a_from="")
	standard implementation for tables use 'from' variable use different initial setting of table More...
	redirectToRefId ($a_ref_id, $a_cmd="")
	redirects to (repository) view per ref id usually to a container and usually used at the end of a save/import method where the object gui type (of the new object) doesn't match with the type of the current $_GET["ref_id"] value More...
	fillCloneTemplate ($a_tpl_varname, $a_type)
	Fill object clone template This method can be called from any object GUI class that wants to offer object cloning. More...
	getCenterColumnHTML ()
	Get center column. More...
	getRightColumnHTML ()
	Display right column. More...
	setColumnSettings (ilColumnGUI $column_gui)
	May be overwritten in subclasses. More...
	checkPermission ($a_perm, $a_cmd="", $a_type="", $a_ref_id=null)
	Check permission and redirect on error. More...
	checkPermissionBool ($a_perm, $a_cmd="", $a_type="", $a_ref_id=null)
	Check permission. More...
	enableDragDropFileUpload ()
	Enables the file upload into this object by dropping files. More...
	handleAutoRating (ilObject $a_new_obj)
	Activate rating automatically if parent container setting. More...

Protected Attributes
	$form
	$rbacsystem
	$error
	$toolbar
	$user
	$log
Protected Attributes inherited from ilObject2GUI
	$object_id
	$node_id
	$creation_forms = array()
	$id_type = array()
	$parent_id
	$access_handler
Protected Attributes inherited from ilObjectGUI
	$ilErr
	$locator
	$user
	$access
	$settings
	$rbacreview
	$toolbar
	$rbacsystem
	$tmp_import_dir
	$tabs_gui = null
	$ctrl

Additional Inherited Members
Static Public Member Functions inherited from ilObject2GUI
static	handleAfterSaveCallback (ilObject $a_obj, $a_callback_ref_id)
	After creation callback. More...
Static Public Member Functions inherited from ilObjectGUI
static	_gotoRepositoryRoot ($a_raise_error=false)
	Goto repository root. More...
static	_gotoRepositoryNode ($a_ref_id, $a_cmd="frameset")
	Goto repository root. More...

Detailed Description

Author

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

Version

$Id$ ilObjTermsOfServiceGUI: ilPermissionGUI ilObjTermsOfServiceGUI: ilAdministrationGUI

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

Member Function Documentation

addUserAutoComplete()

ilObjTermsOfServiceGUI::addUserAutoComplete ( )

protected

Show auto complete results.

Definition at line 440 of file class.ilObjTermsOfServiceGUI.php.

References array, exit, ilUserAutoComplete\MAX_ENTRIES, and USER_FOLDER_ID.

    {
        if (
            !$this->rbacsystem->checkAccess('read', '', $this->object->getRefId()) ||
            !$this->rbacsystem->checkAccess('read', '', USER_FOLDER_ID)
        ) {
            echo json_encode(array());
            exit();
        }
        
        include_once 'Services/User/classes/class.ilUserAutoComplete.php';
        $auto = new ilUserAutoComplete();
        $auto->setSearchFields(array('login', 'firstname', 'lastname', 'email'));
        $auto->enableFieldSearchableCheck(false);
        $auto->setMoreLinkAvailable(true);

        if (($_REQUEST['fetchall'])) {
            $auto->setLimit(ilUserAutoComplete::MAX_ENTRIES);
        }

        echo $auto->getList($_REQUEST['term']);
        exit();
    }

applyAcceptanceHistoryFilter()

ilObjTermsOfServiceGUI::applyAcceptanceHistoryFilter ( )

protected

Definition at line 467 of file class.ilObjTermsOfServiceGUI.php.

References $table, and showAcceptanceHistory().

    {
        $table = new ilTermsOfServiceAcceptanceHistoryTableGUI($this, 'showAcceptanceHistory');
        $table->resetOffset();
        $table->writeFilterToSession();

        $this->showAcceptanceHistory();
    }

Here is the call graph for this function:

applyAgreementByLanguageFilter()

ilObjTermsOfServiceGUI::applyAgreementByLanguageFilter ( )

protected

Definition at line 342 of file class.ilObjTermsOfServiceGUI.php.

References $table, and showAgreementByLanguage().

    {
        $table = new ilTermsOfServiceAgreementByLanguageTableGUI($this, 'showAgreementByLanguage');
        $table->resetOffset();
        $table->writeFilterToSession();

        $this->showAgreementByLanguage();
    }

Here is the call graph for this function:

confirmReset()

ilObjTermsOfServiceGUI::confirmReset ( )

protected

Definition at line 245 of file class.ilObjTermsOfServiceGUI.php.

    {
        if (!$this->rbacsystem->checkAccess('write', $this->object->getRefId())) {
            $this->error->raiseError($this->lng->txt('permission_denied'), $this->error->MESSAGE);
        }

        $confirmation = new ilConfirmationGUI();
        $confirmation->setFormAction($this->ctrl->getFormAction($this, 'confirmReset'));
        $confirmation->setConfirm($this->lng->txt('confirm'), 'reset');
        $confirmation->setCancel($this->lng->txt('cancel'), 'showAgreementByLanguage');
        $confirmation->setHeaderText($this->lng->txt('tos_sure_reset_tos'));

        $this->tpl->setContent($confirmation->getHTML());
    }

executeCommand()

ilObjTermsOfServiceGUI::executeCommand

(

)

Definition at line 114 of file class.ilObjTermsOfServiceGUI.php.

References ilObject2GUI\prepareOutput().

    {
        $next_class = $this->ctrl->getNextClass($this);
        $cmd        = $this->ctrl->getCmd();
        $this->prepareOutput();

        switch ($next_class) {
            case 'ilpermissiongui':
                $this->tabs_gui->setTabActive('perm_settings');
                require_once 'Services/AccessControl/classes/class.ilPermissionGUI.php';
                $perm_gui = new ilPermissionGUI($this);
                $this->ctrl->forwardCommand($perm_gui);
                break;

            default:
                if ($cmd == '' || $cmd == 'view') {
                    $cmd = 'settings';
                }
                $this->$cmd();
                break;
        }
    }

Here is the call graph for this function:

getAcceptedContentAsynch()

ilObjTermsOfServiceGUI::getAcceptedContentAsynch ( )

protected

Definition at line 421 of file class.ilObjTermsOfServiceGUI.php.

References $_GET, $response, ilTermsOfServiceHelper\getById(), ilTermsOfServiceJsonResponse\STATUS_FAILURE, and ilUtil\stripSlashes().

    {
        require_once 'Services/TermsOfService/classes/class.ilTermsOfServiceJsonResponse.php';
        $response = new ilTermsOfServiceJsonResponse();

        if (!isset($_GET['tosv_id'])) {
            $response->setStatus(ilTermsOfServiceJsonResponse::STATUS_FAILURE);
            echo $response;
        }

        $entity = ilTermsOfServiceHelper::getById(ilUtil::stripSlashes($_GET['tosv_id']));
        $response->setBody($entity->getText());

        echo $response;
    }

Here is the call graph for this function:

getAdminTabs()

ilObjTermsOfServiceGUI::getAdminTabs

(

)

Definition at line 140 of file class.ilObjTermsOfServiceGUI.php.

References array, and USER_FOLDER_ID.

    {
        if ($this->rbacsystem->checkAccess('read', $this->object->getRefId())) {
            $this->tabs_gui->addTarget('settings', $this->ctrl->getLinkTarget($this, 'settings'), array('saveSettings', 'settings', '', 'view'), '', '');
        }

        if ($this->rbacsystem->checkAccess('read', $this->object->getRefId())) {
            $this->tabs_gui->addTarget('tos_agreement_by_lng', $this->ctrl->getLinkTarget($this, 'showAgreementByLanguage'), array('reset', 'confirmReset', 'showAgreementByLanguage', 'resetAgreementByLanguageFilter', 'applyAgreementByLanguageFilter'), '', '');
        }

        if ($this->rbacsystem->checkAccess('read', $this->object->getRefId()) &&
            $this->rbacsystem->checkAccess('read', USER_FOLDER_ID)
        ) {
            $this->tabs_gui->addTarget('tos_acceptance_history', $this->ctrl->getLinkTarget($this, 'showAcceptanceHistory'), array('showAcceptanceHistory', 'resetAcceptanceHistoryFilter', 'applyAcceptanceHistoryFilter'), '', '');
        }

        if ($this->rbacsystem->checkAccess('edit_permission', $this->object->getRefId())) {
            $this->tabs_gui->addTarget('perm_settings', $this->ctrl->getLinkTargetByClass(array(get_class($this), 'ilpermissiongui'), 'perm'), array('perm', 'info', 'owner'), 'ilpermissiongui');
        }
    }

getAgreementTextByFilenameAsynch()

ilObjTermsOfServiceGUI::getAgreementTextByFilenameAsynch ( )

protected

Definition at line 366 of file class.ilObjTermsOfServiceGUI.php.

References $_GET, $file, $response, file, ilTermsOfServiceJsonResponse\STATUS_FAILURE, and ilUtil\stripOnlySlashes().

    {
        require_once 'Services/TermsOfService/classes/class.ilTermsOfServiceJsonResponse.php';
        $response = new ilTermsOfServiceJsonResponse();

        if (
            !isset($_GET['agreement_document']) ||
            !strlen($_GET['agreement_document']) ||
            !$this->rbacsystem->checkAccess('read', $this->object->getRefId())) {
            $response->setStatus(ilTermsOfServiceJsonResponse::STATUS_FAILURE);
            echo $response;
        }

        $file = realpath(strip_tags(rawurldecode(ilUtil::stripOnlySlashes($_GET['agreement_document']))));
        if (preg_match('/Customizing[\/\\\](global[\/\\\]agreement|clients[\/\\\]' . CLIENT_ID . '[\/\\\]agreement)[\/\\\]agreement_([a-z]{2})\.html$/', $file)) {
            $content = file_get_contents($file);
            if (strip_tags($content) === $content) {
                $content       = '';
                $lines         = file($file);
                foreach ($lines as $line) {
                    $content .= nl2br(trim($line));
                }
            }
            $response->setBody($content);
        } else {
            $response->setStatus(ilTermsOfServiceJsonResponse::STATUS_FAILURE);
        }

        echo $response;
    }

Here is the call graph for this function:

getType()

ilObjTermsOfServiceGUI::getType

(

)

Functions that must be overwritten.

Definition at line 106 of file class.ilObjTermsOfServiceGUI.php.

    {
        return 'tos';
    }

initSettingsForm()

ilObjTermsOfServiceGUI::initSettingsForm ( )

protected

Definition at line 164 of file class.ilObjTermsOfServiceGUI.php.

References ilFormPropertyGUI\setInfo().

Referenced by saveSettings(), and settings().

    {
        if (null == $this->form) {
            $this->form = new ilPropertyFormGUI();
            $this->form->setTitle($this->lng->txt('tos_tos_settings'));
            $this->form->setFormAction($this->ctrl->getFormAction($this, 'saveSettings'));

            $status = new ilCheckboxInputGUI($this->lng->txt('tos_status_enable'), 'tos_status');
            $status->setInfo($this->lng->txt('tos_status_desc'));
            $this->form->addItem($status);

            $this->form->addCommandButton('saveSettings', $this->lng->txt('save'));
        }
    }

Here is the call graph for this function:

Here is the caller graph for this function:

reset()

ilObjTermsOfServiceGUI::reset ( )

protected

Definition at line 263 of file class.ilObjTermsOfServiceGUI.php.

References ilUtil\sendSuccess(), showAgreementByLanguage(), and user().

    {
        if (!$this->rbacsystem->checkAccess('write', $this->object->getRefId())) {
            $this->error->raiseError($this->lng->txt('permission_denied'), $this->error->MESSAGE);
        }

        $this->object->resetAll();
        $this->log->write(__METHOD__ . ': Terms of service reset by ' . $this->user->getId() . ' [' . $this->user->getLogin() . ']');
        ilUtil::sendSuccess($this->lng->txt('tos_reset_successfull'));

        $this->showAgreementByLanguage();
    }

Here is the call graph for this function:

resetAcceptanceHistoryFilter()

ilObjTermsOfServiceGUI::resetAcceptanceHistoryFilter ( )

protected

Definition at line 479 of file class.ilObjTermsOfServiceGUI.php.

References $table, and showAcceptanceHistory().

    {
        $table = new ilTermsOfServiceAcceptanceHistoryTableGUI($this, 'showAcceptanceHistory');
        $table->resetOffset();
        $table->resetFilter();

        $this->showAcceptanceHistory();
    }

Here is the call graph for this function:

resetAgreementByLanguageFilter()

ilObjTermsOfServiceGUI::resetAgreementByLanguageFilter ( )

protected

Definition at line 354 of file class.ilObjTermsOfServiceGUI.php.

References $table, and showAgreementByLanguage().

    {
        $table = new ilTermsOfServiceAgreementByLanguageTableGUI($this, 'showAgreementByLanguage');
        $table->resetOffset();
        $table->resetFilter();

        $this->showAgreementByLanguage();
    }

Here is the call graph for this function:

saveSettings()

ilObjTermsOfServiceGUI::saveSettings ( )

protected

Definition at line 182 of file class.ilObjTermsOfServiceGUI.php.

References $_POST, $list, League\OAuth2\Client\Provider\$provider, array, ilTermsOfServiceTableDataProviderFactory\CONTEXT_AGRREMENT_BY_LANGUAGE, initSettingsForm(), ilUtil\sendFailure(), ilUtil\sendSuccess(), and settings().

    {
        if (!$this->rbacsystem->checkAccess('write', $this->object->getRefId())) {
            $this->error->raiseError($this->lng->txt('permission_denied'), $this->error->MESSAGE);
        }

        $provider = $this->factory->getByContext(ilTermsOfServiceTableDataProviderFactory::CONTEXT_AGRREMENT_BY_LANGUAGE);
        $list     = $provider->getList(array(), array());

        $has_documents = false;
        foreach ($list['items'] as $item) {
            if ($item['agreement_document']) {
                $has_documents = true;
                break;
            }
        }

        $this->initSettingsForm();
        if ($this->form->checkInput()) {
            if ($has_documents || !(int) $this->form->getInput('tos_status')) {
                $this->object->saveStatus((int) $this->form->getInput('tos_status'));
                ilUtil::sendSuccess($this->lng->txt('saved_successfully'));
            }
        }
        
        if (
            !$has_documents &&
            (int) $this->form->getInput('tos_status') &&
            !$this->object->getStatus()
        ) {
            $_POST['tos_status'] = 0;
            ilUtil::sendFailure($this->lng->txt('tos_no_documents_exist_cant_save'));
        }

        $this->settings(false);
    }

Here is the call graph for this function:

settings()

ilObjTermsOfServiceGUI::settings (   $init_from_database = true )

protected

Parameters

bool

$init_from_database

Definition at line 222 of file class.ilObjTermsOfServiceGUI.php.

References array, initSettingsForm(), object, and showMissingDocuments().

Referenced by saveSettings().

    {
        if (!$this->rbacsystem->checkAccess('read', $this->object->getRefId())) {
            $this->error->raiseError($this->lng->txt('permission_denied'), $this->error->MESSAGE);
        }

        $this->showMissingDocuments();

        $this->initSettingsForm();
        if ($init_from_database) {
            $this->form->setValuesByArray(array(
                'tos_status' => $this->object->getStatus()
            ));
        } else {
            $this->form->setValuesByPost();
        }

        $this->tpl->setContent($this->form->getHTML());
    }

Here is the call graph for this function:

Here is the caller graph for this function:

showAcceptanceHistory()

ilObjTermsOfServiceGUI::showAcceptanceHistory ( )

protected

Definition at line 400 of file class.ilObjTermsOfServiceGUI.php.

References $table, ilTermsOfServiceTableDataProviderFactory\CONTEXT_ACCEPTANCE_HISTORY, and USER_FOLDER_ID.

Referenced by applyAcceptanceHistoryFilter(), and resetAcceptanceHistoryFilter().

    {
        if (
            !$this->rbacsystem->checkAccess('read', '', $this->object->getRefId()) ||
            !$this->rbacsystem->checkAccess('read', '', USER_FOLDER_ID)
        ) {
            $this->error->raiseError($this->lng->txt('permission_denied'), $this->error->MESSAGE);
        }

        $this->lng->loadLanguageModule('meta');

        $table = new ilTermsOfServiceAcceptanceHistoryTableGUI($this, 'showAcceptanceHistory');
        $table->setProvider($this->factory->getByContext(ilTermsOfServiceTableDataProviderFactory::CONTEXT_ACCEPTANCE_HISTORY));
        $table->populate();

        $this->tpl->setContent($table->getHTML());
    }

Here is the caller graph for this function:

showAgreementByLanguage()

ilObjTermsOfServiceGUI::showAgreementByLanguage ( )

protected

Definition at line 279 of file class.ilObjTermsOfServiceGUI.php.

References $table, ilTermsOfServiceTableDataProviderFactory\CONTEXT_AGRREMENT_BY_LANGUAGE, and showLastResetDate().

Referenced by applyAgreementByLanguageFilter(), reset(), and resetAgreementByLanguageFilter().

    {
        if (!$this->rbacsystem->checkAccess('read', $this->object->getRefId())) {
            $this->error->raiseError($this->lng->txt('permission_denied'), $this->error->MESSAGE);
        }

        $this->lng->loadLanguageModule('meta');

        if ($this->rbacsystem->checkAccess('write', $this->object->getRefId())) {
            $this->toolbar->setFormAction($this->ctrl->getFormAction($this, 'settings'));
            $this->toolbar->addFormButton($this->lng->txt('tos_reset_tos_for_all_users'), 'confirmReset');
        }

        $this->showLastResetDate();

        $table = new ilTermsOfServiceAgreementByLanguageTableGUI($this, 'showAgreementByLanguage');
        $table->setProvider($this->factory->getByContext(ilTermsOfServiceTableDataProviderFactory::CONTEXT_AGRREMENT_BY_LANGUAGE));
        $table->populate();

        $this->tpl->setContent($table->getHTML());
    }

Here is the call graph for this function:

Here is the caller graph for this function:

showLastResetDate()

ilObjTermsOfServiceGUI::showLastResetDate ( )

protected

Definition at line 304 of file class.ilObjTermsOfServiceGUI.php.

References ilDatePresentation\formatDate(), IL_CAL_UNIX, object, ilDatePresentation\setUseRelativeDates(), and ilDatePresentation\useRelativeDates().

Referenced by showAgreementByLanguage().

    {
        if ($this->object->getLastResetDate() && $this->object->getLastResetDate()->get(IL_CAL_UNIX) != 0) {
            $status = ilDatePresentation::useRelativeDates();
            ilDatePresentation::setUseRelativeDates(false);
            $this->toolbar->addText(sprintf($this->lng->txt('tos_last_reset_date'), ilDatePresentation::formatDate($this->object->getLastResetDate())));
            ilDatePresentation::setUseRelativeDates($status);
        }
    }

Here is the call graph for this function:

Here is the caller graph for this function:

showMissingDocuments()

ilObjTermsOfServiceGUI::showMissingDocuments ( )

protected

Definition at line 317 of file class.ilObjTermsOfServiceGUI.php.

References $list, League\OAuth2\Client\Provider\$provider, array, ilTermsOfServiceTableDataProviderFactory\CONTEXT_AGRREMENT_BY_LANGUAGE, object, and ilUtil\sendInfo().

Referenced by settings().

    {
        if (!$this->object->getStatus()) {
            return;
        }

        $provider = $this->factory->getByContext(ilTermsOfServiceTableDataProviderFactory::CONTEXT_AGRREMENT_BY_LANGUAGE);
        $list     = $provider->getList(array(), array());
        
        $has_documents = false;
        foreach ($list['items'] as $item) {
            if ($item['agreement_document']) {
                $has_documents = true;
                break;
            }
        }

        if (!$has_documents) {
            ilUtil::sendInfo($this->lng->txt('tos_no_documents_exist'));
        }
    }

Here is the call graph for this function:

Here is the caller graph for this function:

Field Documentation

$ctrl

ilObjTermsOfServiceGUI::$ctrl

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

$error

ilObjTermsOfServiceGUI::$error

protected

Definition at line 57 of file class.ilObjTermsOfServiceGUI.php.

$factory

ilObjTermsOfServiceGUI::$factory

Definition at line 47 of file class.ilObjTermsOfServiceGUI.php.

$form

ilObjTermsOfServiceGUI::$form

protected

Definition at line 22 of file class.ilObjTermsOfServiceGUI.php.

$lng

ilObjTermsOfServiceGUI::$lng

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

$log

ilObjTermsOfServiceGUI::$log

protected

Definition at line 72 of file class.ilObjTermsOfServiceGUI.php.

$object

ilObjTermsOfServiceGUI::$object

Definition at line 37 of file class.ilObjTermsOfServiceGUI.php.

$rbacsystem

ilObjTermsOfServiceGUI::$rbacsystem

protected

Definition at line 52 of file class.ilObjTermsOfServiceGUI.php.

$tabs_gui

ilObjTermsOfServiceGUI::$tabs_gui

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

$toolbar

ilObjTermsOfServiceGUI::$toolbar

protected

Definition at line 62 of file class.ilObjTermsOfServiceGUI.php.

$user

ilObjTermsOfServiceGUI::$user

protected

Definition at line 67 of file class.ilObjTermsOfServiceGUI.php.

---

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

• Services/TermsOfService/classes/class.ilObjTermsOfServiceGUI.php