On-site toolbar service.
This service manages the toolbars used for the on-site administration system. For each context, it provides the following set of toolbars:
The Node toolbar is applicable to the current node, which is usually a topic. MidCOM places the topic management operations into this toolbar, where applicable.
The View toolbar is applicable to the specific view ("url"). Usually this maps to a single displayed object (see also the bind_to_object() member function). MidCOM places the object-specific management operations (like Metadata controls) into this toolbar, if it is bound to an object. Otherwise, this toolbar is not touched by MidCOM.
It is important to understand that the default toolbars made available through this service are completely specific to a given request context. If you have a dynamic_load running on a given site, it will have its own set of toolbars for each instance.
In addition, components may retrieve a third kind of toolbars, which are not under the general control of MidCOM, the Object toolbars. They apply to a single database object (like a bound View toolbar). The usage of this kind of toolbars is completely component-specific.
Implementation notes
It has yet to prove if the toolbar system is needed for a dynamic_load environments. The main reason for this is that dl'ed stuff is often quite tight in space and thus cannot display any toolbars in a sane way. Usually, the administrative tasks will be bound to the main request.
This could be different for portal applications, which display several components on the welcome page, each with its own management options.
Configuration See midcom_config for configuration options.
get_host_toolbar(integer $context_id = null) : \midcom_helper_toolbar_host
Returns the host toolbar of the specified context. The toolbars will be created if this is the first request.
| integer | $context_id | The context to retrieve the node toolbar for, this defaults to the current context. |
get_node_toolbar(integer $context_id = null) : \midcom_helper_toolbar_node
Returns the node toolbar of the specified context. The toolbars will be created if this is the first request.
| integer | $context_id | The context to retrieve the node toolbar for, this defaults to the current context. |
get_view_toolbar(integer $context_id = null) : \midcom_helper_toolbar_view
Returns the view toolbar of the specified context. The toolbars will be created if this is the first request.
| integer | $context_id | The context to retrieve the view toolbar for, this defaults to the current context. |
get_help_toolbar(integer $context_id = null) : \midcom_helper_toolbar_help
Returns the help toolbar of the specified context. The toolbars will be created if this is the first request.
| integer | $context_id | The context to retrieve the help toolbar for, this defaults to the current context. |
add_toolbar(string $identifier, \midcom_helper_toolbar $toolbar, integer $context_id = null)
Add a toolbar
| string | $identifier | |
| \midcom_helper_toolbar | $toolbar | |
| integer | $context_id | The context to retrieve the help toolbar for, this defaults to the current context. |
bind_toolbar_to_object(\midcom_helper_toolbar $toolbar, $object)
Binds the a toolbar to a DBA object. This will append a number of globally available toolbar options. For example, expect Metadata- and Version Control-related options to be added.
This call is available through convenience functions throughout the framework: The toolbar main class has a mapping for it (midcom_helper_toolbar::bind_to($object)) and object toolbars created by this service will automatically be bound to the specified object.
Repeated bind calls are intercepted, you can only bind a toolbar to a single object.
| \midcom_helper_toolbar | $toolbar | |
| $object |
_render_toolbar(integer $toolbar_identifier, integer $context_id = null) : string
Renders the specified toolbar for the indicated context.
If the toolbar is undefined, an empty string is returned.
| integer | $toolbar_identifier | The toolbar identifier constant (one of MIDCOM_TOOLBAR_NODE or MIDCOM_TOOLBAR_VIEW etc.) |
| integer | $context_id | The context to retrieve the node toolbar for, this defaults to the current context. |
The rendered toolbar
render_node_toolbar(integer $context_id = null) : string
Renders the node toolbar for the indicated context. If the toolbar is undefined, an empty string is returned. If you want to show the toolbar directly, look for the show_xxx_toolbar methods.
| integer | $context_id | The context to retrieve the node toolbar for, this defaults to the current context. |
The rendered toolbar
render_view_toolbar(integer $context_id = null) : string
Renders the view toolbar for the indicated context. If the toolbar is undefined, an empty string is returned. If you want to show the toolbar directly, look for the show_xxx_toolbar methods.
| integer | $context_id | The context to retrieve the node toolbar for, this defaults to the current context. |
The rendered toolbar
render_host_toolbar(integer $context_id = null) : string
Renders the host toolbar for the indicated context. If the toolbar is undefined, an empty string is returned. If you want to show the toolbar directly, look for the show_xxx_toolbar methods.
| integer | $context_id | The context to retrieve the node toolbar for, this defaults to the current context. |
The rendered toolbar
render_help_toolbar(integer $context_id = null) : string
Renders the help toolbar for the indicated context. If the toolbar is undefined, an empty string is returned. If you want to show the toolbar directly, look for the show_xxx_toolbar methods.
| integer | $context_id | The context to retrieve the node toolbar for, this defaults to the current context. |
The rendered toolbar
_get_toolbar(integer $context_id, string $identifier) : \midcom_helper_toolbar
| integer | $context_id | |
| string | $identifier |