From 60c65db6932a00f065cd85beef6344e8ec9c9ab2 Mon Sep 17 00:00:00 2001 From: Martin Ficzel Date: Wed, 7 Dec 2016 14:58:48 +0100 Subject: [PATCH 1/2] TASK: Prepare comments and readme for release --- .../ComponentImplementation.php | 24 ++++++++++++++----- README.md | 11 +++++++++ composer.json | 4 ++-- 3 files changed, 31 insertions(+), 8 deletions(-) diff --git a/Classes/PackageFactory/AtomicFusion/TypoScriptObjects/ComponentImplementation.php b/Classes/PackageFactory/AtomicFusion/TypoScriptObjects/ComponentImplementation.php index fb4dc5a..298fcda 100644 --- a/Classes/PackageFactory/AtomicFusion/TypoScriptObjects/ComponentImplementation.php +++ b/Classes/PackageFactory/AtomicFusion/TypoScriptObjects/ComponentImplementation.php @@ -1,30 +1,42 @@ + * Martin Ficzel + * + * This package is Open Source Software. For the full copyright and license + * information, please view the LICENSE file which was distributed with this + * source code. + */ + use TYPO3\Flow\Annotations as Flow; use TYPO3\TypoScript\TypoScriptObjects\ArrayImplementation; /** * A TypoScript Component-Object * - * All properties except ``value`` are pushed into a context variable ``props`` - * with that context the value is rendered + * All properties except ``renderer`` are pushed into a context variable ``props`` + * afterwards the ``renderer`` is evaluated * - * //tsPath value The variable to display a dump of. + * //tsPath renderer The variable to display a dump of. + * //tsPath * generic Fusion values that will be added to the ``props`` object in the context * @api */ class ComponentImplementation extends ArrayImplementation { /** - * If you iterate over "properties" these in here should usually be ignored. - * For example additional properties in "Case" that are not "Matchers". + * Properties that are ignored and added to the props * * @var array */ protected $ignoreProperties = ['__meta', 'renderer']; /** - * Return render value with the properties as ``props`` in the context + * Evaluate the fusion-keys as props and afterwards the renderer * * @return void|string */ diff --git a/README.md b/README.md index 9f77e49..a377f59 100644 --- a/README.md +++ b/README.md @@ -33,3 +33,14 @@ prototype(Vendor.Site:Component) < prototype(PackageFactory.AtomicFusion:Compone } } ``` + +## Installation + +PackageFactory.AtomicFusion is available via packagist. Just add `"packagefactory/atomicfusion" : "~1.0"` to the +require-dev section of the composer.json or run `composer require packagefactory/atomicfusion`. + +We use semantic-versioning so every breaking change will increase the major-version number. + +## License + +see [LICENSE file](LICENSE) diff --git a/composer.json b/composer.json index 5a7eb80..19f33ee 100644 --- a/composer.json +++ b/composer.json @@ -1,10 +1,10 @@ { + "name": "packagefactory/atomicfusion", "description": "Prototypes that help implementing atomic-design and a component-architecture in Neos.Fusion", "type": "neos-package", "require": { - "typo3/flow": "*" + "typo3/typoscript": "~2.3.0" }, - "name": "packagefactory/atomicfusion", "autoload": { "psr-0": { "PackageFactory\\AtomicFusion": "Classes/" From 13bcd09737000f7df55f88b908265b8d16ec08dc Mon Sep 17 00:00:00 2001 From: Martin Ficzel Date: Wed, 7 Dec 2016 15:01:38 +0100 Subject: [PATCH 2/2] TASK: Improve comment --- .../AtomicFusion/TypoScriptObjects/ComponentImplementation.php | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/Classes/PackageFactory/AtomicFusion/TypoScriptObjects/ComponentImplementation.php b/Classes/PackageFactory/AtomicFusion/TypoScriptObjects/ComponentImplementation.php index 298fcda..a030eb8 100644 --- a/Classes/PackageFactory/AtomicFusion/TypoScriptObjects/ComponentImplementation.php +++ b/Classes/PackageFactory/AtomicFusion/TypoScriptObjects/ComponentImplementation.php @@ -36,7 +36,8 @@ class ComponentImplementation extends ArrayImplementation protected $ignoreProperties = ['__meta', 'renderer']; /** - * Evaluate the fusion-keys as props and afterwards the renderer + * Evaluate the fusion-keys and transfer the result into the context as ``props`` + * afterwards evaluate the ``renderer`` with this context * * @return void|string */