1 <?php
  2 /**
  3  * @package     Joomla.Legacy
  4  * @subpackage  Controller
  5  *
  6  * @copyright   Copyright (C) 2005 - 2017 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_PLATFORM') or die;
 11 
 12 use Joomla\Utilities\ArrayHelper;
 13 
 14 /**
 15  * Base class for a Joomla Administrator Controller
 16  *
 17  * Controller (controllers are where you put all the actual code) Provides basic
 18  * functionality, such as rendering views (aka displaying templates).
 19  *
 20  * @since  1.6
 21  */
 22 class JControllerAdmin extends JControllerLegacy
 23 {
 24     /**
 25      * The URL option for the component.
 26      *
 27      * @var    string
 28      * @since  1.6
 29      */
 30     protected $option;
 31 
 32     /**
 33      * The prefix to use with controller messages.
 34      *
 35      * @var    string
 36      * @since  1.6
 37      */
 38     protected $text_prefix;
 39 
 40     /**
 41      * The URL view list variable.
 42      *
 43      * @var    string
 44      * @since  1.6
 45      */
 46     protected $view_list;
 47 
 48     /**
 49      * Constructor.
 50      *
 51      * @param   array  $config  An optional associative array of configuration settings.
 52      *
 53      * @see     JControllerLegacy
 54      * @since   1.6
 55      * @throws  Exception
 56      */
 57     public function __construct($config = array())
 58     {
 59         parent::__construct($config);
 60 
 61         // Define standard task mappings.
 62 
 63         // Value = 0
 64         $this->registerTask('unpublish', 'publish');
 65 
 66         // Value = 2
 67         $this->registerTask('archive', 'publish');
 68 
 69         // Value = -2
 70         $this->registerTask('trash', 'publish');
 71 
 72         // Value = -3
 73         $this->registerTask('report', 'publish');
 74         $this->registerTask('orderup', 'reorder');
 75         $this->registerTask('orderdown', 'reorder');
 76 
 77         // Guess the option as com_NameOfController.
 78         if (empty($this->option))
 79         {
 80             $this->option = 'com_' . strtolower($this->getName());
 81         }
 82 
 83         // Guess the JText message prefix. Defaults to the option.
 84         if (empty($this->text_prefix))
 85         {
 86             $this->text_prefix = strtoupper($this->option);
 87         }
 88 
 89         // Guess the list view as the suffix, eg: OptionControllerSuffix.
 90         if (empty($this->view_list))
 91         {
 92             $r = null;
 93 
 94             if (!preg_match('/(.*)Controller(.*)/i', get_class($this), $r))
 95             {
 96                 throw new Exception(JText::_('JLIB_APPLICATION_ERROR_CONTROLLER_GET_NAME'), 500);
 97             }
 98 
 99             $this->view_list = strtolower($r[2]);
100         }
101     }
102 
103     /**
104      * Removes an item.
105      *
106      * @return  void
107      *
108      * @since   1.6
109      */
110     public function delete()
111     {
112         // Check for request forgeries
113         JSession::checkToken() or die(JText::_('JINVALID_TOKEN'));
114 
115         // Get items to remove from the request.
116         $cid = $this->input->get('cid', array(), 'array');
117 
118         if (!is_array($cid) || count($cid) < 1)
119         {
120             JLog::add(JText::_($this->text_prefix . '_NO_ITEM_SELECTED'), JLog::WARNING, 'jerror');
121         }
122         else
123         {
124             // Get the model.
125             $model = $this->getModel();
126 
127             // Make sure the item ids are integers
128             $cid = ArrayHelper::toInteger($cid);
129 
130             // Remove the items.
131             if ($model->delete($cid))
132             {
133                 $this->setMessage(JText::plural($this->text_prefix . '_N_ITEMS_DELETED', count($cid)));
134             }
135             else
136             {
137                 $this->setMessage($model->getError(), 'error');
138             }
139 
140             // Invoke the postDelete method to allow for the child class to access the model.
141             $this->postDeleteHook($model, $cid);
142         }
143 
144         $this->setRedirect(JRoute::_('index.php?option=' . $this->option . '&view=' . $this->view_list, false));
145     }
146 
147     /**
148      * Function that allows child controller access to model data
149      * after the item has been deleted.
150      *
151      * @param   JModelLegacy  $model  The data model object.
152      * @param   integer       $id     The validated data.
153      *
154      * @return  void
155      *
156      * @since   3.1
157      */
158     protected function postDeleteHook(JModelLegacy $model, $id = null)
159     {
160     }
161 
162     /**
163      * Display is not supported by this controller.
164      *
165      * @param   boolean  $cachable   If true, the view output will be cached
166      * @param   array    $urlparams  An array of safe URL parameters and their variable types, for valid values see {@link JFilterInput::clean()}.
167      *
168      * @return  JControllerLegacy  A JControllerLegacy object to support chaining.
169      *
170      * @since   1.6
171      */
172     public function display($cachable = false, $urlparams = array())
173     {
174         return $this;
175     }
176 
177     /**
178      * Method to publish a list of items
179      *
180      * @return  void
181      *
182      * @since   1.6
183      */
184     public function publish()
185     {
186         // Check for request forgeries
187         JSession::checkToken() or die(JText::_('JINVALID_TOKEN'));
188 
189         // Get items to publish from the request.
190         $cid = $this->input->get('cid', array(), 'array');
191         $data = array('publish' => 1, 'unpublish' => 0, 'archive' => 2, 'trash' => -2, 'report' => -3);
192         $task = $this->getTask();
193         $value = ArrayHelper::getValue($data, $task, 0, 'int');
194 
195         if (empty($cid))
196         {
197             JLog::add(JText::_($this->text_prefix . '_NO_ITEM_SELECTED'), JLog::WARNING, 'jerror');
198         }
199         else
200         {
201             // Get the model.
202             $model = $this->getModel();
203 
204             // Make sure the item ids are integers
205             $cid = ArrayHelper::toInteger($cid);
206 
207             // Publish the items.
208             try
209             {
210                 $model->publish($cid, $value);
211                 $errors = $model->getErrors();
212                 $ntext = null;
213 
214                 if ($value == 1)
215                 {
216                     if ($errors)
217                     {
218                         JFactory::getApplication()->enqueueMessage(JText::plural($this->text_prefix . '_N_ITEMS_FAILED_PUBLISHING', count($cid)), 'error');
219                     }
220                     else
221                     {
222                         $ntext = $this->text_prefix . '_N_ITEMS_PUBLISHED';
223                     }
224                 }
225                 elseif ($value == 0)
226                 {
227                     $ntext = $this->text_prefix . '_N_ITEMS_UNPUBLISHED';
228                 }
229                 elseif ($value == 2)
230                 {
231                     $ntext = $this->text_prefix . '_N_ITEMS_ARCHIVED';
232                 }
233                 else
234                 {
235                     $ntext = $this->text_prefix . '_N_ITEMS_TRASHED';
236                 }
237 
238                 if ($ntext !== null)
239                 {
240                     $this->setMessage(JText::plural($ntext, count($cid)));
241                 }
242             }
243             catch (Exception $e)
244             {
245                 $this->setMessage($e->getMessage(), 'error');
246             }
247         }
248 
249         $extension = $this->input->get('extension');
250         $extensionURL = $extension ? '&extension=' . $extension : '';
251         $this->setRedirect(JRoute::_('index.php?option=' . $this->option . '&view=' . $this->view_list . $extensionURL, false));
252     }
253 
254     /**
255      * Changes the order of one or more records.
256      *
257      * @return  boolean  True on success
258      *
259      * @since   1.6
260      */
261     public function reorder()
262     {
263         // Check for request forgeries.
264         JSession::checkToken() or jexit(JText::_('JINVALID_TOKEN'));
265 
266         $ids = $this->input->post->get('cid', array(), 'array');
267         $inc = ($this->getTask() == 'orderup') ? -1 : 1;
268 
269         $model = $this->getModel();
270         $return = $model->reorder($ids, $inc);
271 
272         if ($return === false)
273         {
274             // Reorder failed.
275             $message = JText::sprintf('JLIB_APPLICATION_ERROR_REORDER_FAILED', $model->getError());
276             $this->setRedirect(JRoute::_('index.php?option=' . $this->option . '&view=' . $this->view_list, false), $message, 'error');
277 
278             return false;
279         }
280         else
281         {
282             // Reorder succeeded.
283             $message = JText::_('JLIB_APPLICATION_SUCCESS_ITEM_REORDERED');
284             $this->setRedirect(JRoute::_('index.php?option=' . $this->option . '&view=' . $this->view_list, false), $message);
285 
286             return true;
287         }
288     }
289 
290     /**
291      * Method to save the submitted ordering values for records.
292      *
293      * @return  boolean  True on success
294      *
295      * @since   1.6
296      */
297     public function saveorder()
298     {
299         // Check for request forgeries.
300         JSession::checkToken() or jexit(JText::_('JINVALID_TOKEN'));
301 
302         // Get the input
303         $pks = $this->input->post->get('cid', array(), 'array');
304         $order = $this->input->post->get('order', array(), 'array');
305 
306         // Sanitize the input
307         $pks = ArrayHelper::toInteger($pks);
308         $order = ArrayHelper::toInteger($order);
309 
310         // Get the model
311         $model = $this->getModel();
312 
313         // Save the ordering
314         $return = $model->saveorder($pks, $order);
315 
316         if ($return === false)
317         {
318             // Reorder failed
319             $message = JText::sprintf('JLIB_APPLICATION_ERROR_REORDER_FAILED', $model->getError());
320             $this->setRedirect(JRoute::_('index.php?option=' . $this->option . '&view=' . $this->view_list, false), $message, 'error');
321 
322             return false;
323         }
324         else
325         {
326             // Reorder succeeded.
327             $this->setMessage(JText::_('JLIB_APPLICATION_SUCCESS_ORDERING_SAVED'));
328             $this->setRedirect(JRoute::_('index.php?option=' . $this->option . '&view=' . $this->view_list, false));
329 
330             return true;
331         }
332     }
333 
334     /**
335      * Check in of one or more records.
336      *
337      * @return  boolean  True on success
338      *
339      * @since   1.6
340      */
341     public function checkin()
342     {
343         // Check for request forgeries.
344         JSession::checkToken() or jexit(JText::_('JINVALID_TOKEN'));
345 
346         $ids = $this->input->post->get('cid', array(), 'array');
347 
348         $model = $this->getModel();
349         $return = $model->checkin($ids);
350 
351         if ($return === false)
352         {
353             // Checkin failed.
354             $message = JText::sprintf('JLIB_APPLICATION_ERROR_CHECKIN_FAILED', $model->getError());
355             $this->setRedirect(JRoute::_('index.php?option=' . $this->option . '&view=' . $this->view_list, false), $message, 'error');
356 
357             return false;
358         }
359         else
360         {
361             // Checkin succeeded.
362             $message = JText::plural($this->text_prefix . '_N_ITEMS_CHECKED_IN', count($ids));
363             $this->setRedirect(JRoute::_('index.php?option=' . $this->option . '&view=' . $this->view_list, false), $message);
364 
365             return true;
366         }
367     }
368 
369     /**
370      * Method to save the submitted ordering values for records via AJAX.
371      *
372      * @return  void
373      *
374      * @since   3.0
375      */
376     public function saveOrderAjax()
377     {
378         // Get the input
379         $pks = $this->input->post->get('cid', array(), 'array');
380         $order = $this->input->post->get('order', array(), 'array');
381 
382         // Sanitize the input
383         $pks = ArrayHelper::toInteger($pks);
384         $order = ArrayHelper::toInteger($order);
385 
386         // Get the model
387         $model = $this->getModel();
388 
389         // Save the ordering
390         $return = $model->saveorder($pks, $order);
391 
392         if ($return)
393         {
394             echo '1';
395         }
396 
397         // Close the application
398         JFactory::getApplication()->close();
399     }
400 }
401 

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.