[TASK] Update phpdoc of pi_getPageLink/pi_linkToPage 56/20856/4
authorStefan Neufeind <typo3.neufeind@speedpartner.de>
Thu, 16 May 2013 23:36:14 +0000 (01:36 +0200)
committerWouter Wolters <typo3@wouterwolters.nl>
Sun, 19 May 2013 16:23:51 +0000 (18:23 +0200)
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
typo3/sysext/frontend/Classes/Plugin/AbstractPlugin.php

index ac90986..d9d809f 100644 (file)
@@ -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