Range Interface Reference

Inheritance diagram for Range:

Collaboration diagram for Range:

Public Member Functions
	describeRange ()
	getRangeType ()
	getRangeId ()
	userMayAccessRange ($user_id=null)
	userMayEditRange ($user_id=null)
	userMayAdministerRange ($user_id=null)

Detailed Description

Generic range interface. Ranges may be a lot of things in Stud.IP.

Author

Jan-Hendrik Willms tleil.nosp@m.ax+s.nosp@m.tudip.nosp@m.@gma.nosp@m.il.co.nosp@m.m GPL2 or any later version

Member Function Documentation

describeRange()

describeRange

(

)

Returns a descriptive text for the range type.

Returns

string

Implemented in User, Course, and Institute.

getRangeId()

getRangeId

(

)

Returns the id of the current range

Returns

mixed (string|int)

Implemented in User, Course, and Institute.

Here is the caller graph for this function:

getRangeType()

getRangeType

(

)

Returns a unique identificator for the range type.

Returns

string

Implemented in User, Course, and Institute.

Here is the caller graph for this function:

userMayAccessRange()

userMayAccessRange

(

$user_id = null

)

Decides whether the user may access the range.

Parameters

string

$user_id

Optional id of a user, defaults to current user

Returns

bool

Implemented in User, Course, and Institute.

userMayAdministerRange()

userMayAdministerRange

(

$user_id = null

)

Decides whether the user may administer the range.

Parameters

string

$user_id

Optional id of a user, defaults to current user

Returns

bool

Implemented in User, Course, and Institute.

userMayEditRange()

userMayEditRange

(

$user_id = null

)

Decides whether the user may edit/alter the range.

Parameters

string

$user_id

Optional id of a user, defaults to current user

Returns

bool

Implemented in User, Course, and Institute.

---

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

• lib/classes/Range.interface.php