ilADTFloatSearchBridgeSingle Class Reference

Inheritance diagram for ilADTFloatSearchBridgeSingle:

Collaboration diagram for ilADTFloatSearchBridgeSingle:

Public Member Functions
	loadFilter ()
	Load filter value(s) into ADT. More...
	addToForm ()
	Add ADT-specific fields to form. More...
	importFromPost (array $a_post=null)
	Import values from (search) form request POST data. More...
	getSQLCondition ($a_element_id)
	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 ($a_value)
	Set current value(s) in serialized form (for easy persisting) More...
Public Member Functions inherited from ilADTSearchBridgeSingle
	getADT ()
	Get ADT. More...
	isNull ()
	Is null ? More...
	isValid ()
	validate ()
	Validate current data. More...
Public Member Functions inherited from ilADTSearchBridge
	__construct (ilADTDefinition $a_adt_def)
	Constructor. More...
	isNull ()
	Is null ? 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...
	setTableGUI (ilTable2GUI $a_table)
	Set table gui (for filter mode) More...
	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)
	Import values from (search) form request POST data. More...
	validate ()
	Validate current data. More...
	getSQLCondition ($a_element_id)
	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 ($a_value)
	Set current value(s) in serialized form (for easy persisting) More...

Protected Member Functions
	isValidADTDefinition (ilADTDefinition $a_adt_def)
	Check if given ADT definition is valid. More...
Protected Member Functions inherited from ilADTSearchBridgeSingle
	setDefinition (ilADTDefinition $a_adt_def)
	Set ADT definition. More...
Protected Member Functions inherited from ilADTSearchBridge
	isValidADTDefinition (ilADTDefinition $a_adt_def)
	Check if given ADT definition is valid. More...
	setDefinition (ilADTDefinition $a_adt_def)
	Set ADT definition. More...
	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 ($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...

Additional Inherited Members
Protected Attributes inherited from ilADTSearchBridgeSingle
	$adt
Protected Attributes inherited from ilADTSearchBridge
	$form
	$table_gui
	$table_filter_fields = []
	$id
	$title
	$info

Detailed Description

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

Member Function Documentation

addToForm()

ilADTFloatSearchBridgeSingle::addToForm

(

)

Add ADT-specific fields to form.

Reimplemented from ilADTSearchBridge.

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

    {
        $def = $this->getADT()->getCopyOfDefinition();
        
        $number = new ilNumberInputGUI($this->getTitle(), $this->getElementId());
        $number->setSize(10);
        $number->setDecimals($def->getDecimals());
        
        $min = $def->getMin();
        if ($min !== null) {
            $number->setMinValue($min);
        }
        
        $max = $def->getMax();
        if ($max !== null) {
            $number->setMaxValue($max);
            
            $length = strlen($max);
            $number->setSize($length);
            $number->setMaxLength($length);
        }
        
        $number->setValue($this->getADT()->getNumber());
        
        $this->addToParentElement($number);
    }

References ilADTSearchBridge\addToParentElement(), ilADTSearchBridgeSingle\getADT(), ilADTSearchBridge\getElementId(), and ilADTSearchBridge\getTitle().

Here is the call graph for this function:

getSerializedValue()

ilADTFloatSearchBridgeSingle::getSerializedValue

(

)

Get current value(s) in serialized form (for easy persisting)

Returns

string

Reimplemented from ilADTSearchBridge.

Definition at line 91 of file class.ilADTFloatSearchBridgeSingle.php.

    {
        if (!$this->isNull() && $this->isValid()) {
            return serialize(array($this->getADT()->getNumber()));
        }
    }

References ilADTSearchBridgeSingle\getADT(), ilADTSearchBridgeSingle\isNull(), and ilADTSearchBridgeSingle\isValid().

Here is the call graph for this function:

getSQLCondition()

ilADTFloatSearchBridgeSingle::getSQLCondition

(

$a_element_id

)

Get SQL condition for current value(s)

Parameters

string

$a_element_id

Returns

string

Reimplemented from ilADTSearchBridge.

Definition at line 70 of file class.ilADTFloatSearchBridgeSingle.php.

    {
        global $DIC;
 
        $ilDB = $DIC['ilDB'];
        
        if (!$this->isNull() && $this->isValid()) {
            return $a_element_id . " = " . $ilDB->quote($this->getADT()->getNumber(), "float");
        }
    }

References $DIC, $ilDB, ilADTSearchBridgeSingle\getADT(), ilADTSearchBridgeSingle\isNull(), and ilADTSearchBridgeSingle\isValid().

Here is the call graph for this function:

importFromPost()

ilADTFloatSearchBridgeSingle::importFromPost

(

array

$a_post = null

)

Import values from (search) form request POST data.

Returns

bool

Reimplemented from ilADTSearchBridge.

Definition at line 53 of file class.ilADTFloatSearchBridgeSingle.php.

    {
        $post = $this->extractPostValues($a_post);
                
        if ($post && $this->shouldBeImportedFromPost($post)) {
            $item = $this->getForm()->getItemByPostVar($this->getElementId());
            $item->setValue($post);
            
            $this->getADT()->setNumber($post);
        } else {
            $this->getADT()->setNumber();
        }
    }

References ilADTSearchBridge\extractPostValues(), ilADTSearchBridgeSingle\getADT(), ilADTSearchBridge\getElementId(), ilADTSearchBridge\getForm(), and ilADTSearchBridge\shouldBeImportedFromPost().

Here is the call graph for this function:

isInCondition()

ilADTFloatSearchBridgeSingle::isInCondition

(

ilADT

$a_adt

)

Compare directly against ADT.

Parameters

ilADT

$a_adt

Returns

boolean

Reimplemented from ilADTSearchBridge.

Definition at line 81 of file class.ilADTFloatSearchBridgeSingle.php.

    {
        assert($a_adt instanceof ilADTFloat);
        
        return $this->getADT()->equals($a_adt);
    }

References ilADTSearchBridgeSingle\getADT().

Here is the call graph for this function:

isValidADTDefinition()

ilADTFloatSearchBridgeSingle::isValidADTDefinition ( ilADTDefinition  $a_adt_def )

protected

Check if given ADT definition is valid.

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

Parameters

ilADTDefinition

$a_adt_def

Reimplemented from ilADTSearchBridge.

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

    {
        return ($a_adt_def instanceof ilADTFloatDefinition);
    }

loadFilter()

ilADTFloatSearchBridgeSingle::loadFilter

(

)

Load filter value(s) into ADT.

Reimplemented from ilADTSearchBridge.

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

    {
        $value = $this->readFilter();
        if ($value !== null) {
            $this->getADT()->setNumber($value);
        }
    }

References ilADTSearchBridgeSingle\getADT(), and ilADTSearchBridge\readFilter().

Here is the call graph for this function:

setSerializedValue()

ilADTFloatSearchBridgeSingle::setSerializedValue

(

$a_value

)

Set current value(s) in serialized form (for easy persisting)

Parameters

string

Reimplemented from ilADTSearchBridge.

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

    {
        $a_value = unserialize($a_value);
        if (is_array($a_value)) {
            $this->getADT()->setNumber($a_value[0]);
        }
    }

References ilADTSearchBridgeSingle\getADT().

Here is the call graph for this function:

---

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

• Services/ADT/classes/Types/Float/class.ilADTFloatSearchBridgeSingle.php