-
Notifications
You must be signed in to change notification settings - Fork 394
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
[TASK] Move linkhandler code snippets to own files. (#4746)
In preparation for documenting TYPO3-Documentation/Changelog-To-Doc#1005 Releases: main, 12.4 (cherry picked from commit a18e40f)
- Loading branch information
Showing
4 changed files
with
183 additions
and
175 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
31 changes: 31 additions & 0 deletions
31
Documentation/ApiOverview/LinkHandling/Linkhandler/_CustomLinkHandlers/_GitHubLinkHandler.js
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,31 @@ | ||
| /** | ||
| * Module: TYPO3/CMS/Examples/GitHubLinkHandler | ||
| * GitHub issue link interaction | ||
| */ | ||
| define(['jquery', 'TYPO3/CMS/Recordlist/LinkBrowser'], function($, LinkBrowser) { | ||
| 'use strict'; | ||
|
|
||
| /** | ||
| * | ||
| * @type {{}} | ||
| * @exports T3docs/Examples/GitHubLinkHandler | ||
| */ | ||
| var GitHubLinkHandler = {}; | ||
|
|
||
| $(function() { | ||
| $('#lgithubform').on('submit', function(event) { | ||
| event.preventDefault(); | ||
|
|
||
| var value = $(this).find('[name="lgithub"]').val(); | ||
| if (value === 'github:') { | ||
| return; | ||
| } | ||
| if (value.indexOf('github:') === 0) { | ||
| value = value.substr(7); | ||
| } | ||
| LinkBrowser.finalizeFunction('github:' + value); | ||
| }); | ||
| }); | ||
|
|
||
| return GitHubLinkHandler; | ||
| }); |
120 changes: 120 additions & 0 deletions
120
...mentation/ApiOverview/LinkHandling/Linkhandler/_CustomLinkHandlers/_GitHubLinkHandler.php
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,120 @@ | ||
| <?php | ||
|
|
||
| namespace T3docs\Examples\LinkHandler; | ||
|
|
||
| // use ... | ||
| use Psr\Http\Message\ServerRequestInterface; | ||
| use TYPO3\CMS\Backend\Controller\AbstractLinkBrowserController; | ||
| use TYPO3\CMS\Backend\LinkHandler\LinkHandlerInterface; | ||
| use TYPO3\CMS\Core\Imaging\IconFactory; | ||
| use TYPO3\CMS\Core\Page\PageRenderer; | ||
| use TYPO3\CMS\Core\Utility\GeneralUtility; | ||
| use TYPO3\CMS\Fluid\View\StandaloneView; | ||
|
|
||
| class GitHubLinkHandler implements LinkHandlerInterface | ||
| { | ||
| protected $linkAttributes = ['target', 'title', 'class', 'params', 'rel']; | ||
| protected StandaloneView $view; | ||
| protected $configuration; | ||
| private IconFactory $iconFactory; | ||
| private AbstractLinkBrowserController $linkBrowser; | ||
| private array $linkParts; | ||
|
|
||
| /** | ||
| * Initialize the handler | ||
| * | ||
| * @param AbstractLinkBrowserController $linkBrowser | ||
| * @param string $identifier | ||
| * @param array $configuration Page TSconfig | ||
| */ | ||
| public function initialize(AbstractLinkBrowserController $linkBrowser, $identifier, array $configuration) | ||
| { | ||
| $this->linkBrowser = $linkBrowser; | ||
| $this->iconFactory = GeneralUtility::makeInstance(IconFactory::class); | ||
| $this->view = GeneralUtility::makeInstance(StandaloneView::class); | ||
| $this->view->getRequest()->setControllerExtensionName('examples'); | ||
| $this->view->setTemplateRootPaths([GeneralUtility::getFileAbsFileName('EXT:examples/Resources/Private/Templates/LinkBrowser')]); | ||
| $this->configuration = $configuration; | ||
| } | ||
|
|
||
| /** | ||
| * Checks if this is the handler for the given link | ||
| * | ||
| * Also stores information locally about currently linked issue | ||
| * | ||
| * @param array $linkParts Link parts as returned from TypoLinkCodecService | ||
| * | ||
| * @return bool | ||
| */ | ||
| public function canHandleLink(array $linkParts) | ||
| { | ||
| if (isset($linkParts['url']['github'])) { | ||
| $this->linkParts = $linkParts; | ||
| return true; | ||
| } | ||
| return false; | ||
| } | ||
|
|
||
| /** | ||
| * Format the current link for HTML output | ||
| * | ||
| * @return string | ||
| */ | ||
| public function formatCurrentUrl(): string | ||
| { | ||
| return $this->linkParts['url']['github']; | ||
| } | ||
|
|
||
| /** | ||
| * Render the link handler | ||
| * | ||
| * @param ServerRequestInterface $request | ||
| * | ||
| * @return string | ||
| */ | ||
| public function render(ServerRequestInterface $request): string | ||
| { | ||
| GeneralUtility::makeInstance(PageRenderer::class) | ||
| ->loadRequireJsModule('TYPO3/CMS/Examples/GitHubLinkHandler'); | ||
|
|
||
| $this->view->assign('project', $this->configuration['project']); | ||
| $this->view->assign('action', $this->configuration['action']); | ||
| $this->view->assign('github', !empty($this->linkParts) ? $this->linkParts['url']['github'] : ''); | ||
| return $this->view->render('GitHub'); | ||
| } | ||
|
|
||
| /** | ||
| * @return string[] Array of body-tag attributes | ||
| */ | ||
| public function getBodyTagAttributes(): array | ||
| { | ||
| return []; | ||
| } | ||
|
|
||
| /** | ||
| * @return array | ||
| */ | ||
| public function getLinkAttributes() | ||
| { | ||
| return $this->linkAttributes; | ||
| } | ||
|
|
||
| /** | ||
| * @param string[] $fieldDefinitions Array of link attribute field definitions | ||
| * @return string[] | ||
| */ | ||
| public function modifyLinkAttributes(array $fieldDefinitions) | ||
| { | ||
| return $fieldDefinitions; | ||
| } | ||
|
|
||
| /** | ||
| * We don't support updates since there is no difference to simply set the link again. | ||
| * | ||
| * @return bool | ||
| */ | ||
| public function isUpdateSupported() | ||
| { | ||
| return false; | ||
| } | ||
| } |
12 changes: 12 additions & 0 deletions
12
Documentation/ApiOverview/LinkHandling/Linkhandler/_CustomLinkHandlers/_page.tsconfig
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,12 @@ | ||
| TCEMAIN.linkHandler { | ||
| github { | ||
| handler = T3docs\\Examples\\LinkHandler\\GitHubLinkHandler | ||
| label = LLL:EXT:examples/Resources/Private/Language/locallang_browse_links.xlf:github | ||
| displayAfter = url | ||
| scanBefore = url | ||
| configuration { | ||
| project = TYPO3-Documentation/TYPO3CMS-Reference-CoreApi | ||
| action = issues | ||
| } | ||
| } | ||
| } |