Factory
Table of Contents
Constants
- TEMPLATE_DEFINITION_FILENAME : mixed = 'template.xml'
Properties
Methods
- __construct() : mixed
- Constructs a new template factory with its dependencies.
- getAllNames() : array<string|int, string>
- Returns a list of all template names.
- getTemplates() : Collection
- Attempts to find, construct and return a template object with the given template name or (relative/absolute) path.
- getTemplatesPath() : string
- Returns the path where all templates are stored.
- createNewFilesystemFromSubfolder() : FileSystem
- createTemplateFromXml() : Template
- Creates and returns a template object based on the provided template definition.
- getTemplatesDirectory() : FileSystem
- loadTemplate() : Template
- resolve() : FileSystem
Constants
TEMPLATE_DEFINITION_FILENAME
public
final mixed
TEMPLATE_DEFINITION_FILENAME
= 'template.xml'
Properties
$flySystemFactory read-only
private
FlySystemFactory
$flySystemFactory
$globalTemplatesPath read-only
private
string
$globalTemplatesPath
$writerCollection read-only
private
Collection
$writerCollection
Methods
__construct()
Constructs a new template factory with its dependencies.
public
__construct(Collection $writerCollection, FlySystemFactory $flySystemFactory, string $globalTemplatesPath) : mixed
Parameters
- $writerCollection : Collection
- $flySystemFactory : FlySystemFactory
- $globalTemplatesPath : string
getAllNames()
Returns a list of all template names.
public
getAllNames() : array<string|int, string>
Return values
array<string|int, string>getTemplates()
Attempts to find, construct and return a template object with the given template name or (relative/absolute) path.
public
getTemplates(array<int, TemplateDefinition> $templates) : Collection
Parameters
- $templates : array<int, TemplateDefinition>
Return values
CollectiongetTemplatesPath()
Returns the path where all templates are stored.
public
getTemplatesPath() : string
Return values
stringcreateNewFilesystemFromSubfolder()
private
createNewFilesystemFromSubfolder(string $subfolder) : FileSystem
Parameters
- $subfolder : string
Return values
FileSystemcreateTemplateFromXml()
Creates and returns a template object based on the provided template definition.
private
createTemplateFromXml(string $nameOrPath, array<string, string> $templateParams) : Template
Parameters
- $nameOrPath : string
- $templateParams : array<string, string>
Return values
TemplategetTemplatesDirectory()
private
getTemplatesDirectory() : FileSystem
Return values
FileSystemloadTemplate()
private
loadTemplate(string $template, array<string, string> $parameters) : Template
Parameters
- $template : string
- $parameters : array<string, string>
Return values
Templateresolve()
private
resolve(string $nameOrPath) : FileSystem
Parameters
- $nameOrPath : string