[FEATURE] Integration of a generic record link handler
[Packages/TYPO3.CMS.git] / typo3 / sysext / core / Classes / LinkHandling / RecordLinkHandler.php
1 <?php
2 declare(strict_types=1);
3 namespace TYPO3\CMS\Core\LinkHandling;
4
5 /*
6 * This file is part of the TYPO3 CMS project.
7 *
8 * It is free software; you can redistribute it and/or modify it under
9 * the terms of the GNU General Public License, either version 2
10 * of the License, or any later version.
11 *
12 * For the full copyright and license information, please read the
13 * LICENSE.txt file that was distributed with this source code.
14 *
15 * The TYPO3 project - inspiring people to share!
16 */
17
18 /**
19 * Resolves links to records and the parameters given
20 */
21 class RecordLinkHandler implements LinkHandlingInterface
22 {
23 /**
24 * The Base URN for this link handling to act on
25 *
26 * @var string
27 */
28 protected $baseUrn = 't3://record';
29
30 /**
31 * Returns all valid parameters for linking to a TYPO3 page as a string
32 *
33 * @param array $parameters
34 * @return string
35 * @throws \InvalidArgumentException
36 */
37 public function asString(array $parameters): string
38 {
39 if (empty($parameters['identifier']) || empty($parameters['uid'])) {
40 throw new \InvalidArgumentException('The RecordLinkHandler expects identifier and uid as $parameter configuration.', 1486155150);
41 }
42 $urn = $this->baseUrn;
43 $urn .= sprintf('?identifier=%s&uid=%s', $parameters['identifier'], $parameters['uid']);
44
45 return $urn;
46 }
47
48 /**
49 * Returns all relevant information built in the link to a page (see asString())
50 *
51 * @param array $data
52 * @return array
53 * @throws \InvalidArgumentException
54 */
55 public function resolveHandlerData(array $data): array
56 {
57 if (empty($data['identifier']) || empty($data['uid'])) {
58 throw new \InvalidArgumentException('The RecordLinkHandler expects identifier, uid as $data configuration', 1486155151);
59 }
60
61 return $data;
62 }
63 }