typo3/sysext/install/Classes/Controller/Action/ActionInterface.php

   1 <?php
   2 namespace TYPO3\CMS\Install\Controller\Action;
   3
   4 /*
   5  * This file is part of the TYPO3 CMS project.
   6  *
   7  * It is free software; you can redistribute it and/or modify it under
   8  * the terms of the GNU General Public License, either version 2
   9  * of the License, or any later version.
  10  *
  11  * For the full copyright and license information, please read the
  12  * LICENSE.txt file that was distributed with this source code.
  13  *
  14  * The TYPO3 project - inspiring people to share!
  15  */
  16
  17 /**
  18  * General action interface
  19  */
  20 interface ActionInterface
  21 {
  22     /**
  23      * Handle this action
  24      *
  25      * @return string Rendered content
  26      */
  27     public function handle();
  28
  29     /**
  30      * Set form protection token
  31      *
  32      * @param string $token Form protection token
  33      * @return void
  34      */
  35     public function setToken($token);
  36
  37     /**
  38      * Set controller, Either string 'step', 'tool' or 'common'
  39      *
  40      * @param string $controller Controller name
  41      * @return void
  42      */
  43     public function setController($controller);
  44
  45     /**
  46      * Set action name. This is usually similar to the class name,
  47      * only for loginForm, the action is login
  48      *
  49      * @param string $action Name of target action for forms
  50      * @return void
  51      */
  52     public function setAction($action);
  53
  54     /**
  55      * Set POST values
  56      *
  57      * @param array $postValues List of values submitted via POST
  58      * @return void
  59      */
  60     public function setPostValues(array $postValues);
  61
  62     /**
  63      * Set the last error array as returned by error_get_last()
  64      *
  65      * @param array $lastError
  66      */
  67     public function setLastError(array $lastError);
  68
  69     /**
  70      * Status messages from controller
  71      *
  72      * @param array<\TYPO3\CMS\Install\Status\StatusInterface> $messages
  73      */
  74     public function setMessages(array $messages = array());
  75 }