Source for file checkbox.php

Documentation is available at checkbox.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. if (!class_exists('JFormFieldCheckbox'))
  12. {
  13.     require_once JPATH_LIBRARIES . '/joomla/form/fields/checkbox.php';
  14. }
  15.  
  16. /**
  17.  * Form Field class for the FOF framework
  18.  * A single checkbox
  19.  *
  20.  * @package  FrameworkOnFramework
  21.  * @since    2.0
  22.  */
  23. class FOFFormFieldCheckbox extends JFormFieldCheckbox implements FOFFormField
  24. {
  25.     protected $static;
  26.  
  27.     protected $repeatable;
  28.     
  29.     /** @var   FOFTable  The item being rendered in a repeatable form field */
  30.     public $item;
  31.     
  32.     /** @var int A monotonically increasing number, denoting the row number in a repeatable view */
  33.     public $rowid;
  34.  
  35.     /**
  36.      * Method to get certain otherwise inaccessible properties from the form field object.
  37.      *
  38.      * @param   string  $name  The property name for which to the the value.
  39.      *
  40.      * @return  mixed  The property value or null.
  41.      *
  42.      * @since   2.0
  43.      */
  44.     public function __get($name)
  45.     {
  46.         switch ($name)
  47.         {
  48.             case 'static':
  49.                 if (empty($this->static))
  50.                 {
  51.                     $this->static = $this->getStatic();
  52.                 }
  53.  
  54.                 return $this->static;
  55.                 break;
  56.  
  57.             case 'repeatable':
  58.                 if (empty($this->repeatable))
  59.                 {
  60.                     $this->repeatable = $this->getRepeatable();
  61.                 }
  62.  
  63.                 return $this->static;
  64.                 break;
  65.  
  66.             default:
  67.                 return parent::__get($name);
  68.         }
  69.     }
  70.  
  71.     /**
  72.      * Get the rendering of this field type for static display, e.g. in a single
  73.      * item view (typically a "read" task).
  74.      *
  75.      * @since 2.0
  76.      *
  77.      * @return  string  The field HTML
  78.      */
  79.     public function getStatic()
  80.     {
  81.         $class = $this->element['class'] ? ' class="' . (string) $this->element['class'] . '"' : '';
  82.  
  83.         $value = $this->element['value'] ? (string) $this->element['value'] : '1';
  84.  
  85.         if (empty($this->value))
  86.         {
  87.             $checked = (isset($this->element['checked'])) ? ' checked="checked"' : '';
  88.         }
  89.         else
  90.         {
  91.             $checked = ' checked="checked"';
  92.         }
  93.  
  94.         return '<span id="' . $this->id . '" ' . $class . '>' .
  95.             '<input type="checkbox" name="' . $this->name . '" id="' . $this->id . '"' . ' value="'
  96.             . htmlspecialchars($value, ENT_COMPAT, 'UTF-8') . '"' . $class . $checked . $disabled . $onclick . ' />' .
  97.             '</span>';
  98.     }
  99.  
  100.     /**
  101.      * Get the rendering of this field type for a repeatable (grid) display,
  102.      * e.g. in a view listing many item (typically a "browse" task)
  103.      *
  104.      * @since 2.0
  105.      *
  106.      * @return  string  The field HTML
  107.      */
  108.     public function getRepeatable()
  109.     {
  110.         $class = $this->element['class'] ? (string) $this->element['class'] : '';
  111.  
  112.         $value = $this->element['value'] ? (string) $this->element['value'] : '1';
  113.  
  114.         if (empty($this->value))
  115.         {
  116.             $checked = (isset($this->element['checked'])) ? ' checked="checked"' : '';
  117.         }
  118.         else
  119.         {
  120.             $checked = ' checked="checked"';
  121.         }
  122.  
  123.         return '<span class="' . $this->id . ' ' . $class . '">' .
  124.             '<input type="checkbox" name="' . $this->name . '" class="' . $this->id . ' ' . $class . '"' . ' value="'
  125.             . htmlspecialchars($value, ENT_COMPAT, 'UTF-8') . '"' . $checked . $disabled . $onclick . ' />' .
  126.             '</span>';
  127.     }
  128. }

Documentation generated on Tue, 19 Nov 2013 14:55:41 +0100 by phpDocumentor 1.4.3