class.ilPCGrid.php

Go to the documentation of this file.

<?php

class ilPCGrid extends ilPageContent
{
    protected php4DOMElement $grid_node;

    public function init(): void
    {
        $this->setType("grid");
    }

    public function setNode(php4DOMElement $a_node): void
    {
        parent::setNode($a_node);               // this is the PageContent node
        $this->grid_node = $a_node->first_child();              // this is the Tabs node
    }

    public static function getSizes(): array
    {
        return array("s" => "s", "m" => "m", "l" => "l", "xl" => "xl");
    }

    public static function getWidths(): array
    {
        return array(
            "1" => "1/12", "2" => "2/12", "3" => "3/12",
            "4" => "4/12", "5" => "5/12", "6" => "6/12",
            "7" => "7/12", "8" => "8/12", "9" => "9/12",
            "10" => "10/12", "11" => "11/12", "12" => "12/12"
        );
    }

    public function create(
        ilPageObject $a_pg_obj,
        string $a_hier_id,
        string $a_pc_id = ""
    ): void {
        $this->node = $this->createPageContentNode();
        $a_pg_obj->insertContent($this, $a_hier_id, IL_INSERT_AFTER, $a_pc_id);
        $this->grid_node = $this->dom->create_element("Grid");
        $this->grid_node = $this->node->append_child($this->grid_node);
    }

    public function applyTemplate(
        int $post_layout_template,
        int $number_of_cells,
        int $s,
        int $m,
        int $l,
        int $xl
    ): void {
        switch ($post_layout_template) {
            case ilPCGridGUI::TEMPLATE_TWO_COLUMN:
                $this->addGridCell(12, 6, 6, 6);
                $this->addGridCell(12, 6, 6, 6);
                break;

            case ilPCGridGUI::TEMPLATE_THREE_COLUMN:
                $this->addGridCell(12, 4, 4, 4);
                $this->addGridCell(12, 4, 4, 4);
                $this->addGridCell(12, 4, 4, 4);
                break;

            case ilPCGridGUI::TEMPLATE_MAIN_SIDE:
                $this->addGridCell(12, 6, 8, 9);
                $this->addGridCell(12, 6, 4, 3);
                break;

            case ilPCGridGUI::TEMPLATE_TWO_BY_TWO:
                $this->addGridCell(12, 6, 6, 3);
                $this->addGridCell(12, 6, 6, 3);
                $this->addGridCell(12, 6, 6, 3);
                $this->addGridCell(12, 6, 6, 3);
                break;


            case ilPCGridGUI::TEMPLATE_MANUAL:
                for ($i = 0; $i < $number_of_cells; $i++) {
                    $this->addGridCell($s, $m, $l, $xl);
                }
                break;
        }
    }

    public function savePositions(array $a_pos): void
    {
        asort($a_pos);

        $childs = $this->grid_node->child_nodes();
        $nodes = array();
        for ($i = 0; $i < count($childs); $i++) {
            if ($childs[$i]->node_name() == "GridCell") {
                $pc_id = $childs[$i]->get_attribute("PCID");
                $hier_id = $childs[$i]->get_attribute("HierId");
                $nodes[$hier_id . ":" . $pc_id] = $childs[$i];
                $childs[$i]->unlink($childs[$i]);
            }
        }

        foreach ($a_pos as $k => $v) {
            if (is_object($nodes[$k])) {
                $nodes[$k] = $this->grid_node->append_child($nodes[$k]);
            }
        }
    }

    public function saveWidths(
        array $a_width_s,
        array $a_width_m,
        array $a_width_l,
        array $a_width_xl
    ): void {
        $cell_nodes = $this->grid_node->child_nodes();
        for ($i = 0; $i < count($cell_nodes); $i++) {
            if ($cell_nodes[$i]->node_name() == "GridCell") {
                $pc_id = $cell_nodes[$i]->get_attribute("PCID");
                $hier_id = $cell_nodes[$i]->get_attribute("HierId");
                $k = $hier_id . ":" . $pc_id;
                $cell_nodes[$i]->set_attribute("WIDTH_XS", "");
                $cell_nodes[$i]->set_attribute("WIDTH_S", $a_width_s[$k]);
                $cell_nodes[$i]->set_attribute("WIDTH_M", $a_width_m[$k]);
                $cell_nodes[$i]->set_attribute("WIDTH_L", $a_width_l[$k]);
                $cell_nodes[$i]->set_attribute("WIDTH_XL", $a_width_xl[$k]);
            }
        }
    }


    public function deleteGridCell(
        string $a_hier_id,
        string $a_pc_id
    ): void {
        $childs = $this->grid_node->child_nodes();
        for ($i = 0; $i < count($childs); $i++) {
            if ($childs[$i]->node_name() == "GridCell") {
                if ($a_pc_id == $childs[$i]->get_attribute("PCID") &&
                    $a_hier_id == $childs[$i]->get_attribute("HierId")) {
                    $childs[$i]->unlink($childs[$i]);
                }
            }
        }
    }

    public function addGridCell(
        int $a_s,
        int $a_m,
        int $a_l,
        int $a_xl
    ): void {
        $new_item = $this->dom->create_element("GridCell");
        $new_item = $this->grid_node->append_child($new_item);
        //$new_item->set_attribute("xs", $a_xs);
        $new_item->set_attribute("WIDTH_XS", "");
        $new_item->set_attribute("WIDTH_S", $a_s);
        $new_item->set_attribute("WIDTH_M", $a_m);
        $new_item->set_attribute("WIDTH_L", $a_l);
        $new_item->set_attribute("WIDTH_XL", $a_xl);
    }

    public function addCell(): void
    {
        $new_item = $this->dom->create_element("GridCell");
        $new_item->set_attribute("WIDTH_XS", "");
        $new_item->set_attribute("WIDTH_S", "");
        $new_item->set_attribute("WIDTH_M", "");
        $new_item->set_attribute("WIDTH_L", "");
        $new_item->set_attribute("WIDTH_XL", "");
        $this->grid_node->append_child($new_item);
    }

    public static function getLangVars(): array
    {
        return array("pc_grid", "pc_grid_cell", "ed_delete_cell", "ed_cell_left", "ed_cell_right");
    }

    public function getJavascriptFiles(string $a_mode): array
    {
        return parent::getJavascriptFiles($a_mode);
    }

    public function getCssFiles(string $a_mode): array
    {
        return parent::getCssFiles($a_mode);
    }

    public function getCellData(): array
    {
        $cells = array();
        $cell_nodes = $this->grid_node->child_nodes();
        $k = 0;
        for ($i = 0; $i < count($cell_nodes); $i++) {
            if ($cell_nodes[$i]->node_name() == "GridCell") {
                $pc_id = $cell_nodes[$i]->get_attribute("PCID");
                $hier_id = $cell_nodes[$i]->get_attribute("HierId");
                $cells[] = array("pos" => $k,
                    "xs" => $cell_nodes[$i]->get_attribute("WIDTH_XS"),
                    "s" => $cell_nodes[$i]->get_attribute("WIDTH_S"),
                    "m" => $cell_nodes[$i]->get_attribute("WIDTH_M"),
                    "l" => $cell_nodes[$i]->get_attribute("WIDTH_L"),
                    "xl" => $cell_nodes[$i]->get_attribute("WIDTH_XL"),
                    "pc_id" => $pc_id, "hier_id" => $hier_id);
                $k++;
            }
        }

        return $cells;
    }
}