Source for file controller.php

Documentation is available at controller.php

  1. <?php
  2. /**
  3.  * @package     Joomla.Platform
  4.  * @subpackage  Controller
  5.  *
  6.  * @copyright   Copyright (C) 2005 - 2013 Open Source Matters, Inc. All rights reserved.
  7.  * @license     GNU General Public License version 2 or later; see LICENSE
  8.  */
  9.  
  10. defined('JPATH_PLATFORM') or die;
  11.  
  12. /**
  13.  * Joomla Platform Controller Interface
  14.  *
  15.  * @package     Joomla.Platform
  16.  * @subpackage  Controller
  17.  * @since       12.1
  18.  */
  19. interface JController extends Serializable
  20. {
  21.     /**
  22.      * Execute the controller.
  23.      *
  24.      * @return  boolean  True if controller finished execution, false if the controller did not
  25.      *                    finish execution. A controller might return false if some precondition for
  26.      *                    the controller to run has not been satisfied.
  27.      *
  28.      * @since   12.1
  29.      * @throws  LogicException
  30.      * @throws  RuntimeException
  31.      */
  32.     public function execute();
  33.  
  34.     /**
  35.      * Get the application object.
  36.      *
  37.      * @return  JApplicationBase  The application object.
  38.      *
  39.      * @since   12.1
  40.      */
  41.     public function getApplication();
  42.  
  43.     /**
  44.      * Get the input object.
  45.      *
  46.      * @return  JInput  The input object.
  47.      *
  48.      * @since   12.1
  49.      */
  50.     public function getInput();
  51. }

Documentation generated on Tue, 19 Nov 2013 14:57:06 +0100 by phpDocumentor 1.4.3