Huygens Remote Manager
  • Namespace
  • Class
  • Tree
  • Todo

Namespaces

  • hrm
    • job
    • param
      • base
    • setting
      • base
    • shell
    • stats
    • user
      • proxy

Classes

  • DatabaseConnection
  • Fileserver
  • FileserverV2
  • HuygensTemplate
  • HuygensTools
  • Log
  • Mail
  • Nav
  • OmeroConnection
  • QueueManager
  • System
  • Util
  • UtilV2
  • Validator

Functions

  • fileButton

Class Nav

Commodity class to manage all links and actions of the navigation bar.

All items are enclosed in

  • tags.

  • Namespace: hrm
    Package: hrm
    Located at Nav.php

    Methods summary

    public static string
    # linkWikiPage( string $pageName )

    Generate HTML code to link to a specific page in the SVI wiki.

    Generate HTML code to link to a specific page in the SVI wiki.

    Parameters

    $pageName
    The title of the page in the SVI wiki.

    Returns

    string
    HTML code to link to the requested wiki page.
    public static string
    # linkProjectWebsite( )

    Generate HTML code to link to the HRM project website.

    Generate HTML code to link to the HRM project website.

    Returns

    string
    HTML code to link to the HRM project website.
    public static string
    # linkMailingList( )

    Generate HTML code to link to the HRM mailing list page.

    Generate HTML code to link to the HRM mailing list page.

    Returns

    string
    HTML code to link to the HRM mailing list page.
    public static string
    # linkSVIWiki( )

    Generate HTML code to link to the SVI wiki.

    Generate HTML code to link to the SVI wiki.

    Returns

    string
    HTML code to link to the SVI wiki.
    public static string
    # linkManual( )

    Generate HTML code to link to the HRM manual.

    Generate HTML code to link to the HRM manual.

    Returns

    string
    HTML code to link to the HRM manual.
    public static string
    # linkReportIssue( )

    Generate HTML code to link to the report issue page.

    Generate HTML code to link to the report issue page.

    Returns

    string
    HTML code to link to the report issue page.
    public static string
    # linkWhatsNew( )

    Generate HTML code to link to the What's New? page.

    Generate HTML code to link to the What's New? page.

    Returns

    string
    HTML code to link to the What's new?.
    public static string
    # linkRawImages( )

    Generate HTML code to link to the raw images page.

    Generate HTML code to link to the raw images page.

    Returns

    string
    HTML code to link to the raw images page.
    public static string
    # linkResults( )

    Generate HTML code to link to the results page.

    Generate HTML code to link to the results page.

    Returns

    string
    HTML code to link to the results page.
    public static string
    # linkHome( string $currentPage )

    Generate HTML code to link to the home page.

    Generate HTML code to link to the home page.

    This function requires the URL of the current page. You can use the Util::getThisPageName() to get it.

    Parameters

    $currentPage
    URL of the current page.

    Returns

    string
    HTML code to link to the home page.
    public static string
    # linkLogOut( string $currentPage )

    Generate HTML code to the logout link.

    Generate HTML code to the logout link.

    This function requires the URL of the current page. You can use the Util::getThisPageName() to get it.

    Parameters

    $currentPage
    URL of the current page.

    Returns

    string
    HTML code to the logout link.
    public static string
    # linkJobQueue( )

    Generate HTML code to link to the job queue page.

    Generate HTML code to link to the job queue page.

    Returns

    string
    HTML code to link to the job queue page.
    public static string
    # textUser( string $userName )

    Generate HTML code to display the user name.

    Generate HTML code to display the user name.

    Parameters

    $userName
    User name.

    Returns

    string
    HTML code to display the user name.
    public static string
    # linkBack( string $toURL )

    Generate HTML code to link back to a specified page.

    Generate HTML code to link back to a specified page.

    Parameters

    $toURL
    URL to the page to go back to.

    Returns

    string
    HTML code to link to the requested page.
    public static string
    # exitToLogin( )

    Generate HTML code to link back (exit) to the login page.

    Generate HTML code to link back (exit) to the login page.

    Returns

    string
    HTML code to link back to the login page.
    public static string
    # actionCheckForUpdates( )

    Generate HTML code to trigger the check for updates action.

    Generate HTML code to trigger the check for updates action.

    Returns

    string
    HTML code to trigger the check for updates action.
    Huygens Remote Manager API documentation generated by ApiGen