ILIAS\Wiki\WikiGUIRequest Class Reference

Collaboration diagram for ILIAS\Wiki\WikiGUIRequest:

Public Member Functions
	__construct (\ILIAS\HTTP\Services $http, \ILIAS\Refinery\Factory $refinery, ?array $passed_query_params=null, ?array $passed_post_data=null)
	getRefId ()
	getOldNr ()
	getUserId ()
	getWikiPageId ()
	getWikiPageIds ()
	getNotification ()
	getAssignmentId ()
	getWithComments ()
	getPage ()
	getFromPage ()
	getNewType ()
	getSearchString ()
	getSearchTerm ()
	getTerm ()
	getUserIds ()
	getMarks ()
	getComments ()
	getStatus ()
	getImportantPageId ()
	getImportantPageIds ()
	getPrintOrdering ()
	getStyleId ()
	getImportantPageOrdering ()
	getImportantPageIndentation ()
	getFormat ()
	getPageTemplateId ()
	getObjId ()
	getSelectedPrintType ()
	getIds ()
	getAllIds ()
	getNewPages ()
	getAddToPage ()
	getEmptyPageTemplate ()
	getStatFig ()
	getStatTfr ()
	getStatScp ()
	getTranslation ()
	getPrintPageSel ()

Data Fields
trait	BaseGUIRequest
	Base gui request wrapper. More...

Detailed Description

Definition at line 23 of file WikiGUIRequest.php.

Constructor & Destructor Documentation

__construct()

ILIAS\Wiki\WikiGUIRequest::__construct	(	\ILIAS\HTTP\Services	$http,
		\ILIAS\Refinery\Factory	$refinery,
		?array	$passed_query_params = null,
		?array	$passed_post_data = null
	)

Definition at line 27 of file WikiGUIRequest.php.

      {
        $this->initRequest(
            $http,
            $refinery,
            $passed_query_params,
            $passed_post_data
        );
    }

References ILIAS\UI\examples\Layout\Page\Mail\$refinery, and ILIAS\Repository\initRequest().

Here is the call graph for this function:

Member Function Documentation

getAddToPage()

ILIAS\Wiki\WikiGUIRequest::getAddToPage

(

)

Returns

int[]

Definition at line 227 of file WikiGUIRequest.php.

                                  : array
    {
        return $this->intArray("add_to_page");
    }

References ILIAS\Repository\intArray().

Here is the call graph for this function:

getAllIds()

ILIAS\Wiki\WikiGUIRequest::getAllIds

(

)

Returns

int[]

Definition at line 215 of file WikiGUIRequest.php.

                               : array
    {
        return $this->intArray("all_ids");
    }

References ILIAS\Repository\intArray().

Here is the call graph for this function:

getAssignmentId()

ILIAS\Wiki\WikiGUIRequest::getAssignmentId

(

)

Definition at line 72 of file WikiGUIRequest.php.

                                     : int
    {
        return $this->int("ass");
    }

References ILIAS\Repository\int().

Here is the call graph for this function:

getComments()

ILIAS\Wiki\WikiGUIRequest::getComments

(

)

Returns

string[]

Definition at line 125 of file WikiGUIRequest.php.

                                 : array
    {
        return $this->strArray("lcomment");
    }

References ILIAS\Repository\strArray().

Here is the call graph for this function:

getEmptyPageTemplate()

ILIAS\Wiki\WikiGUIRequest::getEmptyPageTemplate

(

)

Definition at line 232 of file WikiGUIRequest.php.

                                          : int
    {
        return $this->int("empty_page_templ");
    }

References ILIAS\Repository\int().

Here is the call graph for this function:

getFormat()

ILIAS\Wiki\WikiGUIRequest::getFormat

(

)

Definition at line 184 of file WikiGUIRequest.php.

                               : string
    {
        return trim($this->str("format"));
    }

References ILIAS\Repository\str().

Here is the call graph for this function:

getFromPage()

ILIAS\Wiki\WikiGUIRequest::getFromPage

(

)

Definition at line 87 of file WikiGUIRequest.php.

                                 : string
    {
        return (string) $this->raw("from_page");
    }

References ILIAS\Repository\raw().

Here is the call graph for this function:

getIds()

ILIAS\Wiki\WikiGUIRequest::getIds

(

)

Returns

int[]

Definition at line 209 of file WikiGUIRequest.php.

                            : array
    {
        return $this->intArray("id");
    }

References ILIAS\Repository\intArray().

Here is the call graph for this function:

getImportantPageId()

ILIAS\Wiki\WikiGUIRequest::getImportantPageId

(

)

Definition at line 136 of file WikiGUIRequest.php.

                                        : int
    {
        return $this->int("imp_page_id");
    }

References ILIAS\Repository\int().

Here is the call graph for this function:

getImportantPageIds()

ILIAS\Wiki\WikiGUIRequest::getImportantPageIds

(

)

Returns

int[]

Definition at line 142 of file WikiGUIRequest.php.

                                         : array
    {
        return $this->intArray("imp_page_id");
    }

References ILIAS\Repository\intArray().

Here is the call graph for this function:

getImportantPageIndentation()

ILIAS\Wiki\WikiGUIRequest::getImportantPageIndentation

(

)

Definition at line 179 of file WikiGUIRequest.php.

                                                 : array
    {
        return $this->intArray("indent");
    }

References ILIAS\Repository\intArray().

Here is the call graph for this function:

getImportantPageOrdering()

ILIAS\Wiki\WikiGUIRequest::getImportantPageOrdering

(

)

Definition at line 174 of file WikiGUIRequest.php.

                                              : array
    {
        return $this->intArray("ord");
    }

References ILIAS\Repository\intArray().

Here is the call graph for this function:

getMarks()

ILIAS\Wiki\WikiGUIRequest::getMarks

(

)

Returns

string[]

Definition at line 119 of file WikiGUIRequest.php.

                              : array
    {
        return $this->strArray("mark");
    }

References ILIAS\Repository\strArray().

Here is the call graph for this function:

getNewPages()

ILIAS\Wiki\WikiGUIRequest::getNewPages

(

)

Returns

int[]

Definition at line 221 of file WikiGUIRequest.php.

                                 : array
    {
        return $this->intArray("new_pages");
    }

References ILIAS\Repository\intArray().

Here is the call graph for this function:

getNewType()

ILIAS\Wiki\WikiGUIRequest::getNewType

(

)

Definition at line 92 of file WikiGUIRequest.php.

                                : string
    {
        return $this->str("new_type");
    }

References ILIAS\Repository\str().

Here is the call graph for this function:

getNotification()

ILIAS\Wiki\WikiGUIRequest::getNotification

(

)

Definition at line 67 of file WikiGUIRequest.php.

                                     : int
    {
        return $this->int("ntf");
    }

References ILIAS\Repository\int().

Here is the call graph for this function:

getObjId()

ILIAS\Wiki\WikiGUIRequest::getObjId

(

)

Definition at line 198 of file WikiGUIRequest.php.

                              : int
    {
        return $this->int("obj_id");
    }

References ILIAS\Repository\int().

Here is the call graph for this function:

getOldNr()

ILIAS\Wiki\WikiGUIRequest::getOldNr

(

)

Definition at line 46 of file WikiGUIRequest.php.

                              : int
    {
        return $this->int("old_nr");
    }

References ILIAS\Repository\int().

Here is the call graph for this function:

getPage()

ILIAS\Wiki\WikiGUIRequest::getPage

(

)

Definition at line 82 of file WikiGUIRequest.php.

                             : string
    {
        return (string) $this->raw("page");
    }

References ILIAS\Repository\raw().

Here is the call graph for this function:

getPageTemplateId()

ILIAS\Wiki\WikiGUIRequest::getPageTemplateId

(

)

Definition at line 189 of file WikiGUIRequest.php.

                                       : int
    {
        $templ_id = $this->int("page_templ");
        if ($templ_id === 0) {
            $templ_id = $this->int("templ_page_id");
        }
        return $templ_id;
    }

References ILIAS\Repository\int().

Here is the call graph for this function:

getPrintOrdering()

ILIAS\Wiki\WikiGUIRequest::getPrintOrdering

(

)

Returns

int[]

Definition at line 148 of file WikiGUIRequest.php.

                                      : array
    {
        if ($this->isArray("wordr")) {
            return $this->intArray("wordr");
        }
 
        $wordr = $this->str("wordr");
        if ($wordr !== "") {
            $page_ids = array_values(array_unique(array_filter(
                array_map("intval", explode(",", $wordr)),
                static fn(int $page_id): bool => $page_id > 0
            )));
            $ordering = [];
            foreach ($page_ids as $order => $page_id) {
                $ordering[$page_id] = ($order + 1) * 10;
            }
            return $ordering;
        }
        return [];
    }

References ILIAS\Repository\intArray(), ILIAS\Repository\isArray(), and ILIAS\Repository\str().

Here is the call graph for this function:

getPrintPageSel()

ILIAS\Wiki\WikiGUIRequest::getPrintPageSel

(

)

Definition at line 257 of file WikiGUIRequest.php.

                                     : int
    {
        return $this->int("print_page_sel");
    }

References ILIAS\Repository\int().

Here is the call graph for this function:

getRefId()

ILIAS\Wiki\WikiGUIRequest::getRefId

(

)

Definition at line 41 of file WikiGUIRequest.php.

                              : int
    {
        return $this->int("ref_id");
    }

References ILIAS\Repository\int().

Here is the call graph for this function:

getSearchString()

ILIAS\Wiki\WikiGUIRequest::getSearchString

(

)

Definition at line 97 of file WikiGUIRequest.php.

                                     : string
    {
        return $this->str("srcstring");
    }

References ILIAS\Repository\str().

Here is the call graph for this function:

getSearchTerm()

ILIAS\Wiki\WikiGUIRequest::getSearchTerm

(

)

Definition at line 102 of file WikiGUIRequest.php.

                                   : string
    {
        return trim($this->str("search_term"));
    }

References ILIAS\Repository\str().

Here is the call graph for this function:

getSelectedPrintType()

ILIAS\Wiki\WikiGUIRequest::getSelectedPrintType

(

)

Definition at line 203 of file WikiGUIRequest.php.

                                          : string
    {
        return $this->str("sel_type");
    }

References ILIAS\Repository\str().

Here is the call graph for this function:

getStatFig()

ILIAS\Wiki\WikiGUIRequest::getStatFig

(

)

Definition at line 237 of file WikiGUIRequest.php.

                                : int
    {
        return $this->int("fig");
    }

References ILIAS\Repository\int().

Here is the call graph for this function:

getStatScp()

ILIAS\Wiki\WikiGUIRequest::getStatScp

(

)

Definition at line 247 of file WikiGUIRequest.php.

                                : int
    {
        return $this->int("scp");
    }

References ILIAS\Repository\int().

Here is the call graph for this function:

getStatTfr()

ILIAS\Wiki\WikiGUIRequest::getStatTfr

(

)

Definition at line 242 of file WikiGUIRequest.php.

                                : string
    {
        return $this->str("tfr");
    }

References ILIAS\Repository\str().

Here is the call graph for this function:

getStatus()

ILIAS\Wiki\WikiGUIRequest::getStatus

(

)

Returns

string[]

Definition at line 131 of file WikiGUIRequest.php.

                               : array
    {
        return $this->strArray("status");
    }

References ILIAS\Repository\strArray().

Here is the call graph for this function:

getStyleId()

ILIAS\Wiki\WikiGUIRequest::getStyleId

(

)

Definition at line 169 of file WikiGUIRequest.php.

                                : int
    {
        return $this->int("style_id");
    }

References ILIAS\Repository\int().

Here is the call graph for this function:

getTerm()

ILIAS\Wiki\WikiGUIRequest::getTerm

(

)

Definition at line 107 of file WikiGUIRequest.php.

                             : string
    {
        return trim($this->str("term"));
    }

References ILIAS\Repository\str().

Here is the call graph for this function:

getTranslation()

ILIAS\Wiki\WikiGUIRequest::getTranslation

(

)

Definition at line 252 of file WikiGUIRequest.php.

                                    : string
    {
        return $this->str("transl");
    }

References ILIAS\Repository\str().

Here is the call graph for this function:

getUserId()

ILIAS\Wiki\WikiGUIRequest::getUserId

(

)

Definition at line 51 of file WikiGUIRequest.php.

                               : int
    {
        return $this->int("user");
    }

References ILIAS\Repository\int().

Here is the call graph for this function:

getUserIds()

ILIAS\Wiki\WikiGUIRequest::getUserIds

(

)

Returns

int[]

Definition at line 113 of file WikiGUIRequest.php.

                                : array
    {
        return $this->intArray("user_id");
    }

References ILIAS\Repository\intArray().

Here is the call graph for this function:

getWikiPageId()

ILIAS\Wiki\WikiGUIRequest::getWikiPageId

(

)

Definition at line 56 of file WikiGUIRequest.php.

                                   : int
    {
        return $this->int("wpg_id");
    }

References ILIAS\Repository\int().

Here is the call graph for this function:

getWikiPageIds()

ILIAS\Wiki\WikiGUIRequest::getWikiPageIds

(

)

Returns

int[]

Definition at line 62 of file WikiGUIRequest.php.

                                    : array
    {
        return $this->intArray("obj_id");
    }

References ILIAS\Repository\intArray().

Here is the call graph for this function:

getWithComments()

ILIAS\Wiki\WikiGUIRequest::getWithComments

(

)

Definition at line 77 of file WikiGUIRequest.php.

                                     : bool
    {
        return $this->int("with_comments");
    }

References ILIAS\Repository\int().

Here is the call graph for this function:

Field Documentation

BaseGUIRequest

trait ILIAS\Repository::BaseGUIRequest

Base gui request wrapper.

This class processes all request parameters which are not handled by form classes already. POST overwrites GET with the same name. POST/GET parameters may be passed to the class for testing purposes.

Author

Alexander Killing killi.nosp@m.ng@l.nosp@m.eifos.nosp@m..de

Definition at line 33 of file trait.BaseGUIRequest.php.

---

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

• components/ILIAS/Wiki/Main/WikiGUIRequest.php