ilADTSearchBridgeRange Class Reference

Class ilADTSearchBridgeRange. More...

Inheritance diagram for ilADTSearchBridgeRange:

Collaboration diagram for ilADTSearchBridgeRange:

Public Member Functions
	getLowerADT ()
	Get lower ADT. More...
	getUpperADT ()
	Get upper ADT. More...
	isNull ()
	isValid ()
	validate ()
Public Member Functions inherited from ilADTSearchBridge
	__construct (ilADTDefinition $a_adt_def)
	isNull ()
	setForm (ilPropertyFormGUI $a_form)
	getForm ()
	setElementId (string $a_value)
	getElementId ()
	setTitle (string $a_value)
	getTitle ()
	getSearchColumn ()
	setTableGUI (ilTable2GUI $a_table)
	getTableGUI ()
	Get table gui. More...
	loadFilter ()
	Load filter value(s) into ADT. More...
	addToForm ()
	Add ADT-specific fields to form. More...
	importFromPost (array $a_post=null)
	validate ()
	Validate current data. More...
	getSQLCondition (string $a_element_id, int $mode=self::SQL_LIKE, array $quotedWords=[])
	Get SQL condition for current value(s) More...
	isInCondition (ilADT $a_adt)
	Compare directly against ADT. More...
	getSerializedValue ()
	Get current value(s) in serialized form (for easy persisting) More...
	setSerializedValue (string $a_value)
	Set current value(s) in serialized form (for easy persisting) More...

Protected Member Functions
	setDefinition (ilADTDefinition $a_adt_def)
Protected Member Functions inherited from ilADTSearchBridge
	isValidADTDefinition (ilADTDefinition $a_adt_def)
	setDefinition (ilADTDefinition $a_adt_def)
	writeFilter ($a_value=null)
	Write value(s) to filter store (in session) More...
	readFilter ()
	Load value(s) from filter store (in session) More...
	addToParentElement (ilFormPropertyGUI $a_field)
	Add form field to parent element. More...
	addToElementId (string $a_add)
	Add sub-element. More...
	shouldBeImportedFromPost ($a_post)
	Check if incoming values should be imported at all. More...
	extractPostValues (array $a_post=null)
	Extract data from (post) values. More...

Protected Attributes
ilADT	$adt_lower
ilADT	$adt_upper
Protected Attributes inherited from ilADTSearchBridge
ilPropertyFormGUI	$form = null
ilTable2GUI	$table_gui = null
array	$table_filter_fields = []
string	$id = ''
string	$title = ''
string	$info = ''
ilLanguage	$lng
ilDBInterface	$db
HttpServices	$http

Additional Inherited Members
Data Fields inherited from ilADTSearchBridge
const	SQL_STRICT = 1
const	SQL_LIKE = 2
const	SQL_LIKE_END = 3
const	SQL_LIKE_START = 4
const	DEFAULT_SEARCH_COLUMN = 'value'

Detailed Description

Class ilADTSearchBridgeRange.

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

Member Function Documentation

getLowerADT()

ilADTSearchBridgeRange::getLowerADT

(

)

Get lower ADT.

Returns

ilADT | null

Definition at line 29 of file class.ilADTSearchBridgeRange.php.

References $adt_lower.

Referenced by ilADTDateSearchBridgeRange\addToForm(), ilADTDateTimeSearchBridgeRange\addToForm(), ilADTDateSearchBridgeRange\getSerializedValue(), ilADTDateTimeSearchBridgeRange\getSerializedValue(), ilADTDateSearchBridgeRange\getSQLCondition(), ilADTDateTimeSearchBridgeRange\getSQLCondition(), ilADTDateSearchBridgeRange\importFromPost(), ilADTDateTimeSearchBridgeRange\importFromPost(), ilADTDateSearchBridgeRange\isInCondition(), ilADTDateTimeSearchBridgeRange\isInCondition(), isNull(), isValid(), ilADTDateSearchBridgeRange\loadFilter(), ilADTDateTimeSearchBridgeRange\loadFilter(), ilADTDateSearchBridgeRange\setSerializedValue(), ilADTDateTimeSearchBridgeRange\setSerializedValue(), and validate().

                                 : ?ilADT
    {
        return $this->adt_lower;
    }

Here is the caller graph for this function:

getUpperADT()

ilADTSearchBridgeRange::getUpperADT

(

)

Get upper ADT.

Returns

ilADT | null

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

References $adt_upper.

Referenced by ilADTDateSearchBridgeRange\addToForm(), ilADTDateTimeSearchBridgeRange\addToForm(), ilADTDateSearchBridgeRange\getSerializedValue(), ilADTDateTimeSearchBridgeRange\getSerializedValue(), ilADTDateSearchBridgeRange\getSQLCondition(), ilADTDateTimeSearchBridgeRange\getSQLCondition(), ilADTDateSearchBridgeRange\importFromPost(), ilADTDateTimeSearchBridgeRange\importFromPost(), ilADTDateSearchBridgeRange\isInCondition(), ilADTDateTimeSearchBridgeRange\isInCondition(), isNull(), isValid(), ilADTDateSearchBridgeRange\loadFilter(), ilADTDateTimeSearchBridgeRange\loadFilter(), ilADTDateSearchBridgeRange\setSerializedValue(), ilADTDateTimeSearchBridgeRange\setSerializedValue(), and validate().

                                 : ?ilADT
    {
        return $this->adt_upper;
    }

Here is the caller graph for this function:

isNull()

ilADTSearchBridgeRange::isNull

(

)

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

References getLowerADT(), and getUpperADT().

Referenced by ilADTDateSearchBridgeRange\addToForm(), ilADTDateTimeSearchBridgeRange\addToForm(), ilADTDateSearchBridgeRange\getSerializedValue(), ilADTDateTimeSearchBridgeRange\getSerializedValue(), ilADTDateSearchBridgeRange\getSQLCondition(), ilADTDateTimeSearchBridgeRange\getSQLCondition(), ilADTDateSearchBridgeRange\isInCondition(), and ilADTDateTimeSearchBridgeRange\isInCondition().

                            : bool
    {
        if (!$this->getLowerADT() instanceof ilADT || !$this->getUpperADT() instanceof ilADT) {
            return false;
        }
        return ($this->getLowerADT()->isNull() && $this->getUpperADT()->isNull());
    }

Here is the call graph for this function:

Here is the caller graph for this function:

isValid()

ilADTSearchBridgeRange::isValid

(

)

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

References getLowerADT(), and getUpperADT().

Referenced by ilADTDateSearchBridgeRange\getSerializedValue(), ilADTDateTimeSearchBridgeRange\getSerializedValue(), ilADTDateSearchBridgeRange\getSQLCondition(), ilADTDateTimeSearchBridgeRange\getSQLCondition(), and validate().

                             : bool
    {
        if (!$this->getLowerADT() instanceof ilADT || !$this->getUpperADT() instanceof ilADT) {
            return false;
        }
        return ($this->getLowerADT()->isValid() && $this->getUpperADT()->isValid());
    }

Here is the call graph for this function:

Here is the caller graph for this function:

setDefinition()

ilADTSearchBridgeRange::setDefinition ( ilADTDefinition  $a_adt_def )

protected

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

References $factory, ilADTFactory\getInstance(), and ilADTSearchBridge\isValidADTDefinition().

                                                                : void
    {
        if ($this->isValidADTDefinition($a_adt_def)) {
            $factory = ilADTFactory::getInstance();
            $this->adt_lower = $factory->getInstanceByDefinition($a_adt_def);
            $this->adt_upper = $factory->getInstanceByDefinition($a_adt_def);
            return;
        }

        throw new InvalidArgumentException('ilADTSearchBridge type mismatch.');
    }

Here is the call graph for this function:

validate()

ilADTSearchBridgeRange::validate

(

)

Definition at line 59 of file class.ilADTSearchBridgeRange.php.

References ilADTSearchBridge\addToElementId(), ilADTSearchBridge\getForm(), getLowerADT(), getUpperADT(), and isValid().

                              : bool
    {
        if (!$this->getLowerADT() instanceof ilADT || !$this->getUpperADT() instanceof ilADT) {
            return false;
        }
        if (!$this->isValid()) {
            $tmp = [];
            $mess = $this->getLowerADT()->getValidationErrors();
            foreach ($mess as $error_code) {
                $tmp[] = $this->getLowerADT()->translateErrorCode($error_code);
            }
            if ($tmp) {
                $field = $this->getForm()->getItemByPostVar($this->addToElementId("lower"));
                $field->setAlert(implode("<br />", $tmp));
            }

            $tmp = [];
            $mess = $this->getUpperADT()->getValidationErrors();
            foreach ($mess as $error_code) {
                $tmp[] = $this->getUpperADT()->translateErrorCode($error_code);
            }
            if ($tmp) {
                $field = $this->getForm()->getItemByPostVar($this->addToElementId("upper"));
                $field->setAlert(implode("<br />", $tmp));
            }
            return false;
        }
        return true;
    }

Here is the call graph for this function:

Field Documentation

$adt_lower

ilADT ilADTSearchBridgeRange::$adt_lower

protected

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

Referenced by getLowerADT().

$adt_upper

ilADT ilADTSearchBridgeRange::$adt_upper

protected

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

Referenced by getUpperADT().

---

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

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