Skip to content

Commit b8a81ed

Browse files
authored
Merge pull request #12 from kdambekalns/style-tweaks
TASK: Use PSR-4, adjust README, tweak composer manifest
2 parents 40c0ba5 + dbe9c97 commit b8a81ed

File tree

8 files changed

+21
-20
lines changed

8 files changed

+21
-20
lines changed

Classes/Flowpack/ElasticSearch/ContentRepositoryQueueIndexer/Command/NodeIndexQueueCommandController.php renamed to Classes/Command/NodeIndexQueueCommandController.php

File renamed without changes.

Classes/Flowpack/ElasticSearch/ContentRepositoryQueueIndexer/Domain/Repository/NodeDataRepository.php renamed to Classes/Domain/Repository/NodeDataRepository.php

File renamed without changes.

Classes/Flowpack/ElasticSearch/ContentRepositoryQueueIndexer/Indexer/NodeIndexer.php renamed to Classes/Indexer/NodeIndexer.php

File renamed without changes.

Classes/Flowpack/ElasticSearch/ContentRepositoryQueueIndexer/IndexingJob.php renamed to Classes/IndexingJob.php

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -6,8 +6,8 @@
66
use Flowpack\JobQueue\Common\Job\JobInterface;
77
use Flowpack\JobQueue\Common\Queue\Message;
88
use Flowpack\JobQueue\Common\Queue\QueueInterface;
9+
use Neos\ContentRepository\Domain\Model\NodeData;
910
use Neos\Flow\Annotations as Flow;
10-
use Neos\Flow\Log\SystemLoggerInterface;
1111
use Neos\Flow\Utility\Algorithms;
1212
use Neos\ContentRepository\Domain\Factory\NodeFactory;
1313
use Neos\ContentRepository\Domain\Model\NodeInterface;

Classes/Flowpack/ElasticSearch/ContentRepositoryQueueIndexer/LoggerTrait.php renamed to Classes/LoggerTrait.php

File renamed without changes.

Classes/Flowpack/ElasticSearch/ContentRepositoryQueueIndexer/UpdateAliasJob.php renamed to Classes/UpdateAliasJob.php

File renamed without changes.

README.md

Lines changed: 16 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,14 @@
1-
# Neos CMS ElasticSearch indexer based on beanstalkd (job queue)
1+
# Neos CMS Elasticsearch indexer based on a job queue
22

3-
This package can be used to index a huge amount of nodes in ElasticSearch indexes. This
4-
package use Beanstalkd and the JobQueue package to handle ES indexing asynchronously.
3+
This package can be used to index a huge amount of nodes in Elasticsearch indexes. This
4+
package use the Flowpack JobQueue packages to handle the indexing asynchronously.
55

66
# Breaking change after an upgrade to 3.0
77

8-
## Install and configure your Queue package
8+
Previously the Beanstalk queue package was installed by default, this is no longer
9+
the case.
10+
11+
# Install and configure your Queue package
912

1013
You need to install the correct Queue package based on your needs.
1114

@@ -18,10 +21,10 @@ Available packages:
1821

1922
Please check the package documentation for specific configurations.
2023

21-
The default configuration use Beanstalkd, but you need to install it manually:
24+
The default configuration uses Beanstalkd, but you need to install it manually:
2225

2326
composer require flowpack/jobqueue-beanstalkd
24-
27+
2528
Check the ```Settings.yaml``` to adapt based on the Queue package, you need to adapt the ```className```:
2629

2730
Flowpack:
@@ -30,18 +33,16 @@ Check the ```Settings.yaml``` to adapt based on the Queue package, you need to a
3033
queues:
3134
'Flowpack.ElasticSearch.ContentRepositoryQueueIndexer':
3235
className: 'Flowpack\JobQueue\Beanstalkd\Queue\BeanstalkdQueue'
33-
36+
3437
'Flowpack.ElasticSearch.ContentRepositoryQueueIndexer.Live':
3538
className: 'Flowpack\JobQueue\Beanstalkd\Queue\BeanstalkdQueue'
3639

37-
38-
3940
# Batch Indexing
4041

4142
## How to build indexing job
4243

4344
flow nodeindexqueue:build --workspace live
44-
45+
4546
## How to process indexing job
4647

4748
You can use this CLI command to process indexing job:
@@ -56,20 +57,20 @@ You can disable async live indexing by editing ```Settings.yaml```:
5657
ElasticSearch:
5758
ContentRepositoryQueueIndexer:
5859
enableLiveAsyncIndexing: false
59-
60+
6061
You can use this CLI command to process indexing job:
6162

62-
flow nodeindexqueue:work --queue live
63+
flow nodeindexqueue:work --queue live
6364

6465
# Supervisord configuration
6566

6667
You can use tools like ```supervisord``` to manage long runing process. Bellow you can
6768
found a basic configuration:
6869

6970
[supervisord]
70-
71+
7172
[supervisorctl]
72-
73+
7374
[program:elasticsearch_batch_indexing]
7475
command=php flow nodeindexqueue:work --queue batch
7576
stdout_logfile=AUTO
@@ -80,7 +81,7 @@ found a basic configuration:
8081
autostart=true
8182
autorestart=true
8283
stopsignal=QUIT
83-
84+
8485
[program:elasticsearch_live_indexing]
8586
command=php flow nodeindexqueue:work --queue live
8687
stdout_logfile=AUTO

composer.json

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,15 +1,15 @@
11
{
22
"name": "flowpack/elasticsearch-contentrepositoryqueueindexer",
3-
"type": "typo3-flow-package",
4-
"description": "Neos CMS ElasticSearch indexer based on beanstalkd (job queue)",
3+
"type": "neos-package",
4+
"description": "Neos CMS Elasticsearch indexer based on a job queue",
55
"license": "MIT",
66
"require": {
77
"flowpack/jobqueue-common": "^2.0.0",
88
"flowpack/elasticsearch-contentrepositoryadaptor": "^4.0.0"
99
},
1010
"autoload": {
11-
"psr-0": {
12-
"Flowpack\\ElasticSearch\\ContentRepositoryQueueIndexer": "Classes"
11+
"psr-4": {
12+
"Flowpack\\ElasticSearch\\ContentRepositoryQueueIndexer\\": "Classes"
1313
}
1414
},
1515
"extra": {

0 commit comments

Comments
 (0)