Source for file language.php

Documentation is available at language.php

  1. <?php
  2. /**
  3.  * @package     FrameworkOnFramework
  4.  * @subpackage  model
  5.  * @copyright   Copyright (C) 2010 - 2012 Akeeba Ltd. All rights reserved.
  6.  * @license     GNU General Public License version 2 or later; see LICENSE.txt
  7.  */
  8. // Protect from unauthorized access
  9. defined('_JEXEC') or die;
  10.  
  11. /**
  12.  * FrameworkOnFramework model behavior class to filter front-end access to items
  13.  * based on the language.
  14.  *
  15.  * @package  FrameworkOnFramework
  16.  * @since    2.1
  17.  */
  18. class FOFModelBehaviorLanguage extends FOFModelBehavior
  19. {
  20.     /**
  21.      * This event runs after we have built the query used to fetch a record
  22.      * list in a model. It is used to apply automatic query filters.
  23.      *
  24.      * @param   FOFModel        &$model  The model which calls this event
  25.      * @param   JDatabaseQuery  &$query  The model which calls this event
  26.      *
  27.      * @return  void 
  28.      */
  29.     public function onAfterBuildQuery(&$model, &$query)
  30.     {
  31.         // This behavior only applies to the front-end.
  32.         if (!FOFPlatform::getInstance()->isFrontend())
  33.         {
  34.             return;
  35.         }
  36.  
  37.         // Get the name of the language field
  38.         $table = $model->getTable();
  39.         $languageField = $table->getColumnAlias('language');
  40.  
  41.         // Make sure the access field actually exists
  42.         if (!in_array($languageField, $table->getKnownFields()))
  43.         {
  44.             return;
  45.         }
  46.  
  47.         // Make sure it is a multilingual site and get a list of languages
  48.         $app = JFactory::getApplication();
  49.         $hasLanguageFilter = method_exists($app, 'getLanguageFilter');
  50.  
  51.         if ($hasLanguageFilter)
  52.         {
  53.             $hasLanguageFilter = $app->getLanguageFilter();
  54.         }
  55.  
  56.         if (!$hasLanguageFilter)
  57.         {
  58.             return;
  59.         }
  60.  
  61.         $lang_filter_plugin = JPluginHelper::getPlugin('system', 'languagefilter');
  62.         $lang_filter_params = new JRegistry($lang_filter_plugin->params);
  63.  
  64.         $languages = array('*');
  65.  
  66.         if ($lang_filter_params->get('remove_default_prefix'))
  67.         {
  68.             // Get default site language
  69.             $lg = JFactory::getLanguage();
  70.             $languages[] = $lg->getTag();
  71.         }
  72.         else
  73.         {
  74.             $languages[] = JFactory::getApplication()->input->getCmd('language', '*');
  75.         }
  76.  
  77.         // Filter out double languages
  78.         $languages = array_unique($languages);
  79.  
  80.         // And filter the query output by these languages
  81.         $db = JFactory::getDbo();
  82.         $languages = array_map(array($db, 'quote'), $languages);
  83.         $query->where($db->qn($languageField) . ' IN (' . implode(',', $languages) . ')');
  84.     }
  85.  
  86.     /**
  87.      * The event runs after FOFModel has called FOFTable and retrieved a single
  88.      * item from the database. It is used to apply automatic filters.
  89.      *
  90.      * @param   FOFModel  &$model   The model which was called
  91.      * @param   FOFTable  &$record  The record loaded from the databae
  92.      *
  93.      * @return  void 
  94.      */
  95.     public function onAfterGetItem(&$model, &$record)
  96.     {
  97.         if ($record instanceof FOFTable)
  98.         {
  99.             $fieldName = $record->getColumnAlias('language');
  100.  
  101.             // Make sure the field actually exists
  102.             if (!in_array($fieldName, $record->getKnownFields()))
  103.             {
  104.                 return;
  105.             }
  106.  
  107.             // Make sure it is a multilingual site and get a list of languages
  108.             $app = JFactory::getApplication();
  109.             $hasLanguageFilter = method_exists($app, 'getLanguageFilter');
  110.  
  111.             if ($hasLanguageFilter)
  112.             {
  113.                 $hasLanguageFilter = $app->getLanguageFilter();
  114.             }
  115.  
  116.             if (!$hasLanguageFilter)
  117.             {
  118.                 return;
  119.             }
  120.  
  121.             $lang_filter_plugin = JPluginHelper::getPlugin('system', 'languagefilter');
  122.             $lang_filter_params = new JRegistry($lang_filter_plugin->params);
  123.  
  124.             $languages = array('*');
  125.  
  126.             if ($lang_filter_params->get('remove_default_prefix'))
  127.             {
  128.                 // Get default site language
  129.                 $lg = JFactory::getLanguage();
  130.                 $languages[] = $lg->getTag();
  131.             }
  132.             else
  133.             {
  134.                 $languages[] = JFactory::getApplication()->input->getCmd('language', '*');
  135.             }
  136.  
  137.             // Filter out double languages
  138.             $languages = array_unique($languages);
  139.  
  140.             if (!in_array($record->$fieldName, $languages))
  141.             {
  142.                 $record = null;
  143.             }
  144.         }
  145.     }
  146. }

Documentation generated on Tue, 19 Nov 2013 15:06:31 +0100 by phpDocumentor 1.4.3