sminnee / silverstripe-framework

src/View/SSTemplateParser.php

Doc Comments +7 added lines, -3 removed lines

@@ -95,6 +95,8 @@ 
 
     /**
      * Override the function that constructs the result arrays to also prepare a 'php' item in the array
+     * @param string $matchrule
+     * @param string $name
      */
     function construct($matchrule, $name, $arguments = null)
     {
@@ -163,9 +165,9 @@ 
 
     /**
      * Ensures that the arguments to addOpenBlock and addClosedBlock are valid
-     * @param $name
-     * @param $callable
-     * @param $type
+     * @param string $name
+     * @param callable $callable
+     * @param string $type
      * @throws InvalidArgumentException
      */
     protected function validateExtensionBlock($name, $callable, $type)
@@ -924,6 +926,7 @@ 
      * The basic generated PHP of LookupStep and LastLookupStep is the same, except that LookupStep calls 'obj' to
      * get the next ViewableData in the sequence, and LastLookupStep calls different methods (XML_val, hasValue, obj)
      * depending on the context the lookup is used in.
+     * @param string $method
      */
     function Lookup_AddLookupStep(&$res, $sub, $method)
     {
@@ -6477,6 +6480,7 @@ 
 
     /**
      * @param string $code
+     * @param string $templateName
      * @return string $code
      */
     protected function includeDebuggingComments($code, $templateName)

src/View/SSTemplateParser.php.inc

Doc Comments +7 added lines, -3 removed lines

@@ -116,6 +116,8 @@ 
 
     /**
      * Override the function that constructs the result arrays to also prepare a 'php' item in the array
+     * @param string $matchrule
+     * @param string $name
      */
     public function construct($matchrule, $name, $arguments = null)
     {
@@ -184,9 +186,9 @@ 
 
     /**
      * Ensures that the arguments to addOpenBlock and addClosedBlock are valid
-     * @param $name
-     * @param $callable
-     * @param $type
+     * @param string $name
+     * @param callable $callable
+     * @param string $type
      * @throws InvalidArgumentException
      */
     protected function validateExtensionBlock($name, $callable, $type)
@@ -277,6 +279,7 @@ 
      * The basic generated PHP of LookupStep and LastLookupStep is the same, except that LookupStep calls 'obj' to
      * get the next ViewableData in the sequence, and LastLookupStep calls different methods (XML_val, hasValue, obj)
      * depending on the context the lookup is used in.
+     * @param string $method
      */
     public function Lookup_AddLookupStep(&$res, $sub, $method)
     {
@@ -1279,6 +1282,7 @@ 
 
     /**
      * @param string $code
+     * @param string $templateName
      * @return string $code
      */
     protected function includeDebuggingComments($code, $templateName)

src/View/SSViewer.php

Doc Comments +4 added lines, -1 removed lines

@@ -648,7 +648,7 @@ 
      * @param mixed $data Data context
      * @param array $arguments Additional arguments
      * @param Object $scope
-     * @return string Evaluated result
+     * @return DBHTMLText Evaluated result
      */
     public static function execute_template($template, $data, $arguments = null, $scope = null)
     {
@@ -676,6 +676,9 @@ 
         return $v->process($data, $arguments);
     }
 
+    /**
+     * @param string $content
+     */
     public function parseTemplateContent($content, $template = "")
     {
         return $this->getParser()->compileString(

src/View/SSViewer_DataPresenter.php

Doc Comments +8 added lines

@@ -33,6 +33,10 @@ 
      */
     protected $underlay;
 
+    /**
+     * @param ViewableData $item
+     * @param ViewableData $inheritedScope
+     */
     public function __construct($item, $overlay = null, $underlay = null, $inheritedScope = null)
     {
         parent::__construct($item, $inheritedScope);
@@ -65,6 +69,10 @@ 
         $this->underlay = $underlay ? $underlay : array();
     }
 
+    /**
+     * @param string $interfaceToQuery
+     * @param string $variableMethod
+     */
     protected function createCallableArray(&$extraArray, $interfaceToQuery, $variableMethod, $createObject = false)
     {
         $implementers = ClassInfo::implementorsOf($interfaceToQuery);

src/View/SSViewer_FromString.php

Doc Comments +3 added lines

@@ -30,6 +30,9 @@
      */
     protected $cacheTemplate;
 
+    /**
+     * @param string $content
+     */
     public function __construct($content, TemplateParser $parser = null)
     {
         if ($parser) {

tests/php/Assets/Storage/AssetStoreTest/TestStore.php

Doc Comments +6 added lines

@@ -634,6 +634,9 @@ 
 	}
 
 
+	/**
+	 * @param string $fileID
+	 */
 	public function getOriginalFilename($fileID) {
 		return parent::getOriginalFilename($fileID);
 	}
@@ -642,6 +645,9 @@ 
 		return parent::removeVariant($fileID);
 	}
 
+	/**
+	 * @param null|string $variant
+	 */
 	public function getDefaultConflictResolution($variant) {
 		return parent::getDefaultConflictResolution($variant);
 	}

tests/php/Core/Manifest/ConfigManifestTest.php

Doc Comments +3 added lines, -2 removed lines

@@ -10,7 +10,7 @@ 
 
 	/**
 	 * This is a helper method for getting a new manifest
-	 * @param $name
+	 * @param string $name
 	 * @return any
 	 */
 	protected function getConfigFixtureValue($name) {
@@ -20,6 +20,7 @@ 
 
 	/**
 	 * This is a helper method for displaying a relevant message about a parsing failure
+	 * @param string $path
 	 */
 	protected function getParsedAsMessage($path) {
 		return sprintf('Reference path "%s" failed to parse correctly', $path);
@@ -41,7 +42,7 @@ 
 
 	/**
 	 * A helper method to return a mock of the manifest in order to test expectations and reduce dependency
-	 * @param $methods
+	 * @param string[] $methods
 	 * @return SS_ConfigManifest
 	 */
 	protected function getManifestMock($methods) {

tests/php/Core/ObjectTest/Extending.php

Doc Comments +5 added lines

@@ -608,6 +608,11 @@
 		'ObjectTest_Extending_Extension'
 	);
 
+	/**
+	 * @param integer $first
+	 * @param integer $second
+	 * @param integer $third
+	 */
 	public function getResults(&$first, &$second, &$third) {
 		// Before extending should be invoked second
 		$this->beforeExtending('updateResult', function(&$first, &$second, &$third) {

tests/php/Core/Startup/ErrorControlChainTest.php

Doc Comments +5 added lines, -1 removed lines

@@ -24,7 +24,7 @@ 
 	/**
 	 * Modify method visibility to public for testing
 	 *
-	 * @param mixed $errors
+	 * @param string $errors
 	 */
 	public function setDisplayErrors($errors)
 	{
@@ -33,6 +33,10 @@ 
 	}
 
 	// Change function visibility to be testable directly
+
+	/**
+	 * @param string $memstring
+	 */
 	public function translateMemstring($memstring) {
 		return parent::translateMemstring($memstring);
 	}