Class 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.
Use Apptus\ESales\Connector\DynamicPage::retrieveContent() to get the content of this page and all of its sub panels, recursively.
The request will be equivalent to requesting a predefined zone with the same name, and the same sub panels,
as the dynamic page.
Methods summary
public
Apptus\ESales\Connector\DynamicPage
|
#
addSubpanel( Apptus\ESales\Connector\Subpanel $subpanel )
Adds a subpanel to this dynamic page. Each subpanel must have a unique name.
Adds a subpanel to this dynamic page. Each subpanel must have a unique name.
Parameters
- $subpanel
- subpanel to add
Returns
Throws
|
public
Apptus\ESales\Connector\DynamicPage
|
#
addAttribute( string $name, string $value )
Adds a local panel attribute to this dynamic page. These attributes can be retrieved from the Apptus\ESales\Connector\PanelContent response.
Parameters
- $name
- The attribute name.
- $value
- The attribute value.
Returns
|
public
Apptus\ESales\Connector\DynamicPage
|
#
addAttributes( array $attributes )
Appends an associative array of attributes to the local panel attributes of this dynamic page. Any prior attributes with
the same name will be overridden. These attributes can be retrieved from the Apptus\ESales\Connector\PanelContent response.
Appends an associative array of attributes to the local panel attributes of this dynamic page. Any prior attributes with
the same name will be overridden. These attributes can be retrieved from the Apptus\ESales\Connector\PanelContent response.
Parameters
- $attributes
An associative array of local attributes for the dynamic page, where key is the attribute name, and value is the
attribute value. Returns
|
public
Apptus\ESales\Connector\PanelContent
|
#
retrieveContent( Apptus\ESales\Connector\ArgMap|array|null $dynamicPageArguments = null )
Retrieves the content of this dynamic page from the eSales service.
Retrieves the content of this dynamic page from the eSales service.
The arguments supplied to this method may be overriden by the arguments sent to the subpanels.
You may use an Apptus\ESales\Connector\ArgMap or an associative array to pass the arguments.
Parameters
- $dynamicPageArguments
map of arguments, where key is the parameter name, and value is the argument value.
Arguments having null values are ignored. Returns
Throws
|
public
string
|
#
retrieveContentAsXml( array|Apptus\ESales\Connector\ArgMap $dynamicPageArguments = null )
Retrieves the content of this dynamic page from the eSales service as a string.
Retrieves the content of this dynamic page from the eSales service as a string.
The arguments supplied to this method may be overriden by the arguments sent to the subpanels,
or by the arguments already defined in the public panels referred to by the subpanels.
You may use an Apptus\ESales\Connector\ArgMap or an associative array to pass the arguments.
Parameters
- $dynamicPageArguments
A 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 dynamic page.
Throws
|