ePages 7.28.0 - DE_EPAGES/Shop/API/ShopUriBuilder.pm

Package DE_EPAGES::Shop::API::ShopUriBuilder

provides functionallity to generate uris on a shop basis.

Functions

buildPrivateUri
buildUri
new

buildPrivateUri

generates a Private Uri for the builders specific shop using the passed resource path and replacing all key/value pairs from the input parameters.

Syntax
buildPrivateUri( $PathTemplate, $hPathParams, $hQueryParams );
Input
$PathTemplate (string)
resource path, may contain path variables
$hPathParams (refhash)
paramaters to replace in the resource path
$hQueryParams (refhash)
paramaters to add query parameters to url (optional)
Return
(string)
Full path uri

buildUri

generates a Public Uri for the builders specific shop using the passed resource path and replacing all key/value pairs from the input parameters.

Syntax
buildUri( $PathTemplate, $hPathParams, $hQueryParams );
Input
$PathTemplate (string)
resource path, may contain path variables
$hPathParams (refhash)
paramaters to replace in the resource path
$hQueryParams (refhash)
paramaters to add query parameters to url (optional)
Return
(string)
Full path uri

new

Creates a ShopUriBuilder.

Syntax
my $ShopUriBuilder = ShopUriBuilder->new( $ShopOrObject );
Input
$Object (string)
a shop or a object refering to a shop
Return
(DE_EPAGES::Shop::API::ShopUriBuilder)
ShopUriBuilder instance