Inheritance diagram for ilUIMarkdownPreviewGUI:

Collaboration diagram for ilUIMarkdownPreviewGUI:

Public Member Functions
	__construct ()

	executeCommand ()

	getAsyncUrl ()
	Returns an endpoint where the clientside input can submit it's value to and receive the current preview. More...

	getParameterName ()
	Returns the name of the $_POST variable the asynchronous input submits to. More...

	renderAsync ()
	Sends a JSON-response with the rendered preview of the submitted input. More...

	render (string $markdown_text)
	Returns the rendered preview of the given string. More...

Protected Member Functions
	sendResponse (string $html)

Protected Attributes
const	CMD_RENDER_ASYNC = 'renderAsync'

Refinery	$refinery

ilCtrlInterface	$ctrl

HTTPServices	$http

Detailed Description

Author: Thibeau Fuhrer thibe.nosp@m.au@s.nosp@m.r.sol.nosp@m.utio.nosp@m.ns AutoloadingIssuesInspection

Definition at line 31 of file class.ilUIMarkdownPreviewGUI.php.

Constructor & Destructor Documentation

◆ __construct()

ilUIMarkdownPreviewGUI::__construct ( )

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

References $DIC, ILIAS\Repository\ctrl(), ILIAS\FileDelivery\http(), and ILIAS\Repository\refinery().

     {
         global $DIC;
 
         $this->refinery = $DIC->refinery();
         $this->ctrl = $DIC->ctrl();
         $this->http = $DIC->http();
     }

Here is the call graph for this function:

Member Function Documentation

◆ executeCommand()

ilUIMarkdownPreviewGUI::executeCommand ( )

Definition at line 48 of file class.ilUIMarkdownPreviewGUI.php.

References ILIAS\Repository\ctrl(), ILIAS\FileDelivery\http(), and renderAsync().

                                     : void
     {
         if (!$this->ctrl->isAsynch() && self::CMD_RENDER_ASYNC !== $this->ctrl->getCmd()) {
             $this->http->saveResponse(
                 $this->http
                     ->response()
                     ->withBody(Streams::ofString('Whoops, something went wrong!'))
                     ->withStatus(404)
             );
 
             $this->http->sendResponse();
             $this->http->close();
         }
 
         $this->renderAsync();
     }

Here is the call graph for this function:

◆ getAsyncUrl()

ilUIMarkdownPreviewGUI::getAsyncUrl ( )

Returns an endpoint where the clientside input can submit it's value to and receive the current preview.

Note that ilCtrl does not return fully qualified URIs, therefore string is type-hinted.

Implements ILIAS\UI\Component\Input\Field\MarkdownRenderer.

Definition at line 65 of file class.ilUIMarkdownPreviewGUI.php.

References ILIAS\Repository\ctrl().

                                  : string
     {
         return $this->ctrl->getLinkTargetByClass(
             self::class,
             self::CMD_RENDER_ASYNC,
             null,
             true
         );
     }

Here is the call graph for this function:

◆ getParameterName()

ilUIMarkdownPreviewGUI::getParameterName ( )

Returns the name of the $_POST variable the asynchronous input submits to.

Implements ILIAS\UI\Component\Input\Field\MarkdownRenderer.

Definition at line 75 of file class.ilUIMarkdownPreviewGUI.php.

Referenced by renderAsync().

                                       : string
     {
         return 'raw_markdown';
     }

Here is the caller graph for this function:

◆ render()

ilUIMarkdownPreviewGUI::render ( string $markdown_text )

Returns the rendered preview of the given string.

Implements ILIAS\UI\Component\Input\Field\MarkdownRenderer.

Definition at line 96 of file class.ilUIMarkdownPreviewGUI.php.

References ILIAS\Repository\refinery().

Referenced by renderAsync().

                                                  : string
     {
         return $this->refinery->string()->markdown()->toHTML()->transform($markdown_text);
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ renderAsync()

ilUIMarkdownPreviewGUI::renderAsync ( )

Sends a JSON-response with the rendered preview of the submitted input.

Implements ILIAS\UI\Component\Input\Field\MarkdownRenderer.

Definition at line 80 of file class.ilUIMarkdownPreviewGUI.php.

References getParameterName(), ILIAS\FileDelivery\http(), ILIAS\Repository\refinery(), render(), and sendResponse().

Referenced by executeCommand().

                                  : void
     {
         $parameter_name = $this->getParameterName();
 
         if (!$this->http->wrapper()->post()->has($parameter_name)) {
             $this->sendResponse('');
         }
 
         $raw_markdown = $this->http->wrapper()->post()->retrieve(
             $parameter_name,
             $this->refinery->to()->string()
         );
 
         $this->sendResponse($this->render($raw_markdown));
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ sendResponse()

ilUIMarkdownPreviewGUI::sendResponse ( string $html )

protected

Definition at line 101 of file class.ilUIMarkdownPreviewGUI.php.

References ILIAS\FileDelivery\http().

Referenced by renderAsync().

                                                  : void
     {
         $this->http->saveResponse(
             $this->http->response()->withBody(Streams::ofString($html))
         );
 
         $this->http->sendResponse();
         $this->http->close();
     }