[BUGFIX] phpdoc: $urlParameters can be a string 02/17302/2
authorStefan Neufeind <typo3.neufeind@speedpartner.de>
Tue, 1 Jan 2013 11:01:16 +0000 (12:01 +0100)
committerJigal van Hemert <jigal@xs4all.nl>
Tue, 1 Jan 2013 11:06:26 +0000 (12:06 +0100)
In functions like getTypoLink() $urlParameters can also
be a string. A string is expected to be URL-encoded already,
as an array the keys are expected to be URL-encoded already
but the values not. Clearly point that out in the phpdocs.

Change-Id: Ifc767550464449fc9610f16f2e0d511b84391f60
Fixes: #44263
Releases: 4.5, 4.6, 4.7, 6.0, 6.1
Reviewed-on: https://review.typo3.org/17302
Reviewed-by: Jigal van Hemert
Tested-by: Jigal van Hemert
typo3/sysext/frontend/Classes/ContentObject/ContentObjectRenderer.php

index a4d7b44..5550f08 100644 (file)
@@ -6126,7 +6126,7 @@ class ContentObjectRenderer {
         *
         * @param string $label Text string being wrapped by the link.
         * @param string $params Link parameter; eg. "123" for page id, "kasperYYYY@typo3.com" for email address, "http://...." for URL, "fileadmin/blabla.txt" for file.
-        * @param array $urlParameters An array with key/value pairs representing URL parameters to set. Values NOT URL-encoded yet.
+        * @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.
         * @param string $target Specific target set, if any. (Default is using the current)
         * @return string The wrapped $label-text string
         * @see getTypoLink_URL()
@@ -6155,7 +6155,7 @@ class ContentObjectRenderer {
         * Returns the URL of a "typolink" create from the input parameter string, url-parameters and target
         *
         * @param string $params Link parameter; eg. "123" for page id, "kasperYYYY@typo3.com" for email address, "http://...." for URL, "fileadmin/blabla.txt" for file.
-        * @param array $urlParameters An array with key/value pairs representing URL parameters to set. Values NOT URL-encoded yet.
+        * @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.
         * @param string $target Specific target set, if any. (Default is using the current)
         * @return string The URL
         * @see getTypoLink()
@@ -6182,7 +6182,7 @@ class ContentObjectRenderer {
        /**
         * Returns the current page URL
         *
-        * @param array $urlParameters Optionally you can specify additional URL parameters. An array with key/value pairs representing URL parameters to set. Values NOT URL-encoded yet.
+        * @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.
         * @param integer $id An alternative ID to the current id ($GLOBALS['TSFE']->id)
         * @return string The URL
         * @see getTypoLink_URL()
@@ -6203,7 +6203,7 @@ class ContentObjectRenderer {
         * @todo Define visibility
         */
        public function getClosestMPvalueForPage($pageId, $raw = FALSE) {
-               // MointPoints:
+               // MountPoints:
                if ($GLOBALS['TYPO3_CONF_VARS']['FE']['enable_mount_pids'] && $GLOBALS['TSFE']->MP) {
                        // Same page as current.
                        if (!strcmp($GLOBALS['TSFE']->id, $pageId)) {