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 PanelContent

The content of a panel as retrieved from an eSales servie.

This object contains all panel attributes for the panel, as defined in eSales Manager.

For zone panels, this object contains all subpanels returned by the eSales service.

For function panels, this object contains the Apptus\ESales\Connector\Result of evaluating the function in the eSales service.

An object of this class will never make new requests to the eSales service; it just holds the result of a request.

Namespace: Apptus\ESales\Connector
Located at Connector/PanelContent.php
Methods summary
public array
# attributes( )

Returns an array with panel attributes and their values.

Returns an array with panel attributes and their values.

Returns

array
An associative array from attribute name to attribute value.
public string|mixed
# getAttribute( string $name, mixed $default = null )

Return the value of a single attribute.

Return the value of a single attribute.

Parameters

$name
of the attribute to return.
$default
to return if the attribute does not exist. Defaults to null.

Returns

string|mixed
The attribute named $name, or $default if it does not exist.
public boolean
# hasResult( )

Returns true if this panel content contains a function result.

Returns true if this panel content contains a function result.

Returns

boolean
True if there is a result, false otherwise.
public Apptus\ESales\Connector\Result
# result( )

Returns the result of this panel.

Returns the result of this panel.

If this panel is not a function panel it returns null.

Returns

Apptus\ESales\Connector\Result
The result of a function panel.

Throws

Apptus\ESales\Connector\PanelException
If there was an error evaluating the function in the eSales service.
public boolean
# isZone( )

Returns true if this panel is a container, that is, it contains subpanels.

Returns true if this panel is a container, that is, it contains subpanels.

Returns

boolean
True if the panel contains subpanels, false otherwise.
public boolean
# hasSubpanel( string $relativePath )

Returns true if this zone contains a subpanel with the specified relative path.

Returns true if this zone contains a subpanel with the specified relative path.

Parameters

$relativePath
simple name of the subpanel

Returns

boolean
True if this panel contains the subpanel, false otherwise.
public Apptus\ESales\Connector\PanelContent
# subpanel( string $relativePath )

Returns a subpanel given its relative path. If the panel is not contained by this zone, then null is returned.

Returns a subpanel given its relative path. If the panel is not contained by this zone, then null is returned.

Parameters

$relativePath
relative path of the subpanel.

Returns

Apptus\ESales\Connector\PanelContent
A PanelContent object.
public array
# subpanels( )

Returns a list of all sub panels in this panel.

Returns a list of all sub panels in this panel.

Returns

array
A list of all sub panels in this panel.
public string
# path( )

Returns the complete path of this panel.

Returns the complete path of this panel.

Returns

string
The complete path of this panel.
public
# __toString( )
public string
# ticket( )

Returns the ticket of the panel.

Returns the ticket of the panel.

Returns

string
The ticket of the panel.
public Apptus\ESales\Connector\CategoryNode
# resultAsCategoryTree( )

Fetches the result as a CategoryNode object, representing the root of a (possibly partial) category tree. The tree can be traversed using for example CategoryNode::getSubcategories(), or utility methods such as CategoryNode::getSelectedSubcategory() and CategoryNode::findDescendant().

Fetches the result as a CategoryNode object, representing the root of a (possibly partial) category tree. The tree can be traversed using for example CategoryNode::getSubcategories(), or utility methods such as CategoryNode::getSelectedSubcategory() and CategoryNode::findDescendant().

Returns

Apptus\ESales\Connector\CategoryNode
The root node of a category tree as a CategoryNode object

Throws

Apptus\ESales\Connector\ResultTypeException
If the result is not of category_tree format
Apptus\ESales\Connector\PanelException
If there was an error evaluating the function in the eSales service
public array
# resultAsCategoryList( )

Fetches the result as an array of CategoryData objects. These objects do not have links to any subcategories or parent.

Fetches the result as an array of CategoryData objects. These objects do not have links to any subcategories or parent.

Returns

array
The result as an array of CategoryData objects

Throws

Apptus\ESales\Connector\ResultTypeException
if the result is not of the category list type
Apptus\ESales\Connector\PanelException
If there was an error evaluating the function in the eSales service.
public Apptus\ESales\Connector\Corrections
# resultAsCorrections( )

Fetches the result as Corrections.

Fetches the result as Corrections.

Returns

Apptus\ESales\Connector\Corrections
The result as Corrections.

Throws

Apptus\ESales\Connector\ResultTypeException
If the result is not of type Corrections.
Apptus\ESales\Connector\PanelException
If there was an error evaluating the function in the eSales service.
public Apptus\ESales\Connector\Completions
# resultAsCompletions( )

Fetches the result as Completions

Fetches the result as Completions

Returns

Apptus\ESales\Connector\Completions
The result as Completions

Throws

Apptus\ESales\Connector\ResultTypeException
If the result is not of type Completions.
Apptus\ESales\Connector\PanelException
If there was an error evaluating the function in the eSales service.
public Apptus\ESales\Connector\Count
# resultAsCount( )

Fetches the result as Count.

Fetches the result as Count.

Returns

Apptus\ESales\Connector\Count
The result as Count.

Throws

Apptus\ESales\Connector\ResultTypeException
If the result is not of type Count.
Apptus\ESales\Connector\PanelException
If there was an error evaluating the function in the eSales service.
public Apptus\ESales\Connector\Products
# resultAsProducts( )

Fetches the result as Products.

Fetches the result as Products.

Returns

Apptus\ESales\Connector\Products
The result as Products.

Throws

Apptus\ESales\Connector\ResultTypeException
If the result is not of type Products.
Apptus\ESales\Connector\PanelException
If there was an error evaluating the function in the eSales service.
public Apptus\ESales\Connector\Values
# resultAsValues( )

Fetches the result as Values.

Fetches the result as Values.

Returns

Apptus\ESales\Connector\Values
The result as Values.

Throws

Apptus\ESales\Connector\ResultTypeException
If the result is not of type Values.
Apptus\ESales\Connector\PanelException
If there was an error evaluating the function in the eSales service.
public Apptus\ESales\Connector\Phrases
# resultAsPhrases( )

Fetches the result as Phrases.

Fetches the result as Phrases.

Returns

Apptus\ESales\Connector\Phrases
The result as Phrases.

Throws

Apptus\ESales\Connector\ResultTypeException
If the result is not of type Phrases.
Apptus\ESales\Connector\PanelException
If there was an error evaluating the function in the eSales service.
public Apptus\ESales\Connector\Ads
# resultAsAds( )

Fetches the result as Ads.

Fetches the result as Ads.

Returns

Apptus\ESales\Connector\Ads
The result as Ads.

Throws

Apptus\ESales\Connector\ResultTypeException
If the result is not of type Ads.
Apptus\ESales\Connector\PanelException
If there was an error evaluating the function in the eSales service.
public Apptus\ESales\Connector\FacetRange
# resultAsFacetRange( )

Fetches the result as FacetRange

Fetches the result as FacetRange

Returns

Apptus\ESales\Connector\FacetRange
result as FacetRange

Throws

Apptus\ESales\Connector\ResultTypeException
if the result is not of type FacetRange
Apptus\ESales\Connector\PanelException
if there was an error evaluating the function in the eSales service
public Apptus\ESales\Connector\FacetRange
# resultAsFacetList( )

Fetches the result as FacetList

Fetches the result as FacetList

Returns

Apptus\ESales\Connector\FacetRange
result as FacetList

Throws

Apptus\ESales\Connector\ResultTypeException
if the result is not of type FacetList
Apptus\ESales\Connector\PanelException
if there was an error evaluating the function in the eSales service
Apptus ESales Connector PHP API documentation generated by ApiGen