Source for file helper.php

Documentation is available at helper.php

  1. <?php
  2. /**
  3.  * @package     Joomla.Site
  4.  * @subpackage  mod_wrapper
  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.  * Helper for mod_wrapper
  14.  *
  15.  * @package     Joomla.Site
  16.  * @subpackage  mod_wrapper
  17.  * @since       1.5
  18.  */
  19. class ModWrapperHelper
  20. {
  21.     /**
  22.      * Gets the parameters for the wrapper
  23.      *
  24.      * @param   mixed  &$params  The parameters set in the administrator section
  25.      *
  26.      * @return  mixed  &params  The modified parameters
  27.      *
  28.      * @since   1.5
  29.      */
  30.     public static function getParams(&$params)
  31.     {
  32.         $params->def('url', '');
  33.         $params->def('scrolling', 'auto');
  34.         $params->def('height', '200');
  35.         $params->def('height_auto', '0');
  36.         $params->def('width', '100%');
  37.         $params->def('add', '1');
  38.         $params->def('name', 'wrapper');
  39.  
  40.         $url = $params->get('url');
  41.  
  42.         if ($params->get('add'))
  43.         {
  44.             // Adds 'http://' if none is set
  45.             if (substr($url, 0, 1) == '/')
  46.             {
  47.                 // Relative url in component. use server http_host.
  48.                 $url = 'http://' . $_SERVER['HTTP_HOST'] . $url;
  49.             }
  50.             elseif (!strstr($url, 'http') && !strstr($url, 'https'))
  51.             {
  52.                 $url = 'http://' . $url;
  53.             }
  54.             else
  55.             {
  56.                 $url = $url;
  57.             }
  58.         }
  59.  
  60.         // Auto height control
  61.         if ($params->def('height_auto'))
  62.         {
  63.             $load = 'onload="iFrameHeight()"';
  64.         }
  65.         else
  66.         {
  67.             $load = '';
  68.         }
  69.  
  70.         $params->set('load', $load);
  71.         $params->set('url', $url);
  72.  
  73.         return $params;
  74.     }
  75. }

Documentation generated on Tue, 19 Nov 2013 15:04:22 +0100 by phpDocumentor 1.4.3