HubCheckoutHelper
in package
Class HubCheckoutHelper
Table of Contents
- createHubTransactionsApiClient() : HubTransactionsApiClient
- Creates a HubTransactionsApiClient instance.
- getCartContent() : CartContent
- Returns a CartContent instance based on the global 'order' information.
- getClientSessionInformation() : ClientSessionInformation
- Returns a ClientSessionInformation instance.
- getCustomer() : array<string|int, mixed>
- Get customer information from database.
- getCustomerInformation() : CustomerInformation
- Returns a CustomerInformation instance based on the global 'order' information.
- getHubClientInformation() : HubClientInformation
- Returns a HubClientInformation instance
- startSession() : bool|HubSessionsApiClient
- Creates a HubSessionsApiClient instance.
- getAttributesForPropertiesCombi() : array<string|int, mixed>
- Returns an array properties_name => values_name for a given combination ID and language.
- getCombiModel() : mixed|string
- Returns combi_model for a product variant identified by $combiId.
- getProductCategoryPath() : string
- Returns category path for a product w/ names in a specific language.
- getProductImageUrl() : string
- Returns URL for a product’s primary image.
- getProductsItemCodes() : array<string|int, mixed>
- Returns an array of product item codes; currently only code_mpn and brand_name.
- getProductUrl() : string
- Returns URL for product page.
Methods
createHubTransactionsApiClient()
Creates a HubTransactionsApiClient instance.
public
createHubTransactionsApiClient(HubSessionKey $sessionKey) : HubTransactionsApiClient
Parameters
- $sessionKey : HubSessionKey
-
Hub session key.
Return values
HubTransactionsApiClient —Created instance.
getCartContent()
Returns a CartContent instance based on the global 'order' information.
public
getCartContent(order $order) : CartContent
Parameters
- $order : order
-
Contains the order information.
Return values
CartContent —getClientSessionInformation()
Returns a ClientSessionInformation instance.
public
getClientSessionInformation(order $order) : ClientSessionInformation
Parameters
- $order : order
-
Contains the order information.
Return values
ClientSessionInformation —getCustomer()
Get customer information from database.
public
getCustomer(int $customerId) : array<string|int, mixed>
Parameters
- $customerId : int
-
The customer's row ID.
Return values
array<string|int, mixed> —Returns an array with the customer's data.
getCustomerInformation()
Returns a CustomerInformation instance based on the global 'order' information.
public
getCustomerInformation(order $order) : CustomerInformation
Parameters
- $order : order
-
Contains the order information.
Return values
CustomerInformation —getHubClientInformation()
Returns a HubClientInformation instance
public
getHubClientInformation() : HubClientInformation
Return values
HubClientInformation —startSession()
Creates a HubSessionsApiClient instance.
public
startSession(string $shopUrl, LanguageCode $languageCode) : bool|HubSessionsApiClient
Parameters
- $shopUrl : string
-
Shop url with trailing slash.
- $languageCode : LanguageCode
Return values
bool|HubSessionsApiClient —getAttributesForPropertiesCombi()
Returns an array properties_name => values_name for a given combination ID and language.
protected
getAttributesForPropertiesCombi(int $combiId, int $languageId) : array<string|int, mixed>
Parameters
- $combiId : int
- $languageId : int
Return values
array<string|int, mixed> —getCombiModel()
Returns combi_model for a product variant identified by $combiId.
protected
getCombiModel( $combiId) : mixed|string
Parameters
Return values
mixed|string —getProductCategoryPath()
Returns category path for a product w/ names in a specific language.
protected
getProductCategoryPath( $productId, $languageId) : string
Format is 'Category>Subcategory>Subsubcategory'.
Parameters
Return values
string —getProductImageUrl()
Returns URL for a product’s primary image.
protected
getProductImageUrl( $productId) : string
Parameters
Return values
string —getProductsItemCodes()
Returns an array of product item codes; currently only code_mpn and brand_name.
protected
getProductsItemCodes( $productId) : array<string|int, mixed>
Parameters
Return values
array<string|int, mixed> —getProductUrl()
Returns URL for product page.
protected
getProductUrl( $productId, $productName) : string
Uses SEOBoost if configured.