Preset FO useful variables
Preset FO useful variables
Posted on Tuesday, January 12, 2010
- |
Non exhaustive list of request attributes available in the Front Office
Section(s): front office, learning
A set of request attributes is initialized early by the Front Office framework. This article will give you a list of them and of their use.
Using WMS FO framework provides tools for resolving datas and entering in a template. Developpers should only concentrate in developping the template and not take care of background-actions. Meanwhile, a list of request attributes is initialized during the resolution of a front query :
- config_parameter_name_objectname
- The name of the request parameter handling the object name of the current viewed object
- config_parameter_name_objectid
- The name of the request parameter handling the object ID of the current viewed object
- config_parameter_name_menuid
- The name of the request parameter handling the menu ID of the current page
- context_objectname
- Name of current object type
- context_objectid
- ID of current object
- context_menu_objectid
- current menu ID
- config_menu_objectname
- object used for building menu (should ALWAYS be category)
- config_url_homepage
- home page URL (you don't have to set this value at any moment)
- config_url_view
- view part URL
- config_url_search
- search part URL
- config_url_bov2
- URL to BO
- activeObject
- Active object is the main object being view.
- activeObjectStructure
- structure of the activeObject
- preview
- bollean indicating whether we are in preview or not
- activeMedia
- This request attribute is only available if WMS_FO_MultiSite plugin is availabale.
Contains the media object on which the user is browsing
- activeModel
- This request attribute is only available if WMS_FO_MultiSite plugin is availabale.
Contains the sitemodel object which the activeMedia uses.
- layout
- This request attribute is only available if WMS_FO_MultiSite plugin is availabale.
Contains the layout name.
- activeLang
- This request attribute is only available if WMS_FO_MultiLang plugin is availabale.
Contains the language object of the surfer.
- WMS_BlocManagement_allBlocs
- This request attribute is only available if WMS_BlocManagement? plugin is availabale.
Is a java.util.Map where- key is a bloc structure name (should probably only contain bloc)
- value is a comma separated list of ids of blocs of this type associated to current page
- WMS_BlocManagement_blocsMapping
- This request attribute is only available if WMS_BlocManagement? plugin is availabale.
Is a java.util.Map where- key is the name of a target zone (drop zone during handling)
- value is a java.util.List of String Array containing keys to find in WMS_BlocManagement_allBlocs request attribute the blocs:
String array always have 3 values :- name of structure
- timestamp or random string
- id of instance
- WMS_BlocManagement_sourceObject
- This request attribute is only available if WMS_BlocManagement? plugin is availabale.
The object that gave the blocks configuration (because of inheritance, it might not be activeObject).
