Stud.IP  4.0
 All Data Structures Namespaces Files Functions Variables Groups
FeedbackRange Interface Reference
Inheritance diagram for FeedbackRange:
Course FileRef Folder

Public Member Functions

 getRangeName ()
 
 getRangeIcon ($role)
 
 getRangeUrl ()
 
 getRangeCourseId ()
 
 isRangeAccessible (string $user_id=null)
 

Detailed Description

Interface FeedbackRange

The FeedbackRange defines methods for range objects that can reveive feedback.

Author
Nils Gehrke nils..nosp@m.gehr.nosp@m.ke@un.nosp@m.i-go.nosp@m.ettin.nosp@m.gen..nosp@m.de

Member Function Documentation

getRangeCourseId ( )

Returns the course id of FeedbackRange object instance

Returns
string course_id

Implemented in Course, Folder, and FileRef.

getRangeIcon (   $role)

Returns the icon object that shall be used with the FeedbackRange object instance.

Parameters
string$rolerole of icon
Returns
Icon icon for the FeedbackRange object instance.

Implemented in Course, Folder, and FileRef.

getRangeName ( )

Returns a human-friendly representation of the FeedbackRange object instance's name.

Returns
string A human-friendly name for the FeedbackRange object instance.

Implemented in Course, Folder, and FileRef.

getRangeUrl ( )

Returns the URL of FeedbackRange view, where the object instance is visible together with the related feedback element(s).

Returns
string Path that is usable with the url_for and link_for methods.

Implemented in Course, Folder, and FileRef.

isRangeAccessible ( string  $user_id = null)

Returns the accessebility of FeedbackRange object instance for current active user

Parameters
string$user_idoptional; use this ID instead of $GLOBALS['user']->id
Returns
bool range object accessebility

Implemented in Course, Folder, and FileRef.


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