ilADTDateTimeFormBridge Class Reference

Inheritance diagram for ilADTDateTimeFormBridge:

Collaboration diagram for ilADTDateTimeFormBridge:

Public Member Functions
	setTextInputMode ($a_value)
	addToForm ()
	Add ADT-specific fields to form. More...
	importFromPost ()
	Import values from form request POST data. More...
	validate ()
	Validate ADT and parse error codes. More...
Public Member Functions inherited from ilADTFormBridge
	__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 (ilTemplate $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...
Protected Member Functions inherited from ilADTFormBridge
	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
	$invalid_input
	$text_input
Protected Attributes inherited from ilADTFormBridge
	$adt
	$form
	$id
	$title
	$info
	$parent_element
	$required
	$disabled

Detailed Description

Definition at line 5 of file class.ilADTDateTimeFormBridge.php.

Member Function Documentation

addToForm()

ilADTDateTimeFormBridge::addToForm

(

)

Add ADT-specific fields to form.

Reimplemented from ilADTFormBridge.

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

    {
        global $lng;
            
        $adt_date = $this->getADT()->getDate();
 
        $date = new ilDateTimeInputGUI($this->getTitle(), $this->getElementId());
        $date->setShowTime(true);
 
        $this->addBasicFieldProperties($date, $this->getADT()->getCopyOfDefinition());
        
        $date->setDate($adt_date);
 
        $this->addToParentElement($date);
    }

References $lng, ilADTFormBridge\addBasicFieldProperties(), ilADTFormBridge\addToParentElement(), ilADTFormBridge\getADT(), ilADTFormBridge\getElementId(), and ilADTFormBridge\getTitle().

Here is the call graph for this function:

importFromPost()

ilADTDateTimeFormBridge::importFromPost

(

)

Import values from form request POST data.

Reimplemented from ilADTFormBridge.

Definition at line 36 of file class.ilADTDateTimeFormBridge.php.

    {
        $field = $this->getForm()->getItemByPostvar($this->getElementId());
                
        // because of ilDateTime the ADT can only have valid dates
        if (!$field->hasInvalidInput()) {
            // ilPropertyFormGUI::checkInput() is pre-requisite
            $this->getADT()->setDate($field->getDate());
 
            $field->setDate($this->getADT()->getDate());
        } else {
            $this->invalid_input = true;
        }
    }

References ilADTFormBridge\getADT(), ilADTFormBridge\getElementId(), and ilADTFormBridge\getForm().

Here is the call graph for this function:

isValidADT()

ilADTDateTimeFormBridge::isValidADT ( ilADT  $a_adt )

protected

Check if given ADT is valid.

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

Parameters

ilADT

$a_adt

Reimplemented from ilADTFormBridge.

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

    {
        return ($a_adt instanceof ilADTDateTime);
    }

setTextInputMode()

ilADTDateTimeFormBridge::setTextInputMode

(

$a_value

)

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

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

validate()

ilADTDateTimeFormBridge::validate

(

)

Validate ADT and parse error codes.

Returns

boolean

Reimplemented from ilADTFormBridge.

Definition at line 51 of file class.ilADTDateTimeFormBridge.php.

    {
        // :TODO: error handling is done by ilDateTimeInputGUI
        return !(bool) $this->invalid_input;
    }

Field Documentation

$invalid_input

ilADTDateTimeFormBridge::$invalid_input

protected

Definition at line 7 of file class.ilADTDateTimeFormBridge.php.

$text_input

ilADTDateTimeFormBridge::$text_input

protected

Definition at line 8 of file class.ilADTDateTimeFormBridge.php.

---

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

• Services/ADT/classes/Types/DateTime/class.ilADTDateTimeFormBridge.php