Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/decodelabs/metamorph
A flexible framework for content transformations
https://github.com/decodelabs/metamorph
content-transformation markdown php
Last synced: 1 day ago
JSON representation
A flexible framework for content transformations
- Host: GitHub
- URL: https://github.com/decodelabs/metamorph
- Owner: decodelabs
- License: mit
- Created: 2022-03-11T17:58:46.000Z (almost 3 years ago)
- Default Branch: develop
- Last Pushed: 2024-09-04T21:26:50.000Z (4 months ago)
- Last Synced: 2024-12-29T19:08:51.831Z (11 days ago)
- Topics: content-transformation, markdown, php
- Language: PHP
- Homepage:
- Size: 75.2 KB
- Stars: 0
- Watchers: 3
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
Awesome Lists containing this project
README
# Metamorph
[](https://packagist.org/packages/decodelabs/metamorph)
[](https://packagist.org/packages/decodelabs/metamorph)
[](https://packagist.org/packages/decodelabs/metamorph)
[](https://github.com/decodelabs/metamorph/actions/workflows/integrate.yml)
[](https://github.com/phpstan/phpstan)
[](https://packagist.org/packages/decodelabs/metamorph)
### A flexible framework for content transformations
Metamorph provides an extensible framework for transforming content from one format to another through a simple and intuitive interface.
_Get news and updates on the [DecodeLabs blog](https://blog.decodelabs.com)._
---
## Installation
```bash
composer require decodelabs/metamorph
```
## Usage
### Importing
Metamorph uses [Veneer](https://github.com/decodelabs/veneer) to provide a unified frontage under DecodeLabs\Metamorph.
You can access all the primary functionality via this static frontage without compromising testing and dependency injection.
### Transformations
Use the Metamorph frontage to manipulate and output different formats of content.
Options can be passed as the second parameter and named macros allow for bundles of options to be passed as part of the call.
Metamorph uses [Archetype](https://github.com/decodelabs/archetype) to load `Handler` classes - the base package comes with a small set of handlers out of the box:
### Markdown
The built-in Markdown Handler will use whichever appropriate Markdown library has been installed via composer.
```php
use DecodeLabs\Metamorph;
// Default Markdown renders
echo Metamorph::markdown($markdownContent);
// Ensure output is secure from exploits with "safe" macro
echo Metamorph::{'markdown.safe'}($markdownContent);
// Output inline markup
echo Metamorph::{'markdown.inline'}($markdownContent);
```
### Text
The Text Handler considers input to be plain text and allows for various manipulations.
HTML wrapping is turned on by default, converting the text to Tagged Markup.
```php
echo Metamorph::text('Hello world', [
'maxLength' => 5 // shorten output with ellipsis
'ellipsis' => '...' // Character(s) used while shortening string (optional)
'wrap' => true // Wrap output as HTML markup
]);
// wrap=false
echo Metamorph::{'text.raw'}($longText);
// maxLength=50, wrap=true
echo Metamorph::{'text.preview'}($longText);
// maxLength=50, wrap=false
echo Metamorph::{'text.preview.raw'}($longText);
```
### HtmlToText
The HtmlToText Handler works in the opposite direction, taking HTML input and converting it to readable plain text.
```php
echo Metamorph::htmlToText('
This is an HTML paragraph
', [
'maxLength' => 5 // shorten stripped output with ellipsis
'ellipsis' => '...' // Character(s) used while shortening string (optional)
'wrap' => true // Wrap the stripped text in Markup element
]);
// Strip and re-wrap HTML
echo Metamorph::{'htmlToText.wrap'}($html);
// maxLength=50, wrap=true
echo Metamorph::{'htmlToText.preview'}($html);
```
## Other implementations
See [Idiom](https://github.com/decodelabs/idiom) and [Chirp](https://github.com/decodelabs/chirp) for other custom implementations of Metamorph Handlers.
## Licensing
Metamorph is licensed under the MIT License. See [LICENSE](./LICENSE) for the full license text.