Class ilTermsOfServiceCriterionFormGUI. More...

Inheritance diagram for ilTermsOfServiceCriterionFormGUI:

Collaboration diagram for ilTermsOfServiceCriterionFormGUI:

Public Member Functions
	__construct (ilTermsOfServiceDocument $document, ilTermsOfServiceDocumentCriterionAssignment $assignment, ilTermsOfServiceCriterionTypeFactoryInterface $criterionTypeFactory, ilObjUser $actor, string $formAction='', string $saveCommand='saveDocument', string $cancelCommand='showDocuments')
	ilTermsOfServiceCriterionFormGUI constructor. More...

	setCheckInputCalled (bool $status)

	hasTranslatedError ()

	getTranslatedError ()

	saveObject ()

Public Member Functions inherited from ilPropertyFormGUI
	__construct ()
	Constructor. More...

	executeCommand ()
	Execute command. More...

	setTableWidth ($a_width)
	Set table width. More...

	getTableWidth ()
	get table width More...

	setMode ($a_mode)
	Set Mode ('std', 'subform'). More...

	getMode ()
	Get Mode ('std', 'subform'). More...

	setTitle ($a_title)
	Set Title. More...

	getTitle ()
	Get Title. More...

	setTitleIcon ($a_titleicon)
	Set TitleIcon. More...

	getTitleIcon ()
	Get TitleIcon. More...

	setDescription ($a_val)
	Set description. More...

	getDescription ()
	Get description. More...

	setTopAnchor ($a_val)
	Set top anchor. More...

	getTopAnchor ()
	Get top anchor. More...

	setShowTopButtons ($a_val)
	Get show top buttons. More...

	getShowTopButtons ()
	Set show top buttons. More...

	setForceTopButtons ($a_val)
	Set force top buttons. More...

	getForceTopButtons ()
	Get force top buttons. More...

	addItem ($a_item)
	Add Item (Property, SectionHeader). More...

	removeItemByPostVar ($a_post_var, $a_remove_unused_headers=false)
	Remove Item. More...

	getItemByPostVar ($a_post_var)
	Get Item by POST variable. More...

	setItems ($a_items)
	Set Items. More...

	getItems ()
	Get Items. More...

	getInputItemsRecursive ()
	returns a flat array of all input items including the possibly existing subitems recursively More...

	setDisableStandardMessage ($a_val)
	Set disable standard message. More...

	getDisableStandardMessage ()
	Get disable standard message. More...

	getHideLabels ()
	Get a value indicating whether the labels should be hidden or not. More...

	setHideLabels ($a_value=true)
	Set a value indicating whether the labels should be hidden or not. More...

	setValuesByArray ($a_values, $a_restrict_to_value_keys=false)
	Set form values from an array. More...

	setValuesByPost ()
	Set form values from POST values. More...

	checkInput ()
	Check Post Input. More...

	getInput ($a_post_var, $ensureValidation=true)
	Returns the value of a HTTP-POST variable, identified by the passed id. More...

	addCustomProperty ( $a_title, $a_html, $a_info="", $a_alert="", $a_required=false)
	Add a custom property. More...

	addCommandButton ($a_cmd, $a_text, $a_id="")
	Add Command button. More...

	getCommandButtons ()
	Return all Command buttons. More...

	clearCommandButtons ()
	Remove all command buttons. More...

	getContent ()
	Get Content. More...

	insertItem ($item, $a_sub_item=false)

	getHTML ()

	getFileUpload ($a_field, $a_index=null, $a_sub_index=null)
	Get file upload data. More...

	hasFileUpload ($a_field, $a_index=null, $a_sub_index=null)
	Was any file uploaded? More...

	moveFileUpload ($a_target_directory, $a_field, $a_target_name=null, $a_index=null, $a_sub_index=null)
	Move upload to target directory. More...

Public Member Functions inherited from ilFormGUI
	setFormAction ($a_formaction)
	Set FormAction. More...

	getFormAction ()
	Get FormAction. More...

	setTarget ($a_target)
	Set Target. More...

	getTarget ()
	Get Target. More...

	setMultipart ($a_multipart)
	Set Enctype Multipart/Formdata true/false. More...

	getMultipart ()
	Get Enctype Multipart/Formdata true/false. More...

	setId ($a_id)
	Set Id. More...

	getId ()
	Get Id. More...

	setName ($a_name)
	Set Name. More...

	getName ()
	Get Name. More...

	setKeepOpen ($a_keepopen)
	Set Keep Form Tag Open. More...

	getKeepOpen ()
	Get Keep Form Tag Open. More...

	setOpenTag ($a_open)
	Enable/Disable Open Form Tag. More...

	getOpenTag ()
	Get Open Form Tag Enabled. More...

	setCloseTag ($a_val)
	Set close tag. More...

	getCloseTag ()
	Get close tag. More...

	setPreventDoubleSubmission ($a_val)
	Set prevent double submission. More...

	getPreventDoubleSubmission ()
	Get prevent double submission. More...

	getHTML ()
	Get HTML. More...

	getContent ()
	Get Content. More...

Protected Member Functions
	fillObject ()

Protected Member Functions inherited from ilPropertyFormGUI
	hideRequired ($a_type)

	rebuildUploadedFiles ()
	try to rebuild files More...

Protected Attributes
	$document

	$assignment

	$formAction

	$actor

	$saveCommand

	$cancelCommand

	$translatedError = ''

	$criterionTypeFactory

Protected Attributes inherited from ilPropertyFormGUI
	$lng

	$ctrl

	$tpl

	$user

	$settings

	$mode = "std"

	$check_input_called = false

	$disable_standard_message = false

	$top_anchor = "il_form_top"

	$titleicon = false

	$description = ""

	$tbl_width = false

	$show_top_buttons = true

	$hide_labels = false

	$force_top_buttons = false

Protected Attributes inherited from ilFormGUI
	$formaction

	$multipart = false

	$keepopen = false

	$opentag = true

	$id

	$name

	$prevent_double_submission = false

Detailed Description

Class ilTermsOfServiceCriterionFormGUI.

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

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

Constructor & Destructor Documentation

◆ __construct()

ilTermsOfServiceCriterionFormGUI::__construct	(	ilTermsOfServiceDocument	$document,
		ilTermsOfServiceDocumentCriterionAssignment	$assignment,
		ilTermsOfServiceCriterionTypeFactoryInterface	$criterionTypeFactory,
		ilObjUser	$actor,
		string	$formAction = `''`,
		string	$saveCommand = `'saveDocument'`,
		string	$cancelCommand = `'showDocuments'`
	)

ilTermsOfServiceCriterionFormGUI constructor.

Parameters

ilTermsOfServiceDocument	$document
ilTermsOfServiceDocumentCriterionAssignment	$assignment
ilTermsOfServiceCriterionTypeFactoryInterface	$criterionTypeFactory
ilObjUser	$actor
string	$formAction
string	$saveCommand
string	$cancelCommand

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

References $actor, $assignment, $cancelCommand, $criterionTypeFactory, $document, $formAction, $saveCommand, and ILIAS\GlobalScreen\Provider\__construct().

       {
         $this->document = $document;
         $this->assignment = $assignment;
         $this->criterionTypeFactory = $criterionTypeFactory;
         $this->actor = $actor;
         $this->formAction = $formAction;
         $this->saveCommand = $saveCommand;
         $this->cancelCommand = $cancelCommand;
 
         parent::__construct();
 
         $this->initForm();
     }

Here is the call graph for this function:

Member Function Documentation

◆ fillObject()

ilTermsOfServiceCriterionFormGUI::fillObject ( )

protected

Definition at line 177 of file class.ilTermsOfServiceCriterionFormGUI.php.

References Vendor\Package\$e, ilPropertyFormGUI\checkInput(), ilPropertyFormGUI\getInput(), and ilPropertyFormGUI\getItemByPostVar().

Referenced by saveObject().

                                     : bool
     {
         if (!$this->checkInput()) {
             return false;
         }
 
         try {
             $criterionType = $this->criterionTypeFactory->findByTypeIdent($this->getInput('criterion'));
             $criterionGui = $criterionType->ui($this->lng);
 
             $this->assignment->setCriterionId($criterionType->getTypeIdent());
             $this->assignment->setCriterionValue($criterionGui->getConfigByForm($this));
 
             if ($this->assignment->getId() > 0) {
                 $this->assignment->setLastModifiedUsrId($this->actor->getId());
             } else {
                 $this->assignment->setOwnerUsrId($this->actor->getId());
             }
         } catch (Exception $e) {
             $this->getItemByPostVar('criterion')->setAlert($e->getMessage());
             $this->translatedError = $this->lng->txt('form_input_not_valid');
             return false;
         }
 
         return true;
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getTranslatedError()

ilTermsOfServiceCriterionFormGUI::getTranslatedError ( )

Returns: string

Definition at line 132 of file class.ilTermsOfServiceCriterionFormGUI.php.

References $translatedError.

                                          : string
     {
         return $this->translatedError;
     }

◆ hasTranslatedError()

ilTermsOfServiceCriterionFormGUI::hasTranslatedError ( )

Returns: bool

Definition at line 124 of file class.ilTermsOfServiceCriterionFormGUI.php.

                                          : bool
     {
         return strlen($this->translatedError) > 0;
     }

◆ saveObject()

ilTermsOfServiceCriterionFormGUI::saveObject ( )

Returns: bool

Exceptions

ilTermsOfServiceDuplicateCriterionAssignmentException

Definition at line 141 of file class.ilTermsOfServiceCriterionFormGUI.php.

References fillObject(), ilPropertyFormGUI\getItemByPostVar(), and ilPropertyFormGUI\setValuesByPost().

                                  : bool
     {
         if (!$this->fillObject()) {
             $this->setValuesByPost();
             return false;
         }
 
         $uniqueAssignmentConstraint = new ilTermsOfServiceDocumentCriterionAssignmentConstraint(
             $this->criterionTypeFactory,
             $this->document,
             new Factory(),
             $this->lng
         );
 
         if (!$uniqueAssignmentConstraint->accepts($this->assignment)) {
             $this->getItemByPostVar('criterion')->setAlert($this->lng->txt('tos_criterion_assignment_must_be_unique_insert'));
             if ($this->assignment->getId() > 0) {
                 $this->getItemByPostVar('criterion')->setAlert($this->lng->txt('tos_criterion_assignment_must_be_unique_update'));
             }
 
             $this->translatedError = $this->lng->txt('form_input_not_valid');
             $this->setValuesByPost();
             return false;
         }
 
         if (!$this->assignment->getId()) {
             $this->document->attachCriterion($this->assignment);
         }
         $this->document->save();
 
         return true;
     }

Here is the call graph for this function:

◆ setCheckInputCalled()

ilTermsOfServiceCriterionFormGUI::setCheckInputCalled ( bool $status )

Parameters

bool $status

Definition at line 71 of file class.ilTermsOfServiceCriterionFormGUI.php.

References $document, ilPropertyFormGUI\addCommandButton(), ilPropertyFormGUI\addItem(), ilFormGUI\setFormAction(), ilFormPropertyGUI\setRequired(), and ilPropertyFormGUI\setTitle().

                                                       : void
     {
         $this->check_input_called = $status;
     }

Here is the call graph for this function:

Field Documentation

◆ $actor

ilTermsOfServiceCriterionFormGUI::$actor

protected

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

Referenced by __construct().

◆ $assignment

ilTermsOfServiceCriterionFormGUI::$assignment

protected

Definition at line 16 of file class.ilTermsOfServiceCriterionFormGUI.php.

Referenced by __construct().

◆ $cancelCommand

ilTermsOfServiceCriterionFormGUI::$cancelCommand

protected

Definition at line 28 of file class.ilTermsOfServiceCriterionFormGUI.php.

Referenced by __construct().

◆ $criterionTypeFactory

ilTermsOfServiceCriterionFormGUI::$criterionTypeFactory

protected

Definition at line 34 of file class.ilTermsOfServiceCriterionFormGUI.php.

Referenced by __construct().

◆ $document

ilTermsOfServiceCriterionFormGUI::$document

protected

Definition at line 13 of file class.ilTermsOfServiceCriterionFormGUI.php.

Referenced by __construct(), and setCheckInputCalled().

◆ $formAction

ilTermsOfServiceCriterionFormGUI::$formAction

protected

Definition at line 19 of file class.ilTermsOfServiceCriterionFormGUI.php.

Referenced by __construct().

◆ $saveCommand

ilTermsOfServiceCriterionFormGUI::$saveCommand

protected

Definition at line 25 of file class.ilTermsOfServiceCriterionFormGUI.php.

Referenced by __construct().

◆ $translatedError

ilTermsOfServiceCriterionFormGUI::$translatedError = ''

protected

Definition at line 31 of file class.ilTermsOfServiceCriterionFormGUI.php.

Referenced by getTranslatedError().

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

Services/TermsOfService/classes/Criteria/class.ilTermsOfServiceCriterionFormGUI.php

Public Member Functions

Protected Member Functions

Protected Attributes

Detailed Description

Constructor & Destructor Documentation

◆ __construct()

Member Function Documentation

◆ fillObject()

◆ getTranslatedError()

◆ hasTranslatedError()

◆ saveObject()

◆ setCheckInputCalled()

Field Documentation

◆ $actor

◆ $assignment

◆ $cancelCommand

◆ $criterionTypeFactory

◆ $document

◆ $formAction

◆ $saveCommand

◆ $translatedError