Source for file weblinks.php

Documentation is available at weblinks.php

  1. <?php
  2. /**
  3.  * @package     Joomla.Plugin
  4.  * @subpackage  Finder.Weblinks
  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
  8.  */
  9.  
  10. defined('JPATH_BASE') or die;
  11.  
  12. // Load the base adapter.
  13. require_once JPATH_ADMINISTRATOR . '/components/com_finder/helpers/indexer/adapter.php';
  14.  
  15. /**
  16.  * Finder adapter for Joomla Web Links.
  17.  *
  18.  * @package     Joomla.Plugin
  19.  * @subpackage  Finder.Weblinks
  20.  * @since       2.5
  21.  */
  22. class PlgFinderWeblinks extends FinderIndexerAdapter
  23. {
  24.     /**
  25.      * The plugin identifier.
  26.      *
  27.      * @var    string 
  28.      * @since  2.5
  29.      */
  30.     protected $context = 'Weblinks';
  31.  
  32.     /**
  33.      * The extension name.
  34.      *
  35.      * @var    string 
  36.      * @since  2.5
  37.      */
  38.     protected $extension = 'com_weblinks';
  39.  
  40.     /**
  41.      * The sublayout to use when rendering the results.
  42.      *
  43.      * @var    string 
  44.      * @since  2.5
  45.      */
  46.     protected $layout = 'weblink';
  47.  
  48.     /**
  49.      * The type of content that the adapter indexes.
  50.      *
  51.      * @var    string 
  52.      * @since  2.5
  53.      */
  54.     protected $type_title = 'Web Link';
  55.  
  56.     /**
  57.      * The table name.
  58.      *
  59.      * @var    string 
  60.      * @since  2.5
  61.      */
  62.     protected $table = '#__weblinks';
  63.  
  64.     /**
  65.      * Load the language file on instantiation.
  66.      *
  67.      * @var    boolean 
  68.      * @since  3.1
  69.      */
  70.     protected $autoloadLanguage = true;
  71.  
  72.     /**
  73.      * Method to update the item link information when the item category is
  74.      * changed. This is fired when the item category is published or unpublished
  75.      * from the list view.
  76.      *
  77.      * @param   string   $extension  The extension whose category has been updated.
  78.      * @param   array    $pks        A list of primary key ids of the content that has changed state.
  79.      * @param   integer  $value      The value of the state that the content has been changed to.
  80.      *
  81.      * @return  void 
  82.      *
  83.      * @since   2.5
  84.      */
  85.     public function onFinderCategoryChangeState($extension, $pks, $value)
  86.     {
  87.         // Make sure we're handling com_weblinks categories
  88.         if ($extension == 'com_weblinks')
  89.         {
  90.             $this->categoryStateChange($pks, $value);
  91.         }
  92.     }
  93.  
  94.     /**
  95.      * Method to remove the link information for items that have been deleted.
  96.      *
  97.      * @param   string  $context  The context of the action being performed.
  98.      * @param   JTable  $table    A JTable object containing the record to be deleted
  99.      *
  100.      * @return  boolean  True on success.
  101.      *
  102.      * @since   2.5
  103.      * @throws  Exception on database error.
  104.      */
  105.     public function onFinderAfterDelete($context, $table)
  106.     {
  107.         if ($context == 'com_weblinks.weblink')
  108.         {
  109.             $id = $table->id;
  110.         }
  111.         elseif ($context == 'com_finder.index')
  112.         {
  113.             $id = $table->link_id;
  114.         }
  115.         else
  116.         {
  117.             return true;
  118.         }
  119.         // Remove the items.
  120.         return $this->remove($id);
  121.     }
  122.  
  123.     /**
  124.      * Method to determine if the access level of an item changed.
  125.      *
  126.      * @param   string   $context  The context of the content passed to the plugin.
  127.      * @param   JTable   $row      A JTable object
  128.      * @param   boolean  $isNew    If the content has just been created
  129.      *
  130.      * @return  boolean  True on success.
  131.      *
  132.      * @since   2.5
  133.      * @throws  Exception on database error.
  134.      */
  135.     public function onFinderAfterSave($context, $row, $isNew)
  136.     {
  137.         // We only want to handle web links here. We need to handle front end and back end editing.
  138.         if ($context == 'com_weblinks.weblink' || $context == 'com_weblinks.form' )
  139.         {
  140.             // Check if the access levels are different
  141.             if (!$isNew && $this->old_access != $row->access)
  142.             {
  143.                 // Process the change.
  144.                 $this->itemAccessChange($row);
  145.             }
  146.  
  147.             // Reindex the item
  148.             $this->reindex($row->id);
  149.         }
  150.  
  151.         // Check for access changes in the category
  152.         if ($context == 'com_categories.category')
  153.         {
  154.             // Check if the access levels are different
  155.             if (!$isNew && $this->old_cataccess != $row->access)
  156.             {
  157.                 $this->categoryAccessChange($row);
  158.             }
  159.         }
  160.  
  161.         return true;
  162.     }
  163.  
  164.     /**
  165.      * Method to reindex the link information for an item that has been saved.
  166.      * This event is fired before the data is actually saved so we are going
  167.      * to queue the item to be indexed later.
  168.      *
  169.      * @param   string   $context  The context of the content passed to the plugin.
  170.      * @param   JTable   $row     A JTable object
  171.      * @param   boolean  $isNew    If the content is just about to be created
  172.      *
  173.      * @return  boolean  True on success.
  174.      *
  175.      * @since   2.5
  176.      * @throws  Exception on database error.
  177.      */
  178.     public function onFinderBeforeSave($context, $row, $isNew)
  179.     {
  180.         // We only want to handle web links here
  181.         if ($context == 'com_weblinks.weblink' || $context == 'com_weblinks.form')
  182.         {
  183.             // Query the database for the old access level if the item isn't new
  184.             if (!$isNew)
  185.             {
  186.                 $this->checkItemAccess($row);
  187.             }
  188.         }
  189.  
  190.         // Check for access levels from the category
  191.         if ($context == 'com_categories.category')
  192.         {
  193.             // Query the database for the old access level if the item isn't new
  194.             if (!$isNew)
  195.             {
  196.                 $this->checkCategoryAccess($row);
  197.             }
  198.         }
  199.  
  200.         return true;
  201.     }
  202.  
  203.     /**
  204.      * Method to update the link information for items that have been changed
  205.      * from outside the edit screen. This is fired when the item is published,
  206.      * unpublished, archived, or unarchived from the list view.
  207.      *
  208.      * @param   string   $context  The context for the content passed to the plugin.
  209.      * @param   array    $pks      A list of primary key ids of the content that has changed state.
  210.      * @param   integer  $value    The value of the state that the content has been changed to.
  211.      *
  212.      * @return  void 
  213.      *
  214.      * @since   2.5
  215.      */
  216.     public function onFinderChangeState($context, $pks, $value)
  217.     {
  218.         // We only want to handle web links here
  219.         if ($context == 'com_weblinks.weblink' || $context == 'com_weblinks.form')
  220.         {
  221.             $this->itemStateChange($pks, $value);
  222.         }
  223.         // Handle when the plugin is disabled
  224.         if ($context == 'com_plugins.plugin' && $value === 0)
  225.         {
  226.             $this->pluginDisable($pks);
  227.         }
  228.     }
  229.  
  230.     /**
  231.      * Method to index an item. The item must be a FinderIndexerResult object.
  232.      *
  233.      * @param   FinderIndexerResult  $item    The item to index as an FinderIndexerResult object.
  234.      * @param   string               $format  The item format
  235.      *
  236.      * @return  void 
  237.      *
  238.      * @since   2.5
  239.      * @throws  Exception on database error.
  240.      */
  241.     protected function index(FinderIndexerResult $item, $format = 'html')
  242.     {
  243.         // Check if the extension is enabled
  244.         if (JComponentHelper::isEnabled($this->extension) == false)
  245.         {
  246.             return;
  247.         }
  248.  
  249.         $item->setLanguage();
  250.  
  251.         // Initialize the item parameters.
  252.         $registry = new JRegistry;
  253.         $registry->loadString($item->params);
  254.         $item->params = $registry;
  255.  
  256.         $registry = new JRegistry;
  257.         $registry->loadString($item->metadata);
  258.         $item->metadata = $registry;
  259.  
  260.         // Build the necessary route and path information.
  261.         $item->url = $this->getURL($item->id, $this->extension, $this->layout);
  262.         $item->route = WeblinksHelperRoute::getWeblinkRoute($item->slug, $item->catslug);
  263.         $item->path = FinderIndexerHelper::getContentPath($item->route);
  264.  
  265.         /*
  266.          * Add the meta-data processing instructions based on the newsfeeds
  267.          * configuration parameters.
  268.          */
  269.         // Add the meta-author.
  270.         $item->metaauthor = $item->metadata->get('author');
  271.  
  272.         // Handle the link to the meta-data.
  273.         $item->addInstruction(FinderIndexer::META_CONTEXT, 'link');
  274.         $item->addInstruction(FinderIndexer::META_CONTEXT, 'metakey');
  275.         $item->addInstruction(FinderIndexer::META_CONTEXT, 'metadesc');
  276.         $item->addInstruction(FinderIndexer::META_CONTEXT, 'metaauthor');
  277.         $item->addInstruction(FinderIndexer::META_CONTEXT, 'author');
  278.         $item->addInstruction(FinderIndexer::META_CONTEXT, 'created_by_alias');
  279.  
  280.         // Add the type taxonomy data.
  281.         $item->addTaxonomy('Type', 'Web Link');
  282.  
  283.         // Add the category taxonomy data.
  284.         $item->addTaxonomy('Category', $item->category, $item->cat_state, $item->cat_access);
  285.  
  286.         // Add the language taxonomy data.
  287.         $item->addTaxonomy('Language', $item->language);
  288.  
  289.         // Get content extras.
  290.         FinderIndexerHelper::getContentExtras($item);
  291.  
  292.         // Index the item.
  293.         $this->indexer->index($item);
  294.     }
  295.  
  296.     /**
  297.      * Method to setup the indexer to be run.
  298.      *
  299.      * @return  boolean  True on success.
  300.      *
  301.      * @since   2.5
  302.      */
  303.     protected function setup()
  304.     {
  305.         // Load dependent classes.
  306.         require_once JPATH_SITE . '/components/com_weblinks/helpers/route.php';
  307.  
  308.         return true;
  309.     }
  310.  
  311.     /**
  312.      * Method to get the SQL query used to retrieve the list of content items.
  313.      *
  314.      * @param   mixed  $query  A JDatabaseQuery object or null.
  315.      *
  316.      * @return  JDatabaseQuery  A database object.
  317.      *
  318.      * @since   2.5
  319.      */
  320.     protected function getListQuery($query = null)
  321.     {
  322.         $db = JFactory::getDbo();
  323.         // Check if we can use the supplied SQL query.
  324.         $query = $query instanceof JDatabaseQuery ? $query : $db->getQuery(true)
  325.             ->select('a.id, a.catid, a.title, a.alias, a.url AS link, a.description AS summary')
  326.             ->select('a.metakey, a.metadesc, a.metadata, a.language, a.access, a.ordering')
  327.             ->select('a.created_by_alias, a.modified, a.modified_by')
  328.             ->select('a.publish_up AS publish_start_date, a.publish_down AS publish_end_date')
  329.             ->select('a.state AS state, a.created AS start_date, a.params')
  330.             ->select('c.title AS category, c.published AS cat_state, c.access AS cat_access');
  331.  
  332.         // Handle the alias CASE WHEN portion of the query
  333.         $case_when_item_alias = ' CASE WHEN ';
  334.         $case_when_item_alias .= $query->charLength('a.alias', '!=', '0');
  335.         $case_when_item_alias .= ' THEN ';
  336.         $a_id = $query->castAsChar('a.id');
  337.         $case_when_item_alias .= $query->concatenate(array($a_id, 'a.alias'), ':');
  338.         $case_when_item_alias .= ' ELSE ';
  339.         $case_when_item_alias .= $a_id.' END as slug';
  340.         $query->select($case_when_item_alias);
  341.  
  342.         $case_when_category_alias = ' CASE WHEN ';
  343.         $case_when_category_alias .= $query->charLength('c.alias', '!=', '0');
  344.         $case_when_category_alias .= ' THEN ';
  345.         $c_id = $query->castAsChar('c.id');
  346.         $case_when_category_alias .= $query->concatenate(array($c_id, 'c.alias'), ':');
  347.         $case_when_category_alias .= ' ELSE ';
  348.         $case_when_category_alias .= $c_id.' END as catslug';
  349.         $query->select($case_when_category_alias)
  350.  
  351.             ->from('#__weblinks AS a')
  352.             ->join('LEFT', '#__categories AS c ON c.id = a.catid');
  353.  
  354.         return $query;
  355.     }
  356.  
  357.     /**
  358.      * Method to get the query clause for getting items to update by time.
  359.      *
  360.      * @param   string  $time  The modified timestamp.
  361.      *
  362.      * @return  JDatabaseQuery  A database object.
  363.      *
  364.      * @since   2.5
  365.      */
  366.     protected function getUpdateQueryByTime($time)
  367.     {
  368.         // Build an SQL query based on the modified time.
  369.         $query = $this->db->getQuery(true)
  370.             ->where('a.date >= ' . $this->db->quote($time));
  371.  
  372.         return $query;
  373.     }
  374. }

Documentation generated on Tue, 19 Nov 2013 15:18:33 +0100 by phpDocumentor 1.4.3