From: Stefan Neufeind <typo3.neufeind@speedpartner.de>
Date: Thu, 16 May 2013 23:36:14 +0000 (+0200)
Subject: [TASK] Update phpdoc of pi_getPageLink/pi_linkToPage
X-Git-Tag: TYPO3_6-2-0alpha1~39
X-Git-Url: http://git.typo3.org/Packages/TYPO3.CMS.git/commitdiff_plain/66e556b6576c8d3c7b58d3d616a53a5df7569a46?hp=cc468faa601121872c8cec381b2d2d3381206ecb

[TASK] Update phpdoc of pi_getPageLink/pi_linkToPage

Calls methods in contentObjectRenderer and thus
should match that phpdoc over there (especially
giving a hint about what to urlencode and what not).

Resolves: #48316
Releases: 6.2
Change-Id: Id932763dc06ffaad09f169aff9ac9457d890a777
Reviewed-on: https://review.typo3.org/20856
Reviewed-by: Wouter Wolters
Tested-by: Wouter Wolters
---

diff --git a/typo3/sysext/frontend/Classes/Plugin/AbstractPlugin.php b/typo3/sysext/frontend/Classes/Plugin/AbstractPlugin.php
index ac9098609a7a..d9d809fe43d2 100644
--- a/typo3/sysext/frontend/Classes/Plugin/AbstractPlugin.php
+++ b/typo3/sysext/frontend/Classes/Plugin/AbstractPlugin.php
@@ -279,9 +279,10 @@ class AbstractPlugin {
 	 *
 	 * @param integer $id Page id
 	 * @param string $target Target value to use. Affects the &type-value of the URL, defaults to current.
-	 * @param array $urlParameters Additional URL parameters to set (key/value pairs)
+	 * @param array|string $urlParameters As an array key/value pairs represent URL parameters to set. Values NOT URL-encoded yet, keys should be URL-encoded if needed. As a string the parameter is expected to be URL-encoded already.
 	 * @return string The resulting URL
 	 * @see pi_linkToPage()
+	 * @see \TYPO3\CMS\Frontend\ContentObject\ContentObjectRenderer->getTypoLink()
 	 * @todo Define visibility
 	 */
 	public function pi_getPageLink($id, $target = '', $urlParameters = array()) {
@@ -296,7 +297,7 @@ class AbstractPlugin {
 	 * @param string $str The content string to wrap in <a> tags
 	 * @param integer $id Page id
 	 * @param string $target Target value to use. Affects the &type-value of the URL, defaults to current.
-	 * @param array $urlParameters Additional URL parameters to set (key/value pairs)
+	 * @param array|string $urlParameters As an array key/value pairs represent URL parameters to set. Values NOT URL-encoded yet, keys should be URL-encoded if needed. As a string the parameter is expected to be URL-encoded already.
 	 * @return string The input string wrapped in <a> tags with the URL and target set.
 	 * @see pi_getPageLink(), \TYPO3\CMS\Frontend\ContentObject\ContentObjectRenderer::getTypoLink()
 	 * @todo Define visibility