[!!!][TASK] Rewrite install tool
[Packages/TYPO3.CMS.git] / typo3 / sysext / install / Classes / ViewHelpers / Format / CropViewHelper.php
1 <?php
2 namespace TYPO3\CMS\Install\ViewHelpers\Format;
3
4 /***************************************************************
5 * Copyright notice
6 *
7 * (c) 2013 Christian Kuhn <lolli@schwarzbu.ch>
8 * All rights reserved
9 *
10 * This script is part of the TYPO3 project. The TYPO3 project is
11 * free software; you can redistribute it and/or modify
12 * it under the terms of the GNU General Public License as published by
13 * the Free Software Foundation; either version 2 of the License, or
14 * (at your option) any later version.
15 *
16 * The GNU General Public License can be found at
17 * http://www.gnu.org/copyleft/gpl.html.
18 *
19 * This script is distributed in the hope that it will be useful,
20 * but WITHOUT ANY WARRANTY; without even the implied warranty of
21 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
22 * GNU General Public License for more details.
23 *
24 * This copyright notice MUST APPEAR in all copies of the script!
25 ***************************************************************/
26
27 /**
28 * Simplified crop view helper that does not need a frontend environment
29 *
30 * = Examples =
31 *
32 * <code title="Defaults">
33 * <f:format.crop maxCharacters="10">This is some very long text</f:format.crop>
34 * </code>
35 * <output>
36 * This is...
37 * </output>
38 *
39 * <code title="Inline notation">
40 * {someLongText -> f:format.crop(maxCharacters: 10)}
41 * </code>
42 * <output>
43 * someLongText cropped after 10 characters...
44 * (depending on the value of {someLongText})
45 * </output>
46 */
47 class CropViewHelper extends \TYPO3\CMS\Fluid\Core\ViewHelper\AbstractViewHelper {
48
49 /**
50 * Render the cropped text
51 *
52 * @param integer $maxCharacters Place where to truncate the string
53 * @throws \TYPO3\CMS\Install\ViewHelpers\Exception
54 * @return string cropped text
55 */
56 public function render($maxCharacters) {
57 if (empty($maxCharacters) || $maxCharacters < 1) {
58 throw new \TYPO3\CMS\Install\ViewHelpers\Exception(
59 'maxCharacters must be a positive integer',
60 1371410113
61 );
62 }
63 $stringToTruncate = $this->renderChildren();
64 return substr($stringToTruncate, 0, $maxCharacters);
65 }
66 }
67
68 ?>