Public Member Functions | |
| __construct () | |
| initSubNavigation () | |
 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 () | |
Protected Member Functions | |
| getSearchOptionNavigation (?string $option_name=null) | |
| Protected Member Functions inherited from Navigation | |
| initSubNavigation () | |
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 Attributes inherited from Navigation | |
| $active | |
| $enabled | |
| $initialized = false | |
| $active_image | |
| $badgeNumber | |
| $badgeTimestamp | |
| $description | |
| $image | |
| $link_attributes = [] | |
| $params | |
| $subnav | |
| $title | |
| $url | |
| $render_as_button = false | |
Detailed Description
This navigation includes all search pages depending on the activated modules.
Constructor & Destructor Documentation
◆ __construct()
| __construct | ( | ) |
Initialize a new Navigation instance.
Member Function Documentation
◆ getSearchOptionNavigation()
|
protected |
Returns a new navigation object for the sidebar according to the name of the option. The option name is the key of an entry in the array with the navigation options.
The navigation options are configured in the global configuration as an array. For further details see documentation of entry COURSE_SEARCH_NAVIGATION_OPTIONS in global configuration.
This is an example with all possible options. Note that the "target" attribute has no meaning anymore and is only there for backwards compatibility with existing configurations. The target is now hardcoded to "sidebar".
{ // "courses", "semtree" and "rangetree" are the "old" search options. // The link text is fixed. "courses":{ "visible":true, // The target indicates where the link to this search option is // placed. Possible values are "sidebar" for a link in the sidebar // or "courses" to show a link (maybe with picture) below the // "course search". "target":"sidebar" }, "semtree":{ "visible":true, "target":"sidebar" }, "rangetree":{ "visible":false, "target":"sidebar" }, // New option to acivate the search for modules and the systematic // search in studycourses, field of study and degrees. "module":{ "visible":true, "target":"sidebar" }, // This option shows a direct link in the sidebar to an entry (level) // in the range tree. The link text is the name of the level. "fb3_hist":{ "visible":true, "target":"sidebar", "range_tree_id":"d1a07cf0c8057c664279214cc070b580" }, // The same for an entry in the sem tree. "grundstudium":{ "visible":true, "target":"sidebar", "sem_tree_id":"e1a07cf0c8057c664279214cc070b580" }, // This shows a link in the sidebar to the course search. The text is // availlable in two languages. "vvz":{ "visible":true, "target":"sidebar", "url":"dispatch.php/search/courses?level=f&option=vav", "title":{ "de_DE":"Veranstaltungsverzeichnis", "en_GB":"Course Catalogue" } }, // This option uses an url with search option and shows a link in the // sidebar to an entry in the range tree with all courses. "test":{ "visible":true, "target":"sidebar", "url":"dispatch.php/search/courses?start_item_id=d1a07cf0c8057c664279214cc070b580&cmd=show_sem_range_tree&item_id=d1a07cf0c8057c664279214cc070b580_withkids&level=ev", "title":{ "de_DE":"Historisches Institut", "en_GB":"Historical Institute" } }, // This option shows a link to the sem tree with picture below the // course search (target: courses). // This is the behaviour of Stud.IP < 4.2. "csemtree":{ "visible":true, "target":"courses", "url":"dispatch.php/search/courses?level=vv", "img":{ "filename":"directory-search.png", "attributes":{ "size":"260@100" } }, "title":{ "de_DE":"Suche im Vorlesungsverzeichnis", "en_GB":"Search course directory" } }, // This option shows a link to the range tree with picture below the // course search (target: courses). // This is the behaviour of Stud.IP < 4.2. "crangetree":{ "visible":true, "target":"courses", "url":"dispatch.php/search/courses?level=ev", "img":{ "filename":"institute-search.png", "attributes":{ "size":"260@100" } }, "title":{ "de_DE":"Suche in Einrichtungen", "en_GB":"Search institutes" } } }
- Parameters
-
string $option_name
- Returns
- Navigation|null
◆ initSubNavigation()
| initSubNavigation | ( | ) |
Initialize the subnavigation of this item. This method is called once before the first item is added or removed.
The documentation for this class was generated from the following file:
- lib/navigation/SearchNavigation.php
