neos / metadata-contentrepositoryadapter
Maps asset meta data to CR nodes
Fund package maintenance!
shop.neos.io/neosfunding
Installs: 5 980
Dependents: 0
Suggesters: 0
Security: 0
Stars: 3
Watchers: 3
Forks: 4
Open Issues: 1
Type:neos-package
Requires
- php: ^7.4 || ^8.0
- neos/content-repository: ^3.0 || ^4.0 || ^5.0 || ^7.0 || ^8.0 || dev-master
- neos/eel: ^4.0 || ^5.0 || ^6.0 || ^7.0 || ^8.0 || dev-master
- neos/flow: ^4.0 || ^5.0 || ^6.0 || ^7.0 || ^8.0 || dev-master
- neos/fusion: ^3.0 || ^4.0 || ^5.0 || ^7.0 || ^8.0 || dev-master
- neos/media: ^3.0 || ^4.0 || ^5.0 || ^7.0 || ^8.0 || dev-master
- neos/metadata: ^2.0 || dev-master
Suggests
- neos/metadata-extractor: Extracts meta data from Assets
README
Neos.MetaData.ContentRepositoryAdapter Package
This package handles the mapping of meta data DTOs to the Neos Content Repository.
It provides three main features:
- Configurable mapping of the meta data DTOs to MetaData node types.
- FlowQuery operation to query for assets by their meta data.
- Eel helper to load the meta data nodes for any existing asset object.
Installation
Install using composer:
composer require neos/metadata-contentrepositoryadapter
Some related packages are:
neos/metadata
: Provides provides data types and interfaces (and is automatically installed with this package)neos/metadata-extractor
: Provides CLI and realtime meta data extraction on assets
Configuration
The package provides a way to store asset meta data in nodes, so it can be used in an application.
Usage
The package does not in itself change the way metadata is handled. Instead it provides ways for other packages to interact with meta data of assets.
- Install the package
- Extract the meta data (f.e. with suggested
neos/metadata-extractor
) - Use the meta data in FlowQuery or Eel
Examples
Custom meta data node types
Create a NodeType inheriting from Neos.MetaData:AbstractMetaData
. Most of the time you will be
inheriting from Neos.MetaData:Asset
.
'Vendor.Namespace:Type': superTypes: 'Neos.MetaData:Asset': true properties: yourProperty: mapping: '${yourDto.yourProperty}'
Specify the media types for which your NodeType will be used for.
Neos: MetaData: ContentRepositoryAdapter: mapping: nodeTypeMappings: 'type/subtype': 'Vendor.Namespace:Type' 'type/otherSubtype': 'Vendor.Namespace:Type'
Eel
Find the meta data of an asset - here of the node property image
:
prototype(Neos.NodeTypes:Image) {
imageMetaDataNode = ${MetaData.find(q(node).property('image'), node)}
imageTitle = ${q(this.imageMetaDataNode).property('title')}
}
FlowQuery
Get all meta data nodes matching the filter:
collection = ${q(assets).children('[instanceof Neos.MetaData:Exif][artist*="Daniel Lienert"]').get()}
Get the assets referenced by those meta data nodes:
assets = ${q(this.collection).getAssets()}