Class Subpanel
A subpanel refers to a public panel, and can be provided to a dynamic page in order to
retrieve content from several panels at once without having to predefine a zone.
Each subpanel must have a unique name within a dynamic page.
Methods summary
public static
Apptus\ESales\Connector\Subpanel
|
#
create( string $name, string $publicPanel )
Creates a subpanel with a reference to a public panel. The subpanel can be supplied to a dynamic page.
Creates a subpanel with a reference to a public panel. The subpanel can be supplied to a dynamic page.
Parameters
- $name
The name of this subpanel, defining the path shown in the result.
This name must be unique for each dynamic page it is provided to.
- $publicPanel
- The path of the public panel.
Returns
|
public
Apptus\ESales\Connector\Subpanel
|
#
addArgument( string $name, string $value )
Adds an argument to the map of arguments for this subpanel,
where key is the parameter name, and value is the argument value.
Adds an argument to the map of arguments for this subpanel,
where key is the parameter name, and value is the argument value.
Parameters
- $name
- The parameter name.
- $value
- The argument value.
Returns
|
public
Apptus\ESales\Connector\Subpanel
|
#
addArguments( array|Apptus\ESales\Connector\ArgMap $args )
Appends a map of arguments to the arguments of this subpanel. Any prior arguments with the same name
will be overriden.
Appends a map of arguments to the arguments of this subpanel. Any prior arguments with the same name
will be overriden.
These arguments will have precedence in any name collisions with the arguments provided
to a dynamic page with this subpanel.
Parameters
- $args
- A map of arguments to the subpanel, where key is the parameter name, and value is the argument value.
Returns
|
public
Apptus\ESales\Connector\Subpanel
|
#
addAttribute( string $name, string $value )
Adds a local panel attribute to this subpanel. These attributes can be retrieved from the corresponding Apptus\ESales\Connector\PanelContent
object in the response.
Parameters
- $name
- The attribute name.
- $value
- The attribute value.
Returns
|
public
Apptus\ESales\Connector\Subpanel
|
#
addAttributes( array $attributes )
Appends an associative array of attributes to the local panel attributes of this subpanel. Any prior attributes with
the same name will be overridden. These attributes can be retrieved from the corresponding Apptus\ESales\Connector\PanelContent object
in the response.
Appends an associative array of attributes to the local panel attributes of this subpanel. Any prior attributes with
the same name will be overridden. These attributes can be retrieved from the corresponding Apptus\ESales\Connector\PanelContent object
in the response.
Parameters
- $attributes
An associative array of local attributes for the subpanel, where key is the attribute name, and value is the
attribute value.
Returns
|