Property | Type | Description | |
---|---|---|---|
$layoutRootPathPattern | string | ||
$options | array | ||
$packageManager | Neos\Flow\Package\PackageManagerInterface | ||
$partialRootPathPattern | string | ||
$patternReplacementVariables | string[] | A map of key => values to be replaced in path patterns. | |
$templateRootPathPattern | string |
Method | Description | |
---|---|---|
__construct ( array $options = [] ) | ||
getLayoutPathAndFilename ( string $layoutName = 'Default' ) : string | Resolve the path and file name of the layout file, based on $this->options['layoutPathAndFilename'] and $this->options['layoutPathAndFilenamePattern']. | |
getLayoutRootPaths ( ) : array | ||
getOption ( string $optionName ) : mixed | Get a specific option of this object | |
getPartialPathAndFilename ( string $partialName ) : string | Resolve the partial path and filename based on $this->options['partialPathAndFilenamePattern']. | |
getPartialRootPaths ( ) | ||
getPatternReplacementVariables ( ) : string[] | ||
getTemplateRootPathPattern ( ) : string | ||
getTemplateRootPaths ( ) : array | Resolves the template root to be used inside other paths. | |
injectPackageManager ( Neos\Flow\Package\PackageManagerInterface $packageManager ) | ||
resolveTemplateFileForControllerAndActionAndFormat ( string $controller, string $action, string $format = null ) : mixed | string | Resolves a template file based on the given controller and action, together with eventually defined patternReplacementVariables. | |
setLayoutRootPath ( string $layoutRootPath ) | ||
setLayoutRootPathPattern ( string $layoutRootPathPattern ) | ||
setOption ( string $optionName, mixed $value ) : void | Set a specific option of this object | |
setPartialRootPath ( string $partialRootPath ) | ||
setPartialRootPathPattern ( string $partialRootPathPattern ) | ||
setPatternReplacementVariables ( string[] $patternReplacementVariables ) | ||
setTemplateRootPath ( string $templateRootPath ) | ||
setTemplateRootPathPattern ( string $templateRootPathPattern ) |
Method | Description | |
---|---|---|
createIdentifierForFile ( string $pathAndFilename, string $prefix ) : string |
Returns a unique identifier for the given file in the format
|
|
expandGenericPathPattern ( string $pattern, array $patternReplacementVariables, boolean $bubbleControllerAndSubpackage, boolean $formatIsOptional ) : array | Processes following placeholders inside $pattern: - "@templateRoot" - "@partialRoot" - "@layoutRoot" - "@subpackage" - "@controller" - "@format" | |
expandPatterns ( array $patterns, string $search, array $replacements ) : void | Expands the given $patterns by adding an array element for each $replacement replacing occurrences of $search. | |
expandSubPackageAndController ( array $paths, string $controllerName, null $subPackageKey = null, boolean $bubbleControllerAndSubpackage = false ) : array | ||
getPackagePath ( string $packageName ) : string | ||
getPackagePrivateResourcesPath ( string $packageKey ) : string | null | ||
replacePatternVariable ( array $paths, string $variableName, string $variableValue ) : array | ||
sanitizePath ( string $path ) : string | Sanitize a path, ensuring it is absolute and if a directory, suffixed by a trailing slash. |
protected expandGenericPathPattern ( string $pattern, array $patternReplacementVariables, boolean $bubbleControllerAndSubpackage, boolean $formatIsOptional ) : array | ||
$pattern | string | Pattern to be resolved |
$patternReplacementVariables | array | The variables to replace in the pattern |
$bubbleControllerAndSubpackage | boolean | if TRUE, then we successively split off parts from "@controller" and "@subpackage" until both are empty. |
$formatIsOptional | boolean | if TRUE, then half of the resulting strings will have ."@format" stripped off, and the other half will have it. |
return | array | unix style paths |
public getLayoutPathAndFilename ( string $layoutName = 'Default' ) : string | ||
$layoutName | string | Name of the layout to use. If none given, use "Default" |
return | string | Path and filename of layout files |
protected getPackagePath ( string $packageName ) : string | ||
$packageName | string | |
return | string |
public getPartialPathAndFilename ( string $partialName ) : string | ||
$partialName | string | The name of the partial |
return | string | the full path which should be used. The path definitely exists. |
public getPatternReplacementVariables ( ) : string[] | ||
return | string[] |
public getTemplateRootPathPattern ( ) : string | ||
return | string |
public getTemplateRootPaths ( ) : array | ||
return | array | Path(s) to template root directory |
public injectPackageManager ( Neos\Flow\Package\PackageManagerInterface $packageManager ) | ||
$packageManager | Neos\Flow\Package\PackageManagerInterface |
protected sanitizePath ( string $path ) : string | ||
$path | string | |
return | string |
public setLayoutRootPath ( string $layoutRootPath ) | ||
$layoutRootPath | string |
public setLayoutRootPathPattern ( string $layoutRootPathPattern ) | ||
$layoutRootPathPattern | string |
public setPartialRootPath ( string $partialRootPath ) | ||
$partialRootPath | string |
public setPartialRootPathPattern ( string $partialRootPathPattern ) | ||
$partialRootPathPattern | string |
public setPatternReplacementVariables ( string[] $patternReplacementVariables ) | ||
$patternReplacementVariables | string[] |
public setTemplateRootPath ( string $templateRootPath ) | ||
$templateRootPath | string |
public setTemplateRootPathPattern ( string $templateRootPathPattern ) | ||
$templateRootPathPattern | string |
protected PackageManagerInterface,Neos\Flow\Package $packageManager | ||
return | Neos\Flow\Package\PackageManagerInterface |
protected string $partialRootPathPattern | ||
return | string |
protected string[] $patternReplacementVariables | ||
return | string[] |
protected string $templateRootPathPattern | ||
return | string |