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 CloudConnector

Connector for Apptus eSales when hosted in the cloud.

This class acts as a facade to the connector library. All requests to the eSales service are initiated by method calls to a CloudConnector object, or an object obtained via the CloudConnector.

Apptus\ESales\Connector\Connector
Extended by Apptus\ESales\Connector\CloudConnector
Namespace: Apptus\ESales\Connector
Located at Connector/CloudConnector.php
Methods summary
public Apptus\ESales\Connector\CloudConnector
# __construct( string $uriString, Apptus\Util\Cache\StateCache $stateCache = null )

Creates a connector for the given eSales cluster URI.

Creates a connector for the given eSales cluster URI.

The URI should be on the following format:

esales://username:password[?parameter1=value1[&parameter2=value2[&...]]]

Example: esales://john:fjQ947Haq9jnFh?query_timeout=3500&notification_timeout=3500

Unspecified port defaults to 443.

The available parameters are:

  • connection_timeout - the connection timeout in milliseconds, default 2000
  • query_timeout - the query timeout in milliseconds, default 3000
  • export_timeout - the export timeout in milliseconds, default 60000
  • import_timeout - the import timeout in milliseconds, default 600000
  • notification_timeout - the notification timeout in milliseconds, default 3000
  • health_check_timeout - the health check timeout in milliseconds, default 500
  • compression_mode - what compression should be used when sending imports. Available settings:
    • none - No compression.
    • gzip - Compress with GZIP. This is the default.
    • pre_compressed_gzip - Send headers to indicate the import is compressed with GZIP, but don't do any compression. Use this if the file or InputStream you supply is already compressed.
    Note that files with names that end with ".gz" or ".gzip" will behave as if compression_mode=pre_compressed_gzip, regardless of what compression_mode is actually set to.

Parameter values must be URL encoded in order to avoid ambiguity.

Parameters

$uriString
base URI to an eSales cluster.
$stateCache

instance of an object implementing the Apptus\Util\Cache\StateCache interface. Defaults to an SQLite3StateCache using the file 'esales.statecache' in the current working directory.

Returns

Apptus\ESales\Connector\CloudConnector
A connector instance.

Throws

Apptus\ESales\Connector\MalformedURLException
If the URI contains errors.
Methods inherited from Apptus\ESales\Connector\Connector
availableMarkets(), checkCustomerDataJobStatus(), createExportCustomerDataJob(), createRemoveCustomerDataJob(), downloadExportCustomerDataJobResult(), downloadExportCustomerDataJobResultToDestination(), exportAds(), exportConfiguration(), exportPanels(), exportProducts(), exportSynonyms(), getVersion(), importAds(), importConfiguration(), importPanels(), importProducts(), importSynonyms(), latestNotifications(), reporter(), reporterForUnknownMarket(), serverLog(), serverLogNames(), session(), status()
Apptus ESales Connector PHP API documentation generated by ApiGen