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

Package DE_EPAGES::Shop::API::ShopUriBuilder

provides functionallity to generate uris on a shop basis.

Functions

buildEndpointUri
buildUri
new

buildEndpointUri

generates a endpoint format uri with the format /rs/shops/{shopid}/$Path. 'shopid' can't be used in $hPathParams, because it is replaced in this method.

Syntax
buildEndpointUri( $Path, $hPathParams );
Input
$PathTemplate (string)
resource path
$hPathParams (optional) (refhash)
paramaters to replace in the resource path
Return
(string)
Full path uri

buildUri

generates a 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 );
Input
$PathTemplate (string)
resource path, may contain path variables
$hPathParams (refhash)
paramaters to replace in the resource path
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