sitegeist / sitegeist.silhouettes Goto Github PK

Preconfigure property-silhouettes that can be applied to various properties of multiple NodeTypes.

License: GNU General Public License v3.0

PHP 100.00%

sitegeist.silhouettes's Introduction

Sitegeist.Silhouettes

Neos 7.0 includes the features of Sitegeist.Silhouettes as NodeType presets. This package will be abandoned in favor of that eventually!

Centralized property configuration for the Neos.ContentRepository

It is common that properties in various NodeTypes are expected to behave identically. This is usually achieved with mixins but those are bound to a fixed property name do not cover the case where properties with different names share similarities.

The Sitegeist.Silhouettes package uses preconfigured property-configurations from the settings in multiple NodeTypes. This adds a way to centralize property-configuration for cases where mixins are not sufficient and settings shall be synchronized betweeen properties with different names.

It is also possible to create silhouettes for childNode constraint configurations, e.g. to apply the same centralized constraints to different childNodes following the dry principle. This can also be useful when using a single NodeType package in different neos instances where the constraints may differcenate.

The settings from the configured silhouette are merged with the configuration that is found in the nodeType with the local configuration taking precedence over the silhouette.

Authors & Sponsors

Martin Ficzel - [email protected]

The development and the public-releases of this package is generously sponsored by our employer http://www.sitegeist.de.

Usage

Settings.yaml

Sitegeist:
  Silhouettes:
    properties:
      vendor:
        text:
          block:
            type: string
            defaultValue: ''
            ui:
              inlineEditable: true
              inline:
                editorOptions:
                  placeholder: '(( text block ))'
                  autoparagraph: true
                  linking:
                    anchor: true
                    title: true
                    relNofollow: false
                    targetBlank: false
                  formatting:
                    strong: true
                    em: true
                    u: false
                    underline: false
                    strikethrough: false
                    sub: false
                    sup: false
                    del: false
                    p: true
                    h1: false
                    h2: false
                    h3: false
                    h4: false
                    h5: false
                    h6: false
                    pre: false
                    removeFormat: true
                    left: false
                    right: false
                    center: false
                    justify: false
                    table: false
                    ol: false
                    ul: false
                    a: true
  
      childNodes:
        vendor:
          defaultConstraints:
            constraints:
              'Neos.Neos:Content': true
              'Neos.NodeTypes.BaseMixins:TitleMixin': true
              'Neos.Demo:Constraint.Content.Carousel': true
              'Neos.Demo:Constraint.Content.Column': false

NodeTypes.yaml

'Vendor.Package:NodeTypeName':
  childNodes:
    column1:
      options:
        silhouette: 'vendor.defaultConstraints'    
    column2:
      options:
        silhouette: 'vendor.defaultConstraints'    
  properties:
    description:
      ui:
        label: 'Description'
        inline:
          editorOptions:
            placeholder: 'please add description ... '
      options:
        silhouette: 'vendor.text.block'

Predefined silhouettes

text.plain: An inline editable string where no formatting is allowed.
text.block: An inline editable string where only inline formatting is enabled.
text.free: An inline editable string where all formatting including blocks is allowed.

Installation

Sitegeist.Silhouettes is available via packagist. Add "sitegeist/silhouettes" : "^1.0" to the require section of the composer.json or run composer require sitegeist/silhouettes.

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

Contribution

We will gladly accept contributions. Please send us pull requests.

sitegeist.silhouettes's People

Contributors

Stargazers

Watchers

Forkers

rolandschuetz d3k4y fiach paavo

sitegeist.silhouettes's Issues

Silhouette not working for Neos.NodeTypes:Text

The pre-defined silhouettes (text.plain, text.block, text.free) and my own are working fine with everything but Neos.NodeTypes:Text.

'Neos.NodeTypes:Text':
  properties:
    text:
      options:
        silhouette: 'text.free'

(referencing https://github.com/sitegeist/Sitegeist.Silhouettes/blob/master/Configuration/Settings.yaml#L58)

We've got this with 2 Neos 5.2 sites. Can anyone reproduce this?

Silhouettes is applied after configuration enrichment, but needs to be applied first

The NodeTypeConfigurationEnrichmentAspect enriches the property configuratiuon with dataType-specific default values. This is triggered via `@Flow\Around("method(Neos\ContentRepository\Domain\Model\NodeType->__construct())").

Sihouettes postprocess is called after the media enrichment and therefore misses the vital defaults.

This is the reason for the following two bugs:
#2 It's not possible to use translations
#3 It's not possible to use ImageInterface as property type

Manual Test Case:
Settings.yaml

Sitegeist:
  Silhouettes:
    properties:
      viennajs:
        image:
          type: Neos\Media\Domain\Model\ImageInterface
          ui:
            label: i18n
            reloadIfChanged: true
            inspector:
              group: 'general'
              position: 50

Test Properties:

  properties:
    image:
      options:
        silhouette: 'viennajs.image'
    imageHalf:
      type: Neos\Media\Domain\Model\ImageInterface
      ui:
        inspector:
          position: 50
      options:
        silhouette: 'viennajs.image'
    imageFull:
      type: Neos\Media\Domain\Model\ImageInterface
      ui:
        label: i18n
        reloadIfChanged: true
        inspector:
          group: 'general'
          position: 50

Expected result for all three cases:

    image:
      type: Neos\Media\Domain\Model\ImageInterface
      ui:
        label: Image
        reloadIfChanged: true
        inspector: { editorOptions: { fileUploadLabel: 'Neos.Neos:Main:choose', maximumFileSize: null, features: { crop: true, upload: true, mediaBrowser: true, resize: false }, crop: { aspectRatio: { options: { square: { width: 1, height: 1, label: Square }, fourFive: { width: 4, height: 5 }, fiveSeven: { width: 5, height: 7 }, twoThree: { width: 2, height: 3 }, fourThree: { width: 4, height: 3 }, sixteenNine: { width: 16, height: 9 } }, enableOriginal: true, allowCustom: true, locked: { width: 0, height: 0 } } } }, typeConverter: Neos\Neos\Ui\TypeConverter\UiDependentImageSerializer, editor: Neos.Neos/Inspector/Editors/ImageEditor, group: general, position: 50 }

Actual result:

    image:
      type: Neos\Media\Domain\Model\ImageInterface
      ui:
        label: i18n
        reloadIfChanged: true
        inspector: { group: general, position: 50 }
      options:
        silhouette: viennajs.image
    imageHalf:
      type: Neos\Media\Domain\Model\ImageInterface
      ui:
        label: i18n
        reloadIfChanged: true
        inspector: { group: general, position: 50, editorOptions: { fileUploadLabel: 'Neos.Neos:Main:choose', maximumFileSize: null, features: { crop: true, upload: true, mediaBrowser: true, resize: false }, crop: { aspectRatio: { options: { square: { width: 1, height: 1, label: Square }, fourFive: { width: 4, height: 5 }, fiveSeven: { width: 5, height: 7 }, twoThree: { width: 2, height: 3 }, fourThree: { width: 4, height: 3 }, sixteenNine: { width: 16, height: 9 } }, enableOriginal: true, allowCustom: true, locked: { width: 0, height: 0 } } } }, typeConverter: Neos\Neos\Ui\TypeConverter\UiDependentImageSerializer, editor: Neos.Neos/Inspector/Editors/ImageEditor }
      options:
        silhouette: viennajs.image
    imageFull:
      type: Neos\Media\Domain\Model\ImageInterface
      ui:
        label: 'ViennaJS.Site:NodeTypes.Document.Event:properties.imageFull'
        reloadIfChanged: true
        inspector: { editorOptions: { fileUploadLabel: 'Neos.Neos:Main:choose', maximumFileSize: null, features: { crop: true, upload: true, mediaBrowser: true, resize: false }, crop: { aspectRatio: { options: { square: { width: 1, height: 1, label: Square }, fourFive: { width: 4, height: 5 }, fiveSeven: { width: 5, height: 7 }, twoThree: { width: 2, height: 3 }, fourThree: { width: 4, height: 3 }, sixteenNine: { width: 16, height: 9 } }, enableOriginal: true, allowCustom: true, locked: { width: 0, height: 0 } } } }, typeConverter: Neos\Neos\Ui\TypeConverter\UiDependentImageSerializer, editor: Neos.Neos/Inspector/Editors/ImageEditor, group: general, position: 50 }

It's not possible to use translations

Currently it is not possible to add i18n labels to Settings.yaml:

Would be nice if this would be possible :)

Feature: Use multiple Silhouettes

I'd love to have multiple Silhouettes for one single property.
Or is there already a way @mficzel ?

    image:
      options:
        silhouette:
          - 'vendor.image.square'
          - 'vendor.message.sync'

It's not possible to use ImageInterface as property type

The use of Neos\Media\Domain\Model\ImageInterface as property type results in a Missing editor definition error.

Sitegeist:
  Silhouettes:
    properties:
      vendor:
        image:
          plain:
            type: Neos\Media\Domain\Model\ImageInterface
            ui:
              reloadIfChanged: true
              inspector:
                group: 'image'
                position: 10

  properties:
    image:
      ui:
        label: i18n
        inspector:
          group: 'image'
          position: 10
      options:
        silhouette: 'vendor.image.plain'

Inherit from another Silhouette

Is there a way, to inherit from another Silhouette?
Maybe @mficzel has an idea?

Sitegeist:
  Silhouettes:
    properties:
      vendor:
        image:

          # vendor.image.plain
          plain:
            type: Neos\Media\Domain\Model\ImageInterface
            ui:
              label: 'Image'
              reloadIfChanged: true
              inspector:
                group: image

          # vendor.image.square
          square:
            # inherit from another silhouette
            options:
              silhouette: 'vendor.image.plain'
            # customize settings
            ui:
              label: 'Image square'

1.1.0 prevents Neos 4.3. from booting

After upgrading to 1.1.0 on Neos 4.3.13 the site will die during bootstrap.

Can you reproduce this? Or is there something wrong with our configuration? Site works fine with 1.0.3

Exception in line 46 of /var/www/Neos/releases/2020-05-15__09-56-36/Data/Temporary/Production/Cache/Code/Flow_Object_Classes/Sitegeist_Silhouettes_ContentRepository_SilhouettesNodeTypePostProcessor.php: Argument 1 passed to Neos\Utility\Arrays::getValueByPath() must be of the type array, null given, called in /var/www/Neos/releases/2020-05-15__09-56-36/Data/Temporary/Production/Cache/Code/Flow_Object_Classes/Sitegeist_Silhouettes_ContentRepository_SilhouettesNodeTypePostProcessor.php on line 46