class.ilSubEnabledFormPropertyGUI.php

Go to the documentation of this file.

<?php

declare(strict_types=1);

class ilSubEnabledFormPropertyGUI extends ilFormPropertyGUI
{
    protected array $sub_items = array();

    public function addSubItem(ilFormPropertyGUI $a_item): void
    {
        $a_item->setParent($this);
        $this->sub_items[] = $a_item;
    }

    public function getSubItems(): array
    {
        return $this->sub_items;
    }

    public function getSubInputItemsRecursive(): array
    {
        $subInputItems = array();

        foreach ($this->sub_items as $subItem) {
            if ($subItem->getType() == 'section_header') {
                continue;
            }

            $subInputItems[] = $subItem;

            if ($subItem instanceof ilSubEnabledFormPropertyGUI) {
                $subInputItems = array_merge($subInputItems, $subItem->getSubInputItemsRecursive());
            }
        }

        return $subInputItems;
    }

    final public function checkSubItemsInput(): bool
    {
        $ok = true;
        foreach ($this->getSubItems() as $item) {
            $item_ok = $item->checkInput();
            if (!$item_ok) {
                $ok = false;
            }
        }
        return $ok;
    }

    final public function getSubForm(): ?ilPropertyFormGUI
    {
        // subitems
        $pf = null;
        if (count($this->getSubItems()) > 0) {
            $pf = new ilPropertyFormGUI();
            $pf->setMode("subform");
            $pf->setItems($this->getSubItems());
        }

        return $pf;
    }

    public function getItemByPostVar(string $a_post_var): ?ilFormPropertyGUI
    {
        if ($this->getPostVar() == $a_post_var) {
            return $this;
        }

        foreach ($this->getSubItems() as $item) {
            if ($item->getType() != "section_header") {
                $ret = $item->getItemByPostVar($a_post_var);
                if (is_object($ret)) {
                    return $ret;
                }
            }
        }

        return null;
    }
}