Public Member Functions | |
| getId () | |
| 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.
Member Function Documentation
◆ getId()
| getId | ( | ) |
Returns the ID of this range.
- Returns
- string|integer The ID of the range.
◆ getRangeCourseId()
| getRangeCourseId | ( | ) |
Returns the course id of FeedbackRange object instance
- Returns
- string course_id
Implemented in Course, StructuralElement, Folder, FileRef, and Unit.
◆ getRangeIcon()
| getRangeIcon | ( | $role | ) |
Returns the icon object that shall be used with the FeedbackRange object instance.
- Parameters
-
string $role role of icon
- Returns
- Icon icon for the FeedbackRange object instance.
Implemented in Course, StructuralElement, Folder, FileRef, and Unit.
◆ getRangeName()
| 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, StructuralElement, Folder, FileRef, and Unit.
◆ getRangeUrl()
| 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, StructuralElement, Folder, FileRef, and Unit.
◆ isRangeAccessible()
| isRangeAccessible | ( | string | $user_id = null | ) |
Returns the accessebility of FeedbackRange object instance for current active user
- Parameters
-
string $user_id optional; use this ID instead of $GLOBALS['user']->id
- Returns
- bool range object accessebility
Implemented in Course, StructuralElement, Folder, FileRef, and Unit.
The documentation for this interface was generated from the following file:
- lib/classes/FeedbackRange.php
