Inheritance diagram for ILIAS\Wiki\Page\PagesTableBuilder:

Collaboration diagram for ILIAS\Wiki\Page\PagesTableBuilder:

Public Member Functions
	__construct (protected InternalDomainService $domain, protected InternalGUIService $gui, protected int $ref_id, protected string $mode, protected int $page_id, protected string $lang, object $parent_gui, string $parent_cmd)

Public Member Functions inherited from ILIAS\Repository\Table\CommonTableBuilder
	__construct (protected object $parent_gui, protected string $parent_cmd, bool $numeric_ids=true)

	getTable ()

Data Fields
const	MODE_ALL_PAGES = "all"

const	MODE_NEW_PAGES = "new"

const	MODE_POPULAR_PAGES = "popular"

const	MODE_WHAT_LINKS_HERE = "what_links"

const	MODE_ORPHANED_PAGES = "orphaned"

Protected Member Functions
	getId ()

	getTitle ()

	getRetrieval ()

	transformRow (array $data_row)
	transform raw data array to table row data array More...

	build (TableAdapterGUI $table)

	getLanguageLabel (string $language)

	getTranslations (int $page_id)

Protected Member Functions inherited from ILIAS\Repository\Table\CommonTableBuilder
	getId ()

	getTitle ()

	getRetrieval ()

	getNamespace ()

	getOrderingCommand ()

	activeAction (string $action, array $data_row)

	transformRow (array $data_row)
	transform raw data array to table row data array More...

	build (TableAdapterGUI $table)

Protected Attributes
Translations	$translations

PageManager	$page_manager

Protected Attributes inherited from ILIAS\Repository\Table\CommonTableBuilder
TableAdapterGUI	$table

Detailed Description

Definition at line 30 of file PagesTableBuilder.php.

Constructor & Destructor Documentation

◆ __construct()

ILIAS\Wiki\Page\PagesTableBuilder::__construct	(	protected InternalDomainService	$domain,
		protected InternalGUIService	$gui,
		protected int	$ref_id,
		protected string	$mode,
		protected int	$page_id,
		protected string	$lang,
		object	$parent_gui,
		string	$parent_cmd
	)

Definition at line 41 of file PagesTableBuilder.php.

      {
        $this->page_manager = $this->domain->page()->page($ref_id);
        $this->translations = $this->domain->wiki()->translation($ref_id);
        parent::__construct($parent_gui, $parent_cmd);
    }

References ILIAS\GlobalScreen\Provider\__construct().

Here is the call graph for this function:

Member Function Documentation

◆ build()

ILIAS\Wiki\Page\PagesTableBuilder::build ( TableAdapterGUI $table )

protected

Reimplemented from ILIAS\Repository\Table\CommonTableBuilder.

Definition at line 129 of file PagesTableBuilder.php.

                                                    : TableAdapterGUI
    {
        $lng = $this->domain->lng();
        $translation_active = $this->translations->getContentTranslationActivated();
 
        switch ($this->mode) {
            case self::MODE_NEW_PAGES:
                $table = $table
                    ->dateColumn("created", $lng->txt("created"), true)
                    ->linkColumn("title", $lng->txt("wiki_page"), true);
                if ($translation_active) {
                    $table = $table->textColumn("lang", $lng->txt("language"));
                }
                return $table->textColumn("user_sort", $lng->txt("wiki_created_by"), true);
 
            case self::MODE_POPULAR_PAGES:
                $table = $table
                    ->linkColumn("title", $lng->txt("wiki_page"), true);
                if ($translation_active) {
                    $table = $table->textColumn("lang", $lng->txt("language"));
                }
                return $table->textColumn("cnt", $lng->txt("wiki_page_hits"), true);
 
            case self::MODE_ORPHANED_PAGES:
                $table = $table->linkColumn("title", $lng->txt("wiki_page"), true);
                if ($translation_active) {
                    $table = $table->textColumn("lang", $lng->txt("language"));
                }
                return $table;
 
            default:
                $table = $table
                    ->linkColumn("title", $lng->txt("wiki_page"), true)
                    ->dateColumn("date", $lng->txt("wiki_last_changed"), true);
                if ($translation_active && $this->mode !== self::MODE_WHAT_LINKS_HERE) {
                    $table = $table->textColumn("languages", $lng->txt("wiki_translations"));
                }
                return $table->textColumn("user_sort", $lng->txt("wiki_last_changed_by"), true);
        }
    }

References $lng, ILIAS\Repository\Table\CommonTableBuilder\$table, ILIAS\Repository\Table\TableAdapterGUI\dateColumn(), ILIAS\Repository\Table\TableAdapterGUI\linkColumn(), ILIAS\Wiki\Page\PagesTableBuilder\MODE_NEW_PAGES, ILIAS\Wiki\Page\PagesTableBuilder\MODE_ORPHANED_PAGES, ILIAS\Wiki\Page\PagesTableBuilder\MODE_POPULAR_PAGES, and ILIAS\Repository\Table\TableAdapterGUI\textColumn().

Here is the call graph for this function:

◆ getId()

ILIAS\Wiki\Page\PagesTableBuilder::getId ( )

protected

Reimplemented from ILIAS\Repository\Table\CommonTableBuilder.

Definition at line 56 of file PagesTableBuilder.php.

                              : string
    {
        return "wiki_pages_" . $this->mode;
    }

◆ getLanguageLabel()

ILIAS\Wiki\Page\PagesTableBuilder::getLanguageLabel ( string $language )

protected

Definition at line 170 of file PagesTableBuilder.php.

                                                         : string
    {
        $language = $language === "-"
            ? $this->translations->getBaseLanguage()
            : $language;
        return $this->domain->lng()->txt("meta_l_" . $language);
    }

Referenced by ILIAS\Wiki\Page\PagesTableBuilder\transformRow().

Here is the caller graph for this function:

◆ getRetrieval()

ILIAS\Wiki\Page\PagesTableBuilder::getRetrieval ( )

protected

Reimplemented from ILIAS\Repository\Table\CommonTableBuilder.

Definition at line 73 of file PagesTableBuilder.php.

                                     : RetrievalInterface
    {
        return $this->domain->page()->pagesRetrieval(
            $this->ref_id,
            $this->mode,
            $this->page_id,
            $this->lang
        );
    }

◆ getTitle()

ILIAS\Wiki\Page\PagesTableBuilder::getTitle ( )

protected

Reimplemented from ILIAS\Repository\Table\CommonTableBuilder.

Definition at line 61 of file PagesTableBuilder.php.

                                 : string
    {
        if ($this->mode === self::MODE_WHAT_LINKS_HERE) {
            return sprintf(
                $this->domain->lng()->txt("wiki_what_links_to_page"),
                \ilWikiPage::lookupTitle($this->page_id)
            );
        }
 
        return $this->domain->lng()->txt("wiki_" . $this->mode . "_pages");
    }

References ilWikiPage\lookupTitle().

Here is the call graph for this function:

◆ getTranslations()

ILIAS\Wiki\Page\PagesTableBuilder::getTranslations ( int $page_id )

protected

Definition at line 178 of file PagesTableBuilder.php.

                                                    : string
    {
        $languages = array_filter(
            $this->page_manager->getLanguages($page_id),
            fn(string $language): bool => in_array(
                $language,
                array_map(
                    fn($language): string => $language->getLanguageCode(),
                    $this->translations->getLanguages()
                ),
                true
            )
        );
 
        return implode(", ", $languages);
    }

Referenced by ILIAS\Wiki\Page\PagesTableBuilder\transformRow().

Here is the caller graph for this function:

◆ transformRow()

ILIAS\Wiki\Page\PagesTableBuilder::transformRow ( array $data_row )

protected

transform raw data array to table row data array

Reimplemented from ILIAS\Repository\Table\CommonTableBuilder.

Definition at line 83 of file PagesTableBuilder.php.

                                                    : array
    {
        $row = [
            "id" => $data_row["id"],
            "title" => $this->gui->ui()->factory()->link()->standard(
                $data_row["title"],
                $this->page_manager->getPermaLink($data_row["id"], $data_row["lang"] ?? "")
            )
        ];
 
        if ($this->mode === self::MODE_NEW_PAGES) {
            $row["created"] = new \DateTimeImmutable($data_row["created"]);
            if ($this->translations->getContentTranslationActivated()) {
                $row["lang"] = $this->getLanguageLabel($data_row["lang"]);
            }
        } elseif ($this->mode === self::MODE_POPULAR_PAGES) {
            $row["cnt"] = $data_row["cnt"];
            if ($this->translations->getContentTranslationActivated()) {
                $row["lang"] = $this->getLanguageLabel($data_row["lang"]);
            }
        } elseif ($this->mode === self::MODE_ORPHANED_PAGES) {
            $row["date"] = new \DateTimeImmutable($data_row["date"]);
            if ($this->translations->getContentTranslationActivated()) {
                $row["lang"] = $this->getLanguageLabel($data_row["lang"]);
            }
        } elseif ($this->mode !== self::MODE_WHAT_LINKS_HERE) {
            $row["date"] = new \DateTimeImmutable($data_row["date"]);
            if ($this->translations->getContentTranslationActivated()) {
                $row["languages"] = $this->getTranslations($data_row["id"]);
            }
        } else {
            $row["date"] = new \DateTimeImmutable($data_row["date"]);
        }
 
        if (isset($data_row["user"])) {
            $row["user_sort"] = \ilUserUtil::getNamePresentation(
                $data_row["user"],
                true,
                true,
                $this->gui->ctrl()->getLinkTarget($this->parent_gui, $this->parent_cmd)
            );
        }
 
        return $row;
    }

References ILIAS\Wiki\Page\PagesTableBuilder\getLanguageLabel(), ilUserUtil\getNamePresentation(), and ILIAS\Wiki\Page\PagesTableBuilder\getTranslations().

Here is the call graph for this function:

Field Documentation

◆ $page_manager

PageManager ILIAS\Wiki\Page\PagesTableBuilder::$page_manager

protected

Definition at line 39 of file PagesTableBuilder.php.

◆ $translations

Translations ILIAS\Wiki\Page\PagesTableBuilder::$translations

protected

Definition at line 38 of file PagesTableBuilder.php.

◆ MODE_ALL_PAGES

const ILIAS\Wiki\Page\PagesTableBuilder::MODE_ALL_PAGES = "all"

Definition at line 32 of file PagesTableBuilder.php.

◆ MODE_NEW_PAGES

const ILIAS\Wiki\Page\PagesTableBuilder::MODE_NEW_PAGES = "new"

Definition at line 33 of file PagesTableBuilder.php.

Referenced by ILIAS\Wiki\Page\PagesTableBuilder\build().

◆ MODE_ORPHANED_PAGES

const ILIAS\Wiki\Page\PagesTableBuilder::MODE_ORPHANED_PAGES = "orphaned"

Definition at line 36 of file PagesTableBuilder.php.

Referenced by ILIAS\Wiki\Page\PagesTableBuilder\build().

◆ MODE_POPULAR_PAGES

const ILIAS\Wiki\Page\PagesTableBuilder::MODE_POPULAR_PAGES = "popular"

Definition at line 34 of file PagesTableBuilder.php.

Referenced by ILIAS\Wiki\Page\PagesTableBuilder\build().

◆ MODE_WHAT_LINKS_HERE

const ILIAS\Wiki\Page\PagesTableBuilder::MODE_WHAT_LINKS_HERE = "what_links"

Definition at line 35 of file PagesTableBuilder.php.

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

components/ILIAS/Wiki/Page/PagesTableBuilder.php

Public Member Functions

Data Fields

Protected Member Functions

Protected Attributes

Detailed Description

Constructor & Destructor Documentation

◆ __construct()

Member Function Documentation

◆ build()

◆ getId()

◆ getLanguageLabel()

◆ getRetrieval()

◆ getTitle()

◆ getTranslations()

◆ transformRow()

Field Documentation

◆ $page_manager

◆ $translations

◆ MODE_ALL_PAGES

◆ MODE_NEW_PAGES

◆ MODE_ORPHANED_PAGES

◆ MODE_POPULAR_PAGES

◆ MODE_WHAT_LINKS_HERE