Mapbender 3.0.6.1 API documenation
  • Namespace
  • Class
  • Tree
  • Deprecated
  • Todo
  • Download

Namespaces

  • FOM
    • CoreBundle
      • Component
      • DependencyInjection
      • Doctrine
        • Types
      • Form
        • DataTransformer
        • Type
    • ManagerBundle
      • Component
      • Configuration
      • Controller
      • DependencyInjection
        • Compiler
      • Form
        • Type
      • Routing
    • UserBundle
      • Command
      • Component
      • Controller
      • DependencyInjection
        • Factory
      • Entity
      • EventListener
      • Form
        • DataTransformer
        • EventListener
        • Type
      • Security
        • Authentication
          • Provider
          • Token
        • Authorization
          • Voter
        • Firewall
  • Mapbender
    • Component
    • CoreBundle
      • Asset
      • Command
      • Component
        • Exception
      • Controller
      • DataFixtures
        • ORM
          • Application
      • DependencyInjection
        • Compiler
      • Element
        • DataTransformer
        • EventListener
        • Type
      • Entity
      • EventListener
      • Extension
      • Form
        • DataTransformer
        • EventListener
        • Type
      • Security
      • Template
      • Tests
        • Controller
      • Utils
      • Validator
        • Constraints
    • DataSourceBundle
      • Component
        • Drivers
          • Interfaces
      • Controller
      • DependencyInjection
      • Element
        • Type
      • Entity
      • Extension
      • Tests
    • DigitizerBundle
      • Component
      • Element
        • Type
      • Entity
      • Utils
    • DrupalIntegrationBundle
      • DependencyInjection
      • Security
        • Authentication
          • Provider
          • Token
        • Authorization
          • Voter
        • Factory
        • Firewall
        • User
      • Session
    • KmlBundle
      • Element
    • ManagerBundle
      • Component
        • Exception
      • Controller
      • Form
        • DataTransformer
        • Type
      • Template
    • MobileBundle
      • DependencyInjection
      • Template
    • PrintBundle
      • Component
      • Element
        • Type
    • WmcBundle
      • Component
        • Exception
      • Element
        • Type
      • Entity
      • Form
        • Type
      • Tests
        • Component
    • WmsBundle
      • Component
        • Exception
      • Controller
      • DependencyInjection
      • Element
        • DataTransformer
        • EventListener
        • Type
      • Entity
      • Event
      • Form
        • DataTransformer
        • EventListener
        • Type
  • None
  • OwsProxy3
    • CoreBundle
      • Component
        • Exception
      • Controller
      • DependencyInjection
      • Entity
      • Event
      • EventListener
      • Worker
  • PHP

Classes

  • Application
  • ApplicationYAMLMapper
  • BoundingBox
  • Element
  • EntityHandler
  • InstanceConfiguration
  • InstanceConfigurationOptions
  • KeywordUpdater
  • MapbenderBundle
  • ProxyService
  • SecurityContext
  • Signer
  • Size
  • SourceEntityHandler
  • SourceInstanceEntityHandler
  • SourceInstanceItemEntityHandler
  • SourceItemEntityHandler
  • SourceMetadata
  • SQLSearchEngine
  • StateHandler
  • Template
  • Utils
  • XmlValidator

Interfaces

  • ContainingKeyword
  • ExtendedCollection
  • SearchEngine

Class Template

Base class for all application templates.

Direct known subclasses

Mapbender\CoreBundle\Template\Fullscreen, Mapbender\ManagerBundle\Template\ManagerTemplate, Mapbender\MobileBundle\Template\Mobile

Indirect known subclasses

Mapbender\CoreBundle\Template\Classic, Mapbender\CoreBundle\Template\FullscreenAlternative, Mapbender\CoreBundle\Template\Regional, Mapbender\CoreBundle\Template\Responsive, Mapbender\ManagerBundle\Template\LoginTemplate

Abstract
Namespace: Mapbender\CoreBundle\Component
Author: Christian Wygoda
Author: Andriy Oblivantsev
Located at Mapbender/CoreBundle/Component/Template.php

Methods summary

public
# __construct( Symfony\Component\DependencyInjection\ContainerInterface $container, Mapbender\CoreBundle\Component\Application $application )

Template constructor.

Template constructor.

Parameters

$container
$application
public static string
# getTitle( )

Get the template title.

Get the template title.

This title is mainly used in the backend manager when creating a new application.

Returns

string
string
public static array
# listAssets( )

Returns

array
array
public array
# getAssets( string $type )

Get the element assets.

Get the element assets.

Returns an array of references to asset files of the given type. References can either be filenames/path which are searched for in the Resources/public directory of the element's bundle or assetic references indicating the bundle to search in:

array( 'foo.css'), '@MapbenderCoreBundle/Resources/public/foo.css'));

Parameters

$type
Asset type to list, can be 'css' or 'js'

Returns

array
array
public array
# getLateAssets( string $type )

Get assets for late including. These will be appended to the asset output last. Remember to list them in listAssets!

Get assets for late including. These will be appended to the asset output last. Remember to list them in listAssets!

Parameters

$type
Asset type to list, can be 'css' or 'js'

Returns

array
array
public static array
# getRegions( )

Get the template regions available in the Twig template.

Get the template regions available in the Twig template.

Returns

array
array
public string
# render( string $format = 'html', boolean $html = true, boolean $css = true, boolean $js = true )

Render the application

Render the application

Parameters

$format
Output format, defaults to HTML
$html
Whether to render the HTML itself
$css
Whether to include the CSS links
$js
Whether to include the JavaScript

Returns

string
$html The rendered HTML
public static array
# getRegionsProperties( )

Get the available regions properties.

Get the available regions properties.

Returns

array
array
public string
# getBundleName( )

Get template bundle name

Get template bundle name

Returns

string
Bundle name
public static string
# getResourcePath( )

Get resource path

Get resource path

Returns

string
string
public
# setTwigTemplate( Mapbender\CoreBundle\Component\Application $twigTemplate )

Parameters

$twigTemplate
public static
# setTitle( mixed $title )

Parameters

$title
Title
public string
# getTwigTemplate( )

Returns

string
TWIG template path
public static
# addAndMergeUniqueAssets( mixed $type, array $assets )

Add and merge unique assets

Add and merge unique assets

Parameters

$type
$assets

Magic methods summary

Properties summary

protected Symfony\Component\DependencyInjection\ContainerInterface $container
#
protected Mapbender\CoreBundle\Component\Application $application
#
protected static string $resourcePath

Bundle public resource path

Bundle public resource path

#
protected static string $title

Application title

Application title

#
protected string $twigTemplate

Application TWIG template path

Application TWIG template path

#
protected array $lateAssets

Late assets

Late assets

#array( 'js' => array(), 'css' => array(), 'trans' => array(), )
protected static array $regionsProperties

Region properties

Region properties

#array()
protected static array $regions

Region names

Region names

#array()
protected static array $css
#array()
protected static array $js
#array()
protected static array $translations
#array()
Mapbender 3.0.6.1 API documenation API documentation generated by ApiGen 2.8.0