pm_Pathbar::set Method

Rewrites parameters of the pathbar GUI element at drill-down or drill-up in the hierarchy of pages.

Syntax

Parameters

url

      A string value that holds URL of the page being displayed. Is set to NULL by default.

name

      A string value that holds the localization key associated with the page title to be displayed. The format of the key is 'pb_<php_file_name_no_extension>'. Is set to NULL by default.

in_context

      A string value that holds the passed in context of the page. Is set to NULL by default (will be read from the global scope).

return_conhelp

      A string value that holds the context help localization key for the current page. The format of the key is 'to_<php_file_name_no_extension>'. Is set to NULL by default.

page

      A string value that holds the name of the PHP script file (without extension) set in the action parameter of the page being displayed. Is set to NULL by default.

top_page

      A string value that holds the top-level page to be displayed in the pathbar GUI element. Should be specified at drill-down. Is set to NULL by default.

Returns

A boolean value which is always true after the pathbar parameters are set anew.

Remarks

The in_context parameter can be used if it is necessary to pass the required session context (a string that specifies the section of the navigation pane of Plesk Control panel from which the navigation is started, e.g. 'clients', 'domains', etc.). If left equal to NULL, the in_context parameter indicates than the session context should be read from the global scope.

The collection of bookmarks stored in the 'pathbar' array is either added with a new item or truncated, depending on the direction one moves through the hierarchy of pages.