https://github.com/smichaelsen/fluid-signature

https://github.com/smichaelsen/fluid-signature

Last synced: 30 days ago
JSON representation

• Host: GitHub
• URL: https://github.com/smichaelsen/fluid-signature
• Owner: smichaelsen
• License: gpl-2.0
• Created: 2021-05-25T18:56:50.000Z (over 3 years ago)
• Default Branch: main
• Last Pushed: 2021-05-26T20:39:00.000Z (over 3 years ago)
• Last Synced: 2024-04-24T16:09:00.321Z (8 months ago)
• Language: PHP
• Size: 10.7 KB
• Stars: 2
• Watchers: 2
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: Readme.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# Fluid Signature

Define expected variables of fluid templates.

> **Warning**: 

> Fluid has a [similiar functionality](https://github.com/NamelessCoder/Fluid/blob/master/src/ViewHelpers/ParameterViewHelper.php) in version 3.x and plans to have it also in 2.x. This solution is not compatible with what might become available in TYPO3 soon. If you want to migrate to the native functionality later it will be manual labor.

## Why?

Fluid often silently fails when you forget to pass a variable to a template, because any undefined variable will just evaluate as null.

````

Hello {firstName} {lastName}!

````

=> Hello Kasper !

On the other hand fluid also doesn't care if you pass variables to a template that aren't used.

````

Hello {firstName}!

````

=> Hello Kasper!

That means passing too many or too few variables or mistyping their name is a common source of error.

## Solution

By using an `` tag you can define the expected variables at a certain point in your fluid code.

````

    

    Hello {firstName} {lastName}{f:if(condition: country, then: ' from {country}')}!

=> ❌ Exception: Required fluid variable lastName is not available

=> ❌ Exception: Variable profession was provided but not allowed

=> ✅ Hello Kasper Skårhøj!

=> ✅ Hello Kasper Skårhøj from Denmark!

````

## Attributes

`required`: Comma separated list of variables. If given, an exception is thrown if any of the variables in not defined in the current variable context.

`allowed`: Comma separated list of variables. If given the current variable context is checked for any variables that are not in `required` or `allowed` and an exception is thrown if a variable is found. `allowed=""` means only the `required` variables are allowed.

`defaultValues`: Associative array. `defaultValues="{country: 'Iceland'}"` means `country` will be set to `Iceland` if it is not defined in the current variable context.

## Installation

`composer require smic/fluid-signature dev-main`

The package is tested with TYPO3 v10, but should be compatible from v8 to v11.

I'll accept bug reports for TYPO3 v10 and v11 and pull requests for earlier versions.