ILIAS  release_5-1 Revision 5.0.0-5477-g43f3e3fab5f
ilADTIntegerSearchBridgeSingle Class Reference
+ Inheritance diagram for ilADTIntegerSearchBridgeSingle:
+ Collaboration diagram for ilADTIntegerSearchBridgeSingle:

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 (ilADTInteger $a_adt)
 
 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.ilADTIntegerSearchBridgeSingle.php.

Member Function Documentation

◆ addToForm()

ilADTIntegerSearchBridgeSingle::addToForm ( )

Add ADT-specific fields to form.

Reimplemented from ilADTSearchBridge.

Definition at line 27 of file class.ilADTIntegerSearchBridgeSingle.php.

28 {
29 $def = $this->getADT()->getCopyOfDefinition();
30
31 $number = new ilNumberInputGUI($this->getTitle(), $this->getElementId());
32 $number->setSize(10);
33
34 $min = $def->getMin();
35 if($min !== null)
36 {
37 $number->setMinValue($min);
38 }
39
40 $max = $def->getMax();
41 if($max !== null)
42 {
43 $number->setMaxValue($max);
44
45 $length = strlen($max);
46 $number->setSize($length);
47 $number->setMaxLength($length);
48 }
49
50 $number->setValue($this->getADT()->getNumber());
51
52 $this->addToParentElement($number);
53 }
addToParentElement(ilFormPropertyGUI $a_field)
Add form field to parent element.
getElementId()
Get element id.
This class represents a number property in a property form.

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

+ Here is the call graph for this function:

◆ getSerializedValue()

ilADTIntegerSearchBridgeSingle::getSerializedValue ( )

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

Returns
string

Reimplemented from ilADTSearchBridge.

Definition at line 93 of file class.ilADTIntegerSearchBridgeSingle.php.

94 {
95 if(!$this->isNull() && $this->isValid())
96 {
97 return serialize(array($this->getADT()->getNumber()));
98 }
99 }

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

+ Here is the call graph for this function:

◆ getSQLCondition()

ilADTIntegerSearchBridgeSingle::getSQLCondition (   $a_element_id)

Get SQL condition for current value(s)

Parameters
string$a_element_id
Returns
string

Reimplemented from ilADTSearchBridge.

Definition at line 75 of file class.ilADTIntegerSearchBridgeSingle.php.

76 {
77 global $ilDB;
78
79 if(!$this->isNull() && $this->isValid())
80 {
81 return $a_element_id." = ".$ilDB->quote($this->getADT()->getNumber(), "integer");
82 }
83 }
global $ilDB

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

+ Here is the call graph for this function:

◆ importFromPost()

ilADTIntegerSearchBridgeSingle::importFromPost ( array  $a_post = null)

Import values from (search) form request POST data.

Returns
bool

Reimplemented from ilADTSearchBridge.

Definition at line 55 of file class.ilADTIntegerSearchBridgeSingle.php.

56 {
57 $post = $this->extractPostValues($a_post);
58
59 if($post && $this->shouldBeImportedFromPost($post))
60 {
61 $item = $this->getForm()->getItemByPostVar($this->getElementId());
62 $item->setValue($post);
63
64 $this->getADT()->setNumber($post);
65 }
66 else
67 {
68 $this->getADT()->setNumber();
69 }
70 }
extractPostValues(array $a_post=null)
Extract data from (post) values.
shouldBeImportedFromPost($a_post)
Check if incoming values should be imported at all.

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

+ Here is the call graph for this function:

◆ isInCondition()

ilADTIntegerSearchBridgeSingle::isInCondition ( ilADTInteger  $a_adt)

Definition at line 85 of file class.ilADTIntegerSearchBridgeSingle.php.

86 {
87 return $this->getADT()->equals($a_adt);
88 }

References ilADTSearchBridgeSingle\getADT().

+ Here is the call graph for this function:

◆ isValidADTDefinition()

ilADTIntegerSearchBridgeSingle::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.ilADTIntegerSearchBridgeSingle.php.

8 {
9 return ($a_adt_def instanceof ilADTIntegerDefinition);
10 }

◆ loadFilter()

ilADTIntegerSearchBridgeSingle::loadFilter ( )

Load filter value(s) into ADT.

Reimplemented from ilADTSearchBridge.

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

16 {
17 $value = $this->readFilter();
18 if($value !== null)
19 {
20 $this->getADT()->setNumber($value);
21 }
22 }
readFilter()
Load value(s) from filter store (in session)

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

+ Here is the call graph for this function:

◆ setSerializedValue()

ilADTIntegerSearchBridgeSingle::setSerializedValue (   $a_value)

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

Parameters
string

Reimplemented from ilADTSearchBridge.

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

102 {
103 $a_value = unserialize($a_value);
104 if(is_array($a_value))
105 {
106 $this->getADT()->setNumber($a_value[0]);
107 }
108 }

References ilADTSearchBridgeSingle\getADT().

+ Here is the call graph for this function:

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