Source for file button.php

Documentation is available at button.php

  1. <?php
  2. /**
  3.  * @package    FrameworkOnFramework
  4.  * @subpackage form
  5.  * @copyright  Copyright (C) 2010 - 2012 Akeeba Ltd. All rights reserved.
  6.  * @license    GNU General Public License version 2 or later; see LICENSE.txt
  7.  */
  8. // Protect from unauthorized access
  9. defined('_JEXEC') or die;
  10.  
  11. JFormHelper::loadFieldClass('text');
  12.  
  13. /**
  14.  * Form Field class for the FOF framework
  15.  * Supports a button input.
  16.  *
  17.  * @package  FrameworkOnFramework
  18.  * @since    2.0
  19.  */
  20. class FOFFormFieldButton extends FOFFormFieldText implements FOFFormField
  21. {
  22.     protected $static;
  23.  
  24.     protected $repeatable;
  25.  
  26.     /**
  27.      * Method to get certain otherwise inaccessible properties from the form field object.
  28.      *
  29.      * @param   string  $name  The property name for which to the the value.
  30.      *
  31.      * @return  mixed  The property value or null.
  32.      *
  33.      * @since   2.0
  34.      */
  35.     public function __get($name)
  36.     {
  37.         switch ($name)
  38.         {
  39.             case 'static':
  40.                 if (empty($this->static))
  41.                 {
  42.                     $this->static = $this->getStatic();
  43.                 }
  44.  
  45.                 return $this->static;
  46.                 break;
  47.  
  48.             case 'repeatable':
  49.                 if (empty($this->repeatable))
  50.                 {
  51.                     $this->repeatable = $this->getRepeatable();
  52.                 }
  53.  
  54.                 return $this->static;
  55.                 break;
  56.  
  57.             default:
  58.                 return parent::__get($name);
  59.         }
  60.     }
  61.  
  62.     /**
  63.      * Get the rendering of this field type for static display, e.g. in a single
  64.      * item view (typically a "read" task).
  65.      *
  66.      * @since 2.0
  67.      *
  68.      * @return  string  The field HTML
  69.      */
  70.     public function getInput()
  71.     {
  72.         $this->label = '';
  73.  
  74.         $text = $this->element['text'];
  75.         $class = $this->element['class'] ? (string) $this->element['class'] : '';
  76.         $icon = $this->element['icon'] ? (string) $this->element['icon'] : '';
  77.         $onclick = $this->element['onclick'] ? 'onclick="' . (string) $this->element['onclick'] . '"' : '';
  78.  
  79.         $this->value = JText::_($text);
  80.  
  81.         if ($icon)
  82.         {
  83.             $icon = '<span class="icon ' . $icon . '"></span>';
  84.         }
  85.  
  86.         return '<button id="' . $this->id . '" class="btn ' . $class . '" ' .
  87.             $onclick . '>' .
  88.             $icon .
  89.             htmlspecialchars($this->value, ENT_COMPAT, 'UTF-8') .
  90.             '</button>';
  91.     }
  92.  
  93.     /**
  94.      * Method to get the field title.
  95.      *
  96.      * @return  string  The field title.
  97.      */
  98.     protected function getTitle()
  99.     {
  100.         return null;
  101.     }
  102. }

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