[TASK] Streamline phpdoc annotations in EXT:extbase
[Packages/TYPO3.CMS.git] / typo3 / sysext / extbase / Classes / Mvc / Web / Routing / UriBuilder.php
index 10b6891..9eeb313 100644 (file)
@@ -23,8 +23,6 @@ use TYPO3\CMS\Extbase\Mvc\Web\Request as WebRequest;
 
 /**
  * An URI Builder
- *
- * @api
  */
 class UriBuilder
 {
@@ -134,6 +132,7 @@ class UriBuilder
 
     /**
      * @param \TYPO3\CMS\Extbase\Configuration\ConfigurationManagerInterface $configurationManager
+     * @internal only to be used within Extbase, not part of TYPO3 Core API.
      */
     public function injectConfigurationManager(\TYPO3\CMS\Extbase\Configuration\ConfigurationManagerInterface $configurationManager)
     {
@@ -142,6 +141,7 @@ class UriBuilder
 
     /**
      * @param \TYPO3\CMS\Extbase\Service\ExtensionService $extensionService
+     * @internal only to be used within Extbase, not part of TYPO3 Core API.
      */
     public function injectExtensionService(\TYPO3\CMS\Extbase\Service\ExtensionService $extensionService)
     {
@@ -150,6 +150,7 @@ class UriBuilder
 
     /**
      * @param \TYPO3\CMS\Extbase\Service\EnvironmentService $environmentService
+     * @internal only to be used within Extbase, not part of TYPO3 Core API.
      */
     public function injectEnvironmentService(\TYPO3\CMS\Extbase\Service\EnvironmentService $environmentService)
     {
@@ -158,6 +159,7 @@ class UriBuilder
 
     /**
      * Life-cycle method that is called by the DI container as soon as this object is completely built
+     * @internal only to be used within Extbase, not part of TYPO3 Core API.
      */
     public function initializeObject()
     {
@@ -169,6 +171,7 @@ class UriBuilder
      *
      * @param Request $request
      * @return \TYPO3\CMS\Extbase\Mvc\Web\Routing\UriBuilder the current UriBuilder to allow method chaining
+     * @internal only to be used within Extbase, not part of TYPO3 Core API.
      */
     public function setRequest(Request $request)
     {
@@ -178,6 +181,7 @@ class UriBuilder
 
     /**
      * @return Request
+     * @internal only to be used within Extbase, not part of TYPO3 Core API.
      */
     public function getRequest()
     {
@@ -191,7 +195,6 @@ class UriBuilder
      *
      * @param array $arguments
      * @return \TYPO3\CMS\Extbase\Mvc\Web\Routing\UriBuilder the current UriBuilder to allow method chaining
-     * @api
      */
     public function setArguments(array $arguments)
     {
@@ -201,7 +204,6 @@ class UriBuilder
 
     /**
      * @return array
-     * @api
      */
     public function getArguments()
     {
@@ -213,7 +215,6 @@ class UriBuilder
      *
      * @param string $section
      * @return \TYPO3\CMS\Extbase\Mvc\Web\Routing\UriBuilder the current UriBuilder to allow method chaining
-     * @api
      */
     public function setSection($section)
     {
@@ -223,7 +224,6 @@ class UriBuilder
 
     /**
      * @return string
-     * @api
      */
     public function getSection()
     {
@@ -235,7 +235,6 @@ class UriBuilder
      *
      * @param string $format
      * @return \TYPO3\CMS\Extbase\Mvc\Web\Routing\UriBuilder the current UriBuilder to allow method chaining
-     * @api
      */
     public function setFormat($format)
     {
@@ -245,7 +244,6 @@ class UriBuilder
 
     /**
      * @return string
-     * @api
      */
     public function getFormat()
     {
@@ -257,7 +255,6 @@ class UriBuilder
      *
      * @param bool $createAbsoluteUri
      * @return \TYPO3\CMS\Extbase\Mvc\Web\Routing\UriBuilder the current UriBuilder to allow method chaining
-     * @api
      */
     public function setCreateAbsoluteUri($createAbsoluteUri)
     {
@@ -267,7 +264,6 @@ class UriBuilder
 
     /**
      * @return bool
-     * @api
      */
     public function getCreateAbsoluteUri()
     {
@@ -276,6 +272,7 @@ class UriBuilder
 
     /**
      * @return string
+     * @internal only to be used within Extbase, not part of TYPO3 Core API.
      */
     public function getAbsoluteUriScheme()
     {
@@ -287,6 +284,7 @@ class UriBuilder
      *
      * @param string $absoluteUriScheme the scheme to be used for absolute URIs
      * @return \TYPO3\CMS\Extbase\Mvc\Web\Routing\UriBuilder the current UriBuilder to allow method chaining
+     * @internal only to be used within Extbase, not part of TYPO3 Core API.
      */
     public function setAbsoluteUriScheme($absoluteUriScheme)
     {
@@ -299,7 +297,6 @@ class UriBuilder
      *
      * @param bool $addQueryString
      * @return \TYPO3\CMS\Extbase\Mvc\Web\Routing\UriBuilder the current UriBuilder to allow method chaining
-     * @api
      * @see TSref/typolink.addQueryString
      */
     public function setAddQueryString($addQueryString)
@@ -310,7 +307,6 @@ class UriBuilder
 
     /**
      * @return bool
-     * @api
      */
     public function getAddQueryString()
     {
@@ -323,7 +319,6 @@ class UriBuilder
      *
      * @param string $addQueryStringMethod
      * @return \TYPO3\CMS\Extbase\Mvc\Web\Routing\UriBuilder the current UriBuilder to allow method chaining
-     * @api
      * @see TSref/typolink.addQueryString.method
      */
     public function setAddQueryStringMethod($addQueryStringMethod)
@@ -334,7 +329,6 @@ class UriBuilder
 
     /**
      * @return string
-     * @api
      */
     public function getAddQueryStringMethod()
     {
@@ -347,7 +341,6 @@ class UriBuilder
      *
      * @param array $argumentsToBeExcludedFromQueryString
      * @return \TYPO3\CMS\Extbase\Mvc\Web\Routing\UriBuilder the current UriBuilder to allow method chaining
-     * @api
      * @see TSref/typolink.addQueryString.exclude
      * @see setAddQueryString()
      */
@@ -359,7 +352,6 @@ class UriBuilder
 
     /**
      * @return array
-     * @api
      */
     public function getArgumentsToBeExcludedFromQueryString()
     {
@@ -371,6 +363,7 @@ class UriBuilder
      *
      * @param string $argumentPrefix
      * @return \TYPO3\CMS\Extbase\Mvc\Web\Routing\UriBuilder the current UriBuilder to allow method chaining
+     * @internal only to be used within Extbase, not part of TYPO3 Core API.
      */
     public function setArgumentPrefix($argumentPrefix)
     {
@@ -380,6 +373,7 @@ class UriBuilder
 
     /**
      * @return string
+     * @internal only to be used within Extbase, not part of TYPO3 Core API.
      */
     public function getArgumentPrefix()
     {
@@ -391,7 +385,6 @@ class UriBuilder
      *
      * @param bool $linkAccessRestrictedPages
      * @return \TYPO3\CMS\Extbase\Mvc\Web\Routing\UriBuilder the current UriBuilder to allow method chaining
-     * @api
      */
     public function setLinkAccessRestrictedPages($linkAccessRestrictedPages)
     {
@@ -401,7 +394,6 @@ class UriBuilder
 
     /**
      * @return bool
-     * @api
      */
     public function getLinkAccessRestrictedPages()
     {
@@ -413,7 +405,6 @@ class UriBuilder
      *
      * @param int $targetPageUid
      * @return \TYPO3\CMS\Extbase\Mvc\Web\Routing\UriBuilder the current UriBuilder to allow method chaining
-     * @api
      */
     public function setTargetPageUid($targetPageUid)
     {
@@ -425,7 +416,6 @@ class UriBuilder
      * returns $this->targetPageUid.
      *
      * @return int
-     * @api
      */
     public function getTargetPageUid()
     {
@@ -437,7 +427,6 @@ class UriBuilder
      *
      * @param int $targetPageType
      * @return \TYPO3\CMS\Extbase\Mvc\Web\Routing\UriBuilder the current UriBuilder to allow method chaining
-     * @api
      */
     public function setTargetPageType($targetPageType)
     {
@@ -447,6 +436,7 @@ class UriBuilder
 
     /**
      * @return int
+     * @internal only to be used within Extbase, not part of TYPO3 Core API.
      */
     public function getTargetPageType()
     {
@@ -459,7 +449,6 @@ class UriBuilder
      *
      * @param bool $noCache
      * @return \TYPO3\CMS\Extbase\Mvc\Web\Routing\UriBuilder the current UriBuilder to allow method chaining
-     * @api
      */
     public function setNoCache($noCache)
     {
@@ -469,7 +458,6 @@ class UriBuilder
 
     /**
      * @return bool
-     * @api
      */
     public function getNoCache()
     {
@@ -482,7 +470,6 @@ class UriBuilder
      *
      * @param bool $useCacheHash
      * @return \TYPO3\CMS\Extbase\Mvc\Web\Routing\UriBuilder the current UriBuilder to allow method chaining
-     * @api
      */
     public function setUseCacheHash($useCacheHash)
     {
@@ -492,7 +479,6 @@ class UriBuilder
 
     /**
      * @return bool
-     * @api
      */
     public function getUseCacheHash()
     {
@@ -504,6 +490,7 @@ class UriBuilder
      * This is only set after build() / uriFor() has been called.
      *
      * @return array The last arguments
+     * @internal only to be used within Extbase, not part of TYPO3 Core API.
      */
     public function getLastArguments()
     {
@@ -514,7 +501,6 @@ class UriBuilder
      * Resets all UriBuilder options to their default value
      *
      * @return \TYPO3\CMS\Extbase\Mvc\Web\Routing\UriBuilder the current UriBuilder to allow method chaining
-     * @api
      */
     public function reset()
     {
@@ -544,7 +530,6 @@ class UriBuilder
      * @param string $extensionName Name of the target extension, without underscores. If not set, current ExtensionName is used.
      * @param string $pluginName Name of the target plugin. If not set, current PluginName is used.
      * @return string the rendered URI
-     * @api
      * @see build()
      */
     public function uriFor($actionName = null, $controllerArguments = [], $controllerName = null, $extensionName = null, $pluginName = null)
@@ -616,7 +601,6 @@ class UriBuilder
      * Depending on the current context this calls buildBackendUri() or buildFrontendUri()
      *
      * @return string The URI
-     * @api
      * @see buildBackendUri()
      * @see buildFrontendUri()
      */
@@ -635,6 +619,7 @@ class UriBuilder
      * will be ignored in the backend.
      *
      * @return string The URI
+     * @internal only to be used within Extbase, not part of TYPO3 Core API.
      */
     public function buildBackendUri()
     {
@@ -712,6 +697,7 @@ class UriBuilder
      *
      * @return string The URI
      * @see buildTypolinkConfiguration()
+     * @internal only to be used within Extbase, not part of TYPO3 Core API.
      */
     public function buildFrontendUri()
     {
@@ -828,6 +814,7 @@ class UriBuilder
      * @param \TYPO3\CMS\Extbase\DomainObject\AbstractDomainObject $object
      * @return array
      * @todo Refactore this into convertDomainObjectsToIdentityArrays()
+     * @internal only to be used within Extbase, not part of TYPO3 Core API.
      */
     public function convertTransientObjectToArray(\TYPO3\CMS\Extbase\DomainObject\AbstractDomainObject $object)
     {