Merge pull request #869 from Steveb-p/gh-pages-nav

Github pages navigation structure

Author: makasim

docs/async_event_dispatcher/quick_tour.md

@@ -1,3 +1,7 @@
+---
+layout: default
+nav_exclude: true
+---
 <h2 align="center">Supporting Enqueue</h2>
 
 Enqueue is an MIT-licensed open source project with its ongoing development made possible entirely by the support of community and our customers. If you'd like to join them, please consider:
@@ -9,9 +13,9 @@ Enqueue is an MIT-licensed open source project with its ongoing development made
 
 # Async event dispatcher (Symfony)
 
-The doc shows how you can setup async event dispatching in plain PHP. 
+The doc shows how you can setup async event dispatching in plain PHP.
 If you are looking for the ways to use it in Symfony application [read this post instead](../bundle/async_events.md)
- 
+
 * [Installation](#installation)
 * [Configuration](#configuration)
 * [Dispatch event](#dispatch-event)
@@ -47,7 +51,7 @@ $context = (new FsConnectionFactory('file://'.__DIR__.'/queues'))->createContext
 $eventQueue = $context->createQueue('symfony_events');
 
 $registry = new SimpleRegistry(
-    ['the_event' => 'default'], 
+    ['the_event' => 'default'],
     ['default' => new PhpSerializerEventTransformer($context)]
 );
 

docs/bundle/async_commands.md

@@ -1,3 +1,8 @@
+---
+layout: default
+parent: "Symfony bundle"
+title: Async commands
+---
 <h2 align="center">Supporting Enqueue</h2>
 
 Enqueue is an MIT-licensed open source project with its ongoing development made possible entirely by the support of community and our customers. If you'd like to join them, please consider:
@@ -63,9 +68,9 @@ $promise = $producer->sendCommand(Commands::RUN_COMMAND, new RunCommand('debug:c
 
 // do other stuff.
 
-if ($replyMessage = $promise->receive(5000)) { 
+if ($replyMessage = $promise->receive(5000)) {
     $result = CommandResult::jsonUnserialize($replyMessage->getBody());
-    
+
     echo $result->getOutput();
 }
 ```

docs/bundle/async_events.md

@@ -1,3 +1,8 @@
+---
+layout: default
+parent: "Symfony bundle"
+title: Async events
+---
 <h2 align="center">Supporting Enqueue</h2>
 
 Enqueue is an MIT-licensed open source project with its ongoing development made possible entirely by the support of community and our customers. If you'd like to join them, please consider:
@@ -9,9 +14,9 @@ Enqueue is an MIT-licensed open source project with its ongoing development made
 
 # Async events
 
-The EnqueueBundle allows you to dispatch events asynchronously. 
-Behind the scene it replaces your listener with one that sends a message to MQ. 
-The message contains the event object. 
+The EnqueueBundle allows you to dispatch events asynchronously.
+Behind the scene it replaces your listener with one that sends a message to MQ.
+The message contains the event object.
 The consumer, once it receives the message, restores the event and dispatches it to only async listeners.
 
 Async listeners benefits:
@@ -57,14 +62,14 @@ or to `kernel.event_subscriber`:
 ```yaml
 # app/config/config.yml
 
-services: 
+services:
     test_async_subscriber:
         class: 'AcmeBundle\Listener\TestAsyncSubscriber'
         tags:
             - { name: 'kernel.event_subscriber', async: true }
 ```
 
-That's basically it. The rest of the doc describes advanced features. 
+That's basically it. The rest of the doc describes advanced features.
 
 ## Advanced Usage.
 
@@ -87,8 +92,8 @@ services:
 
 The bundle uses [php serializer](https://github.com/php-enqueue/enqueue-dev/blob/master/pkg/enqueue-bundle/Events/PhpSerializerEventTransformer.php) transformer by default to pass events through MQ.
 You can write a transformer for each event type by implementing the `Enqueue\AsyncEventDispatcher\EventTransformer` interface.
-Consider the next example. It shows how to send an event that contains Doctrine entity as a subject  
- 
+Consider the next example. It shows how to send an event that contains Doctrine entity as a subject
+
 ```php
 <?php
 namespace AcmeBundle\Listener;
@@ -116,22 +121,22 @@ class FooEventTransformer implements EventTransformer
 
     /**
      * {@inheritdoc}
-     * 
+     *
      * @param GenericEvent $event
      */
     public function toMessage($eventName, Event $event = null)
     {
         $entity = $event->getSubject();
         $entityClass = get_class($entity);
-        
+
         $manager = $this->doctrine->getManagerForClass($entityClass);
         $meta = $manager->getClassMetadata($entityClass);
 
         $id = $meta->getIdentifierValues($entity);
-        
+
         $message = new Message();
         $message->setBody([
-            'entityClass' => $entityClass, 
+            'entityClass' => $entityClass,
             'entityId' => $id,
             'arguments' => $event->getArguments()
         ]);
@@ -145,14 +150,14 @@ class FooEventTransformer implements EventTransformer
     public function toEvent($eventName, QueueMessage $message)
     {
         $data = JSON::decode($message->getBody());
-        
+
         $entityClass = $data['entityClass'];
-        
+
         $manager = $this->doctrine->getManagerForClass($entityClass);
         if (false == $entity = $manager->find($entityClass, $data['entityId'])) {
             return Result::reject('The entity could not be found.');
         }
-        
+
         return new GenericEvent($entity, $data['arguments']);
     }
 }
@@ -171,7 +176,7 @@ services:
             - {name: 'enqueue.event_transformer', eventName: 'foo' }
 ```
 
-The `eventName` attribute accepts a regexp. You can do next `eventName: '/foo\..*?/'`. 
+The `eventName` attribute accepts a regexp. You can do next `eventName: '/foo\..*?/'`.
 It uses this transformer for all event with the name beginning with `foo.`
 
 [back to index](../index.md)

docs/bundle/cli_commands.md

@@ -1,3 +1,8 @@
+---
+layout: default
+parent: "Symfony bundle"
+title: CLI commands
+---
 <h2 align="center">Supporting Enqueue</h2>
 
 Enqueue is an MIT-licensed open source project with its ongoing development made possible entirely by the support of community and our customers. If you'd like to join them, please consider:
@@ -9,7 +14,7 @@ Enqueue is an MIT-licensed open source project with its ongoing development made
 
 # Cli commands
 
-The EnqueueBundle provides several commands. 
+The EnqueueBundle provides several commands.
 The most useful one `enqueue:consume` connects to the broker and process the messages.
 Other commands could be useful during debugging (like `enqueue:topics`) or deployment (like `enqueue:setup-broker`).
 
@@ -134,7 +139,7 @@ Help:
 ```
 
 ## enqueue:transport:consume
- 
+
 ```
 ./bin/console enqueue:transport:consume --help
 Usage:

docs/bundle/config_reference.md

@@ -1,3 +1,8 @@
+---
+layout: default
+parent: "Symfony bundle"
+title: Config reference
+---
 <h2 align="center">Supporting Enqueue</h2>
 
 Enqueue is an MIT-licensed open source project with its ongoing development made possible entirely by the support of community and our customers. If you'd like to join them, please consider:

docs/bundle/consumption_extension.md

@@ -1,3 +1,8 @@
+---
+layout: default
+parent: "Symfony bundle"
+title: Consumption extension
+---
 <h2 align="center">Supporting Enqueue</h2>
 
 Enqueue is an MIT-licensed open source project with its ongoing development made possible entirely by the support of community and our customers. If you'd like to join them, please consider:
@@ -23,7 +28,7 @@ use Enqueue\Consumption\Context\PostMessageReceived;
 class CountProcessedMessagesExtension implements PostMessageReceivedExtensionInterface
 {
     private $processedMessages = 0;
-    
+
     public function onPostMessageReceived(PostMessageReceived $context): void
     {
         $this->processedMessages += 1;

docs/bundle/debugging.md

@@ -1,3 +1,8 @@
+---
+layout: default
+parent: "Symfony bundle"
+title: Debugging
+---
 <h2 align="center">Supporting Enqueue</h2>
 
 Enqueue is an MIT-licensed open source project with its ongoing development made possible entirely by the support of community and our customers. If you'd like to join them, please consider:
@@ -11,7 +16,7 @@ Enqueue is an MIT-licensed open source project with its ongoing development made
 
 ## Profiler
 
-It may be useful to see what messages were sent during a http request. 
+It may be useful to see what messages were sent during a http request.
 The bundle provides a collector for Symfony [profiler](http://symfony.com/doc/current/profiler.html).
 The extension collects all sent messages
 
@@ -36,17 +41,17 @@ use Symfony\Component\HttpFoundation\Request;
 use Enqueue\Client\Message;
 use Enqueue\Client\ProducerInterface;
 
-class DefaultController extends Controller 
+class DefaultController extends Controller
     /**
      * @Route("/", name="homepage")
      */
     public function indexAction(Request $request)
     {
         /** @var ProducerInterface $producer */
-        $producer = $this->get('enqueue.producer'); 
-        
+        $producer = $this->get('enqueue.producer');
+
         $producer->sendEvent('foo_topic', 'Hello world');
-        
+
         $producer->sendEvent('bar_topic', ['bar' => 'val']);
 
         $message = new Message();
@@ -59,10 +64,10 @@ class DefaultController extends Controller
 ```
 
 For this action you may see something like this in the profiler:
- 
+
  ![Symfony profiler](../images/symfony_profiler.png)
- 
-## Queues and topics available 
+
+## Queues and topics available
 
 There are two console commands `./bin/console enqueue:queues` and `./bin/console enqueue:topics`.
 They are here to help you to learn more about existing topics and queues.
@@ -71,11 +76,11 @@ Here's the result:
 
 ![Cli debug commands](../images/cli_debug_commands.png)
 
-## Consume command verbosity 
+## Consume command verbosity
 
-By default the commands `enqueue:consume` or `enqueue:transport:consume` does not output anything. 
+By default the commands `enqueue:consume` or `enqueue:transport:consume` does not output anything.
 You can add `-vvv` to see more information.
- 
+
 ![Consume command verbosity](../images/consume_command_verbosity.png)
 
 [back to index](../index.md)

docs/bundle/functional_testing.md

@@ -1,3 +1,8 @@
+---
+layout: default
+parent: "Symfony bundle"
+title: Functional testing
+---
 <h2 align="center">Supporting Enqueue</h2>
 
 Enqueue is an MIT-licensed open source project with its ongoing development made possible entirely by the support of community and our customers. If you'd like to join them, please consider:
@@ -10,17 +15,17 @@ Enqueue is an MIT-licensed open source project with its ongoing development made
 # Functional testing
 
 In this chapter we give some advices on how to test message queue related logic.
- 
+
 * [NULL transport](#null-transport)
 * [Traceable message producer](#traceable-message-producer)
 
 ## NULL transport
 
-While testing the application you don't usually need to send real message to real broker. 
-Or even have a dependency on a MQ broker. 
-Here's the purpose of the NULL transport. 
-It simple do nothing when you ask it to send a message. 
-Pretty useful in tests. 
+While testing the application you don't usually need to send real message to real broker.
+Or even have a dependency on a MQ broker.
+Here's the purpose of the NULL transport.
+It simple do nothing when you ask it to send a message.
+Pretty useful in tests.
 Here's how you can configure it.
 
 ```yaml
@@ -35,7 +40,7 @@ enqueue:
 ## Traceable message producer
 
 Imagine you have a service `my_service` with a method `someMethod()` that internally sends a message and you have to find out was the message sent or not.
-There is a solution for that. You have to enable traceable message producer in test environment. 
+There is a solution for that. You have to enable traceable message producer in test environment.
 
 ```yaml
 # app/config/config_test.yml
@@ -57,28 +62,28 @@ class FooTest extends WebTestCase
 {
     /** @var  \Symfony\Bundle\FrameworkBundle\Client */
     private $client;
-    
+
     public function setUp()
     {
-        $this->client = static::createClient();        
+        $this->client = static::createClient();
     }
-    
+
     public function testMessageSentToFooTopic()
     {
         // Use your own business logic here:
         $service = $this->client->getContainer()->get('my_service');
-        
+
         // someMethod() is part of your business logic and is calling somewhere $producer->send('fooTopic', 'messageBody');
         $service->someMethod();
-        
+
         $traces = $this->getProducer()->getTopicTraces('fooTopic');
-        
+
         $this->assertCount(1, $traces);
         $this->assertEquals('messageBody', $traces[0]['message']);
     }
-    
+
     /**
-     * @return TraceableProducer 
+     * @return TraceableProducer
      */
     private function getProducer()
     {

docs/bundle/index.md

@@ -0,0 +1,9 @@
+---
+layout: default
+title: "Symfony bundle"
+nav_order: 8
+has_children: true
+permalink: /symfony
+---
+
+{:toc}