1 <?php
  2 /**
  3  * @package    FrameworkOnFramework
  4  * @subpackage form
  5  * @copyright   Copyright (C) 2010-2016 Nicholas K. Dionysopoulos / 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('FOF_INCLUDED') or die;
 10 
 11 JFormHelper::loadFieldClass('list');
 12 
 13 /**
 14  * Form Field class for FOF
 15  * Supports a generic list of options.
 16  *
 17  * @package  FrameworkOnFramework
 18  * @since    2.0
 19  */
 20 class FOFFormFieldPublished extends JFormFieldList implements FOFFormField
 21 {
 22     protected $static;
 23 
 24     protected $repeatable;
 25 
 26     /** @var   FOFTable  The item being rendered in a repeatable form field */
 27     public $item;
 28 
 29     /** @var int A monotonically increasing number, denoting the row number in a repeatable view */
 30     public $rowid;
 31 
 32     /**
 33      * Method to get certain otherwise inaccessible properties from the form field object.
 34      *
 35      * @param   string  $name  The property name for which to the the value.
 36      *
 37      * @return  mixed  The property value or null.
 38      *
 39      * @since   2.0
 40      */
 41     public function __get($name)
 42     {
 43         switch ($name)
 44         {
 45             case 'static':
 46                 if (empty($this->static))
 47                 {
 48                     $this->static = $this->getStatic();
 49                 }
 50 
 51                 return $this->static;
 52                 break;
 53 
 54             case 'repeatable':
 55                 if (empty($this->repeatable))
 56                 {
 57                     $this->repeatable = $this->getRepeatable();
 58                 }
 59 
 60                 return $this->repeatable;
 61                 break;
 62 
 63             default:
 64                 return parent::__get($name);
 65         }
 66     }
 67 
 68     /**
 69      * Method to get the field options.
 70      *
 71      * @since 2.0
 72      *
 73      * @return  array  The field option objects.
 74      */
 75     protected function getOptions()
 76     {
 77         $options = parent::getOptions();
 78 
 79         if (!empty($options))
 80         {
 81             return $options;
 82         }
 83 
 84         // If no custom options were defined let's figure out which ones of the
 85         // defaults we shall use...
 86 
 87         $config = array(
 88             'published'      => 1,
 89             'unpublished'    => 1,
 90             'archived'       => 0,
 91             'trash'          => 0,
 92             'all'            => 0,
 93         );
 94 
 95         $configMap = array(
 96             'show_published'    => array('published', 1),
 97             'show_unpublished'  => array('unpublished', 1),
 98             'show_archived'     => array('archived', 0),
 99             'show_trash'        => array('trash', 0),
100             'show_all'          => array('all', 0),
101         );
102 
103         foreach ($configMap as $attribute => $preferences)
104         {
105             list($configKey, $default) = $preferences;
106 
107             switch (strtolower($this->element[$attribute]))
108             {
109                 case 'true':
110                 case '1':
111                 case 'yes':
112                     $config[$configKey] = true;
113 
114                 case 'false':
115                 case '0':
116                 case 'no':
117                     $config[$configKey] = false;
118 
119                 default:
120                     $config[$configKey] = $default;
121             }
122         }
123 
124         if ($config['published'])
125         {
126             $stack[] = JHtml::_('select.option', '1', JText::_('JPUBLISHED'));
127         }
128 
129         if ($config['unpublished'])
130         {
131             $stack[] = JHtml::_('select.option', '0', JText::_('JUNPUBLISHED'));
132         }
133 
134         if ($config['archived'])
135         {
136             $stack[] = JHtml::_('select.option', '2', JText::_('JARCHIVED'));
137         }
138 
139         if ($config['trash'])
140         {
141             $stack[] = JHtml::_('select.option', '-2', JText::_('JTRASHED'));
142         }
143 
144         if ($config['all'])
145         {
146             $stack[] = JHtml::_('select.option', '*', JText::_('JALL'));
147         }
148 
149         return $stack;
150     }
151 
152     /**
153      * Get the rendering of this field type for static display, e.g. in a single
154      * item view (typically a "read" task).
155      *
156      * @since 2.0
157      *
158      * @return  string  The field HTML
159      */
160     public function getStatic()
161     {
162         $class = $this->element['class'] ? ' class="' . (string) $this->element['class'] . '"' : '';
163 
164         return '<span id="' . $this->id . '" ' . $class . '>' .
165             htmlspecialchars(FOFFormFieldList::getOptionName($this->getOptions(), $this->value), ENT_COMPAT, 'UTF-8') .
166             '</span>';
167     }
168 
169     /**
170      * Get the rendering of this field type for a repeatable (grid) display,
171      * e.g. in a view listing many item (typically a "browse" task)
172      *
173      * @since 2.0
174      *
175      * @return  string  The field HTML
176      */
177     public function getRepeatable()
178     {
179         if (!($this->item instanceof FOFTable))
180         {
181             throw new Exception(__CLASS__ . ' needs a FOFTable to act upon');
182         }
183 
184         // Initialise
185         $prefix = '';
186         $checkbox = 'cb';
187         $publish_up = null;
188         $publish_down = null;
189         $enabled = true;
190 
191         // Get options
192         if ($this->element['prefix'])
193         {
194             $prefix = (string) $this->element['prefix'];
195         }
196 
197         if ($this->element['checkbox'])
198         {
199             $checkbox = (string) $this->element['checkbox'];
200         }
201 
202         if ($this->element['publish_up'])
203         {
204             $publish_up = (string) $this->element['publish_up'];
205         }
206 
207         if ($this->element['publish_down'])
208         {
209             $publish_down = (string) $this->element['publish_down'];
210         }
211 
212         // @todo Enforce ACL checks to determine if the field should be enabled or not
213         // Get the HTML
214         return JHTML::_('jgrid.published', $this->value, $this->rowid, $prefix, $enabled, $checkbox, $publish_up, $publish_down);
215     }
216 }
217 

Joomla! Framework TM API documentation generated by ApiGen 2.8.0
Joomla!® and Joomla! Framework™ are trademarks of Open Source Matters, Inc. in the United States and other countries.