Skip to content

Commit 2f7555b

Browse files
committed
DOCS: Update readme
1 parent 3bc9ece commit 2f7555b

File tree

1 file changed

+11
-9
lines changed

1 file changed

+11
-9
lines changed

README.md

Lines changed: 11 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -4,26 +4,28 @@
44

55
Autogenerate php classes and interfaces for NodeTypes with type safe property accessor methods that allow full static analysis.
66

7-
- NodeTypeObject are created for each non abstract NodeType in the namespace of the given package.
8-
- NodeTypeObjects are stored in the `NodeTypes` folder using all parts of the NodeTypeName as folders
9-
- The namespace of each NodeTypeObject is derived from the package-key with added ``NodeTypes`
10-
- The className of a NodeTypeObject is defined by the last part of the NodeTypeName with postfix `NodeTypeObject`
7+
- NodeObjects are created for each non abstract NodeType in the namespace of the given package.
8+
- NodeInterfaces are created for each NodeType in the namespace of the given package.
9+
- NodeObjects and NodeInterfaces are stored in the `NodeTypes` folder using all parts of the NodeTypeName as folders
10+
- The namespace of each NodeTypeObject/NodeInterface is derived from the package-key with added ``NodeTypes`
11+
- The className of a NodeObject is defined by the last part of the NodeTypeName with postfix `NodeObject`
12+
- The interfaceName of a NodeInterface is defined by the last part of the NodeTypeName with postfix `NodeInterface`
1113

1214
## Preconditions
1315

14-
The following preconditions have to be met for a package to use NodeTypeObjects.
16+
The following preconditions have to be met for a package to use NodeObject.
1517

1618
- The php namespace of the package is directly derived from the Neos package key. As is the default and best practice.
1719
- The Package registers a PSR4 Namespace for `NodeTypes` in the `composer.json` that points to the `NodeTypes` folder.
18-
- The pattern `*NodeTypeObject.php` is added to `.gitignore` to avoid committing the generated files.
19-
- The commands `nodetypeobjects:build` and `nodetypeobjects:clean` are integrated into build processes and watchers
20+
- The pattern `NodeTypes/**/*NodeObject.php` and `NodeTypes/**/*NodeInterface.php` are added to `.gitignore` to avoid committing the generated files.
21+
- The commands `nodeobjects:build` and `nodeobjects:clean` are integrated into build processes and watchers
2022

2123
## Usage
2224

2325
The package defines the following cli commands
2426

25-
- `./flow nodetypeobjects:build Vendor.Site` : regenerate all NodeTypeObject in the given package.
26-
- `./flow nodetypeobjects:clean Vendor.Site` : remove all NodeTypeObject in the given package. This will also remove orphaned NodeObjects.
27+
- `./flow nodeobjects:build Vendor.Site` : regenerate all NodeObject in the given package.
28+
- `./flow nodeobjects:clean Vendor.Site` : remove all NodeObject in the given package. This will also remove orphaned NodeObjects.
2729

2830
## Installation
2931

0 commit comments

Comments
 (0)