class.ilDclGenericMultiInputGUI.php

Go to the documentation of this file.

<?php

class ilDclGenericMultiInputGUI extends ilFormPropertyGUI
{
    const HOOK_IS_LINE_REMOVABLE = "hook_is_line_removable";
    const HOOK_IS_INPUT_DISABLED = "hook_is_disabled";
    const HOOK_BEFORE_INPUT_RENDER = "hook_before_render";
    protected $cust_attr = array();
    protected $value;
    protected $inputs = array();
    protected $input_options = array();
    protected $hooks = array();
    protected $line_values = array();
    protected $template_dir = '';
    protected $post_var_cache = array();
    protected $show_label = false;
    protected $limit = 0;
    protected $allow_empty_fields = false;


    public function getLimit()
    {
        return $this->limit;
    }


    public function setLimit($limit)
    {
        $this->limit = $limit;
    }


    public function isAllowEmptyFields()
    {
        return $this->allow_empty_fields;
    }


    public function setAllowEmptyFields($allow_empty_fields)
    {
        $this->allow_empty_fields = $allow_empty_fields;
    }


    public function __construct($a_title = "", $a_postvar = "")
    {
        parent::__construct($a_title, $a_postvar);
        $this->setType("line_select");
        $this->setMulti(true);
    }


    public function getHook($key)
    {
        if (isset($this->hooks[$key])) {
            return $this->hooks[$key];
        }

        return false;
    }


    public function addHook($key, $options)
    {
        $this->hooks[$key] = $options;
    }


    public function removeHook($key)
    {
        if (isset($this->hooks[$key])) {
            unset($this->hooks[$key]);

            return true;
        }

        return false;
    }


    public function addInput(ilFormPropertyGUI $input, $options = array())
    {
        $input->setRequired(!$this->allow_empty_fields);
        $this->inputs[$input->getPostVar()] = $input;
        $this->input_options[$input->getPostVar()] = $options;
    }


    public function isShowLabel()
    {
        return $this->show_label;
    }


    public function setShowLabel($show_label)
    {
        $this->show_label = $show_label;
    }


    public function getInputs()
    {
        return $this->inputs;
    }


    public function setMulti($a_multi, $a_sortable = false, $a_addremove = true)
    {
        $this->multi = $a_multi;
        $this->multi_sortable = $a_sortable;
    }


    public function setValue($a_value)
    {
        foreach ($this->inputs as $key => $item) {
            if ($item instanceof ilCheckboxInputGUI) {
                $item->setChecked((bool) $a_value[$key]);
            } else {
                if ($item instanceof ilDateTimeInputGUI) {
                    $item->setDate(new ilDate($a_value[$key], IL_CAL_DATE));
                } else {
                    if (method_exists($item, 'setValue')) {
                        $item->setValue($a_value[$key]);
                    }
                }
            }
        }
        $this->value = $a_value;
    }


    public function getValue()
    {
        $out = array();
        foreach ($this->inputs as $key => $item) {
            $out[$key] = $item->getValue();
        }

        return $out;
    }


    public function setValueByArray($a_values)
    {
        $data = $a_values[$this->getPostVar()];
        if ($this->getMulti()) {
            $this->line_values = $data;
        } else {
            $this->setValue($data);
        }
    }


    public function checkInput()
    {
        global $lng;

        $valid = true;

        // escape data
        $out_array = array();
        foreach ($_POST[$this->getPostVar()] as $item_num => $item) {
            foreach ($this->inputs as $input_key => $input) {
                if (isset($item[$input_key])) {
                    $out_array[$item_num][$input_key] = (is_string($item[$input_key])) ? ilUtil::stripSlashes($item[$input_key]) : $item[$input_key];
                }
            }
        }
        $_POST[$this->getPostVar()] = $out_array;

        if ($this->getRequired() && !trim(implode("", $_POST[$this->getPostVar()]))) {
            $valid = false;
        }

        // validate
        foreach ($this->inputs as $input_key => $inputs) {
            foreach ($out_array as $subitem) {
                $_POST[$inputs->getPostVar()] = $subitem[$inputs->getPostVar()];
                if (!$inputs->checkInput()) {
                    $valid = false;
                }
            }
        }

        if (!$valid) {
            $this->setAlert($lng->txt("msg_input_is_required"));

            return false;
        }

        return $valid;
    }


    public function addCustomAttribute($key, $value, $override = false)
    {
        if (isset($this->cust_attr[$key]) && !$override) {
            $this->cust_attr[$key] .= ' ' . $value;
        } else {
            $this->cust_attr[$key] = $value;
        }
    }


    public function getCustomAttributes()
    {
        return (array) $this->cust_attr;
    }


    protected function createInputPostVar($iterator_id, ilFormPropertyGUI $input)
    {
        if ($this->getMulti()) {
            return $this->getPostVar() . '[' . $iterator_id . '][' . $input->getPostVar() . ']';
        } else {
            return $this->getPostVar() . '[' . $input->getPostVar() . ']';
        }
    }


    public function render($iterator_id = 0, $clean_render = false)
    {
        $tpl = new ilTemplate("tpl.prop_generic_multi_line.html", true, true, 'Modules/DataCollection');

        $class = 'multi_input_line';

        $this->addCustomAttribute('class', $class, true);
        foreach ($this->getCustomAttributes() as $key => $value) {
            $tpl->setCurrentBlock('cust_attr');
            $tpl->setVariable('CUSTOM_ATTR_KEY', $key);
            $tpl->setVariable('CUSTOM_ATTR_VALUE', $value);
            $tpl->parseCurrentBlock();
        }

        $inputs = $this->inputs;

        foreach ($inputs as $key => $input) {
            $input = clone $input;
            if (!method_exists($input, 'render')) {
                throw new ilException(
                    "Method " . get_class($input)
                    . "::render() does not exists! You cannot use this input-type in ilMultiLineInputGUI"
                );
            }

            $is_disabled_hook = $this->getHook(self::HOOK_IS_INPUT_DISABLED);
            if ($is_disabled_hook !== false && !$clean_render) {
                $input->setDisabled($is_disabled_hook($this->getValue()));
            }

            if ($this->getDisabled()) {
                $input->setDisabled(true);
            }

            if ($iterator_id == 0 && !isset($this->post_var_cache[$key])) {
                $this->post_var_cache[$key] = $input->getPostVar();
            } else {
                // Reset post var
                $input->setPostVar($this->post_var_cache[$key]);
            }

            $post_var = $this->createInputPostVar($iterator_id, $input);
            $input->setPostVar($post_var);

            $before_render_hook = $this->getHook(self::HOOK_BEFORE_INPUT_RENDER);
            if ($before_render_hook !== false && !$clean_render) {
                $input = $before_render_hook($this->getValue(), $key, $input);
            }

            //var_dump($input);

            if ($this->isShowLabel()) {
                $tpl->setCurrentBlock('input_label');
                $tpl->setVariable('LABEL', $input->getTitle());
                $tpl->setVariable('CONTENT', $input->render());
                $tpl->parseCurrentBlock();
            } else {
                $tpl->setCurrentBlock('input');
                $tpl->setVariable('CONTENT', $input->render());
                $tpl->parseCurrentBlock();
            }
        }

        if ($this->getMulti() && !$this->getDisabled()) {
            $tpl->setVariable('IMAGE_MINUS', ilGlyphGUI::get(ilGlyphGUI::REMOVE));

            $show_remove = true;
            $is_removeable_hook = $this->getHook(self::HOOK_IS_LINE_REMOVABLE);
            if ($is_removeable_hook !== false && !$clean_render) {
                $show_remove = $is_removeable_hook($this->getValue());
            }

            $image_minus = ($show_remove) ? ilGlyphGUI::get(ilGlyphGUI::REMOVE) : '<span class="glyphicon glyphicon-minus hide"></span>';
            $tpl->setCurrentBlock('multi_icons');
            $tpl->setVariable('IMAGE_PLUS', ilGlyphGUI::get(ilGlyphGUI::ADD));
            $tpl->setVariable('IMAGE_MINUS', $image_minus);
            if ($this->multi_sortable) {
                $tpl->setVariable('IMAGE_UP', ilGlyphGUI::get(ilGlyphGUI::UP));
                $tpl->setVariable('IMAGE_DOWN', ilGlyphGUI::get(ilGlyphGUI::DOWN));
            }
            $tpl->parseCurrentBlock();
        }

        return $tpl->get();
    }


    public function insert(&$a_tpl)
    {
        global $DIC;
        $tpl = $DIC['tpl'];

        $output = "";
        //              $tpl->addCss($this->getTemplateDir() . '/templates/css/multi_line_input.css');

        $output .= $this->render(0, true);

        if ($this->getMulti() && is_array($this->line_values) && count($this->line_values) > 0) {
            $counter = 0;
            foreach ($this->line_values as $i => $data) {
                $object = $this;
                $object->setValue($data);
                $output .= $object->render($i);
                $counter++;
            }
        } else {
            $output .= $this->render(1, true);
        }

        if ($this->getMulti()) {
            $output = '<div id="' . $this->getFieldId() . '" class="multi_line_input">' . $output . '</div>';
            $tpl->addJavascript('Modules/DataCollection/js/generic_multi_line_input.js');
            $output .= '<script type="text/javascript">$("#' . $this->getFieldId() . '").multi_line_input('
                . json_encode($this->input_options) . ', '
                . json_encode(array('limit' => $this->limit, 'sortable' => $this->multi_sortable, 'locale' => $DIC->language()->getLangKey()))
                . ')</script>';
        }

        $a_tpl->setCurrentBlock("prop_generic");
        $a_tpl->setVariable("PROP_GENERIC", $output);
        $a_tpl->parseCurrentBlock();
    }


    public function getTableFilterHTML()
    {
        $html = $this->render();

        return $html;
    }


    public function getToolbarHTML()
    {
        $html = $this->render("toolbar");

        return $html;
    }


    //  /**
    //   * @param bool|false $a_sortable
    //   *
    //   * @return string
    //   */
    //  public function getMultiIconsHTML($a_sortable = false) {
    //
    //          $id = $this->getFieldId();
    //
    //          if (file_exists(ilUtil::getImagePath('edit_add.png'))) {
    //                  $html = '<a href="#" style="display: inline-block;" class="add_button"><img src="' . ilUtil::getImagePath('edit_add.png') . '" /></a>';
    //                  $html .= '<a href="#" style="display: inline-block;" class="remove_button"><img src="' . ilUtil::getImagePath('edit_remove.png')
    //                          . '" /></a>';
    //          } else {
    //                  $html = '<a href="#" style="display: inline-block;" class="add_button"><span class="sr-only"></span><span class="glyphicon glyphicon-plus"></span></a>';
    //                  $html .= '<a href="#" style="display: inline-block;" class="remove_button"><span class="sr-only"></span><span class="glyphicon glyphicon-minus"></span></a>';
    //          }
    //
    //          /*if($a_sortable)
    //          {
    //                  $html .= '&nbsp;<input align="absmiddle" type="image" id="ilMultiDwn~'.$id.'~0"'.
    //                          ' src="'.ilUtil::getImagePath('icon_down_s.png').'" alt="'.
    //                          $lng->txt("down").'" title="'.$lng->txt("down").'" onclick="javascript: return false;" />'.
    //                          '<input align="absmiddle" type="image" id="ilMultiUp~'.$id.'~0"'.
    //                          ' src="'.ilUtil::getImagePath('icon_up_s.png').'" alt="'.$lng->txt("up").
    //                          '" title="'.$lng->txt("up").'"  onclick="javascript: return false;" />';
    //          }*/
    //
    //          return $html;
    //  }

    public function getSubItems()
    {
        return array();
    }
}