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

Namespace Apptus\ESales\Connector

Namespaces summary
Apptus\ESales\Connector\Report
Apptus\ESales\Connector\Time
Classes summary
Ad Represents a single element in a result having the ad format.
Ads Represents a result having the ads format.
ArgMap

Convenience class for passing arguments to a panel request. Automaticly casts all keys and values to strings.

Attribute Representation of a product or variant attribute.
AttributeValidation Simple validation rules for eSales identifiers.
Authorization
Category A common abstraction for the CategoryNode and CategoryData classes.
CategoryData

A class representing a category that holds only attribute information. In addition to its parent class it also knows which tree it belongs to.

CategoryList Base class for results parsed from the replies from an eSales service.
CategoryNode

Represents a result having the category_tree format. A CategoryNode is part of a category tree and may, in addition to attributes, have a parent and/or subcategories. The tree can be traversed using for example CategoryNode.getSubcategories(), or utility methods such as CategoryNode.getSelectedSubcategory() and CategoryNode.findDescendant(key).

CloudConnector Connector for Apptus eSales when hosted in the cloud.
ClusterUriIterator
Completion Represents a single element in a result having the completions format.
Completions Represents a result having the completions format.
CompressionMode
Connector Abstract super class for Apptus\ESales\Connector\CloudConnector and Apptus\ESales\Connector\OnPremConnector.
ConnectorSettingsBuilder
Correction Represents a single element in a result having the corrections format.
Corrections Represents a result having the corrections format.
Count Represents a result having the count format.
CssClass Class used to generate the CSS classes that are required to use automatic notifications or site overlay for web pages.
CustomerKeyAuthentication A class that should be used for creating personal customer keys when using eSales Web-API.
DynamicPage

A dynamic page consists of a page name and a number of sub panels. Each sub panel must point to a public panel, already defined in the eSales panel hierarchy.

EventDataJobResult Used to represent the responses from customer data related methods (e.g. Connector::checkCustomerDataJobStatus()).
FacetList Represents a result having the FacetList format.
FacetRange Represents a result having the facet_range format.
Facets

Class for creating a facets argument, used for check-box navigation. It also has support for parsing and toggling facet values, so it can be used to keep track of selection changes.

Filter Represents a filter for a query.
FilterBuilder A set of static methods for building a filter.
ImportData
JavaScriptNotifier
MessageAuthentication A class that is used for signing messages.
OnPremConnector Connector for on-premise instances of Apptus eSales.
Order

A sale order from a customer session. Use Session.notifyPayment to notify eSales that an order has been paid by a customer in a session.

OrderLine An order line in a sale order.
Panel A panel in the eSales panel hierarchy.
PanelContent The content of a panel as retrieved from an eSales servie.
Path Convenience class for working with panel paths.
Phrase Represents a single element in a result having the phrases format.
Phrases Represents a result having the phrases format.
Product Represents a single element in a result having the products format.
Products Represents a result having the products format.
Reporter A Reporter fetches market-specific reports from an eSales cluster.
ResultType Result types.
Session A session where information is exchanged with an eSales service.
Status
Subpanel

A subpanel refers to a public panel, and can be provided to a dynamic page in order to retrieve content from several panels at once without having to predefine a zone.

Value Represents a single element in a result having the values format.
Values Represents a result having the values format.
Variant Represents a product variant.
Interfaces summary
Facet interface for FacetList items. Either FacetRange or Values
Result Base class for results parsed from the replies from an eSales service.
Exceptions summary
BusyClusterException
ClusterUnavailableException
DuplicateSubpanelException
FetchClusterException
IOException
MalformedJsonException
MalformedURLException
MissingSubpanelException
PanelException
ParseException
ReportException
RequestFailedException
ResultTypeException
Apptus ESales Connector PHP API documentation generated by ApiGen