[TASK] Streamline return tags in phpdocs
[Packages/TYPO3.CMS.git] / typo3 / sysext / extbase / Classes / Mvc / Cli / Response.php
1 <?php
2 namespace TYPO3\CMS\Extbase\Mvc\Cli;
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 * A CLI specific response implementation
19 *
20 * @license http://www.gnu.org/licenses/lgpl.html GNU Lesser General Public License, version 3 or later
21 */
22 class Response extends \TYPO3\CMS\Extbase\Mvc\Response
23 {
24 /**
25 * @var int
26 */
27 private $exitCode = 0;
28
29 /**
30 * Sets the numerical exit code which should be returned when exiting this application.
31 *
32 * @param int $exitCode
33 * @throws \InvalidArgumentException
34 * @api
35 */
36 public function setExitCode($exitCode)
37 {
38 if (!is_int($exitCode)) {
39 throw new \InvalidArgumentException(sprintf('Tried to set invalid exit code. The value must be integer, %s given.', gettype($exitCode)), 1312222064);
40 }
41 $this->exitCode = $exitCode;
42 }
43
44 /**
45 * Rets the numerical exit code which should be returned when exiting this application.
46 *
47 * @return int
48 * @api
49 */
50 public function getExitCode()
51 {
52 return $this->exitCode;
53 }
54
55 /**
56 * Renders and sends the whole web response
57 *
58 * @api
59 */
60 public function send()
61 {
62 if ($this->content !== null) {
63 echo $this->shutdown();
64 }
65 }
66 }