Navigation
in package
Implement navigation entry object
This class provides general interfaces to handle navigation item renderings.
Tags
Table of Contents
- $_end_depth : mixed
- $_entries : mixed
- $_filter : mixed
- $_hide_empty : mixed
- $_is_root_based : mixed
- $_items_written : mixed
- $_match : mixed
- $_open_levels : mixed
- $_request : mixed
- $_root_folder : mixed
- $_show_root : mixed
- $_start_depth : mixed
- $_url : mixed
- __construct() : mixed
- Navigation block constructor.
- EndDepth() : int
- Entries() : array<string|int, NavigationEntry>
- Filter() : array<string|int, mixed>|string|null
- HideEmpty() : bool
- Hide empty set
- IsRootBased() : bool
- ItemsWritten() : int
- ItemWritten() : void
- OpenLevels() : array<string|int, mixed>
- RootFolderPath() : string
- Fetch the root folder path
- ShowRoot() : bool
- StartDepth() : int
- Url() : array<string|int, mixed>|string|null
Properties
$_end_depth
private
mixed
$_end_depth
= -1
$_entries
private
mixed
$_entries
= array()
$_filter
private
mixed
$_filter
= null
$_hide_empty
private
mixed
$_hide_empty
= false
$_is_root_based
private
mixed
$_is_root_based
= false
$_items_written
private
mixed
$_items_written
= 0
$_match
private
mixed
$_match
$_open_levels
private
mixed
$_open_levels
= array()
$_request
private
mixed
$_request
$_root_folder
private
mixed
$_root_folder
= null
$_show_root
private
mixed
$_show_root
= false
$_start_depth
private
mixed
$_start_depth
= 0
$_url
private
mixed
$_url
= array()
Methods
__construct()
Navigation block constructor.
public
__construct(string $match, Request $request) : mixed
Parameters
- $match : string
-
The html to parse result
- $request : Request
-
The system http request
Return values
mixed —EndDepth()
public
EndDepth() : int
Return values
int —Entries()
public
Entries() : array<string|int, NavigationEntry>
Return values
array<string|int, NavigationEntry> —Filter()
public
Filter() : array<string|int, mixed>|string|null
Return values
array<string|int, mixed>|string|null —HideEmpty()
Hide empty set
public
HideEmpty() : bool
Hide whole navigation block with wrapper when no element was found to display
Return values
bool —IsRootBased()
public
IsRootBased() : bool
Return values
bool —ItemsWritten()
public
ItemsWritten() : int
Return values
int —ItemWritten()
public
ItemWritten() : void
Return values
void —OpenLevels()
public
OpenLevels() : array<string|int, mixed>
Return values
array<string|int, mixed> —RootFolderPath()
Fetch the root folder path
public
RootFolderPath() : string
Return values
string —ShowRoot()
public
ShowRoot() : bool
Return values
bool —StartDepth()
public
StartDepth() : int
Return values
int —Url()
public
Url([mixed $index = -1 ]) : array<string|int, mixed>|string|null
Parameters
- $index : mixed = -1