TYPO3  7.6
Public Member Functions | Public Attributes | Protected Attributes | List of all members
ExtensionService Class Reference
Inheritance diagram for ExtensionService:
SingletonInterface

Public Member Functions

 injectObjectManager (\TYPO3\CMS\Extbase\Object\ObjectManagerInterface $objectManager)
 
 injectConfigurationManager (\TYPO3\CMS\Extbase\Configuration\ConfigurationManagerInterface $configurationManager)
 
 getPluginNamespace ($extensionName, $pluginName)
 
 getPluginNameByAction ($extensionName, $controllerName, $actionName)
 
 isActionCacheable ($extensionName, $pluginName, $controllerName, $actionName)
 
 getTargetPidByPlugin ($extensionName, $pluginName)
 
 getDefaultControllerNameByPlugin ($extensionName, $pluginName)
 
 getDefaultActionNameByPluginAndController ($extensionName, $pluginName, $controllerName)
 
 getTargetPageTypeByFormat ($extensionName, $format)
 

Public Attributes

const PLUGIN_TYPE_PLUGIN = 'list_type'
 
const PLUGIN_TYPE_CONTENT_ELEMENT = 'CType'
 

Protected Attributes

 $objectManager
 
 $configurationManager
 
 $targetPidPluginCache = array()
 

Detailed Description

Service for determining basic extension params

Definition at line 20 of file ExtensionService.php.

Member Function Documentation

getDefaultActionNameByPluginAndController (   $extensionName,
  $pluginName,
  $controllerName 
)

This returns the name of the first action of the given plugin controller.

Parameters
string$extensionNamename of the extension to retrieve the target PID for
string$pluginNamename of the plugin to retrieve the target PID for
string$controllerNamename of the controller to retrieve default action for
Returns
string|NULL

Definition at line 196 of file ExtensionService.php.

References $GLOBALS.

getDefaultControllerNameByPlugin (   $extensionName,
  $pluginName 
)

This returns the name of the first controller of the given plugin.

Parameters
string$extensionNamename of the extension to retrieve the target PID for
string$pluginNamename of the plugin to retrieve the target PID for
Returns
string|NULL

Definition at line 179 of file ExtensionService.php.

References $GLOBALS.

getPluginNameByAction (   $extensionName,
  $controllerName,
  $actionName 
)

Iterates through the global TypoScript configuration and returns the name of the plugin that matches specified extensionName, controllerName and actionName. If no matching plugin was found, NULL is returned. If more than one plugin matches and the current plugin is not configured to handle the action, an Exception will be thrown

Parameters
string$extensionNamename of the target extension (UpperCamelCase)
string$controllerNamename of the target controller (UpperCamelCase)
string$actionNamename of the target action (lowerCamelCase)
Exceptions
\TYPO3\CMS\Extbase\Exception
Returns
string name of the target plugin (UpperCamelCase) or NULL if no matching plugin configuration was found

Definition at line 90 of file ExtensionService.php.

References $GLOBALS.

getPluginNamespace (   $extensionName,
  $pluginName 
)

Determines the plugin namespace of the specified plugin (defaults to "tx_[extensionname]_[pluginname]") If plugin.tx_$pluginSignature.view.pluginNamespace is set, this value is returned If pluginNamespace is not specified "tx_[extensionname]_[pluginname]" is returned.

Parameters
string$extensionNamename of the extension to retrieve the namespace for
string$pluginNamename of the plugin to retrieve the namespace for
Returns
string plugin namespace

Definition at line 66 of file ExtensionService.php.

getTargetPageTypeByFormat (   $extensionName,
  $format 
)

Resolve the page type number to use for building a link for a specific format

Parameters
string$extensionNamename of the extension that has defined the target page type
string$formatThe format for which to look up the page type
Returns
int Page type number for target page

Definition at line 212 of file ExtensionService.php.

getTargetPidByPlugin (   $extensionName,
  $pluginName 
)

Determines the target page of the specified plugin. If plugin.tx_$pluginSignature.view.defaultPid is set, this value is used as target page id If defaultPid is set to "auto", a the target pid is determined by loading the tt_content record that contains this plugin If the page could not be determined, NULL is returned If defaultPid is "auto" and more than one page contains the specified plugin, an Exception is thrown

Parameters
string$extensionNamename of the extension to retrieve the target PID for
string$pluginNamename of the plugin to retrieve the target PID for
Exceptions
\TYPO3\CMS\Extbase\Exception
Returns
int uid of the target page or NULL if target page could not be determined

Definition at line 152 of file ExtensionService.php.

References $GLOBALS.

injectConfigurationManager ( \TYPO3\CMS\Extbase\Configuration\ConfigurationManagerInterface  $configurationManager)
Parameters
\TYPO3\CMS\Extbase\Configuration\ConfigurationManagerInterface$configurationManager

Definition at line 52 of file ExtensionService.php.

References ExtensionService\$configurationManager.

injectObjectManager ( \TYPO3\CMS\Extbase\Object\ObjectManagerInterface  $objectManager)
Parameters
\TYPO3\CMS\Extbase\Object\ObjectManagerInterface$objectManager

Definition at line 44 of file ExtensionService.php.

References ExtensionService\$objectManager.

isActionCacheable (   $extensionName,
  $pluginName,
  $controllerName,
  $actionName 
)

Checks if the given action is cacheable or not.

Parameters
string$extensionNameName of the target extension, without underscores
string$pluginNameName of the target plugin
string$controllerNameName of the target controller
string$actionNameName of the action to be called
Returns
bool TRUE if the specified plugin action is cacheable, otherwise FALSE

Definition at line 131 of file ExtensionService.php.

Member Data Documentation

$configurationManager
protected

Definition at line 33 of file ExtensionService.php.

Referenced by ExtensionService\injectConfigurationManager().

$objectManager
protected

Definition at line 28 of file ExtensionService.php.

Referenced by ExtensionService\injectObjectManager().

$targetPidPluginCache = array()
protected

Definition at line 39 of file ExtensionService.php.

const PLUGIN_TYPE_CONTENT_ELEMENT = 'CType'

Definition at line 23 of file ExtensionService.php.

const PLUGIN_TYPE_PLUGIN = 'list_type'

Definition at line 22 of file ExtensionService.php.