ilResourceOverviewGUI Class Reference

Collaboration diagram for ilResourceOverviewGUI:

Public Member Functions
	__construct ()
	executeCommand ()

Data Fields
const	CMD_INDEX = 'index'
const	CMD_REMOVE = 'remove'
const	CMD_DOWNLOAD = 'download'
const	CMD_SHOW_REVISIONS = 'showRevisions'
const	CMD_GOTO_RESOURCE = 'gotoResource'
const	P_RESOURCE_ID = 'resource_id'

Protected Member Functions
	initBackTab ()

Protected Attributes
ilCtrlInterface	$ctrl
ilLanguage	$language
Renderer	$ui_renderer
ilGlobalTemplateInterface	$main_tpl
Services	$irss
FileUpload	$upload
ILIAS HTTP Services	$http
Factory	$refinery
ResourceCollection	$collection
ResourceStakeholder	$stakeholder
ArrayBasedRequestWrapper	$query

Private Member Functions
	index ()
	showRevisions ()
	download ()
	getResourceIdFromRequest ()

Private Attributes
WrapperFactory	$wrapper
ilTabsGUI	$tabs

Detailed Description

Author

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

ilResourceOverviewGUI: ilObjFileServicesGUI ilResourceOverviewGUI: ilResourceCollectionGUI

Definition at line 41 of file class.ilResourceOverviewGUI.php.

Constructor & Destructor Documentation

__construct()

ilResourceOverviewGUI::__construct ( )

final

Definition at line 69 of file class.ilResourceOverviewGUI.php.

References $DIC, ILIAS\Repository\ctrl(), ILIAS\UI\examples\Symbol\Glyph\Language\language(), ILIAS\Repository\refinery(), ILIAS\Repository\tabs(), and ILIAS\Repository\upload().

    {
        global $DIC;
        // Services
        $this->irss = $DIC->resourceStorage();
        $this->ctrl = $DIC->ctrl();
        $this->language = $DIC->language();
        $this->language->loadLanguageModule('irss');
        $this->main_tpl = $DIC->ui()->mainTemplate();
        $this->upload = $DIC->upload();
        $this->wrapper = $DIC->http()->wrapper();
        $this->refinery = $DIC->refinery();
        $this->ui_renderer = $DIC->ui()->renderer();
        $this->tabs = $DIC->tabs();
    }

Here is the call graph for this function:

Member Function Documentation

download()

ilResourceOverviewGUI::download ( )

private

Definition at line 184 of file class.ilResourceOverviewGUI.php.

References ILIAS\Repository\ctrl(), getResourceIdFromRequest(), and ILIAS\UI\examples\Symbol\Glyph\Language\language().

Referenced by executeCommand().

                               : void
    {
        $rid = $this->getResourceIdFromRequest();
        if (!$rid instanceof ResourceIdentification) {
            $this->main_tpl->setOnScreenMessage('failure', $this->language->txt('msg_no_perm_read'), true);
            $this->ctrl->redirect($this, self::CMD_INDEX);
            return;
        }
        $this->irss->consume()->download($rid)->run();
    }

Here is the call graph for this function:

Here is the caller graph for this function:

executeCommand()

ilResourceOverviewGUI::executeCommand ( )

final

Definition at line 98 of file class.ilResourceOverviewGUI.php.

References ILIAS\Repository\ctrl(), download(), index(), and showRevisions().

                                          : void
    {
        switch ($this->ctrl->getCmd(self::CMD_INDEX)) {
            case self::CMD_INDEX:
                $this->index();
                break;
            case self::CMD_DOWNLOAD:
                $this->download();
                break;
            case self::CMD_SHOW_REVISIONS:
                $this->showRevisions();
                break;
            case self::CMD_GOTO_RESOURCE:
                $this->gotoResource();
                break;
        }
    }

Here is the call graph for this function:

getResourceIdFromRequest()

ilResourceOverviewGUI::getResourceIdFromRequest ( )

private

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

References null, and ILIAS\Repository\refinery().

Referenced by download(), index(), and showRevisions().

                                               : ?ResourceIdentification
    {
        $rid = $this->wrapper->query()->has(self::P_RESOURCE_ID) ? $this->wrapper->query()->retrieve(
            self::P_RESOURCE_ID,
            $this->refinery->to()->string()
        ) : ($this->wrapper->post()->has(self::P_RESOURCE_ID)
            ? $this->wrapper->post()->retrieve(self::P_RESOURCE_ID, $this->refinery->to()->string())
            : null);

        if ($rid === null) {
            return null;
        }

        return $this->irss->manage()->find($rid);
    }

Here is the call graph for this function:

Here is the caller graph for this function:

index()

ilResourceOverviewGUI::index ( )

private

Definition at line 116 of file class.ilResourceOverviewGUI.php.

References ILIAS\Repository\ctrl(), ILIAS\ResourceStorage\Stakeholder\ResourceStakeholder\getLocationURIForResourceUsage(), getResourceIdFromRequest(), initBackTab(), ILIAS\UI\examples\Symbol\Glyph\Language\language(), and null.

Referenced by executeCommand().

                            : void
    {
        $listing = new ResourceListingUI(
            new ViewDefinition(
                self::class,
                self::CMD_INDEX,
                $this->language->txt('resource_overview')
            ),
            new AllResourcesDataSource(),
            new OverviewActionGenerator()
        );

        $this->main_tpl->setContent(
            $this->ui_renderer->render($listing->getComponents())
        );
    }

Here is the call graph for this function:

Here is the caller graph for this function:

initBackTab()

ilResourceOverviewGUI::initBackTab ( )

protected

Returns

void

Exceptions

ilCtrlException

Definition at line 89 of file class.ilResourceOverviewGUI.php.

References ILIAS\Repository\ctrl(), ILIAS\UI\examples\Symbol\Glyph\Language\language(), and ILIAS\Repository\tabs().

Referenced by index(), and showRevisions().

                                    : void
    {
        $this->tabs->clearTargets();
        $this->tabs->setBackTarget(
            $this->language->txt('back'),
            $this->ctrl->getLinkTarget($this, self::CMD_INDEX)
        );
    }

Here is the call graph for this function:

Here is the caller graph for this function:

showRevisions()

ilResourceOverviewGUI::showRevisions ( )

private

Definition at line 159 of file class.ilResourceOverviewGUI.php.

References getResourceIdFromRequest(), initBackTab(), ILIAS\UI\examples\Symbol\Glyph\Language\language(), and ILIAS\components\ResourceStorage\Resources\Listing\ViewDefinition\setMode().

Referenced by executeCommand().

                                    : void
    {
        $this->initBackTab();

        $rid = $this->getResourceIdFromRequest();
        $resource = $this->irss->manage()->getResource($rid);

        $view_definition = new ViewDefinition(
            self::class,
            self::CMD_SHOW_REVISIONS,
            $this->language->txt('resource_overview')
        );
        $view_definition->setMode(ViewDefinition::MODE_AS_TABLE);
        $listing = new RevisionListingUI(
            $view_definition,
            $resource
        );


        $this->main_tpl->setContent(
            $this->ui_renderer->render($listing->getComponents())
        );
    }

Here is the call graph for this function:

Here is the caller graph for this function:

Field Documentation

$collection

ResourceCollection ilResourceOverviewGUI::$collection

protected

Definition at line 63 of file class.ilResourceOverviewGUI.php.

$ctrl

ilCtrlInterface ilResourceOverviewGUI::$ctrl

protected

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

$http

ILIAS HTTP Services ilResourceOverviewGUI::$http

protected

Definition at line 61 of file class.ilResourceOverviewGUI.php.

$irss

Services ilResourceOverviewGUI::$irss

protected

Definition at line 59 of file class.ilResourceOverviewGUI.php.

$language

ilLanguage ilResourceOverviewGUI::$language

protected

Definition at line 56 of file class.ilResourceOverviewGUI.php.

$main_tpl

ilGlobalTemplateInterface ilResourceOverviewGUI::$main_tpl

protected

Definition at line 58 of file class.ilResourceOverviewGUI.php.

$query

ArrayBasedRequestWrapper ilResourceOverviewGUI::$query

protected

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

$refinery

Factory ilResourceOverviewGUI::$refinery

protected

Definition at line 62 of file class.ilResourceOverviewGUI.php.

$stakeholder

ResourceStakeholder ilResourceOverviewGUI::$stakeholder

protected

Definition at line 64 of file class.ilResourceOverviewGUI.php.

$tabs

ilTabsGUI ilResourceOverviewGUI::$tabs

private

Definition at line 67 of file class.ilResourceOverviewGUI.php.

$ui_renderer

Renderer ilResourceOverviewGUI::$ui_renderer

protected

Definition at line 57 of file class.ilResourceOverviewGUI.php.

$upload

FileUpload ilResourceOverviewGUI::$upload

protected

Definition at line 60 of file class.ilResourceOverviewGUI.php.

$wrapper

WrapperFactory ilResourceOverviewGUI::$wrapper

private

Definition at line 66 of file class.ilResourceOverviewGUI.php.

CMD_DOWNLOAD

const ilResourceOverviewGUI::CMD_DOWNLOAD = 'download'

Definition at line 47 of file class.ilResourceOverviewGUI.php.

Referenced by ILIAS\components\ResourceStorage\Resources\UI\Actions\OverviewActionGenerator\getActionsForRevision().

CMD_GOTO_RESOURCE

const ilResourceOverviewGUI::CMD_GOTO_RESOURCE = 'gotoResource'

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

Referenced by ILIAS\components\ResourceStorage\Resources\UI\Actions\OverviewActionGenerator\getActionsForRevision().

CMD_INDEX

const ilResourceOverviewGUI::CMD_INDEX = 'index'

Definition at line 45 of file class.ilResourceOverviewGUI.php.

CMD_REMOVE

const ilResourceOverviewGUI::CMD_REMOVE = 'remove'

Definition at line 46 of file class.ilResourceOverviewGUI.php.

Referenced by ILIAS\components\ResourceStorage\Resources\UI\Actions\OverviewActionGenerator\getRemoveConfirmationModal().

CMD_SHOW_REVISIONS

const ilResourceOverviewGUI::CMD_SHOW_REVISIONS = 'showRevisions'

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

Referenced by ILIAS\components\ResourceStorage\Resources\UI\Actions\OverviewActionGenerator\getActionsForRevision().

P_RESOURCE_ID

const ilResourceOverviewGUI::P_RESOURCE_ID = 'resource_id'

Definition at line 52 of file class.ilResourceOverviewGUI.php.

Referenced by ILIAS\components\ResourceStorage\Resources\UI\Actions\OverviewActionGenerator\getActionsForRevision().

---

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

• components/ILIAS/ResourceStorage/classes/Resources/class.ilResourceOverviewGUI.php