NodeRetrievalGUI Class Reference

Inheritance diagram for NodeRetrievalGUI:

Collaboration diagram for NodeRetrievalGUI:

Public Member Functions
	executeCommand ()
	getNodeRetrieval ()

Protected Member Functions
	renderAsyncNodeChildren (int $parent_node_id)
	sendHtmlResponse (string $html)

Protected Attributes
const string	PARENT_NODE_ID_PARAMETER = 'parent_node_id'
const int	MAX_BRANCH_NODE_DEPTH = 2
UINodeRetrieval	$node_retrieval
URLBuilderToken	$async_node_id_parameter
Factory	$ui_factory
Renderer	$renderer
RequestWrapper	$get_request
GlobalHttpState	$http
ILIAS Refinery Factory	$refinery
ilObjMainMenuAccess	$access
ilCtrlInterface	$ctrl

Detailed Description

Author

Fabian Schmid fabia.nosp@m.n@sr.nosp@m..solu.nosp@m.tion.nosp@m.s

Definition at line 34 of file NodeRetrievalGUI.php.

Member Function Documentation

executeCommand()

NodeRetrievalGUI::executeCommand

(

)

Definition at line 98 of file NodeRetrievalGUI.php.

                                    : void
    {
        if (!$this->ctrl->isAsynch()) {
            throw new \RuntimeException(self::class . ' must be called asynchronously.');
        }
        if ($this->ctrl->getNextClass($this)) {
            throw new \LogicException(self::class . ' must be the only command class.');
        }
 
        if (!$this->get_request->has($this->async_node_id_parameter->getName())) {
            $this->sendHtmlResponse('');
            return;
        }
        $parent_node_id = (int) $this->get_request->retrieve(
            $this->async_node_id_parameter->getName(),
            $this->refinery->kindlyTo()->int(),
        );
        $this->renderAsyncNodeChildren($parent_node_id);
    }

References ILIAS\Repository\ctrl(), ILIAS\Repository\int(), ILIAS\Repository\refinery(), renderAsyncNodeChildren(), and sendHtmlResponse().

Here is the call graph for this function:

getNodeRetrieval()

NodeRetrievalGUI::getNodeRetrieval

(

)

Definition at line 118 of file NodeRetrievalGUI.php.

                                      : UINodeRetrieval
    {
        return $this->node_retrieval;
    }

References $node_retrieval.

renderAsyncNodeChildren()

NodeRetrievalGUI::renderAsyncNodeChildren ( int  $parent_node_id )

protected

Definition at line 123 of file NodeRetrievalGUI.php.

                                                                   : void
    {
        $child_node_iterator = $this->node_retrieval->getNodes(
            $this->ui_factory->input()->field()->node(),
            $this->ui_factory->symbol()->icon(),
            (string) $parent_node_id,
        );
 
        $html = '';
        foreach ($child_node_iterator as $node) {
            $html .= $this->renderer->renderAsync($node);
        }
        $this->sendHtmlResponse($html);
    }

References renderer(), and sendHtmlResponse().

Referenced by executeCommand().

Here is the call graph for this function:

Here is the caller graph for this function:

sendHtmlResponse()

NodeRetrievalGUI::sendHtmlResponse ( string  $html )

protected

Definition at line 138 of file NodeRetrievalGUI.php.

                                                     : void
    {
        $this->http->saveResponse(
            $this->http->response()
                       ->withHeader('Content-Type', 'text/html; charset=utf-8')
                       ->withBody(Streams::ofString($html))
        );
        $this->http->sendResponse();
        $this->http->close();
    }

References ILIAS\FileDelivery\http().

Referenced by executeCommand(), and renderAsyncNodeChildren().

Here is the call graph for this function:

Here is the caller graph for this function:

Field Documentation

$access

ilObjMainMenuAccess NodeRetrievalGUI::$access

protected

Definition at line 46 of file NodeRetrievalGUI.php.

$async_node_id_parameter

URLBuilderToken NodeRetrievalGUI::$async_node_id_parameter

protected

Definition at line 40 of file NodeRetrievalGUI.php.

$ctrl

ilCtrlInterface NodeRetrievalGUI::$ctrl

protected

Definition at line 47 of file NodeRetrievalGUI.php.

$get_request

RequestWrapper NodeRetrievalGUI::$get_request

protected

Definition at line 43 of file NodeRetrievalGUI.php.

$http

GlobalHttpState NodeRetrievalGUI::$http

protected

Definition at line 44 of file NodeRetrievalGUI.php.

$node_retrieval

UINodeRetrieval NodeRetrievalGUI::$node_retrieval

protected

Definition at line 39 of file NodeRetrievalGUI.php.

Referenced by getNodeRetrieval().

$refinery

ILIAS Refinery Factory NodeRetrievalGUI::$refinery

protected

Definition at line 45 of file NodeRetrievalGUI.php.

$renderer

Renderer NodeRetrievalGUI::$renderer

protected

Definition at line 42 of file NodeRetrievalGUI.php.

$ui_factory

Factory NodeRetrievalGUI::$ui_factory

protected

Definition at line 41 of file NodeRetrievalGUI.php.

MAX_BRANCH_NODE_DEPTH

const int NodeRetrievalGUI::MAX_BRANCH_NODE_DEPTH = 2

protected

Definition at line 37 of file NodeRetrievalGUI.php.

PARENT_NODE_ID_PARAMETER

const string NodeRetrievalGUI::PARENT_NODE_ID_PARAMETER = 'parent_node_id'

protected

Definition at line 36 of file NodeRetrievalGUI.php.

---

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

• components/ILIAS/StaticURL/classes/Shortlinks/NodeRetrievalGUI.php