<commit_before>========================
MgiletNotificationBundle
========================
------------------------------------------------
A simple Symfony 3 bundle for user notifications
------------------------------------------------

Installation
============


Prerequisites
-------------

This version of the bundle requires Symfony 2.7+.

Warning : For now only Doctrine ORM is supported

Basic installation:
-------------------

Require the bundle with composer:
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

.. code-block:: bash

    $ composer require mgilet/notification-bundle

Composer will install the bundle to your project's ``vendor/mgilet/notification-bundle`` directory.

Then add the following line in the AppKernel.php:

.. code-block:: php

         <?php
         // app/AppKernel.php

         public function registerBundles()
         {
            $bundles = array(
                // ...
                new Mgilet\NotificationBundle\MgiletNotificationBundle(),
                // ...
            );
         }

Configure notifiables classes:
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

The goal of this bundle is to make one or many entities ``notifiables``.

1. Use the ``@Notifiable`` annotation on your entity
2. Implement the ``Mgilet\NotificationBundle\NotifiableInterface`` interface (it's an empty interface)

And that's it !

Example:

.. code-block:: php

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

    namespace AppBundle\Entity;

    ...
    use Doctrine\Common\Collections\ArrayCollection;
    use Doctrine\ORM\Mapping as ORM;
    use Mgilet\NotificationBundle\UserNotificationInterface;

    /**
     * @ORM\Entity
     * @ORM\Table(name="my_entity")
     * @Notifiable(name="my_entity")
     */
    class MyEntity implements Mgilet\NotificationBundle\NotifiableInterface
    {
        ...


You can set as many entities ``notifiables`` as you want.
Entities with multiple identifiers are supported

Update Doctrine
~~~~~~~~~~~~~~~
<commit_msg>Update documentation - index<commit_after>========================
MgiletNotificationBundle
========================
------------------------------------------------
A simple Symfony 3 bundle for user notifications
------------------------------------------------

Installation
============


Prerequisites
-------------

This version of the bundle requires Symfony 2.7+.

Warning : For now only Doctrine ORM is supported

Basic installation:
-------------------

Require the bundle with composer:
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

.. code-block:: bash

    $ composer require mgilet/notification-bundle

Composer will install the bundle to your project's ``vendor/mgilet/notification-bundle`` directory.

Then add the following line in the AppKernel.php:

.. code-block:: php

         <?php
         // app/AppKernel.php

         public function registerBundles()
         {
            $bundles = array(
                // ...
                new Mgilet\NotificationBundle\MgiletNotificationBundle(),
                // ...
            );
         }

Configure notifiables classes:
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

The goal of this bundle is to make one or many entities ``notifiables``.

1. Use the ``@Notifiable`` annotation on your entity
2. Implement the ``Mgilet\NotificationBundle\NotifiableInterface`` interface (it's an empty interface)

And that's it !

Example:

.. code-block:: php

    <?php
    // src/AppBundle/Entity/MyEntity.php

    namespace AppBundle\Entity;

    ...
    use Mgilet\NotificationBundle\Annotation\Notifiable;
    use Mgilet\NotificationBundle\NotifiableInterface;

    /**
     * @ORM\Entity
     * @ORM\Table(name="my_entity")
     * @Notifiable(name="my_entity")
     */
    class MyEntity implements NotifiableInterface
    {
        ...


You can set as many entities ``notifiables`` as you want.
Entities with multiple identifiers are supported.

After this, you can send notifications to any ``notifiable`` entity.

Update Doctrine
~~~~~~~~~~~~~~~

{'fraction_non_alphanumeric': 0.21080535218379198, 'fraction_numerical': 0.0025246149962130774, 'mean_word_length': 2.3519458544839256, 'pattern_counts': {'":': 0, '<': 7, '<?xml version=': 0, '>': 3, 'https://': 0, 'lorem ipsum': 0, 'www.': 0, 'xml': 0}, 'pii_count': 0, 'substrings_counts': 0, 'word_list_counts': {'cursed_substrings.json': 0, 'profanity_word_list.json': 0, 'sexual_word_list.json': 0, 'zh_pornsignals.json': 0}}
{'dir': 'git-commits-cleaned', 'id': '5751267', 'n_tokens_mistral': 1034, 'n_tokens_neox': 966, 'n_words': 298}