Merge pull request #46 from ergonode/develop

Develop to Master

Author: wiewiurdp

docs/_sidebar.md

@@ -5,6 +5,7 @@
 <!--  * [**Backend - production**](installation/backend-production.md) -->
     * [**Frontend**](installation/frontend.md)
     * [**Docker - contribution**](installation/docker.md)
+    * [**Documentation**](installation/docs.md)
 * [**Backend**](backend.md)
     * [Architecture](backend/architecture.md)
     * [Coding standards](backend/coding_standards.md)
@@ -24,14 +25,44 @@
          * [Account](backend/modules/account.md)
          * [Core](backend/modules/core.md)
          * [Attribute](backend/modules/attribute.md)
-         * [Importer](backend/modules/importer.md) 
+         * [Importer](backend/modules/importer.md)
          * [Transformer](backend/modules/transformer.md)
     * [Configuration](backend/configuration.md)
     * [Tests](backend/tests.md)
     * [Changelog](backend/changelog.md)
 * [**Frontend**](frontend.md)
-    * [Architecture](frontend/architecture.md)
-    * [Quality](frontend/quality.md)
+    * [**Technologies**](frontend/technologies.md)
+    * [**Architecture**](frontend/architecture.md)
+        * [**Application structure**](frontend/architecture/app-structure.md)
+        * [**Module structure**](frontend/architecture/module-structure.md)
+    * [**Module configurations**](frontend/configurations.md)
+    * [**Modules**](frontend/modules.md)
+        * [**Core**](frontend/modules/core.md)
+        * [**Authentication**](frontend/modules/authentication.md)
+        * [**Users**](frontend/modules/users.md)
+        * [**Notifications**](frontend/modules/notifications.md)
+        * [**Attributes**](frontend/modules/attributes.md)
+        * [**Categories**](frontend/modules/categories.md)
+        * [**Products**](frontend/modules/products.md)
+        * [**Templates**](frontend/modules/templates.md)
+        * [**Product Statuses**](frontend/modules/statuses.md)
+        * [**Category Trees**](frontend/modules/tree.md)
+        * [**Activity Logs**](frontend/modules/activity_logs.md)
+        * [**Conditions**](frontend/modules/conditions.md)
+        * [**Collections**](frontend/modules/collections.md)
+        * [**Segments**](frontend/modules/segments.md)
+        * [**Status Transitions**](frontend/modules/transitions.md)
+        * [**Media**](frontend/modules/media.md)
+        * [**Comments**](frontend/modules/comments.md)
+        * [**Import**](frontend/modules/import.md)
+        * [**Channels**](frontend/modules/channels.md)
+        * [**Dashboard**](frontend/modules/dashboard.md)
+    * [**Cookbook**](frontend/cookbook.md)
+        * [**Create New Project**](frontend/cookbook/new_project.md)
+        * [**Create New Module**](frontend/cookbook/new_module.md)
+        * [**Extend Toolbar Menu**](frontend/cookbook/extend_toolbar_menu.md)
+    * [**In depth**](frontend/in-depth/in-depth.md)
+        * [**Autosave**](frontend/in-depth/autosave.md)
 * [**Community**](community.md)
     * [Contribution](community/contribution.md)
     * [Code of Conduct](community/code_of_conduct.md)

docs/backend/cookbook.md

@@ -10,5 +10,6 @@
 * [New Grid Column Type](backend/cookbook/new_grid_column_type.md)
 * [New Condition](backend/cookbook/new_condition.md)
 * [New Channel](backend/cookbook/new_channel.md)
+* [New Mass Action](backend/cookbook/new_mass_action.md)
 
 

docs/backend/cookbook/new_attribute.md

@@ -12,8 +12,9 @@ This file should live in `Your-module\Application\Form\Attribute\` namespace ext
 In Ergonode system we have several Abstract Attribute classes (you can find them in `Ergonode\Attribute\Domain\Entity\Attribute` namespace), it depends on what kind of attribute you want to create, you can either use one of already created or create a custom one. 
 
 Keep in mind that Abstract Attribute class should extend `\Ergonode\Attribute\Domain\Entity\AbstractAttribute`.
+
 ```php
-namespace Ergonode\Attribute\Domain\Entity\Attribute;
+namespace YourNameSpace\Domain\Entity\Attribute;
 
 /**
  */
@@ -22,7 +23,7 @@ class YourAttribute extends AbstractCollectionAttribute implements AttributeInte
     public const TYPE = 'YOUR_ATTRIBUTE';
 
     /**
-     * @JMS\virtualProperty();
+     * @JMS\VirtualProperty();
      * @JMS\SerializedName("type")
      *
      * @return string
@@ -42,7 +43,7 @@ Create a command for creation `CreateYourAttributeCommand`.
 This file should live in `Your-module\Domain\Command\Attribute\Create` namespace and extends `Ergonode\Attribute\Domain\Command\Attribute\AbstractCreateAttributeCommand`.
 
 ```php
-namespace Ergonode\Attribute\Domain\Command\Attribute\Create;
+namespace YourNameSpace\Domain\Command\Attribute\Create;
 
 /**
  */
@@ -55,9 +56,10 @@ Each command needs to have handler, class that handles the logic represented by
 
 Create a handler `CreateYourAttributeCommandHandler`.
 This file should live in `Your-module\Infrastructure\Handler\Attribute\Create` namespace.
+Remember to tag the handler with `messenger.message_handler`
 
 ```php
-namespace Ergonode\Attribute\Infrastructure\Handler\Attribute\Create;
+namespace YourNameSpace\Infrastructure\Handler\Attribute\Create;
 
 /**
  */
@@ -93,7 +95,7 @@ class CreateYourAttributeCommandHandler
         );
 
         foreach ($command->getGroups() as $group) {
-            $attribute->addGroup(new AttributeGroupId($group));
+            $attribute->addGroup($group);
         }
 
         $this->attributeRepository->save($attribute);
@@ -104,7 +106,7 @@ class CreateYourAttributeCommandHandler
 Create a command for update `UpdateYourAttributeCommand`.This file should live in `Your-module\Domain\Command\Attribute\Update` namespace and extends `Ergonode\Attribute\Domain\Command\Attribute\AbstractUpdateAttributeCommand`.
 
 ```php
-namespace Ergonode\Attribute\Domain\Command\Attribute\Update;
+namespace YourNameSpace\Domain\Command\Attribute\Update;
 
 /**
  */
@@ -114,9 +116,10 @@ class UpdateYourAttributeCommand extends AbstractUpdateAttributeCommand
 ```
 
 Create a handler `UpdateYourAttributeCommandHandler`.This file should live in `Your-module\Infrastructure\Handler\Attribute\Upadate` namespace.
+Remember to tag the handler with `messenger.message_handler`
 
 ```php
-namespace Ergonode\Attribute\Infrastructure\Handler\Attribute\Update;
+namespace YourNameSpace\Infrastructure\Handler\Attribute\Update;
 
 /**
  */
@@ -154,11 +157,11 @@ class UpdateYourAttributeCommandHandler extends AbstractUpdateAttributeCommandHa
 
 ## Command factories
 
-Create a handler  for creation command `CreateYourAttributeCommandFactory`.This file should live in `Your-module\Infrastructure\Factory\Command\Create` namespace and implements `Ergonode\Attribute\Infrastructure\Factory\Command\CreateAttributeCommandFactoryInterface`
-
+Create a handler for creation command `CreateYourAttributeCommandFactory`.This file should live in `Your-module\Infrastructure\Factory\Command\Create` namespace and implements `Ergonode\Attribute\Infrastructure\Factory\Command\CreateAttributeCommandFactoryInterface`
+If autoconfiguration is not used remember to tag your service with `component.attribute.create_attribute_command_factory_interface` 
 
 ```php
-namespace Ergonode\Attribute\Infrastructure\Factory\Command\Create;
+namespace YourNameSpace\Infrastructure\Factory\Command\Create;
 
 /**
  */
@@ -199,9 +202,10 @@ class CreateYourAttributeCommandFactory implements CreateAttributeCommandFactory
 ```
 
 Create a handler for updating command `UpdateYourAttributeCommandFactory`.This file should live in `Your-module\Infrastructure\Factory\Command\Update` namespace and implements `Ergonode\Attribute\Infrastructure\Factory\Command\UpdateAttributeCommandFactoryInterface`
+If autoconfiguration is not used remember to tag your service with `component.attribute.update_attribute_command_factory_interface`
 
 ```php
-namespace Ergonode\Attribute\Infrastructure\Factory\Command\Update;
+namespace YourNameSpace\Infrastructure\Factory\Command\Update;
 
 /**
  */
@@ -235,7 +239,7 @@ class UpdateYourAttributeCommandFactory implements UpdateAttributeCommandFactory
             new TranslatableString($data->hint),
             new TranslatableString($data->placeholder),
             new AttributeScope($data->scope),
-            $data->groups,
+            array_map(fn($group) => new AttributeGroupId($group), $data->groups),
         );
     }
 }
@@ -244,12 +248,11 @@ class UpdateYourAttributeCommandFactory implements UpdateAttributeCommandFactory
 ## Value Constrain Strategy
 
 To be able to validate values which are used in our new attribute `YourAttributeValueConstraintStrategy` needs to be created. This file should live in `Your-module\Infrastructure\Provider\Strategy` namespace and implements `Ergonode\Attribute\Infrastructure\Provider\AttributeValueConstraintStrategyInterface`
+If autoconfiguration is not used remember to tag your service with `component.attribute.attribute_validation_interface`
 
 ```php
-namespace Ergonode\Attribute\Infrastructure\Provider\Strategy;
+namespace YourNameSpace\Infrastructure\Provider\Strategy;
 
-/**
- */
 class YourAttributeValueConstraintStrategy implements AttributeValueConstraintStrategyInterface
 {
     /**
@@ -283,9 +286,10 @@ Create form class `YouAttributeForm`
 This file should live in `Your-module\Application\Form\Attribute` namespace and extends:
 * `Symfony\Component\Form\AbstractType`
 * `Ergonode\Attribute\Application\Form\Attribute\AttributeFormInterface`
+If autoconfiguration is not used remember to tag your service with `attribute.form.attribute_form_interface`
 
 ```php
-namespace Ergonode\Attribute\Application\Form\Attribute;
+namespace YourNameSpace\Application\Form\Attribute;
 
 class YourAttributeForm extends AbstractType implements AttributeFormInterface
 {
@@ -358,12 +362,36 @@ class YourAttributeForm extends AbstractType implements AttributeFormInterface
 
 If you want be able to use your attribute on a grid you need to create following classes.
 
+
+Create column class `YourAttributeColumn`
+
+This file should live in `Your-module\Grid\Column` namespace and extends `\Ergonode\Grid\Column\AbstractColumn`
+
+```php
+namespace YourNameSpace\Grid\Column;
+
+/**
+ */
+class YourColumn extends AbstractColumn
+{
+    public const TYPE = 'YOUR_ATTRIBUTE';
+
+    /**
+     * {@inheritDoc}
+     */
+    public function getType(): string
+    {
+        return self::TYPE;
+    }
+}
+```
+
 Create strategy class `YourAttributeColumnStrategy` 
 
 This file should live in `Your-module\Infrastructure\Grid\Column\Provider\Strategy` namespace and implements `Ergonode\Product\Infrastructure\Grid\Column\Provider\Strategy\AttributeColumnStrategyInterface`
 
 ```php
-namespace Ergonode\Product\Infrastructure\Grid\Column\Provider\Strategy;
+namespace YourNameSpace\Infrastructure\Grid\Column\Provider\Strategy;
 
 /**
  */
@@ -395,7 +423,7 @@ Create DataSet Builder class `YourAttributeDataSetQueryBuilder`
 This file should live in `Your-module\Infrastructure\Grid\Builder\Query` namespace and extends `Ergonode\Product\Infrastructure\Grid\Builder\Query\AbstractAttributeDataSetBuilder`
 
 ```php
-namespace Ergonode\Product\Infrastructure\Grid\Builder\Query;
+namespace YourNameSpace\Infrastructure\Grid\Builder\Query;
 
 /**
  */
@@ -411,25 +439,30 @@ class YourAttributeDataSetQueryBuilder extends AbstractAttributeDataSetBuilder
 }
 ```
 
-Create column class `YourAttributeColumn`
-
-This file should live in `Your-module\Grid\Column` namespace and extends `\Ergonode\Grid\Column\AbstractColumn`
+Create renderer class `YourAttributeColumnRenderer`
 
 ```php
-namespace Ergonode\Grid\Column;
+namespace YourNameSpace\Infrastructure\Grid\Column\Renderer;
 
 /**
  */
-class YourColumn extends AbstractColumn
+class YourAttributeColumnRenderer extends \Ergonode\Grid\Column\Renderer\ColumnRendererInterface
 {
-    public const TYPE = 'YOUR_ATTRIBUTE';
+    /**
+     * {@inheritDoc}
+     */
+    public function supports(ColumnInterface $column): bool
+    {
+        return $column instanceof YourAttributeColumn;
+    }
 
     /**
      * {@inheritDoc}
      */
-    public function getType(): string
+
+    public function render(ColumnInterface $column, string $id, array $row)
     {
-        return self::TYPE;
+        // TODO return your column value
     }
 }
 ```

docs/backend/cookbook/new_mass_action.md

@@ -0,0 +1,34 @@
+# How to create new mass action
+
+## Mass action processor class
+
+Any custom mass action process must implement ```BatchActionProcessorInterface``` 
+
+```php
+namespace YourNameSpace\Infrastructure\Processor;
+
+use Ergonode\BatchAction\Domain\Entity\BatchActionId;
+use Ergonode\BatchAction\Domain\ValueObject\BatchActionMessage;
+use Ergonode\BatchAction\Domain\ValueObject\BatchActionType;
+use Ergonode\BatchAction\Infrastructure\Provider\BatchActionProcessorInterface;
+use Ergonode\SharedKernel\Domain\AggregateId;
+
+class YourBatchActionProcessor implements BatchActionProcessorInterface
+{
+    public function supports(BatchActionType $type): bool
+    {
+        return $type->getValue() === 'you type';
+    }
+
+    /**
+     * @return BatchActionMessage[]
+     */    
+    public function process(BatchActionId $id, AggregateId $resourceId): array
+    {
+        // here implement your action for given AggregateId 
+    }
+}
+```
+
+If, for some reason, a mass action can't be processed for a given object, you can return information about it as array of ```BatchActionMessage``` objects
+In whole batch action this object is marked processed as unsuccessful.  

docs/backend/modules/api.md

@@ -0,0 +1,5 @@
+# Api
+
+-----
+
+Api module provides API related exception handling.

docs/backend/modules/authentication.md

@@ -0,0 +1,5 @@
+# Authentication
+
+----------------
+
+Authentication module provides JWT token authentication integration with `lexik/jwt-authentication-bundle`.

docs/backend/modules/category.md

@@ -0,0 +1,5 @@
+# Category
+
+----------
+
+Adds the possibility to create a tree structure of categories to organize products.

docs/backend/modules/comment.md

@@ -0,0 +1,5 @@
+# Comment
+
+---------
+
+The module brings the possibility to comment on different types of Ergonode resources. 

docs/backend/modules/completeness.md

@@ -0,0 +1,5 @@
+# Completeness
+
+--------------
+
+Provides statistics for completeness of product creation with needed translations.

docs/backend/modules/condition.md

@@ -0,0 +1,18 @@
+# Condition
+
+-----------
+
+Brings powerful abstraction and a handful of useful condition strategies implementation for different cases:
+* attribute exists
+* language completeness
+* numeric attribute value
+* option attribute value
+* product belongs to category
+* product belongs to category tree
+* product completeness
+* product has status
+* product has template
+* product sku exists
+* role exactly
+* test attribute value
+* user exactly

docs/backend/modules/designer.md

@@ -0,0 +1,5 @@
+# Designer
+
+----------
+
+Introduces functionality and management of product templates.

docs/backend/modules/editor.md

@@ -0,0 +1,5 @@
+# Editor
+
+--------
+
+The module gives the possibility to maintain product drafts.

docs/backend/modules/event-sourcing.md

@@ -0,0 +1,5 @@
+# Event-sourcing
+
+----------------
+
+The module provides an implementation for Event Sourcing with ready abstraction for Aggregates and Entities.

docs/backend/modules/exporter-file.md

@@ -0,0 +1,5 @@
+# Exporter file
+
+---------------
+
+Based on the `ergonode/exporter` the modules brings the possibility to export Ergonode PIM data to file.

docs/backend/modules/exporter-magento-2.md

@@ -0,0 +1,5 @@
+# Exporter Magento 2
+
+--------------------
+
+Export functionality compliant with Magento 2.