\org_openpsa_products_handler_configuration

Component configuration screen.

Usage:

Write a datamanager schema compatible configuration schema and place it among your component files
Point a configuration key 'schemadb_config' to it within your component configuration (config/config.inc)
Refer to the component configuration helper with a request handler, e.g.

$this->_request_handler['config'] = array ( 'handler' => ['midcom_baseclasses_components_handler_configuration', 'config'], 'fixed_args' => ['config'], );

Summary

Methods

Properties

Constants

_load_datamanagers()
_load_objects()
_handler_recreate()
_show_recreate()
__construct()
_handler_config()
initialize()
_on_initialize()
show()
add_breadcrumb()
populate_breadcrumb_line()
bind_view_to_object()
__get()
__isset()
set_active_leaf()
add_stylesheet()
get_workflow()

$_topic
$_request_data
$_master
$_node_toolbar
$_view_toolbar
$_component
$_i18n
$_l10n
$_l10n_midcom
$_config

No constants found

No protected methods found

$router

N/A

load_controller()
_load_objects_group()

$_breadcrumbs
$_services

N/A

Properties

$_topic

$_topic : \midcom_db_topic

The topic for which we are handling a request.

Type

\midcom_db_topic

$_request_data

$_request_data : Array

Request specific data storage area. Registered in the component context as ''.

Type

Array

$_master

$_master : \midcom_baseclasses_components_request

The request class that has invoked this handler instance.

Type

\midcom_baseclasses_components_request

$_node_toolbar

$_node_toolbar : \midcom_helper_toolbar

The node toolbar for the current request context. Not available during the can_handle phase.

Type

\midcom_helper_toolbar

$_view_toolbar

$_view_toolbar : \midcom_helper_toolbar

The view toolbar for the current request context. Not available during the can_handle phase.

Type

\midcom_helper_toolbar

$_component

$_component : string

The name of the component, e.g. net.nehmer.static. Should be used whenever the component's name is required instead of hardcoding it.

Type

string

$_i18n

$_i18n : \midcom_services_i18n

A handle to the i18n service.

Type

\midcom_services_i18n

$_l10n

$_l10n : \midcom_services_i18n_l10n

The components' L10n string database.

Type

\midcom_services_i18n_l10n

$_l10n_midcom

$_l10n_midcom : \midcom_services_i18n_l10n

The global MidCOM string database.

Type

\midcom_services_i18n_l10n

$_config

$_config : \midcom_helper_configuration

The current configuration.

Type

\midcom_helper_configuration

$router

$router : \Symfony\Component\Routing\Router

Type

\Symfony\Component\Routing\Router

$_breadcrumbs

$_breadcrumbs : array

Holds breadcrumb entries the handler wants to add

Type

array

$_services

$_services : array

Array that holds the already instantiated services

Type

array

Methods

_load_datamanagers()

_load_datamanagers() : array<mixed,\midcom\datamanager\datamanager>

Must return an array of datamanager objects indexed by DBA class name.

Returns

array<mixed,\midcom\datamanager\datamanager>

_load_objects()

_load_objects() : array<mixed,\midcom_core_dbaobject>

Must return an array of DBA objects.

Returns

array<mixed,\midcom_core_dbaobject>

_handler_recreate()

_handler_recreate(string  $handler_id, array  $args, array  $data)

Handler for regenerating all derived images used in the folder.

Parameters

string	$handler_id	Name of the handler
array	$args	Variable arguments
array	$data

_show_recreate()

_show_recreate(string  $handler_id, array  $data)

Show the recreation screen

Parameters

string	$handler_id	Name of the handler
array	$data	Miscellaneous output data

__construct()

__construct()

Initialize all member variables, remember to set $_component before calling this constructor from your derived classes.

_handler_config()

_handler_config(string  $handler_id, array  $args, array  $data)

Generic handler for all the DM2 based configuration requests

Parameters

string	$handler_id	Name of the handler
array	$args	Variable arguments
array	$data

initialize()

initialize(\midcom_baseclasses_components_request  $master, \Symfony\Component\Routing\Router  $router)

Initializes the request handler class, called by the component interface after instantiation.

Be aware that it is possible that a handler can come from a different component (or library) than the master class. Take this into account when getting the component data storage, configuration and l10n instances. Configuration is merged during runtime based on the system defaults and all parameters attached to the topic we're currently operating on.

Parameters

\midcom_baseclasses_components_request	$master	The request class
\Symfony\Component\Routing\Router	$router

_on_initialize()

_on_initialize()

Initialization event handler, called at the end of the initialization process.

Use this for all initialization work you need, as the component state is already populated when this event handler is called.

show()

show(string  $element) : \midcom_response_styled

Generates a response with a given style element

Parameters

string

$element

Returns

\midcom_response_styled

add_breadcrumb()

add_breadcrumb(string  $url, string  $title)

Registers a new breadcrumb entry

Parameters

string	$url	The URL
string	$title	The text to display

populate_breadcrumb_line()

populate_breadcrumb_line()

Adds the registered breadcrumb entries to context_data

bind_view_to_object()

bind_view_to_object(\midcom_core_dbaobject  $object, string  $page_class = 'default')

Binds the current page view to a particular object. This will automatically connect such things like metadata and toolbars to the correct object.

Parameters

\midcom_core_dbaobject	$object	The DBA class instance to bind to.
string	$page_class	String describing page type, will be used for substyling

__get()

__get(  $field)

Parameters

$field

__isset()

__isset(  $field)

Parameters

$field

set_active_leaf()

set_active_leaf(  $leaf_id)

Parameters

$leaf_id

add_stylesheet()

add_stylesheet(string  $url, string  $media = false)

Convenience shortcut for adding CSS files

Parameters

string	$url	The stylesheet URL
string	$media	The media type(s) for the stylesheet, if any

get_workflow()

get_workflow(string  $identifier, array  $options = array()) : \midcom\workflow\dialog

Parameters

string	$identifier
array	$options

Returns

\midcom\workflow\dialog

load_controller()

load_controller()

_load_objects_group()

_load_objects_group(  $group_id)

Parameters

$group_id