Source for file calendar.php

Documentation is available at calendar.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('JFormFieldCalendar'))
  12. {
  13.     require_once JPATH_LIBRARIES . '/joomla/form/fields/calendar.php';
  14. }
  15.  
  16. /**
  17.  * Form Field class for the FOF framework
  18.  * Supports a calendar / date field.
  19.  *
  20.  * @package  FrameworkOnFramework
  21.  * @since    2.0
  22.  */
  23. class FOFFormFieldCalendar extends JFormFieldCalendar 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.             // ATTENTION: Redirected getInput() to getStatic()
  49.             case 'input':
  50.                 if (empty($this->static))
  51.                 {
  52.                     $this->static = $this->getStatic();
  53.                 }
  54.  
  55.                 return $this->static;
  56.                 break;
  57.  
  58.             case 'repeatable':
  59.                 if (empty($this->repeatable))
  60.                 {
  61.                     $this->repeatable = $this->getRepeatable();
  62.                 }
  63.  
  64.                 return $this->static;
  65.                 break;
  66.  
  67.             default:
  68.                 return parent::__get($name);
  69.         }
  70.     }
  71.  
  72.     /**
  73.      * Get the rendering of this field type for static display, e.g. in a single
  74.      * item view (typically a "read" task).
  75.      *
  76.      * @since 2.0
  77.      *
  78.      * @return  string  The field HTML
  79.      */
  80.     public function getStatic()
  81.     {
  82.         return $this->getCalendar('static');
  83.     }
  84.  
  85.     /**
  86.      * Get the rendering of this field type for a repeatable (grid) display,
  87.      * e.g. in a view listing many item (typically a "browse" task)
  88.      *
  89.      * @since 2.0
  90.      *
  91.      * @return  string  The field HTML
  92.      */
  93.     public function getRepeatable()
  94.     {
  95.         return $this->getCalendar('repeatable');
  96.     }
  97.  
  98.     /**
  99.      * Method to get the calendar input markup.
  100.      *
  101.      * @param    string    $display    The display to render ('static' or 'repeatable')
  102.      *
  103.      * @return  string    The field input markup.
  104.      *
  105.      * @since   2.1.rc4
  106.      */
  107.     protected function getCalendar($display)
  108.     {
  109.         // Initialize some field attributes.
  110.         $format = $this->element['format'] ? (string) $this->element['format'] : '%Y-%m-%d';
  111.         $class  = $this->element['class'] ? (string) $this->element['class'] : '';
  112.  
  113.         // PHP date doesn't use percentages (%) for the format, but the calendar Javascript
  114.         // DOES use it (@see: calendar-uncompressed.js). Therefore we have to convert it.
  115.         $formatJS  = $format;
  116.         $formatPHP = str_replace('%', '', $formatJS);
  117.  
  118.         // Get some system objects.
  119.         $config = JFactory::getConfig();
  120.         $user = JFactory::getUser();
  121.         $date = JFactory::getDate($this->value, 'UTC');
  122.  
  123.         // If a known filter is given use it.
  124.         switch (strtoupper((string) $this->element['filter']))
  125.         {
  126.             case 'SERVER_UTC':
  127.                 // Convert a date to UTC based on the server timezone.
  128.                 if ((int) $this->value)
  129.                 {
  130.                     // Get a date object based on the correct timezone.
  131.                     $date->setTimezone(new DateTimeZone($config->get('offset')));
  132.                 }
  133.                 break;
  134.  
  135.             case 'USER_UTC':
  136.                 // Convert a date to UTC based on the user timezone.
  137.                 if ((int) $this->value)
  138.                 {
  139.                     // Get a date object based on the correct timezone.
  140.                     $date->setTimezone(new DateTimeZone($user->getParam('timezone', $config->get('offset'))));
  141.                 }
  142.                 break;
  143.  
  144.             default:
  145.                 break;
  146.         }
  147.  
  148.         // Transform the date string.
  149.         $this->value = $date->format($formatPHP, true, false);
  150.  
  151.         if ($display == 'static')
  152.         {
  153.             // Build the attributes array.
  154.             $attributes = array();
  155.  
  156.             if ($this->element['size'])
  157.             {
  158.                 $attributes['size'] = (int) $this->element['size'];
  159.             }
  160.             if ($this->element['maxlength'])
  161.             {
  162.                 $attributes['maxlength'] = (int) $this->element['maxlength'];
  163.             }
  164.             if ($this->element['class'])
  165.             {
  166.                 $attributes['class'] = (string) $this->element['class'];
  167.             }
  168.             if ((string) $this->element['readonly'] == 'true')
  169.             {
  170.                 $attributes['readonly'] = 'readonly';
  171.             }
  172.             if ((string) $this->element['disabled'] == 'true')
  173.             {
  174.                 $attributes['disabled'] = 'disabled';
  175.             }
  176.             if ($this->element['onchange'])
  177.             {
  178.                 $attributes['onchange'] = (string) $this->element['onchange'];
  179.             }
  180.             if ($this->required)
  181.             {
  182.                 $attributes['required'] = 'required';
  183.                 $attributes['aria-required'] = 'true';
  184.             }
  185.  
  186.             return JHtml::_('calendar', $this->value, $this->name, $this->id, $formatJS, $attributes);
  187.         }
  188.         else
  189.         {
  190.             return '<span class="' . $this->id . ' ' . $class . '">' .
  191.             htmlspecialchars($this->value, ENT_COMPAT, 'UTF-8') .
  192.             '</span>';
  193.         }
  194.     }
  195. }

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