[TASK] Streamline phpdoc annotations in EXT:fluid
[Packages/TYPO3.CMS.git] / typo3 / sysext / fluid / Classes / ViewHelpers / Link / ExternalViewHelper.php
index 200c1b8..0aaedbe 100644 (file)
@@ -1,15 +1,20 @@
 <?php
+namespace TYPO3\CMS\Fluid\ViewHelpers\Link;
 
-/*                                                                        *
- * This script is backported from the FLOW3 package "TYPO3.Fluid".        *
- *                                                                        *
- * It is free software; you can redistribute it and/or modify it under    *
- * the terms of the GNU Lesser General Public License, either version 3   *
- *  of the License, or (at your option) any later version.                *
- *                                                                        *
- * The TYPO3 project - inspiring people to share!                         *
- *                                                                        */
+/*
+ * This file is part of the TYPO3 CMS project.
+ *
+ * It is free software; you can redistribute it and/or modify it under
+ * the terms of the GNU General Public License, either version 2
+ * of the License, or any later version.
+ *
+ * For the full copyright and license information, please read the
+ * LICENSE.txt file that was distributed with this source code.
+ *
+ * The TYPO3 project - inspiring people to share!
+ */
 
+use TYPO3Fluid\Fluid\Core\ViewHelper\AbstractTagBasedViewHelper;
 
 /**
  * A view helper for creating links to external targets.
  * <output>
  * <a href="ftp://typo3.org">external ftp link</a>
  * </output>
- *
- * @api
  */
-class Tx_Fluid_ViewHelpers_Link_ExternalViewHelper extends Tx_Fluid_Core_ViewHelper_AbstractTagBasedViewHelper {
+class ExternalViewHelper extends AbstractTagBasedViewHelper
+{
+    /**
+     * @var string
+     */
+    protected $tagName = 'a';
 
-       /**
-        * @var string
-        */
-       protected $tagName = 'a';
+    /**
+     * Initialize arguments
+     */
+    public function initializeArguments()
+    {
+        parent::initializeArguments();
+        $this->registerArgument('uri', 'string', 'The URI that will be put in the href attribute of the rendered link tag', true);
+        $this->registerArgument('defaultScheme', 'string', 'Scheme the href attribute will be prefixed with if specified $uri does not contain a scheme already', false, 'http');
+        $this->registerUniversalTagAttributes();
+        $this->registerTagAttribute('name', 'string', 'Specifies the name of an anchor');
+        $this->registerTagAttribute('rel', 'string', 'Specifies the relationship between the current document and the linked document');
+        $this->registerTagAttribute('rev', 'string', 'Specifies the relationship between the linked document and the current document');
+        $this->registerTagAttribute('target', 'string', 'Specifies where to open the linked document');
+    }
 
-       /**
-        * Initialize arguments
-        *
-        * @return void
-        * @api
-        */
-       public function initializeArguments() {
-               $this->registerUniversalTagAttributes();
-               $this->registerTagAttribute('name', 'string', 'Specifies the name of an anchor');
-               $this->registerTagAttribute('rel', 'string', 'Specifies the relationship between the current document and the linked document');
-               $this->registerTagAttribute('rev', 'string', 'Specifies the relationship between the linked document and the current document');
-               $this->registerTagAttribute('target', 'string', 'Specifies where to open the linked document');
-       }
+    /**
+     * @return string Rendered link
+     */
+    public function render()
+    {
+        $uri = $this->arguments['uri'];
+        $defaultScheme = $this->arguments['defaultScheme'];
 
-       /**
-        * @param string $uri the URI that will be put in the href attribute of the rendered link tag
-        * @param string $defaultScheme scheme the href attribute will be prefixed with if specified $uri does not contain a scheme already
-        * @return string Rendered link
-        * @api
-        */
-       public function render($uri, $defaultScheme = 'http') {
-               $scheme = parse_url($uri, PHP_URL_SCHEME);
-               if ($scheme === NULL && $defaultScheme !== '') {
-                       $uri = $defaultScheme . '://' . $uri;
-               }
-               $this->tag->addAttribute('href', $uri);
-               $this->tag->setContent($this->renderChildren());
-               $this->tag->forceClosingTag(TRUE);
+        $scheme = parse_url($uri, PHP_URL_SCHEME);
+        if ($scheme === null && $defaultScheme !== '') {
+            $uri = $defaultScheme . '://' . $uri;
+        }
+        $this->tag->addAttribute('href', $uri);
+        $this->tag->setContent($this->renderChildren());
+        $this->tag->forceClosingTag(true);
 
-               return $this->tag->render();
-       }
+        return $this->tag->render();
+    }
 }
-
-
-?>
\ No newline at end of file