/app/bundles/DashboardBundle/Model/DashboardModel.php

<?php
/**
 * @package     Mautic
 * @copyright   2014 Mautic Contributors. All rights reserved.
 * @author      Mautic
 * @link        http://mautic.org
 * @license     GNU/GPLv3 http://www.gnu.org/licenses/gpl-3.0.html
 */

namespace Mautic\DashboardBundle\Model;

use Mautic\CoreBundle\Helper\CoreParametersHelper;
use Mautic\CoreBundle\Helper\PathsHelper;
use Mautic\CoreBundle\Model\FormModel;
use Symfony\Component\HttpFoundation\Session\Session;
use Symfony\Component\HttpKernel\Exception\MethodNotAllowedHttpException;
use Mautic\DashboardBundle\Entity\Widget;
use Mautic\DashboardBundle\Event\WidgetDetailEvent;
use Mautic\DashboardBundle\DashboardEvents;
use Mautic\CoreBundle\Entity\CommonRepository;
use Mautic\CoreBundle\Helper\CacheStorageHelper;

/**
 * Class DashboardModel
 */
class DashboardModel extends FormModel
{
    /**
     * @var Session
     */
    protected $session;
    
    /**
     * @var CoreParametersHelper
     */
    protected $coreParametersHelper;

    /**
     * @var PathsHelper
     */
    protected $pathsHelper;

    /**
     * DashboardModel constructor.
     * 
     * @param CoreParametersHelper $coreParametersHelper
     * @param PathsHelper $pathsHelper
     */
    public function __construct(CoreParametersHelper $coreParametersHelper, PathsHelper $pathsHelper)
    {
        $this->coreParametersHelper = $coreParametersHelper;
        $this->pathsHelper = $pathsHelper;
    }

    /**
     * @param Session $session
     */
    public function setSession(Session $session)
    {
        $this->session = $session;
    }
    
    /**
     * {@inheritdoc}
     *
     * @return string
     */
    public function getRepository()
    {
        return $this->em->getRepository('MauticDashboardBundle:Widget');
    }

    /**
     * {@inheritdoc}
     *
     * @return string
     */
    public function getPermissionBase()
    {
        return 'dashboard:widgets';
    }

    /**
     * Get a specific entity or generate a new one if id is empty
     *
     * @param $id
     * @return null|object
     */
    public function getEntity($id = null)
    {
        if ($id === null) {
            return new Widget();
        }

        $entity = parent::getEntity($id);

        return $entity;
    }

    /**
     * Load widgets for the current user from database
     *
     * @return array
     */
    public function getWidgets()
    {
        $widgets = $this->getEntities(array(
            'orderBy' => 'w.ordering',
            'filter' => array(
                'force' => array(
                    array(
                        'column' => 'w.createdBy',
                        'expr'   => 'eq',
                        'value'  => $this->user->getId()
                    )
                )
            )
        ));

        return $widgets;
    }

    /**
     * Fill widgets with their content
     *
     * @param array $widgets
     * @param array $filter
     */
    public function populateWidgetsContent(&$widgets, $filter = array())
    {
        if (count($widgets)) {
            foreach ($widgets as &$widget) {
                if (!($widget instanceof Widget)) {
                    $widget = $this->populateWidgetEntity($widget);
                }
                $this->populateWidgetContent($widget, $filter);
            }
        }
    }

    /**
     * Creates a new Widget object from an array data
     *
     * @param array $data
     *
     * @return Widget
     */
    public function populateWidgetEntity($data)
    {
        $entity = new Widget;

        foreach ($data as $property => $value) {
            $method = "set".ucfirst($property);
            if (method_exists($entity, $method)) {
                $entity->$method($value);
            }
            unset($data[$property]);
        }

        return $entity;
    }

    /**
     * Load widget content from the onWidgetDetailGenerate event
     *
     * @param Widget $widget
     * @param array  $filter
     */
    public function populateWidgetContent(Widget &$widget, $filter = array())
    {
        $cacheDir   = $this->coreParametersHelper->getParameter('cached_data_dir', $this->pathsHelper->getSystemPath('cache', true));

        if ($widget->getCacheTimeout() == null || $widget->getCacheTimeout() == -1) {
            $widget->setCacheTimeout($this->coreParametersHelper->getParameter('cached_data_timeout'));
        }

        // Merge global filter with widget params
        $widgetParams = $widget->getParams();
        $resultParams = array_merge($widgetParams, $filter);

        // Add the user timezone
        if (empty($resultParams['timezone'])) {
            $resultParams['timezone'] = $this->user->getTimezone();
        }

        // Clone the objects in param array to avoid reference issues if some subscriber changes them
        foreach ($resultParams as &$param) {
            if (is_object($param)) {
                $param = clone $param;
            }
        }

        $widget->setParams($resultParams);

        $event = new WidgetDetailEvent($this->translator);
        $event->setWidget($widget);

        $event->setCacheDir($cacheDir, $this->user->getId());
        $event->setSecurity($this->security);
        $this->dispatcher->dispatch(DashboardEvents::DASHBOARD_ON_MODULE_DETAIL_GENERATE, $event);
    }

    /**
     * Clears the temporary widget cache
     */
    public function clearDashboardCache()
    {
        $cacheDir = $this->coreParametersHelper->getParameter('cached_data_dir', $this->pathsHelper->getSystemPath('cache', true));
        $cacheStorage = new CacheStorageHelper($cacheDir, $this->user->getId());
        $cacheStorage->clear();
    }

    /**
     * {@inheritdoc}
     *
     * @param Widget                                $entity
     * @param \Symfony\Component\Form\FormFactory $formFactory
     * @param string|null                         $action
     * @param array                               $options
     *
     * @return \Symfony\Component\Form\Form
     * @throws \Symfony\Component\HttpKernel\Exception\MethodNotAllowedHttpException
     */
    public function createForm($entity, $formFactory, $action = null, $options = array())
    {
        if (!$entity instanceof Widget) {
            throw new MethodNotAllowedHttpException(array('Widget'), 'Entity must be of class Widget()');
        }

        if (!empty($action))  {
            $options['action'] = $action;
        }

        return $formFactory->create('widget', $entity, $options);
    }

    /**
     * Create/edit entity
     *
     * @param object $entity
     * @param bool   $unlock
     */
    public function saveEntity($entity, $unlock = true)
    {
        // Set widget name from widget type if empty
        if (!$entity->getName()) {
            $entity->setName($this->translator->trans('mautic.widget.' . $entity->getType()));
        }

        parent::saveEntity($entity, $unlock);
    }

    /**
     * Generate default date range filter and time unit
     *
     * @return array
     */
    public function getDefaultFilter()
    {
        $lastMonth = new \DateTime();
        $lastMonth->sub(new \DateInterval('P30D'));

        $today       = new \DateTime();
        $dateFrom    = new \DateTime($this->session->get('mautic.dashboard.date.from', $lastMonth->format('Y-m-d 00:00:00')));
        $dateTo      = new \DateTime($this->session->get('mautic.dashboard.date.to', $today->format('Y-m-d H:i:s')));

        return array(
            'dateFrom' => $dateFrom,
            'dateTo'   => $dateTo,
        );
    }
}