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 Panel

A panel in the eSales panel hierarchy.

Use Apptus\ESales\Connector\Panel::retrieveContent() to get the content of this panel and all its subpanels, recursively.

When executing panels, see the Panel library section in Apptus Zone (http://zone.apptus.com) for the arguments to each panel. When working with filters see Working with filters and the Apptus\ESales\Connector\FilterBuilder class. Also read the other articles in the Key concepts section for information about the other panel arguments.

Namespace: Apptus\ESales\Connector
Located at Connector/Panel.php
Methods summary
public Apptus\ESales\Connector\PanelContent
# retrieveContent( Apptus\ESales\Connector\ArgMap|array|null $arguments = null )

Retrieves the content of this panel from the eSales service.

Retrieves the content of this panel from the eSales service.

The panel is evaluated with the arguments supplied to this method. You may use an Apptus\ESales\Connector\ArgMap or a standard array with string keys and string values to pass the arguments.

Parameters

$arguments

map of arguments, where key is the parameter name, and value is the argument value. Arguments having null values are ignored.

Returns

Apptus\ESales\Connector\PanelContent
A PanelContent object holding the content of the panel.

Throws

Apptus\ESales\Connector\RequestFailedException
If there is an error communicating with the eSales service.
Apptus\ESales\Connector\ParseException
If the response cannot be parsed.
InvalidArgumentException
if arguments contains empty or reserved keys
public string
# retrieveContentAsXml( Apptus\ESales\Connector\ArgMap|array|null $arguments = null )

Retrieves the content of this panel from the eSales service as a string.

Retrieves the content of this panel from the eSales service as a string.

The panel is evaluated with the arguments supplied to this method. You may use an Apptus\ESales\Connector\ArgMap or a standard array with string keys and string values to pass the arguments.

Parameters

$arguments

map of arguments, where key is the parameter name, and value is the argument value. Arguments having null values are ignored.

Returns

string
A string containing the xml content of the panel.

Throws

InvalidArgumentException
If arguments contains empty or reserved keys.
Apptus\ESales\Connector\RequestFailedException
If there is an error communicating with the eSales service.
Apptus ESales Connector PHP API documentation generated by ApiGen