Class ilAccessibilityDocumentFormGUI. More...

Inheritance diagram for ilAccessibilityDocumentFormGUI:

Collaboration diagram for ilAccessibilityDocumentFormGUI:

Public Member Functions
	__construct (ilAccessibilityDocument $document, ilHtmlPurifierInterface $documentPurifier, ilObjUser $actor, Filesystem $tmpFileSystem, FileUpload $fileUpload, string $formAction='', string $saveCommand='saveDocument', string $cancelCommand='showDocuments', bool $isEditable=false)
	ilAccessibilityDocumentFormGUI constructor. More...

	setCheckInputCalled (bool $status)

	hasTranslatedError ()

	getTranslatedError ()

	hasTranslatedInfo ()

	getTranslatedInfo ()

	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
	initForm ()

Protected Member Functions inherited from ilPropertyFormGUI
	hideRequired ($a_type)

	rebuildUploadedFiles ()
	try to rebuild files More...

Protected Attributes
	$document

	$actor

	$fileUpload

	$tmpFileSystem

	$formAction

	$saveCommand

	$cancelCommand

	$isEditable = false

	$translatedError = ''

	$translatedInfo = ''

	$documentPurifier

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 ilAccessibilityDocumentFormGUI.

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

Constructor & Destructor Documentation

◆ __construct()

ilAccessibilityDocumentFormGUI::__construct	(	ilAccessibilityDocument	$document,
		ilHtmlPurifierInterface	$documentPurifier,
		ilObjUser	$actor,
		Filesystem	$tmpFileSystem,
		FileUpload	$fileUpload,
		string	$formAction = `''`,
		string	$saveCommand = `'saveDocument'`,
		string	$cancelCommand = `'showDocuments'`,
		bool	$isEditable = `false`
	)

ilAccessibilityDocumentFormGUI constructor.

Parameters

ilAccessibilityDocument	$document
ilHtmlPurifierInterface	$documentPurifier
ilObjUser	$actor
Filesystem	$tmpFileSystem
FileUpload	$fileUpload
string	$formAction
string	$saveCommand
string	$cancelCommand
bool	$isEditable

Definition at line 60 of file class.ilAccessibilityDocumentFormGUI.php.

References $actor, $cancelCommand, $document, $documentPurifier, $fileUpload, $formAction, $isEditable, $saveCommand, $tmpFileSystem, ILIAS\GlobalScreen\Provider\__construct(), and initForm().

       {
         $this->document = $document;
         $this->documentPurifier = $documentPurifier;
         $this->actor = $actor;
         $this->tmpFileSystem = $tmpFileSystem;
         $this->fileUpload = $fileUpload;
         $this->formAction = $formAction;
         $this->saveCommand = $saveCommand;
         $this->cancelCommand = $cancelCommand;
         $this->isEditable = $isEditable;
 
         parent::__construct();
 
         $this->initForm();
     }

Here is the call graph for this function:

Member Function Documentation

◆ getTranslatedError()

ilAccessibilityDocumentFormGUI::getTranslatedError ( )

Returns: string

Definition at line 149 of file class.ilAccessibilityDocumentFormGUI.php.

References $translatedError.

                                          : string
     {
         return $this->translatedError;
     }

◆ getTranslatedInfo()

ilAccessibilityDocumentFormGUI::getTranslatedInfo ( )

Returns: string

Definition at line 165 of file class.ilAccessibilityDocumentFormGUI.php.

References $translatedInfo.

                                         : string
     {
         return $this->translatedInfo;
     }

◆ hasTranslatedError()

ilAccessibilityDocumentFormGUI::hasTranslatedError ( )

Returns: bool

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

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

◆ hasTranslatedInfo()

ilAccessibilityDocumentFormGUI::hasTranslatedInfo ( )

Returns: bool

Definition at line 157 of file class.ilAccessibilityDocumentFormGUI.php.

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

◆ initForm()

ilAccessibilityDocumentFormGUI::initForm ( )

protected

Definition at line 97 of file class.ilAccessibilityDocumentFormGUI.php.

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

Referenced by __construct().

                                   : void
     {
         if ($this->document->getId() > 0) {
             $this->setTitle($this->lng->txt('acc_form_edit_doc_head'));
         } else {
             $this->setTitle($this->lng->txt('acc_form_new_doc_head'));
         }
 
         $this->setFormAction($this->formAction);
 
         $title = new ilTextInputGUI($this->lng->txt('acc_form_document_title'), 'title');
         $title->setInfo($this->lng->txt('acc_form_document_title_info'));
         $title->setRequired(true);
         $title->setDisabled(!$this->isEditable);
         $title->setValue($this->document->getTitle());
         $title->setMaxLength(255);
         $this->addItem($title);
 
         $documentLabel = $this->lng->txt('acc_form_document');
         $documentByline = $this->lng->txt('acc_form_document_info');
         if ($this->document->getId() > 0) {
             $documentLabel = $this->lng->txt('acc_form_document_new');
             $documentByline = $this->lng->txt('acc_form_document_new_info');
         }
 
         $document = new ilFileInputGUI($documentLabel, 'document');
         $document->setInfo($documentByline);
         if (!$this->document->getId()) {
             $document->setRequired(true);
         }
         $document->setDisabled(!$this->isEditable);
         $document->setSuffixes(['html', 'txt']);
         $this->addItem($document);
 
         if ($this->isEditable) {
             $this->addCommandButton($this->saveCommand, $this->lng->txt('save'));
         }
 
         $this->addCommandButton($this->cancelCommand, $this->lng->txt('cancel'));
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ saveObject()

ilAccessibilityDocumentFormGUI::saveObject ( )

Returns: bool

Definition at line 173 of file class.ilAccessibilityDocumentFormGUI.php.

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

                                  : bool
     {
         if (!$this->fillObject()) {
             $this->setValuesByPost();
             return false;
         }
 
         $this->document->save();
 
         return true;
     }

Here is the call graph for this function:

◆ setCheckInputCalled()

ilAccessibilityDocumentFormGUI::setCheckInputCalled ( bool $status )

Parameters

bool $status

Definition at line 89 of file class.ilAccessibilityDocumentFormGUI.php.

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

Field Documentation

◆ $actor

ilAccessibilityDocumentFormGUI::$actor

protected

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

Referenced by __construct().

◆ $cancelCommand

ilAccessibilityDocumentFormGUI::$cancelCommand

protected

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

Referenced by __construct().

◆ $document

ilAccessibilityDocumentFormGUI::$document

protected

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

Referenced by __construct(), and initForm().

◆ $documentPurifier

ilAccessibilityDocumentFormGUI::$documentPurifier

protected

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

Referenced by __construct().

◆ $fileUpload

ilAccessibilityDocumentFormGUI::$fileUpload

protected

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

Referenced by __construct().

◆ $formAction

ilAccessibilityDocumentFormGUI::$formAction

protected

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

Referenced by __construct().

◆ $isEditable

ilAccessibilityDocumentFormGUI::$isEditable = false

protected

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

Referenced by __construct().

◆ $saveCommand

ilAccessibilityDocumentFormGUI::$saveCommand

protected

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

Referenced by __construct().

◆ $tmpFileSystem

ilAccessibilityDocumentFormGUI::$tmpFileSystem

protected

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

Referenced by __construct().

◆ $translatedError

ilAccessibilityDocumentFormGUI::$translatedError = ''

protected

Definition at line 40 of file class.ilAccessibilityDocumentFormGUI.php.

Referenced by getTranslatedError().

◆ $translatedInfo

ilAccessibilityDocumentFormGUI::$translatedInfo = ''

protected

Definition at line 43 of file class.ilAccessibilityDocumentFormGUI.php.

Referenced by getTranslatedInfo().

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

Services/Accessibility/classes/Document/class.ilAccessibilityDocumentFormGUI.php

Public Member Functions

Protected Member Functions

Protected Attributes

Detailed Description

Constructor & Destructor Documentation

◆ __construct()

Member Function Documentation

◆ getTranslatedError()

◆ getTranslatedInfo()

◆ hasTranslatedError()

◆ hasTranslatedInfo()

◆ initForm()

◆ saveObject()

◆ setCheckInputCalled()

Field Documentation

◆ $actor

◆ $cancelCommand

◆ $document

◆ $documentPurifier

◆ $fileUpload

◆ $formAction

◆ $isEditable

◆ $saveCommand

◆ $tmpFileSystem

◆ $translatedError

◆ $translatedInfo