Owner Interface Reference

Inheritance diagram for Owner:

Public Member Functions
	isCalendarReadable (?string $user_id=null)
	isCalendarWritable (?string $user_id=null)

Static Public Member Functions
static	getCalendarOwner (string $owner_id)

Detailed Description

The Studip interface defines methods that classes whose instances own calendars shall implement to faciliate permission checks for that calendars.

Member Function Documentation

getCalendarOwner()

static getCalendarOwner ( string  $owner_id )

static

Retrieves the Owner object for a specified owner-ID.

Parameters

string

$owner_id

The ID of the owner.

Returns

Owner|null Either the Owner object if it can be found or null in case it cannot be found.

Implemented in Course, and User.

isCalendarReadable()

isCalendarReadable

(

?string

$user_id = null

)

Determines whether the specified user has read permissions to the calendar.

Parameters

string | null

$user_id

The ID of the user for which to determine write permissions. Defaults to the current user if no user-ID is provided.

Returns

bool True, if the user has read permissions, false otherwise.

Implemented in Course, and User.

isCalendarWritable()

isCalendarWritable

(

?string

$user_id = null

)

Determines whether the specified user has write permissions to the calendar.

Parameters

string | null

$user_id

The ID of the user for which to determine write permissions. Defaults to the current user if no user-ID is provided.

Returns

bool True, if the user has write permissions, false otherwise.

---

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

• lib/classes/calendar/Owner.php