ilADTFormBridge Class Reference

ADT form bridge base class. More...

Inheritance diagram for ilADTFormBridge:

Collaboration diagram for ilADTFormBridge:

Public Member Functions
	__construct (ilADT $a_adt)
	Constructor. More...
	getADT ()
	Get ADT. More...
	setForm (ilPropertyFormGUI $a_form)
	Set form. More...
	getForm ()
	Get form. More...
	setElementId ($a_value)
	Set element id (aka form field) More...
	getElementId ()
	Get element id. More...
	setTitle ($a_value)
	Set title (aka form field caption) More...
	getTitle ()
	Get title. More...
	setInfo ($a_value)
	Set info (aka form field info text) More...
	getInfo ()
	Get info. More...
	setParentElement ($a_value)
	Set parent element. More...
	getParentElement ()
	Get parent element. More...
	setDisabled ($a_value)
	Set disabled. More...
	isDisabled ()
	Get disabled. More...
	setRequired ($a_value)
	Set required. More...
	isRequired ()
	Get required. More...
	addToForm ()
	Add ADT-specific fields to form. More...
	addJS (ilGlobalTemplate $a_tpl)
	Add ADT-specific JS-files to template. More...
	shouldBeImportedFromPost (ilADTFormBridge $a_parent_adt=null)
	Check if incoming values should be imported at all. More...
	importFromPost ()
	Import values from form request POST data. More...
	validate ()
	Validate ADT and parse error codes. More...
	setExternalErrors ($a_errors)

Protected Member Functions
	isValidADT (ilADT $a_adt)
	Check if given ADT is valid. More...
	setADT (ilADT $a_adt)
	Set ADT. More...
	addBasicFieldProperties (ilFormPropertyGUI $a_field, ilADTDefinition $a_def)
	Helper method to handle generic properties like setRequired(), setInfo() More...
	findParentElementInForm ()
	Try to find parent element in form (could be option) More...
	addToParentElement (ilFormPropertyGUI $a_field)
	Add form field to parent element. More...
	isActiveForSubItems ($a_parent_option=null)
	Check if element is currently active for subitem(s) More...

Protected Attributes
	$adt
	$form
	$id
	$title
	$info
	$parent_element
	$required
	$disabled

Detailed Description

ADT form bridge base class.

Author

Jörg Lützenkirchen luetz.nosp@m.enki.nosp@m.rchen.nosp@m.@lei.nosp@m.fos.c.nosp@m.om

Version

$Id$

Definition at line 11 of file class.ilADTFormBridge.php.

Constructor & Destructor Documentation

__construct()

ilADTFormBridge::__construct

(

ilADT

$a_adt

)

Constructor.

Parameters

ilADT

$a_adt

Returns

self

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

References isValidADT(), and setADT().

    {
        $this->setADT($a_adt);
    }

Here is the call graph for this function:

Member Function Documentation

addBasicFieldProperties()

ilADTFormBridge::addBasicFieldProperties ( ilFormPropertyGUI  $a_field, ilADTDefinition  $a_def  )

protected

Helper method to handle generic properties like setRequired(), setInfo()

Parameters

ilFormPropertyGUI	$a_field
ilADTDefinition	$a_def

Definition at line 227 of file class.ilADTFormBridge.php.

References $info, getInfo(), isDisabled(), isRequired(), ilFormPropertyGUI\setDisabled(), ilFormPropertyGUI\setInfo(), and ilFormPropertyGUI\setRequired().

Referenced by ilADTTextFormBridge\addElementToForm(), ilADTLocationFormBridge\addToForm(), ilADTMultiTextFormBridge\addToForm(), ilADTBooleanFormBridge\addToForm(), ilADTFloatFormBridge\addToForm(), ilADTIntegerFormBridge\addToForm(), ilADTDateFormBridge\addToForm(), ilADTDateTimeFormBridge\addToForm(), ilADTMultiEnumFormBridge\addToForm(), ilADTInternalLinkFormBridge\addToForm(), ilADTExternalLinkFormBridge\addToForm(), and ilADTEnumFormBridge\addToForm().

    {
        if ((bool) $this->isDisabled()) {
            $a_field->setDisabled(true);
        } elseif ($this->isRequired()) {
            $a_field->setRequired(true);
        }
        
        $info = $this->getInfo();
        if ($info) {
            $a_field->setInfo($info);
        }
    }

Here is the call graph for this function:

Here is the caller graph for this function:

addJS()

ilADTFormBridge::addJS

(

ilGlobalTemplate

$a_tpl

)

Add ADT-specific JS-files to template.

Parameters

ilGlobalTemplate

$a_tpl

Definition at line 301 of file class.ilADTFormBridge.php.

    {
    }

addToForm()

ilADTFormBridge::addToForm ( )

abstract

Add ADT-specific fields to form.

Referenced by addToParentElement().

Here is the caller graph for this function:

addToParentElement()

ilADTFormBridge::addToParentElement ( ilFormPropertyGUI  $a_field )

protected

Add form field to parent element.

Parameters

ilFormPropertyGUI

$a_field

Definition at line 281 of file class.ilADTFormBridge.php.

References addToForm(), findParentElementInForm(), and getForm().

Referenced by ilADTTextFormBridge\addElementToForm(), ilADTLocationFormBridge\addToForm(), ilADTMultiTextFormBridge\addToForm(), ilADTBooleanFormBridge\addToForm(), ilADTFloatFormBridge\addToForm(), ilADTIntegerFormBridge\addToForm(), ilADTDateFormBridge\addToForm(), ilADTDateTimeFormBridge\addToForm(), ilADTMultiEnumFormBridge\addToForm(), ilADTInternalLinkFormBridge\addToForm(), ilADTExternalLinkFormBridge\addToForm(), and ilADTEnumFormBridge\addToForm().

    {
        $field = $this->findParentElementInForm();
        if ($field) {
            $field->addSubItem($a_field);
        } elseif ($this->getForm() instanceof ilPropertyFormGUI) {
            $this->getForm()->addItem($a_field);
        }
    }

Here is the call graph for this function:

Here is the caller graph for this function:

findParentElementInForm()

ilADTFormBridge::findParentElementInForm ( )

protected

Try to find parent element in form (could be option)

Returns

ilFormPropertyGUI

Definition at line 246 of file class.ilADTFormBridge.php.

References getForm(), and getParentElement().

Referenced by addToParentElement().

    {
        $parent_def = $this->getParentElement();
        if ($parent_def) {
            if (is_array($parent_def)) {
                $parent_option = $parent_def[1];
                $parent_def = $parent_def[0];
            }

            // :TODO: throw exception on invalid definition ?!

            $parent_field = $this->getForm()->getItemByPostVar($parent_def);
            if ($parent_field instanceof ilSubEnabledFormPropertyGUI) {
                // radio/checkbox group
                if ($parent_option && method_exists($parent_field, "getOptions")) {
                    foreach ($parent_field->getOptions() as $option) {
                        if ($option->getValue() == $parent_option) {
                            $parent_field = $option;
                            break;
                        }
                    }
                }
            }
            
            if ($parent_field) {
                return $parent_field;
            }
        }
    }

Here is the call graph for this function:

Here is the caller graph for this function:

getADT()

ilADTFormBridge::getADT

(

)

Get ADT.

Returns

ilADT

Definition at line 68 of file class.ilADTFormBridge.php.

References $adt.

Referenced by ilADTTextFormBridge\addElementToForm(), ilADTBooleanFormBridge\addToForm(), ilADTIntegerFormBridge\addToForm(), ilADTFloatFormBridge\addToForm(), ilADTLocationFormBridge\addToForm(), ilADTMultiTextFormBridge\addToForm(), ilADTDateFormBridge\addToForm(), ilADTDateTimeFormBridge\addToForm(), ilADTLocalizedTextFormBridge\addToForm(), ilADTMultiEnumFormBridge\addToForm(), ilADTInternalLinkFormBridge\addToForm(), ilADTExternalLinkFormBridge\addToForm(), ilADTEnumFormBridge\addToForm(), ilADTTextFormBridge\addToForm(), ilADTMultiTextFormBridge\importFromPost(), ilADTBooleanFormBridge\importFromPost(), ilADTDateFormBridge\importFromPost(), ilADTDateTimeFormBridge\importFromPost(), ilADTIntegerFormBridge\importFromPost(), ilADTFloatFormBridge\importFromPost(), ilADTInternalLinkFormBridge\importFromPost(), ilADTExternalLinkFormBridge\importFromPost(), ilADTMultiEnumFormBridge\importFromPost(), ilADTLocalizedTextFormBridge\importFromPost(), ilADTLocationFormBridge\importFromPost(), ilADTEnumFormBridge\importFromPost(), ilADTTextFormBridge\importFromPost(), ilADTBooleanFormBridge\isActiveForSubItems(), ilADTMultiEnumFormBridge\isActiveForSubItems(), ilADTEnumFormBridge\isActiveForSubItems(), isActiveForSubItems(), ilADTGroupFormBridge\prepareElements(), ilADTGroupFormBridge\validate(), and validate().

    {
        return $this->adt;
    }

Here is the caller graph for this function:

getElementId()

ilADTFormBridge::getElementId

(

)

Get element id.

Returns

string

Definition at line 108 of file class.ilADTFormBridge.php.

References $id.

Referenced by ilADTDateFormBridge\addToElementId(), ilADTBooleanFormBridge\addToForm(), ilADTIntegerFormBridge\addToForm(), ilADTLocationFormBridge\addToForm(), ilADTFloatFormBridge\addToForm(), ilADTMultiTextFormBridge\addToForm(), ilADTDateFormBridge\addToForm(), ilADTDateTimeFormBridge\addToForm(), ilADTLocalizedTextFormBridge\addToForm(), ilADTMultiEnumFormBridge\addToForm(), ilADTInternalLinkFormBridge\addToForm(), ilADTExternalLinkFormBridge\addToForm(), ilADTEnumFormBridge\addToForm(), ilADTTextFormBridge\addToForm(), ilADTMultiTextFormBridge\importFromPost(), ilADTBooleanFormBridge\importFromPost(), ilADTDateFormBridge\importFromPost(), ilADTDateTimeFormBridge\importFromPost(), ilADTIntegerFormBridge\importFromPost(), ilADTFloatFormBridge\importFromPost(), ilADTInternalLinkFormBridge\importFromPost(), ilADTExternalLinkFormBridge\importFromPost(), ilADTLocalizedTextFormBridge\importFromPost(), ilADTMultiEnumFormBridge\importFromPost(), ilADTLocationFormBridge\importFromPost(), ilADTEnumFormBridge\importFromPost(), ilADTTextFormBridge\importFromPost(), setExternalErrors(), and validate().

    {
        return $this->id;
    }

Here is the caller graph for this function:

getForm()

ilADTFormBridge::getForm

(

)

Get form.

Returns

ilPropertyFormGUI

Definition at line 88 of file class.ilADTFormBridge.php.

References $form.

Referenced by ilADTGroupFormBridge\addToForm(), addToParentElement(), findParentElementInForm(), ilADTMultiTextFormBridge\importFromPost(), ilADTBooleanFormBridge\importFromPost(), ilADTDateFormBridge\importFromPost(), ilADTDateTimeFormBridge\importFromPost(), ilADTIntegerFormBridge\importFromPost(), ilADTFloatFormBridge\importFromPost(), ilADTInternalLinkFormBridge\importFromPost(), ilADTExternalLinkFormBridge\importFromPost(), ilADTLocalizedTextFormBridge\importFromPost(), ilADTMultiEnumFormBridge\importFromPost(), ilADTLocationFormBridge\importFromPost(), ilADTEnumFormBridge\importFromPost(), ilADTTextFormBridge\importFromPost(), ilADTGroupFormBridge\prepareElements(), ilADTTestGUI\prepareFormElements(), setExternalErrors(), ilADTGroupFormBridge\validate(), and validate().

    {
        return $this->form;
    }

Here is the caller graph for this function:

getInfo()

ilADTFormBridge::getInfo

(

)

Get info.

Returns

string

Definition at line 148 of file class.ilADTFormBridge.php.

References $info.

Referenced by addBasicFieldProperties(), and ilADTGroupFormBridge\addToForm().

    {
        return $this->info;
    }

Here is the caller graph for this function:

getParentElement()

ilADTFormBridge::getParentElement

(

)

Get parent element.

Returns

string

Definition at line 171 of file class.ilADTFormBridge.php.

Referenced by findParentElementInForm(), and shouldBeImportedFromPost().

    {
        return $this->parent;
    }

Here is the caller graph for this function:

getTitle()

ilADTFormBridge::getTitle

(

)

Get title.

Returns

string

Definition at line 128 of file class.ilADTFormBridge.php.

References $title.

Referenced by ilADTBooleanFormBridge\addToForm(), ilADTIntegerFormBridge\addToForm(), ilADTFloatFormBridge\addToForm(), ilADTLocationFormBridge\addToForm(), ilADTMultiTextFormBridge\addToForm(), ilADTDateFormBridge\addToForm(), ilADTDateTimeFormBridge\addToForm(), ilADTLocalizedTextFormBridge\addToForm(), ilADTMultiEnumFormBridge\addToForm(), ilADTExternalLinkFormBridge\addToForm(), ilADTInternalLinkFormBridge\addToForm(), ilADTEnumFormBridge\addToForm(), ilADTGroupFormBridge\addToForm(), ilADTTextFormBridge\addToForm(), and ilADTExternalLinkFormBridge\importFromPost().

    {
        return $this->title;
    }

Here is the caller graph for this function:

importFromPost()

ilADTFormBridge::importFromPost ( )

abstract

Import values from form request POST data.

Referenced by shouldBeImportedFromPost().

Here is the caller graph for this function:

isActiveForSubItems()

ilADTFormBridge::isActiveForSubItems (   $a_parent_option = null )

protected

Check if element is currently active for subitem(s)

Parameters

mixed

$a_parent_option

Returns

bool

Definition at line 311 of file class.ilADTFormBridge.php.

References getADT().

    {
        return !$this->getADT()->isNull();
    }

Here is the call graph for this function:

isDisabled()

ilADTFormBridge::isDisabled

(

)

Get disabled.

Returns

bool

Definition at line 191 of file class.ilADTFormBridge.php.

References $disabled.

Referenced by addBasicFieldProperties(), and shouldBeImportedFromPost().

    {
        return $this->disabled;
    }

Here is the caller graph for this function:

isRequired()

ilADTFormBridge::isRequired

(

)

Get required.

Returns

required

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

References $required.

Referenced by addBasicFieldProperties(), ilADTLocationFormBridge\addToForm(), ilADTEnumFormBridge\addToForm(), ilADTLocationFormBridge\importFromPost(), and validate().

    {
        return $this->required;
    }

Here is the caller graph for this function:

isValidADT()

ilADTFormBridge::isValidADT ( ilADT  $a_adt )

abstractprotected

Check if given ADT is valid.

:TODO: This could be avoided with type-specifc constructors :TODO: bridge base class?

Parameters

ilADT

$a_adt

Referenced by __construct(), and setADT().

Here is the caller graph for this function:

setADT()

ilADTFormBridge::setADT ( ilADT  $a_adt )

protected

Set ADT.

Exceptions

Exception

Parameters

ilADT

$a_adt

Definition at line 54 of file class.ilADTFormBridge.php.

References isValidADT().

Referenced by __construct().

    {
        if (!$this->isValidADT($a_adt)) {
            throw new Exception('ADTFormBridge Type mismatch.');
        }
        
        $this->adt = $a_adt;
    }

Here is the call graph for this function:

Here is the caller graph for this function:

setDisabled()

ilADTFormBridge::setDisabled

(

$a_value

)

Set disabled.

Parameters

bool

$a_value

Definition at line 181 of file class.ilADTFormBridge.php.

References disabled().

    {
        $this->disabled = (bool) $a_value;
    }

Here is the call graph for this function:

setElementId()

ilADTFormBridge::setElementId

(

$a_value

)

Set element id (aka form field)

Parameters

string

$a_value

Definition at line 98 of file class.ilADTFormBridge.php.

    {
        $this->id = (string) $a_value;
    }

setExternalErrors()

ilADTFormBridge::setExternalErrors

(

$a_errors

)

Definition at line 381 of file class.ilADTFormBridge.php.

References getElementId(), and getForm().

    {
        $field = $this->getForm()->getItemByPostvar($this->getElementId());
        $field->setAlert(implode("<br />", $a_errors));
    }

Here is the call graph for this function:

setForm()

ilADTFormBridge::setForm

(

ilPropertyFormGUI

$a_form

)

Set form.

Parameters

ilPropertyFormGUI

$a_form

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

    {
        $this->form = $a_form;
    }

setInfo()

ilADTFormBridge::setInfo

(

$a_value

)

Set info (aka form field info text)

Parameters

string

$a_value

Definition at line 138 of file class.ilADTFormBridge.php.

References info().

Referenced by ilADTTestGUI\prepareFormElements().

    {
        $this->info = trim($a_value);
    }

Here is the call graph for this function:

Here is the caller graph for this function:

setParentElement()

ilADTFormBridge::setParentElement

(

$a_value

)

Set parent element.

Parameters

string | array

$a_value

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

    {
        if (!is_array($a_value)) {
            $a_value = (string) $a_value;
        }
        $this->parent = $a_value;
    }

setRequired()

ilADTFormBridge::setRequired

(

$a_value

)

Set required.

Parameters

bool

$a_value

Definition at line 201 of file class.ilADTFormBridge.php.

    {
        $this->required = (bool) $a_value;
    }

setTitle()

ilADTFormBridge::setTitle

(

$a_value

)

Set title (aka form field caption)

Parameters

string

$a_value

Definition at line 118 of file class.ilADTFormBridge.php.

Referenced by ilADTTestGUI\prepareFormElements().

    {
        $this->title = trim($a_value);
    }

Here is the caller graph for this function:

shouldBeImportedFromPost()

ilADTFormBridge::shouldBeImportedFromPost

(

ilADTFormBridge

$a_parent_adt = null

)

Check if incoming values should be imported at all.

Parameters

ilADTFormBridge

$a_parent_adt

Returns

bool

Definition at line 322 of file class.ilADTFormBridge.php.

References $parent_element, getParentElement(), importFromPost(), and isDisabled().

    {
        if ($this->isDisabled()) {
            return false;
        }
        
        // inactive parent elements disable importing
        if ($a_parent_adt) {
            $parent_option = null;
            $parent_element = $this->getParentElement();
            if (is_array($parent_element)) {
                $parent_option = $parent_element[1];
            }
            return $a_parent_adt->isActiveForSubItems($parent_option);
        }
        
        return true;
    }

Here is the call graph for this function:

validate()

ilADTFormBridge::validate

(

)

Validate ADT and parse error codes.

Returns

boolean

Definition at line 351 of file class.ilADTFormBridge.php.

References $DIC, $lng, getADT(), getElementId(), getForm(), and isRequired().

    {
        global $DIC;

        $lng = $DIC['lng'];
        
        // ilADTFormBridge->isRequired() != ilADT->allowNull()
        if ($this->isRequired() && $this->getADT()->isNull()) {
            $field = $this->getForm()->getItemByPostvar($this->getElementId());
            $field->setAlert($lng->txt("msg_input_is_required"));
            return false;
        }
        // no need to further validate if no value given
        elseif (!$this->getADT()->isValid()) {
            $tmp = array();
            
            $mess = $this->getADT()->getValidationErrors();
            foreach ($mess as $error_code) {
                $tmp[] = $this->getADT()->translateErrorCode($error_code);
            }
            
            $field = $this->getForm()->getItemByPostvar($this->getElementId());
            $field->setAlert(implode("<br />", $tmp));
            
            return false;
        }
        
        return true;
    }

Here is the call graph for this function:

Field Documentation

$adt

ilADTFormBridge::$adt

protected

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

Referenced by ilADTLocationFormBridge\addToForm(), and getADT().

$disabled

ilADTFormBridge::$disabled

protected

Definition at line 20 of file class.ilADTFormBridge.php.

Referenced by isDisabled().

$form

ilADTFormBridge::$form

protected

Definition at line 14 of file class.ilADTFormBridge.php.

Referenced by getForm().

$id

ilADTFormBridge::$id

protected

Definition at line 15 of file class.ilADTFormBridge.php.

Referenced by getElementId().

$info

ilADTFormBridge::$info

protected

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

Referenced by addBasicFieldProperties(), and getInfo().

$parent_element

ilADTFormBridge::$parent_element

protected

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

Referenced by shouldBeImportedFromPost().

$required

ilADTFormBridge::$required

protected

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

Referenced by isRequired().

$title

ilADTFormBridge::$title

protected

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

Referenced by ilADTLocationFormBridge\addToForm(), ilADTExternalLinkFormBridge\addToForm(), and getTitle().

---

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

• Services/ADT/classes/Bridges/class.ilADTFormBridge.php