kleisli/fusionfiles

There is no license information available for the latest version (1.0.0) of this package.

Serve different file formats with Neos.Fusion

1.0.0 2023-04-26 13:08 UTC

Requires

• neos/fusion: *

Unknown License

README

Serve different file formats with Neos.Fusion

Available formats

• json
• ics
• pdf (with additional package Kleisli.FusionFiles.Pdf)

Json

To render a node My.NodeType as json, just add a fusion prototype My.NodeType.Json that extends Kleisli.FusionFiles:File.Json and add the json values to the data property.

Eel helper

This package has its own eel helper FusionFiles.Json to jsonify, because the core eel helper fails to replace the Neos cache markers correctly.

Example

prototype(My.App:Document.List.Json) < prototype(Kleisli.FusionFiles:File.Json) {
    data {
        value = 'ok'
        getValueFromPrototype = My.App:Component.ListAsArray
    }
}

on requesting https://your.domain/path/to/node.json the response will be something like

{
    "value" : "ok",
    "getValueFromPrototype" : [
        {"id": "abc"},
        {"id": "def"}
    ]
}

Ics Event

Make nodes representing an event addable to calendars.

To render a node My.Event as ics, just add a fusion prototype My.Event.Ics that extends Kleisli.FusionFiles:File.Ics.Event and add the event properties to the data property.

Example

prototype(My.App:Document.Event.Ics) < prototype(Kleisli.FusionFiles:File.Ics.Event) {
    data {
        startDateTime = ${node.properties.startDate}
        endDateTime = ${node.properties.endDate}
        title = ${node.properties.title}
    }
}

In the template of My.Event you can link the ICS file like:

<Neos.Neos:NodeLink node={documentNode} attributes.href.format="ics">
    Add to calendar
</Neos.Neos:NodeLink>

Use the helpers for other file formats

Add a Request.fusion file to your package with

root {
    // Hook into the root matcher to change rendering for fancy requests
    fancy = Kleisli.FusionFiles:Helper.RenderFileMatcher {
        fileExtension = 'fancy'
    }
}

to access the prototype

prototype(My.App:Document.List.Fancy) < prototype(Neos.Fusion:Component) {
    renderer = ''
}

via https://your.domain/path/to/node.fancy

Kudos

The development of this package has significantly been funded by Profolio - a digital platform for career choice & career counseling