ergebnis / front-matter
Provides a front matter parser.
Installs: 65 733
Dependents: 1
Suggesters: 0
Security: 0
Stars: 4
Watchers: 4
Forks: 0
Open Issues: 0
Requires
- php: ~8.1.0 || ~8.2.0 || ~8.3.0
- symfony/yaml: ^5.0.0 || ^6.0.0
Requires (Dev)
- ergebnis/composer-normalize: ^2.39.0
- ergebnis/data-provider: ^3.0.0
- ergebnis/license: ^2.2.0
- ergebnis/php-cs-fixer-config: ~6.10.0
- ergebnis/phpunit-slow-test-detector: ^2.3.2
- fakerphp/faker: ^1.23.0
- infection/infection: ~0.27.6
- phpunit/phpunit: ^10.4.2
- psalm/plugin-phpunit: ~0.18.4
- rector/rector: ~0.18.6
- vimeo/psalm: ^5.15.0
README
This project provides a composer
package with a front matter parser.
Installation
Run
composer require ergebnis/front-matter
Usage
This packages comes with an Ergebnis\FrontMatter\Parser
interface and provides the following parsers:
YamlParser
With the YamlParser
, you can test if a string
has YAML front matter:
<?php declare(strict_types=1); use Ergebnis\FrontMatter; $parser = new FrontMatter\YamlParser(); $unparsedContentWithoutFrontMatter = FrontMatter\Content::fromString('Hello, how are you today?'); $parser->hasFrontMatter($unparsedContentWithoutFrontMatter); // false $unparsedContentWithFrontMatter = FrontMatter\Content::fromString(<<<TXT --- page: title: "Hello" description: "Good to see you, how can I help you?" --- TXT); $parser->hasFrontMatter($unparsedContentWithFrontMatter); // true
With the YamlParser
, you can parse a string
, regardless of whether it has YAML front matter or not.
<?php declare(strict_types=1); use Ergebnis\FrontMatter; $parser = new FrontMatter\YamlParser(); $unparsedContentWithoutFrontMatter = FrontMatter\Content::fromString('Hello, how are you today?'); /** @var FrontMatter\Parsed $parsedWithoutFrontMatter */ $parsedWithoutFrontMatter = $parser->parse($unparsedContentWithoutFrontMatter); $unparsedContentWithFrontMatter = FrontMatter\Content::fromString(<<<TXT --- page: title: "Hello" description: "Good to see you, how can I help you?" --- TXT); /** @var FrontMatter\Parsed $parsedWithFrontMatter */ $parsedWithFrontMatter = $parser->parse($unparsedContentWithoutFrontMatter); var_dump($parsedWithFrontMatter->frontMatter()->data()->has('page.title')); // true var_dump($parsedWithFrontMatter->frontMatter()->data()->get('page.title')); // "Hello"
❗ The YamlParser
will throw an Ergebnis\FrontMatter\Exception\FrontMatterCanNotBeParsed
exception when the front matter is invalid YAML and an Ergebnis\FrontMatter\Exception\FrontMatterIsNotAnObject
exception when the front matter does not describe an object.
💡 The YamlParser
returns an Ergebnis\FrontMatter\Parsed
value object on success, regardless of whether the value has front matter or not.
Changelog
The maintainers of this project record notable changes to this project in a changelog.
Contributing
The maintainers of this project suggest following the contribution guide.
Code of Conduct
The maintainers of this project ask contributors to follow the code of conduct.
General Support Policy
The maintainers of this project provide limited support.
You can support the maintenance of this project by sponsoring @localheinz or requesting an invoice for services related to this project.
PHP Version Support Policy
This project supports PHP versions with active and security support.
The maintainers of this project add support for a PHP version following its initial release and drop support for a PHP version when it has reached the end of security support.
Security Policy
This project has a security policy.
License
This project uses the MIT license.
Credits
This project is inspired by webuni/front-matter
, originally licensed under MIT by Martin Hasoň.
Social
Follow @localheinz and @ergebnis on Twitter.