Generator class
This page documents the modern
Generatorclass for parsing templates of any file format. For legacy PHP generation from JSON/YAML/NEON templates, see theClassicGeneratorclass.
The Generator class provides functionality for parsing modern templates (any file format) and generating files. It uses ParsβEm for template parsing and variable substitution.
Important Classes
GenericFileObject
Matronator\Mtrgen\GenericFileObject is the main data structure for parsed modern templates. It contains all the information about the file that is needed for writing it to the disk.
1
2
3
4
5
6
7
8
9
10
11
12
13
14
namespace Matronator\Mtrgen;
class GenericFileObject
{
public string $contents; // The file contents as a string
public string $filename; // The output filename (including extension)
public string $directory; // The output directory path
public function __construct(string $directory, string $filename, string $contents) {
$this->filename = $filename;
$this->contents = $contents;
$this->directory = $directory;
}
}
TemplateHeader
Matronator\Mtrgen\Template\TemplateHeader represents the metadata header of a template file.
1
2
3
4
5
6
7
8
9
10
11
namespace Matronator\Mtrgen\Template;
class TemplateHeader
{
public string $name; // Template name (for storage/identification)
public string $filename; // Output filename (can use template variables)
public string $path; // Output directory path (can use template variables)
public function __construct(string $name, string $filename, string $path);
public static function fromArray(array $array): static;
}
Constants
HEADER_PATTERN: Regular expression pattern for matching the template header block (/^--- MTRGEN ---(.+)--- \/MTRGEN ---/ms).COMMENT_PATTERN: Regular expression pattern for matching comment-based template variables (for use withuseCommentSyntaxoption).
Methods
parseAnyFile(string $path, array $arguments = [], bool $useCommentSyntax = false): GenericFileObject
Parses a template file of any format and returns a GenericFileObject ready to be written to disk.
$path: The path to the template file.$arguments: (optional) An array of arguments to pass to the template variables.$useCommentSyntax: (optional) Iftrue, uses comment-based syntax (/*variable*/) instead of<%variable%>syntax.- Returns: A
GenericFileObjectrepresenting the parsed file.
Example:
1
2
3
4
5
6
7
$file = Generator::parseAnyFile('component.js.mtr', [
'name' => 'MyComponent',
'event' => 'click'
]);
// $file->filename will be "MyComponent.js" (from header)
// $file->directory will be the path from header
// $file->contents will be the parsed template content
writeFiles(GenericFileObject|GenericFileObject[] $files): void
Writes one or more parsed file objects to disk. Creates directories if they donβt exist.
$files: A singleGenericFileObjector an array ofGenericFileObjectinstances.
Example:
1
2
3
4
5
// Write a single file
Generator::writeFiles($file);
// Write multiple files
Generator::writeFiles([$file1, $file2, $file3]);
getName(?string $content = null, ?string $path = null): string
Gets the template name from the header. Either $content or $path must be provided.
$content: (optional) The template file contents.$path: (optional) The path to the template file.- Returns: The template name from the header.
- Throws:
RuntimeExceptionif neither$contentnor$pathis provided, or if the header is missing required fields.
getTemplateHeader(string $content): TemplateHeader
Extracts and parses the template header from the file content.
$content: The template file contents (including the header).- Returns: A
TemplateHeaderobject withname,filename, andpathproperties. - Throws:
RuntimeExceptionif the header is missing required properties.
removeHeader(string $content): string
Removes the template header block from the file content, returning only the template body.
$content: The template file contents (including the header).- Returns: The template content without the header block.