packagefactory/atomicfusion-constants

This package is abandoned and no longer maintained. No replacement package was suggested.
There is no license information available for the latest version (v1.0.0) of this package.

Language construct for constants as an addition to Neos.Fusion

v1.0.0 2018-04-11 15:26 UTC

This package is auto-updated.

Last update: 2022-11-24 16:01:33 UTC


README

Constants as a language construct for fusion

Warning!

This is experimental technology. Constants are currently not part of the fusion language. You can however install this package to make this functionality available to your project.

Our goal is to make this part of the fusion core in the future. It is very likely though, that Syntax, Scoping and implementation details will deviate from what is presented here.

Installation

PackageFactory.AtomicFusion.Constants is available via packagist. You can install this package with composer:

composer require packagefactory/atomicfusion-constants

We use semantic-versioning so every breaking change will increase the major-version number.

Usage

This package introduces the const: declaration, that let's you define constants within a fusion file. With const::* you can use the defined constant anywhere in your fusion file:

const: PI = 3.14

prototype(Vendor.Site:MyCircleArea) < prototype(PackageFactory.AtomicFusion:Component) {
	radius = 5
	renderer = ${const::PI * props.radius * props.radius}
}

Constants are scoped to the file they are defined in and cannot be overwritten or redeclared within that file.

Constant names need to be ALL_UPPERCASE and can contain letters, numbers and underscores. A name needs to start with either a letter or an underscore.

Magic Constants

__FILE__

Similar to PHP's __FILE__ constant, you can use const::__FILE__ to reference the location of the current fusion file.

prototype(Vendor.Site:MyContentElement) < prototype(Neos.Fusion:Template) {
	@process.attachFileName = ${value + '<br>Brought to you by ' + const::__FILE__}
}

__DIR__

Similar to PHP's __DIR__ constant, you can use const::__DIR__ to reference the directory of the current fusion file.

prototype(Vendor.Site:MyContentElement) < prototype(Neos.Fusion:Template) {
	templatePath = ${const::__DIR__ + '/MyContentElement.html'}
}

License

see LICENSE file