kikwik/referable-bundle

Referable behaviour for Doctrine 2 entities

v2.0.2 2023-04-28 15:25 UTC

Requires

• php: ^7.1.3
• ext-json: *
• doctrine/orm: ^2.7
• symfony/framework-bundle: ^5.3

MIT

• Davide Scarpato

README

This bundle will save referer values in Doctrine 2 entities for symfony 4

Installation

Open a command console, enter your project directory and execute the following command to download the latest stable version of this bundle:

$ composer require kikwik/referable-bundle

Configuration

Create the config/packages/kikwik_referable.yaml config file

kikwik_referable:
    interfaces:
        CpcReferableInterface:
            cookie_name: 'r'
            query_params: ['r']
            expire: '+30 days'
        UtmReferableInterface:
            cookie_name: 'utm'
            query_params: [ 'utm_source', 'utm_medium', 'utm_campaign', 'utm_term', 'utm_content' ]
            expire: '+30 days'

Implements one or more interfaces in your classes and use the corresponding trait (Traits can be used only with query_params from the example above):

namespace App\Entity;

use Doctrine\ORM\Mapping as ORM;
use Kikwik\ReferableBundle\Model\CpcReferableInterface;
use Kikwik\ReferableBundle\Model\CpcReferableTrait;
use Kikwik\ReferableBundle\Model\HttpReferableInterface;
use Kikwik\ReferableBundle\Model\HttpReferableTrait;
use Kikwik\ReferableBundle\Model\UtmReferableInterface;
use Kikwik\ReferableBundle\Model\UtmReferableTrait;
use Symfony\Component\Security\Core\User\UserInterface;

/**
 * @ORM\Entity(repositoryClass=UserRepository::class)
 * @ORM\Table(name="`user`")
 */
class User implements UserInterface, HttpReferableInterface, CpcReferableInterface, UtmReferableInterface
{
    use HttpReferableTrait;
    use CpcReferableTrait;
    use UtmReferableTrait;
    
    //...
}

Make migrations and update your database

$ php bin/console make:migration
$ php bin/console doctrine:migrations:migrate