Class ilADNNotificationGUI @ilCtrl_IsCalledBy ilADNNotificationGUI: ilObjAdministrativeNotificationGUI @ilCtrl_IsCalledBy ilADNNotificationGUI: ilObjAdministrativeNotificationGUI. More...

Inheritance diagram for ilADNNotificationGUI:

Collaboration diagram for ilADNNotificationGUI:

Public Member Functions
	__construct (ilADNTabHandling $tab_handling)

Public Member Functions inherited from ilADNAbstractGUI
	__construct (protected \ilADNTabHandling $tab_handling)
	ilADNAbstractGUI constructor. More...

	executeCommand ()

Data Fields
const	TAB_TABLE = 'notifications'

const	CMD_DEFAULT = 'index'

const	CMD_ADD = 'add'

const	CMD_CREATE = 'save'

const	CMD_UPDATE = 'update'

const	CMD_EDIT = 'edit'

const	CMD_DUPLICATE = 'duplicate'

const	CMD_CANCEL = 'cancel'

const	CMD_DELETE = 'delete'

const	CMD_RESET = 'reset'

const	CMD_CONFIRM_DELETE = 'confirmDelete'

Data Fields inherited from ilADNAbstractGUI
const	IDENTIFIER = 'identifier'

ilLanguage	$lng

ilGlobalTemplateInterface	$tpl

ilTree	$tree

Protected Member Functions
	dispatchCommand ($cmd)

	index ()

	add ()

	create ()

	cancel ()

	edit ()

	duplicate ()

	update ()

	delete ()

	reset ()

	confirmDelete ()

	getNotificationFromRequest ()
	@noinspection PhpIncompatibleReturnTypeInspection More...

	getNotificationsFromRequest ()

Protected Member Functions inherited from ilADNAbstractGUI
	determineCommand (?string $standard=null)

	dispatchCommand (string $cmd)

Protected Attributes
Table	$table

Protected Attributes inherited from ilADNAbstractGUI
UIServices	$ui

Services	$http

ilToolbarGUI	$toolbar

ilTabsGUI	$tabs

ilCtrl	$ctrl

ilObjAdministrativeNotificationAccess	$access

Private Attributes
readonly Factory	$ui_factory

readonly Renderer	$ui_renderer

Detailed Description

Class ilADNNotificationGUI @ilCtrl_IsCalledBy ilADNNotificationGUI: ilObjAdministrativeNotificationGUI @ilCtrl_IsCalledBy ilADNNotificationGUI: ilObjAdministrativeNotificationGUI.

Author: Fabian Schmid fs@st.nosp@m.uder.nosp@m.-raim.nosp@m.ann..nosp@m.ch

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

Constructor & Destructor Documentation

◆ __construct()

ilADNNotificationGUI::__construct ( ilADNTabHandling $tab_handling )

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

    {
        global $DIC;
        parent::__construct($tab_handling);
        $this->table = new Table($this);
        $this->ui_factory = $DIC->ui()->factory();
        $this->ui_renderer = $DIC->ui()->renderer();
    }

References $DIC, and ILIAS\GlobalScreen\Provider\__construct().

Here is the call graph for this function:

Member Function Documentation

◆ add()

ilADNNotificationGUI::add ( )

protected

Definition at line 106 of file class.ilADNNotificationGUI.php.

                            : string
    {
        $form = new ilADNNotificationUIFormGUI(
            new ilADNNotification(),
            $this->ctrl->getLinkTarget($this, self::CMD_CREATE)
        );
        return $form->getHTML();
    }

References ILIAS\Repository\ctrl().

Referenced by dispatchCommand().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ cancel()

ilADNNotificationGUI::cancel ( )

protected

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

                               : void
    {
        $this->ctrl->setParameter($this, self::IDENTIFIER, null);
        $this->ctrl->redirect($this, self::CMD_DEFAULT);
    }

References ILIAS\Repository\ctrl().

Referenced by delete(), duplicate(), and reset().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ confirmDelete()

ilADNNotificationGUI::confirmDelete ( )

protected

Definition at line 185 of file class.ilADNNotificationGUI.php.

                                      : void
    {
        $adns = $this->getNotificationsFromRequest();
 
        $stream = Streams::ofString(
            $this->ui_renderer->render(
                $this->ui_factory->modal()->interruptive(
                    $this->lng->txt('action_confirm_delete'),
                    $this->lng->txt('action_confirm_delete_msg'),
                    $this->ctrl->getLinkTarget($this, self::CMD_DELETE)
                )->withAffectedItems(
                    array_map(fn(ilADNNotification $adn): Standard => $this->ui_factory->modal()->interruptiveItem()->standard(
                        $adn->getId(),
                        $adn->getTitle()
                    ), $adns)
                )
            )
        );
        $this->http->saveResponse($this->http->response()->withBody($stream));
        $this->http->sendResponse();
        $this->http->close();
    }

References ilADNNotification\getId(), getNotificationsFromRequest(), ilADNNotification\getTitle(), and ILIAS\FileDelivery\http().

Referenced by dispatchCommand().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ create()

ilADNNotificationGUI::create ( )

protected

Definition at line 115 of file class.ilADNNotificationGUI.php.

                               : string
    {
        $form = new ilADNNotificationUIFormGUI(
            new ilADNNotification(),
            $this->ctrl->getLinkTarget($this, self::CMD_CREATE)
        );
        $form->setValuesByPost();
        if ($form->saveObject()) {
            $this->tpl->setOnScreenMessage('success', $this->lng->txt('msg_success_created'), true);
            $this->ctrl->redirect($this, self::CMD_DEFAULT);
        }
        return $form->getHTML();
    }

References ILIAS\Repository\ctrl(), and ILIAS\Repository\lng().

Referenced by dispatchCommand().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ delete()

ilADNNotificationGUI::delete ( )

protected

Definition at line 165 of file class.ilADNNotificationGUI.php.

                               : void
    {
        foreach ($this->getNotificationsFromRequest() as $notification) {
            $notification->delete();
        }
 
        $this->tpl->setOnScreenMessage('success', $this->lng->txt('msg_success_deleted'), true);
        $this->cancel();
    }

References cancel(), getNotificationsFromRequest(), and ILIAS\Repository\lng().

Here is the call graph for this function:

◆ dispatchCommand()

ilADNNotificationGUI::dispatchCommand ( $cmd )

protected

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

                                            : string
    {
        $this->tab_handling->initTabs(
            ilObjAdministrativeNotificationGUI::TAB_MAIN,
            'index',
            true
        );
        switch ($cmd) {
            case self::CMD_ADD:
                return $this->add();
            case self::CMD_CREATE:
                return $this->create();
            case self::CMD_EDIT:
                return $this->edit();
            case self::CMD_DUPLICATE:
                $this->duplicate();
                break;
            case self::CMD_UPDATE:
                return $this->update();
            case self::CMD_DELETE:
                $this->delete();
                break;
            case self::CMD_RESET:
                $this->reset();
                break;
            case self::CMD_CONFIRM_DELETE:
                $this->confirmDelete();
                break;
            case self::CMD_DEFAULT:
            default:
                return $this->index();
        }
 
        return "";
    }

References add(), CMD_ADD, CMD_CONFIRM_DELETE, CMD_CREATE, CMD_DEFAULT, CMD_DELETE, CMD_DUPLICATE, CMD_EDIT, CMD_RESET, CMD_UPDATE, confirmDelete(), create(), duplicate(), edit(), index(), reset(), ilObjAdministrativeNotificationGUI\TAB_MAIN, and update().

Here is the call graph for this function:

◆ duplicate()

ilADNNotificationGUI::duplicate ( )

protected

Definition at line 144 of file class.ilADNNotificationGUI.php.

                                  : void
    {
        $notification = $this->getNotificationFromRequest();
        $notification->setId(0);
        $notification->create();
        $this->tpl->setOnScreenMessage('success', $this->lng->txt('msg_success_duplicated'), true);
        $this->cancel();
    }

References cancel(), getNotificationFromRequest(), and ILIAS\Repository\lng().

Referenced by dispatchCommand().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ edit()

ilADNNotificationGUI::edit ( )

protected

Definition at line 135 of file class.ilADNNotificationGUI.php.

                             : string
    {
        $notification = $this->getNotificationFromRequest();
        $this->ctrl->setParameter($this, ilADNAbstractGUI::IDENTIFIER, $notification->getId());
 
        $form = new ilADNNotificationUIFormGUI($notification, $this->ctrl->getLinkTarget($this, self::CMD_UPDATE));
        return $form->getHTML();
    }

References ILIAS\Repository\ctrl(), getNotificationFromRequest(), and ilADNAbstractGUI\IDENTIFIER.

Referenced by dispatchCommand().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getNotificationFromRequest()

ilADNNotificationGUI::getNotificationFromRequest ( )

protected

@noinspection PhpIncompatibleReturnTypeInspection

Definition at line 209 of file class.ilADNNotificationGUI.php.

                                                   : ilADNNotification
    {
        return $this->getNotificationsFromRequest()[0];
    }

References getNotificationsFromRequest().

Referenced by duplicate(), edit(), and update().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getNotificationsFromRequest()

ilADNNotificationGUI::getNotificationsFromRequest ( )

protected

Returns: ilADNNotification[]

Definition at line 217 of file class.ilADNNotificationGUI.php.

                                                    : array
    {
        $query_params = $this->http->request()->getQueryParams(); // aka $_GET
        $name = $this->table->getIdToken()->getName(); // name of the query parameter from the table
        $field_ids = $query_params[$name] ?? []; // array of field ids
 
        // all objects
        if (($field_ids[0] ?? null) === 'ALL_OBJECTS') {
            return ilADNNotification::get();
        }
        // check ilADNAbstractGUI::IDENTIFIER
        if (($field_id = $this->http->request()->getQueryParams()[ilADNAbstractGUI::IDENTIFIER] ?? false)) {
            return [ilADNNotification::findOrFail((int) $field_id)];
        }
 
        $return = [];
        foreach ($field_ids as $field_id) {
            $return[] = ilADNNotification::findOrFail((int) $field_id);
        }
 
        // check interruptive items
        if (($interruptive_items = $this->http->request()->getParsedBody()['interruptive_items'] ?? false)) {
            foreach ($interruptive_items as $interruptive_item) {
                $return[] = ilADNNotification::findOrFail((int) $interruptive_item);
            }
        }
 
        return $return;
    }

References ActiveRecord\findOrFail(), ActiveRecord\get(), ILIAS\FileDelivery\http(), and ilADNAbstractGUI\IDENTIFIER.

Referenced by confirmDelete(), delete(), getNotificationFromRequest(), and reset().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ index()

ilADNNotificationGUI::index ( )

protected

Definition at line 93 of file class.ilADNNotificationGUI.php.

                              : string
    {
        $this->table = new Table($this);
        if ($this->access->hasUserPermissionTo('write')) {
            $btn_add_msg = $this->ui->factory()->button()->standard(
                $this->lng->txt('common_add_msg'),
                $this->ctrl->getLinkTarget($this, self::CMD_ADD)
            );
            $this->toolbar->addComponent($btn_add_msg);
        }
        return $this->table->getHTML();
    }

References ILIAS\Repository\access(), ILIAS\Repository\lng(), ILIAS\Repository\toolbar(), and ILIAS\Repository\ui().

Referenced by dispatchCommand().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ reset()

ilADNNotificationGUI::reset ( )

protected

Definition at line 175 of file class.ilADNNotificationGUI.php.

                              : void
    {
        foreach ($this->getNotificationsFromRequest() as $notification) {
            $notification->resetForAllUsers();
        }
 
        $this->tpl->setOnScreenMessage('success', $this->lng->txt('msg_success_reset'), true);
        $this->cancel();
    }

References cancel(), getNotificationsFromRequest(), and ILIAS\Repository\lng().

Referenced by dispatchCommand().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ update()

ilADNNotificationGUI::update ( )

protected

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

                               : string
    {
        $notification = $this->getNotificationFromRequest();
        $form = new ilADNNotificationUIFormGUI($notification, $this->ctrl->getLinkTarget($this, self::CMD_UPDATE));
        $form->setValuesByPost();
        if ($form->saveObject()) {
            $this->tpl->setOnScreenMessage('success', $this->lng->txt('msg_success_updated'), true);
            $this->ctrl->redirect($this, self::CMD_DEFAULT);
        }
        return $form->getHTML();
    }