positibe/unique-views-bundle

Symfony PositibeUniqueViewsBundle for count the number of views of a object model

Positibe UniqueViews Bundle

This bundle allow you add a counter system to your visitable entities., _(*1)

Installation

To install the bundle just add the dependent bundles:, _(*2)

php composer.phar require positibe/media-bundle

Next, be sure to enable the bundles in your application kernel:, _(*3)

<?php
// app/AppKernel.php
public function registerBundles()
{
    return array(
        // ...
        new Positibe\Bundle\UniqueViewsBundle\PositibeUniqueViewsBundle(),

        // ...
    );
}

Documentation in 2 step

1. Implement the VisitableInterface, _(*4)

   // src/AppBundle/Entity/Post.php, _(*5)

   namespace AppBundle\Entity;, _(*6)

   use Doctrine\ORM\Mapping as ORM; use Positibe\Bundle\UniqueViewsBundle\Model\VisitableInterface;, _(*7)

   class Post implement VisitableInterface {, _(*8)

   /**
    * @ORM\Column(name="count_views", type="integer")
    */
   protected $countViews = 0;
   
   /**
    * @ORM\Column(name="slug", type="string", length=255)
    */
   protected $slug;
   
   public function getSlug()
   {
       return $this->slug;
   }
   
   /**
    * {@inheritdoc}
    */
   public function getVisitableId()
   {
       return $this->getSlug();
   }
   
   /**
    * {@inheritdoc}
    */
   public function getVisitableType()
   {
       return 'post';
   }
   
   /**
    * {@inheritdoc}
    */
   public function onNewViewed()
   {
       return $this->countViews++;
   }
   
   /**
    * {@inheritdoc}
    */
   public function countViews()
   {
       return $this->countViews;
   }

   }, _(*9)

Tips: You could use the AbstractVisitable or VisitableTrait instead to minimize your code., _(*10)

// src/AppBundle/Entity/Post.php

namespace AppBundle\Entity;

use Doctrine\ORM\Mapping as ORM;
use Positibe\Bundle\UniqueViewsBundle\Model\VisitableInterface;

class Post implement VisitableInterface {

    use VisitableTrait;

    /**
     * @ORM\Column(name="slug", type="string", length=255)
     */
    protected $slug;

    public function getSlug()
    {
        return $this->slug;
    }

    /**
     * {@inheritdoc}
     */
    public function getVisitableId()
    {
        return $this->getSlug();
    }
}

1. On a countable template you could count views using positibe_unique_views function., _(*11)

   {# app/Resources/views/post/show.html.twig #}, _(*12)

   {{ post.title }}

   {{ positibe_unique_views(post) }} unique views, _(*13)

2.1. On a countable controller you could count views using positibe_unique_views.views_counter service:, _(*14)

//src/AppBundle/Controller/PostController

$this->get('positibe_unique_views.views_counter')->count($post);