ilRecurrenceInputGUI Class Reference

This class represents an input GUI for recurring events/appointments (course events or calendar appointments) More...

Inheritance diagram for ilRecurrenceInputGUI:

Collaboration diagram for ilRecurrenceInputGUI:

Public Member Functions
	__construct ($a_title, $a_postvar)
	Constructor. More...
	checkInput ()
	check input More...
	setRecurrence ($a_rec)
	set recurrence object More...
	getRecurrence ()
	Get Recurrence. More...
	allowUnlimitedRecurrences ($a_status)
	Allow unlimited recurrences. More...
	isUnlimitedRecurrenceAllowed ()
	Check if unlimited recurrence is allowed. More...
	setEnabledSubForms ($a_sub_forms)
	set enabled subforms More...
	getEnabledSubForms ()
	get enabled subforms More...
	insert ($a_tpl)
	insert More...
Public Member Functions inherited from ilCustomInputGUI
	__construct ($a_title="", $a_postvar="")
	Constructor. More...
	setHtml ($a_html)
	Set Html. More...
	getHtml ()
	Get Html. More...
	setValueByArray ($a_values)
	Set value by array. More...
	insert ($a_tpl)
	Insert property html. More...
	checkInput ()
	Check input, strip slashes etc. More...
Public Member Functions inherited from ilSubEnabledFormPropertyGUI
	addSubItem ($a_item)
	Add Subitem. More...
	getSubItems ()
	Get Subitems. More...
	getSubInputItemsRecursive ()
	returns a flat array of possibly existing subitems recursively More...
	checkSubItemsInput ()
	Check SubItems. More...
	getSubForm ()
	Get sub form html. More...
	getItemByPostVar ($a_post_var)
	Get item by post var. More...
Public Member Functions inherited from ilFormPropertyGUI
	__construct ($a_title="", $a_postvar="")
	Constructor. More...
	executeCommand ()
	Execute command. More...
	getType ()
	Get Type. More...
	setTitle ($a_title)
	Set Title. More...
	getTitle ()
	Get Title. More...
	setPostVar ($a_postvar)
	Set Post Variable. More...
	getPostVar ()
	Get Post Variable. More...
	getFieldId ()
	Get Post Variable. More...
	setInfo ($a_info)
	Set Information Text. More...
	getInfo ()
	Get Information Text. More...
	setAlert ($a_alert)
	Set Alert Text. More...
	getAlert ()
	Get Alert Text. More...
	setRequired ($a_required)
	Set Required. More...
	getRequired ()
	Get Required. More...
	setDisabled ($a_disabled)
	Set Disabled. More...
	getDisabled ()
	Get Disabled. More...
	checkInput ()
	Check input, strip slashes etc. More...
	setParentForm ($a_parentform)
	Set Parent Form. More...
	getParentForm ()
	Get Parent Form. More...
	setParent ($a_val)
	Set Parent GUI object. More...
	getParent ()
	Get Parent GUI object. More...
	getSubForm ()
	Get sub form html. More...
	hideSubForm ()
	Sub form hidden on init? More...
	setHiddenTitle ($a_val)
	Set hidden title (for screenreaders) More...
	getHiddenTitle ()
	Get hidden title. More...
	getItemByPostVar ($a_post_var)
	Get item by post var. More...
	serializeData ()
	serialize data More...
	unserializeData ($a_data)
	unserialize data More...
	writeToSession ()
	Write to session. More...
	clearFromSession ()
	Clear session value. More...
	readFromSession ()
	Read from session. More...
	getHiddenTag ($a_post_var, $a_value)
	Get hidden tag (used for disabled properties) More...
	setMulti ($a_multi, $a_sortable=false, $a_addremove=true)
	Set Multi. More...
	getMulti ()
	Get Multi. More...
	setMultiValues (array $a_values)
	Set multi values. More...
	getMultiValues ()
	Get multi values. More...
	getContentOutsideFormTag ()
	Get content that has to reside outside of the parent form tag, e.g. More...
	stripSlashesAddSpaceFallback ($a_str)
	Strip slashes with add space fallback, see https://www.ilias.de/mantis/view.php?id=19727. More...

Data Fields
const	REC_LIMITED = 2
const	REC_UNLIMITED = 1

Protected Member Functions
	loadRecurrence ()
	load recurrence settings protected More...
	buildWeekDaySelection ($tpl)
	build weekday checkboxes More...
	buildMonthlyByDaySelection ($tpl)
	build monthly by day list (e.g second monday) More...
	buildMonthlyByMonthDaySelection ($tpl)
	build monthly bymonthday selection More...
	buildYearlyByMonthDaySelection ($tpl)
	protected More...
	buildYearlyByDaySelection ($tpl)
	protected More...
	buildUntilSelection ($tpl)
	build selection for ending date More...
Protected Member Functions inherited from ilFormPropertyGUI
	setType ($a_type)
	Set Type. More...
	getMultiIconsHTML ()
	Get HTML for multiple value icons. More...

Protected Attributes
	$lng
	$recurrence
	$user_settings
	$allow_unlimited_recurrences = true
	$enabled_subforms
Protected Attributes inherited from ilCustomInputGUI
	$lng
	$html
Protected Attributes inherited from ilSubEnabledFormPropertyGUI
	$sub_items = array()
Protected Attributes inherited from ilFormPropertyGUI
	$ctrl
	$lng
	$type
	$title
	$postvar
	$info
	$alert
	$required = false
	$parentgui
	$parentform
	$hidden_title = ""
	$multi = false
	$multi_sortable = false
	$multi_addremove = true
	$multi_values

Additional Inherited Members
Static Public Member Functions inherited from ilFormPropertyGUI
static	removeProhibitedCharacters ($a_text)
	Remove prohibited characters see #19159. More...

Detailed Description

This class represents an input GUI for recurring events/appointments (course events or calendar appointments)

Author

Stefan Meyer smeye.nosp@m.r.il.nosp@m.ias@g.nosp@m.mx.d.nosp@m.e

Version

$Id$

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

Constructor & Destructor Documentation

__construct()

ilRecurrenceInputGUI::__construct	(		$a_title,
			$a_postvar
	)

Constructor.

public

Parameters

string	title
string	postvar

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

References $ilUser, $lng, $tpl, ilCalendarUserSettings\_getInstanceByUserId(), and setRecurrence().

    {
        global $lng,$tpl,$ilUser;
        
        $this->lng = $lng;
        $this->lng->loadLanguageModule('dateplaner');

        $this->user_settings = ilCalendarUserSettings::_getInstanceByUserId($ilUser->getId());
        $tpl->addJavascript("./Services/Calendar/js/recurrence_input.js");
        
        $this->setRecurrence(new ilCalendarRecurrence());
        
        parent::__construct($a_title, $a_postvar);
    }

Here is the call graph for this function:

Member Function Documentation

allowUnlimitedRecurrences()

ilRecurrenceInputGUI::allowUnlimitedRecurrences

(

$a_status

)

Allow unlimited recurrences.

Parameters

object

$a_status

Returns

Definition at line 241 of file class.ilRecurrenceInputGUI.php.

Referenced by ilObjSessionGUI\initForm().

    {
        $this->allow_unlimited_recurrences = $a_status;
    }

Here is the caller graph for this function:

buildMonthlyByDaySelection()

ilRecurrenceInputGUI::buildMonthlyByDaySelection (   $tpl )

protected

build monthly by day list (e.g second monday)

protected

Parameters

Definition at line 394 of file class.ilRecurrenceInputGUI.php.

References $i, $tpl, ilCalendarUtil\_numericDayToString(), array, and ilUtil\formSelect().

Referenced by insert().

    {
        $byday_list = $this->recurrence->getBYDAYList();
        $chosen_num_day = 1;
        $chosen_day = 'MO';
        $chosen = false;
        foreach ($byday_list as $byday) {
            if (preg_match('/^(-?\d)([A-Z][A-Z])/', $byday, $parsed) === 1) {
                $chosen = true;
                $chosen_num_day = $parsed[1];
                $chosen_day = $parsed[2];
            }
        }
        // check for last day
        if (count($this->recurrence->getBYMONTHDAYList()) == 1) {
            $bymonthday = $this->recurrence->getBYMONTHDAY();
            if (in_array($bymonthday, array(1,2,3,4,5,-1))) {
                $chosen = true;
                $chosen_num_day = $bymonthday;
                $chosen_day = 9;
            }
        }
        // Check for first, second... last weekday
        if (count($this->recurrence->getBYSETPOSList()) == 1) {
            $bysetpos = $this->recurrence->getBYSETPOS();
            if (in_array($bysetpos, array(1,2,3,4,5,-1))) {
                if ($this->recurrence->getBYDAYList() == array('MO','TU','WE','TH','FR')) {
                    $chosen = true;
                    $chosen_num_day = $bysetpos;
                    $chosen_day = 8;
                }
            }
        }
        
        

        if ($chosen) {
            $tpl->setVariable('M_BYDAY_CHECKED', 'checked="checked"');
        }

        $num_options = array(
            1 => $this->lng->txt('cal_first'),
            2 => $this->lng->txt('cal_second'),
            3 => $this->lng->txt('cal_third'),
            4 => $this->lng->txt('cal_fourth'),
            5 => $this->lng->txt('cal_fifth'),
           -1 => $this->lng->txt('cal_last'));
           
        $tpl->setVariable('SELECT_BYDAY_NUM_MONTHLY', ilUtil::formSelect(
            $chosen_num_day,
            'monthly_byday_num',
            $num_options,
            false,
            true,
            '',
            '',
            array('onchange' => "ilUpdateSubTypeSelection('sub_monthly_radio_1');")
        ));
            
        $days = array(0 => 'SU',1 => 'MO',2 => 'TU',3 => 'WE',4 => 'TH',5 => 'FR',6 => 'SA',7 => 'SU');
        
        for ($i = (int) $this->user_settings->getWeekStart();$i < 7 + (int) $this->user_settings->getWeekStart();$i++) {
            $days_select[$days[$i]] = ilCalendarUtil::_numericDayToString($i);
        }
        $days_select[8] = $this->lng->txt('cal_weekday');
        $days_select[9] = $this->lng->txt('cal_day_of_month');
        $tpl->setVariable('SEL_BYDAY_DAY_MONTHLY', ilUtil::formSelect(
            $chosen_day,
            'monthly_byday_day',
            $days_select,
            false,
            true,
            '',
            '',
            array('onchange' => "ilUpdateSubTypeSelection('sub_monthly_radio_1');")
        ));
    }

Here is the call graph for this function:

Here is the caller graph for this function:

buildMonthlyByMonthDaySelection()

ilRecurrenceInputGUI::buildMonthlyByMonthDaySelection (   $tpl )

protected

build monthly bymonthday selection

protected

Parameters

Definition at line 479 of file class.ilRecurrenceInputGUI.php.

References $i, $options, $tpl, array, and ilUtil\formSelect().

Referenced by insert().

    {
        $tpl->setVariable('TXT_IN', $this->lng->txt('cal_in'));
        
        $chosen_day = 1;
        $chosen = false;
        if (count($bymonthday = $this->recurrence->getBYMONTHDAYList()) == 1) {
            foreach ($bymonthday as $mday) {
                if ($mday > 0 and $mday < 32) {
                    $chosen = true;
                    $chosen_day = $mday;
                }
            }
        }

        if ($chosen) {
            $tpl->setVariable('M_BYMONTHDAY_CHECKED', 'checked="checked"');
        }
        
        for ($i = 1; $i < 32;$i++) {
            $options[$i] = $i;
        }
        $tpl->setVariable('SELECT_BYMONTHDAY', ilUtil::formSelect(
            $chosen_day,
            'monthly_bymonthday',
            $options,
            false,
            true,
            '',
            '',
            array('onchange' => "ilUpdateSubTypeSelection('sub_monthly_radio_2');")
        ));
    }

Here is the call graph for this function:

Here is the caller graph for this function:

buildUntilSelection()

ilRecurrenceInputGUI::buildUntilSelection (   $tpl )

protected

build selection for ending date

protected

Parameters

object

tpl

Returns

Definition at line 665 of file class.ilRecurrenceInputGUI.php.

References $tpl, and isUnlimitedRecurrenceAllowed().

Referenced by insert().

    {
        if ($this->isUnlimitedRecurrenceAllowed()) {
            $tpl->setVariable('TXT_NO_ENDING', $this->lng->txt('cal_no_ending'));
        }
        
        $tpl->setVariable('TXT_UNTIL_CREATE', $this->lng->txt('cal_create'));
        $tpl->setVariable('TXT_APPOINTMENTS', $this->lng->txt('cal_appointments'));
        
        $tpl->setVariable('VAL_COUNT', $this->recurrence->getFrequenceUntilCount() ?
            $this->recurrence->getFrequenceUntilCount() :
            2);
            
        if ($this->recurrence->getFrequenceUntilDate()) {
            $tpl->setVariable('UNTIL_END_CHECKED', 'checked="checked"');
        } elseif ($this->recurrence->getFrequenceUntilCount() or !$this->isUnlimitedRecurrenceAllowed()) {
            $tpl->setVariable('UNTIL_COUNT_CHECKED', 'checked="checked"');
        } else {
            $tpl->setVariable('UNTIL_NO_CHECKED', 'checked="checked"');
        }

        $tpl->setVariable('TXT_UNTIL_END', $this->lng->txt('cal_repeat_until'));
        $dt = new ilDateTimeInputGUI('', 'until_end');
        // no proper subform
        // $dt->setRequired(true);
        $dt->setDate(
            $this->recurrence->getFrequenceUntilDate() ? $this->recurrence->getFrequenceUntilDate() : null
        );
        $tpl->setVariable('UNTIL_END_DATE', $dt->getTableFilterHTML());
    }

Here is the call graph for this function:

Here is the caller graph for this function:

buildWeekDaySelection()

ilRecurrenceInputGUI::buildWeekDaySelection (   $tpl )

protected

build weekday checkboxes

protected

Parameters

object

tpl

Definition at line 363 of file class.ilRecurrenceInputGUI.php.

References $i, $tpl, ilCalendarUtil\_numericDayToString(), and array.

Referenced by insert().

    {
        $days = array(0 => 'SU',1 => 'MO',2 => 'TU',3 => 'WE',4 => 'TH',5 => 'FR',6 => 'SA',7 => 'SU');
        
        $checked_days = array();
        foreach ($this->recurrence->getBYDAYList() as $byday) {
            if (in_array($byday, $days)) {
                $checked_days[] = $byday;
            }
        }
        
        for ($i = (int) $this->user_settings->getWeekStart();$i < 7 + (int) $this->user_settings->getWeekStart();$i++) {
            $tpl->setCurrentBlock('byday_simple');
            
            if (in_array($days[$i], $checked_days)) {
                $tpl->setVariable('BYDAY_WEEKLY_CHECKED', 'checked="checked"');
            }
            $tpl->setVariable('TXT_ON', $this->lng->txt('cal_on'));
            $tpl->setVariable('BYDAY_WEEKLY_VAL', $days[$i]);
            $tpl->setVariable('TXT_DAY_SHORT', ilCalendarUtil::_numericDayToString($i, false));
            $tpl->parseCurrentBlock();
        }
    }

Here is the call graph for this function:

Here is the caller graph for this function:

buildYearlyByDaySelection()

ilRecurrenceInputGUI::buildYearlyByDaySelection (   $tpl )

protected

protected

Parameters

Definition at line 581 of file class.ilRecurrenceInputGUI.php.

References $i, $m, $options, $tpl, ilCalendarUtil\_numericDayToString(), ilCalendarUtil\_numericMonthToString(), array, and ilUtil\formSelect().

Referenced by insert().

    {
        $tpl->setVariable('TXT_ON_THE', $this->lng->txt('cal_on_the'));

        $chosen_num_day = 1;
        $chosen_day = 'MO';
        $chosen = false;
        foreach ($this->recurrence->getBYDAYList() as $byday) {
            if (preg_match('/^(-?\d)([A-Z][A-Z])/', $byday, $parsed) === 1) {
                $chosen = true;
                $chosen_num_day = $parsed[1];
                $chosen_day = $parsed[2];
            }
        }


        $num_options = array(
            1 => $this->lng->txt('cal_first'),
            2 => $this->lng->txt('cal_second'),
            3 => $this->lng->txt('cal_third'),
            4 => $this->lng->txt('cal_fourth'),
            5 => $this->lng->txt('cal_fifth'),
           -1 => $this->lng->txt('cal_last'));
           
        $tpl->setVariable('SELECT_BYDAY_NUM_YEARLY', ilUtil::formSelect(
            $chosen_num_day,
            'yearly_byday_num',
            $num_options,
            false,
            true,
            '',
            '',
            array('onchange' => "ilUpdateSubTypeSelection('sub_yearly_radio_1');")
        ));
            
        
        $days = array(0 => 'SU',1 => 'MO',2 => 'TU',3 => 'WE',4 => 'TH',5 => 'FR',6 => 'SA',7 => 'SU');
        for ($i = (int) $this->user_settings->getWeekStart();$i < 7 + (int) $this->user_settings->getWeekStart();$i++) {
            $days_select[$days[$i]] = ilCalendarUtil::_numericDayToString($i);
        }
        $tpl->setVariable('SELECT_BYDAY_DAY_YEARLY', ilUtil::formSelect(
            $chosen_day,
            'yearly_byday',
            $days_select,
            false,
            true,
            '',
            '',
            array('onchange' => "ilUpdateSubTypeSelection('sub_yearly_radio_1');")
        ));
            
    
        $chosen = false;
        $chosen_month = 1;
        foreach ($this->recurrence->getBYMONTHList() as $month) {
            if ($this->recurrence->getBYMONTHDAYList()) {
                $chosen_month = $month;
                $chosen = true;
                break;
            }
        }
        $options = array();
        for ($m = 1;$m < 13;$m++) {
            $options[$m] = ilCalendarUtil::_numericMonthToString($m);
        }
        $tpl->setVariable('SELECT_BYMONTH_BYDAY', ilUtil::formSelect(
            $chosen_month,
            'yearly_bymonth_byday',
            $options,
            false,
            true,
            '',
            '',
            array('onchange' => "ilUpdateSubTypeSelection('sub_yearly_radio_1');")
        ));
    }

Here is the call graph for this function:

Here is the caller graph for this function:

buildYearlyByMonthDaySelection()

ilRecurrenceInputGUI::buildYearlyByMonthDaySelection (   $tpl )

protected

protected

Parameters

objet

tpl

Returns

Definition at line 520 of file class.ilRecurrenceInputGUI.php.

References $i, $m, $options, $tpl, ilCalendarUtil\_numericMonthToString(), array, and ilUtil\formSelect().

Referenced by insert().

    {
        $tpl->setVariable('TXT_Y_EVERY', $this->lng->txt('cal_every'));

            
        $chosen = false;
        $chosen_month = 1;
        $chosen_day = 1;
        foreach ($this->recurrence->getBYMONTHList() as $month) {
            if ($this->recurrence->getBYMONTHDAYList()) {
                $chosen_month = $month;
                $chosen = true;
                break;
            }
        }
        foreach ($this->recurrence->getBYMONTHDAYList() as $day) {
            $chosen_day = $day;
        }
            
        for ($i = 1; $i < 32;$i++) {
            $options[$i] = $i;
        }
        $tpl->setVariable('SELECT_BYMONTHDAY_NUM_YEARLY', ilUtil::formSelect(
            $chosen_day,
            'yearly_bymonthday',
            $options,
            false,
            true,
            '',
            '',
            array('onchange' => "ilUpdateSubTypeSelection('sub_yearly_radio_2');")
        ));
        
        $options = array();
        for ($m = 1;$m < 13;$m++) {
            $options[$m] = ilCalendarUtil::_numericMonthToString($m);
        }
        $tpl->setVariable('SELECT_BYMONTH_YEARLY', ilUtil::formSelect(
            $chosen_month,
            'yearly_bymonth_by_monthday',
            $options,
            false,
            true,
            '',
            '',
            array('onchange' => "ilUpdateSubTypeSelection('sub_yearly_radio_2');")
        ));
            
            
        if ($chosen) {
            $tpl->setVariable('Y_BYMONTHDAY_CHECKED', 'checked="checked"');
        }
    }

Here is the call graph for this function:

Here is the caller graph for this function:

checkInput()

ilRecurrenceInputGUI::checkInput

(

)

check input

public

Parameters

Definition at line 84 of file class.ilRecurrenceInputGUI.php.

References $_POST, $lng, loadRecurrence(), and ilFormPropertyGUI\setAlert().

    {
        global $lng;
        
        if (!$this->loadRecurrence()) {
            return false;
        }

        if ($_POST['frequence'] == 'NONE') {
            return true;
        }
        
        if (!isset($_POST['until_type']) or $_POST['until_type'] == self::REC_LIMITED) {
            if ($_POST['count'] <= 0 or $_POST['count'] >= 100) {
                $this->setAlert($lng->txt("cal_rec_err_limit"));
                return false;
            }
        }
        

        return true;
    }

Here is the call graph for this function:

getEnabledSubForms()

ilRecurrenceInputGUI::getEnabledSubForms

(

)

get enabled subforms

public

Returns

Definition at line 273 of file class.ilRecurrenceInputGUI.php.

References $enabled_subforms.

Referenced by insert().

    {
        return $this->enabled_subforms;
    }

Here is the caller graph for this function:

getRecurrence()

ilRecurrenceInputGUI::getRecurrence

(

)

Get Recurrence.

Returns

ilCalendarRecurrence

Definition at line 231 of file class.ilRecurrenceInputGUI.php.

References $recurrence.

Referenced by loadRecurrence().

    {
        return $this->recurrence;
    }

Here is the caller graph for this function:

insert()

ilRecurrenceInputGUI::insert

(

$a_tpl

)

insert

public

Parameters

Definition at line 285 of file class.ilRecurrenceInputGUI.php.

References $options, $tpl, array, buildMonthlyByDaySelection(), buildMonthlyByMonthDaySelection(), buildUntilSelection(), buildWeekDaySelection(), buildYearlyByDaySelection(), buildYearlyByMonthDaySelection(), ilUtil\formSelect(), getEnabledSubForms(), IL_CAL_FREQ_DAILY, IL_CAL_FREQ_MONTHLY, IL_CAL_FREQ_WEEKLY, and IL_CAL_FREQ_YEARLY.

    {
        $tpl = new ilTemplate('tpl.recurrence_input.html', true, true, 'Services/Calendar');
        
        $options = array('NONE' => $this->lng->txt('cal_no_recurrence'));
        if (in_array(IL_CAL_FREQ_DAILY, $this->getEnabledSubForms())) {
            $options[IL_CAL_FREQ_DAILY] = $this->lng->txt('cal_daily');
        }
        if (in_array(IL_CAL_FREQ_WEEKLY, $this->getEnabledSubForms())) {
            $options[IL_CAL_FREQ_WEEKLY] = $this->lng->txt('cal_weekly');
        }
        if (in_array(IL_CAL_FREQ_MONTHLY, $this->getEnabledSubForms())) {
            $options[IL_CAL_FREQ_MONTHLY] = $this->lng->txt('cal_monthly');
        }
        if (in_array(IL_CAL_FREQ_YEARLY, $this->getEnabledSubForms())) {
            $options[IL_CAL_FREQ_YEARLY] = $this->lng->txt('cal_yearly');
        }
        
        $tpl->setVariable('FREQUENCE', ilUtil::formSelect(
            $this->recurrence->getFrequenceType(),
            'frequence',
            $options,
            false,
            true,
            '',
            '',
            array('onchange' => 'ilHideFrequencies();','id' => 'il_recurrence_1')
        ));
        
        $tpl->setVariable('TXT_EVERY', $this->lng->txt('cal_every'));

        // DAILY
        if (in_array(IL_CAL_FREQ_DAILY, $this->getEnabledSubForms())) {
            $tpl->setVariable('TXT_DAILY_FREQ_UNIT', $this->lng->txt('cal_day_s'));
            $tpl->setVariable('COUNT_DAILY_VAL', $this->recurrence->getInterval());
        }
        
        // WEEKLY
        if (in_array(IL_CAL_FREQ_WEEKLY, $this->getEnabledSubForms())) {
            $tpl->setVariable('TXT_WEEKLY_FREQ_UNIT', $this->lng->txt('cal_week_s'));
            $tpl->setVariable('COUNT_WEEKLY_VAL', $this->recurrence->getInterval());
            $this->buildWeekDaySelection($tpl);
        }
        
        // MONTHLY
        if (in_array(IL_CAL_FREQ_MONTHLY, $this->getEnabledSubForms())) {
            $tpl->setVariable('TXT_MONTHLY_FREQ_UNIT', $this->lng->txt('cal_month_s'));
            $tpl->setVariable('COUNT_MONTHLY_VAL', $this->recurrence->getInterval());
            $tpl->setVariable('TXT_ON_THE', $this->lng->txt('cal_on_the'));
            $tpl->setVariable('TXT_BYMONTHDAY', $this->lng->txt('cal_on_the'));
            $tpl->setVariable('TXT_OF_THE_MONTH', $this->lng->txt('cal_of_the_month'));
            $this->buildMonthlyByDaySelection($tpl);
            $this->buildMonthlyByMonthDaySelection($tpl);
        }

        // YEARLY
        if (in_array(IL_CAL_FREQ_YEARLY, $this->getEnabledSubForms())) {
            $tpl->setVariable('TXT_YEARLY_FREQ_UNIT', $this->lng->txt('cal_year_s'));
            $tpl->setVariable('COUNT_YEARLY_VAL', $this->recurrence->getInterval());
            $tpl->setVariable('TXT_ON_THE', $this->lng->txt('cal_on_the'));
            $this->buildYearlyByMonthDaySelection($tpl);
            $this->buildYearlyByDaySelection($tpl);
        }

        // UNTIL
        $this->buildUntilSelection($tpl);
        
        $a_tpl->setCurrentBlock("prop_custom");
        $a_tpl->setVariable("CUSTOM_CONTENT", $tpl->get());
        $a_tpl->parseCurrentBlock();
    }

Here is the call graph for this function:

isUnlimitedRecurrenceAllowed()

ilRecurrenceInputGUI::isUnlimitedRecurrenceAllowed

(

)

Check if unlimited recurrence is allowed.

Returns

Definition at line 250 of file class.ilRecurrenceInputGUI.php.

References $allow_unlimited_recurrences.

Referenced by buildUntilSelection().

    {
        return $this->allow_unlimited_recurrences;
    }

Here is the caller graph for this function:

loadRecurrence()

ilRecurrenceInputGUI::loadRecurrence ( )

protected

load recurrence settings protected

Returns

Definition at line 112 of file class.ilRecurrenceInputGUI.php.

References $_POST, getRecurrence(), IL_CAL_FREQ_DAILY, IL_CAL_FREQ_MONTHLY, IL_CAL_FREQ_WEEKLY, IL_CAL_FREQ_YEARLY, and ilUtil\stripSlashes().

Referenced by checkInput().

    {
        if (!$this->getRecurrence() instanceof ilCalendarRecurrence) {
            return false;
        }
        
        
        switch ($_POST['frequence']) {
            case IL_CAL_FREQ_DAILY:
                $this->getRecurrence()->setFrequenceType($_POST['frequence']);
                $this->getRecurrence()->setInterval((int) $_POST['count_DAILY']);
                break;
            
            case IL_CAL_FREQ_WEEKLY:
                $this->getRecurrence()->setFrequenceType($_POST['frequence']);
                $this->getRecurrence()->setInterval((int) $_POST['count_WEEKLY']);
                if (is_array($_POST['byday_WEEKLY'])) {
                    $this->getRecurrence()->setBYDAY(ilUtil::stripSlashes(implode(',', $_POST['byday_WEEKLY'])));
                }
                break;

            case IL_CAL_FREQ_MONTHLY:
                $this->getRecurrence()->setFrequenceType($_POST['frequence']);
                $this->getRecurrence()->setInterval((int) $_POST['count_MONTHLY']);
                switch ((int) $_POST['subtype_MONTHLY']) {
                    case 0:
                        // nothing to do;
                        break;
                    
                    case 1:
                        switch ((int) $_POST['monthly_byday_day']) {
                            case 8:
                                // Weekday
                                $this->getRecurrence()->setBYSETPOS((int) $_POST['monthly_byday_num']);
                                $this->getRecurrence()->setBYDAY('MO,TU,WE,TH,FR');
                                break;
                                
                            case 9:
                                // Day of month
                                $this->getRecurrence()->setBYMONTHDAY((int) $_POST['monthly_byday_num']);
                                break;
                                
                            default:
                                $this->getRecurrence()->setBYDAY((int) $_POST['monthly_byday_num'] . $_POST['monthly_byday_day']);
                                break;
                        }
                        break;
                    
                    case 2:
                        $this->getRecurrence()->setBYMONTHDAY((int) $_POST['monthly_bymonthday']);
                        break;
                }
                break;
            
            case IL_CAL_FREQ_YEARLY:
                $this->getRecurrence()->setFrequenceType($_POST['frequence']);
                $this->getRecurrence()->setInterval((int) $_POST['count_YEARLY']);
                switch ((int) $_POST['subtype_YEARLY']) {
                    case 0:
                        // nothing to do;
                        break;
                    
                    case 1:
                        $this->getRecurrence()->setBYMONTH((int) $_POST['yearly_bymonth_byday']);
                        $this->getRecurrence()->setBYDAY((int) $_POST['yearly_byday_num'] . $_POST['yearly_byday']);
                        break;
                    
                    case 2:
                        $this->getRecurrence()->setBYMONTH((int) $_POST['yearly_bymonth_by_monthday']);
                        $this->getRecurrence()->setBYMONTHDAY((int) $_POST['yearly_bymonthday']);
                        break;
                }
                break;
        }
        
        // UNTIL
        switch ((int) $_POST['until_type']) {
            case 1:
                $this->getRecurrence()->setFrequenceUntilDate(null);
                // nothing to do
                break;
                
            case 2:
                $this->getRecurrence()->setFrequenceUntilDate(null);
                $this->getRecurrence()->setFrequenceUntilCount((int) $_POST['count']);
                break;
                
            case 3:
                $dt = new ilDateTimeInputGUI('', 'until_end');
                $dt->setRequired(true);
                if ($dt->checkInput()) {
                    $this->getRecurrence()->setFrequenceUntilCount(0);
                    $this->getRecurrence()->setFrequenceUntilDate($dt->getDate());
                } else {
                    return false;
                }
                break;
        }
        
        return true;
    }

Here is the call graph for this function:

Here is the caller graph for this function:

setEnabledSubForms()

ilRecurrenceInputGUI::setEnabledSubForms

(

$a_sub_forms

)

set enabled subforms

public

Parameters

array(IL_CAL_FREQ_DAILY,IL_CAL_FREQ_WEEKLY...)

Returns

Definition at line 262 of file class.ilRecurrenceInputGUI.php.

Referenced by ilConsultationHoursGUI\initFormSequence().

    {
        $this->enabled_subforms = $a_sub_forms;
    }

Here is the caller graph for this function:

setRecurrence()

ilRecurrenceInputGUI::setRecurrence

(

$a_rec

)

set recurrence object

public

Parameters

Definition at line 222 of file class.ilRecurrenceInputGUI.php.

Referenced by __construct().

    {
        $this->recurrence = $a_rec;
    }

Here is the caller graph for this function:

Field Documentation

$allow_unlimited_recurrences

ilRecurrenceInputGUI::$allow_unlimited_recurrences = true

protected

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

Referenced by isUnlimitedRecurrenceAllowed().

$enabled_subforms

ilRecurrenceInputGUI::$enabled_subforms

protected

Initial value:

= array(
        IL_CAL_FREQ_DAILY,
        IL_CAL_FREQ_WEEKLY,
        IL_CAL_FREQ_MONTHLY,
        IL_CAL_FREQ_YEARLY)

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

Referenced by getEnabledSubForms().

$lng

ilRecurrenceInputGUI::$lng

protected

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

Referenced by __construct(), and checkInput().

$recurrence

ilRecurrenceInputGUI::$recurrence

protected

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

Referenced by getRecurrence().

$user_settings

ilRecurrenceInputGUI::$user_settings

protected

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

REC_LIMITED

const ilRecurrenceInputGUI::REC_LIMITED = 2

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

REC_UNLIMITED

const ilRecurrenceInputGUI::REC_UNLIMITED = 1

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

---

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

• Services/Calendar/classes/Form/class.ilRecurrenceInputGUI.php