Class ilADNNotificationGUI ilADNNotificationGUI: ilObjAdministrativeNotificationGUI ilADNNotificationGUI: ilObjAdministrativeNotificationGUI. More...

Inheritance diagram for ilADNNotificationGUI:

Collaboration diagram for ilADNNotificationGUI:

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_CANCEL = 'cancel'

const	CMD_DELETE = 'delete'

const	CMD_CONFIRM_DELETE = 'confirmDelete'

const	CMD_CONFIRM_RESET = 'confirmReset'

const	CMD_RESET = 'reset'

Data Fields inherited from ilADNAbstractGUI
const	IDENTIFIER = 'identifier'

	$lng

	$tpl

	$tree

Protected Member Functions
	dispatchCommand ($cmd)

	index ()

	add ()

	create ()

	cancel ()

	edit ()

	update ()

	confirmDelete ()

	delete ()

	confirmReset ()

	reset ()

	getNotificationFromRequest ()

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

	dispatchCommand (string $cmd)

Additional Inherited Members
Public Member Functions inherited from ilADNAbstractGUI
	__construct (ilADNTabHandling $tab_handling)
	ilADNAbstractGUI constructor. More...

	executeCommand ()

Protected Attributes inherited from ilADNAbstractGUI
	$ui

	$http

	$toolbar

	$tab_handling

	$tabs

	$ctrl

	$access

Detailed Description

Class ilADNNotificationGUI ilADNNotificationGUI: ilObjAdministrativeNotificationGUI ilADNNotificationGUI: ilObjAdministrativeNotificationGUI.

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

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

Member Function Documentation

◆ add()

ilADNNotificationGUI::add ( )

protected

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

References ilADNNotificationUIFormGUI\fillForm().

Referenced by dispatchCommand().

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

Here is the call graph for this function:

Here is the caller graph for this function:

◆ cancel()

ilADNNotificationGUI::cancel ( )

protected

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

Referenced by delete(), and reset().

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

Here is the caller graph for this function:

◆ confirmDelete()

ilADNNotificationGUI::confirmDelete ( )

protected

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

References getNotificationFromRequest().

Referenced by dispatchCommand().

                                        : string
     {
         $notification = $this->getNotificationFromRequest();
         $confirmation = new ilConfirmationGUI();
         $confirmation->setFormAction($this->ctrl->getFormAction($this));
         $confirmation->addItem(self::IDENTIFIER, $notification->getId(), $notification->getTitle());
         $confirmation->setCancel($this->lng->txt('msg_form_button_cancel'), self::CMD_CANCEL);
         $confirmation->setConfirm($this->lng->txt('msg_form_button_delete'), self::CMD_DELETE);
 
         return $confirmation->getHTML();
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ confirmReset()

ilADNNotificationGUI::confirmReset ( )

protected

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

References getNotificationFromRequest().

Referenced by dispatchCommand().

                                       : string
     {
         $notification = $this->getNotificationFromRequest();
         $confirmation = new ilConfirmationGUI();
         $confirmation->setFormAction($this->ctrl->getFormAction($this));
         $confirmation->addItem(self::IDENTIFIER, $notification->getId(), $notification->getTitle());
         $confirmation->setCancel($this->lng->txt('msg_form_button_cancel'), self::CMD_CANCEL);
         $confirmation->setConfirm($this->lng->txt('msg_form_button_reset'), self::CMD_RESET);
 
         return $confirmation->getHTML();
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ create()

ilADNNotificationGUI::create ( )

protected

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

References ilADNNotificationUIFormGUI\setValuesByPost().

Referenced by dispatchCommand().

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

Here is the call graph for this function:

Here is the caller graph for this function:

◆ delete()

ilADNNotificationGUI::delete ( )

protected

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

References cancel(), and getNotificationFromRequest().

                                 : void
     {
         $notification = $this->getNotificationFromRequest();
         $notification->delete();
         ilUtil::sendSuccess($this->lng->txt('msg_success_deleted'), true);
         $this->cancel();
     }

Here is the call graph for this function:

◆ dispatchCommand()

ilADNNotificationGUI::dispatchCommand ( $cmd )

protected

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

References add(), ilMMSubItemGUI\CMD_VIEW_SUB_ITEMS, confirmDelete(), confirmReset(), create(), edit(), index(), reset(), ilObjAdministrativeNotificationGUI\TAB_MAIN, and update().

                                              : string
     {
         $this->tab_handling->initTabs(
             ilObjAdministrativeNotificationGUI::TAB_MAIN,
             ilMMSubItemGUI::CMD_VIEW_SUB_ITEMS,
             true,
             self::class
         );
         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_UPDATE:
                 return $this->update();
             case self::CMD_CONFIRM_DELETE:
                 return $this->confirmDelete();
             case self::CMD_DELETE:
                 $this->delete();
                 break;
             case self::CMD_CONFIRM_RESET:
                 return $this->confirmReset();
             case self::CMD_RESET:
                 return $this->reset();
             case self::CMD_DEFAULT:
             default:
                 return $this->index();
 
         }
 
         return "";
     }

Here is the call graph for this function:

◆ edit()

ilADNNotificationGUI::edit ( )

protected

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

References ilADNNotificationUIFormGUI\fillForm(), getNotificationFromRequest(), and ilADNAbstractGUI\IDENTIFIER.

Referenced by dispatchCommand().

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

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getNotificationFromRequest()

ilADNNotificationGUI::getNotificationFromRequest ( )

protected

Returns: ilADNNotification

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

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

Referenced by confirmDelete(), confirmReset(), delete(), edit(), reset(), and update().

                                                     : ActiveRecord
     {
         if (isset($this->http->request()->getParsedBody()[self::IDENTIFIER])) {
             $identifier = $this->http->request()->getParsedBody()[self::IDENTIFIER];
         } elseif (isset($this->http->request()->getParsedBody()['interruptive_items'][0])) {
             $identifier = $this->http->request()->getParsedBody()['interruptive_items'][0];
         } else {
             $identifier = $this->http->request()->getQueryParams()[self::IDENTIFIER];
         }
 
         return ilADNNotification::findOrFail($identifier);
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ index()

ilADNNotificationGUI::index ( )

protected

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

References ilLinkButton\getInstance().

Referenced by dispatchCommand().

                                : string
     {
         if ($this->access->hasUserPermissionTo('write')) {
             $button = ilLinkButton::getInstance();
             $button->setCaption($this->lng->txt('common_add_msg'), false);
             $button->setUrl($this->ctrl->getLinkTarget($this, self::CMD_ADD));
             $this->toolbar->addButtonInstance($button);
         }
 
         $notMessageTableGUI = new ilADNNotificationTableGUI($this, self::CMD_DEFAULT);
         return $notMessageTableGUI->getHTML();
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ reset()

ilADNNotificationGUI::reset ( )

protected

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

References cancel(), and getNotificationFromRequest().

Referenced by dispatchCommand().

     {
         $notification = $this->getNotificationFromRequest();
 
         $notification->resetForAllUsers();
         ilUtil::sendSuccess($this->lng->txt('msg_success_reset'), true);
         $this->cancel();
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ update()

ilADNNotificationGUI::update ( )

protected

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

References getNotificationFromRequest(), and ilADNNotificationUIFormGUI\setValuesByPost().

Referenced by dispatchCommand().

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