Source for file associations.php

Documentation is available at associations.php

  1. <?php
  2. /**
  3.  * @package     Joomla.Libraries
  4.  * @subpackage  Language
  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. /**
  13.  * Utitlity class for associations in multilang
  14.  *
  15.  * @package     Joomla.Libraries
  16.  * @subpackage  Language
  17.  * @since       3.1
  18.  */
  19. class JLanguageAssociations
  20. {
  21.     /**
  22.      * Get the associations.
  23.      *
  24.      * @param   string   $extension   The name of the component.
  25.      * @param   string   $tablename   The name of the table.
  26.      * @param   string   $context     The context
  27.      * @param   integer  $id          The primary key value.
  28.      * @param   string   $pk          The name of the primary key in the given $table.
  29.      * @param   string   $aliasField  If the table has an alias field set it here. Null to not use it
  30.      * @param   string   $catField    If the table has a catid field set it here. Null to not use it
  31.      *
  32.      * @return  array                The associated items
  33.      *
  34.      * @since   3.1
  35.      */
  36.     public static function getAssociations($extension, $tablename, $context, $id, $pk = 'id', $aliasField = 'alias', $catField = 'catid')
  37.     {
  38.         $associations = array();
  39.         $db = JFactory::getDbo();
  40.         $query = $db->getQuery(true)
  41.             ->select($db->quoteName('c2.language'))
  42.             ->from($db->quoteName($tablename, 'c'))
  43.             ->join('INNER', $db->quoteName('#__associations', 'a') . ' ON a.id = c.id AND a.context=' . $db->quote($context))
  44.             ->join('INNER', $db->quoteName('#__associations', 'a2') . ' ON a.key = a2.key')
  45.             ->join('INNER', $db->quoteName($tablename, 'c2') . ' ON a2.id = c2.' . $db->quoteName($pk));
  46.  
  47.         // Use alias field ?
  48.         if (!empty($aliasField))
  49.         {
  50.             $query->select(
  51.                 $query->concatenate(
  52.                     array(
  53.                         $db->quoteName('c2.' . $pk),
  54.                         $db->quoteName('c2.' . $aliasField)
  55.                     ),
  56.                     ':'
  57.                 ) . ' AS ' . $db->quoteName($pk)
  58.             );
  59.         }
  60.         else
  61.         {
  62.             $query->select($db->quoteName('c2.' . $pk));
  63.         }
  64.  
  65.         // Use catid field ?
  66.         if (!empty($catField))
  67.         {
  68.             $query->join('INNER', $db->quoteName('#__categories', 'ca') . ' ON ' . $db->quoteName('c2.' . $catField) . ' = ca.id AND ca.extension = ' . $db->quote($extension))
  69.                 ->select(
  70.                     $query->concatenate(
  71.                         array('ca.id', 'ca.alias'),
  72.                         ':'
  73.                     ) . ' AS ' . $db->quoteName($catField)
  74.                 );
  75.         }
  76.  
  77.         $query->where('c.' . $pk . ' = ' . (int) $id);
  78.  
  79.         $db->setQuery($query);
  80.  
  81.         try
  82.         {
  83.             $items = $db->loadObjectList('language');
  84.         }
  85.         catch (RuntimeException $e)
  86.         {
  87.             throw new Exception($e->getMessage(), 500);
  88.         }
  89.  
  90.         if ($items)
  91.         {
  92.             foreach ($items as $tag => $item)
  93.             {
  94.                 // Do not return itself as result
  95.                 if ((int) $item->{$pk} != $id)
  96.                 {
  97.                     $associations[$tag] = $item;
  98.                 }
  99.             }
  100.         }
  101.  
  102.         return $associations;
  103.     }
  104.  
  105.     /**
  106.      * Method to determine if the language filter Items Associations parameter is enabled.
  107.      * This works for both site and administrator.
  108.      *
  109.      * @return  boolean  True if the parameter is implemented; false otherwise.
  110.      *
  111.      * @since   3.2
  112.      */
  113.     public static function isEnabled()
  114.     {
  115.         // Flag to avoid doing multiple database queries.
  116.         static $tested = false;
  117.  
  118.         // Status of language filter parameter.
  119.         static $enabled = false;
  120.  
  121.         if (JLanguageMultilang::isEnabled())
  122.         {
  123.             // If already tested, don't test again.
  124.             if (!$tested)
  125.             {
  126.                 $params = new JRegistry(JPluginHelper::getPlugin('system', 'languagefilter')->params);
  127.  
  128.                 $enabled  = (boolean) $params->get('item_associations', true);
  129.                 $tested = true;
  130.             }
  131.         }
  132.  
  133.         return $enabled;
  134.     }
  135. }

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