CourseNavigation Class Reference
Inheritance diagram for CourseNavigation:
Public Member Functions | |
| __construct (Range $range) | |
| addToolNavigation ($plugin_id, array $navigations) | |
 Public Member Functions inherited from Navigation | |
| __construct ($title, $url=NULL, $params=NULL) | |
| initItem () | |
| getImage () | |
| getImageTag () | |
| getTitle () | |
| getDescription () | |
| getURL () | |
| getBadgeNumber () | |
| getBadgeTimestamp () | |
| hasBadgeNumber () | |
| isActive () | |
| isEnabled () | |
| isVisible ($needs_image=false) | |
| setActive ($active) | |
| setEnabled ($enabled) | |
| setImage (?\Icon $image) | |
| setActiveImage (?\Icon $image) | |
| setLinkAttributes ($attributes) | |
| getLinkAttributes () | |
| setTitle ($title) | |
| setDescription ($description) | |
| setURL ($url, $params=NULL) | |
| setBadgeNumber ($badgeNumber) | |
| setBadgeTimestamp ($badgeTimestamp) | |
| setRenderAsButton (bool $state=true) | |
| getRenderAsButton () | |
| activeSubNavigation () | |
| addSubNavigation ($name, Navigation $navigation) | |
| insertSubNavigation ($name, Navigation $navigation, $where) | |
| getSubNavigation () | |
| removeSubNavigation ($name) | |
| getIterator () | |
Additional Inherited Members | |
| Static Public Member Functions inherited from Navigation | |
| static | activateItem ($path) |
| static | addItem ($path, Navigation $navigation) |
| static | insertItem ($path, Navigation $navigation, $where) |
| static | removeItem ($path) |
| static | getItem ($path) |
| static | hasItem ($path) |
| static | setRootNavigation (Navigation $navigation) |
| Protected Member Functions inherited from Navigation | |
| initSubNavigation () | |
| Protected Attributes inherited from Navigation | |
| $active | |
| $enabled | |
| $initialized = false | |
| $active_image | |
| $badgeNumber | |
| $badgeTimestamp | |
| $description | |
| $image | |
| $link_attributes = [] | |
| $params | |
| $subnav | |
| $title | |
| $url | |
| $render_as_button = false | |
Constructor & Destructor Documentation
◆ __construct()
| __construct | ( | Range | $range | ) |
Initialize a new Navigation instance.
Member Function Documentation
◆ addToolNavigation()
| addToolNavigation | ( | $plugin_id, | |
| array | $navigations | ||
| ) |
Add an array of navigation items to the subnavigation of this object. The new items are inserted at the appropriate position for this tool according to the order defined in tools_activated.
- Parameters
-
int $plugin_id id of the module array $navigations navigation items to add
The documentation for this class was generated from the following file:
- lib/navigation/CourseNavigation.php
