Uniformize Symfony ULID documentation (#153)

* Fixed missing reference to Symfony UID doc in menus

* Uniformize Symfony ULID doc

Author: yann-eugone

docs/docs/bridges/symfony-uid.rst

@@ -1,65 +1,43 @@
 Bridge with ``symfony/uid``
 ============================================================
 
-The UID component provides utilities to work with unique identifiers (UIDs) such as UUIDs and ULIDs.
-Please have a look to `Symfony's component documentation <https://symfony.com/doc/current/components/uid.html>`__.
+| The UID component provides utilities to work with unique identifiers (UIDs) such as UUIDs and ULIDs.
+| Refer to the `official documentation <https://symfony.com/doc/current/components/uid.html>`__ on Symfony's website.
+
+This bridge provides ways to generate ``JobExecution`` ids.
 
 
 Random based UUIDs ``JobExecution`` ids
 ------------------------------------------------------------
 
 Use ``RandomBasedUuidJobExecutionIdGenerator`` for time based UUIDs ``JobExecution`` ids.
 
-.. code-block:: php
-
-    <?php
+.. literalinclude:: symfony-uid/random-based-uuid-job-execution-id-generator.php
+   :language: php
 
-    use Symfony\Component\Uid\Factory\UuidFactory;
-    use Yokai\Batch\Bridge\Symfony\Uid\Factory\RandomBasedUuidJobExecutionIdGenerator;
-    use Yokai\Batch\Factory\JobExecutionFactory;
-    use Yokai\Batch\Factory\JobExecutionParametersBuilder\NullJobExecutionParametersBuilder;
-
-    (new JobExecutionFactory(
-        (new RandomBasedUuidJobExecutionIdGenerator(new UuidFactory())),
-        new NullJobExecutionParametersBuilder(),
-    ))->create('job.foo');
+.. seealso::
+   | :doc:`What is a job execution storage? </core-concepts/job-execution-storage>`
 
 
 Time based UUIDs ``JobExecution`` ids
 ------------------------------------------------------------
 
 Use ``TimeBasedUuidJobExecutionIdGenerator`` for time based UUIDs ``JobExecution`` ids.
 
-.. code-block:: php
-
-    <?php
+.. literalinclude:: symfony-uid/time-based-uuid-job-execution-id-generator.php
+   :language: php
 
-    use Symfony\Component\Uid\Factory\UuidFactory;
-    use Yokai\Batch\Bridge\Symfony\Uid\Factory\TimeBasedUuidJobExecutionIdGenerator;
-    use Yokai\Batch\Factory\JobExecutionFactory;
-    use Yokai\Batch\Factory\JobExecutionParametersBuilder\NullJobExecutionParametersBuilder;
-
-    (new JobExecutionFactory(
-        (new TimeBasedUuidJobExecutionIdGenerator(new UuidFactory())),
-        new NullJobExecutionParametersBuilder(),
-    ))->create('job.foo');
+.. seealso::
+   | :doc:`What is a job execution storage? </core-concepts/job-execution-storage>`
 
 
 ULIDs ``JobExecution`` ids
 ------------------------------------------------------------
 
 Use ``UlidJobExecutionIdGenerator`` for ULIDs ``JobExecution`` ids.
 
-.. code-block:: php
-
-    <?php
-
-    use Symfony\Component\Uid\Factory\UuidFactory;
-    use Yokai\Batch\Bridge\Symfony\Uid\Factory\UlidJobExecutionIdGenerator;
-    use Yokai\Batch\Factory\JobExecutionFactory;
-    use Yokai\Batch\Factory\JobExecutionParametersBuilder\NullJobExecutionParametersBuilder;
+.. literalinclude:: symfony-uid/ulid-job-execution-id-generator.php
+   :language: php
 
-    (new JobExecutionFactory(
-        (new UlidJobExecutionIdGenerator(new UuidFactory())),
-        new NullJobExecutionParametersBuilder(),
-    ))->create('job.foo');
+.. seealso::
+   | :doc:`What is a job execution storage? </core-concepts/job-execution-storage>`

docs/docs/bridges/symfony-uid/random-based-uuid-job-execution-id-generator.php

@@ -0,0 +1,13 @@
+<?php
+
+declare(strict_types=1);
+
+use Symfony\Component\Uid\Factory\UuidFactory;
+use Yokai\Batch\Bridge\Symfony\Uid\Factory\RandomBasedUuidJobExecutionIdGenerator;
+use Yokai\Batch\Factory\JobExecutionFactory;
+use Yokai\Batch\Factory\JobExecutionParametersBuilder\NullJobExecutionParametersBuilder;
+
+(new JobExecutionFactory(
+    new RandomBasedUuidJobExecutionIdGenerator(new UuidFactory()),
+    new NullJobExecutionParametersBuilder(),
+))->create('job.foo');

docs/docs/bridges/symfony-uid/time-based-uuid-job-execution-id-generator.php

@@ -0,0 +1,13 @@
+<?php
+
+declare(strict_types=1);
+
+use Symfony\Component\Uid\Factory\UuidFactory;
+use Yokai\Batch\Bridge\Symfony\Uid\Factory\TimeBasedUuidJobExecutionIdGenerator;
+use Yokai\Batch\Factory\JobExecutionFactory;
+use Yokai\Batch\Factory\JobExecutionParametersBuilder\NullJobExecutionParametersBuilder;
+
+(new JobExecutionFactory(
+    new TimeBasedUuidJobExecutionIdGenerator(new UuidFactory()),
+    new NullJobExecutionParametersBuilder(),
+))->create('job.foo');

docs/docs/bridges/symfony-uid/ulid-job-execution-id-generator.php

@@ -0,0 +1,13 @@
+<?php
+
+declare(strict_types=1);
+
+use Symfony\Component\Uid\Factory\UlidFactory;
+use Yokai\Batch\Bridge\Symfony\Uid\Factory\UlidJobExecutionIdGenerator;
+use Yokai\Batch\Factory\JobExecutionFactory;
+use Yokai\Batch\Factory\JobExecutionParametersBuilder\NullJobExecutionParametersBuilder;
+
+(new JobExecutionFactory(
+    new UlidJobExecutionIdGenerator(new UlidFactory()),
+    new NullJobExecutionParametersBuilder(),
+))->create('job.foo');

docs/docs/index.rst

@@ -104,6 +104,7 @@ Explore some of the things that could be built with **Yokai Batch**:
    Symfony Messenger </bridges/symfony-messenger>
    Symfony Serializer </bridges/symfony-serializer>
    Symfony Validator </bridges/symfony-validator>
+   Symfony UID </bridges/symfony-uid>
 
 .. toctree::
    :maxdepth: 2