ILIAS  Release_5_0_x_branch Revision 61816
 All Data Structures Namespaces Files Functions Variables Groups Pages
ilADTIntegerSearchBridgeSingle Class Reference
+ Inheritance diagram for ilADTIntegerSearchBridgeSingle:
+ Collaboration diagram for ilADTIntegerSearchBridgeSingle:

Public Member Functions

 addToForm ()
 Add ADT-specific fields to form.
 importFromPost (array $a_post=null)
 Import values from (search) form request POST data.
 getSQLCondition ($a_element_id)
 Get SQL condition for current value(s)
 isInCondition (ilADTInteger $a_adt)
 getSerializedValue ()
 Get current value(s) in serialized form (for easy persisting)
 setSerializedValue ($a_value)
 Set current value(s) in serialized form (for easy persisting)
- Public Member Functions inherited from ilADTSearchBridgeSingle
 getADT ()
 Get ADT.
 isNull ()
 Is null ?
 isValid ()
 validate ()
 Validate current data.
- Public Member Functions inherited from ilADTSearchBridge
 __construct (ilADTDefinition $a_adt_def)
 Constructor.
 setForm (ilPropertyFormGUI $a_form)
 Set form.
 getForm ()
 Get form.
 setElementId ($a_value)
 Set element id (aka form field)
 getElementId ()
 Get element id.
 setTitle ($a_value)
 Set title (aka form field caption)
 getTitle ()
 Get title.
 setTableGUI (ilTable2GUI $a_table)
 Set table gui (for filter mode)
 getTableGUI ()
 Get table gui.
 loadFilter ()
 Load filter value(s) into ADT.
 isInCondition (ilADT $a_adt)
 Compare directly against ADT.

Protected Member Functions

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

Additional Inherited Members

- Protected Attributes inherited from ilADTSearchBridgeSingle
 $adt

Detailed Description

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

Member Function Documentation

ilADTIntegerSearchBridgeSingle::addToForm ( )

Add ADT-specific fields to form.

Reimplemented from ilADTSearchBridge.

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

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

{
$def = $this->getADT()->getCopyOfDefinition();
$number = new ilNumberInputGUI($this->getTitle(), $this->getElementId());
$number->setSize(10);
$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);
}
$this->addToParentElement($number);
}

+ Here is the call graph for this function:

ilADTIntegerSearchBridgeSingle::getSerializedValue ( )

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

Returns
string

Reimplemented from ilADTSearchBridge.

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

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

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

+ Here is the call graph for this function:

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 61 of file class.ilADTIntegerSearchBridgeSingle.php.

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

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

+ Here is the call graph for this function:

ilADTIntegerSearchBridgeSingle::importFromPost ( array  $a_post = null)

Import values from (search) form request POST data.

Returns
bool

Reimplemented from ilADTSearchBridge.

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

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

{
$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();
}
}

+ Here is the call graph for this function:

ilADTIntegerSearchBridgeSingle::isInCondition ( ilADTInteger  $a_adt)

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

References ilADTSearchBridgeSingle\getADT().

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

+ Here is the call graph for this function:

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.

{
return ($a_adt_def instanceof ilADTIntegerDefinition);
}
ilADTIntegerSearchBridgeSingle::setSerializedValue (   $a_value)

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

Parameters
string

Reimplemented from ilADTSearchBridge.

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

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

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