Collaboration diagram for ilSystemStyleDocumentationGUI:

Public Member Functions
	__construct ($read_only=false)
	ilSystemStyleDocumentationGUI constructor. More...

	executeCommand ()
	Execute command. More...

	show ()

	isReadOnly ()

	setIsReadOnly ($is_read_only)

Data Fields
const	ROOT_FACTORY_PATH = "./Services/Style/System/data/abstractDataFactory.php"

const	DATA_DIRECTORY = "./Services/Style/System/data"

const	DATA_FILE = "data.json"

Static Public Attributes
static	$DATA_PATH

Protected Member Functions
	addGotoLink ()

	parseEntries ()

	readEntries ()

Protected Attributes
	$tpl

	$ctrl

	$lng

	$is_read_only = false

Detailed Description

Author: Timon Amstutz timon.nosp@m..ams.nosp@m.tutz@.nosp@m.ilub.nosp@m..unib.nosp@m.e.ch

Version: $Id$*

Definition at line 14 of file class.ilSystemStyleDocumentationGUI.php.

Constructor & Destructor Documentation

◆ __construct()

ilSystemStyleDocumentationGUI::__construct ( $read_only = false )

ilSystemStyleDocumentationGUI constructor.

Parameters

bool | false $read_only

Definition at line 44 of file class.ilSystemStyleDocumentationGUI.php.

References $DIC, and setIsReadOnly().

     {
         global $DIC;
 
         $this->ctrl = $DIC->ctrl();
         $this->lng = $DIC->language();
         $this->tpl = $DIC["tpl"];
 
         $this->setIsReadOnly($read_only);
 
         self::$DATA_PATH= self::DATA_DIRECTORY . "/" . self::DATA_FILE;
     }

Here is the call graph for this function:

Member Function Documentation

◆ addGotoLink()

ilSystemStyleDocumentationGUI::addGotoLink ( )

protected

Definition at line 148 of file class.ilSystemStyleDocumentationGUI.php.

References $_GET.

Referenced by executeCommand().

     {
         $this->tpl->setPermanentLink("stys", $_GET["ref_id"], "_" . $_GET["node_id"] . "_"
                 . $_GET["skin_id"] . "_" . $_GET["style_id"]);
     }

Here is the caller graph for this function:

◆ executeCommand()

ilSystemStyleDocumentationGUI::executeCommand ( )

Execute command.

Definition at line 60 of file class.ilSystemStyleDocumentationGUI.php.

References addGotoLink(), and show().

     {
         $cmd = $this->ctrl->getCmd();
 
         switch ($cmd) {
             case 'parseEntries':
                 $this->$cmd();
                 $this->show();
                 break;
             default:
                 if ($this->is_read_only) {
                     $this->resetForReadOnly();
                 }
                 $this->addGotoLink();
                 $this->show();
                 break;
         }
     }

Here is the call graph for this function:

◆ isReadOnly()

ilSystemStyleDocumentationGUI::isReadOnly ( )

Returns: bool

Definition at line 186 of file class.ilSystemStyleDocumentationGUI.php.

References $is_read_only.

Referenced by show().

     {
         return $this->is_read_only;
     }

Here is the caller graph for this function:

◆ parseEntries()

ilSystemStyleDocumentationGUI::parseEntries ( )

protected

Returns: Crawler

Exceptions

Crawler

Definition at line 158 of file class.ilSystemStyleDocumentationGUI.php.

References ilUtil\sendSuccess().

     {
         $crawler = new Crawler\FactoriesCrawler();
         $entries = $crawler->crawlFactory(self::ROOT_FACTORY_PATH);
         file_put_contents(self::$DATA_PATH, json_encode($entries));
         ilUtil::sendSuccess($this->lng->txt("entries_reloaded"), true);
         return $entries;
     }

Here is the call graph for this function:

◆ readEntries()

ilSystemStyleDocumentationGUI::readEntries ( )

protected

Returns: Crawler

Definition at line 170 of file class.ilSystemStyleDocumentationGUI.php.

Referenced by show().

     {
         $entries_array = json_decode(file_get_contents(self::$DATA_PATH), true);
 
         $entries = new Crawler\Entry\ComponentEntries();
         foreach ($entries_array as $entry_array) {
             $entry = new Crawler\Entry\ComponentEntry($entry_array);
             $entries->addEntry($entry);
         }
 
         return $entries;
     }

Here is the caller graph for this function:

◆ setIsReadOnly()

ilSystemStyleDocumentationGUI::setIsReadOnly ( $is_read_only )

Parameters

bool $is_read_only

Definition at line 194 of file class.ilSystemStyleDocumentationGUI.php.

References $is_read_only.

Referenced by __construct().

     {
         $this->is_read_only = $is_read_only;
     }

Here is the caller graph for this function:

◆ show()

ilSystemStyleDocumentationGUI::show ( )

Definition at line 79 of file class.ilSystemStyleDocumentationGUI.php.

References $_GET, $DIC, $style, ilSystemStyleSkinContainer\generateFromId(), ilLinkButton\getInstance(), isReadOnly(), readEntries(), and ilKSDocumentationEntryGUI\renderEntry().

Referenced by executeCommand().

     {
         $entries = $this->readEntries();
         $content = "";
 
         //The button to parse the entries from code should only be shown in DEVMODE. Other users do not need that.
         if (DEVMODE == 1  && !$this->isReadOnly()) {
             $toolbar = new ilToolbarGUI();
             $reload_btn = ilLinkButton::getInstance();
             $reload_btn->setCaption($this->lng->txt('refresh_entries'), false);
             if ($_GET["node_id"]) {
                 $this->ctrl->saveParameter($this, "node_id");
             }
             $reload_btn->setUrl($this->ctrl->getLinkTarget($this, 'parseEntries'));
             $toolbar->addButtonInstance($reload_btn);
             $content .= $toolbar->getHTML();
         }
 
         $explorer = new ilKSDocumentationExplorerGUI($this, "entries", $entries, $_GET["node_id"]);
         $this->tpl->setLeftNavContent($explorer->getHTML());
         $entry_gui = new ilKSDocumentationEntryGUI($this, $explorer->getCurrentOpenedNode(), $entries);
         $content .= $entry_gui->renderEntry();
 
         $this->tpl->setContent($content);
     }