ilCalendarBlockGUI Class Reference

Calendar blocks, displayed in different contexts, e.g. More...

Inheritance diagram for ilCalendarBlockGUI:

Collaboration diagram for ilCalendarBlockGUI:

Public Member Functions
	ilCalendarBlockGUI ($a_skip_init=false)
	Constructor. More...
&	executeCommand ()
	execute command More...
	setEnableEdit ($a_enable_edit=0)
	Set EnableEdit. More...
	getEnableEdit ()
	Get EnableEdit. More...
	fillDataSection ()
	Fill data section. More...
	addMiniMonth ($a_tpl)
	Add mini version of monthly overview (Maybe extracted to another class, if used in pd calendar tab. More...
	getHTML ()
	Get bloch HTML code. More...
	getOverview ()
	Get overview. More...
	addCloseCommand ($a_content_block)
	setSeed ()
	Set seed. More...
	returnToUpperContext ()
	Return to upper context. More...
	showCalendarSubscription ()
	fillFooter ()
	setFooterLinks ()
	setPdModeEvents ()
	setPdModeMonth ()
	getData ()
	Get Data. More...
Public Member Functions inherited from ilBlockGUI
	ilBlockGUI ()
	Constructor. More...
	addHeaderLink ($a_href, $a_text, $status=true)
	getHeaderLinks ()
	setData ($a_data)
	Set Data. More...
	getData ()
	Get Data. More...
	setBigMode ($a_bigmode)
	Set Big Mode. More...
	getBigMode ()
	Get Big Mode. More...
	setBlockId ($a_block_id=0)
	Set Block Id. More...
	getBlockId ()
	Get Block Id. More...
	setAvailableDetailLevels ($a_max, $a_min=0)
	Set Available Detail Levels. More...
	setCurrentDetailLevel ($a_currentdetaillevel)
	Set Current Detail Level. More...
	setGuiObject (&$a_gui_object)
	Set GuiObject. More...
	getGuiObject ()
	Get GuiObject. More...
	getCurrentDetailLevel ()
	Get Current Detail Level. More...
	setTitle ($a_title)
	Set Title. More...
	getTitle ()
	Get Title. More...
	setImage ($a_image)
	Set Image. More...
	getImage ()
	Get Image. More...
	setOffset ($a_offset)
	Set Offset. More...
	getOffset ()
	Get Offset. More...
	correctOffset ()
	setLimit ($a_limit)
	Set Limit. More...
	getLimit ()
	Get Limit. More...
	setEnableEdit ($a_enableedit)
	Set EnableEdit. More...
	getEnableEdit ()
	Get EnableEdit. More...
	setRepositoryMode ($a_repositorymode)
	Set RepositoryMode. More...
	getRepositoryMode ()
	Get RepositoryMode. More...
	setFooterInfo ($a_footerinfo, $a_hide_and_icon=false)
	Set Footer Info. More...
	getFooterInfo ($a_hide_and_icon=false)
	Get Footer Info. More...
	setSubtitle ($a_subtitle)
	Set Subtitle. More...
	getSubtitle ()
	Get Subtitle. More...
	setRefId ($a_refid)
	Set Ref Id (only used if isRepositoryObject() is true). More...
	getRefId ()
	Get Ref Id (only used if isRepositoryObject() is true). More...
	setAdminCommands ($a_admincommands)
	Set Administration Commmands. More...
	getAdminCommands ()
	Get Administration Commmands. More...
	setColSpan ($a_colspan)
	Set Columns Span. More...
	getColSpan ()
	Get Columns Span. More...
	setEnableDetailRow ($a_enabledetailrow)
	Set EnableDetailRow. More...
	getEnableDetailRow ()
	Get EnableDetailRow. More...
	setEnableNumInfo ($a_enablenuminfo)
	Set Enable Item Number Info. More...
	getEnableNumInfo ()
	Get Enable Item Number Info. More...
	setProperties ($a_properties)
	This function is supposed to be used for block type specific properties, that should be inherited through ilColumnGUI->setBlockProperties. More...
	getProperty ($a_property)
	setProperty ($a_property, $a_value)
	setRowTemplate ($a_rowtemplatename, $a_rowtemplatedir="")
	Set Row Template Name. More...
	getNavParameter ()
	getDetailParameter ()
	getConfigParameter ()
	getMoveParameter ()
	getRowTemplateName ()
	Get Row Template Name. More...
	getRowTemplateDir ()
	Get Row Template Directory. More...
	addBlockCommand ($a_href, $a_text, $a_target="", $a_img="", $a_right_aligned=false, $a_checked=false, $a_html="")
	Add Block Command. More...
	getBlockCommands ()
	Get Block commands. More...
	addHeaderCommand ($a_href, $a_text, $a_as_close=false)
	Add Header Block Command. More...
	getHeaderCommands ()
	Get Header Block commands. More...
	addFooterLink ($a_text, $a_href="", $a_onclick="", $a_block_id="", $a_top=false, $a_omit_separator=false, $a_checked=false)
	Add a footer text/link. More...
	getFooterLinks ()
	Get footer links. More...
	clearFooterLinks ()
	Clear footer links. More...
	handleDetailLevel ()
	Handle read/write current detail level. More...
	getHTML ()
	Handle config status. More...
	fillHeaderCommands ()
	Fill header commands block. More...
	fillHeaderTitleBlock ()
	Fill header title block (title and. More...
	setDataSection ($a_content)
	Call this from overwritten fillDataSection(), if standard row based data is not used. More...
	fillDataSection ()
	Standard implementation for row based data. More...
	fillRow ($a_set)
	fillFooter ()
	fillPreviousNext ()
	Fill previous/next row. More...
	setPreviousNextLinks ()
	Get previous/next linkbar. More...
	fillFooterLinks ($a_top=false, $a_numinfo="")
	Fill footer links. More...
	fillDetailRow ()
	Fill Detail Setting Row. More...

Static Public Member Functions
static	getBlockType ()
	Get block type. More...
static	isRepositoryObject ()
	Is this a repository object. More...
static	getScreenMode ()
	Get Screen Mode for current command. More...
static	getBlockType ()
static	isRepositoryObject ()
static	getScreenMode ()
	Get Screen Mode for current command. More...

Data Fields
	$ctrl = null

Static Public Attributes
static	$block_type = "cal"
static	$st_data

Protected Member Functions
	initCategories ()
	init categories More...
	setSubTabs ()
Protected Member Functions inherited from ilBlockGUI
	fillRowColor ($a_placeholder="CSS_ROW")
	preloadData (array $data)
	Can be overwritten in subclasses. More...

Protected Attributes
	$mode
	$display_mode
Protected Attributes inherited from ilBlockGUI
	$data = array()
	$colspan = 1
	$enablenuminfo = true
	$detail_min = 0
	$detail_max = 0
	$bigmode = false
	$footer_links = array()
	$block_id = 0
	$header_commands = array()
	$allow_moving = true
	$move = array("left" => false, "right" => false, "up" => false, "down" => false)
	$enabledetailrow = true
	$header_links = array()
	$footerinfo = false
	$footerinfo_icon = false
	$block_commands = array()
	$max_count = false
	$close_command = false
	$image = false
	$property = false
	$nav_value = ""
	$css_row = ""
	$dropdown

Detailed Description

Calendar blocks, displayed in different contexts, e.g.

groups and courses

Author

Alex Killing alex..nosp@m.kill.nosp@m.ing@g.nosp@m.mx.d.nosp@m.e

Version

$Id$

@ilCtrl_IsCalledBy ilCalendarBlockGUI: ilColumnGUI @ilCtrl_Calls ilCalendarBlockGUI: ilCalendarDayGUI, ilCalendarAppointmentGUI @ilCtrl_Calls ilCalendarBlockGUI: ilCalendarMonthGUI, ilCalendarWeekGUI, ilCalendarInboxGUI @ilCtrl_Calls ilCalendarBlockGUI: ilConsultationHoursGUI

Definition at line 40 of file class.ilCalendarBlockGUI.php.

Member Function Documentation

addCloseCommand()

ilCalendarBlockGUI::addCloseCommand

(

$a_content_block

)

Definition at line 629 of file class.ilCalendarBlockGUI.php.

        {
                global $lng, $ilCtrl;
                
                $a_content_block->addHeaderCommand($ilCtrl->getParentReturn($this),
                        $lng->txt("close"), true);
        }

References $ilCtrl, and $lng.

addMiniMonth()

ilCalendarBlockGUI::addMiniMonth

(

$a_tpl

)

Add mini version of monthly overview (Maybe extracted to another class, if used in pd calendar tab.

Definition at line 298 of file class.ilCalendarBlockGUI.php.

        {
                global $ilCtrl, $lng,$ilUser;
                
                // weekdays
                include_once('Services/Calendar/classes/class.ilCalendarUtil.php');
                $a_tpl->setCurrentBlock('month_header_col');
                $a_tpl->setVariable('TXT_WEEKDAY', $lng->txt("cal_week_abbrev"));
                $a_tpl->parseCurrentBlock();
                for($i = (int) $this->user_settings->getWeekStart();$i < (7 + (int) $this->user_settings->getWeekStart());$i++)
                {
                        $a_tpl->setCurrentBlock('month_header_col');
                        $a_tpl->setVariable('TXT_WEEKDAY',ilCalendarUtil::_numericDayToString($i,false));
                        $a_tpl->parseCurrentBlock();
                }
 
                if(isset($_GET["bkid"]))
                {
                        $user_id = $_GET["bkid"];
                        $disable_empty = true;
                }
                else
                {
                        $user_id = $ilUser->getId();
                        $disable_empty = false;
                }
                include_once('Services/Calendar/classes/class.ilCalendarSchedule.php');
                $this->scheduler = new ilCalendarSchedule($this->seed,ilCalendarSchedule::TYPE_MONTH,$user_id);
                $this->scheduler->addSubitemCalendars(true);            
                $this->scheduler->calculate();
                
                $counter = 0;
                foreach(ilCalendarUtil::_buildMonthDayList($this->seed->get(IL_CAL_FKT_DATE,'m'),
                        $this->seed->get(IL_CAL_FKT_DATE,'Y'),
                        $this->user_settings->getWeekStart())->get() as $date)
                {
                        $counter++;
 
                        $events = $this->scheduler->getByDay($date,$ilUser->getTimeZone());
                        $has_events = (bool)count($events);
                        if($has_events || !$disable_empty)
                        {
                                $a_tpl->setCurrentBlock('month_col_link');
                        }
                        else
                        {
                                $a_tpl->setCurrentBlock('month_col_no_link');
                        }
 
                        if($disable_empty)
                        {
                                if(!$has_events)
                                {
                                        $a_tpl->setVariable('DAY_CLASS','calminiinactive');
                                }
                                else
                                {
                                        $week_has_events = true;
                                        include_once 'Services/Booking/classes/class.ilBookingEntry.php';
                                        foreach($events as $event)
                                        {
                                                $booking = new ilBookingEntry($event['event']->getContextId());
                                                if($booking->hasBooked($event['event']->getEntryId()))
                                                {
                                                        $a_tpl->setVariable('DAY_CLASS','calminiapp');
                                                        break;
                                                }
                                        }
                                }
                        }
                        elseif($has_events)
                        {
                                $week_has_events = true;
                                $a_tpl->setVariable('DAY_CLASS','calminiapp');
                        }
                        
                        
                        $day = $date->get(IL_CAL_FKT_DATE,'j');
                        $month = $date->get(IL_CAL_FKT_DATE,'n');
                        
                        $month_day = $day;
                        
                        $ilCtrl->clearParametersByClass('ilcalendardaygui');
                        $ilCtrl->setParameterByClass('ilcalendardaygui','seed',$date->get(IL_CAL_DATE));
                        $a_tpl->setVariable('OPEN_DAY_VIEW', $ilCtrl->getLinkTargetByClass('ilcalendardaygui',''));
                        $ilCtrl->clearParametersByClass('ilcalendardaygui');
                        
                        $a_tpl->setVariable('MONTH_DAY',$month_day);
 
                        $a_tpl->parseCurrentBlock();
 
 
                        $a_tpl->setCurrentBlock('month_col');
 
                        include_once('./Services/Calendar/classes/class.ilCalendarUtil.php');
                        if(ilCalendarUtil::_isToday($date))
                        {
                                $a_tpl->setVariable('TD_CLASS','calminitoday');
                        }
                        #elseif(ilDateTime::_equals($date,$this->seed,IL_CAL_DAY))
                        #{
                        #       $a_tpl->setVariable('TD_CLASS','calmininow');
                        #}
                        elseif(ilDateTime::_equals($date,$this->seed,IL_CAL_MONTH))
                        {
                                $a_tpl->setVariable('TD_CLASS','calministd');
                        }
                        elseif(ilDateTime::_before($date,$this->seed,IL_CAL_MONTH))
                        {
                                $a_tpl->setVariable('TD_CLASS','calminiprev');
                        }
                        else
                        {
                                $a_tpl->setVariable('TD_CLASS','calmininext');
                        }
                        
                        $a_tpl->parseCurrentBlock();
 
                        
                        if($counter and !($counter % 7))
                        {
                                if(!$disable_empty || $week_has_events)
                                {
                                        $a_tpl->setCurrentBlock('month_row_link');
                                        $ilCtrl->clearParametersByClass('ilcalendarweekgui');
                                        $ilCtrl->setParameterByClass('ilcalendarweekgui','seed',$date->get(IL_CAL_DATE));
                                        $a_tpl->setVariable('OPEN_WEEK_VIEW', $ilCtrl->getLinkTargetByClass('ilcalendarweekgui',''));
                                        $ilCtrl->clearParametersByClass('ilcalendarweekgui');
                                }
                                else
                                {
                                        $a_tpl->setCurrentBlock('month_row_no_link');
                                        $a_tpl->setVariable('WEEK_CLASS', 'calminiinactive');
                                }
                                $a_tpl->setVariable('WEEK',
                                        $date->get(IL_CAL_FKT_DATE,'W'));
                            $a_tpl->parseCurrentBlock();
 
                                $a_tpl->setCurrentBlock('month_row');
                                $a_tpl->setVariable('TD_CLASS','calminiweek');
                                $a_tpl->parseCurrentBlock();
 
                                $week_has_events = false;
                        }
                }
                $a_tpl->setCurrentBlock('mini_month');
                $a_tpl->setVariable('TXT_MONTH_OVERVIEW', $lng->txt("cal_month_overview"));
                $a_tpl->setVariable('TXT_MONTH',
                        $lng->txt('month_'.$this->seed->get(IL_CAL_FKT_DATE,'m').'_long').
                                ' '.$this->seed->get(IL_CAL_FKT_DATE,'Y'));
                $myseed = clone($this->seed);
                $ilCtrl->setParameterByClass('ilcalendarmonthgui','seed',$myseed->get(IL_CAL_DATE));
                $a_tpl->setVariable('OPEN_MONTH_VIEW',$ilCtrl->getLinkTargetByClass('ilcalendarmonthgui',''));
                
                $myseed->increment(ilDateTime::MONTH, -1);
                $ilCtrl->setParameter($this,'seed',$myseed->get(IL_CAL_DATE));
                
                $a_tpl->setVariable('BL_TYPE', $this->getBlockType());
                $a_tpl->setVariable('BL_ID', $this->getBlockId());
                
                $a_tpl->setVariable('PREV_MONTH',
                        $ilCtrl->getLinkTarget($this, "setSeed"));
                $a_tpl->setVariable('PREV_MONTH_ASYNC',
                        $ilCtrl->getLinkTarget($this, "setSeed", "", true));
                        
                $myseed->increment(ilDateTime::MONTH, 2);
                $ilCtrl->setParameter($this,'seed',$myseed->get(IL_CAL_DATE));
                $a_tpl->setVariable('NEXT_MONTH',
                        $ilCtrl->getLinkTarget($this, "setSeed"));
                $a_tpl->setVariable('NEXT_MONTH_ASYNC',
                        $ilCtrl->getLinkTarget($this, "setSeed", "", true));
 
                $ilCtrl->setParameter($this, 'seed', "");
                $a_tpl->parseCurrentBlock();
        }

References $_GET, $ilCtrl, $ilUser, $lng, ilDateTime\_before(), ilCalendarUtil\_buildMonthDayList(), ilDateTime\_equals(), ilCalendarUtil\_isToday(), ilCalendarUtil\_numericDayToString(), ilBlockGUI\getBlockId(), getBlockType(), IL_CAL_DATE, IL_CAL_FKT_DATE, IL_CAL_MONTH, ilDateTime\MONTH, and ilCalendarSchedule\TYPE_MONTH.

Referenced by fillDataSection().

Here is the call graph for this function:

Here is the caller graph for this function:

executeCommand()

& ilCalendarBlockGUI::executeCommand

(

)

execute command

Definition at line 188 of file class.ilCalendarBlockGUI.php.

        {
                global $ilCtrl,$ilTabs,$ilUser;
 
                $next_class = $ilCtrl->getNextClass();
                $cmd = $ilCtrl->getCmd("getHTML");
                
                $this->setSubTabs();
                
                switch ($next_class)
                {
                        case "ilcalendarappointmentgui":
                                include_once('./Services/Calendar/classes/class.ilCalendarAppointmentGUI.php');
                                $app_gui = new ilCalendarAppointmentGUI($this->seed,$this->seed);
                                $ilCtrl->forwardCommand($app_gui);
                                break;
                                
                        case "ilcalendardaygui":
                                $ilTabs->setSubTabActive('app_day');
                                include_once('./Services/Calendar/classes/class.ilCalendarDayGUI.php');
                                $day_gui = new ilCalendarDayGUI($this->seed);                           
                                $ilCtrl->forwardCommand($day_gui);
                                break;
 
                        case "ilcalendarweekgui":
                                $ilTabs->setSubTabActive('app_week');
                                include_once('./Services/Calendar/classes/class.ilCalendarWeekGUI.php');
                                $week_gui = new ilCalendarWeekGUI($this->seed);                         
                                $ilCtrl->forwardCommand($week_gui);
                                break;
 
                        case "ilcalendarmonthgui":
                                $ilTabs->setSubTabActive('app_month');
                                include_once('./Services/Calendar/classes/class.ilCalendarMonthGUI.php');
                                $month_gui = new ilCalendarMonthGUI($this->seed);                               
                                $ilCtrl->forwardCommand($month_gui);
                                break;
                                
                        case "ilcalendarinboxgui":
                                include_once('./Services/Calendar/classes/class.ilCalendarInboxGUI.php');
                                $inbox = new ilCalendarInboxGUI($this->seed);                           
                                $ilCtrl->forwardCommand($inbox);
                                break;
 
                        case "ilconsultationhoursgui":
                                include_once('./Services/Calendar/classes/ConsultationHours/class.ilConsultationHoursGUI.php');
                                $hours = new ilConsultationHoursGUI($this->seed);
                                $ilCtrl->forwardCommand($hours);
                                break;
 
                        default:
                                return $this->$cmd();
                }
        }

References $cmd, $ilCtrl, $ilUser, and setSubTabs().

Here is the call graph for this function:

fillDataSection()

ilCalendarBlockGUI::fillDataSection

(

)

Fill data section.

Reimplemented from ilBlockGUI.

Definition at line 266 of file class.ilCalendarBlockGUI.php.

        {
                // alex: changed from > 1 to > 0 - original detail level 1 did not work anymore
                if ($this->getCurrentDetailLevel() > 0 && $this->display_mode != "mmon")
                {
                        $this->setColSpan(1);                                   
                        $this->tpl->addBlockFile("BLOCK_ROW", "block_row","tpl.pd_event_list.html", "Services/Calendar");               
                        
                        ilBlockGUI::fillDataSection();
                }
                else
                {
                        // alex: changed from > 1 to > 0 - original detail level 1 did not work anymore
                        if ($this->getCurrentDetailLevel() > 0)
                        {
                                $tpl = new ilTemplate("tpl.calendar_block.html", true, true,
                                        "Services/Calendar");
 
                                $this->addMiniMonth($tpl);
                                $this->setDataSection($tpl->get());
                        }
                        else
                        {
                                $this->setDataSection($this->getOverview());
                        }
                }               
        }

References $tpl, addMiniMonth(), ilBlockGUI\fillDataSection(), ilBlockGUI\getCurrentDetailLevel(), getOverview(), ilBlockGUI\setColSpan(), and ilBlockGUI\setDataSection().

Here is the call graph for this function:

fillFooter()

ilCalendarBlockGUI::fillFooter

(

)

Reimplemented from ilBlockGUI.

Definition at line 770 of file class.ilCalendarBlockGUI.php.

        {
                global $ilCtrl, $lng, $ilUser;
 
                // begin-patch ch
                foreach((array) $this->cal_footer as $link_info)
                {
                        $this->tpl->setCurrentBlock('data_section');
                        $this->tpl->setVariable('DATA',
                                        sprintf('<a href="%s">%s</a>',$link_info['link'],$link_info['txt'])
 
                        );
                        $this->tpl->parseCurrentBlock();
                }
                // end-patch ch
 
                $this->setFooterLinks();
                $this->fillFooterLinks();
                $this->tpl->setVariable("FCOLSPAN", $this->getColSpan());
                if ($this->tpl->blockExists("block_footer"))
                {
                        $this->tpl->setCurrentBlock("block_footer");
                        $this->tpl->parseCurrentBlock();
                }
                
        }

References $ilCtrl, $ilUser, $lng, ilBlockGUI\fillFooterLinks(), ilBlockGUI\getColSpan(), and setFooterLinks().

Here is the call graph for this function:

getBlockType()

static ilCalendarBlockGUI::getBlockType ( )

static

Get block type.

Returns

string Block type.

Reimplemented from ilBlockGUI.

Reimplemented in ilPDCalendarBlockGUI.

Definition at line 138 of file class.ilCalendarBlockGUI.php.

        {
                return self::$block_type;
        }

References $block_type.

Referenced by addMiniMonth(), and ilCalendarBlockGUI().

Here is the caller graph for this function:

getData()

ilCalendarBlockGUI::getData

(

)

Get Data.

Returns

array Data

Reimplemented from ilBlockGUI.

Definition at line 864 of file class.ilCalendarBlockGUI.php.

        {
                global $ilCtrl, $lng;
                                                        
                $seed = new ilDate(date('Y-m-d',time()),IL_CAL_DATE);
                
                include_once('./Services/Calendar/classes/class.ilCalendarSchedule.php');               
                $schedule = new ilCalendarSchedule($seed, ilCalendarSchedule::TYPE_PD_UPCOMING);                        
                $schedule->addSubitemCalendars(true); // #12007
                $schedule->setEventsLimit(20);
                $schedule->calculate();
                $events = $schedule->getScheduledEvents(); // #13809
                
                $data = array();
                if(sizeof($events))
                {                       
                        foreach($events as $item)
                        {                       
                                $start = $item["dstart"];
                                $end = $item["dend"];                           
                                if($item["fullday"])
                                {
                                        $start = new ilDate($start, IL_CAL_UNIX);
                                        $end = new ilDate($end, IL_CAL_UNIX);
                                }
                                else
                                {
                                        $start = new ilDateTime($start, IL_CAL_UNIX);
                                        $end = new ilDateTime($end, IL_CAL_UNIX);
                                }
                                
                                $ilCtrl->clearParametersByClass('ilcalendardaygui');
                                $ilCtrl->setParameterByClass('ilcalendardaygui','seed',$start->get(IL_CAL_DATE));
                                $link = $ilCtrl->getLinkTargetByClass('ilcalendardaygui','');
                                $ilCtrl->clearParametersByClass('ilcalendardaygui');
                        
                                $data[] = array(        
                                        "date" =>  ilDatePresentation::formatPeriod($start, $end),
                                        "title" => $item["event"]->getPresentationTitle(),                      
                                        "url" => $link
                                        );                              
                        }                       
                        
                        $this->setEnableNumInfo(true);
                }
                else
                {
                        $data[] = array(        
                                        "date" => $lng->txt("msg_no_search_result"),
                                        "title" => "",                  
                                        "url" => ""
                                        );              
                        
                        $this->setEnableNumInfo(false);
                }
                
                return $data;
        }

References ilBlockGUI\$data, $ilCtrl, $lng, ilDatePresentation\formatPeriod(), IL_CAL_DATE, IL_CAL_UNIX, ilBlockGUI\setEnableNumInfo(), and ilCalendarSchedule\TYPE_PD_UPCOMING.

Here is the call graph for this function:

getEnableEdit()

ilCalendarBlockGUI::getEnableEdit

(

)

Get EnableEdit.

Returns

boolean Edit mode on/off

Reimplemented from ilBlockGUI.

Definition at line 258 of file class.ilCalendarBlockGUI.php.

        {
                return $this->enable_edit;
        }

getHTML()

ilCalendarBlockGUI::getHTML

(

)

Get bloch HTML code.

Reimplemented from ilBlockGUI.

Definition at line 477 of file class.ilCalendarBlockGUI.php.

        {
                global $ilCtrl, $lng, $ilUser,$ilAccess;
                
                if ($this->getCurrentDetailLevel() == 0)
                {
                        return "";
                }
                
                // add edit commands
                #if ($this->getEnableEdit())
                
                if($this->mode == ilCalendarCategories::MODE_PERSONAL_DESKTOP_ITEMS or
                        $this->mode == ilCalendarCategories::MODE_PERSONAL_DESKTOP_MEMBERSHIP)
                {
                        include_once("./Services/News/classes/class.ilRSSButtonGUI.php");
                        $this->addBlockCommand(
                                $this->ctrl->getLinkTarget($this,'showCalendarSubscription'),
                                $lng->txt('ical_export'),
                                "", "", true, false, ilRSSButtonGUI::get(ilRSSButtonGUI::ICON_ICAL)
                        );
                }
                
                
                if($this->mode == ilCalendarCategories::MODE_REPOSITORY)
                {
                        if(!isset($_GET["bkid"]))
                        {
                                if($ilAccess->checkAccess('edit_event','',(int) $_GET['ref_id']))
                                {
                                        $ilCtrl->setParameter($this, "add_mode", "block");
                                        $this->addBlockCommand(
                                                $ilCtrl->getLinkTargetByClass("ilCalendarAppointmentGUI",
                                                        "add"),
                                                $lng->txt("add_appointment"));
                                        $ilCtrl->setParameter($this, "add_mode", "");
                                }
 
                                global $ilObjDataCache;
 
                                include_once "Modules/Course/classes/class.ilCourseParticipants.php";
                                $obj_id = $ilObjDataCache->lookupObjId((int) $_GET['ref_id']);
                                $participants = ilCourseParticipants::_getInstanceByObjId($obj_id);
                                $users = array_unique(array_merge($participants->getTutors(), $participants->getAdmins()));
                                //$users = $participants->getParticipants();
                                include_once 'Services/Booking/classes/class.ilBookingEntry.php';
                                $users = ilBookingEntry::lookupBookableUsersForObject($obj_id,$users);
                                foreach($users as $user_id)
                                {
                                        if(!isset($_GET["bkid"]))
                                        {
                                                include_once './Services/Calendar/classes/ConsultationHours/class.ilConsultationHourAppointments.php';
                                                $now = new ilDateTime(time(), IL_CAL_UNIX);
                                                
                                                // default to last booking entry
                                                $appointments = ilConsultationHourAppointments::getAppointments($user_id);
                                                $next_app = end($appointments);
                                                reset($appointments);
                                                
                                                foreach($appointments as $entry)
                                                {
                                                        // find next entry
                                                        if(ilDateTime::_before($entry->getStart(), $now, IL_CAL_DAY))
                                                        {
                                                                continue;
                                                        }
                                                        include_once 'Services/Booking/classes/class.ilBookingEntry.php';
                                                        $booking_entry = new ilBookingEntry($entry->getContextId());
                                                        if(!in_array($obj_id, $booking_entry->getTargetObjIds()))
                                                        {
                                                                continue;
                                                        }
                                                        
                                                        if(!$booking_entry->isAppointmentBookableForUser($entry->getEntryId(), $GLOBALS['ilUser']->getId()))
                                                        {
                                                                continue;
                                                        }
                                                        $next_app = $entry;
                                                        break;
                                                }
                                                
                                                $ilCtrl->setParameter($this, "bkid", $user_id);
                                                if($next_app)
                                                {
                                                        $ilCtrl->setParameter(
                                                                $this,
                                                                'seed',
                                                                (string) $next_app->getStart()->get(IL_CAL_DATE)
                                                        );
                                                }
                                                
                                                $this->addBlockCommand(
                                                        $ilCtrl->getLinkTargetByClass(
                                                                "ilCalendarMonthGUI",
                                                                ""),
                                                        $lng->txt("cal_consultation_hours_for").' '. ilObjUser::_lookupFullname($user_id)
                                                );
                                                
                                                $this->cal_footer[] = array(
                                                        'link' => $ilCtrl->getLinkTargetByClass('ilCalendarMonthGUI',''),
                                                        'txt' => $lng->txt("cal_consultation_hours_for").' '.ilObjUser::_lookupFullname($user_id)
                                                );
                                                
                                        }
                                }
                                $ilCtrl->setParameter($this, "bkid", "");
                                $ilCtrl->setParameter($this, 'seed', '');
                        }
                        else
                        {
                                $ilCtrl->setParameter($this, "bkid", "");
                                $this->addBlockCommand(
                                                        $ilCtrl->getLinkTarget($this),
                                                        $lng->txt("back"));
                                $ilCtrl->setParameter($this, "bkid", (int)$_GET["bkid"]);
                        }
                }
 
                if ($this->getProperty("settings") == true)
                {
                        $this->addBlockCommand(
                                $ilCtrl->getLinkTarget($this, "editSettings"),
                                $lng->txt("settings"));
                }
 
                $ilCtrl->setParameterByClass("ilcolumngui", "seed", isset($_GET["seed"]) ? $_GET["seed"] : "");
                $ret = parent::getHTML();
                $ilCtrl->setParameterByClass("ilcolumngui", "seed", "");
                
                return $ret;
        }

References $_GET, $GLOBALS, $ilCtrl, $ilUser, $lng, $ret, ilDateTime\_before(), ilCourseParticipants\_getInstanceByObjId(), ilObjUser\_lookupFullname(), ilBlockGUI\addBlockCommand(), ilRSSButtonGUI\get(), ilConsultationHourAppointments\getAppointments(), ilBlockGUI\getCurrentDetailLevel(), ilBlockGUI\getProperty(), ilRSSButtonGUI\ICON_ICAL, IL_CAL_DATE, IL_CAL_DAY, IL_CAL_UNIX, ilBookingEntry\lookupBookableUsersForObject(), ilCalendarCategories\MODE_PERSONAL_DESKTOP_ITEMS, ilCalendarCategories\MODE_PERSONAL_DESKTOP_MEMBERSHIP, and ilCalendarCategories\MODE_REPOSITORY.

Referenced by setPdModeEvents(), setPdModeMonth(), and setSeed().

Here is the call graph for this function:

Here is the caller graph for this function:

getOverview()

ilCalendarBlockGUI::getOverview

(

)

Get overview.

Definition at line 612 of file class.ilCalendarBlockGUI.php.

        {
                global $ilUser, $lng, $ilCtrl;
                
                include_once('./Services/Calendar/classes/class.ilCalendarSchedule.php');
                $schedule = new ilCalendarSchedule($this->seed,ilCalendarSchedule::TYPE_INBOX); 
                $events = $schedule->getChangedEvents(true);
 
                $ilCtrl->setParameterByClass('ilcalendarinboxgui', 'changed', 1);
                $link = '<a href='.$ilCtrl->getLinkTargetByClass('ilcalendarinboxgui','').'>';
                $ilCtrl->setParameterByClass('ilcalendarinboxgui', 'changed', '');
                $text = '<div class="small">'.((int) count($events))." ".$lng->txt("cal_changed_events_header")."</div>";
                $end_link = '</a>';
                
                return $link.$text.$end_link;
        }

References $ilCtrl, $ilUser, $lng, $text, and ilCalendarSchedule\TYPE_INBOX.

Referenced by fillDataSection().

Here is the caller graph for this function:

getScreenMode()

static ilCalendarBlockGUI::getScreenMode ( )

static

Get Screen Mode for current command.

Reimplemented from ilBlockGUI.

Definition at line 156 of file class.ilCalendarBlockGUI.php.

        {
                global $ilCtrl;
                
                $cmd_class = $ilCtrl->getCmdClass();
                
                if ($cmd_class == "ilcalendarappointmentgui" ||
                        $cmd_class == "ilcalendardaygui" ||
                        $cmd_class == "ilcalendarweekgui" ||
                        $cmd_class == "ilcalendarmonthgui" ||
                        $cmd_class == "ilcalendarinboxgui" ||
                        $cmd_class == "ilconsultationhoursgui" ||
                        $_GET['cmd'] == 'showCalendarSubscription')
                {
                        return IL_SCREEN_CENTER;
                }
                
                switch($ilCtrl->getCmd())
                {
                        case "kkk":
                        // return IL_SCREEN_CENTER;
                        // return IL_SCREEN_FULL;
                        
                        default:
                                //return IL_SCREEN_SIDE;
                                break;
                }
        }

References $_GET, $ilCtrl, and IL_SCREEN_CENTER.

ilCalendarBlockGUI()

ilCalendarBlockGUI::ilCalendarBlockGUI

(

$a_skip_init = false

)

Constructor.

Parameters

boolean

skip initialisation (is called by derived PDCalendarBlockGUI class)

Definition at line 54 of file class.ilCalendarBlockGUI.php.

        {
                global $ilCtrl, $lng, $ilUser, $tpl, $ilHelp;
                
                parent::ilBlockGUI();
                
                $this->ctrl = $ilCtrl;
 
                $lng->loadLanguageModule("dateplaner");
                $ilHelp->addHelpSection("cal_block");
                
                include_once("./Services/News/classes/class.ilNewsItem.php");
 
                $ilCtrl->saveParameter($this, 'bkid');
 
                if (!$a_skip_init)
                {
                        $this->initCategories();
                        $this->setBlockId($ilCtrl->getContextObjId());
                }
 
                $this->setLimit(5);                     // @todo: needed?
                
                // alex: original detail level 1 did not work anymore
                $this->setAvailableDetailLevels(1);
                $this->setEnableNumInfo(false);
 
                if(!isset($_GET["bkid"]))
                {
                        $title = $lng->txt("calendar");
                }
                else
                {
                        $title = $lng->txt("cal_consultation_hours_for")." ".ilObjUser::_lookupFullname($_GET["bkid"]);
                }
                                
                $this->setTitle($title);
                //$this->setData($data);
                $this->allow_moving = false;
                //$this->handleView();
                
                include_once('Services/Calendar/classes/class.ilDate.php');
                include_once('Services/Calendar/classes/class.ilCalendarUserSettings.php');
                
                $seed_str = "";
                if ((!isset($_GET["seed"]) || $_GET["seed"] == "") &&
                        isset($_SESSION["il_cal_block_".$this->getBlockType()."_".$this->getBlockId()."_seed"]))
                {
                        $seed_str = $_SESSION["il_cal_block_".$this->getBlockType()."_".$this->getBlockId()."_seed"];
                }
                else if (isset($_GET["seed"]))
                {
                        $seed_str =  $_GET["seed"];
                }
                        
                if (isset($_GET["seed"]) && $_GET["seed"] != "")
                {
                        $_SESSION["il_cal_block_".$this->getBlockType()."_".$this->getBlockId()."_seed"]
                                = $_GET["seed"];
                }
 
                if ($seed_str == "")
                {
                        $this->seed = new ilDate(time(),IL_CAL_UNIX);   // @todo: check this
                }
                else
                {
                        $this->seed = new ilDate($seed_str,IL_CAL_DATE);        // @todo: check this
                }
                $this->user_settings = ilCalendarUserSettings::_getInstanceByUserId($ilUser->getId());
                
                $tpl->addCSS("./Services/Calendar/css/calendar.css");
                // @todo: this must work differently...
                $tpl->addCSS("./Services/Calendar/templates/default/delos.css");
                
                $mode = $ilUser->getPref("il_pd_cal_mode");
                $this->display_mode = $mode ? $mode : "mmon";
        }

References $_GET, $_SESSION, $ilCtrl, $ilUser, $lng, $mode, $tpl, ilCalendarUserSettings\_getInstanceByUserId(), ilObjUser\_lookupFullname(), ilBlockGUI\getBlockId(), getBlockType(), IL_CAL_DATE, IL_CAL_UNIX, initCategories(), ilBlockGUI\setAvailableDetailLevels(), ilBlockGUI\setBlockId(), ilBlockGUI\setEnableNumInfo(), ilBlockGUI\setLimit(), and ilBlockGUI\setTitle().

Here is the call graph for this function:

initCategories()

ilCalendarBlockGUI::initCategories ( )

protected

init categories

@access protected

Parameters

return

Reimplemented in ilPDCalendarBlockGUI.

Definition at line 644 of file class.ilCalendarBlockGUI.php.

        {
                $this->mode = ilCalendarCategories::MODE_REPOSITORY;
 
                include_once('./Services/Calendar/classes/class.ilCalendarCategories.php');
 
                if(!isset($_GET['bkid']))
                {
                        ilCalendarCategories::_getInstance()->initialize(ilCalendarCategories::MODE_REPOSITORY,(int) $_GET['ref_id'],true);
                }
                else
                {
                        // display consultation hours only (in course/group)
                        ilCalendarCategories::_getInstance()->setCHUserId((int) $_GET['bkid']);
                        ilCalendarCategories::_getInstance()->initialize(ilCalendarCategories::MODE_CONSULTATION,(int) $_GET['ref_id'],true);
                }
        }

References $_GET, ilCalendarCategories\_getInstance(), ilCalendarCategories\MODE_CONSULTATION, and ilCalendarCategories\MODE_REPOSITORY.

Referenced by ilCalendarBlockGUI().

Here is the call graph for this function:

Here is the caller graph for this function:

isRepositoryObject()

static ilCalendarBlockGUI::isRepositoryObject ( )

static

Is this a repository object.

Returns

string Block type.

Reimplemented from ilBlockGUI.

Definition at line 148 of file class.ilCalendarBlockGUI.php.

        {
                return false;
        }

returnToUpperContext()

ilCalendarBlockGUI::returnToUpperContext

(

)

Return to upper context.

Reimplemented in ilPDCalendarBlockGUI.

Definition at line 709 of file class.ilCalendarBlockGUI.php.

        {
                global $ilCtrl;
                
                $ilCtrl->returnToParent($this);
        }

References $ilCtrl.

Referenced by setSeed().

Here is the caller graph for this function:

setEnableEdit()

ilCalendarBlockGUI::setEnableEdit

(

$a_enable_edit = 0

)

Set EnableEdit.

Parameters

boolean

$a_enable_edit

Edit mode on/off

Reimplemented from ilBlockGUI.

Definition at line 248 of file class.ilCalendarBlockGUI.php.

        {
                $this->enable_edit = $a_enable_edit;
        }

setFooterLinks()

ilCalendarBlockGUI::setFooterLinks

(

)

Definition at line 797 of file class.ilCalendarBlockGUI.php.

        {
                global $ilCtrl, $lng;
                
                // alex: changed from < 2 to < 1 - original detail level 1 did not work anymore
                if ($this->getCurrentDetailLevel() < 1)
                {
                        return;
                }
                
//              if ($this->display_mode == 'mmon')
//              {
//                      $this->addFooterLink($lng->txt("month"));
                        
                        $this->addFooterLink($lng->txt("cal_upcoming_events_header"),
                                $ilCtrl->getLinkTarget($this, "setPdModeEvents"),
                                $ilCtrl->getLinkTarget($this, "setPdModeEvents", "", true),
                                "block_".$this->getBlockType()."_".$this->block_id,
                                false, false, ($this->display_mode != 'mmon'));
                        
//              }
//              else
//              {
                        $this->addFooterLink( $lng->txt("app_month"),
                                $ilCtrl->getLinkTarget($this, "setPdModeMonth"),
                                $ilCtrl->getLinkTarget($this, "setPdModeMonth", "", true),
                                "block_".$this->getBlockType()."_".$this->block_id,
                                false, false, ($this->display_mode == 'mmon'));
                        
//                      $this->addFooterLink($lng->txt("cal_upcoming_events_header"));
//              }
        }

References $ilCtrl, $lng, ilBlockGUI\addFooterLink(), and ilBlockGUI\getCurrentDetailLevel().

Referenced by fillFooter().

Here is the call graph for this function:

Here is the caller graph for this function:

setPdModeEvents()

ilCalendarBlockGUI::setPdModeEvents

(

)

Definition at line 830 of file class.ilCalendarBlockGUI.php.

        {
                global $ilUser, $ilCtrl;
                
                $ilUser->writePref("il_pd_cal_mode", "evt");
                $this->display_mode = "evt";
                if ($ilCtrl->isAsynch())
                {
                        echo $this->getHTML();
                        exit;
                }
                else
                {
                        $ilCtrl->redirectByClass("ilpersonaldesktopgui", "show");
                }
        }

References $ilCtrl, $ilUser, exit, and getHTML().

Here is the call graph for this function:

setPdModeMonth()

ilCalendarBlockGUI::setPdModeMonth

(

)

Definition at line 847 of file class.ilCalendarBlockGUI.php.

        {
                global $ilUser, $ilCtrl;
                
                $ilUser->writePref("il_pd_cal_mode", "mmon");
                $this->display_mode = "mmon";
                if ($ilCtrl->isAsynch())
                {
                        echo $this->getHTML();
                        exit;
                }
                else
                {
                        $ilCtrl->redirectByClass("ilpersonaldesktopgui", "show");
                }
        }

References $ilCtrl, $ilUser, exit, and getHTML().

Here is the call graph for this function:

setSeed()

ilCalendarBlockGUI::setSeed

(

)

Set seed.

Definition at line 688 of file class.ilCalendarBlockGUI.php.

        {
                global $ilCtrl, $ilUser;
 
                //$ilUser->writePref("il_pd_bkm_mode", 'flat');
                $_SESSION["il_cal_block_".$this->getBlockType()."_".$this->getBlockId()."_seed"] =
                        $_GET["seed"];
                if ($ilCtrl->isAsynch())
                {
                        echo $this->getHTML();
                        exit;
                }
                else
                {
                        $this->returnToUpperContext();
                }
        }

References $_GET, $_SESSION, $ilCtrl, $ilUser, exit, ilBlockGUI\getBlockId(), getHTML(), and returnToUpperContext().

Here is the call graph for this function:

setSubTabs()

ilCalendarBlockGUI::setSubTabs ( )

protected

Parameters

return

Definition at line 667 of file class.ilCalendarBlockGUI.php.

        {
                global $ilTabs;
                
                $ilTabs->clearSubTabs();
                return true;
                
                // TODO: needs another switch
                if($_GET['ref_id'])
                {
                        
                        $ilTabs->addSubTabTarget('app_day',$this->ctrl->getLinkTargetByClass('ilCalendarDayGUI',''));
                        $ilTabs->addSubTabTarget('app_week',$this->ctrl->getLinkTargetByClass('ilCalendarWeekGUI',''));
                        $ilTabs->addSubTabTarget('app_month',$this->ctrl->getLinkTargetByClass('ilCalendarMonthGUI',''));
                }
                return true;
        }

References $_GET.

Referenced by executeCommand().

Here is the caller graph for this function:

showCalendarSubscription()

ilCalendarBlockGUI::showCalendarSubscription

(

)

Definition at line 717 of file class.ilCalendarBlockGUI.php.

        {
                global $lng, $ilUser;
                
                $tpl = new ilTemplate('tpl.show_calendar_subscription.html',true,true,'Services/Calendar');
                
                $tpl->setVariable('TXT_TITLE',$lng->txt('cal_subscription_header'));
                $tpl->setVariable('TXT_INFO',$lng->txt('cal_subscription_info'));
                $tpl->setVariable('TXT_CAL_URL',$lng->txt('cal_subscription_url'));
                
                include_once './Services/Calendar/classes/class.ilCalendarAuthenticationToken.php';
                
                switch($this->mode)
                {
                        case ilCalendarCategories::MODE_PERSONAL_DESKTOP_ITEMS:
                        case ilCalendarCategories::MODE_PERSONAL_DESKTOP_MEMBERSHIP:
                                $selection = ilCalendarAuthenticationToken::SELECTION_PD;
                                $calendar = 0;
                                break;
                        
                        default:
                                $selection = ilCalendarAuthenticationToken::SELECTION_CATEGORY;
                                // TODO: calendar id
                                $calendar = ilObject::_lookupObjId((int) $_GET['ref_id']);      
                                break;           
                }
                if($hash = ilCalendarAuthenticationToken::lookupAuthToken($ilUser->getId(), $selection, $calendar))
                {
                        
                }
                else
                {
                        $token = new ilCalendarAuthenticationToken($ilUser->getId());
                        $token->setSelectionType($selection);
                        $token->setCalendar($calendar);
                        $hash = $token->add();
                }
                $url = ILIAS_HTTP_PATH.'/calendar.php?client_id='.CLIENT_ID.'&token='.$hash;
                
                $tpl->setVariable('VAL_CAL_URL',$url);
                $tpl->setVariable('VAL_CAL_URL_TXT',$url);
                
                include_once("./Services/PersonalDesktop/classes/class.ilPDContentBlockGUI.php");
                $content_block = new ilPDContentBlockGUI();
                $content_block->setContent($tpl->get());
                $content_block->setTitle($lng->txt("calendar"));
                $content_block->addHeaderCommand($this->ctrl->getParentReturn($this),
                        $lng->txt("selected_items_back"));
 
                return $content_block->getHTML();
                
        }

References $_GET, $ilUser, $lng, $tpl, $url, ilObject\_lookupObjId(), ilCalendarAuthenticationToken\lookupAuthToken(), ilCalendarCategories\MODE_PERSONAL_DESKTOP_ITEMS, ilCalendarCategories\MODE_PERSONAL_DESKTOP_MEMBERSHIP, ilCalendarAuthenticationToken\SELECTION_CATEGORY, and ilCalendarAuthenticationToken\SELECTION_PD.

Here is the call graph for this function:

Field Documentation

$block_type

ilCalendarBlockGUI::$block_type = "cal"

static

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

Referenced by getBlockType().

$ctrl

ilCalendarBlockGUI::$ctrl = null

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

$display_mode

ilCalendarBlockGUI::$display_mode

protected

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

$mode

ilCalendarBlockGUI::$mode

protected

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

Referenced by ilCalendarBlockGUI().

$st_data

ilCalendarBlockGUI::$st_data

static

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

---

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

• Services/Calendar/classes/class.ilCalendarBlockGUI.php