ILIAS\Wiki\Navigation\ImportantPageDBRepository Class Reference

Wiki page repo. More...

Collaboration diagram for ILIAS\Wiki\Navigation\ImportantPageDBRepository:

Public Member Functions
	__construct (InternalDataService $data, \ilDBInterface $db)
	getList (int $wiki_id)
	getListAsArray (int $wiki_id)
	add (int $wiki_id, int $page_id, int $nr=0, int $indent=0)
	isImportantPage (int $wiki_id, int $page_id)
	removeImportantPage (int $wiki_id, int $page_id)
	saveOrderingAndIndentation (int $wiki_id, array $a_ord, array $a_indent)
	getImportantPageIds (int $wiki_id)

Protected Member Functions
	getPageInfoFromRecord (array $rec)
	getMaxOrdNr (int $wiki_id)
	fixImportantPagesNumbering (int $wiki_id)

Protected Attributes
InternalDataService	$data
ilDBInterface	$db

Detailed Description

Wiki page repo.

Definition at line 29 of file ImportantPageDBRepository.php.

Constructor & Destructor Documentation

__construct()

ILIAS\Wiki\Navigation\ImportantPageDBRepository::__construct	(	InternalDataService	$data,
		\ilDBInterface	$db
	)

Definition at line 34 of file ImportantPageDBRepository.php.

References ILIAS\Wiki\Navigation\ImportantPageDBRepository\$data, and ILIAS\Wiki\Navigation\ImportantPageDBRepository\$db.

      {
        $this->data = $data;
        $this->db = $db;
    }

Member Function Documentation

add()

ILIAS\Wiki\Navigation\ImportantPageDBRepository::add	(	int	$wiki_id,
		int	$page_id,
		int	$nr = 0,
		int	$indent = 0
	)

Definition at line 89 of file ImportantPageDBRepository.php.

References ILIAS\Wiki\Navigation\ImportantPageDBRepository\getMaxOrdNr(), and ILIAS\Wiki\Navigation\ImportantPageDBRepository\isImportantPage().

     : void {
        if (!$this->isImportantPage($wiki_id, $page_id)) {
            if ($nr === 0) {
                $nr = $this->getMaxOrdNr($wiki_id) + 10;
            }

            $this->db->manipulate("INSERT INTO il_wiki_imp_pages " .
                "(wiki_id, ord, indent, page_id) VALUES (" .
                $this->db->quote($wiki_id, "integer") . "," .
                $this->db->quote($nr, "integer") . "," .
                $this->db->quote($indent, "integer") . "," .
                $this->db->quote($page_id, "integer") .
                ")");
        }
    }

Here is the call graph for this function:

fixImportantPagesNumbering()

ILIAS\Wiki\Navigation\ImportantPageDBRepository::fixImportantPagesNumbering ( int  $wiki_id )

protected

Definition at line 181 of file ImportantPageDBRepository.php.

References $q, and ILIAS\Wiki\Navigation\ImportantPageDBRepository\getListAsArray().

Referenced by ILIAS\Wiki\Navigation\ImportantPageDBRepository\removeImportantPage().

     : void {
        $ipages = $this->getListAsArray($wiki_id);
        // fix indentation: no 2 is allowed after a 0
        $c_indent = 0;
        foreach ($ipages as $k => $v) {
            if ($v["indent"] == 2 && $c_indent == 0) {
                $ipages[$k]["indent"] = 1;
            }
            $c_indent = $ipages[$k]["indent"];
        }

        $ord = 10;
        foreach ($ipages as $k => $v) {
            $this->db->manipulate(
                $q = "UPDATE il_wiki_imp_pages SET " .
                    " ord = " . $this->db->quote($ord, "integer") .
                    ", indent = " . $this->db->quote($v["indent"], "integer") .
                    " WHERE wiki_id = " . $this->db->quote($v["wiki_id"], "integer") .
                    " AND page_id = " . $this->db->quote($v["page_id"], "integer")
            );
            $ord += 10;
        }
    }

Here is the call graph for this function:

Here is the caller graph for this function:

getImportantPageIds()

ILIAS\Wiki\Navigation\ImportantPageDBRepository::getImportantPageIds

(

int

$wiki_id

)

Definition at line 207 of file ImportantPageDBRepository.php.

References ILIAS\Repository\int().

                                                     : array
    {
        $set = $this->db->query(
            "SELECT DISTINCT page_id FROM il_wiki_imp_pages WHERE " .
            " wiki_id = " . $this->db->quote($wiki_id, "integer")
        );
        $ids = [];
        while ($rec = $this->db->fetchAssoc($set)) {
            $ids[] = (int) $rec["page_id"];
        }
        return $ids;
    }

Here is the call graph for this function:

getList()

ILIAS\Wiki\Navigation\ImportantPageDBRepository::getList

(

int

$wiki_id

)

Returns

iterable<ImportantPage>

Definition at line 54 of file ImportantPageDBRepository.php.

References ILIAS\Wiki\Navigation\ImportantPageDBRepository\getPageInfoFromRecord().

Referenced by ILIAS\Wiki\Navigation\ImportantPageDBRepository\getListAsArray().

                                         : \Iterator
    {
        $set = $this->db->query(
            "SELECT * FROM il_wiki_imp_pages WHERE " .
            " wiki_id = " . $this->db->quote($wiki_id, "integer") . " ORDER BY ord ASC "
        );
        while ($rec = $this->db->fetchAssoc($set)) {
            yield $this->getPageInfoFromRecord($rec);
        }
    }

Here is the call graph for this function:

Here is the caller graph for this function:

getListAsArray()

ILIAS\Wiki\Navigation\ImportantPageDBRepository::getListAsArray

(

int

$wiki_id

)

Definition at line 65 of file ImportantPageDBRepository.php.

References ILIAS\Wiki\Navigation\ImportantPageDBRepository\getList().

Referenced by ILIAS\Wiki\Navigation\ImportantPageDBRepository\fixImportantPagesNumbering(), and ILIAS\Wiki\Navigation\ImportantPageDBRepository\saveOrderingAndIndentation().

                                                : array
    {
        $ipages = [];
        foreach ($this->getList($wiki_id) as $ip) {
            $ipages[$ip->getId()]["page_id"] = $ip->getId();
            $ipages[$ip->getId()]["ord"] = $ip->getOrder();
            $ipages[$ip->getId()]["indent"] = $ip->getIndent();
            $ipages[$ip->getId()]["wiki_id"] = $wiki_id;
        }
        return $ipages;
    }

Here is the call graph for this function:

Here is the caller graph for this function:

getMaxOrdNr()

ILIAS\Wiki\Navigation\ImportantPageDBRepository::getMaxOrdNr ( int  $wiki_id )

protected

Definition at line 77 of file ImportantPageDBRepository.php.

Referenced by ILIAS\Wiki\Navigation\ImportantPageDBRepository\add().

     : int {
        $set = $this->db->query(
            "SELECT MAX(ord) as m FROM il_wiki_imp_pages WHERE " .
            " wiki_id = " . $this->db->quote($wiki_id, "integer")
        );
        $rec = $this->db->fetchAssoc($set);
        return (int) $rec["m"];
    }

Here is the caller graph for this function:

getPageInfoFromRecord()

ILIAS\Wiki\Navigation\ImportantPageDBRepository::getPageInfoFromRecord ( array  $rec )

protected

Definition at line 42 of file ImportantPageDBRepository.php.

Referenced by ILIAS\Wiki\Navigation\ImportantPageDBRepository\getList().

                                                        : ImportantPage
    {
        return $this->data->importantPage(
            (int) $rec["page_id"],
            (int) $rec["ord"],
            (int) $rec["indent"]
        );
    }

Here is the caller graph for this function:

isImportantPage()

ILIAS\Wiki\Navigation\ImportantPageDBRepository::isImportantPage	(	int	$wiki_id,
		int	$page_id
	)

Definition at line 110 of file ImportantPageDBRepository.php.

Referenced by ILIAS\Wiki\Navigation\ImportantPageDBRepository\add().

     : bool {
        $set = $this->db->query(
            "SELECT * FROM il_wiki_imp_pages WHERE " .
            " wiki_id = " . $this->db->quote($wiki_id, "integer") . " AND " .
            " page_id = " . $this->db->quote($page_id, "integer")
        );
        if ($this->db->fetchAssoc($set)) {
            return true;
        }
        return false;
    }

Here is the caller graph for this function:

removeImportantPage()

ILIAS\Wiki\Navigation\ImportantPageDBRepository::removeImportantPage	(	int	$wiki_id,
		int	$page_id
	)

Definition at line 125 of file ImportantPageDBRepository.php.

References ILIAS\Wiki\Navigation\ImportantPageDBRepository\fixImportantPagesNumbering().

     : void {
        $this->db->manipulate(
            "DELETE FROM il_wiki_imp_pages WHERE "
            . " wiki_id = " . $this->db->quote($wiki_id, "integer")
            . " AND page_id = " . $this->db->quote($page_id, "integer")
        );
        $this->fixImportantPagesNumbering($wiki_id);
    }

Here is the call graph for this function:

saveOrderingAndIndentation()

ILIAS\Wiki\Navigation\ImportantPageDBRepository::saveOrderingAndIndentation	(	int	$wiki_id,
		array	$a_ord,
		array	$a_indent
	)

Definition at line 137 of file ImportantPageDBRepository.php.

References $q, ILIAS\Wiki\Navigation\ImportantPageDBRepository\getListAsArray(), ILIAS\Repository\int(), and ilArrayUtil\sortArray().

     : bool {
        $ipages = $this->getListAsArray($wiki_id);

        foreach ($ipages as $k => $v) {
            if (isset($a_ord[$v["page_id"]])) {
                $ipages[$k]["ord"] = (int) $a_ord[$v["page_id"]];
            }
            if (isset($a_indent[$v["page_id"]])) {
                $ipages[$k]["indent"] = (int) $a_indent[$v["page_id"]];
            }
        }
        $ipages = \ilArrayUtil::sortArray($ipages, "ord", "asc", true);

        // fix indentation: no 2 is allowed after a 0
        $c_indent = 0;
        $fixed = false;
        foreach ($ipages as $k => $v) {
            if ($v["indent"] == 2 && $c_indent == 0) {
                $ipages[$k]["indent"] = 1;
                $fixed = true;
            }
            $c_indent = $ipages[$k]["indent"];
        }

        $ord = 10;
        reset($ipages);
        foreach ($ipages as $k => $v) {
            $this->db->manipulate(
                $q = "UPDATE il_wiki_imp_pages SET " .
                    " ord = " . $this->db->quote($ord, "integer") . "," .
                    " indent = " . $this->db->quote($v["indent"], "integer") .
                    " WHERE wiki_id = " . $this->db->quote($wiki_id, "integer") .
                    " AND page_id = " . $this->db->quote($v["page_id"], "integer")
            );
            $ord += 10;
        }

        return $fixed;
    }

Here is the call graph for this function:

Field Documentation

$data

InternalDataService ILIAS\Wiki\Navigation\ImportantPageDBRepository::$data

protected

Definition at line 31 of file ImportantPageDBRepository.php.

Referenced by ILIAS\Wiki\Navigation\ImportantPageDBRepository\__construct().

$db

ilDBInterface ILIAS\Wiki\Navigation\ImportantPageDBRepository::$db

protected

Definition at line 32 of file ImportantPageDBRepository.php.

Referenced by ILIAS\Wiki\Navigation\ImportantPageDBRepository\__construct().

---

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

• components/ILIAS/Wiki/Navigation/ImportantPageDBRepository.php