class.ilADTSearchBridge.php

Go to the documentation of this file.

<?php
/* Copyright (c) 1998-2009 ILIAS open source, Extended GPL, see docs/LICENSE */

include_once "Services/Form/classes/class.ilPropertyFormGUI.php";

abstract class ilADTSearchBridge
{
    public const DEFAULT_SEARCH_COLUMN = 'value';

    protected $form; // [ilPropertyFormGUI]
    protected $table_gui; // [ilTable2GUI]
    protected $table_filter_fields = []; // [array]
    protected $id; // [string]
    protected $title; // [string]
    protected $info; // [string]
    
    public function __construct(ilADTDefinition $a_adt_def)
    {
        $this->setDefinition($a_adt_def);
    }
    
    
    //
    // properties
    //
    
    abstract protected function isValidADTDefinition(ilADTDefinition $a_adt_def);
    
    abstract protected function setDefinition(ilADTDefinition $a_adt_def);
    
    abstract public function isNull();
    
    public function setForm(ilPropertyFormGUI $a_form)
    {
        $this->form = $a_form;
    }
    
    public function getForm()
    {
        return $this->form;
    }
    
    public function setElementId($a_value)
    {
        $this->id = (string) $a_value;
    }
    
    public function getElementId()
    {
        return $this->id;
    }
    
    public function setTitle($a_value)
    {
        $this->title = trim($a_value);
    }
    
    public function getTitle()
    {
        return $this->title;
    }


    public function getSearchColumn() : string
    {
        return self::DEFAULT_SEARCH_COLUMN;
    }
    
    
    //
    // table2gui / filter
    //
    
    public function setTableGUI(ilTable2GUI $a_table)
    {
        $this->table_gui = $a_table;
    }
    
    public function getTableGUI()
    {
        return $this->table_gui;
    }
    
    protected function writeFilter($a_value = null)
    {
        if (!$this->table_gui instanceof ilTable2GUI) {
            return;
        }
        if ($a_value !== null) {
            $_SESSION["form_" . $this->table_gui->getId()][$this->getElementId()] = serialize($a_value);
        } else {
            unset($_SESSION["form_" . $this->table_gui->getId()][$this->getElementId()]);
        }
    }
    
    protected function readFilter()
    {
        if (!$this->table_gui instanceof ilTable2GUI) {
            return;
        }
        $value = $_SESSION["form_" . $this->table_gui->getId()][$this->getElementId()];
        if ($value) {
            return unserialize($value);
        }
    }
    
    abstract public function loadFilter();
    
    
    //
    // form
    //
    
    protected function addToParentElement(ilFormPropertyGUI $a_field)
    {
        if ($this->getForm() instanceof ilPropertyFormGUI) {
            $this->getForm()->addItem($a_field);
        } elseif ($this->getTableGUI() instanceof ilTable2GUI) {
            $this->table_filter_fields[$a_field->getFieldId()] = $a_field;
            $this->getTableGUI()->addFilterItem($a_field);
            
            // :TODO:
            // $a_field->readFromSession();
            // $this->getTableGUI()->filter[$this->getElementId()] = $a_field->getValue();
        }
    }
    
    protected function addToElementId($a_add)
    {
        return $this->getElementId() . "[" . $a_add . "]";
    }
    
    abstract public function addToForm();
    
    
    //
    // post data
    //
    
    protected function shouldBeImportedFromPost($a_post)
    {
        return true;
    }
    
    protected function extractPostValues(array $a_post = null)
    {
        $element_id = $this->getElementId();
        $multi = strpos($this->getElementId(), "[");

        // get rid of this case
        if ($a_post === null) {
            $a_post = $_POST;
            if ($multi !== false) {
                $post = $a_post[substr($element_id, 0, $multi)][substr($element_id, $multi + 1, -1)];
            } else {
                $post = $a_post[$element_id];
            }
        } elseif ($multi !== false) {
            $post = $a_post[substr($element_id, $multi + 1, -1)];
        } else {
            $post = $a_post[$element_id];
        }

        return $post;
    }
    
    abstract public function importFromPost(array $a_post = null);
    
    abstract public function validate();
        
    
    //
    // DB
    //
    
    abstract public function getSQLCondition($a_element_id);
    
    public function isInCondition(ilADT $a_adt)
    {
        return false;
    }
    
    
    //
    //  import/export
    //
    
    abstract public function getSerializedValue();
    
    abstract public function setSerializedValue($a_value);
}