Skip to content

GeneratorInterface

github-actions edited this page Apr 19, 2026 · 1 revision

Generates LICENSE files from composer.json metadata.

This interface defines the contract for generating license files by reading composer.json and producing appropriate license content.


  • Full name: \FastForward\DevTools\License\GeneratorInterface

Methods

generateContent

Generates license content without writing it to disk.

public generateContent(): string|null

Return Value:

the generated license content, or null when generation is not possible


generate

Generates a LICENSE file at the specified path.

public generate(string $targetPath): string|null

Reads the license from composer.json, validates it's supported, loads the appropriate template, resolves placeholders, and writes the LICENSE file to the target path.

Parameters:

Parameter Type Description
$targetPath string The full path where the LICENSE file should be written

Return Value:

The generated license content, or null if generation failed


Clone this wiki locally