Class Session
A session where information is exchanged with an eSales service.
Use the notification methods to notify the eSales service about client-side activities. These notification will be used to
improve results from eSales with the use of machine learning algorithms, and for statistical reports.
A tutorial section describing the procedure for notifying client-side activities can be found in the tutorial section
Notifying Customer Actions on Apptus Zone (http://zone.apptus.com).
Use the Session::panel() method to get a Apptus\ESales\Connector\Panel
object, from which you may retrieve content from the eSales service.
You may (but need not) call the Session::end() method once the session is over. This will allow the eSales service to include the information in statistical reports.
The session will end automatically when neither a panel has been retrieved, nor a notifications has been sent, within 15 minutes.
public
|
|
public
|
|
public
|
|
public
|
#
notifyProperty( string $name, string $value )
Sends a notification to the eSales service, about a session property being set. |
public
|
#
notifyClick( string $ticket )
Sends a notification to the eSales service, about a click being made by the user in a session. |
public
|
#
notifyAddingToCart( string $ticket )
Sends a notification to the eSales service, about a product being added to the shopping cart by a user in the session. |
public
|
#
notifyNonEsalesClick( string $productKey, string $variantKey )
Sends a notification to the eSales service, about a non-eSales product click being made by the user in a session. This method should only be used on non-eSales rendered products where no ticket is available. |
public
|
#
notifyNonEsalesAddingToCart( string $productKey, string $variantKey )
Sends a notification to the eSales service, about a non-eSales product being added to the shopping cart by a user in the session. This method should only be used on non-eSales rendered products where no ticket is available. |
public
|
#
notifyPayment(
Sends a notification to the eSales service, about products and variants being paid by a user in the session. |
public
|
#
notifyRating( string $productKey, integer $rating )
Sends a notification to the eSales service, about a product being rated. |
public
boolean
|
|
public
|
#
notifyFavoriteAddition( string $productKey, string $variantKey )
Sends a notification to the eSales service, about a product being added to favorites. |
public
|
#
notifyFavoriteRemoval( string $productKey, string $variantKey )
Sends a notification to the eSales service, about a product being removed from favorites. |
final public
string
|
|
final public
string
|
|
final public
string
|
string |
CUSTOMER_KEY_HEADER_NAME
|
#
'eSales-customer_key'
|
string |
MARKET_HEADER_NAME
|
#
'eSales-market'
|
string |
PROPERTY_MARKET
|
#
'market'
|
string |
PROPERTY_CUSTOMER_KEY
|
#
'customer_key'
|