Merge pull request #28 from superbrave/exporter-doc

Fixed the exporter documentation

DependencyInjection/SuperbraveGdprExtension.php

@@ -43,6 +43,7 @@ public function load(array $configs, ContainerBuilder $container)
 
         $loader = new Loader\YamlFileLoader($container, new FileLocator(__DIR__.'/../Resources/config'));
         $loader->load('services.yml');
+        $loader->load('services.exporter.types.yml');
         $loader->load('services.anonymizer.types.yml');
     }
 }

Resources/config/services.exporter.types.yml

@@ -0,0 +1,22 @@
+services:
+    _defaults:
+        public: false
+
+    superbrave_gdpr.exporter.serializer.normalizer.export_annotation:
+        class: Superbrave\GdprBundle\Serializer\Normalizer\AnnotationNormalizer
+        arguments:
+            - "@superbrave_gdpr.annotation.reader"
+            - "Superbrave\\GdprBundle\\Annotation\\Export"
+            - "@superbrave_gdpr.property_manipulator"
+        tags:
+            - { name: "superbrave_gdpr.serializer.normalizer" }
+
+    superbrave_gdpr.exporter.serializer.encoder.xml:
+        class: Symfony\Component\Serializer\Encoder\XmlEncoder
+        tags:
+            - { name: "superbrave_gdpr.serializer.encoder" }
+
+    superbrave_gdpr.exporter.serializer.encoder.json:
+        class: Symfony\Component\Serializer\Encoder\JsonEncoder
+        tags:
+            - { name: "superbrave_gdpr.serializer.encoder" }

Resources/config/services.yml

@@ -25,25 +25,6 @@ services:
             - !tagged "superbrave_gdpr.serializer.normalizer"
             - !tagged "superbrave_gdpr.serializer.encoder"
 
-    superbrave_gdpr.exporter.serializer.normalizer.export_annotation:
-        class: Superbrave\GdprBundle\Serializer\Normalizer\AnnotationNormalizer
-        arguments:
-            - "@superbrave_gdpr.annotation.reader"
-            - "Superbrave\\GdprBundle\\Annotation\\Export"
-            - "@superbrave_gdpr.property_manipulator"
-        tags:
-            - { name: "superbrave_gdpr.serializer.normalizer" }
-
-    superbrave_gdpr.exporter.serializer.encoder.xml:
-        class: Symfony\Component\Serializer\Encoder\XmlEncoder
-        tags:
-            - { name: "superbrave_gdpr.serializer.encoder" }
-
-    superbrave_gdpr.exporter.serializer.encoder.json:
-        class: Symfony\Component\Serializer\Encoder\JsonEncoder
-        tags:
-            - { name: "superbrave_gdpr.serializer.encoder" }
-
     superbrave_gdpr.property_accessor:
         class: Symfony\Component\PropertyAccess\PropertyAccessor
 

Resources/doc/anonymizer.md

@@ -13,7 +13,7 @@ Provides an annotation for anonymizing objects based on specific anonymization t
 
 ## Registering new anonymizers
 
-You can create your own anonymizers and register them in the compiler pass by tagging the service.
+You can create your own anonymizers and add them to the compiler pass by tagging the service.
 The `type` parameter specifies the name to be used in the `type` parameter of the annotation.
 
 ```yml
@@ -23,7 +23,7 @@ your_bundle_name.your_anonymizer:
         - { name: superbrave_gdpr.anonymizer, type: your_type }
 ```
 
-The example above will register an anonymizer with the name `your_type`. You can then use it as followed:
+The example above will add an anonymizer with the name `your_type`. You can then use it as followed:
 ```@GDPR\Anonymize(type="your_type")```
 
 ## Usage
@@ -56,7 +56,7 @@ use Superbrave\GdprBundle\Annotation as GDPR;
   *
   * @GDPR\Anonymize(type="fixed", value="anonymized")
   */
- protected $value;
+ private $value;
 ```
 
 ##### Advanced fixed value
@@ -78,7 +78,7 @@ use Superbrave\GdprBundle\Annotation as GDPR;
   *
   * @GDPR\Anonymize(type="fixed", value="firstName-{id}")
   */
- protected $firstName;
+ private $firstName;
 ```
 
 #### Type: dateTime
@@ -95,7 +95,7 @@ use Superbrave\GdprBundle\Annotation as GDPR;
   *
   * @GDPR\Anonymize(type="dateTime")
   */
- protected $createdAt;
+ private $createdAt;
 ```
 
 #### Type: ip
@@ -112,7 +112,7 @@ use Superbrave\GdprBundle\Annotation as GDPR;
   *
   * @GDPR\Anonymize(type="ip")
   */
- protected $ipAddress;
+ private $ipAddress;
 ```
 
 #### Type: null
@@ -129,7 +129,7 @@ use Superbrave\GdprBundle\Annotation as GDPR;
   *
   * @GDPR\Anonymize(type="null")
   */
- protected $city;
+ private $city;
 ```
 
 #### Type: object
@@ -148,7 +148,7 @@ class Order
      *
      * @GDPR\Anonymize(type="ip")
      */
-    protected $ipAddress;
+    private $ipAddress;
 }
 ```
 
@@ -162,7 +162,7 @@ use Superbrave\GdprBundle\Annotation as GDPR;
   *
   * @GDPR\Anonymize(type="object")
   */
- protected $order;
+ private $order;
 ```
 
 #### Type: collection
@@ -181,7 +181,7 @@ class Order
      *
      * @GDPR\Anonymize(type="ip")
      */
-    protected $ipAddress;
+    private $ipAddress;
 }
 ```
 
@@ -195,5 +195,5 @@ use Superbrave\GdprBundle\Annotation as GDPR;
   *
   * @GDPR\Anonymize(type="collection")
   */
- protected $orders;
+ private $orders;
 ```

Resources/doc/exporter.md

@@ -0,0 +1,84 @@
+# Exporter
+
+Provides an annotation for exporting object data to a specific format
+
+## Exporter encoder types
+
+- xml
+- json
+
+## Register new normalizers
+
+You can create your own normalizers and add them to the compiler pass by tagging the service.
+
+```yml
+your_bundle_name.your_normalizer:
+    class: Your\Class\To\Your\Normalizer
+    tags:
+        - { name: superbrave_gdpr.serializer.normalizer }
+```
+
+## Register new encoders
+
+You can create your own encoders and register them to the compiler pass by tagging the service.
+
+```yml
+your_bundle_name.your_encoder:
+    class: Your\Class\To\Your\Encoder
+    tags:
+        - { name: superbrave_gdpr.serializer.encoder }
+```
+
+## Usage
+
+You can export objects by using the exporter service:
+
+```php
+<?php
+
+$this->get('superbrave_gdpr.exporter')->exportObject($object, $objectName, $format);
+```
+
+## Examples
+
+#### Annotations
+
+Setting annotations on the object. Only the marked properties are being exported. If you mark an object, you also need to put annotations on properties of the object.
+
+```php
+<?php
+
+use Superbrave\GdprBundle\Annotation as GDPR;
+
+class Order
+{
+    /**
+     * @var int
+     *
+     * @GDPR\Export()
+     */
+    private $id;
+
+    /**
+     * @var Product
+     *
+     * @GDPR\Export()
+     */
+    private $product;
+}
+
+class Product
+{
+    /**
+     * @var int
+     */
+    private $id;
+
+    /**
+     * @var int
+     *
+     * @GDPR\Export()
+     */
+    private $name;
+}
+```