Source for file banners.php

Documentation is available at banners.php

  1. <?php
  2. /**
  3.  * @package     Joomla.Site
  4.  * @subpackage  com_banners
  5.  *
  6.  * @copyright   Copyright (C) 2005 - 2013 Open Source Matters, Inc. All rights reserved.
  7.  * @license     GNU General Public License version 2 or later; see LICENSE.txt
  8.  */
  9.  
  10. defined('_JEXEC') or die;
  11.  
  12. JTable::addIncludePath(JPATH_COMPONENT_ADMINISTRATOR . '/tables');
  13.  
  14. /**
  15.  * Banners model for the Joomla Banners component.
  16.  *
  17.  * @package     Joomla.Site
  18.  * @subpackage  com_banners
  19.  * @since       1.6
  20.  */
  21. class BannersModelBanners extends JModelList
  22. {
  23.     /**
  24.      * Method to get a store id based on model configuration state.
  25.      *
  26.      * This is necessary because the model is used by the component and
  27.      * different modules that might need different sets of data or different
  28.      * ordering requirements.
  29.      *
  30.      * @param   string  $id    A prefix for the store id.
  31.      *
  32.      * @return  string  A store id.
  33.      * @since   1.6
  34.      */
  35.     protected function getStoreId($id = '')
  36.     {
  37.         // Compile the store id.
  38.         $id .= ':' . $this->getState('filter.search');
  39.         $id .= ':' . $this->getState('filter.tag_search');
  40.         $id .= ':' . $this->getState('filter.client_id');
  41.         $id .= ':' . serialize($this->getState('filter.category_id'));
  42.         $id .= ':' . serialize($this->getState('filter.keywords'));
  43.  
  44.         return parent::getStoreId($id);
  45.     }
  46.  
  47.     /**
  48.      * Gets a list of banners
  49.      *
  50.      * @return  array  An array of banner objects.
  51.      * @since   1.6
  52.      */
  53.     protected function getListQuery()
  54.     {
  55.         $db = $this->getDbo();
  56.         $query = $db->getQuery(true);
  57.         $ordering = $this->getState('filter.ordering');
  58.         $tagSearch = $this->getState('filter.tag_search');
  59.         $cid = $this->getState('filter.client_id');
  60.         $categoryId = $this->getState('filter.category_id');
  61.         $keywords = $this->getState('filter.keywords');
  62.         $randomise = ($ordering == 'random');
  63.         $nullDate = $db->quote($db->getNullDate());
  64.  
  65.         $query->select(
  66.             'a.id as id,' .
  67.                 'a.type as type,' .
  68.                 'a.name as name,' .
  69.                 'a.clickurl as clickurl,' .
  70.                 'a.cid as cid,' .
  71.                 'a.params as params,' .
  72.                 'a.custombannercode as custombannercode,' .
  73.                 'a.track_impressions as track_impressions,' .
  74.                 'cl.track_impressions as client_track_impressions'
  75.         )
  76.             ->from('#__banners as a')
  77.             ->join('LEFT', '#__banner_clients AS cl ON cl.id = a.cid')
  78.             ->where('a.state=1')
  79.             ->where('(' . $query->currentTimestamp() . ' >= a.publish_up OR a.publish_up = ' . $nullDate . ')')
  80.             ->where('(' . $query->currentTimestamp() . ' <= a.publish_down OR a.publish_down = ' . $nullDate . ')')
  81.             ->where('(a.imptotal = 0 OR a.impmade <= a.imptotal)');
  82.  
  83.         if ($cid)
  84.         {
  85.             $query->join('LEFT', '#__categories as cat ON a.catid = cat.id')
  86.                 ->where('a.cid = ' . (int) $cid)
  87.                 ->where('cl.state = 1');
  88.         }
  89.  
  90.         // Filter by a single or group of categories
  91.         if (is_numeric($categoryId))
  92.         {
  93.             $type = $this->getState('filter.category_id.include', true) ? '= ' : '<> ';
  94.  
  95.             // Add subcategory check
  96.             $includeSubcategories = $this->getState('filter.subcategories', false);
  97.             $categoryEquals = 'a.catid ' . $type . (int) $categoryId;
  98.  
  99.             if ($includeSubcategories)
  100.             {
  101.                 $levels = (int) $this->getState('filter.max_category_levels', '1');
  102.                 // Create a subquery for the subcategory list
  103.                 $subQuery = $db->getQuery(true);
  104.                 $subQuery->select('sub.id')
  105.                     ->from('#__categories as sub')
  106.                     ->join('INNER', '#__categories as this ON sub.lft > this.lft AND sub.rgt < this.rgt')
  107.                     ->where('this.id = ' . (int) $categoryId)
  108.                     ->where('sub.level <= this.level + ' . $levels);
  109.  
  110.                 // Add the subquery to the main query
  111.                 $query->where('(' . $categoryEquals . ' OR a.catid IN (' . $subQuery->__toString() . '))');
  112.             }
  113.             else
  114.             {
  115.                 $query->where($categoryEquals);
  116.             }
  117.         }
  118.         elseif ((is_array($categoryId)) && (count($categoryId) > 0))
  119.         {
  120.             JArrayHelper::toInteger($categoryId);
  121.             $categoryId = implode(',', $categoryId);
  122.             if ($categoryId != '0')
  123.             {
  124.                 $type = $this->getState('filter.category_id.include', true) ? 'IN' : 'NOT IN';
  125.                 $query->where('a.catid ' . $type . ' (' . $categoryId . ')');
  126.             }
  127.         }
  128.  
  129.         if ($tagSearch)
  130.         {
  131.             if (count($keywords) == 0)
  132.             {
  133.                 $query->where('0');
  134.             }
  135.             else
  136.             {
  137.                 $temp = array();
  138.                 $config = JComponentHelper::getParams('com_banners');
  139.                 $prefix = $config->get('metakey_prefix');
  140.  
  141.                 foreach ($keywords as $keyword)
  142.                 {
  143.                     $keyword = trim($keyword);
  144.                     $condition1 = "a.own_prefix=1 AND a.metakey_prefix=SUBSTRING(" . $db->quote($keyword) . ",1,LENGTH( a.metakey_prefix)) OR a.own_prefix=0 AND cl.own_prefix=1 AND cl.metakey_prefix=SUBSTRING(" . $db->quote($keyword) . ",1,LENGTH(cl.metakey_prefix)) OR a.own_prefix=0 AND cl.own_prefix=0 AND " . ($prefix == substr($keyword, 0, strlen($prefix)) ? '1' : '0');
  145.  
  146.                     $condition2 = "a.metakey REGEXP '[[:<:]]" . $db->escape($keyword) . "[[:>:]]'";
  147.  
  148.                     if ($cid)
  149.                     {
  150.                         $condition2 .= " OR cl.metakey REGEXP '[[:<:]]" . $db->escape($keyword) . "[[:>:]]'";
  151.                     }
  152.  
  153.                     if ($categoryId)
  154.                     {
  155.                         $condition2 .= " OR cat.metakey REGEXP '[[:<:]]" . $db->escape($keyword) . "[[:>:]]'";
  156.                     }
  157.  
  158.                     $temp[] = "($condition1) AND ($condition2)";
  159.                 }
  160.  
  161.                 $query->where('(' . implode(' OR ', $temp) . ')');
  162.             }
  163.         }
  164.  
  165.         // Filter by language
  166.         if ($this->getState('filter.language'))
  167.         {
  168.             $query->where('a.language in (' . $db->quote(JFactory::getLanguage()->getTag()) . ',' . $db->quote('*') . ')');
  169.         }
  170.  
  171.         $query->order('a.sticky DESC,' . ($randomise ? 'RAND()' : 'a.ordering'));
  172.         return $query;
  173.     }
  174.  
  175.     /**
  176.      * Get a list of banners.
  177.      *
  178.      * @return  array 
  179.      * @since   1.6
  180.      */
  181.     public function getItems()
  182.     {
  183.         if (!isset($this->cache['items']))
  184.         {
  185.             $this->cache['items'] = parent::getItems();
  186.  
  187.             foreach ($this->cache['items'] as &$item)
  188.             {
  189.                 $parameters = new JRegistry;
  190.                 $parameters->loadString($item->params);
  191.                 $item->params = $parameters;
  192.             }
  193.         }
  194.         return $this->cache['items'];
  195.     }
  196.  
  197.     /**
  198.      * Makes impressions on a list of banners
  199.      *
  200.      * @return  void 
  201.      * @since   1.6
  202.      */
  203.     public function impress()
  204.     {
  205.         $trackDate = JFactory::getDate()->format('Y-m-d H');
  206.         $items = $this->getItems();
  207.         $db = $this->getDbo();
  208.         $query = $db->getQuery(true);
  209.  
  210.         foreach ($items as $item)
  211.         {
  212.             // Increment impression made
  213.             $id = $item->id;
  214.             $query->clear()
  215.                 ->update('#__banners')
  216.                 ->set('impmade = (impmade + 1)')
  217.                 ->where('id = ' . (int) $id);
  218.             $db->setQuery($query);
  219.  
  220.             try
  221.             {
  222.                 $db->execute();
  223.             }
  224.             catch (RuntimeException $e)
  225.             {
  226.                 JError::raiseError(500, $e->getMessage());
  227.             }
  228.  
  229.             // track impressions
  230.             $trackImpressions = $item->track_impressions;
  231.             if ($trackImpressions < 0 && $item->cid)
  232.             {
  233.                 $trackImpressions = $item->client_track_impressions;
  234.             }
  235.  
  236.             if ($trackImpressions < 0)
  237.             {
  238.                 $config = JComponentHelper::getParams('com_banners');
  239.                 $trackImpressions = $config->get('track_impressions');
  240.             }
  241.  
  242.             if ($trackImpressions > 0)
  243.             {
  244.                 // is track already created ?
  245.                 $query->clear()
  246.                     ->select($db->quoteName('count'))
  247.                     ->from('#__banner_tracks')
  248.                     ->where('track_type=1')
  249.                     ->where('banner_id=' . (int) $id)
  250.                     ->where('track_date=' . $db->quote($trackDate));
  251.  
  252.                 $db->setQuery($query);
  253.  
  254.                 try
  255.                 {
  256.                     $db->execute();
  257.                 }
  258.                 catch (RuntimeException $e)
  259.                 {
  260.                     JError::raiseError(500, $e->getMessage());
  261.                 }
  262.  
  263.                 $count = $db->loadResult();
  264.  
  265.                 $query->clear();
  266.  
  267.                 if ($count)
  268.                 {
  269.                     // update count
  270.                     $query->update('#__banner_tracks')
  271.                         ->set($db->quoteName('count') . ' = (' . $db->quote('count') . ' + 1)')
  272.                         ->where('track_type=1')
  273.                         ->where('banner_id=' . (int) $id)
  274.                         ->where('track_date=' . $db->quote($trackDate));
  275.                 }
  276.                 else
  277.                 {
  278.                     // insert new count
  279.                     //sqlsrv change
  280.                     $query->insert('#__banner_tracks')
  281.                         ->columns(
  282.                             array(
  283.                                 $db->quoteName('count'), $db->quoteName('track_type'),
  284.                                 $db->quoteName('banner_id'), $db->quoteName('track_date')
  285.                             )
  286.                         )
  287.                         ->values('1, 1, ' . (int) $id . ', ' . $db->quote($trackDate));
  288.                 }
  289.  
  290.                 $db->setQuery($query);
  291.  
  292.                 try
  293.                 {
  294.                     $db->execute();
  295.                 }
  296.                 catch (RuntimeException $e)
  297.                 {
  298.                     JError::raiseError(500, $e->getMessage());
  299.                 }
  300.             }
  301.         }
  302.     }
  303. }

Documentation generated on Tue, 19 Nov 2013 14:54:21 +0100 by phpDocumentor 1.4.3