Skip to content

FundingYamlCodec

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

Parses and renders GitHub funding YAML metadata.


  • Full name: \FastForward\DevTools\Funding\FundingYamlCodec
  • This class is marked as final and can't be subclassed
  • This class is a Final class

Methods

parse

Parses a GitHub funding YAML payload into a normalized profile.

public parse(string|null $contents): \FastForward\DevTools\Funding\FundingProfile

Parameters:

Parameter Type Description
$contents string|null the YAML contents, or null when the file does not exist

Return Value:

the normalized funding profile


dump

Renders a normalized funding profile into GitHub funding YAML.

public dump(\FastForward\DevTools\Funding\FundingProfile $profile): string

Parameters:

Parameter Type Description
$profile \FastForward\DevTools\Funding\FundingProfile the profile to render

Return Value:

the YAML document contents


Clone this wiki locally