Class Element
Base class for all Mapbender elements.
This class defines all base methods and required instance methods to implement an Mapbender3 element.
Direct known subclasses
Mapbender\CoreBundle\Element\AboutDialog
,
Mapbender\CoreBundle\Element\ActivityIndicator
,
Mapbender\CoreBundle\Element\Legend
,
Mapbender\CoreBundle\Element\Map
,
Mapbender\CoreBundle\Element\Overview
,
Mapbender\CoreBundle\Element\POI
,
Mapbender\CoreBundle\Element\PrintClient
,
Mapbender\CoreBundle\Element\Redlining
,
Mapbender\CoreBundle\Element\Ruler
,
Mapbender\CoreBundle\Element\ScaleBar
,
Mapbender\CoreBundle\Element\ScaleDisplay
,
Mapbender\CoreBundle\Element\ScaleSelector
,
Mapbender\CoreBundle\Element\BaseSourceSwitcher
,
Mapbender\CoreBundle\Element\SearchRouter
,
Mapbender\CoreBundle\Element\SimpleSearch
,
Mapbender\CoreBundle\Element\Sketch
,
Mapbender\CoreBundle\Element\SrsSelector
,
Mapbender\CoreBundle\Element\ZoomBar
,
Mapbender\KmlBundle\Element\KmlExport
,
Mapbender\PrintBundle\Element\ImageExport
,
Mapbender\WmcBundle\Element\SuggestMap
,
Mapbender\WmcBundle\Element\WmcEditor
,
Mapbender\WmcBundle\Element\WmcList
,
Mapbender\CoreBundle\Element\Button
,
Mapbender\WmcBundle\Element\WmcLoader
,
Mapbender\WmsBundle\Element\DimensionsHandler
,
Mapbender\WmsBundle\Element\WmsLoader
,
Mapbender\CoreBundle\Element\CoordinatesDisplay
,
Mapbender\CoreBundle\Element\Copyright
,
Mapbender\CoreBundle\Element\FeatureInfo
,
Mapbender\CoreBundle\Element\GpsPosition
,
Mapbender\CoreBundle\Element\HTMLElement
,
Mapbender\CoreBundle\Element\Layertree
Indirect known subclasses
Mapbender\DataSourceBundle\Element\BaseElement
,
Mapbender\DigitizerBundle\Element\Digitizer
Namespace: Mapbender\CoreBundle\Component
Author: Christian Wygoda
Located at Mapbender/CoreBundle/Component/Element.php
Methods summary
public
|
#
__construct(
The constructor. Every element needs an application to live within and the container to do useful things. |
public static
string
|
|
public static
string
|
|
public static
array
|
|
public static
array
|
|
final public
mixed
|
|
final public
|
|
public
object
|
|
public
string
|
|
public
string
|
|
public
string
|
|
public
string
|
|
public static
array
|
|
public
array
|
|
public
array
|
#
getConfiguration( )
Get the publicly exposed configuration, usually directly derived from the configuration field of the configuration entity. If you, for example, store passwords in your element configuration, you should override this method to return a cleaned up version of your configuration which can safely be exposed in the client. |
public
string
|
#
getWidgetName( )
Get the function name of the JavaScript widget for this element. This will be called to initialize the element. |
public
Symfony\Component\HttpFoundation\Response
|
|
public
string
|
#
trans( mixed $key, array $parameters = array(), null $domain = null, null $locale = null )
Translate subject by key |
public static
string
|
|
public static
string
|
|
public static
array
|
|
public static
array
|
#
mergeArrays( array $default, array $main, array $result )
Merges the default configuration array and the configuration array |
public
|
|
public static
array
|
#
getElementForm( Symfony\Component\DependencyInjection\ContainerInterface $container,
Create form for given element |
public static
|
#
getDefaultElement(
Create default element |
public
array
|
#
normalizeConfiguration( array $formConfiguration, array $entityConfiguration = array() )
Changes a element entity configuration while exporting. |
public
array
|
#
denormalizeConfiguration( array $configuration,
Changes a element entity configuration while importing. |
protected static
mixed
|
|
public
array
|
#
updateAppConfig( array $configIn )
Hook function for embedded elements to influence the effective application config on initial load. We (can) use this for BaseSourceSwitchter (deactivates layers), SuggestMap element reloading state etc. |
Magic methods summary
Properties summary
public static
boolean
|
$ext_api
Extended API. The ext_api defines, if an element can be used as a target element. |
# true |
public static
boolean
|
$merge_configurations
Merge Configurations. The merge_configurations defines, if the default configuration array and the configuration array should be merged |
# true |
protected
|
$application
Application component |
|
protected
Symfony\Component\DependencyInjection\ContainerInterface
|
$container
Symfony container |
|
protected
|
$entity
Element configuration storage entity |
|
protected
array
|
$classNameParts
Class name parts |
|
protected static
array
|
$defaultConfiguration
Element fefault configuration |
# array() |
protected static
string
|
$description
Element description translation subject |
# "mb.core.element.class.description" |
protected static
string
|
$tags
Element title translation subject |
# array() |
protected static
string[]
|
$title
Element tag translation subjects |
# "mb.core.element.class.title" |