Single Task Controllers RFC

libraries/cms/captcha/captcha.php

@@ -46,7 +46,7 @@ class JCaptcha extends JObject
 	/**
 	 * Captcha Plugin object
 	 *
-	 * @var	   JPlugin
+	 * @var       JPlugin
 	 * @since  2.5
 	 */
 	private $_captcha;
@@ -62,15 +62,15 @@ class JCaptcha extends JObject
 	/**
 	 * Array of instances of this class.
 	 *
-	 * @var	array
+	 * @var    array
 	 */
 	private static $_instances = array();
 
 	/**
 	 * Class constructor.
 	 *
-	 * @param   string  $captcha  The editor to use.
-	 * @param   array   $options  Associative array of options.
+	 * @param   string $captcha The editor to use.
+	 * @param   array  $options Associative array of options.
 	 *
 	 * @since 2.5
 	 */
@@ -84,8 +84,8 @@ public function __construct($captcha, $options)
 	 * Returns the global Captcha object, only creating it
 	 * if it doesn't already exist.
 	 *
-	 * @param   string  $captcha  The plugin to use.
-	 * @param   array   $options  Associative array of options.
+	 * @param   string $captcha The plugin to use.
+	 * @param   array  $options Associative array of options.
 	 *
 	 * @return  JCaptcha  Instance of this class.
 	 *
@@ -104,6 +104,7 @@ public static function getInstance($captcha, array $options = array())
 			catch (RuntimeException $e)
 			{
 				JFactory::getApplication()->enqueueMessage($e->getMessage(), 'error');
+
 				return null;
 			}
 		}
@@ -114,11 +115,11 @@ public static function getInstance($captcha, array $options = array())
 	/**
 	 * Fire the onInit event to initialise the captcha plug-in.
 	 *
-	 * @param   string  $id  The id of the field.
+	 * @param   string $id The id of the field.
 	 *
 	 * @return  boolean  True on success
 	 *
-	 * @since	2.5
+	 * @since    2.5
 	 */
 	public function initialise($id)
 	{
@@ -132,6 +133,7 @@ public function initialise($id)
 		catch (Exception $e)
 		{
 			JFactory::getApplication()->enqueueMessage($e->getMessage(), 'error');
+
 			return false;
 		}
 
@@ -141,9 +143,9 @@ public function initialise($id)
 	/**
 	 * Get the HTML for the captcha.
 	 *
-	 * @param   string  $name   The control name.
-	 * @param   string  $id     The id for the control.
-	 * @param   string  $class  Value for the HTML class attribute
+	 * @param   string $name  The control name.
+	 * @param   string $id    The id for the control.
+	 * @param   string $class Value for the HTML class attribute
 	 *
 	 * @return  mixed  The return value of the function "onDisplay" of the selected Plugin.
 	 *
@@ -174,11 +176,11 @@ public function display($name, $id, $class = '')
 	/**
 	 * Checks if the answer is correct.
 	 *
-	 * @param   string  $code  The answer.
+	 * @param   string $code The answer.
 	 *
 	 * @return  mixed   The return value of the function "onCheckAnswer" of the selected Plugin.
 	 *
-	 * @since	2.5
+	 * @since    2.5
 	 */
 	public function checkAnswer($code)
 	{
@@ -197,11 +199,11 @@ public function checkAnswer($code)
 	/**
 	 * Load the Captcha plug-in.
 	 *
-	 * @param   array  $options  Associative array of options.
+	 * @param   array $options Associative array of options.
 	 *
 	 * @return  void
 	 *
-	 * @since	2.5
+	 * @since    2.5
 	 * @throws  RuntimeException
 	 */
 	private function _load(array $options = array())
@@ -224,11 +226,11 @@ private function _load(array $options = array())
 		{
 			throw new RuntimeException(JText::sprintf('JLIB_CAPTCHA_ERROR_PLUGIN_NOT_FOUND', $name));
 		}
-		$params = new JRegistry($plugin->params);
+		$params         = new JRegistry($plugin->params);
 		$plugin->params = $params;
 
 		// Build captcha plugin classname
-		$name = 'plgCaptcha' . $this->_name;
+		$name           = 'plgCaptcha' . $this->_name;
 		$this->_captcha = new $name($this, (array) $plugin, $options);
 	}
 
@@ -247,7 +249,7 @@ public function getState()
 	/**
 	 * Attach an observer object
 	 *
-	 * @param   object  $observer  An observer object to attach
+	 * @param   object $observer An observer object to attach
 	 *
 	 * @return  void
 	 *
@@ -294,7 +296,7 @@ public function attach($observer)
 			}
 
 			$this->_observers[] = $observer;
-			$methods = array_diff(get_class_methods($observer), get_class_methods('JPlugin'));
+			$methods            = array_diff(get_class_methods($observer), get_class_methods('JPlugin'));
 		}
 
 		$key = key($this->_observers);
@@ -315,7 +317,7 @@ public function attach($observer)
 	/**
 	 * Detach an observer object
 	 *
-	 * @param   object  $observer  An observer object to detach.
+	 * @param   object $observer An observer object to detach.
 	 *
 	 * @return  boolean  True if the observer object was detached.
 	 *

libraries/cms/controller/add.php

@@ -0,0 +1,47 @@
+<?php
+/**
+ * @package     Joomla.Libraries
+ * @subpackage  Controller
+ *
+ * @copyright   Copyright (C) 2005 - 2013 Open Source Matters, Inc. All rights reserved.
+ * @license     GNU General Public License version 2 or later; see LICENSE.txt
+ */
+
+defined('JPATH_PLATFORM') or die;
+
+class JControllerAdd extends JControllerDisplay
+{
+	/**
+	 * Instantiate the controller.
+	 *
+	 * @param   JInput           $input  The input object.
+	 * @param   JApplicationBase $app    The application object.
+	 * @param   array            $config Configuration
+	 *
+	 * @since  12.1
+	 */
+	public function __construct(JInput $input, $app = null, $config = array())
+	{
+		$input->set('layout', 'edit');
+
+		parent::__construct($input, $app, $config);
+	}
+
+	/**
+	 * @see JControllerDisplay::execute()
+	 */
+	public function execute()
+	{
+		$model = $this->getModel();
+		if (!$model->allowAction('core.create'))
+		{
+			$msg = $this->translate('JLIB_APPLICATION_ERROR_CREATE_RECORD_NOT_PERMITTED');
+			$this->abort($msg, 'error');
+
+			return false;
+		}
+
+		return parent::execute();
+	}
+
+}

libraries/cms/controller/cancel.php

@@ -0,0 +1,50 @@
+<?php
+/**
+ * @package     Joomla.Libraries
+ * @subpackage  Controller
+ *
+ * @copyright   Copyright (C) 2005 - 2013 Open Source Matters, Inc. All rights reserved.
+ * @license     GNU General Public License version 2 or later; see LICENSE.txt
+ */
+
+defined('JPATH_PLATFORM') or die;
+
+class JControllerCancel extends JControllerCms
+{
+	/**
+	 * (non-PHPdoc)
+	 * @see JController::execute()
+	 */
+	public function execute()
+	{
+		$config = $this->config;
+		$url    = 'index.php?option=' . $config['option'] . '&task=display.' . $config['subject'];
+
+		$model   = $this->getModel();
+		$keyName = $model->getKeyName();
+
+		$input = $this->input;
+		$pk    = $input->getInt($keyName, 0);
+
+		if ($pk != 0)
+		{
+			try
+			{
+				$model->checkin($pk);
+			}
+			catch (Exception $e)
+			{
+				$msg = $e->getMessage();
+				$this->setRedirect($url, $msg, 'warning');
+
+				return false;
+			}
+		}
+
+		$this->setRedirect($url);
+
+		return true;
+	}
+
+
+}

libraries/cms/controller/checkin.php

@@ -0,0 +1,59 @@
+<?php
+/**
+ * @package     Joomla.Libraries
+ * @subpackage  Controller
+ *
+ * @copyright   Copyright (C) 2005 - 2013 Open Source Matters, Inc. All rights reserved.
+ * @license     GNU General Public License version 2 or later; see LICENSE.txt
+ */
+
+defined('JPATH_PLATFORM') or die;
+
+class JControllerCheckin extends JControllerCms
+{
+	/**
+	 * @see JController::execute()
+	 */
+	public function execute()
+	{
+		//Check for request forgeries
+		$this->validateSession();
+
+		$model = $this->getModel();
+
+		if (!$model->allowAction('core.manage'))
+		{
+			$msg = $this->translate('JLIB_APPLICATION_ERROR_CHECKIN_NOT_ALLOWED');
+			$this->abort($msg, 'error');
+
+			return false;
+		}
+
+		$input = $this->input;
+		$cid   = $input->post->get('cid', array(), 'array');
+		// Make sure the item ids are integers
+		$cid = $this->cleanCid($cid);
+
+		try
+		{
+			foreach ($cid AS $pk)
+			{
+				$model->checkin($pk);
+			}
+		}
+		catch (Exception $e)
+		{
+			$msg = $e->getMessage();
+			$this->abort($msg, 'warning');
+
+			return false;
+		}
+
+		$config = $this->config;
+		$url    = 'index.php?option=' . $config['option'] . '&task=display.' . $config['subject'];
+		$msg    = $this->translate('JLIB_APPLICATION_MSG_CHECKIN_SUCCEEDED');
+		$this->setRedirect($url, $msg, 'message');
+
+		return true;
+	}
+}