[TASK] Comment and non-functional changes
authorSebastian Kurfuerst <sebastian@typo3.org>
Fri, 27 May 2011 05:19:55 +0000 (07:19 +0200)
committerSebastian Kurfuerst <sebastian@typo3.org>
Mon, 20 Jun 2011 07:45:11 +0000 (09:45 +0200)
... appeared during bringing Fluid v4 and v5 in sync again

Change-Id: I326663606a917ad84fa82a736a536ff77863a0b3

22 files changed:
typo3/sysext/fluid/Classes/Core/Parser/Interceptor/Escape.php
typo3/sysext/fluid/Classes/Core/Parser/SyntaxTree/ObjectAccessorNode.php
typo3/sysext/fluid/Classes/Core/Parser/SyntaxTree/ViewHelperNode.php
typo3/sysext/fluid/Classes/Core/Parser/TemplateParser.php
typo3/sysext/fluid/Classes/Core/Rendering/RenderingContext.php
typo3/sysext/fluid/Classes/Core/Widget/AbstractWidgetViewHelper.php
typo3/sysext/fluid/Classes/View/AbstractTemplateView.php
typo3/sysext/fluid/Classes/View/TemplateView.php
typo3/sysext/fluid/Classes/ViewHelpers/CycleViewHelper.php
typo3/sysext/fluid/Classes/ViewHelpers/Form/AbstractFormFieldViewHelper.php
typo3/sysext/fluid/Classes/ViewHelpers/Form/AbstractFormViewHelper.php
typo3/sysext/fluid/Classes/ViewHelpers/Form/PasswordViewHelper.php
typo3/sysext/fluid/Classes/ViewHelpers/Form/SelectViewHelper.php
typo3/sysext/fluid/Classes/ViewHelpers/Form/TextboxViewHelper.php
typo3/sysext/fluid/Classes/ViewHelpers/Form/TextfieldViewHelper.php
typo3/sysext/fluid/Classes/ViewHelpers/Format/DateViewHelper.php
typo3/sysext/fluid/Classes/ViewHelpers/GroupedForViewHelper.php
typo3/sysext/fluid/Classes/ViewHelpers/LayoutViewHelper.php
typo3/sysext/fluid/Classes/ViewHelpers/Link/ExternalViewHelper.php
typo3/sysext/fluid/Classes/ViewHelpers/Uri/ExternalViewHelper.php
typo3/sysext/fluid/Tests/Unit/Core/ViewHelper/TemplateVariableContainerTest.php
typo3/sysext/fluid/Tests/Unit/ViewHelpers/FormViewHelperTest.php

index 66ce822..7a62d11 100644 (file)
@@ -47,6 +47,8 @@ class Tx_Fluid_Core_Parser_Interceptor_Escape implements Tx_Fluid_Core_Parser_In
        protected $objectManager;
 
        /**
+        * Inject object manager
+        *
         * @param Tx_Extbase_Object_ObjectManagerInterface $objectManager
         * @return void
         * @author Karsten Dambekalns <karsten@typo3.org>
index 0d15257..71c1736 100644 (file)
@@ -76,6 +76,7 @@ class Tx_Fluid_Core_Parser_SyntaxTree_ObjectAccessorNode extends Tx_Fluid_Core_P
         *
         * @param mixed $subject An object or array
         * @param string $propertyPath
+        * @param Tx_Fluid_Core_Rendering_RenderingContextInterface $renderingContext
         * @return mixed Value of the property
         */
        protected function getPropertyPath($subject, $propertyPath, Tx_Fluid_Core_Rendering_RenderingContextInterface $renderingContext) {
index df2e09a..08b8d8a 100644 (file)
@@ -93,12 +93,7 @@ class Tx_Fluid_Core_Parser_SyntaxTree_ViewHelperNode extends Tx_Fluid_Core_Parse
                $this->uninitializedViewHelper = $viewHelper;
                $this->viewHelpersByContext = t3lib_div::makeInstance('Tx_Extbase_Persistence_ObjectStorage');
                $this->arguments = $arguments;
-
-               if (FALSE /*FIXME*/) {
-                       $this->viewHelperClassName = $this->uninitializedViewHelper->FLOW3_AOP_Proxy_getProxyTargetClassName();
-               } else {
-                       $this->viewHelperClassName = get_class($this->uninitializedViewHelper);
-               }
+               $this->viewHelperClassName = get_class($this->uninitializedViewHelper);
        }
 
        /**
@@ -188,6 +183,7 @@ class Tx_Fluid_Core_Parser_SyntaxTree_ViewHelperNode extends Tx_Fluid_Core_Parse
         *
         * @param Tx_Fluid_Core_Parser_SyntaxTree_AbstractNode $syntaxTreeNode Value to be converted
         * @param string $type Target type
+        * @param Tx_Fluid_Core_Rendering_RenderingContextInterface $renderingContext
         * @return mixed New value
         * @author Sebastian Kurfürst <sebastian@typo3.org>
         * @author Bastian Waidelich <bastian@typo3.org>
index 9d8a928..64864ce 100644 (file)
@@ -288,6 +288,8 @@ class Tx_Fluid_Core_Parser_TemplateParser implements t3lib_Singleton {
        }
 
        /**
+        * Inject object factory
+        *
         * @param Tx_Extbase_Object_ObjectManagerInterface $objectManager
         * @return void
         * @author Sebastian Kurfürst <sebastian@typo3.org>
index a7ab53d..cada727 100644 (file)
@@ -57,6 +57,8 @@ class Tx_Fluid_Core_Rendering_RenderingContext implements Tx_Fluid_Core_Renderin
        protected $viewHelperVariableContainer;
 
        /**
+        * Inject the object manager
+        *
         * @param Tx_Extbase_Object_ObjectManagerInterface $objectManager
         * @author Sebastian Kurfürst <sebastian@typo3.org>
         */
index e43e1af..4353e46 100644 (file)
@@ -151,7 +151,7 @@ abstract class Tx_Fluid_Core_Widget_AbstractWidgetViewHelper extends Tx_Fluid_Co
         * Initiate a sub request to $this->controller. Make sure to fill $this->controller
         * via Dependency Injection.
         *
-        * @return Tx_Extbase_MVC_Response the response of this request.
+        * @return Tx_Extbase_MVC_ResponseInterface the response of this request.
         * @api
         * @author Sebastian Kurfürst <sebastian@typo3.org>
         */
index 7586690..1e3b4fc 100644 (file)
@@ -68,6 +68,8 @@ abstract class Tx_Fluid_View_AbstractTemplateView implements Tx_Extbase_MVC_View
        protected $renderingStack = array();
 
        /**
+        * Injects the Object Manager
+        *
         * @param Tx_Extbase_Object_ObjectManagerInterface $objectManager
         * @return void
         * @author Robert Lemke <robert@typo3.org>
@@ -103,7 +105,7 @@ abstract class Tx_Fluid_View_AbstractTemplateView implements Tx_Extbase_MVC_View
        /**
         * Sets the current controller context
         *
-        * @param Tx_Extbase_MVC_Controller_ControllerContext $controllerContext
+        * @param Tx_Extbase_MVC_Controller_ControllerContext $controllerContext Controller context which is available inside the view
         * @return void
         * @author Robert Lemke <robert@typo3.org>
         * @api
@@ -318,11 +320,11 @@ abstract class Tx_Fluid_View_AbstractTemplateView implements Tx_Extbase_MVC_View
         * @param Tx_Fluid_Core_Parser_ParsedTemplateInterface $parsedTemplate
         * @return string the Layout name
         * @author Sebastian Kurfürst <sebastian@typo3.org>
+        * @author Rens Admiraal <r.admiraal@drecomm.nl>
         */
        protected function getLayoutNameInTemplate(Tx_Fluid_Core_Parser_ParsedTemplateInterface $parsedTemplate) {
                if ($this->isLayoutDefinedInTemplate($parsedTemplate)) {
                        $layoutNameNode = $parsedTemplate->getVariableContainer()->get('layoutName');
-
                        $layoutName = $layoutNameNode->evaluate($this->baseRenderingContext);
                        if (!empty($layoutName)) {
                                return $layoutName;
@@ -395,7 +397,7 @@ abstract class Tx_Fluid_View_AbstractTemplateView implements Tx_Extbase_MVC_View
         * By default we assume that the view implementation can handle all kinds of
         * contexts. Override this method if that is not the case.
         *
-        * @param Tx_Extbase_MVC_Controller_ControllerContext $controllerContext
+        * @param Tx_Extbase_MVC_Controller_ControllerContext $controllerContext Controller context which is available inside the view
         * @return boolean TRUE if the view has something useful to display, otherwise FALSE
         * @api
         */
index 4864037..7fab59e 100644 (file)
@@ -133,6 +133,7 @@ class Tx_Fluid_View_TemplateView extends Tx_Fluid_View_AbstractTemplateView {
        /**
         * Checks whether a template can be resolved for the current request context.
         *
+        * @param Tx_Extbase_MVC_Controller_ControllerContext $controllerContext Controller context which is available inside the view
         * @return boolean
         * @author Karsten Dambekalns <karsten@typo3.org>
         * @author Sebastian Kurfürst <sebastian@typo3.org>
@@ -363,7 +364,7 @@ class Tx_Fluid_View_TemplateView extends Tx_Fluid_View_AbstractTemplateView {
         * This continues until both @subpackage and @controller are empty.
         *
         * Example for $bubbleControllerAndSubpackage is TRUE, we have the Tx_Fluid_MySubPackage_Controller_MyController as Controller Object Name and the current format is "html"
-        * If pattern is @templateRoot/@controller/@action.@format, then the resulting array is:
+        * If pattern is @templateRoot/@subpackage/@controller/@action.@format, then the resulting array is:
         *  - Resources/Private/Templates/MySubPackage/My/@action.html
         *  - Resources/Private/Templates/MySubPackage/@action.html
         *  - Resources/Private/Templates/@action.html
@@ -406,6 +407,7 @@ class Tx_Fluid_View_TemplateView extends Tx_Fluid_View_AbstractTemplateView {
                        }
 
                } while($i++ < count($subpackageParts) && $bubbleControllerAndSubpackage);
+
                return $results;
        }
 
index f9797ff..a9c1963 100644 (file)
 class Tx_Fluid_ViewHelpers_CycleViewHelper extends Tx_Fluid_Core_ViewHelper_AbstractViewHelper {
 
        /**
-        * @var array|Tx_Extbase_Persistence_ObjectStorage the values to be iterated through
+        * the values to be iterated through
+        * @var array|Tx_Extbase_Persistence_ObjectStorage
         */
        protected $values = NULL;
 
        /**
-        * @var integer current values index
+        * current values index
+        * @var integer
         */
        protected $currentCycleIndex = NULL;
 
index 547fd8f..b75f376 100644 (file)
@@ -143,6 +143,7 @@ abstract class Tx_Fluid_ViewHelpers_Form_AbstractFormFieldViewHelper extends Tx_
         * @author Bastian Waidelich <bastian@typo3.org>
         */
        protected function getPropertyValue() {
+
                $formObject = $this->viewHelperVariableContainer->get('Tx_Fluid_ViewHelpers_FormViewHelper', 'formObject');
                $propertyName = $this->arguments['property'];
 
index 59e8e97..4b08c94 100644 (file)
@@ -74,6 +74,8 @@ abstract class Tx_Fluid_ViewHelpers_Form_AbstractFormViewHelper extends Tx_Fluid
        /**
         * Renders a hidden form field containing the technical identity of the given object.
         *
+        * @param object $object Object to create the identity field for
+        * @param string $name Name
         * @return string A hidden field containing the Identity (UID in FLOW3, uid in Extbase) of the given object or NULL if the object is unknown to the persistence framework
         * @author Robert Lemke <robert@typo3.org>
         * @author Karsten Dambekalns <karsten@typo3.org>
@@ -83,8 +85,7 @@ abstract class Tx_Fluid_ViewHelpers_Form_AbstractFormViewHelper extends Tx_Fluid
        protected function renderHiddenIdentityField($object, $name) {
                if (!is_object($object)
                        || !($object instanceof Tx_Extbase_DomainObject_AbstractDomainObject)
-                       || ($object->_isNew() && !$object->_isClone())
-                       ){
+                       || ($object->_isNew() && !$object->_isClone())) {
                        return '';
                }
                // Intentionally NOT using PersistenceManager::getIdentifierByObject here!!
index 8ab565b..cd1ec1d 100644 (file)
@@ -23,7 +23,7 @@
 /**
  * View Helper which creates a simple Password Text Box (<input type="password">).
  *
 * = Examples =
+ * = Examples =
  *
  * <code title="Example">
  * <f:form.password name="myPassword" />
index deb8654..b8a332f 100644 (file)
@@ -71,7 +71,7 @@ class Tx_Fluid_ViewHelpers_Form_SelectViewHelper extends Tx_Fluid_ViewHelpers_Fo
        protected $tagName = 'select';
 
        /**
-        * @var mixed the selected value
+        * @var mixed
         */
        protected $selectedValue = NULL;
 
@@ -214,6 +214,7 @@ class Tx_Fluid_ViewHelpers_Form_SelectViewHelper extends Tx_Fluid_ViewHelpers_Fo
        /**
         * Render the option tags.
         *
+        * @param mixed $value Value to check for
         * @return boolean TRUE if the value should be marked a s selected; FALSE otherwise
         * @author Bastian Waidelich <bastian@typo3.org>
         * @author Jochen Rau <jochen.rau@typoplanet.de>
index b84d2e6..75014b3 100644 (file)
@@ -25,7 +25,7 @@
  *
  * View Helper which creates a simple Text Box (<input type="text">).
  *
 * = Examples =
+ * = Examples =
  *
  * <code title="Example">
  * <f:form.textbox name="myTextBox" value="default value" />
index dce3f4d..163aed2 100644 (file)
@@ -23,7 +23,7 @@
 /**
  * View Helper which creates a text field (<input type="text">).
  *
 * = Examples =
+ * = Examples =
  *
  * <code title="Example">
  * <f:form.textfield name="myTextBox" value="default value" />
index 3b27041..6eaa2b2 100644 (file)
  * (depending on the current time)
  * </output>
  *
- * <code title="Localized dates using strftime date format">
- * <f:format.date format="%d. %B %Y">{dateObject}</f:format.date>
- * </code>
- * <output>
- * 13. Dezember 1980
- * (depending on the current date and defined locale. In the example you see the 1980-12-13 in a german locale)
- * </output>
- *
  * <code title="strtotime string">
  * <f:format.date format="d.m.Y - H:i:s">+1 week 2 days 4 hours 2 seconds</f:format.date>
  * </code>
index b3c9f5b..b9e433e 100644 (file)
@@ -33,9 +33,9 @@
  *   </f:for>
  * </f:groupedFor>
  * </code>
- *
- * Output:
+ * <output>
  * apple cherry strawberry banana
+ * </output>
  *
  * <code title="Two dimensional list">
  * <ul>
index 8683e21..ad46ada 100644 (file)
 
 /**
  * With this tag, you can select a layout to be used for the current template.
- * <code><f:layout name="main" /></code>
+ *
+ * = Examples =
+ *
+ * <code>
+ * <f:layout name="main" />
+ * </code>
+ * <output>
+ * (no output)
+ * </output>
  *
  * @license http://www.gnu.org/licenses/lgpl.html GNU Lesser General Public License, version 3 or later
  * @api
@@ -71,5 +79,4 @@ class Tx_Fluid_ViewHelpers_LayoutViewHelper extends Tx_Fluid_Core_ViewHelper_Abs
        }
 }
 
-
 ?>
index 690c3ea..1470144 100644 (file)
  * <a href="http://www.typo3.org" target="_blank">external link</a>
  * </output>
  *
+ * <code title="custom default scheme">
+ * <f:link.external uri="typo3.org" defaultScheme="ftp">external ftp link</f:link.external>
+ * </code>
+ * <output>
+ * <a href="ftp://typo3.org">external ftp link</a>
+ * </output>
+ *
  * @license http://www.gnu.org/licenses/lgpl.html GNU Lesser General Public License, version 3 or later
  * @api
  */
index 1d87418..66e5619 100644 (file)
  * http://www.typo3.org
  * </output>
  *
+ * <code title="custom default scheme">
+ * <f:uri.external uri="typo3.org" defaultScheme="ftp" />
+ * </code>
+ * <output>
+ * ftp://typo3.org
+ * </output>
+ *
  * @license http://www.gnu.org/licenses/lgpl.html GNU Lesser General Public License, version 3 or later
  * @api
  */
 class Tx_Fluid_ViewHelpers_Uri_ExternalViewHelper extends Tx_Fluid_Core_ViewHelper_AbstractViewHelper {
 
        /**
-        * @param string $uri the target URI
-        * @param string $defaultScheme scheme the result will be prefixed with if specified $uri does not contain a scheme already
-        * @return string rendered URI
+        * @param string $uri target URI
+        * @param string $defaultScheme scheme the href attribute will be prefixed with if specified $uri does not contain a scheme already
+        * @return string Rendered URI
         * @author Bastian Waidelich <bastian@typo3.org>
         * @api
         */
index 8a0338f..ff9262e 100644 (file)
@@ -33,6 +33,7 @@ class Tx_Fluid_Tests_Unit_Core_ViewHelper_TemplateVariableContainerTest extends
        public function setUp() {
                $this->variableContainer = new Tx_Fluid_Core_ViewHelper_TemplateVariableContainer();
        }
+
        /**
         * @author Sebastian Kurfürst <sebastian@typo3.org>
         */
index 1ad4fe3..a9fd64f 100644 (file)
  * The TYPO3 project - inspiring people to share!                         *
  *                                                                        */
 
-/**
- */
-
 require_once(dirname(__FILE__) . '/ViewHelperBaseTestcase.php');
 
 /**
+ * Test for the Form view helper
+ *
+ * @license http://www.gnu.org/licenses/lgpl.html GNU Lesser General Public License, version 3 or later
  */
 class Tx_Fluid_Tests_Unit_ViewHelpers_FormViewHelperTest extends Tx_Fluid_ViewHelpers_ViewHelperBaseTestcase {
        /**