Scriptlog Documentation

This page is read only. You can view the source, but not change it. Ask your administrator if you think this is wrong.
====== public/themes/blog/functions-nav.php ======


**Source:** ''public/themes/blog/functions-nav.php'' &middot; 227 lines, ~1175 statements &middot; namespace: //(global)// &middot; `declare(strict_types=1)`: no

----

Blog Theme Navigation Helpers

Navigation and menu helpers for the Bootstrap Blog theme.
Extracted from the monolithic functions.php (Phase 5 remediation).
All functions use function_exists() guards to avoid redeclaration errors.

======= Functions (6) =======

^ Function ^ Line ^ Params ^ Returns ^ Summary ^
| ''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. |
| ''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. |
| ''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 |


======== request_path() ========

//Declared inside a guard (the project uses `if (!function_exists(...))` around global functions), so the declaration is conditional at load time.//

<code>
public function request_path()
</code>

request_path() - Get request path object


======== build_menu_tree() ========

//Declared inside a guard (the project uses `if (!function_exists(...))` around global functions), so the declaration is conditional at load time.//

<code>
public function build_menu_tree(array $items, array $parents, int $rootId = 0): array
</code>

build_menu_tree() - Build a recursive MenuViewModel tree from raw menu rows.

^  Parameter ^  Type ^  Default ^  Description ^
|  ''$items'' |  ''array'' |  //required// |   |
|  ''$parents'' |  ''array'' |  //required// |   |
|  ''$rootId'' |  ''int'' |  ''0'' |  Parent id whose children form the tree root |


======== render_menu_tree() ========

//Declared inside a guard (the project uses `if (!function_exists(...))` around global functions), so the declaration is conditional at load time.//

<code>
public function render_menu_tree(array $nodes): string
</code>

render_menu_tree() - Render a MenuViewModel tree to HTML.

^  Parameter ^  Type ^  Default ^  Description ^
|  ''$nodes'' |  ''array'' |  //required// |   |


======== front_navigation() ========

//Declared inside a guard (the project uses `if (!function_exists(...))` around global functions), so the declaration is conditional at load time.//

<code>
public function front_navigation($parent, $menu)
</code>

front_navigation() - Render navigation menu from a MenuViewModel tree.

^  Parameter ^  Type ^  Default ^  Description ^
|  ''$parent'' |  ''(untyped)'' |  //required// |  Root menu parent id (usually 0) |
|  ''$menu'' |  ''(untyped)'' |  //required// |   |


======== convert_menu_link() ========

//Declared inside a guard (the project uses `if (!function_exists(...))` around global functions), so the declaration is conditional at load time.//

<code>
public function convert_menu_link(string $link, bool $permalinkEnabled): string
</code>

convert_menu_link() - Convert menu link between URL formats

^  Parameter ^  Type ^  Default ^  Description ^
|  ''$link'' |  ''string'' |  //required// |   |
|  ''$permalinkEnabled'' |  ''bool'' |  //required// |   |


======== retrieve_site_url() ========

//Declared inside a guard (the project uses `if (!function_exists(...))` around global functions), so the declaration is conditional at load time.//

<code>
public function retrieve_site_url()
</code>

retrieve_site_url() - Get site URL from config


----

//Generated by 'tools/gendoc'.//