Stud.IP  6.0
Range Interface Reference
Inheritance diagram for Range:
Course Institute User

Public Member Functions

 describeRange ()
 
 getRangeType ()
 
 getRangeId ()
 
 getFullName ($format='default')
 
 getConfiguration ()
 
 isAccessibleToUser ($user_id=null)
 
 isEditableByUser ($user_id=null)
 
 __toString ()
 

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

◆ __toString()

__toString ( )
Returns
string A string representation of the Range instance.

Implemented in User, Course, and Institute.

◆ describeRange()

describeRange ( )

Returns a descriptive text for the range type.

Returns
string

Implemented in User, Course, and Institute.

◆ getConfiguration()

getConfiguration ( )

Returns the configuration object for this range.

Returns
RangeConfig

Implemented in User, Course, and Institute.

◆ getFullName()

getFullName (   $format = 'default')

Returns the full name of the range (in given format).

Parameters
string$format
Returns
string

Implemented in Course, User, and Institute.

◆ getRangeId()

getRangeId ( )

Returns the id of the current range

Returns
mixed (string|int)

Implemented in User, Course, and Institute.

◆ getRangeType()

getRangeType ( )

Returns a unique identificator for the range type.

Returns
string

Implemented in User, Course, and Institute.

◆ isAccessibleToUser()

isAccessibleToUser (   $user_id = null)

Decides whether the user may access the range.

Parameters
string | null$user_idOptional id of a user, defaults to current user
Returns
bool

Implemented in User, Course, and Institute.

◆ isEditableByUser()

isEditableByUser (   $user_id = null)

Decides whether the user may edit/alter the range.

Parameters
string | null$user_idOptional 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: