[TASK] Update phpdoc of pi_getPageLink/pi_linkToPage

[Packages/TYPO3.CMS.git] / typo3 / sysext / frontend / Classes / Plugin / AbstractPlugin.php

diff --git a/typo3/sysext/frontend/Classes/Plugin/AbstractPlugin.php b/typo3/sysext/frontend/Classes/Plugin/AbstractPlugin.php
index ac90986..d9d809f 100644 (file)
--- 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 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()
         * @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()) {
         * @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 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
         * @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