[TASK] Move ViewHelper arguments to initializeArguments() in ext:belog
[Packages/TYPO3.CMS.git] / typo3 / sysext / belog / Classes / ViewHelpers / FormatDetailsViewHelper.php
1 <?php
2 namespace TYPO3\CMS\Belog\ViewHelpers;
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 use TYPO3\CMS\Belog\Domain\Model\LogEntry;
18 use TYPO3\CMS\Fluid\Core\ViewHelper\AbstractViewHelper;
19 use TYPO3Fluid\Fluid\Core\Rendering\RenderingContextInterface;
20
21 /**
22 * Create detail string from log entry
23 * @internal
24 */
25 class FormatDetailsViewHelper extends AbstractViewHelper
26 {
27 /**
28 * Initializes the arguments
29 */
30 public function initializeArguments()
31 {
32 parent::initializeArguments();
33 $this->registerArgument('logEntry', LogEntry::class, '', true);
34 }
35
36 /**
37 * Create formatted detail string from log row.
38 *
39 * The method handles two properties of the model: details and logData
40 * Details is a string with possible %s placeholders, and logData an array
41 * with the substitutions.
42 * Furthermore, possible files in logData are stripped to their basename if
43 * the action logged was a file action
44 *
45 * @return string Formatted details
46 */
47 public function render()
48 {
49 return static::renderStatic(
50 $this->arguments,
51 $this->buildRenderChildrenClosure(),
52 $this->renderingContext
53 );
54 }
55
56 /**
57 * @param array $arguments
58 * @param \Closure $renderChildrenClosure
59 * @param RenderingContextInterface $renderingContext
60 *
61 * @return string
62 */
63 public static function renderStatic(array $arguments, \Closure $renderChildrenClosure, RenderingContextInterface $renderingContext)
64 {
65 /** @var LogEntry $logEntry */
66 $logEntry = $arguments['logEntry'];
67 $detailString = $logEntry->getDetails();
68 $substitutes = $logEntry->getLogData();
69 // Strip paths from file names if the log was a file action
70 if ($logEntry->getType() === 2) {
71 $substitutes = self::stripPathFromFilenames($substitutes);
72 }
73 // Substitute
74 $detailString = vsprintf($detailString, $substitutes);
75 // Remove possible pending other %s
76 $detailString = str_replace('%s', '', $detailString);
77 return $detailString;
78 }
79
80 /**
81 * Strips path from array of file names
82 *
83 * @param array $files
84 * @return array
85 */
86 protected static function stripPathFromFilenames(array $files = array())
87 {
88 foreach ($files as $key => $file) {
89 $files[$key] = basename($file);
90 }
91 return $files;
92 }
93 }