ilCalendarActions Class Reference

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

Collaboration diagram for ilCalendarActions:

Public Member Functions
	checkSettingsCal (int $a_cat_id)
	Check calendar editing. More...
	checkShareCal (int $a_cat_id)
	Check sharing (own) calendar. More...
	checkUnshareCal (int $a_cat_id)
	Check un-sharing (other users) calendar. More...
	checkSynchronizeCal (int $a_cat_id)
	Check synchronize remote calendar. More...
	checkAddEvent (int $a_cat_id)
	Check if adding an event is possible. More...
	checkDeleteCal (int $a_cat_id)
	Check if adding an event is possible. More...

Static Public Member Functions
static	getInstance ()
	Get instance. More...

Protected Member Functions
	__construct ()
	Constructor. More...

Protected Attributes
ilCalendarCategories	$cats

Static Protected Attributes
static ilCalendarActions	$instance = null

Private Attributes
int	$user_id

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 Checks if certain actions can be performed

Author

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

Definition at line 25 of file class.ilCalendarActions.php.

Constructor & Destructor Documentation

__construct()

ilCalendarActions::__construct ( )

protected

Constructor.

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

References $DIC, ilCalendarCategories\_getInstance(), and ilCalendarCategories\MODE_UNDEFINED.

    {
        global $DIC;

        $this->user_id = $DIC->user()->getId();
        $this->cats = ilCalendarCategories::_getInstance($this->user_id);
        if ($this->cats->getMode() == ilCalendarCategories::MODE_UNDEFINED) {
            throw new ilCalCategoriesNotInitializedException(
                "ilCalendarActions needs ilCalendarCategories to be initialized for user " . $this->user_id
            );
        }
    }

Here is the call graph for this function:

Member Function Documentation

checkAddEvent()

ilCalendarActions::checkAddEvent

(

int

$a_cat_id

)

Check if adding an event is possible.

Definition at line 106 of file class.ilCalendarActions.php.

                                                : bool
    {
        $info = $this->cats->getCategoryInfo($a_cat_id);
        return $info['editable'] ?? false;
    }

checkDeleteCal()

ilCalendarActions::checkDeleteCal

(

int

$a_cat_id

)

Check if adding an event is possible.

Definition at line 115 of file class.ilCalendarActions.php.

References ilCalendarCategory\TYPE_GLOBAL, and ilCalendarCategory\TYPE_USR.

                                                 : bool
    {
        $info = $this->cats->getCategoryInfo($a_cat_id);
        if (($info['type'] ?? 0) == ilCalendarCategory::TYPE_USR && ($info['obj_id'] ?? 0) == $this->user_id) {
            return true;
        }
        if (($info['type'] ?? 0) == ilCalendarCategory::TYPE_GLOBAL && ($info['settings'] ?? false)) {
            return true;
        }
        return false;
    }

checkSettingsCal()

ilCalendarActions::checkSettingsCal

(

int

$a_cat_id

)

Check calendar editing.

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

                                                   : bool
    {
        $info = $this->cats->getCategoryInfo($a_cat_id);
        return (bool) ($info['settings'] ?? false);
    }

checkShareCal()

ilCalendarActions::checkShareCal

(

int

$a_cat_id

)

Check sharing (own) calendar.

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

References ilCalendarCategory\TYPE_USR.

                                                : bool
    {
        $info = $this->cats->getCategoryInfo($a_cat_id);
        return
            ($info['type'] ?? 0) == ilCalendarCategory::TYPE_USR &&
            ($info['obj_id'] ?? '') == $this->user_id;
    }

checkSynchronizeCal()

ilCalendarActions::checkSynchronizeCal

(

int

$a_cat_id

)

Check synchronize remote calendar.

Definition at line 94 of file class.ilCalendarActions.php.

                                                      : bool
    {
        $info = $this->cats->getCategoryInfo($a_cat_id);
        if ($info['remote'] ?? false) {
            return true;
        }
        return false;
    }

checkUnshareCal()

ilCalendarActions::checkUnshareCal

(

int

$a_cat_id

)

Check un-sharing (other users) calendar.

Definition at line 82 of file class.ilCalendarActions.php.

                                                  : bool
    {
        $info = $this->cats->getCategoryInfo($a_cat_id);
        if ($info['accepted'] ?? false) {
            return true;
        }
        return false;
    }

getInstance()

static ilCalendarActions::getInstance ( )

static

Get instance.

Definition at line 51 of file class.ilCalendarActions.php.

Referenced by ilCalendarManageTableGUI\__construct(), ilCalendarPresentationGUI\__construct(), and ilCalendarCategoryGUI\__construct().

                                        : ilCalendarActions
    {
        if (!self::$instance instanceof self) {
            self::$instance = new self();
        }
        return self::$instance;
    }

Here is the caller graph for this function:

Field Documentation

$cats

ilCalendarCategories ilCalendarActions::$cats

protected

Definition at line 29 of file class.ilCalendarActions.php.

$instance

ilCalendarActions ilCalendarActions::$instance = null

staticprotected

Definition at line 27 of file class.ilCalendarActions.php.

$user_id

int ilCalendarActions::$user_id

private

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

---

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

• components/ILIAS/Calendar/classes/class.ilCalendarActions.php