Collaboration diagram for ILIAS\MetaData\OERHarvester\ControlCenter\ControlCenterGUI:

Public Member Functions
	__construct (protected URI $link_to_parent, protected ilCtrlInterface $ctrl, protected ilGlobalTemplateInterface $tpl, protected UIFactory $ui_factory, protected UIRenderer $ui_renderer, protected RequestParserInterface $request_parser, protected ContentFactoryInterface $content_factory, protected PresentationUtilities $presentation_utilities, protected StateInfoFetcherInterface $state_info_fetcher, protected PublisherInterface $state_changer, protected PublishingSettings $publishing_settings, protected StaticURL $static_url, protected DataFactory $data_factory, protected ObjectHandler $object_handler)

	executeCommand ()

Protected Member Functions
	isCommandAvailable (Command $cmd)
	Includes access checks via StateInfo. More...

	view ()

	block ()

	unblock ()

	publish ()

	withdraw ()

	confirmWithdraw ()

	submit ()

	accept ()

	confirmAccept ()

	reject ()

	confirmReject ()

	getRedirectTargetAfterDeletion (int $fallback_ref_id)

	showSuccessMessageAfterRedirect (Action $action)

Protected Attributes
int	$ref_id

int	$obj_id

string	$type

StateInfoInterface	$state_info

Detailed Description

Definition at line 42 of file ControlCenterGUI.php.

Constructor & Destructor Documentation

◆ __construct()

ILIAS\MetaData\OERHarvester\ControlCenter\ControlCenterGUI::__construct	(	protected URI	$link_to_parent,
		protected ilCtrlInterface	$ctrl,
		protected ilGlobalTemplateInterface	$tpl,
		protected UIFactory	$ui_factory,
		protected UIRenderer	$ui_renderer,
		protected RequestParserInterface	$request_parser,
		protected ContentFactoryInterface	$content_factory,
		protected PresentationUtilities	$presentation_utilities,
		protected StateInfoFetcherInterface	$state_info_fetcher,
		protected PublisherInterface	$state_changer,
		protected PublishingSettings	$publishing_settings,
		protected StaticURL	$static_url,
		protected DataFactory	$data_factory,
		protected ObjectHandler	$object_handler
	)

Definition at line 49 of file ControlCenterGUI.php.

      {
        $this->ref_id = $this->request_parser->fetchRefID();
        $this->obj_id = $this->request_parser->fetchObjID();
        $this->type = $this->request_parser->fetchType();
        $this->state_info = $this->state_info_fetcher->getStateInfoForObjectReference(
            $this->ref_id,
            $this->obj_id,
            $this->type
        );
    }

Member Function Documentation

◆ accept()

ILIAS\MetaData\OERHarvester\ControlCenter\ControlCenterGUI::accept ( )

protected

Definition at line 174 of file ControlCenterGUI.php.

                               : void
    {
        $content = $this->content_factory->getConfirmationContent(
            $this->ref_id,
            $this->obj_id,
            $this->type,
            Action::ACCEPT,
            $this->object_handler->isOnlyReference($this->ref_id)
        );
        echo $this->ui_renderer->renderAsync($this->ui_factory->prompt()->state()->show($content));
        exit;
    }

References exit.

◆ block()

ILIAS\MetaData\OERHarvester\ControlCenter\ControlCenterGUI::block ( )

protected

Definition at line 119 of file ControlCenterGUI.php.

                              : void
    {
        $this->state_changer->block($this->obj_id);
        $this->showSuccessMessageAfterRedirect(Action::BLOCK);
        echo $this->ui_renderer->renderAsync($this->ui_factory->prompt()->state()->redirect($this->link_to_parent));
        exit;
    }

References exit, and ILIAS\MetaData\OERHarvester\ControlCenter\ControlCenterGUI\showSuccessMessageAfterRedirect().

Here is the call graph for this function:

◆ confirmAccept()

ILIAS\MetaData\OERHarvester\ControlCenter\ControlCenterGUI::confirmAccept ( )

protected

Definition at line 187 of file ControlCenterGUI.php.

                                      : void
    {
        $this->state_changer->accept($this->obj_id, $this->type);
 
        $this->showSuccessMessageAfterRedirect(Action::ACCEPT);
        $link = $this->getRedirectTargetAfterDeletion($this->publishing_settings->getContainerRefIDForEditorialStep());
        echo $this->ui_renderer->renderAsync($this->ui_factory->prompt()->state()->redirect($link));
        exit;
    }

References exit, ILIAS\MetaData\OERHarvester\ControlCenter\ControlCenterGUI\getRedirectTargetAfterDeletion(), and ILIAS\MetaData\OERHarvester\ControlCenter\ControlCenterGUI\showSuccessMessageAfterRedirect().

Here is the call graph for this function:

◆ confirmReject()

ILIAS\MetaData\OERHarvester\ControlCenter\ControlCenterGUI::confirmReject ( )

protected

Definition at line 210 of file ControlCenterGUI.php.

                                      : void
    {
        $this->state_changer->reject($this->obj_id);
 
        $this->showSuccessMessageAfterRedirect(Action::REJECT);
        $link = $this->getRedirectTargetAfterDeletion($this->publishing_settings->getContainerRefIDForEditorialStep());
        echo $this->ui_renderer->renderAsync($this->ui_factory->prompt()->state()->redirect($link));
        exit;
    }

References exit, ILIAS\MetaData\OERHarvester\ControlCenter\ControlCenterGUI\getRedirectTargetAfterDeletion(), ILIAS\MetaData\OERHarvester\ControlCenter\State\REJECT, and ILIAS\MetaData\OERHarvester\ControlCenter\ControlCenterGUI\showSuccessMessageAfterRedirect().

Here is the call graph for this function:

◆ confirmWithdraw()

ILIAS\MetaData\OERHarvester\ControlCenter\ControlCenterGUI::confirmWithdraw ( )

protected

Definition at line 156 of file ControlCenterGUI.php.

                                        : void
    {
        $this->state_changer->withdraw($this->obj_id);
 
        $this->showSuccessMessageAfterRedirect(Action::WITHDRAW);
        $link = $this->getRedirectTargetAfterDeletion($this->publishing_settings->getContainerRefIDForPublishing());
        echo $this->ui_renderer->renderAsync($this->ui_factory->prompt()->state()->redirect($link));
        exit;
    }

References exit, ILIAS\MetaData\OERHarvester\ControlCenter\ControlCenterGUI\getRedirectTargetAfterDeletion(), and ILIAS\MetaData\OERHarvester\ControlCenter\ControlCenterGUI\showSuccessMessageAfterRedirect().

Here is the call graph for this function:

◆ executeCommand()

ILIAS\MetaData\OERHarvester\ControlCenter\ControlCenterGUI::executeCommand ( )

Definition at line 75 of file ControlCenterGUI.php.

                                    : void
    {
        $next_class = $this->ctrl->getNextClass($this);
 
        $cmd = Command::tryFrom($this->ctrl->getCmd());
        switch ($next_class) {
            default:
                if (!$cmd || !$this->isCommandAvailable($cmd)) {
                    throw new ilPermissionException($this->presentation_utilities->txt('permission_denied'));
                }
                $cmd_value = $cmd->value;
                $this->$cmd_value();
                break;
        }
    }

References ILIAS\Repository\ctrl(), and ILIAS\MetaData\OERHarvester\ControlCenter\ControlCenterGUI\isCommandAvailable().

Here is the call graph for this function:

◆ getRedirectTargetAfterDeletion()

ILIAS\MetaData\OERHarvester\ControlCenter\ControlCenterGUI::getRedirectTargetAfterDeletion ( int $fallback_ref_id )

protected

Definition at line 220 of file ControlCenterGUI.php.

                                                                           : URI
    {
        if ($this->object_handler->doesReferenceExist($this->ref_id)) {
            return $this->link_to_parent;
        }
        return $this->static_url->builder()->build('cat', $this->data_factory->refId($fallback_ref_id));
    }

Referenced by ILIAS\MetaData\OERHarvester\ControlCenter\ControlCenterGUI\confirmAccept(), ILIAS\MetaData\OERHarvester\ControlCenter\ControlCenterGUI\confirmReject(), and ILIAS\MetaData\OERHarvester\ControlCenter\ControlCenterGUI\confirmWithdraw().

Here is the caller graph for this function:

◆ isCommandAvailable()

ILIAS\MetaData\OERHarvester\ControlCenter\ControlCenterGUI::isCommandAvailable ( Command $cmd )

protected

Includes access checks via StateInfo.

Definition at line 94 of file ControlCenterGUI.php.

                                                       : bool
    {
        if (!$this->state_info->isPublishingRelevant()) {
            return false;
        }
 
        return match ($cmd) {
            Command::VIEW => true,
            Command::BLOCK => $this->state_info->isActionAvailable(Action::BLOCK),
            Command::UNBLOCK => $this->state_info->isActionAvailable(Action::UNBLOCK),
            Command::PUBLISH => $this->state_info->isActionAvailable(Action::PUBLISH),
            Command::WITHDRAW, Command::CONFIRM_WITHDRAW => $this->state_info->isActionAvailable(Action::WITHDRAW),
            Command::SUBMIT => $this->state_info->isActionAvailable(Action::SUBMIT),
            Command::ACCEPT, Command::CONFIRM_ACCEPT => $this->state_info->isActionAvailable(Action::ACCEPT),
            Command::REJECT, Command::CONFIRM_REJECT => $this->state_info->isActionAvailable(Action::REJECT)
        };
    }

References ILIAS\MetaData\OERHarvester\ControlCenter\CONFIRM_REJECT, and ILIAS\MetaData\OERHarvester\ControlCenter\State\REJECT.

Referenced by ILIAS\MetaData\OERHarvester\ControlCenter\ControlCenterGUI\executeCommand().

Here is the caller graph for this function:

◆ publish()

ILIAS\MetaData\OERHarvester\ControlCenter\ControlCenterGUI::publish ( )

protected

Definition at line 135 of file ControlCenterGUI.php.

                                : void
    {
        $this->state_changer->publish($this->obj_id, $this->type);
        $this->showSuccessMessageAfterRedirect(Action::PUBLISH);
        echo $this->ui_renderer->renderAsync($this->ui_factory->prompt()->state()->redirect($this->link_to_parent));
        exit;
    }

References exit, and ILIAS\MetaData\OERHarvester\ControlCenter\ControlCenterGUI\showSuccessMessageAfterRedirect().

Here is the call graph for this function:

◆ reject()

ILIAS\MetaData\OERHarvester\ControlCenter\ControlCenterGUI::reject ( )

protected

Definition at line 197 of file ControlCenterGUI.php.

                               : void
    {
        $content = $this->content_factory->getConfirmationContent(
            $this->ref_id,
            $this->obj_id,
            $this->type,
            Action::REJECT,
            $this->object_handler->isOnlyReference($this->ref_id)
        );
        echo $this->ui_renderer->renderAsync($this->ui_factory->prompt()->state()->show($content));
        exit;
    }

References exit, and ILIAS\MetaData\OERHarvester\ControlCenter\State\REJECT.

◆ showSuccessMessageAfterRedirect()

ILIAS\MetaData\OERHarvester\ControlCenter\ControlCenterGUI::showSuccessMessageAfterRedirect ( Action $action )

protected

Definition at line 228 of file ControlCenterGUI.php.

                                                                      : void
    {
        $this->tpl->setOnScreenMessage(
            GlobalTemplate::MESSAGE_TYPE_SUCCESS,
            $this->content_factory->getSuccessMessage($action),
            true
        );
    }

References ILIAS\UICore\GlobalTemplate\MESSAGE_TYPE_SUCCESS.

Referenced by ILIAS\MetaData\OERHarvester\ControlCenter\ControlCenterGUI\block(), ILIAS\MetaData\OERHarvester\ControlCenter\ControlCenterGUI\confirmAccept(), ILIAS\MetaData\OERHarvester\ControlCenter\ControlCenterGUI\confirmReject(), ILIAS\MetaData\OERHarvester\ControlCenter\ControlCenterGUI\confirmWithdraw(), ILIAS\MetaData\OERHarvester\ControlCenter\ControlCenterGUI\publish(), ILIAS\MetaData\OERHarvester\ControlCenter\ControlCenterGUI\submit(), and ILIAS\MetaData\OERHarvester\ControlCenter\ControlCenterGUI\unblock().

Here is the caller graph for this function:

◆ submit()

ILIAS\MetaData\OERHarvester\ControlCenter\ControlCenterGUI::submit ( )

protected

Definition at line 166 of file ControlCenterGUI.php.

                               : void
    {
        $this->state_changer->submit($this->obj_id);
        $this->showSuccessMessageAfterRedirect(Action::SUBMIT);
        echo $this->ui_renderer->renderAsync($this->ui_factory->prompt()->state()->redirect($this->link_to_parent));
        exit;
    }

References exit, and ILIAS\MetaData\OERHarvester\ControlCenter\ControlCenterGUI\showSuccessMessageAfterRedirect().

Here is the call graph for this function:

◆ unblock()

ILIAS\MetaData\OERHarvester\ControlCenter\ControlCenterGUI::unblock ( )

protected

Definition at line 127 of file ControlCenterGUI.php.

                                : void
    {
        $this->state_changer->unblock($this->obj_id);
        $this->showSuccessMessageAfterRedirect(Action::UNBLOCK);
        echo $this->ui_renderer->renderAsync($this->ui_factory->prompt()->state()->redirect($this->link_to_parent));
        exit;
    }

References exit, and ILIAS\MetaData\OERHarvester\ControlCenter\ControlCenterGUI\showSuccessMessageAfterRedirect().

Here is the call graph for this function:

◆ view()

ILIAS\MetaData\OERHarvester\ControlCenter\ControlCenterGUI::view ( )

protected

Definition at line 112 of file ControlCenterGUI.php.

                             : void
    {
        $content = $this->content_factory->getInfoContent($this->ref_id, $this->obj_id, $this->type, $this->state_info);
        echo $this->ui_renderer->renderAsync($this->ui_factory->prompt()->state()->show($content));
        exit;
    }

References exit.

◆ withdraw()

ILIAS\MetaData\OERHarvester\ControlCenter\ControlCenterGUI::withdraw ( )

protected

Definition at line 143 of file ControlCenterGUI.php.

                                 : void
    {
        $content = $this->content_factory->getConfirmationContent(
            $this->ref_id,
            $this->obj_id,
            $this->type,
            Action::WITHDRAW,
            $this->object_handler->isOnlyReference($this->ref_id)
        );
        echo $this->ui_renderer->renderAsync($this->ui_factory->prompt()->state()->show($content));
        exit;
    }

References exit.

Field Documentation

◆ $obj_id

int ILIAS\MetaData\OERHarvester\ControlCenter\ControlCenterGUI::$obj_id

protected

Definition at line 45 of file ControlCenterGUI.php.

◆ $ref_id

int ILIAS\MetaData\OERHarvester\ControlCenter\ControlCenterGUI::$ref_id

protected

Definition at line 44 of file ControlCenterGUI.php.

◆ $state_info

StateInfoInterface ILIAS\MetaData\OERHarvester\ControlCenter\ControlCenterGUI::$state_info

protected

Definition at line 47 of file ControlCenterGUI.php.

◆ $type

string ILIAS\MetaData\OERHarvester\ControlCenter\ControlCenterGUI::$type

protected

Definition at line 46 of file ControlCenterGUI.php.

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

components/ILIAS/MetaData/classes/OERHarvester/ControlCenter/ControlCenterGUI.php

Public Member Functions

Protected Member Functions

Protected Attributes

Detailed Description

Constructor & Destructor Documentation

◆ __construct()

Member Function Documentation

◆ accept()

◆ block()

◆ confirmAccept()

◆ confirmReject()

◆ confirmWithdraw()

◆ executeCommand()

◆ getRedirectTargetAfterDeletion()

◆ isCommandAvailable()

◆ publish()

◆ reject()

◆ showSuccessMessageAfterRedirect()

◆ submit()

◆ unblock()

◆ view()

◆ withdraw()

Field Documentation

◆ $obj_id

◆ $ref_id

◆ $state_info

◆ $type