Scriptlog Docs

Scriptlog Documentation

Code reference for the Scriptlog codebase

User Tools

Site Tools


scriptlog:public:functions-nav

Differences

This shows you the differences between two versions of the page.

Link to this comparison view

scriptlog:public:functions-nav [2026/09/26 09:09] – admin adminscriptlog:public:functions-nav [2026/09/26 09:17] (current) – admin admin
Line 14: Line 14:
 ======= Functions (6) ======= ======= Functions (6) =======
  
-  ^ Function ^ Line ^ Params ^ Returns ^ Summary ^ +^ Function ^ Line ^ Params ^ Returns ^ Summary ^ 
-  | ''request_path'' | 20 | 0 |  | request_path() - Get request path object | +| ''request_path'' | 20 | 0 |  | request_path() - Get request path object | 
-  | ''build_menu_tree'' | 40 | 3 | ''array'' | build_menu_tree() - Build a recursive MenuViewModel tree from raw menu rows. | +| ''build_menu_tree'' | 40 | 3 | ''array'' | build_menu_tree() - Build a recursive MenuViewModel tree from raw menu rows. | 
-  | ''render_menu_tree'' | 72 | 1 | ''string'' | render_menu_tree() - Render a MenuViewModel tree to HTML. | +| ''render_menu_tree'' | 72 | 1 | ''string'' | render_menu_tree() - Render a MenuViewModel tree to HTML. | 
-  | ''front_navigation'' | 104 | 2 |  | front_navigation() - Render navigation menu from a MenuViewModel tree. | +| ''front_navigation'' | 104 | 2 |  | front_navigation() - Render navigation menu from a MenuViewModel tree. | 
-  | ''convert_menu_link'' | 136 | 2 | ''string'' | convert_menu_link() - Convert menu link between URL formats | +| ''convert_menu_link'' | 136 | 2 | ''string'' | convert_menu_link() - Convert menu link between URL formats | 
-  | ''retrieve_site_url'' | 221 | 0 |  | retrieve_site_url() - Get site URL from config |+| ''retrieve_site_url'' | 221 | 0 |  | retrieve_site_url() - Get site URL from config |
  
  
Line 44: Line 44:
 build_menu_tree() - Build a recursive MenuViewModel tree from raw menu rows. build_menu_tree() - Build a recursive MenuViewModel tree from raw menu rows.
  
-  ^ Parameter ^ Type ^ Default ^ Description ^ +^  Parameter ^  Type ^  Default ^  Description ^ 
-  | ''$items'' | ''array'' | //required// |  | +|  ''$items'' |  ''array'' |  //required// |   | 
-  | ''$parents'' | ''array'' | //required// |  | +|  ''$parents'' |  ''array'' |  //required// |   | 
-  | ''$rootId'' | ''int'' | ''0'' | Parent id whose children form the tree root |+|  ''$rootId'' |  ''int'' |  ''0'' |  Parent id whose children form the tree root |
  
  
Line 60: Line 60:
 render_menu_tree() - Render a MenuViewModel tree to HTML. render_menu_tree() - Render a MenuViewModel tree to HTML.
  
-  ^ Parameter ^ Type ^ Default ^ Description ^ +^  Parameter ^  Type ^  Default ^  Description ^ 
-  | ''$nodes'' | ''array'' | //required// |  |+|  ''$nodes'' |  ''array'' |  //required// |   |
  
  
Line 74: Line 74:
 front_navigation() - Render navigation menu from a MenuViewModel tree. front_navigation() - Render navigation menu from a MenuViewModel tree.
  
-  ^ Parameter ^ Type ^ Default ^ Description ^ +^  Parameter ^  Type ^  Default ^  Description ^ 
-  | ''$parent'' | ''(untyped)'' | //required// | Root menu parent id (usually 0) | +|  ''$parent'' |  ''(untyped)'' |  //required// |  Root menu parent id (usually 0) | 
-  | ''$menu'' | ''(untyped)'' | //required// |  |+|  ''$menu'' |  ''(untyped)'' |  //required// |   |
  
  
Line 89: Line 89:
 convert_menu_link() - Convert menu link between URL formats convert_menu_link() - Convert menu link between URL formats
  
-  ^ Parameter ^ Type ^ Default ^ Description ^ +^  Parameter ^  Type ^  Default ^  Description ^ 
-  | ''$link'' | ''string'' | //required// |  | +|  ''$link'' |  ''string'' |  //required// |   | 
-  | ''$permalinkEnabled'' | ''bool'' | //required// |  |+|  ''$permalinkEnabled'' |  ''bool'' |  //required// |   |
  
  
scriptlog/public/functions-nav.txt · Last modified: by admin