DirectHelpManualPageLinkFactory
in package
Class representing the online manual page link factory
Table of Contents
- $mappingStorage : DirectHelpManualMappingFileStorage
- Online manual page link mapping storage
- $shopVersion : string
- Current shop version
- __construct() : mixed
- Create instance
- linkByOrigin() : string
- Return the appropriate online manual page URL based on the origin provided
- linkBySearchTerm() : string
- Return the online manual search page URL with the provided search term
- linkToRootPage() : string
- Return the online manual root page URL
- baseFromUrl() : string
- Return the basename, fragment and parameters from an URL
- linkToManual() : string
- Return the final URL to the appropriate manual page
Properties
$mappingStorage
Online manual page link mapping storage
protected
DirectHelpManualMappingFileStorage
$mappingStorage
$shopVersion
Current shop version
protected
string
$shopVersion
Methods
__construct()
Create instance
public
__construct(DirectHelpManualMappingFileStorage $mappingStorage, NonEmptyStringType $shopVersion) : mixed
Parameters
- $mappingStorage : DirectHelpManualMappingFileStorage
-
Mapping file storage
- $shopVersion : NonEmptyStringType
-
Shop version
Return values
mixed —linkByOrigin()
Return the appropriate online manual page URL based on the origin provided
public
linkByOrigin(NonEmptyStringType $origin) : string
Parameters
- $origin : NonEmptyStringType
-
Origin URL
Return values
string —linkBySearchTerm()
Return the online manual search page URL with the provided search term
public
linkBySearchTerm(NonEmptyStringType $term) : string
Parameters
- $term : NonEmptyStringType
-
Search term
Return values
string —linkToRootPage()
Return the online manual root page URL
public
linkToRootPage() : string
Return values
string —baseFromUrl()
Return the basename, fragment and parameters from an URL
protected
baseFromUrl(StringType $url) : string
Parameters
- $url : StringType
-
URL
Return values
string —linkToManual()
Return the final URL to the appropriate manual page
protected
linkToManual([string $search = '' ][, string $origin = '' ][, string $section = '' ]) : string
Parameters
- $search : string = ''
-
Search parameters
- $origin : string = ''
-
Origin parameter
- $section : string = ''
-
Manual section parameter