This file is part of ILIAS, a powerful learning management system published by ILIAS open source e-Learning e.V. More...

Inheritance diagram for ilRecurrenceInputGUI:

Collaboration diagram for ilRecurrenceInputGUI:

Public Member Functions
	__construct (string $a_title, string $a_postvar)

	checkInput ()
	@inheritDoc More...

	setRecurrence (ilCalendarRecurrence $a_rec)

	getRecurrence ()

	allowUnlimitedRecurrences (bool $a_status)
	Allow unlimited recurrences. More...

	isUnlimitedRecurrenceAllowed ()

	setEnabledSubForms (array $a_sub_forms)
	set enabled subforms More...

	getEnabledSubForms ()

	insert (ilTemplate $a_tpl)
	@inheritDoc More...

Public Member Functions inherited from ilCustomInputGUI
	__construct (string $a_title="", string $a_postvar="")

	setHtml (string $a_html)

	getHtml ()

	setValueByArray (array $a_values)

	insert (ilTemplate $a_tpl)

	setSkipRequiredCheck (bool $skip)

	checkInput ()
	Check input, strip slashes etc. More...

	getInput ()

Public Member Functions inherited from ilSubEnabledFormPropertyGUI
	addSubItem (ilFormPropertyGUI $a_item)

	getSubItems ()

	getSubInputItemsRecursive ()
	returns a flat array of possibly existing subitems recursively More...

	checkSubItemsInput ()
	Check SubItems. More...

	getSubForm ()

	getItemByPostVar (string $a_post_var)
	Get item by post var. More...

Public Member Functions inherited from ilFormPropertyGUI
	__construct (string $a_title="", string $a_postvar="")

	executeCommand ()

	getType ()

	setTitle (string $a_title)

	getTitle ()

	setPostVar (string $a_postvar)

	getPostVar ()

	getFieldId ()

	setInfo (string $a_info)

	getInfo ()

	setAlert (string $a_alert)

	getAlert ()

	setRequired (bool $a_required)

	getRequired ()

	setDisabled (bool $a_disabled)

	getDisabled ()

	checkInput ()
	Check input, strip slashes etc. More...

	setParentForm (ilPropertyFormGUI $a_parentform)

	getParentForm ()

	setParent (ilFormPropertyGUI $a_val)

	getParent ()

	getSubForm ()

	hideSubForm ()

	setHiddenTitle (string $a_val)

	getHiddenTitle ()

	getItemByPostVar (string $a_post_var)
	Get item by post var. More...

	serializeData ()

	unserializeData (string $a_data)

	setParentTable ($a_val)
	Set parent table. More...

	getParentTable ()
	Get parent table. More...

	writeToSession ()

	clearFromSession ()

	readFromSession ()

	getHiddenTag (string $a_post_var, string $a_value)

	setMulti (bool $a_multi, bool $a_sortable=false, bool $a_addremove=true)

	getMulti ()

	setMultiValues (array $a_values)

	getMultiValues ()

	getContentOutsideFormTag ()
	Get content that has to reside outside of the parent form tag, e.g. More...

	stripSlashesAddSpaceFallback (string $a_str)
	Strip slashes with add space fallback, see https://www.ilias.de/mantis/view.php?id=19727. More...

	getTableFilterLabelFor ()
	Get label "for" attribute value for filter. More...

	getFormLabelFor ()
	Get label "for" attribute value for form. More...

	setRequestParam (string $key, $val)
	This writes the request (aka post) values. More...

Protected Member Functions
	getRecurrenceInputByTypeAsInt (string $input)

	getRecurrenceInputByTypeAsString (string $input)

	loadRecurrence ()

	buildWeekDaySelection (ilTemplate $tpl)
	build weekday checkboxes More...

	buildMonthlyByDaySelection (ilTemplate $tpl)
	build monthly by day list (e.g second monday) More...

	buildMonthlyByMonthDaySelection (ilTemplate $tpl)
	build monthly bymonthday selection More...

	buildYearlyByMonthDaySelection (ilTemplate $tpl)

	buildYearlyByDaySelection (ilTemplate $tpl)

	buildUntilSelection (ilTemplate $tpl)
	build selection for ending date More...

Protected Member Functions inherited from ilFormPropertyGUI
	setType (string $a_type)

	checkParentFormTable ()

	getSessionKey ()

	getMultiIconsHTML ()

	int ($key)

	intArray ($key)

	str ($key)

	raw ($key)

	strArray ($key)

	arrayArray ($key)

	isRequestParamArray (string $key)

	getRequestParam (string $key, Refinery\Transformation $t)

Protected Attributes
const	REC_LIMITED = 2

const	REC_UNLIMITED = 1

ilCalendarRecurrence	$recurrence

ilObjUser	$user

ilCalendarUserSettings	$user_settings

bool	$allow_unlimited_recurrences = true

array	$enabled_subforms

Protected Attributes inherited from ilCustomInputGUI
bool	$skip_required_check = false

string	$html = ""

Protected Attributes inherited from ilSubEnabledFormPropertyGUI
array	$sub_items = array()

Protected Attributes inherited from ilFormPropertyGUI
array	$set_params = []

ilTable2GUI	$parent_table = null

ilFormPropertyGUI	$parent_gui = null

ilCtrl	$ctrl

ilLanguage	$lng

string	$type = ""

string	$title = ""

string	$postvar = ""

string	$info = ""

string	$alert = ""

bool	$required = false

ilPropertyFormGUI	$parentform = null

string	$hidden_title = ""

bool	$multi = false

bool	$multi_sortable = false

bool	$multi_addremove = true

array	$multi_values = []

RequestInterface	$request

HTTP Services	$http

Refinery Factory	$refinery = null

bool	$disabled = false

ilGlobalTemplateInterface	$global_tpl = null

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

Detailed Description

This file is part of ILIAS, a powerful learning management system published by ILIAS open source e-Learning e.V.

ILIAS is licensed with the GPL-3.0, see https://www.gnu.org/licenses/gpl-3.0.en.html You should have received a copy of said license along with the source code, too.

If this is not the case or you just want to try ILIAS, you'll find us at: https://www.ilias.de https://github.com/ILIAS-eLearning 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 28 of file class.ilRecurrenceInputGUI.php.

Constructor & Destructor Documentation

◆ __construct()

ilRecurrenceInputGUI::__construct	(	string	$a_title,
		string	$a_postvar
	)

Reimplemented from ilCustomInputGUI.

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

    {
        global $DIC;
 
        $DIC->ui()->mainTemplate()->addJavaScript("./Services/Calendar/js/recurrence_input.js");
        $this->user = $DIC->user();
        $this->user_settings = ilCalendarUserSettings::_getInstanceByUserId($this->user->getId());
        $this->recurrence = new ilCalendarRecurrence();
        parent::__construct($a_title, $a_postvar);
        $this->lng->loadLanguageModule('dateplaner');
    }

References $DIC, ILIAS\GlobalScreen\Provider\__construct(), ilCalendarUserSettings\_getInstanceByUserId(), ILIAS\Repository\lng(), and ILIAS\Repository\user().

Here is the call graph for this function:

Member Function Documentation

◆ allowUnlimitedRecurrences()

ilRecurrenceInputGUI::allowUnlimitedRecurrences ( bool $a_status )

Allow unlimited recurrences.

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

                                                             : void
    {
        $this->allow_unlimited_recurrences = $a_status;
    }

◆ buildMonthlyByDaySelection()

ilRecurrenceInputGUI::buildMonthlyByDaySelection ( ilTemplate $tpl )

protected

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

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

                                                                  : void
    {
        $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', ilLegacyFormElementsUtil::formSelect(
            $chosen_num_day,
            'monthly_byday_num',
            $num_options,
            false,
            true,
            0,
            '',
            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 = $this->user_settings->getWeekStart(); $i < 7 + $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', ilLegacyFormElementsUtil::formSelect(
            $chosen_day,
            'monthly_byday_day',
            $days_select,
            false,
            true,
            0,
            '',
            array('onchange' => "ilUpdateSubTypeSelection('sub_monthly_radio_1');")
        ));
    }

References $i, $tpl, ilCalendarUtil\_numericDayToString(), ilLegacyFormElementsUtil\formSelect(), ILIAS\Repository\lng(), and HTML_Template_IT\setVariable().

Referenced by insert().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ buildMonthlyByMonthDaySelection()

ilRecurrenceInputGUI::buildMonthlyByMonthDaySelection ( ilTemplate $tpl )

protected

build monthly bymonthday selection

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

                                                                       : void
    {
        $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"');
        }
        $options = [];
        for ($i = 1; $i < 32; $i++) {
            $options[$i] = $i;
        }
        $tpl->setVariable('SELECT_BYMONTHDAY', ilLegacyFormElementsUtil::formSelect(
            $chosen_day,
            'monthly_bymonthday',
            $options,
            false,
            true,
            0,
            '',
            array('onchange' => "ilUpdateSubTypeSelection('sub_monthly_radio_2');")
        ));
    }

References $i, $tpl, ilLegacyFormElementsUtil\formSelect(), and ILIAS\Repository\lng().

Referenced by insert().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ buildUntilSelection()

ilRecurrenceInputGUI::buildUntilSelection ( ilTemplate $tpl )

protected

build selection for ending date

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

                                                           : void
    {
        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() ?:
            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() ?: null
        );
        $tpl->setVariable('UNTIL_END_DATE', $dt->getTableFilterHTML());
    }

References $tpl, isUnlimitedRecurrenceAllowed(), ILIAS\Repository\lng(), and HTML_Template_IT\setVariable().

Referenced by insert().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ buildWeekDaySelection()

ilRecurrenceInputGUI::buildWeekDaySelection ( ilTemplate $tpl )

protected

build weekday checkboxes

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

                                                             : void
    {
        $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 = $this->user_settings->getWeekStart(); $i < 7 + $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('DAY_COUNT', $i);
            $tpl->setVariable('BYDAY_WEEKLY_VAL', $days[$i]);
            $tpl->setVariable('TXT_DAY_SHORT', ilCalendarUtil::_numericDayToString($i, false));
            $tpl->parseCurrentBlock();
        }
    }

References $i, $tpl, ilCalendarUtil\_numericDayToString(), ILIAS\Repository\lng(), and HTML_Template_IT\setVariable().

Referenced by insert().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ buildYearlyByDaySelection()

ilRecurrenceInputGUI::buildYearlyByDaySelection ( ilTemplate $tpl )

protected

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

                                                                 : void
    {
        $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', ilLegacyFormElementsUtil::formSelect(
            $chosen_num_day,
            'yearly_byday_num',
            $num_options,
            false,
            true,
            0,
            '',
            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');
        $days_select = [];
        for ($i = $this->user_settings->getWeekStart(); $i < 7 + $this->user_settings->getWeekStart(); $i++) {
            $days_select[$days[$i]] = ilCalendarUtil::_numericDayToString($i);
        }
        $tpl->setVariable('SELECT_BYDAY_DAY_YEARLY', ilLegacyFormElementsUtil::formSelect(
            $chosen_day,
            'yearly_byday',
            $days_select,
            false,
            true,
            0,
            '',
            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', ilLegacyFormElementsUtil::formSelect(
            $chosen_month,
            'yearly_bymonth_byday',
            $options,
            false,
            true,
            0,
            '',
            array('onchange' => "ilUpdateSubTypeSelection('sub_yearly_radio_1');")
        ));
    }

References $i, $tpl, ilCalendarUtil\_numericDayToString(), ilCalendarUtil\_numericMonthToString(), ilLegacyFormElementsUtil\formSelect(), and ILIAS\Repository\lng().

Referenced by insert().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ buildYearlyByMonthDaySelection()

ilRecurrenceInputGUI::buildYearlyByMonthDaySelection ( ilTemplate $tpl )

protected

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

                                                                      : void
    {
        $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;
        }
        $options = [];
        for ($i = 1; $i < 32; $i++) {
            $options[$i] = $i;
        }
        $tpl->setVariable('SELECT_BYMONTHDAY_NUM_YEARLY', ilLegacyFormElementsUtil::formSelect(
            $chosen_day,
            'yearly_bymonthday',
            $options,
            false,
            true,
            0,
            '',
            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', ilLegacyFormElementsUtil::formSelect(
            $chosen_month,
            'yearly_bymonth_by_monthday',
            $options,
            false,
            true,
            0,
            '',
            array('onchange' => "ilUpdateSubTypeSelection('sub_yearly_radio_2');")
        ));
 
        if ($chosen) {
            $tpl->setVariable('Y_BYMONTHDAY_CHECKED', 'checked="checked"');
        }
    }

References $i, $tpl, ilCalendarUtil\_numericMonthToString(), ilLegacyFormElementsUtil\formSelect(), and ILIAS\Repository\lng().

Referenced by insert().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ checkInput()

ilRecurrenceInputGUI::checkInput ( )

@inheritDoc

Reimplemented from ilCustomInputGUI.

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

                                : bool
    {
        global $DIC;
 
        $lng = $DIC['lng'];
 
        if (!$this->loadRecurrence()) {
            return false;
        }
 
        if ($this->getRecurrenceInputByTypeAsString('frequence') === ilCalendarRecurrence::FREQ_NONE) {
            return true;
        }
 
        if (
            (
                $this->getRecurrenceInputByTypeAsInt('until_type') === 0 ||
                $this->getRecurrenceInputByTypeAsInt('until_type') == self::REC_LIMITED
            ) &&
            (
                $this->getRecurrenceInputByTypeAsInt('count') <= 0 ||
                $this->getRecurrenceInputByTypeAsInt('count') >= 100
            )
        ) {
            $this->setAlert($this->lng->txt("cal_rec_err_limit"));
            return false;
        }
        return true;
    }

References $DIC, ilFormPropertyGUI\$lng, ilCalendarRecurrence\FREQ_NONE, getRecurrenceInputByTypeAsInt(), getRecurrenceInputByTypeAsString(), ILIAS\Repository\lng(), loadRecurrence(), and ilFormPropertyGUI\setAlert().

Here is the call graph for this function:

◆ getEnabledSubForms()

ilRecurrenceInputGUI::getEnabledSubForms ( )

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

                                        : array
    {
        return $this->enabled_subforms;
    }

References $enabled_subforms.

Referenced by insert().

Here is the caller graph for this function:

◆ getRecurrence()

ilRecurrenceInputGUI::getRecurrence ( )

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

                                   : ilCalendarRecurrence
    {
        return $this->recurrence;
    }

References $recurrence.

Referenced by loadRecurrence().

Here is the caller graph for this function:

◆ getRecurrenceInputByTypeAsInt()

ilRecurrenceInputGUI::getRecurrenceInputByTypeAsInt ( string $input )

protected

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

                                                                   : int
    {
        if ($this->http->wrapper()->post()->has($input)) {
            return $this->http->wrapper()->post()->retrieve(
                $input,
                $this->refinery->kindlyTo()->int()
            );
        }
        return 0;
    }

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

Referenced by checkInput(), and loadRecurrence().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getRecurrenceInputByTypeAsString()

ilRecurrenceInputGUI::getRecurrenceInputByTypeAsString ( string $input )

protected

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

                                                                      : string
    {
        if ($this->http->wrapper()->post()->has($input)) {
            return $this->http->wrapper()->post()->retrieve(
                $input,
                $this->refinery->kindlyTo()->string()
            );
        }
        return '';
    }

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

Referenced by checkInput(), and loadRecurrence().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ insert()

ilRecurrenceInputGUI::insert ( ilTemplate $a_tpl )

@inheritDoc

Reimplemented from ilCustomInputGUI.

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

                                             : void
    {
        $tpl = new ilTemplate('tpl.recurrence_input.html', true, true, 'Services/Calendar');
 
        $options = array('NONE' => $this->lng->txt('cal_no_recurrence'));
        if (in_array(ilCalendarRecurrence::FREQ_DAILY, $this->getEnabledSubForms())) {
            $options[ilCalendarRecurrence::FREQ_DAILY] = $this->lng->txt('cal_daily');
        }
        if (in_array(ilCalendarRecurrence::FREQ_WEEKLY, $this->getEnabledSubForms())) {
            $options[ilCalendarRecurrence::FREQ_WEEKLY] = $this->lng->txt('cal_weekly');
        }
        if (in_array(ilCalendarRecurrence::FREQ_MONTHLY, $this->getEnabledSubForms())) {
            $options[ilCalendarRecurrence::FREQ_MONTHLY] = $this->lng->txt('cal_monthly');
        }
        if (in_array(ilCalendarRecurrence::FREQ_YEARLY, $this->getEnabledSubForms())) {
            $options[ilCalendarRecurrence::FREQ_YEARLY] = $this->lng->txt('cal_yearly');
        }
 
        $tpl->setVariable(
            'FREQUENCE',
            ilLegacyFormElementsUtil::formSelect(
                $this->recurrence->getFrequenceType(),
                'frequence',
                $options,
                false,
                true,
                0,
                '',
                ['onchange' => 'ilHideFrequencies();', 'id' => 'il_recurrence_1']
            )
        );
 
        $tpl->setVariable('TXT_EVERY', $this->lng->txt('cal_every'));
 
        // DAILY
        if (in_array(ilCalendarRecurrence::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(ilCalendarRecurrence::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(ilCalendarRecurrence::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(ilCalendarRecurrence::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();
    }

References $tpl, buildMonthlyByDaySelection(), buildMonthlyByMonthDaySelection(), buildUntilSelection(), buildWeekDaySelection(), buildYearlyByDaySelection(), buildYearlyByMonthDaySelection(), ilLegacyFormElementsUtil\formSelect(), ilCalendarRecurrence\FREQ_DAILY, ilCalendarRecurrence\FREQ_MONTHLY, ilCalendarRecurrence\FREQ_WEEKLY, ilCalendarRecurrence\FREQ_YEARLY, getEnabledSubForms(), ILIAS\Repository\lng(), ilTemplate\parseCurrentBlock(), ilTemplate\setCurrentBlock(), and HTML_Template_IT\setVariable().

Here is the call graph for this function:

◆ isUnlimitedRecurrenceAllowed()

ilRecurrenceInputGUI::isUnlimitedRecurrenceAllowed ( )

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

                                                  : bool
    {
        return $this->allow_unlimited_recurrences;
    }

References $allow_unlimited_recurrences.

Referenced by buildUntilSelection().

Here is the caller graph for this function:

◆ loadRecurrence()

ilRecurrenceInputGUI::loadRecurrence ( )

protected

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

                                       : bool
    {
        if (!$this->getRecurrence() instanceof ilCalendarRecurrence) {
            return false;
        }
        switch ($this->getRecurrenceInputByTypeAsString('frequence')) {
            case ilCalendarRecurrence::FREQ_DAILY:
                $this->getRecurrence()->setFrequenceType($this->getRecurrenceInputByTypeAsString('frequence'));
                $this->getRecurrence()->setInterval($this->getRecurrenceInputByTypeAsInt('count_DAILY'));
                break;
 
            case ilCalendarRecurrence::FREQ_WEEKLY:
                $this->getRecurrence()->setFrequenceType($this->getRecurrenceInputByTypeAsString('frequence'));
                $this->getRecurrence()->setInterval($this->getRecurrenceInputByTypeAsInt('count_WEEKLY'));
 
                $weekly_days = [];
                if ($this->http->wrapper()->post()->has('byday_WEEKLY')) {
                    $weekly_days = $this->http->wrapper()->post()->retrieve(
                        'byday_WEEKLY',
                        $this->refinery->kindlyTo()->dictOf(
                            $this->refinery->kindlyTo()->string()
                        )
                    );
                }
                if ($weekly_days !== []) {
                    $this->getRecurrence()->setBYDAY(implode(',', $weekly_days));
                }
                break;
 
            case ilCalendarRecurrence::FREQ_MONTHLY:
                $this->getRecurrence()->setFrequenceType($this->getRecurrenceInputByTypeAsString('frequence'));
                $this->getRecurrence()->setInterval($this->getRecurrenceInputByTypeAsInt('count_MONTHLY'));
                switch ($this->getRecurrenceInputByTypeAsInt('subtype_MONTHLY')) {
                    case 0:
                        // nothing to do;
                        break;
                    case 1:
                        switch ($this->getRecurrenceInputByTypeAsString('monthly_byday_day')) {
                            case '8':
                                // Weekday
                                $this->getRecurrence()->setBYSETPOS($this->getRecurrenceInputByTypeAsString('monthly_byday_num'));
                                $this->getRecurrence()->setBYDAY('MO,TU,WE,TH,FR');
                                break;
 
                            case '9':
                                // Day of month
                                $this->getRecurrence()->setBYMONTHDAY($this->getRecurrenceInputByTypeAsString('monthly_byday_num'));
                                break;
 
                            default:
                                $this->getRecurrence()->setBYDAY(
                                    $this->getRecurrenceInputByTypeAsString('monthly_byday_num') .
                                    $this->getRecurrenceInputByTypeAsString('monthly_byday_day')
                                );
                                break;
                        }
                        break;
 
                    case 2:
                        $this->getRecurrence()->setBYMONTHDAY($this->getRecurrenceInputByTypeAsString('monthly_bymonthday'));
                        break;
                }
                break;
 
            case ilCalendarRecurrence::FREQ_YEARLY:
                $this->getRecurrence()->setFrequenceType($this->getRecurrenceInputByTypeAsString('frequence'));
                $this->getRecurrence()->setInterval($this->getRecurrenceInputByTypeAsInt('count_YEARLY'));
                switch ($this->getRecurrenceInputByTypeAsInt('subtype_YEARLY')) {
                    case 0:
                        // nothing to do;
                        break;
 
                    case 1:
                        $this->getRecurrence()->setBYDAY(
                            $this->getRecurrenceInputByTypeAsString('yearly_byday_num') .
                            $this->getRecurrenceInputByTypeAsString('yearly_byday')
                        );
                        $this->getRecurrence()->setBYMONTH($this->getRecurrenceInputByTypeAsString('yearly_bymonth_byday'));
                        break;
 
                    case 2:
                        $this->getRecurrence()->setBYMONTH($this->getRecurrenceInputByTypeAsString('yearly_bymonthday'));
                        $this->getRecurrence()->setBYMONTHDAY($this->getRecurrenceInputByTypeAsString('yearly_bymonthday'));
                        break;
                }
                break;
        }
 
        // UNTIL
        switch ($this->getRecurrenceInputByTypeAsInt('until_type')) {
            case 1:
                $this->getRecurrence()->setFrequenceUntilDate(null);
                // nothing to do
                break;
 
            case 2:
                $this->getRecurrence()->setFrequenceUntilDate(null);
                $this->getRecurrence()->setFrequenceUntilCount($this->getRecurrenceInputByTypeAsInt('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;
    }

References ilCalendarRecurrence\FREQ_DAILY, ilCalendarRecurrence\FREQ_MONTHLY, ilCalendarRecurrence\FREQ_WEEKLY, ilCalendarRecurrence\FREQ_YEARLY, getRecurrence(), getRecurrenceInputByTypeAsInt(), getRecurrenceInputByTypeAsString(), ILIAS\FileDelivery\http(), and ILIAS\Repository\refinery().

Referenced by checkInput().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ setEnabledSubForms()

ilRecurrenceInputGUI::setEnabledSubForms ( array $a_sub_forms )

set enabled subforms

Parameters

array(IL_CAL_FREQ_DAILY,FREQ_WEEKLY...)

Returns: void

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

                                                          : void
    {
        $this->enabled_subforms = $a_sub_forms;
    }

◆ setRecurrence()

ilRecurrenceInputGUI::setRecurrence ( ilCalendarRecurrence $a_rec )

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

                                                              : void
    {
        $this->recurrence = $a_rec;
    }

Field Documentation

◆ $allow_unlimited_recurrences

bool ilRecurrenceInputGUI::$allow_unlimited_recurrences = true

protected

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

Referenced by isUnlimitedRecurrenceAllowed().

◆ $enabled_subforms

array ilRecurrenceInputGUI::$enabled_subforms

protected

Initial value:

= array(
        ilCalendarRecurrence::FREQ_DAILY,
        ilCalendarRecurrence::FREQ_WEEKLY,
        ilCalendarRecurrence::FREQ_MONTHLY,
        ilCalendarRecurrence::FREQ_YEARLY
    )

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

Referenced by getEnabledSubForms().

◆ $recurrence

ilCalendarRecurrence ilRecurrenceInputGUI::$recurrence

protected

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

Referenced by getRecurrence().

◆ $user

ilObjUser ilRecurrenceInputGUI::$user

protected

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

◆ $user_settings

ilCalendarUserSettings ilRecurrenceInputGUI::$user_settings

protected

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

◆ REC_LIMITED

const ilRecurrenceInputGUI::REC_LIMITED = 2

protected

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

◆ REC_UNLIMITED

const ilRecurrenceInputGUI::REC_UNLIMITED = 1

protected

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

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

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

Public Member Functions

Protected Member Functions

Protected Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ __construct()

Member Function Documentation

◆ allowUnlimitedRecurrences()

◆ buildMonthlyByDaySelection()

◆ buildMonthlyByMonthDaySelection()

◆ buildUntilSelection()

◆ buildWeekDaySelection()

◆ buildYearlyByDaySelection()

◆ buildYearlyByMonthDaySelection()

◆ checkInput()

◆ getEnabledSubForms()

◆ getRecurrence()

◆ getRecurrenceInputByTypeAsInt()

◆ getRecurrenceInputByTypeAsString()

◆ insert()

◆ isUnlimitedRecurrenceAllowed()

◆ loadRecurrence()

◆ setEnabledSubForms()

◆ setRecurrence()

Field Documentation

◆ $allow_unlimited_recurrences

◆ $enabled_subforms

◆ $recurrence

◆ $user

◆ $user_settings

◆ REC_LIMITED

◆ REC_UNLIMITED