class.ilKSDocumentationEntryGUI.php

Go to the documentation of this file.

<?php
include_once("./Services/UIComponent/Panel/classes/class.ilPanelGUI.php");
include_once("Services/Form/classes/class.ilPropertyFormGUI.php");
include_once("libs/composer/vendor/geshi/geshi/src/geshi.php");


use ILIAS\UI\Implementation\Crawler\Entry as Entry;
use ILIAS\UI\Implementation\Crawler as Crawler;

class ilKSDocumentationEntryGUI
{
    protected $entry = null;

    protected $entries = null;

    protected $ctrl;

    protected $parent;

    protected $f = null;

    protected $r = null;

    protected $explorer;

    public function __construct(
        ilSystemStyleDocumentationGUI $parent
    ) {
        global $DIC;

        $this->f = $DIC->ui()->factory();
        $this->r = $DIC->ui()->renderer();


        $entries = Crawler\Entry\ComponentEntries::createFromArray(include ilSystemStyleDocumentationGUI::$DATA_PATH);
        $current_opened_node_id = $_GET["node_id"];

        if ($current_opened_node_id) {
            $DIC->ctrl()->setParameterByClass("ilsystemstyledocumentationgui", "node_id", $current_opened_node_id);
            $this->setEntry($entries->getEntryById($_GET["node_id"]));
        } else {
            $this->setEntry($entries->getRootEntry());
        }
        $this->setEntries($entries);
        $this->setParent($parent);
        $this->ctrl = $DIC->ctrl();
    }

    public function renderEntry()
    {
        $sub_panels = array();

        $feature_wiki_links = array();
        foreach ($this->entry->getFeatureWikiReferences()as $href) {
            $feature_wiki_links[] = $href;
        }


        $sub_panels[] = $this->f->panel()->sub(
            "Description",
            array(
                $this->f->listing()->descriptive(
                    array(
                        "Purpose" => $this->entry->getDescription()->getProperty("purpose"),
                        "Composition" => $this->entry->getDescription()->getProperty("composition"),
                        "Effect" => $this->entry->getDescription()->getProperty("effect"),

                    )
                ),
                $this->f->listing()->descriptive(
                    array(
                        "Background" => $this->entry->getBackground(),
                        "Context" => $this->f->listing()->ordered($this->entry->getContext()),
                        "Feature Wiki References" => $this->f->listing()->ordered($feature_wiki_links)
                    )
                )
            )
        );

        if (sizeof($this->entry->getDescription()->getProperty("rivals"))) {
            $sub_panels[] = $this->f->panel()->sub(
                "Rivals",
                $this->f->listing()->descriptive(
                    $this->entry->getDescription()->getProperty("rivals")
                )
            );
        }

        if ($this->entry->getRules()->hasRules()) {
            $rule_listings = array();
            foreach ($this->entry->getRulesAsArray() as $categoery => $category_rules) {
                $rule_listings[ucfirst($categoery)] = $this->f->listing()->ordered($category_rules);
            }


            $sub_panels[] = $this->f->panel()->sub(
                "Rules",
                $this->f->listing()->descriptive($rule_listings)
            );
        }


        if ($this->entry->getExamples()) {
            $nr = 1;
            foreach ($this->entry->getExamples() as $name => $path) {
                include_once($path);
                $title = "Example " . $nr . ": " . ucfirst(str_replace("_", " ", $name));
                $nr++;
                try{
                    $example = "<div class='well'>" . $name() . "</div>"; //Executes function loaded in file indicated by 'path'
                }catch(\ILIAS\UI\NotImplementedException $e){
                    $example = "<div class='well'>This component is not yet fully implemented.</div>";
                }
                $content_part_1 = $this->f->legacy($example);
                $code = str_replace("<?php\n", "", file_get_contents($path));
                $geshi = new GeSHi($code, "php");
                //@Todo: we need a code container UI Component
                $code_html = "<div class='code-container'>" . $geshi->parse_code() . "</div>";
                $content_part_2 = $this->f->legacy($code_html);
                $content = array($content_part_1,$content_part_2);
                $sub_panels[] = $this->f->panel()->sub($title, $content);
            }
        }
        $sub_panels[] = $this->f->panel()->sub('Relations', [
                                    $this->f->listing()->descriptive(
                                        array(
                                            "Parents" => $this->f->listing()->ordered(
                                                $this->entries->getParentsOfEntryTitles($this->entry->getId())
                                            ),
                                            "Descendants" => $this->f->listing()->unordered(
                                                $this->entries->getDescendantsOfEntryTitles($this->entry->getId())
                                            )
                                        )
                                    )
                                ]);


        $report = $this->f->panel()
            ->report($this->entry->getTitle(), $sub_panels);

        return $this->r->render($report);
    }


    public function getEntry()
    {
        return $this->entry;
    }

    public function setEntry(Entry\ComponentEntry $entry)
    {
        $this->entry = $entry;
    }

    public function getEntries()
    {
        return $this->entries;
    }

    public function setEntries(Entry\ComponentEntries $entries)
    {
        $this->entries = $entries;
    }

    public function getParent()
    {
        return $this->parent;
    }

    public function setParent($parent)
    {
        $this->parent = $parent;
    }
}