Inheritance diagram for ILIAS\UI\Implementation\Component\Layout\Page\PageCommandActionHandler:

Collaboration diagram for ILIAS\UI\Implementation\Component\Layout\Page\PageCommandActionHandler:

Public Member Functions
	__construct (\ilPageObjectGUI $page_gui)

	handle (array $query, array $body)

Protected Member Functions
	cutCommand (array $body)

	pasteCommand (array $body)

	copyCommand (array $body)

	format (array $body)

	delete (array $body)

	dragDropCommand (array $body)

	sendPage ($updated)
	Send whole page as response. More...

	getIdForPCId (string $pcid)
	Get id for pcid. More...

	getHierIdForPCId (string $pcid)
	Get hier id for pcid. More...

	updateCommand (array $body)

	activate (array $body)

	listEdit ($body)
	Activate command. More...

Protected Attributes
	$updated

ilPCParagraph	$content_obj

ILIAS DI UIServices	$ui

ilLanguage	$lng

ilPageObjectGUI	$page_gui

ilObjUser	$user

Server UIWrapper	$ui_wrapper

Detailed Description

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

Definition at line 27 of file class.PageCommandActionHandler.php.

Constructor & Destructor Documentation

◆ __construct()

ILIAS\UI\Implementation\Component\Layout\Page\PageCommandActionHandler::__construct ( \ilPageObjectGUI $page_gui )

Definition at line 40 of file class.PageCommandActionHandler.php.

References $DIC, ILIAS\UI\Implementation\Component\Layout\Page\PageCommandActionHandler\$page_gui, ILIAS\Repository\lng(), ILIAS\Repository\ui(), and ILIAS\Repository\user().

     {
         global $DIC;
 
         $this->ui = $DIC->ui();
         $this->lng = $DIC->language();
         $this->page_gui = $page_gui;
         $this->user = $DIC->user();
 
         $this->ui_wrapper = new Server\UIWrapper($this->ui, $this->lng);
     }

Here is the call graph for this function:

Member Function Documentation

◆ activate()

ILIAS\UI\Implementation\Component\Layout\Page\PageCommandActionHandler::activate ( array $body )

protected

Definition at line 255 of file class.PageCommandActionHandler.php.

References ILIAS\UI\Implementation\Component\Layout\Page\PageCommandActionHandler\$updated, ILIAS\UI\Implementation\Component\Layout\Page\PageCommandActionHandler\getIdForPCId(), and ILIAS\UI\Implementation\Component\Layout\Page\PageCommandActionHandler\sendPage().

Referenced by ILIAS\UI\Implementation\Component\Layout\Page\PageCommandActionHandler\handle().

                                             : Server\Response
     {
         $pcids = $body["data"]["pcids"];
         $page = $this->page_gui->getPageObject();
 
         $hids = array_map(
             function ($pcid) {
                 return $this->getIdForPCId($pcid);
             },
             $pcids
         );
 
         $updated = $page->switchEnableMultiple(
             $hids,
             true,
             $this->page_gui->getPageConfig()->getEnableSelfAssessment()
         );
 
 
         return $this->sendPage($updated);
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ copyCommand()

ILIAS\UI\Implementation\Component\Layout\Page\PageCommandActionHandler::copyCommand ( array $body )

protected

Definition at line 117 of file class.PageCommandActionHandler.php.

References ILIAS\UI\Implementation\Component\Layout\Page\PageCommandActionHandler\getIdForPCId(), and ILIAS\UI\Implementation\Component\Layout\Page\PageCommandActionHandler\sendPage().

Referenced by ILIAS\UI\Implementation\Component\Layout\Page\PageCommandActionHandler\handle().

                                                : Server\Response
     {
         $pcids = $body["data"]["pcids"];
         $page = $this->page_gui->getPageObject();
 
         $hids = array_map(
             function ($pcid) {
                 return $this->getIdForPCId($pcid);
             },
             $pcids
         );
 
         $page->copyContents($hids);
 
         return $this->sendPage(true);
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ cutCommand()

ILIAS\UI\Implementation\Component\Layout\Page\PageCommandActionHandler::cutCommand ( array $body )

protected

Definition at line 88 of file class.PageCommandActionHandler.php.

References ILIAS\UI\Implementation\Component\Layout\Page\PageCommandActionHandler\$updated, ILIAS\UI\Implementation\Component\Layout\Page\PageCommandActionHandler\getIdForPCId(), and ILIAS\UI\Implementation\Component\Layout\Page\PageCommandActionHandler\sendPage().

Referenced by ILIAS\UI\Implementation\Component\Layout\Page\PageCommandActionHandler\handle().

                                               : Server\Response
     {
         $pcids = $body["data"]["pcids"];
         $page = $this->page_gui->getPageObject();
 
         $hids = array_map(
             function ($pcid) {
                 return $this->getIdForPCId($pcid);
             },
             $pcids
         );
 
         $updated = $page->cutContents($hids);
 
         return $this->sendPage($updated);
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ delete()

ILIAS\UI\Implementation\Component\Layout\Page\PageCommandActionHandler::delete ( array $body )

protected

Definition at line 153 of file class.PageCommandActionHandler.php.

References ILIAS\UI\Implementation\Component\Layout\Page\PageCommandActionHandler\$updated, ILIAS\UI\Implementation\Component\Layout\Page\PageCommandActionHandler\getIdForPCId(), and ILIAS\UI\Implementation\Component\Layout\Page\PageCommandActionHandler\sendPage().

                                           : Server\Response
     {
         $pcids = $body["data"]["pcids"];
         $page = $this->page_gui->getPageObject();
 
         $hids = array_map(
             function ($pcid) {
                 return $this->getIdForPCId($pcid);
             },
             $pcids
         );
 
         $updated = $page->deleteContents(
             $hids,
             true,
             $this->page_gui->getPageConfig()->getEnableSelfAssessment()
         );
         if ($updated === true) {
             $this->page_gui->afterDeleteContents();
         }
 
         return $this->sendPage($updated);
     }

Here is the call graph for this function:

◆ dragDropCommand()

ILIAS\UI\Implementation\Component\Layout\Page\PageCommandActionHandler::dragDropCommand ( array $body )

protected

Definition at line 177 of file class.PageCommandActionHandler.php.

References ILIAS\UI\Implementation\Component\Layout\Page\PageCommandActionHandler\$updated, and ILIAS\UI\Implementation\Component\Layout\Page\PageCommandActionHandler\sendPage().

Referenced by ILIAS\UI\Implementation\Component\Layout\Page\PageCommandActionHandler\handle().

                                                    : Server\Response
     {
         $target = $body["data"]["target"];
         $source = $body["data"]["source"];
 
         $page = $this->page_gui->getPageObject();
 
         $source = explode(":", $source);
         $target = explode(":", $target);
 
         $updated = $page->moveContentAfter($source[0], $target[0], $source[1], $target[1]);
 
         return $this->sendPage($updated);
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ format()

ILIAS\UI\Implementation\Component\Layout\Page\PageCommandActionHandler::format ( array $body )

protected

Definition at line 134 of file class.PageCommandActionHandler.php.

References ILIAS\UI\Implementation\Component\Layout\Page\PageCommandActionHandler\$updated, ILIAS\UI\Implementation\Component\Layout\Page\PageCommandActionHandler\getIdForPCId(), and ILIAS\UI\Implementation\Component\Layout\Page\PageCommandActionHandler\sendPage().

Referenced by ILIAS\UI\Implementation\Component\Layout\Page\PageCommandActionHandler\handle().

                                           : Server\Response
     {
         $pcids = $body["data"]["pcids"];
         $par = $body["data"]["paragraph_format"];
         $sec = $body["data"]["section_format"];
         $med = $body["data"]["media_format"];
         $page = $this->page_gui->getPageObject();
 
         $hids = array_map(
             function ($pcid) {
                 return $this->getIdForPCId($pcid);
             },
             $pcids
         );
 
         $updated = $page->assignCharacteristic($hids, $par, $sec, $med);
         return $this->sendPage($updated);
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getHierIdForPCId()

ILIAS\UI\Implementation\Component\Layout\Page\PageCommandActionHandler::getHierIdForPCId ( string $pcid )

protected

Get hier id for pcid.

Definition at line 218 of file class.PageCommandActionHandler.php.

References $id.

                                                      : string
     {
         $page = $this->page_gui->getPageObject();
         $id = "pg";
         if (!in_array($pcid, ["", "pg"])) {
             $hier_ids = $page->getHierIdsForPCIds([$pcid]);
             $id = $hier_ids[$pcid];
         }
         return $id;
     }

◆ getIdForPCId()

ILIAS\UI\Implementation\Component\Layout\Page\PageCommandActionHandler::getIdForPCId ( string $pcid )

protected

Get id for pcid.

Definition at line 204 of file class.PageCommandActionHandler.php.

References $id.

Referenced by ILIAS\UI\Implementation\Component\Layout\Page\PageCommandActionHandler\activate(), ILIAS\UI\Implementation\Component\Layout\Page\PageCommandActionHandler\copyCommand(), ILIAS\UI\Implementation\Component\Layout\Page\PageCommandActionHandler\cutCommand(), ILIAS\UI\Implementation\Component\Layout\Page\PageCommandActionHandler\delete(), ILIAS\UI\Implementation\Component\Layout\Page\PageCommandActionHandler\format(), and ILIAS\UI\Implementation\Component\Layout\Page\PageCommandActionHandler\pasteCommand().

                                                  : string
     {
         $page = $this->page_gui->getPageObject();
         $id = "pg:";
         if (!in_array($pcid, ["", "pg"])) {
             $hier_ids = $page->getHierIdsForPCIds([$pcid]);
             $id = $hier_ids[$pcid] . ":" . $pcid;
         }
         return $id;
     }

Here is the caller graph for this function:

◆ handle()

ILIAS\UI\Implementation\Component\Layout\Page\PageCommandActionHandler::handle	(	array	$query,
		array	$body
	)

Exceptions

Exception

Definition at line 55 of file class.PageCommandActionHandler.php.

References ILIAS\UI\Implementation\Component\Layout\Page\PageCommandActionHandler\activate(), ILIAS\UI\Implementation\Component\Layout\Page\PageCommandActionHandler\copyCommand(), ILIAS\UI\Implementation\Component\Layout\Page\PageCommandActionHandler\cutCommand(), ILIAS\UI\Implementation\Component\Layout\Page\PageCommandActionHandler\dragDropCommand(), ILIAS\UI\Implementation\Component\Layout\Page\PageCommandActionHandler\format(), ILIAS\UI\Implementation\Component\Layout\Page\PageCommandActionHandler\listEdit(), and ILIAS\UI\Implementation\Component\Layout\Page\PageCommandActionHandler\pasteCommand().

                                                      : Server\Response
     {
         switch ($body["action"]) {
             case "cut":
                 return $this->cutCommand($body);
 
             case "paste":
                 return $this->pasteCommand($body);
 
             case "copy":
                 return $this->copyCommand($body);
 
             case "drag.drop":
                 return $this->dragDropCommand($body);
 
             case "format":
                 return $this->format($body);
 
             case "delete":
                 return $this->delete($body);
 
             case "activate":
                 return $this->activate($body);
 
             case "list.edit":
                 return $this->listEdit($body);
                 break;
 
             default:
                 throw new Exception("Unknown action " . $body["action"]);
         }
     }

Here is the call graph for this function:

◆ listEdit()

ILIAS\UI\Implementation\Component\Layout\Page\PageCommandActionHandler::listEdit ( $body )

protected

Activate command.

Parameters

$body

Returns: Server

Definition at line 282 of file class.PageCommandActionHandler.php.

References ILIAS\UI\Implementation\Component\Layout\Page\PageCommandActionHandler\$updated, and ILIAS\UI\Implementation\Component\Layout\Page\PageCommandActionHandler\sendPage().

Referenced by ILIAS\UI\Implementation\Component\Layout\Page\PageCommandActionHandler\handle().

                                       : Server\Response
     {
         $pcid = $body["data"]["pcid"];
         $list_cmd = $body["data"]["list_cmd"];
         $page = $this->page_gui->getPageObject();
 
         $pc = $page->getContentObjectForPcId($pcid);
 
         $updated = true;
         switch ($list_cmd) {
             case "newItemAfter":
                 $pc->newItemAfter();
                 break;
             case "newItemBefore":
                 $pc->newItemBefore();
                 break;
             case "deleteItem":
                 $pc->deleteItem();
                 break;
             case "moveItemUp":
                 $pc->moveItemUp();
                 break;
             case "moveItemDown":
                 $pc->moveItemDown();
                 break;
         }
         $updated = $page->update();
 
         return $this->sendPage($updated);
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ pasteCommand()

ILIAS\UI\Implementation\Component\Layout\Page\PageCommandActionHandler::pasteCommand ( array $body )

protected

Definition at line 105 of file class.PageCommandActionHandler.php.

References ILIAS\UI\Implementation\Component\Layout\Page\PageCommandActionHandler\$updated, ILIAS\UI\Implementation\Component\Layout\Page\PageCommandActionHandler\getIdForPCId(), and ILIAS\UI\Implementation\Component\Layout\Page\PageCommandActionHandler\sendPage().

Referenced by ILIAS\UI\Implementation\Component\Layout\Page\PageCommandActionHandler\handle().

                                                 : Server\Response
     {
         $target_pcid = $body["data"]["target_pcid"];
         $page = $this->page_gui->getPageObject();
         $updated = $page->pasteContents(
             $this->getIdForPCId($target_pcid),
             $page->getPageConfig()->getEnableSelfAssessment()
         );
 
         return $this->sendPage($updated);
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ sendPage()

ILIAS\UI\Implementation\Component\Layout\Page\PageCommandActionHandler::sendPage ( $updated )

protected

Send whole page as response.

Parameters

bool | array $updated

Definition at line 196 of file class.PageCommandActionHandler.php.

References ILIAS\UI\Implementation\Component\Layout\Page\PageCommandActionHandler\$updated.

                                          : Server\Response
     {
         return $this->ui_wrapper->sendPage($this->page_gui, $updated);
     }

Here is the caller graph for this function:

◆ updateCommand()

ILIAS\UI\Implementation\Component\Layout\Page\PageCommandActionHandler::updateCommand ( array $body )

protected

Definition at line 229 of file class.PageCommandActionHandler.php.

References $data, and ilUtil\stripSlashes().

                                                  : Server\Response
     {
         $page = $this->page_gui->getPageObject();
 
         $hier_ids = $page->getHierIdsForPCIds([$body["data"]["pcid"]]);
         $pcid = $hier_ids[$body["data"]["pcid"]] . ":" . $body["data"]["pcid"];
 
         $content = "<div id='" .
             $pcid . "' class='ilc_text_block_" .
             $body["data"]["characteristic"] . "'>" . $body["data"]["content"] . "</div>";
 
         $this->content_obj = new \ilPCParagraph($page);
 
         $this->updated = $this->content_obj->saveJS(
             $page,
             $content,
             \ilUtil::stripSlashes($body["data"]["characteristic"]),
             \ilUtil::stripSlashes($pcid)
         );
 
 
         $data = new \stdClass();
         $data->renderedContent = "Test the rendered content";
         return new Server\Response($data);
     }