Skip to content

Adapt and improve the documentation for new features and new best practices #291

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
tgalopin merged 1 commit into from
Sep 7, 2016
Merged

Adapt and improve the documentation for new features and new best practices #291

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Adapt and improve the documentation for new features
  • Loading branch information
@tgalopin
tgalopin committed Sep 7, 2016
commit ec03ddbc95679e43c0dcd7858ed301650bd068fc
6 changes: 3 additions & 3 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -16,15 +16,15 @@ Documentation

Documentation for this bundle is stored under `Resources/doc` in this repository.

[Read the documentation for master][]
[Read the documentation for the last stable (1.3)][]

License
-------

This bundle is under the MIT license. See the complete license in the bundle:

```
Resources/meta/LICENSE
Resources/meta/LICENSE
```

[Read the documentation for master]: https://github.com/FriendsOfSymfony/FOSMessageBundle/blob/master/Resources/doc/00-index.md
[Read the documentation for the last stable (1.3)]: https://github.com/FriendsOfSymfony/FOSMessageBundle/blob/master/Resources/doc/00-index.md
7 changes: 3 additions & 4 deletions Resources/doc/01-installation.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@ The first step is to tell composer that you want to download FOSMessageBundle wh
be achieved by typing the following at the command prompt:

```bash
$ php composer.phar require friendsofsymfony/message-bundle
$ composer require friendsofsymfony/message-bundle
```

### Step 2 - Setting up your user class
Expand All @@ -24,6 +24,7 @@ Your user class may look something like the following:

```php
<?php
// src/AppBundle/Entity/User.php

use Doctrine\ORM\Mapping as ORM;
use FOS\MessageBundle\Model\ParticipantInterface;
Expand Down Expand Up @@ -52,7 +53,7 @@ We provide examples for both Mongo DB and ORM.
The bundle must be added to your `AppKernel`

```php
# app/AppKernel.php
// app/AppKernel.php

public function registerBundles()
{
Expand All @@ -71,11 +72,9 @@ Add FOSMessageBundle's routing to your application with an optional routing pref
```yaml
# app/config/routing.yml

# ...
fos_message:
resource: "@FOSMessageBundle/Resources/config/routing.xml"
prefix: /optional_routing_prefix
# ...
```

## Installation Finished
Expand Down
50 changes: 25 additions & 25 deletions Resources/doc/01a-orm-models.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -14,8 +14,8 @@ Add the following to your `app/config/config.yml` file.

fos_message:
db_driver: orm
thread_class: Acme\MessageBundle\Entity\Thread
message_class: Acme\MessageBundle\Entity\Message
thread_class: AppBundle\Entity\Thread
message_class: AppBundle\Entity\Message
```

[Continue with the installation][]
Expand All @@ -25,12 +25,12 @@ Message class

```php
<?php
// src/Acme/MessageBundle/Entity/Message.php
// src/AppBundle/Entity/Message.php

namespace Acme\MessageBundle\Entity;
namespace AppBundle\Entity;

use Doctrine\ORM\Mapping as ORM;
use Doctrine\Common\Collections\ArrayCollection;
use Doctrine\Common\Collections\Collection;
use FOS\MessageBundle\Entity\Message as BaseMessage;

/**
Expand All @@ -47,26 +47,26 @@ class Message extends BaseMessage

/**
* @ORM\ManyToOne(
* targetEntity="Acme\MessageBundle\Entity\Thread",
* targetEntity="AppBundle\Entity\Thread",
* inversedBy="messages"
* )
* @var \FOS\MessageBundle\Model\ThreadInterface
*/
protected $thread;

/**
* @ORM\ManyToOne(targetEntity="Acme\UserBundle\Entity\User")
* @ORM\ManyToOne(targetEntity="AppBundle\Entity\User")
* @var \FOS\MessageBundle\Model\ParticipantInterface
*/
protected $sender;

/**
* @ORM\OneToMany(
* targetEntity="Acme\MessageBundle\Entity\MessageMetadata",
* targetEntity="AppBundle\Entity\MessageMetadata",
* mappedBy="message",
* cascade={"all"}
* )
* @var MessageMetadata[]|\Doctrine\Common\Collections\Collection
* @var MessageMetadata[]|Collection
*/
protected $metadata;
}
Expand All @@ -77,9 +77,9 @@ MessageMetadata class

```php
<?php
// src/Acme/MessageBundle/Entity/MessageMetadata.php
// src/AppBundle/Entity/MessageMetadata.php

namespace Acme\MessageBundle\Entity;
namespace AppBundle\Entity;

use Doctrine\ORM\Mapping as ORM;
use FOS\MessageBundle\Entity\MessageMetadata as BaseMessageMetadata;
Expand All @@ -98,15 +98,15 @@ class MessageMetadata extends BaseMessageMetadata

/**
* @ORM\ManyToOne(
* targetEntity="Acme\MessageBundle\Entity\Message",
* targetEntity="AppBundle\Entity\Message",
* inversedBy="metadata"
* )
* @var \FOS\MessageBundle\Model\MessageInterface
*/
protected $message;

/**
* @ORM\ManyToOne(targetEntity="Acme\UserBundle\Entity\User")
* @ORM\ManyToOne(targetEntity="AppBundle\Entity\User")
* @var \FOS\MessageBundle\Model\ParticipantInterface
*/
protected $participant;
Expand All @@ -118,12 +118,12 @@ Thread class

```php
<?php
// src/Acme/MessageBundle/Entity/Thread.php
// src/AppBundle/Entity/Thread.php

namespace Acme\MessageBundle\Entity;
namespace AppBundle\Entity;

use Doctrine\ORM\Mapping as ORM;
use Doctrine\Common\Collections\ArrayCollection;
use Doctrine\Common\Collections\Collection;
use FOS\MessageBundle\Entity\Thread as BaseThread;

/**
Expand All @@ -139,27 +139,27 @@ class Thread extends BaseThread
protected $id;

/**
* @ORM\ManyToOne(targetEntity="Acme\UserBundle\Entity\User")
* @ORM\ManyToOne(targetEntity="AppBundle\Entity\User")
* @var \FOS\MessageBundle\Model\ParticipantInterface
*/
protected $createdBy;

/**
* @ORM\OneToMany(
* targetEntity="Acme\MessageBundle\Entity\Message",
* targetEntity="AppBundle\Entity\Message",
* mappedBy="thread"
* )
* @var Message[]|\Doctrine\Common\Collections\Collection
* @var Message[]|Collection
*/
protected $messages;

/**
* @ORM\OneToMany(
* targetEntity="Acme\MessageBundle\Entity\ThreadMetadata",
* targetEntity="AppBundle\Entity\ThreadMetadata",
* mappedBy="thread",
* cascade={"all"}
* )
* @var ThreadMetadata[]|\Doctrine\Common\Collections\Collection
* @var ThreadMetadata[]|Collection
*/
protected $metadata;
}
Expand All @@ -170,9 +170,9 @@ ThreadMetadata class

```php
<?php
// src/Acme/MessageBundle/Entity/ThreadMetadata.php
// src/AppBundle/Entity/ThreadMetadata.php

namespace Acme\MessageBundle\Entity;
namespace AppBundle\Entity;

use Doctrine\ORM\Mapping as ORM;
use FOS\MessageBundle\Entity\ThreadMetadata as BaseThreadMetadata;
Expand All @@ -191,15 +191,15 @@ class ThreadMetadata extends BaseThreadMetadata

/**
* @ORM\ManyToOne(
* targetEntity="Acme\MessageBundle\Entity\Thread",
* targetEntity="AppBundle\Entity\Thread",
* inversedBy="metadata"
* )
* @var \FOS\MessageBundle\Model\ThreadInterface
*/
protected $thread;

/**
* @ORM\ManyToOne(targetEntity="Acme\UserBundle\Entity\User")
* @ORM\ManyToOne(targetEntity="AppBundle\Entity\User")
* @var \FOS\MessageBundle\Model\ParticipantInterface
*/
protected $participant;
Expand Down
36 changes: 19 additions & 17 deletions Resources/doc/01b-odm-models.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -14,8 +14,8 @@ Add the following to your `app/config/config.yml` file.

fos_message:
db_driver: mongodb
thread_class: Acme\MessageBundle\Document\Thread
message_class: Acme\MessageBundle\Document\Message
thread_class: AppBundle\Document\Thread
message_class: AppBundle\Document\Message
```

You may have to include the MessageBundle in your Doctrine mapping configuration,
Expand All @@ -39,9 +39,9 @@ Message class

```php
<?php
// src/Acme/MessageBundle/Document/Message.php
// src/AppBundle/Document/Message.php

namespace Acme\MessageBundle\Document;
namespace AppBundle\Document;

use Doctrine\ODM\MongoDB\Mapping\Annotations as MongoDB;
use FOS\MessageBundle\Document\Message as BaseMessage;
Expand All @@ -57,17 +57,17 @@ class Message extends BaseMessage
protected $id;

/**
* @MongoDB\EmbedMany(targetDocument="Acme\MessageBundle\Document\MessageMetadata")
* @MongoDB\EmbedMany(targetDocument="AppBundle\Document\MessageMetadata")
*/
protected $metadata;

/**
* @MongoDB\ReferenceOne(targetDocument="Acme\MessageBundle\Document\Thread")
* @MongoDB\ReferenceOne(targetDocument="AppBundle\Document\Thread")
*/
protected $thread;

/**
* @MongoDB\ReferenceOne(targetDocument="Acme\UserBundle\Document\User")
* @MongoDB\ReferenceOne(targetDocument="AppBundle\Document\User")
*/
protected $sender;
}
Expand All @@ -78,8 +78,9 @@ MessageMetadata class

```php
<?php
// src/AppBundle/Document/MessageMetadata.php

namespace Mashup\MessageBundle\Document;
namespace AppBundle\Document;

use Doctrine\ODM\MongoDB\Mapping\Annotations as ODM;
use FOS\MessageBundle\Document\MessageMetadata as BaseMessageMetadata;
Expand All @@ -90,7 +91,7 @@ use FOS\MessageBundle\Document\MessageMetadata as BaseMessageMetadata;
class MessageMetadata extends BaseMessageMetadata
{
/**
* @ODM\ReferenceOne(targetDocument="Mashup\UserBundle\Document\User")
* @ODM\ReferenceOne(targetDocument="AppBundle\Document\User")
*/
protected $participant;
}
Expand All @@ -101,9 +102,9 @@ Thread class

```php
<?php
// src/Acme/MessageBundle/Document/Thread.php
// src/AppBundle/Document/Thread.php

namespace Acme\MessageBundle\Document;
namespace AppBundle\Document;

use Doctrine\ODM\MongoDB\Mapping\Annotations as MongoDB;
use FOS\MessageBundle\Document\Thread as BaseThread;
Expand All @@ -119,22 +120,22 @@ class Thread extends BaseThread
protected $id;

/**
* @MongoDB\ReferenceMany(targetDocument="Acme\MessageBundle\Document\Message")
* @MongoDB\ReferenceMany(targetDocument="AppBundle\Document\Message")
*/
protected $messages;

/**
* @MongoDB\EmbedMany(targetDocument="Acme\MessageBundle\Document\ThreadMetadata")
* @MongoDB\EmbedMany(targetDocument="AppBundle\Document\ThreadMetadata")
*/
protected $metadata;

/**
* @MongoDB\ReferenceMany(targetDocument="Acme\UserBundle\Document\User")
* @MongoDB\ReferenceMany(targetDocument="AppBundle\Document\User")
*/
protected $participants;

/**
* @MongoDB\ReferenceOne(targetDocument="Acme\UserBundle\Document\User")
* @MongoDB\ReferenceOne(targetDocument="AppBundle\Document\User")
*/
protected $createdBy;
}
Expand All @@ -145,8 +146,9 @@ ThreadMetadata class

```php
<?php
// src/AppBundle/Document/ThreadMetadata.php

namespace Mashup\MessageBundle\Document;
namespace AppBundle\Document;

use Doctrine\ODM\MongoDB\Mapping\Annotations as ODM;
use FOS\MessageBundle\Document\ThreadMetadata as BaseThreadMetadata;
Expand All @@ -157,7 +159,7 @@ use FOS\MessageBundle\Document\ThreadMetadata as BaseThreadMetadata;
class ThreadMetadata extends BaseThreadMetadata
{
/**
* @ODM\ReferenceOne(targetDocument="Mashup\UserBundle\Document\User")
* @ODM\ReferenceOne(targetDocument="AppBundle\Document\User")
*/
protected $participant;
}
Expand Down
Loading