Class ilCalendarAppointmentPresentationGUI. More...

Collaboration diagram for ilCalendarAppointmentPresentationGUI:

Public Member Functions
	setListItemMode (Item $a_val)
	Set list item mode. More...

	getListItem ()

	executeCommand ()

	getSeed ()
	Get seed date. More...

	getHTML ()

	getModalHTML ()

	modifyListItem ()
	Modify List item. More...

Static Public Member Functions
static	_getInstance (ilDate $seed, array $a_app)
	get singleton instance More...

Protected Member Functions
	__construct (ilDate $seed, array $a_app)

	getActivePlugins ()

	getContentByPlugins ($a_content, $a_toolbar)

Protected Attributes
const	MODE_MODAL = "modal"

const	MODE_LIST_ITEM = "list_item"

ilDate	$seed

ilCalendarSettings	$settings

array	$appointment = []

string	$mode = self::MODE_MODAL

ilToolbarGUI	$toolbar

ilInfoScreenGUI	$info_screen

ilLanguage	$lng

ilCtrlInterface	$ctrl

ilGlobalTemplateInterface	$tpl

HttpServices	$http

RefineryFactory	$refinery

Item	$list_item = null

Detailed Description

Class ilCalendarAppointmentPresentationGUI.

Author: Jesús López lopez.nosp@m.@lei.nosp@m.fos.c.nosp@m.om @ilCtrl_Calls ilCalendarAppointmentPresentationGUI: ilInfoScreenGUI, ilCalendarAppointmentGUI

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

Constructor & Destructor Documentation

◆ __construct()

ilCalendarAppointmentPresentationGUI::__construct	(	ilDate	$seed,
		array	$a_app
	)

protected

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

    {
        global $DIC;
 
        $this->http = $DIC->http();
        $this->refinery = $DIC->refinery();
        $this->lng = $DIC->language();
        $this->ctrl = $DIC->ctrl();
 
        $this->settings = ilCalendarSettings::_getInstance();
 
        $this->seed = $seed;
        $this->appointment = $a_app;
 
        $this->tpl = $DIC->ui()->mainTemplate();
        $this->info_screen = new ilInfoScreenGUI($this);
        $this->toolbar = new ilToolbarGUI();
    }

References $DIC, $seed, ilCalendarSettings\_getInstance(), ILIAS\Repository\ctrl(), ILIAS\FileDelivery\http(), ILIAS\Repository\lng(), ILIAS\Repository\refinery(), ILIAS\Repository\settings(), and ILIAS\Repository\toolbar().

Here is the call graph for this function:

Member Function Documentation

◆ _getInstance()

static ilCalendarAppointmentPresentationGUI::_getInstance	(	ilDate	$seed,
		array	$a_app
	)

static

get singleton instance

Definition at line 88 of file class.ilCalendarAppointmentPresentationGUI.php.

                                                                   : self
    {
        return new static($seed, $a_app);
    }

References $seed.

Referenced by ilCalendarAgendaListGUI\executeCommand(), ilCalendarBlockGUI\executeCommand(), ilCalendarDayGUI\executeCommand(), ilCalendarMonthGUI\executeCommand(), ilCalendarWeekGUI\executeCommand(), ilCalendarAgendaListGUI\getHTML(), ilCalendarBlockGUI\getModalForApp(), and ilCalendarViewGUI\getModalForApp().

Here is the caller graph for this function:

◆ executeCommand()

ilCalendarAppointmentPresentationGUI::executeCommand ( )

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

                                    : void
    {
        $next_class = $this->ctrl->getNextClass($this);
        $cmd = $this->ctrl->getCmd("getHTML");
 
        switch ($next_class) {
            case 'ilcalendarappointmentgui':
                $app_id = 0;
                if ($this->http->wrapper()->query()->has('app_id')) {
                    $app_id = $this->http->wrapper()->query()->retrieve(
                        'app_id',
                        $this->refinery->kindlyTo()->int()
                    );
                }
                $app = new ilCalendarAppointmentGUI($this->seed, $this->seed, $app_id);
                $this->ctrl->forwardCommand($app);
                break;
 
            default:
                if ($next_class != '') {
                    // get the path and include
                    $class_path = $this->ctrl->lookupClassPath($next_class);
 
                    // check if the class implements our interface
                    $class_name = $this->ctrl->getClassForClasspath($class_path);
                    if (in_array("ilCalendarAppointmentPresentation", class_implements($class_name))) {
                        // forward command to class
                        $gui_class = new $class_name($this->appointment, $this->info_screen, $this->toolbar, null);
                        $this->ctrl->forwardCommand($gui_class);
                    }
                }
                break;
        }
    }

References ILIAS\Repository\ctrl(), ILIAS\FileDelivery\http(), ILIAS\Repository\refinery(), and ILIAS\Repository\toolbar().

Here is the call graph for this function:

◆ getActivePlugins()

ilCalendarAppointmentPresentationGUI::getActivePlugins ( )

protected

Definition at line 191 of file class.ilCalendarAppointmentPresentationGUI.php.

                                         : Iterator
    {
        global $DIC;
 
        $component_factory = $DIC['component.factory'];
        return $component_factory->getActivePluginsInSlot("capm");
    }

References $DIC.

Referenced by getContentByPlugins().

Here is the caller graph for this function:

◆ getContentByPlugins()

ilCalendarAppointmentPresentationGUI::getContentByPlugins	(	$a_content,
		$a_toolbar
	)

protected

Definition at line 199 of file class.ilCalendarAppointmentPresentationGUI.php.

                                                                  : array
    {
        $content = $a_content;
        $toolbar = $a_toolbar;
        foreach ($this->getActivePlugins() as $plugin) {
            //pass only the appointment stuff
            $plugin->setAppointment($this->appointment['event'], new ilDateTime($this->appointment['dstart']));
            if ($new_infoscreen = $plugin->infoscreenAddContent($this->info_screen)) {
                $this->info_screen = $new_infoscreen;
            }
            $content = $this->info_screen->getHTML();
            $extra_content = $plugin->addExtraContent();
            if ($extra_content != '') {
                $content .= $extra_content;
            }
 
            if ($new_content = $plugin->replaceContent()) {
                $content = $new_content;
            }
 
            if ($new_toolbar = $plugin->toolbarAddItems($toolbar)) {
                $toolbar = $new_toolbar;
            }
 
            if ($new_toolbar = $plugin->toolbarReplaceContent()) {
                $new_toolbar->setId((string) $a_toolbar->getId());
                $toolbar = $new_toolbar;
            }
        }
        return array(
            'content' => $content,
            'toolbar' => $toolbar
        );
    }

References XapiProxy\$plugin, $toolbar, getActivePlugins(), and ilToolbarGUI\setId().

Referenced by getModalHTML().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getHTML()

ilCalendarAppointmentPresentationGUI::getHTML ( )

Definition at line 136 of file class.ilCalendarAppointmentPresentationGUI.php.

                             : string
    {
        if ($this->mode == self::MODE_MODAL) {
            return $this->getModalHTML();
        }
        if ($this->mode == self::MODE_LIST_ITEM) {
            return $this->modifyListItem();
        }
        return "";
    }

References getModalHTML(), and modifyListItem().

Here is the call graph for this function:

◆ getListItem()

ilCalendarAppointmentPresentationGUI::getListItem ( )

Definition at line 80 of file class.ilCalendarAppointmentPresentationGUI.php.

                                 : Item
    {
        return $this->list_item;
    }

References $list_item.

Referenced by modifyListItem().

Here is the caller graph for this function:

◆ getModalHTML()

ilCalendarAppointmentPresentationGUI::getModalHTML ( )

Definition at line 147 of file class.ilCalendarAppointmentPresentationGUI.php.

                                  : string
    {
        $tpl = new ilTemplate('tpl.appointment_presentation.html', true, true, 'components/ILIAS/Calendar');
 
        $info_screen = $this->info_screen;
        $info_screen->setFormAction($this->ctrl->getFormAction($this));
 
        #21529 create new toolbar with unique id using the entry id for this purpose
        $toolbar = new ilToolbarGUI();
        $toolbar->setId((string) $this->appointment['event']->getEntryId());
 
        $f = ilAppointmentPresentationFactory::getInstance($this->appointment, $info_screen, $toolbar, null);
 
        $this->ctrl->getHTML($f);
        $content = $info_screen->getHTML();
 
        //because #21529
        $plugin_results = $this->getContentByPlugins($content, $toolbar);
        $content = $plugin_results['content'];
        $toolbar = $plugin_results['toolbar'];
 
        // show toolbar
        $tpl->setCurrentBlock("toolbar");
        $tpl->setVariable("TOOLBAR", $toolbar->getHTML());
        $tpl->parseCurrentBlock();
 
        // show infoscreen
        $tpl->setVariable("CONTENT", $content);
 
        return $tpl->get();
    }

References Vendor\Package\$f, $info_screen, $toolbar, $tpl, ILIAS\Repository\ctrl(), ILIAS\UICore\GlobalTemplate\get(), getContentByPlugins(), ilInfoScreenGUI\getHTML(), ilAppointmentPresentationFactory\getInstance(), ILIAS\UICore\GlobalTemplate\parseCurrentBlock(), ILIAS\UICore\GlobalTemplate\setCurrentBlock(), ilInfoScreenGUI\setFormAction(), ilToolbarGUI\setId(), and ILIAS\UICore\GlobalTemplate\setVariable().

Referenced by getHTML().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getSeed()

ilCalendarAppointmentPresentationGUI::getSeed ( )

Get seed date.

Definition at line 131 of file class.ilCalendarAppointmentPresentationGUI.php.

                             : ilDate
    {
        return $this->seed;
    }

References $seed.

◆ modifyListItem()

ilCalendarAppointmentPresentationGUI::modifyListItem ( )

Modify List item.

Definition at line 182 of file class.ilCalendarAppointmentPresentationGUI.php.

                                    : string
    {
        $li = $this->getListItem();
        $f = ilAppointmentPresentationFactory::getInstance($this->appointment, null, null, $li);
        $this->ctrl->getHTML($f);
        $this->list_item = $f->getListItem();
        return '';
    }

References Vendor\Package\$f, ILIAS\Repository\ctrl(), ilAppointmentPresentationFactory\getInstance(), and getListItem().

Referenced by getHTML().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ setListItemMode()

ilCalendarAppointmentPresentationGUI::setListItemMode ( Item $a_val )

Set list item mode.

Definition at line 74 of file class.ilCalendarAppointmentPresentationGUI.php.

    {
        $this->list_item = $a_val;
        $this->mode = self::MODE_LIST_ITEM;
    }

References MODE_LIST_ITEM.

Field Documentation

◆ $appointment

array ilCalendarAppointmentPresentationGUI::$appointment = []

protected

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

◆ $ctrl

ilCtrlInterface ilCalendarAppointmentPresentationGUI::$ctrl

protected

Definition at line 44 of file class.ilCalendarAppointmentPresentationGUI.php.

◆ $http

HttpServices ilCalendarAppointmentPresentationGUI::$http

protected

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

◆ $info_screen

ilInfoScreenGUI ilCalendarAppointmentPresentationGUI::$info_screen

protected

Definition at line 42 of file class.ilCalendarAppointmentPresentationGUI.php.

Referenced by getModalHTML().

◆ $list_item

Item ilCalendarAppointmentPresentationGUI::$list_item = null

protected

Definition at line 50 of file class.ilCalendarAppointmentPresentationGUI.php.

Referenced by getListItem().

◆ $lng

ilLanguage ilCalendarAppointmentPresentationGUI::$lng

protected

Definition at line 43 of file class.ilCalendarAppointmentPresentationGUI.php.

◆ $mode

string ilCalendarAppointmentPresentationGUI::$mode = self::MODE_MODAL

protected

Definition at line 39 of file class.ilCalendarAppointmentPresentationGUI.php.

◆ $refinery

RefineryFactory ilCalendarAppointmentPresentationGUI::$refinery

protected

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

◆ $seed

ilDate ilCalendarAppointmentPresentationGUI::$seed

protected

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

Referenced by __construct(), _getInstance(), and getSeed().

◆ $settings

ilCalendarSettings ilCalendarAppointmentPresentationGUI::$settings

protected

Definition at line 36 of file class.ilCalendarAppointmentPresentationGUI.php.

◆ $toolbar

ilToolbarGUI ilCalendarAppointmentPresentationGUI::$toolbar

protected

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

Referenced by getContentByPlugins(), and getModalHTML().

◆ $tpl

ilGlobalTemplateInterface ilCalendarAppointmentPresentationGUI::$tpl

protected

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

Referenced by getModalHTML().

◆ MODE_LIST_ITEM

const ilCalendarAppointmentPresentationGUI::MODE_LIST_ITEM = "list_item"

protected

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

Referenced by setListItemMode().

◆ MODE_MODAL

const ilCalendarAppointmentPresentationGUI::MODE_MODAL = "modal"

protected

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

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

components/ILIAS/Calendar/classes/class.ilCalendarAppointmentPresentationGUI.php

Public Member Functions

Static Public Member Functions

Protected Member Functions

Protected Attributes

Detailed Description

Constructor & Destructor Documentation

◆ __construct()

Member Function Documentation

◆ _getInstance()

◆ executeCommand()

◆ getActivePlugins()

◆ getContentByPlugins()

◆ getHTML()

◆ getListItem()

◆ getModalHTML()

◆ getSeed()

◆ modifyListItem()

◆ setListItemMode()

Field Documentation

◆ $appointment

◆ $ctrl

◆ $http

◆ $info_screen

◆ $list_item

◆ $lng

◆ $mode

◆ $refinery

◆ $seed

◆ $settings

◆ $toolbar

◆ $tpl

◆ MODE_LIST_ITEM

◆ MODE_MODAL