TYPO3\CMS\Fluid\View\TemplatePaths Class Reference

Inheritance diagram for TYPO3\CMS\Fluid\View\TemplatePaths:

Public Member Functions
	fillDefaultsByPackageName ($packageName)
	setTemplateRootPaths (array $templateRootPaths)
	setLayoutRootPaths (array $layoutRootPaths)
	setPartialRootPaths (array $partialRootPaths)
string	getPartialPathAndFilename ($partialName)
string	getTemplatePathAndFilename ()

Protected Member Functions
string null	getExtensionPrivateResourcesPath ($extensionKey)
ConfigurationManagerInterface	getConfigurationManager ()
array	getContextSpecificViewConfiguration ($extensionKey)
string	ensureAbsolutePath ($reference)
bool	isBackendMode ()
bool	isFrontendMode ()

Protected Attributes
string	$templateSource
string	$templatePathAndFilename

Detailed Description

Class TemplatePaths

Custom implementation for template paths resolving, one which differs from the base implementation in that it is capable of resolving template paths based on TypoScript configuration when given a package name, and is aware of the Frontend/Backend contexts of TYPO3.

This is for internal Fluid use only.

Definition at line 34 of file TemplatePaths.php.

Member Function Documentation

ensureAbsolutePath()

string TYPO3\CMS\Fluid\View\TemplatePaths::ensureAbsolutePath (   $reference )

protected

Guarantees that $reference is turned into a correct, absolute path. The input can be a relative path or a FILE: or EXT: reference but cannot be a FAL resource identifier.

Parameters

mixed

$reference

Returns

‪string

Definition at line 196 of file TemplatePaths.php.

References TYPO3\CMS\Core\Utility\PathUtility\isAbsolutePath().

fillDefaultsByPackageName()

TYPO3\CMS\Fluid\View\TemplatePaths::fillDefaultsByPackageName

(

$packageName

)

Fills the path arrays with defaults, by package name. Reads those defaults from TypoScript if possible and if not defined, uses fallback paths by convention.

Parameters

string

$packageName

Definition at line 124 of file TemplatePaths.php.

References TYPO3\CMS\Fluid\View\TemplatePaths\getContextSpecificViewConfiguration().

getConfigurationManager()

ConfigurationManagerInterface TYPO3\CMS\Fluid\View\TemplatePaths::getConfigurationManager ( )

protected

Returns

‪ConfigurationManagerInterface

Definition at line 60 of file TemplatePaths.php.

Referenced by TYPO3\CMS\Fluid\View\TemplatePaths\getContextSpecificViewConfiguration().

getContextSpecificViewConfiguration()

array TYPO3\CMS\Fluid\View\TemplatePaths::getContextSpecificViewConfiguration (   $extensionKey )

protected

Parameters

string

$extensionKey

Returns

‪array

Definition at line 71 of file TemplatePaths.php.

References TYPO3\CMS\Extbase\Configuration\ConfigurationManagerInterface\CONFIGURATION_TYPE_FULL_TYPOSCRIPT, TYPO3\CMS\Extbase\Configuration\ConfigurationManagerInterface\getConfiguration(), TYPO3\CMS\Fluid\View\TemplatePaths\getConfigurationManager(), TYPO3\CMS\Fluid\View\TemplatePaths\getExtensionPrivateResourcesPath(), TYPO3\CMS\Fluid\View\TemplatePaths\isBackendMode(), TYPO3\CMS\Fluid\View\TemplatePaths\isFrontendMode(), and TYPO3\CMS\Core\Utility\ArrayUtility\sortArrayWithIntegerKeys().

Referenced by TYPO3\CMS\Fluid\View\TemplatePaths\fillDefaultsByPackageName().

getExtensionPrivateResourcesPath()

string null TYPO3\CMS\Fluid\View\TemplatePaths::getExtensionPrivateResourcesPath (   $extensionKey )

protected

Parameters

string

$extensionKey

Returns

‪string|null

Definition at line 48 of file TemplatePaths.php.

References TYPO3\CMS\Core\Utility\ExtensionManagementUtility\extPath(), and TYPO3\CMS\Core\Utility\ExtensionManagementUtility\isLoaded().

Referenced by TYPO3\CMS\Fluid\View\TemplatePaths\getContextSpecificViewConfiguration().

getPartialPathAndFilename()

string TYPO3\CMS\Fluid\View\TemplatePaths::getPartialPathAndFilename

(

$partialName

)

Public API for currently protected method. Can be dropped when switching to Fluid 1.1.0 or above.

Parameters

string

$partialName

Returns

‪string

Definition at line 172 of file TemplatePaths.php.

getTemplatePathAndFilename()

string TYPO3\CMS\Fluid\View\TemplatePaths::getTemplatePathAndFilename

(

)

Get absolute path to template file

Returns

‪string Returns the absolute path to a Fluid template file

Definition at line 182 of file TemplatePaths.php.

References TYPO3\CMS\Fluid\View\TemplatePaths\$templatePathAndFilename.

isBackendMode()

bool TYPO3\CMS\Fluid\View\TemplatePaths::isBackendMode ( )

protected

Returns

‪bool

Definition at line 210 of file TemplatePaths.php.

Referenced by TYPO3\CMS\Fluid\View\TemplatePaths\getContextSpecificViewConfiguration().

isFrontendMode()

bool TYPO3\CMS\Fluid\View\TemplatePaths::isFrontendMode ( )

protected

Returns

‪bool

Definition at line 218 of file TemplatePaths.php.

Referenced by TYPO3\CMS\Fluid\View\TemplatePaths\getContextSpecificViewConfiguration().

setLayoutRootPaths()

TYPO3\CMS\Fluid\View\TemplatePaths::setLayoutRootPaths

(

array

$layoutRootPaths

)

Overridden setter with enforced sorting behavior

Parameters

array

$layoutRootPaths

Definition at line 146 of file TemplatePaths.php.

References TYPO3\CMS\Core\Utility\ArrayUtility\sortArrayWithIntegerKeys().

setPartialRootPaths()

TYPO3\CMS\Fluid\View\TemplatePaths::setPartialRootPaths

(

array

$partialRootPaths

)

Overridden setter with enforced sorting behavior

Parameters

array

$partialRootPaths

Definition at line 158 of file TemplatePaths.php.

References TYPO3\CMS\Core\Utility\ArrayUtility\sortArrayWithIntegerKeys().

setTemplateRootPaths()

TYPO3\CMS\Fluid\View\TemplatePaths::setTemplateRootPaths

(

array

$templateRootPaths

)

Overridden setter with enforced sorting behavior

Parameters

array

$templateRootPaths

Definition at line 134 of file TemplatePaths.php.

References TYPO3\CMS\Core\Utility\ArrayUtility\sortArrayWithIntegerKeys().

Member Data Documentation

$templatePathAndFilename

string TYPO3\CMS\Fluid\View\TemplatePaths::$templatePathAndFilename

protected

Definition at line 42 of file TemplatePaths.php.

Referenced by TYPO3\CMS\Fluid\View\TemplatePaths\getTemplatePathAndFilename().

$templateSource

string TYPO3\CMS\Fluid\View\TemplatePaths::$templateSource

protected

Definition at line 38 of file TemplatePaths.php.