ilKSDocumentationEntryGUI Class Reference

Collaboration diagram for ilKSDocumentationEntryGUI:

Public Member Functions
	__construct (ilSystemStyleDocumentationGUI $parent, Entry\ComponentEntry $entry, Entry\ComponentEntries $entries)
	ilKSDocumentationEntryGUI constructor. More...
	renderEntry ()
	getEntry ()
	setEntry (Entry\ComponentEntry $entry)
	getEntries ()
	setEntries (Entry\ComponentEntries $entries)
	getParent ()
	setParent ($parent)

Protected Attributes
	$entry = null
	$entries = null
	$ctrl
	$parent
	$f = null
	$r = null

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.ilKSDocumentationEntryGUI.php.

Constructor & Destructor Documentation

__construct()

ilKSDocumentationEntryGUI::__construct	(	ilSystemStyleDocumentationGUI	$parent,
		Entry\ComponentEntry	$entry,
		Entry\ComponentEntries	$entries
	)

ilKSDocumentationEntryGUI constructor.

Parameters

ilSystemStyleDocumentationGUI	$parent
Entry\ComponentEntry	$entry
Entry\ComponentEntries	$entries

Definition at line 52 of file class.ilKSDocumentationEntryGUI.php.

References $DIC, setEntries(), setEntry(), and setParent().

    {
        global $DIC;

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

        $this->setEntry($entry);
        $this->setEntries($entries);
        $this->setParent($parent);
        $this->ctrl = $DIC->ctrl();
    }

Here is the call graph for this function:

Member Function Documentation

getEntries()

ilKSDocumentationEntryGUI::getEntries

(

)

Returns

Entry

Definition at line 176 of file class.ilKSDocumentationEntryGUI.php.

References $entries.

    {
        return $this->entries;
    }

getEntry()

ilKSDocumentationEntryGUI::getEntry

(

)

Returns

Entry

Definition at line 160 of file class.ilKSDocumentationEntryGUI.php.

References $entry.

    {
        return $this->entry;
    }

getParent()

ilKSDocumentationEntryGUI::getParent

(

)

Returns

ilSystemStyleDocumentationGUI

Definition at line 192 of file class.ilKSDocumentationEntryGUI.php.

References $parent.

    {
        return $this->parent;
    }

renderEntry()

ilKSDocumentationEntryGUI::renderEntry

(

)

Returns

string

Definition at line 68 of file class.ilKSDocumentationEntryGUI.php.

References $code, $geshi, $name, $path, and $title.

Referenced by ilSystemStyleDocumentationGUI\show().

    {
        $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++;
                $example = "<div class='well'>" . $name() . "</div>"; //Executes function loaded in file indicated by 'path'
                $content_part_1 = $this->f->legacy($example);
                $code = str_replace("<?php\n", "", file_get_contents($path));
                $geshi = new GeSHi($code, "php");
                $content_part_2 = $this->f->legacy($geshi->parse_code());
                $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);
    }

Here is the caller graph for this function:

setEntries()

ilKSDocumentationEntryGUI::setEntries

(

Entry\ComponentEntries

$entries

)

Parameters

Entry\ComponentEntries

$entries

Definition at line 184 of file class.ilKSDocumentationEntryGUI.php.

References $entries.

Referenced by __construct().

    {
        $this->entries = $entries;
    }

Here is the caller graph for this function:

setEntry()

ilKSDocumentationEntryGUI::setEntry

(

Entry\ComponentEntry

$entry

)

Parameters

Entry\ComponentEntry

$entry

Definition at line 168 of file class.ilKSDocumentationEntryGUI.php.

References $entry.

Referenced by __construct().

    {
        $this->entry = $entry;
    }

Here is the caller graph for this function:

setParent()

ilKSDocumentationEntryGUI::setParent

(

$parent

)

Parameters

ilSystemStyleDocumentationGUI

$parent

Definition at line 200 of file class.ilKSDocumentationEntryGUI.php.

References $parent.

Referenced by __construct().

    {
        $this->parent = $parent;
    }

Here is the caller graph for this function:

Field Documentation

$ctrl

ilCtrl ilKSDocumentationEntryGUI::$ctrl

protected

Definition at line 29 of file class.ilKSDocumentationEntryGUI.php.

$entries

ilKSDocumentationEntryGUI::$entries = null

protected

Definition at line 24 of file class.ilKSDocumentationEntryGUI.php.

Referenced by getEntries(), and setEntries().

$entry

ilKSDocumentationEntryGUI::$entry = null

protected

Definition at line 19 of file class.ilKSDocumentationEntryGUI.php.

Referenced by getEntry(), and setEntry().

$f

ilKSDocumentationEntryGUI::$f = null

protected

Definition at line 39 of file class.ilKSDocumentationEntryGUI.php.

$parent

ilKSDocumentationEntryGUI::$parent

protected

Definition at line 34 of file class.ilKSDocumentationEntryGUI.php.

Referenced by getParent(), and setParent().

$r

ilKSDocumentationEntryGUI::$r = null

protected

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

---

The documentation for this class was generated from the following file:

• Services/Style/System/classes/Documentation/class.ilKSDocumentationEntryGUI.php