ilCalendarActions Class Reference

Checks if certain actions can be performed. More...

Collaboration diagram for ilCalendarActions:

Public Member Functions
	checkSettingsCal ($a_cat_id)
	Check calendar editing. More...
	checkShareCal ($a_cat_id)
	Check sharing (own) calendar. More...
	checkUnshareCal ($a_cat_id)
	Check un-sharing (other users) calendar. More...
	checkSynchronizeCal ($a_cat_id)
	Check synchronize remote calendar. More...
	checkAddEvent ($a_cat_id)
	Check if adding an event is possible. More...
	checkDeleteCal ($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
	$cats = null
	$user_id

Static Protected Attributes
static	$instance = null

Detailed Description

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

Version

$Id$

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

Constructor & Destructor Documentation

__construct()

ilCalendarActions::__construct ( )

protected

Constructor.

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

References $DIC, and ilCalendarCategories\_getInstance().

    {
        global $DIC;

        $this->user_id = $DIC->user()->getId();

        include_once("./Services/Calendar/classes/class.ilCalendarCategories.php");
        $this->cats = ilCalendarCategories::_getInstance($this->user_id);
        if ($this->cats->getMode() == 0) {
            include_once("./Services/Calendar/exceptions/class.ilCalCategoriesNotInitializedException.php");
            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

(

$a_cat_id

)

Check if adding an event is possible.

Parameters

int

$a_cat_id

calendar category id

Returns

bool

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

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

checkDeleteCal()

ilCalendarActions::checkDeleteCal

(

$a_cat_id

)

Check if adding an event is possible.

Parameters

int

$a_cat_id

calendar category id

Returns

bool

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

References ilCalendarCategory\TYPE_GLOBAL, and ilCalendarCategory\TYPE_USR.

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

        return false;
    }

checkSettingsCal()

ilCalendarActions::checkSettingsCal

(

$a_cat_id

)

Check calendar editing.

Parameters

int

$a_cat_id

calendar category id

Returns

bool

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

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

checkShareCal()

ilCalendarActions::checkShareCal

(

$a_cat_id

)

Check sharing (own) calendar.

Parameters

int

$a_cat_id

calendar category id

Returns

bool

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

References ilCalendarCategory\TYPE_USR.

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

        return false;
    }

checkSynchronizeCal()

ilCalendarActions::checkSynchronizeCal

(

$a_cat_id

)

Check synchronize remote calendar.

Parameters

int

$a_cat_id

calendar category id

Returns

bool

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

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

        return false;
    }

checkUnshareCal()

ilCalendarActions::checkUnshareCal

(

$a_cat_id

)

Check un-sharing (other users) calendar.

Parameters

int

$a_cat_id

calendar category id

Returns

bool

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

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

        return false;
    }

getInstance()

static ilCalendarActions::getInstance ( )

static

Get instance.

Returns

ilCalendarActions

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

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

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

Here is the caller graph for this function:

Field Documentation

$cats

ilCalendarActions::$cats = null

protected

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

$instance

ilCalendarActions::$instance = null

staticprotected

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

$user_id

ilCalendarActions::$user_id

protected

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

---

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

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