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.
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
Throws
|
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
|
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
|
|
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(key).
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(key).
Returns
Throws
|
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
|
public
Apptus\ESales\Connector\Corrections
|
#
resultAsCorrections( )
Fetches the result as Corrections.
Fetches the result as Corrections.
Returns
Throws
|
public
Apptus\ESales\Connector\Completions
|
#
resultAsCompletions( )
Fetches the result as Completions
Fetches the result as Completions
Returns
Throws
|
public
Apptus\ESales\Connector\Count
|
#
resultAsCount( )
Fetches the result as Count.
Fetches the result as Count.
Returns
Throws
|
public
Apptus\ESales\Connector\Products
|
#
resultAsProducts( )
Fetches the result as Products.
Fetches the result as Products.
Returns
Throws
|
public
Apptus\ESales\Connector\Values
|
#
resultAsValues( )
Fetches the result as Values.
Fetches the result as Values.
Returns
Throws
|
public
Apptus\ESales\Connector\Phrases
|
#
resultAsPhrases( )
Fetches the result as Phrases.
Fetches the result as Phrases.
Returns
Throws
|
public
Apptus\ESales\Connector\Ads
|
#
resultAsAds( )
Fetches the result as Ads.
Fetches the result as Ads.
Returns
Throws
|
public
Apptus\ESales\Connector\FacetRange
|
#
resultAsFacetRange( )
Fetches the result as FacetRange
Fetches the result as FacetRange
Returns
Throws
|
public
Apptus\ESales\Connector\FacetRange
|
#
resultAsFacetList( )
Fetches the result as FacetList
Fetches the result as FacetList
Returns
Throws
|