TemplatePaths extends TemplatePaths

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.

Internal

This is for internal Fluid use only.

Table of Contents

Properties

$templatePathAndFilename  : string
$templateSource  : string

Methods

fillDefaultsByPackageName()  : void
Fills the path arrays with defaults, by package name.
getTemplatePathAndFilename()  : string
Get absolute path to template file
setLayoutRootPaths()  : void
Overridden setter with enforced sorting behavior
setPartialRootPaths()  : void
Overridden setter with enforced sorting behavior
setTemplateRootPaths()  : void
Overridden setter with enforced sorting behavior
ensureAbsolutePath()  : array<string|int, mixed>|string
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.
getConfigurationManager()  : ConfigurationManagerInterface
getContextSpecificViewConfiguration()  : array<string|int, mixed>
getExtensionPrivateResourcesPath()  : string|null
isBackendMode()  : bool
isFrontendMode()  : bool

Properties

$templatePathAndFilename

protected string $templatePathAndFilename

$templateSource

protected string $templateSource

Methods

fillDefaultsByPackageName()

Fills the path arrays with defaults, by package name.

public fillDefaultsByPackageName(string $packageName) : void

Reads those defaults from TypoScript if possible and if not defined, uses fallback paths by convention.

Parameters
$packageName : string

getTemplatePathAndFilename()

Get absolute path to template file

public getTemplatePathAndFilename() : string
Return values
string

Returns the absolute path to a Fluid template file

setLayoutRootPaths()

Overridden setter with enforced sorting behavior

public setLayoutRootPaths(array<string|int, mixed> $layoutRootPaths) : void
Parameters
$layoutRootPaths : array<string|int, mixed>

setPartialRootPaths()

Overridden setter with enforced sorting behavior

public setPartialRootPaths(array<string|int, mixed> $partialRootPaths) : void
Parameters
$partialRootPaths : array<string|int, mixed>

setTemplateRootPaths()

Overridden setter with enforced sorting behavior

public setTemplateRootPaths(array<string|int, mixed> $templateRootPaths) : void
Parameters
$templateRootPaths : array<string|int, mixed>

ensureAbsolutePath()

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.

protected ensureAbsolutePath(string|array<string|int, mixed> $reference) : array<string|int, mixed>|string
Parameters
$reference : string|array<string|int, mixed>
Return values
array<string|int, mixed>|string

getContextSpecificViewConfiguration()

protected getContextSpecificViewConfiguration(string $extensionKey) : array<string|int, mixed>
Parameters
$extensionKey : string
Return values
array<string|int, mixed>

getExtensionPrivateResourcesPath()

protected getExtensionPrivateResourcesPath(string $extensionKey) : string|null
Parameters
$extensionKey : string
Return values
string|null

isBackendMode()

protected isBackendMode() : bool
Return values
bool

isFrontendMode()

protected isFrontendMode() : bool
Return values
bool

        
On this page

Search results