Source for file refreshhelp.php

Documentation is available at refreshhelp.php

  1. <?php
  2. /**
  3.  * @package     Joomla.Administrator
  4.  * @subpackage  com_config
  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.  * Refresh Help Controller for global configuration
  14.  *
  15.  * @package     Joomla.Administrator
  16.  * @subpackage  com_config
  17.  * @since       3.2
  18. */
  19. class ConfigControllerApplicationRefreshhelp extends JControllerBase
  20. {
  21.     /**
  22.      * Application object - Redeclared for proper typehinting
  23.      *
  24.      * @var    JApplicationCms 
  25.      * @since  3.2
  26.      */
  27.     protected $app;
  28.  
  29.     /**
  30.      * Method to refresh help in global configuration.
  31.      *
  32.      * @return  boolean  True on success.
  33.      *
  34.      * @since   3.2
  35.      */
  36.     public function execute()
  37.     {
  38.         jimport('joomla.filesystem.file');
  39.  
  40.         // Set FTP credentials, if given
  41.         JClientHelper::setCredentialsFromRequest('ftp');
  42.  
  43.         if (($data = file_get_contents('http://help.joomla.org/helpsites.xml')) === false)
  44.         {
  45.             $this->app->enqueueMessage(JText::_('COM_CONFIG_ERROR_HELPREFRESH_FETCH'), 'error');
  46.             $this->app->redirect(JRoute::_('index.php?option=com_config', false));
  47.         }
  48.         elseif (!JFile::write(JPATH_BASE . '/help/helpsites.xml', $data))
  49.         {
  50.             $this->app->enqueueMessage(JText::_('COM_CONFIG_ERROR_HELPREFRESH_ERROR_STORE'), 'error');
  51.             $this->app->redirect(JRoute::_('index.php?option=com_config', false));
  52.         }
  53.         else
  54.         {
  55.             $this->app->enqueueMessage(JText::_('COM_CONFIG_HELPREFRESH_SUCCESS'), 'error');
  56.             $this->app->redirect(JRoute::_('index.php?option=com_config', false));
  57.         }
  58.     }
  59. }

Documentation generated on Tue, 19 Nov 2013 15:11:39 +0100 by phpDocumentor 1.4.3