Source for file moduleposition.php

Documentation is available at moduleposition.php

  1. <?php
  2. /**
  3.  * @package     Joomla.Libraries
  4.  * @subpackage  Form
  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('JPATH_BASE') or die;
  11.  
  12. JFormHelper::loadFieldClass('text');
  13.  
  14. /**
  15.  * Form Field class for the Joomla! CMS.
  16.  *
  17.  * @package     Joomla.Libraries
  18.  * @subpackage  Form
  19.  * @since       1.6
  20.  */
  21. class JFormFieldModulePosition extends JFormFieldText
  22. {
  23.     /**
  24.      * The form field type.
  25.      *
  26.      * @var    string 
  27.      * @since  1.6
  28.      */
  29.     protected $type = 'ModulePosition';
  30.  
  31.     /**
  32.      * The client ID.
  33.      *
  34.      * @var    integer 
  35.      * @since  3.2
  36.      */
  37.     protected $clientId;
  38.  
  39.     /**
  40.      * Method to get certain otherwise inaccessible properties from the form field object.
  41.      *
  42.      * @param   string  $name  The property name for which to the the value.
  43.      *
  44.      * @return  mixed  The property value or null.
  45.      *
  46.      * @since   3.2
  47.      */
  48.     public function __get($name)
  49.     {
  50.         switch ($name)
  51.         {
  52.             case 'clientId':
  53.                 return $this->$name;
  54.         }
  55.  
  56.         return parent::__get($name);
  57.     }
  58.  
  59.     /**
  60.      * Method to set certain otherwise inaccessible properties of the form field object.
  61.      *
  62.      * @param   string  $name   The property name for which to the the value.
  63.      * @param   mixed   $value  The value of the property.
  64.      *
  65.      * @return  void 
  66.      *
  67.      * @since   3.2
  68.      */
  69.     public function __set($name, $value)
  70.     {
  71.         switch ($name)
  72.         {
  73.             case 'clientId':
  74.                 $this->clientId = (string) $value;
  75.                 break;
  76.  
  77.             default:
  78.                 parent::__set($name, $value);
  79.         }
  80.     }
  81.  
  82.     /**
  83.      * Method to attach a JForm object to the field.
  84.      *
  85.      * @param   SimpleXMLElement  $element  The SimpleXMLElement object representing the <field /> tag for the form field object.
  86.      * @param   mixed             $value    The form field value to validate.
  87.      * @param   string            $group    The field name group control value. This acts as as an array container for the field.
  88.      *                                       For example if the field has name="foo" and the group value is set to "bar" then the
  89.      *                                       full field name would end up being "bar[foo]".
  90.      *
  91.      * @return  boolean  True on success.
  92.      *
  93.      * @see     JFormField::setup()
  94.      * @since   3.2
  95.      */
  96.     public function setup(SimpleXMLElement $element, $value, $group = null)
  97.     {
  98.         $result = parent::setup($element, $value, $group);
  99.  
  100.         if ($result == true)
  101.         {
  102.             // Get the client id.
  103.             $clientId = $this->element['client_id'];
  104.  
  105.             if (!isset($clientId))
  106.             {
  107.                 $clientName = $this->element['client'];
  108.  
  109.                 if (isset($clientName))
  110.                 {
  111.                     $client = JApplicationHelper::getClientInfo($clientName, true);
  112.                     $clientId = $client->id;
  113.                 }
  114.             }
  115.  
  116.             if (!isset($clientId) && $this->form instanceof JForm)
  117.             {
  118.                 $clientId = $this->form->getValue('client_id');
  119.             }
  120.  
  121.             $this->clientId = (int) $clientId;
  122.         }
  123.  
  124.         return $result;
  125.     }
  126.  
  127.     /**
  128.      * Method to get the field input markup.
  129.      *
  130.      * @return  string    The field input markup.
  131.      *
  132.      * @since   1.6
  133.      */
  134.     protected function getInput()
  135.     {
  136.         // Load the modal behavior script.
  137.         JHtml::_('behavior.modal', 'a.modal');
  138.  
  139.         // Build the script.
  140.         $script = array();
  141.         $script[] = '    function jSelectPosition_' . $this->id . '(name) {';
  142.         $script[] = '        document.id("' . $this->id . '").value = name;';
  143.         $script[] = '        SqueezeBox.close();';
  144.         $script[] = '    }';
  145.  
  146.         // Add the script to the document head.
  147.         JFactory::getDocument()->addScriptDeclaration(implode("\n", $script));
  148.  
  149.         // Setup variables for display.
  150.         $html = array();
  151.         $link = 'index.php?option=com_modules&view=positions&layout=modal&tmpl=component&function=jSelectPosition_' . $this->id . '&amp;client_id=' . $this->clientId;
  152.  
  153.         // The current user display field.
  154.         $html[] = '<div class="input-append">';
  155.         $html[] = parent::getInput()
  156.             . '<a class="btn modal" title="' . JText::_('COM_MODULES_CHANGE_POSITION_TITLE') . '"  href="' . $link . '" rel="{handler: \'iframe\', size: {x: 800, y: 450}}">'
  157.             . JText::_('COM_MODULES_CHANGE_POSITION_BUTTON') . '</a>';
  158.         $html[] = '</div>';
  159.  
  160.         return implode("\n", $html);
  161.     }
  162. }

Documentation generated on Tue, 19 Nov 2013 15:08:49 +0100 by phpDocumentor 1.4.3