Inheritance diagram for ILIAS\COPage\PC\Paragraph\ParagraphCommandActionHandler:

Collaboration diagram for ILIAS\COPage\PC\Paragraph\ParagraphCommandActionHandler:

Public Member Functions
	__construct (\ilPageObjectGUI $page_gui)

	handle (array $query, array $body)

Protected Member Functions
	insertCommand (array $body, bool $auto=false)

	insertParagraph (string $pcid, string $after_pcid, string $content, string $characteristic, bool $from_placeholder=false)
	Insert paragraph. More...

	autoInsertCommand (array $body)

	updateCommand (array $body, bool $auto=false)

	updateParagraph (string $pcid, string $content, string $characteristic)
	Update paragraph. More...

	autoUpdateCommand (array $body)

	split (array $body, bool $auto=false)

	getFullIdForPCId (\ilPageObject $page, string $pc_id)
	Get full id for pc id. More...

	getContentForSaving (string $pcid, string $content, string $characteristic)

	mergePrevious (array $body)
	Merge with previous paragraph. More...

	cancelCommand (array $body)
	Cancel paragraph. More...

	deleteCommand (array $body)
	Delete paragraph. More...

	getIdForPCId (string $pcid)

Protected Attributes
ilPCParagraph	$content_obj

ILIAS DI UIServices	$ui

ilLanguage	$lng

ilPageObjectGUI	$page_gui

ilObjUser	$user

ParagraphResponseFactory	$response_factory

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.ParagraphCommandActionHandler.php.

Constructor & Destructor Documentation

◆ __construct()

ILIAS\COPage\PC\Paragraph\ParagraphCommandActionHandler::__construct ( \ilPageObjectGUI $page_gui )

Definition at line 37 of file class.ParagraphCommandActionHandler.php.

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

References $DIC, ILIAS\COPage\PC\Paragraph\ParagraphCommandActionHandler\$page_gui, ILIAS\Repository\lng(), ILIAS\Repository\ui(), and ILIAS\Repository\user().

Here is the call graph for this function:

Member Function Documentation

◆ autoInsertCommand()

ILIAS\COPage\PC\Paragraph\ParagraphCommandActionHandler::autoInsertCommand ( array $body )

protected

Definition at line 123 of file class.ParagraphCommandActionHandler.php.

     : Server\Response {
        return $this->insertCommand($body, true);
    }

Referenced by ILIAS\COPage\PC\Paragraph\ParagraphCommandActionHandler\handle().

Here is the caller graph for this function:

◆ autoUpdateCommand()

ILIAS\COPage\PC\Paragraph\ParagraphCommandActionHandler::autoUpdateCommand ( array $body )

protected

Definition at line 161 of file class.ParagraphCommandActionHandler.php.

                                                     : Server\Response
    {
        return $this->updateCommand($body, true);
    }

Referenced by ILIAS\COPage\PC\Paragraph\ParagraphCommandActionHandler\handle().

Here is the caller graph for this function:

◆ cancelCommand()

ILIAS\COPage\PC\Paragraph\ParagraphCommandActionHandler::cancelCommand ( array $body )

protected

Cancel paragraph.

Exceptions

ilCOPagePCEditException

Exceptions

ilCOPageUnknownPCTypeException

Exceptions

ilDateTimeException

Definition at line 344 of file class.ParagraphCommandActionHandler.php.

                                                 : Server\Response
    {
        $remove_section_for_pcid = $body["data"]["removeSectionFromPcid"];
        $par_text = $body["data"]["paragraphText"];
        $par_characteristic = $body["data"]["paragraphCharacteristic"];
 
        $page = $this->page_gui->getPageObject();
        $page->addHierIDs();
        $paragraph = $page->getContentObjectForPcId($remove_section_for_pcid);
        $parent = $page->getParentContentObjectForPcId($remove_section_for_pcid);
        $parent_pc_id = $parent->getPCId();
 
        $updated = true;
 
        // case 1: parent section exists and new characteristic is not empty
        if ($parent->getType() == "sec") {
            $updated = $this->updateParagraph($remove_section_for_pcid, $par_text, $par_characteristic);
 
            if ($updated) {
                $page->addHierIDs();
                $page->moveContentAfter($paragraph->getHierId(), $parent->getHierId());
                $updated = $page->update();
            }
 
            if ($updated) {
                $page->addHierIDs();
                $hid = $page->getHierIdForPcId($parent_pc_id);
                $updated = $page->deleteContents(
                    [$hid],
                    true,
                    $this->page_gui->getPageConfig()->getEnableSelfAssessment()
                );
            }
 
            if ($updated) {
                $updated = $page->update();
            }
        }
        return $this->ui_wrapper->sendPage($this->page_gui, $updated);
    }

References ilPageObject\addHierIDs(), ilPageObject\deleteContents(), ilPageObject\getContentObjectForPcId(), ilPageObject\getHierIdForPcId(), ilPageObject\getParentContentObjectForPcId(), ilPageObject\moveContentAfter(), and ilPageObject\update().

Referenced by ILIAS\COPage\PC\Paragraph\ParagraphCommandActionHandler\handle().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ deleteCommand()

ILIAS\COPage\PC\Paragraph\ParagraphCommandActionHandler::deleteCommand ( array $body )

protected

Delete paragraph.

Definition at line 388 of file class.ParagraphCommandActionHandler.php.

                                                 : Server\Response
    {
        $pcids = [$body["data"]["pcid"]];
 
        $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()
        );
 
        return $this->ui_wrapper->sendPage($this->page_gui, $updated);
    }

References ilPageObject\deleteContents().

Referenced by ILIAS\COPage\PC\Paragraph\ParagraphCommandActionHandler\handle().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getContentForSaving()

ILIAS\COPage\PC\Paragraph\ParagraphCommandActionHandler::getContentForSaving	(	string	$pcid,
		string	$content,
		string	$characteristic
	)

protected

Definition at line 228 of file class.ParagraphCommandActionHandler.php.

     : string {
        $content = str_replace("&nbsp;", " ", $content);
        return "<div id='" .
            $pcid . "' class='ilc_text_block_" .
            $characteristic . "'>" . $content . "</div>";
    }

◆ getFullIdForPCId()

ILIAS\COPage\PC\Paragraph\ParagraphCommandActionHandler::getFullIdForPCId	(	\ilPageObject	$page,
		string	$pc_id
	)

protected

Get full id for pc id.

Definition at line 216 of file class.ParagraphCommandActionHandler.php.

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

References $id, and ilPageObject\getHierIdsForPCIds().

Here is the call graph for this function:

◆ getIdForPCId()

ILIAS\COPage\PC\Paragraph\ParagraphCommandActionHandler::getIdForPCId ( string $pcid )

protected

Definition at line 410 of file class.ParagraphCommandActionHandler.php.

                                                 : 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;
    }

References $id, and ilPageObject\getHierIdsForPCIds().

Here is the call graph for this function:

◆ handle()

ILIAS\COPage\PC\Paragraph\ParagraphCommandActionHandler::handle	(	array	$query,
		array	$body
	)

Definition at line 49 of file class.ParagraphCommandActionHandler.php.

                                                     : Server\Response
    {
        switch ($body["action"]) {
            case "insert":
                return $this->insertCommand($body);
 
            case "update":
                return $this->updateCommand($body);
 
            case "update.auto":
                return $this->autoUpdateCommand($body);
 
            case "insert.auto":
                return $this->autoInsertCommand($body);
 
            case "split":
                return $this->split($body);
 
            case "cmd.sec.class":
                return $this->sectionClassCommand($body);
 
            case "cmd.merge.previous":
                return $this->mergePrevious($body);
 
            case "cmd.cancel":
                return $this->cancelCommand($body);
 
            case "delete":
                return $this->deleteCommand($body);
 
            default:
                throw new Exception("Unknown action " . $body["action"]);
        }
    }

Here is the call graph for this function:

◆ insertCommand()

ILIAS\COPage\PC\Paragraph\ParagraphCommandActionHandler::insertCommand	(	array	$body,
		bool	$auto = `false`
	)

protected

Definition at line 84 of file class.ParagraphCommandActionHandler.php.

     : Server\Response {
        $updated = $this->insertParagraph($body["data"]["pcid"], $body["data"]["after_pcid"], $body["data"]["content"], $body["data"]["characteristic"], $body["data"]["fromPlaceholder"]);
 
        return $this->response_factory->getResponseObject($this->page_gui, $updated, $body["data"]["pcid"]);
    }

Referenced by ILIAS\COPage\PC\Paragraph\ParagraphCommandActionHandler\handle().

Here is the caller graph for this function:

◆ insertParagraph()

ILIAS\COPage\PC\Paragraph\ParagraphCommandActionHandler::insertParagraph	(	string	$pcid,
		string	$after_pcid,
		string	$content,
		string	$characteristic,
		bool	$from_placeholder = `false`
	)

protected

Insert paragraph.

Returns: array|bool|string

Exceptions

ilCOPagePCEditException

Exceptions

ilCOPageUnknownPCTypeException

Definition at line 99 of file class.ParagraphCommandActionHandler.php.

     : array|bool|string {
        $page = $this->page_gui->getPageObject();
 
        $pcid = ":" . $pcid;
        $insert_id = $this->getFullIdForPCId($page, $after_pcid);
        $content = $this->getContentForSaving($pcid, $content, $characteristic);
 
        $this->content_obj = new \ilPCParagraph($page);
        return $this->content_obj->saveJS(
            $page,
            $content,
            \ilUtil::stripSlashes($characteristic),
            \ilUtil::stripSlashes($pcid),
            $insert_id,
            $from_placeholder
        );
    }

◆ mergePrevious()

ILIAS\COPage\PC\Paragraph\ParagraphCommandActionHandler::mergePrevious ( array $body )

protected

Merge with previous paragraph.

Definition at line 318 of file class.ParagraphCommandActionHandler.php.

                                                 : Server\Response
    {
        $page = $this->page_gui->getPageObject();
 
        $updated = $this->updateParagraph(
            $body["data"]["previousPcid"],
            $body["data"]["newPreviousContent"],
            $body["data"]["previousCharacteristic"]
        );
 
        $page->addHierIDs();
        $hier_id = $page->getHierIdForPcId($body["data"]["pcid"]);
        $updated = $page->deleteContents(
            [$hier_id],
            true,
            $this->page_gui->getPageConfig()->getEnableSelfAssessment()
        );
        return $this->ui_wrapper->sendPage($this->page_gui, $updated);
    }

References ilPageObject\addHierIDs(), ilPageObject\deleteContents(), and ilPageObject\getHierIdForPcId().

Referenced by ILIAS\COPage\PC\Paragraph\ParagraphCommandActionHandler\handle().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ split()

ILIAS\COPage\PC\Paragraph\ParagraphCommandActionHandler::split	(	array	$body,
		bool	$auto = `false`
	)

protected

Definition at line 166 of file class.ParagraphCommandActionHandler.php.

     : Server\Response {
        $page = $this->page_gui->getPageObject();
 
        $pcid = ":" . $body["data"]["pcid"];
        $insert_id = "";
        if ($body["data"]["insert_mode"]) {
            $insert_id = $this->getFullIdForPCId($page, $body["data"]["after_pcid"]);
        }
 
        $content = $this->getContentForSaving($pcid, $body["data"]["text"], $body["data"]["characteristic"]);
 
        $content_obj = new \ilPCParagraph($page);
        $updated = $content_obj->saveJS(
            $page,
            $content,
            \ilUtil::stripSlashes($body["data"]["characteristic"]),
            \ilUtil::stripSlashes($pcid),
            $insert_id,
            $body["data"]["fromPlaceholder"] ?? false
        );
        $current_after_id = $body["data"]["pcid"];
        $all_pc_ids[] = $current_after_id;
 
        foreach ($body["data"]["new_paragraphs"] as $p) {
            if ($updated === true) {
                $page->addHierIDs();
                $insert_id = $this->getFullIdForPCId($page, $current_after_id);
                $content = $this->getContentForSaving($p["pcid"], $p["model"]["text"], $p["model"]["characteristic"]);
                $content_obj = new \ilPCParagraph($page);
                $updated = $content_obj->saveJS(
                    $page,
                    $content,
                    \ilUtil::stripSlashes($p["model"]["characteristic"]),
                    ":" . \ilUtil::stripSlashes($p["pcid"]),
                    $insert_id
                );
                $all_pc_ids[] = $p["pcid"];
                $current_after_id = $p["pcid"];
            }
        }
 
        return $this->response_factory->getResponseObjectMulti($this->page_gui, $updated, $all_pc_ids);
    }

Referenced by ILIAS\COPage\PC\Paragraph\ParagraphCommandActionHandler\handle().

Here is the caller graph for this function:

◆ updateCommand()

ILIAS\COPage\PC\Paragraph\ParagraphCommandActionHandler::updateCommand	(	array	$body,
		bool	$auto = `false`
	)

protected

Definition at line 129 of file class.ParagraphCommandActionHandler.php.

     : Server\Response {
        $updated = $this->updateParagraph($body["data"]["pcid"], $body["data"]["content"], $body["data"]["characteristic"]);
        return $this->response_factory->getResponseObject($this->page_gui, $updated, $body["data"]["pcid"]);
    }

Referenced by ILIAS\COPage\PC\Paragraph\ParagraphCommandActionHandler\handle().

Here is the caller graph for this function:

◆ updateParagraph()

ILIAS\COPage\PC\Paragraph\ParagraphCommandActionHandler::updateParagraph	(	string	$pcid,
		string	$content,
		string	$characteristic
	)

protected

Update paragraph.

Returns: array|bool|string

Exceptions

ilCOPagePCEditException

Exceptions

ilCOPageUnknownPCTypeException

Definition at line 143 of file class.ParagraphCommandActionHandler.php.

     : array|bool|string {
        $page = $this->page_gui->getPageObject();
 
        $pcid = $this->getFullIdForPCId($page, $pcid);
        $content = $this->getContentForSaving($pcid, $content, $characteristic);
        $this->content_obj = new \ilPCParagraph($page);
        return $this->content_obj->saveJS(
            $page,
            $content,
            \ilUtil::stripSlashes($characteristic),
            \ilUtil::stripSlashes($pcid)
        );
    }

Field Documentation

◆ $content_obj

ilPCParagraph ILIAS\COPage\PC\Paragraph\ParagraphCommandActionHandler::$content_obj

protected

Definition at line 29 of file class.ParagraphCommandActionHandler.php.

◆ $lng

ilLanguage ILIAS\COPage\PC\Paragraph\ParagraphCommandActionHandler::$lng

protected

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

◆ $page_gui

ilPageObjectGUI ILIAS\COPage\PC\Paragraph\ParagraphCommandActionHandler::$page_gui

protected

Definition at line 32 of file class.ParagraphCommandActionHandler.php.

Referenced by ILIAS\COPage\PC\Paragraph\ParagraphCommandActionHandler\__construct().

◆ $response_factory

ParagraphResponseFactory ILIAS\COPage\PC\Paragraph\ParagraphCommandActionHandler::$response_factory

protected

Definition at line 34 of file class.ParagraphCommandActionHandler.php.

◆ $ui

ILIAS DI UIServices ILIAS\COPage\PC\Paragraph\ParagraphCommandActionHandler::$ui

protected

Definition at line 30 of file class.ParagraphCommandActionHandler.php.

◆ $ui_wrapper

Server UIWrapper ILIAS\COPage\PC\Paragraph\ParagraphCommandActionHandler::$ui_wrapper

protected

Definition at line 35 of file class.ParagraphCommandActionHandler.php.

◆ $user

ilObjUser ILIAS\COPage\PC\Paragraph\ParagraphCommandActionHandler::$user

protected

Definition at line 33 of file class.ParagraphCommandActionHandler.php.

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

components/ILIAS/COPage/PC/Paragraph/class.ParagraphCommandActionHandler.php

Public Member Functions

Protected Member Functions

Protected Attributes

Detailed Description

Constructor & Destructor Documentation

◆ __construct()

Member Function Documentation

◆ autoInsertCommand()

◆ autoUpdateCommand()

◆ cancelCommand()

◆ deleteCommand()

◆ getContentForSaving()

◆ getFullIdForPCId()

◆ getIdForPCId()

◆ handle()

◆ insertCommand()

◆ insertParagraph()

◆ mergePrevious()

◆ split()

◆ updateCommand()

◆ updateParagraph()

Field Documentation

◆ $content_obj

◆ $lng

◆ $page_gui

◆ $response_factory

◆ $ui

◆ $ui_wrapper

◆ $user