Package DE_EPAGES::Shop::API::Object::ShopObject
object interface for all shop objects.
Functions
- className
- getShopUrl
className
Returns the class name, used for DAL access.
Syntax |
$ClassName = $ShopObject->className;
|
Return |
- $ClassName (String)
- class name
|
getShopUrl
Construct the shop url of a given object dependend of the following parameters:
Syntax |
$ShopUrl = $Object->getShopUrl($hParams, $hOptions, $Servlet);
|
Input |
- $hParams (ref.hash)
- url get parameters; values may be strings or arrays of strings
- $hOptions (ref.hash)
- with following keys:
- Type - one of 'sf', 'admin', 'mobile', 'sf/mobile',
if type is 'sf/mobile' a .mobile will be generated if the servlet is defined and the client is a mobile device, otherwise a .sf url is generated; defaults to 'sf' - string
- UseSSL - use https as protocol if SSL enabled for shop / database (optional, defaults to 0) - boolean
- UseObjectPath - use object path rather than objectid (optional, defaults to 0) - boolean
- AddToken - add security token or not (optional, defaults to 0) - boolean
- Token - the security token (required AddToken is true) - String
- AddCookies - add cookies to url or not (optional, defaults to 0) - boolean
- Cookies - cookie values (required if AddCookies is true) - hash.ref
- NoUTF8 - do not use utf-8 for encoding get parameters (optional, defaults to 0) - boolean
- IsMobileServlet - is the client a mobile device or not - boolean
- $Shop (object)
- the current shop
|
Return |
- $url (string)
- the url
|