Overview

Namespaces

  • Apptus
    • ESales
      • Connector
        • Report
        • Time
    • Util
      • Cache
  • PHP

Classes

  • Ad
  • Ads
  • ArgMap
  • Attribute
  • AttributeValidation
  • Authorization
  • Category
  • CategoryData
  • CategoryList
  • CategoryNode
  • CloudConnector
  • ClusterUriIterator
  • Completion
  • Completions
  • CompressionMode
  • Connector
  • ConnectorSettingsBuilder
  • Correction
  • Corrections
  • Count
  • CssClass
  • CustomerKeyAuthentication
  • DynamicPage
  • EventDataJobResult
  • FacetList
  • FacetRange
  • Facets
  • Filter
  • FilterBuilder
  • ImportData
  • JavaScriptNotifier
  • MessageAuthentication
  • OnPremConnector
  • Order
  • OrderLine
  • Panel
  • PanelContent
  • Path
  • Phrase
  • Phrases
  • Product
  • Products
  • Reporter
  • ResultType
  • Session
  • Status
  • Subpanel
  • Value
  • Values
  • Variant

Interfaces

  • Facet
  • Result

Exceptions

  • BusyClusterException
  • ClusterUnavailableException
  • DuplicateSubpanelException
  • FetchClusterException
  • IOException
  • MalformedJsonException
  • MalformedURLException
  • MissingSubpanelException
  • PanelException
  • ParseException
  • ReportException
  • RequestFailedException
  • ResultTypeException
  • Overview
  • Namespace
  • Class
  • Tree

Class JavaScriptNotifier

Namespace: Apptus\ESales\Connector
Located at Connector/JavaScriptNotifier.php
Methods summary
public static
# notify( Apptus\ESales\Connector\Connector $connector, string $sessionKey, string $id, string $type, string $ticket, string $propertyName, string $propertyValue, string $productKey, string $rating )

Pass through a JavaScript notification to the cluster.

Pass through a JavaScript notification to the cluster.

This method is for advanced users only. If two identical notifications are sent with the same id for the same session key, the second notification will be ignored.

Deprecated

This method is deprecated due to severe security issues. It is strongly recommended not to allow client side property notifications, these should be made server side. Use Apptus\ESales\Connector\JavaScriptNotifier::notifySafe() for the other types of notifications.


Parameters

$connector
eSales connector to notify through.
$sessionKey
key of the eSales session to attach the notification to.
$id
for detection of re-sent notifications.
$type
click|adding_to_cart|property|rating|end
$ticket
ticket for the object clicked or added to cart.
$propertyName
valid Java identifier as name of the property.
$propertyValue
value of the property.
$productKey
key of the rated product.
$rating
rating as a string.

Throws

Apptus\ESales\Connector\RequestFailedException
if the notification cannot be sent to the eSales service.
public static
# notifySafe( Apptus\ESales\Connector\Connector $connector, string $sessionKey, string $id, string $type, string $ticket, string $productKey, string $rating )

Pass through a JavaScript notification to the cluster.

Pass through a JavaScript notification to the cluster.

This method is for advanced users only. If two identical notifications are sent with the same id for the same session key, the second notification will be ignored.

Parameters

$connector
eSales connector to notify through.
$sessionKey
key of the eSales session to attach the notification to.
$id
for detection of re-sent notifications.
$type
click|adding_to_cart|rating|end
$ticket
ticket for the object clicked or added to cart.
$productKey
key of the rated product.
$rating
rating as a string.

Throws

Apptus\ESales\Connector\RequestFailedException
if the notification cannot be sent to the eSales service.
public static
# notifyWithProperties( Apptus\ESales\Connector\Connector $connector, string $sessionKey, string $customerKey, string $market, string $id, string $type, string $ticket, string $productKey, string $rating )

Pass through a JavaScript notification to the cluster.

Pass through a JavaScript notification to the cluster.

This method is for advanced users only. If two identical notifications are sent with the same id for the same session key, the second notification will be ignored.

Parameters

$connector
eSales connector to notify through.
$sessionKey
key of the eSales session to attach the notification to.
$customerKey

key of the customer for the notification. Warning! Must not be taken from the client, as this will pose a security threat.

$market

market for which the notification is made. Warning! Must not be taken from the client, as this will pose a security threat.

$id
for detection of re-sent notifications.
$type
click|adding_to_cart|property|rating|end
$ticket
ticket for the object clicked or added to cart.
$productKey
key of the rated product.
$rating
rating as a string.

Throws

Apptus\ESales\Connector\RequestFailedException

if the notification cannot be sent to the eSales service.

Warning! It is strongly recommended not to allow client side property notifications, these should be made from the server.

Constants summary
string CUSTOMER_KEY_HEADER_NAME
# 'eSales-customer_key'
string MARKET_HEADER_NAME
# 'eSales-market'
Apptus ESales Connector PHP API documentation generated by ApiGen