Inheritance diagram for arEditGUI:

Collaboration diagram for arEditGUI:

Public Member Functions
	__construct (arGUI $parent_gui, ActiveRecord $ar)

	setArFieldsAfterSubmit ()

	setFields (arEditFields $fields)
	Setters and Getters *********************. More...

	getFields ()

	getFieldsAsArray ()

	getField ($field_name)

	addEditField (arEditField $field)

	setFormName ($form_name)

	getFormName ()

	setFormPrefix ($form_prefix)

	getFormPrefix ()

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

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

	removeItemByPostVar ($a_post_var)
	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 ()
	Get HTML. More...

	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
	init ()
	Form Initialization **********************. More...

	initFields ()

	customizeFields ()

	initForm ()

	beforeInitForm ()

	initFormAction ()

	initFormTitle ()

	addFormField (arEditField $field)

	addBooleanInputField (arEditField $field)

	addTextInputField (arEditField $field)

	addNumbericInputField (arEditField $field)

	addDateTimeInputField (arEditField $field)

	addClobInputField (arEditField $field)

	initCommandButtons ()

	afterInitForm ()

	beforeFillForm ()

	afterFillForm ()

	fillCustomFormField (arEditField $field)

	beforeSave ()

	afterSave ()

	afterValidation ()

	setNumericRecordField (arEditField $field)

	setTextRecordField (arEditField $field)

	setDateTimeRecordField (arEditField $field)

	setCustomRecordField (arEditField $field)

	handleEmptyPostValue (arEditField $field)

	txt ($txt, $plugin_txt=true)

Protected Member Functions inherited from ilPropertyFormGUI
	hideRequired ($a_type)

	rebuildUploadedFiles ()
	try to rebuild files More...

Protected Attributes
	$ar

	$parent_gui

	$ctrl

	$form_name = ""

	$form_prefix = ""

	$fields

Protected Attributes inherited from ilPropertyFormGUI
	$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

Protected Attributes inherited from ilFormGUI
	$formaction

	$multipart = false

	$keepopen = false

	$opentag = true

	$id

	$name

	$prevent_double_submission = false

Detailed Description

GUI-Class arEditGUI.

Author: Timon Amstutz timon.nosp@m..ams.nosp@m.tutz@.nosp@m.ilub.nosp@m..unib.nosp@m.e.ch

Version: 2.0.7

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

Constructor & Destructor Documentation

◆ __construct()

arEditGUI::__construct	(	arGUI	$parent_gui,
		ActiveRecord	$ar
	)

Parameters

arGUI	$parent_gui
ActiveRecord	$ar

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

                                                                         {
                global $ilCtrl;
 
                $this->ar = $ar;
                $this->parent_gui = $parent_gui;
                $this->ctrl = $ilCtrl;
                $this->ctrl->saveParameter($parent_gui, 'ar_id');
                $this->setFormName(get_class($ar));
                $this->init();
        }

References $ar, $ilCtrl, $parent_gui, init(), and setFormName().

Here is the call graph for this function:

Member Function Documentation

◆ addBooleanInputField()

arEditGUI::addBooleanInputField ( arEditField $field )

protected

Parameters

arEditField $field

Returns: ilTextInputGUI

Definition at line 167 of file class.arEditGUI.php.

                                                                    {
                return new ilCheckboxInputGUI($this->txt($field->getTxt()), $field->getName());
        }

References arField\getName(), arViewField\getTxt(), and txt().

Here is the call graph for this function:

◆ addClobInputField()

arEditGUI::addClobInputField ( arEditField $field )

protected

Parameters

arEditField $field

Returns: ilTextAreaInputGUI

Definition at line 211 of file class.arEditGUI.php.

                                                                 {
                return new ilTextAreaInputGUI($this->txt($field->getTxt()), $field->getName());
        }

References arField\getName(), arViewField\getTxt(), and txt().

Referenced by addFormField().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ addDateTimeInputField()

arEditGUI::addDateTimeInputField ( arEditField $field )

protected

Parameters

arEditField $field

Returns: ilDateTimeInputGUI

Definition at line 197 of file class.arEditGUI.php.

                                                                     {
                $date_input = new ilDateTimeInputGUI($this->txt($field->getTxt()), $field->getName());
                $date_input->setDate(new ilDate(date('Y-m-d H:i:s'), IL_CAL_DATE));
                $date_input->setShowTime(true);
 
                return $date_input;
        }

References date, arField\getName(), arViewField\getTxt(), IL_CAL_DATE, and txt().

Referenced by addFormField().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ addEditField()

arEditGUI::addEditField ( arEditField $field )

Parameters

arEditField

Definition at line 533 of file class.arEditGUI.php.

                                                         {
                $this->getFields()->addField($field);
        }

References getFields().

Here is the call graph for this function:

◆ addFormField()

arEditGUI::addFormField ( arEditField $field )

protected

Parameters

arEditField $field

Definition at line 127 of file class.arEditGUI.php.

                                                            {
                $field_element = NULL;
                if (!$field->getFormElement()) {
                        switch ($field->getFieldType()) {
                                case 'integer':
                                case 'float':
                                        $field->setFormElement($this->addNumbericInputField($field));
                                        break;
                                        break;
                                case 'date':
                                case 'time':
                                case 'timestamp':
                                        $field->setFormElement($this->addDateTimeInputField($field));
                                        break;
                                case 'clob':
                                        $field->setFormElement($this->addClobInputField($field));
                                        break;
                                default:
                                        $field->setFormElement($this->addTextInputField($field));
                        }
                        if ($field->getNotNull()) {
                                $field->getFormElement()->setRequired(true);
                        }
                }
 
                if ($field->getFormElement()) {
                        if ($field->getSubelementOf()) {
                                $field->getSubelementOf()->addSubItem($field->getFormElement());
                        } else {
                                $this->addItem($field->getFormElement());
                        }
                }
        }

References addClobInputField(), addDateTimeInputField(), ilPropertyFormGUI\addItem(), addNumbericInputField(), addTextInputField(), arField\getFieldType(), arEditField\getFormElement(), arField\getNotNull(), arEditField\getSubelementOf(), and arEditField\setFormElement().

Here is the call graph for this function:

◆ addNumbericInputField()

arEditGUI::addNumbericInputField ( arEditField $field )

protected

Parameters

arEditField $field

Returns: ilNumberInputGUI

Definition at line 187 of file class.arEditGUI.php.

                                                                     {
                return new ilNumberInputGUI($this->txt($field->getTxt()), $field->getName());
        }

References arField\getName(), arViewField\getTxt(), and txt().

Referenced by addFormField().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ addTextInputField()

arEditGUI::addTextInputField ( arEditField $field )

protected

Parameters

arEditField $field

Returns: ilTextInputGUI

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

                                                                 {
                return new ilTextInputGUI($this->txt($field->getTxt()), $field->getName());
        }

References arField\getName(), arViewField\getTxt(), and txt().

Referenced by addFormField().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ afterFillForm()

arEditGUI::afterFillForm ( )

protected

Definition at line 255 of file class.arEditGUI.php.

255 {

256 }

◆ afterInitForm()

arEditGUI::afterInitForm ( )

protected

Definition at line 226 of file class.arEditGUI.php.

226 {

227 }

Referenced by initForm().

Here is the caller graph for this function:

◆ afterSave()

arEditGUI::afterSave ( )

protected

Returns: bool

Definition at line 358 of file class.arEditGUI.php.

                                       {
                return true;
        }

◆ afterValidation()

arEditGUI::afterValidation ( )

protected

Definition at line 384 of file class.arEditGUI.php.

                                             {
                return true;
        }

Referenced by setArFieldsAfterSubmit().

Here is the caller graph for this function:

◆ beforeFillForm()

arEditGUI::beforeFillForm ( )

protected

Definition at line 251 of file class.arEditGUI.php.

251 {

252 }

◆ beforeInitForm()

arEditGUI::beforeInitForm ( )

protected

Definition at line 92 of file class.arEditGUI.php.

92 {

93 }

◆ beforeSave()

arEditGUI::beforeSave ( )

protected

Definition at line 350 of file class.arEditGUI.php.

                                        {
                return true;
        }

◆ customizeFields()

arEditGUI::customizeFields ( )

protected

Definition at line 78 of file class.arEditGUI.php.

78 {

79 }

Referenced by initFields().

Here is the caller graph for this function:

◆ fillCustomFormField()

arEditGUI::fillCustomFormField ( arEditField $field )

protected

Parameters

arEditField $field

Definition at line 294 of file class.arEditGUI.php.

294 {

295 }

◆ getField()

arEditGUI::getField ( $field_name )

Parameters

$field_name

Returns: arEditField

Definition at line 525 of file class.arEditGUI.php.

                                              {
                return $this->getFields()->getField($field_name);
        }

References getFields().

Here is the call graph for this function:

◆ getFields()

arEditGUI::getFields ( )

Returns: arEditFields

Definition at line 507 of file class.arEditGUI.php.

                                    {
                return $this->fields;
        }

References $fields.

Referenced by addEditField(), getField(), and getFieldsAsArray().

Here is the caller graph for this function:

◆ getFieldsAsArray()

arEditGUI::getFieldsAsArray ( )

Returns: arEditField []

Definition at line 515 of file class.arEditGUI.php.

                                           {
                return $this->getFields()->getFields();
        }

References getFields().

Here is the call graph for this function:

◆ getFormName()

arEditGUI::getFormName ( )

Returns: string

Definition at line 560 of file class.arEditGUI.php.

                                      {
                return $this->form_name;
        }

References $form_name.

Referenced by initFormTitle().

Here is the caller graph for this function:

◆ getFormPrefix()

arEditGUI::getFormPrefix ( )

Returns: string

Definition at line 576 of file class.arEditGUI.php.

                                        {
                return $this->form_prefix;
        }

References $form_prefix.

Referenced by initFormTitle().

Here is the caller graph for this function:

◆ handleEmptyPostValue()

arEditGUI::handleEmptyPostValue ( arEditField $field )

protected

Parameters

arEditField $field

Returns: bool

Definition at line 487 of file class.arEditGUI.php.

                                                                    {
                return true;
        }

◆ init()

arEditGUI::init ( )

protected

Form Initialization **********************.

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

                                  {
                $this->initFields();
                $this->initForm();
                if ($this->ar->getPrimaryFieldValue() != 0) {
                        $this->fillForm();
                }
        }

References initFields(), and initForm().

Referenced by __construct().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ initCommandButtons()

arEditGUI::initCommandButtons ( )

protected

Definition at line 216 of file class.arEditGUI.php.

                                                {
                if ($this->ar->getPrimaryFieldValue() == 0) {
                        $this->addCommandButton('create', $this->txt('create', false));
                } else {
                        $this->addCommandButton('update', $this->txt('save', false));
                }
                $this->addCommandButton('index', $this->txt('cancel', false));
        }

References ilPropertyFormGUI\addCommandButton(), and txt().

Referenced by initForm().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ initFields()

arEditGUI::initFields ( )

protected

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

                                        {
                $this->fields = new arEditFields($this->ar);
                $this->customizeFields();
                $this->fields->sortFields();
        }

References customizeFields(), and fields.

Referenced by init().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ initForm()

arEditGUI::initForm ( )

protected

Definition at line 82 of file class.arEditGUI.php.

                                      {
                $this->BeforeInitForm();
                $this->initFormAction();
                $this->initFormTitle();
                $this->generateFormFields();
                $this->initCommandButtons();
                $this->afterInitForm();
        }

References afterInitForm(), initCommandButtons(), initFormAction(), and initFormTitle().

Referenced by init().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ initFormAction()

arEditGUI::initFormAction ( )

protected

Definition at line 96 of file class.arEditGUI.php.

                                            {
                $this->setFormAction($this->ctrl->getFormAction($this->parent_gui, "index"));
        }

References ilFormGUI\setFormAction().

Referenced by initForm().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ initFormTitle()

arEditGUI::initFormTitle ( )

protected

Definition at line 101 of file class.arEditGUI.php.

                                           {
                $this->setFormPrefix("");
                if ($this->ar->getPrimaryFieldValue() == 0) {
                        $this->setTitle($this->txt($this->getFormPrefix() . 'create_' . $this->getFormName()));
                } else {
                        $this->setTitle($this->txt($this->getFormPrefix() . 'edit_' . $this->getFormName()));
                }
        }

References getFormName(), getFormPrefix(), setFormPrefix(), ilPropertyFormGUI\setTitle(), and txt().

Referenced by initForm().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ setArFieldsAfterSubmit()

arEditGUI::setArFieldsAfterSubmit ( )

Returns: bool

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

                                                 {
                if (!$this->checkInput()) {
                        return false;
                }
                if (!$this->afterValidation()) {
                        return false;
                }
 
                foreach ($this->fields->getFields() as $field) {
                        if (!$this->setArFieldAfterSubmit($field)) {
                                return false;
                        }
                }
 
                return true;
        }

References afterValidation(), ilPropertyFormGUI\checkInput(), and fields.

Here is the call graph for this function:

◆ setCustomRecordField()

arEditGUI::setCustomRecordField ( arEditField $field )

protected

Parameters

arEditField $field

Returns: bool

Definition at line 477 of file class.arEditGUI.php.

                                                                    {
                return true;
        }

◆ setDateTimeRecordField()

arEditGUI::setDateTimeRecordField ( arEditField $field )

protected

Parameters

arEditField $field

Returns: bool

Definition at line 458 of file class.arEditGUI.php.

                                                                      {
                $set_function = $field->getSetFunctionName();
                $value = $this->getInput($field->getName());
                if ($value['time']) {
                        $datetime = new ilDateTime($value['date'] . " " . $value['time'], IL_CAL_DATETIME);
                } else {
                        $datetime = new ilDateTime($value['date'], IL_CAL_DATETIME);
                }
                $this->ar->$set_function($datetime);
 
                return true;
        }

References ilPropertyFormGUI\getInput(), arField\getName(), arViewField\getSetFunctionName(), and IL_CAL_DATETIME.

Here is the call graph for this function:

◆ setFields()

arEditGUI::setFields ( arEditFields $fields )

Setters and Getters *********************.

Parameters

arEditFields $fields

Definition at line 499 of file class.arEditGUI.php.

                                                 {
                $this->fields = $fields;
        }

References $fields, and fields.

◆ setFormName()

arEditGUI::setFormName ( $form_name )

Parameters

string $form_name

Definition at line 552 of file class.arEditGUI.php.

                                                {
                $this->form_name = $form_name;
        }

References $form_name.

Referenced by __construct().

Here is the caller graph for this function:

◆ setFormPrefix()

arEditGUI::setFormPrefix ( $form_prefix )

Parameters

string $form_prefix

Definition at line 568 of file class.arEditGUI.php.

                                                    {
                $this->form_prefix = $form_prefix;
        }

References $form_prefix.

Referenced by initFormTitle().

Here is the caller graph for this function:

◆ setNumericRecordField()

arEditGUI::setNumericRecordField ( arEditField $field )

protected

Parameters

arEditField $field

Returns: bool

Definition at line 432 of file class.arEditGUI.php.

                                                                     {
                $set_function = $field->getSetFunctionName();
                $this->ar->$set_function($this->getInput($field->getName()));
 
                return true;
        }

References ilPropertyFormGUI\getInput(), arField\getName(), and arViewField\getSetFunctionName().

Here is the call graph for this function:

◆ setTextRecordField()

arEditGUI::setTextRecordField ( arEditField $field )

protected

Parameters

arEditField $field

Returns: bool

Definition at line 445 of file class.arEditGUI.php.

                                                                  {
                $set_function = $field->getSetFunctionName();
                $this->ar->$set_function($this->getInput($field->getName()));
 
                return true;
        }

References ilPropertyFormGUI\getInput(), arField\getName(), and arViewField\getSetFunctionName().

Here is the call graph for this function:

◆ txt()

arEditGUI::txt	(	$txt,
		$plugin_txt = `true`
	)

protected

Parameters

	$txt
bool	$plugin_txt

Returns: string

Definition at line 544 of file class.arEditGUI.php.

                                                         {
                return $this->parent_gui->txt($txt, $plugin_txt);
        }

References $txt.

Referenced by addBooleanInputField(), addClobInputField(), addDateTimeInputField(), addNumbericInputField(), addTextInputField(), initCommandButtons(), and initFormTitle().

Here is the caller graph for this function:

Field Documentation

◆ $ar

arEditGUI::$ar

protected

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

Referenced by __construct().

◆ $ctrl

arEditGUI::$ctrl

protected

Definition at line 26 of file class.arEditGUI.php.

◆ $fields

arEditGUI::$fields

protected

Definition at line 38 of file class.arEditGUI.php.

Referenced by getFields(), and setFields().

◆ $form_name

arEditGUI::$form_name = ""

protected

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

Referenced by getFormName(), and setFormName().

◆ $form_prefix

arEditGUI::$form_prefix = ""

protected

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

Referenced by getFormPrefix(), and setFormPrefix().

◆ $parent_gui

arEditGUI::$parent_gui

protected

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

Referenced by __construct().

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

Services/ActiveRecord/Views/Edit/class.arEditGUI.php

Public Member Functions

Protected Member Functions

Protected Attributes

Detailed Description

Constructor & Destructor Documentation

◆ __construct()

Member Function Documentation

◆ addBooleanInputField()

◆ addClobInputField()

◆ addDateTimeInputField()

◆ addEditField()

◆ addFormField()

◆ addNumbericInputField()

◆ addTextInputField()

◆ afterFillForm()

◆ afterInitForm()

◆ afterSave()

◆ afterValidation()

◆ beforeFillForm()

◆ beforeInitForm()

◆ beforeSave()

◆ customizeFields()

◆ fillCustomFormField()

◆ getField()

◆ getFields()

◆ getFieldsAsArray()

◆ getFormName()

◆ getFormPrefix()

◆ handleEmptyPostValue()

◆ init()

◆ initCommandButtons()

◆ initFields()

◆ initForm()

◆ initFormAction()

◆ initFormTitle()

◆ setArFieldsAfterSubmit()

◆ setCustomRecordField()

◆ setDateTimeRecordField()

◆ setFields()

◆ setFormName()

◆ setFormPrefix()

◆ setNumericRecordField()

◆ setTextRecordField()

◆ txt()

Field Documentation

◆ $ar

◆ $ctrl

◆ $fields

◆ $form_name

◆ $form_prefix

◆ $parent_gui