sminnee / silverstripe-framework

tests/view/ViewableDataTest.php

Doc Comments +3 added lines

@@ -252,6 +252,9 @@
 
 class ViewableDataTest_Container extends ViewableData {
 
+	/**
+	 * @param ViewableDataTest_Castable $failover
+	 */
 	public function __construct($failover) {
 		$this->failover = $failover;
 		parent::__construct();

view/ArrayData.php

Doc Comments +4 added lines, -10 removed lines

@@ -50,14 +50,7 @@ 
 	/**
 	 * Gets a field from this object.
 	 *
-	 * @param string $field
-	 *
-	 * If the value is an object but not an instance of
-	 * ViewableData, it will be converted recursively to an
-	 * ArrayData.
-	 *
-	 * If the value is an associative array, it will likewise be
-	 * converted recursively to an ArrayData.
+	 * @param string $f
 	 */
 	public function getField($f) {
 		$value = $this->array[$f];
@@ -73,7 +66,7 @@ 
 	* Add or set a field on this object.
 	*
 	* @param string $field
-	* @param mixed $value
+	* @param string $value
 	*/
 	public function setField($field, $value) {
 		$this->array[$field] = $value;
@@ -83,6 +76,7 @@ 
 	 * Check array to see if field isset
 	 *
 	 * @param string Field Key
+	 * @param string $f
 	 * @return bool
 	 */
 	public function hasField($f) {
@@ -93,7 +87,7 @@ 
 	 * Converts an associative array to a simple object
 	 *
 	 * @param array
-	 * @return obj $obj
+	 * @return stdClass $obj
 	 */
 	public static function array_to_object($arr = null) {
 		$obj = new stdClass();

view/Requirements.php

Doc Comments +4 added lines, -2 removed lines

@@ -65,6 +65,7 @@ 
 	 * while automatically busting this cache every time the file is changed.
 	 *
 	 * @param bool
+	 * @param boolean $var
 	 */
 	public static function set_suffix_requirements($var) {
 		self::backend()->setSuffixRequirements($var);
@@ -744,6 +745,7 @@ 
 	 * Forces the JavaScript requirements to the end of the body, right before the closing tag
 	 *
 	 * @param bool
+	 * @param boolean $var
 	 * @return $this
 	 */
 	public function setForceJSToBottom($var) {
@@ -1534,8 +1536,8 @@ 
 	/**
 	 * Given a filename and list of files, generate a new filename unique to these files
 	 *
-	 * @param string $name
-	 * @param array $files
+	 * @param array $fileList
+	 * @param string $combinedFile
 	 * @return string
 	 */
 	protected function hashedCombinedFilename($combinedFile, $fileList) {

view/SSTemplateParser.php

Doc Comments +9 added lines, -5 removed lines

@@ -111,6 +111,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) {
 		$res = parent::construct($matchrule, $name, $arguments);
@@ -172,9 +174,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) {
@@ -737,6 +739,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) {
 		$res['LookupSteps'][] = $sub;
@@ -4691,8 +4694,8 @@ 
 	 * Compiles some passed template source code into the php code that will execute as per the template source.
 	 *
 	 * @throws SSTemplateParseException
-	 * @param  $string The source of the template
-	 * @param string $templateName The name of the template, normally the filename the template source was loaded from
+	 * @param  string $string The source of the template
+	 * @param string string The name of the template, normally the filename the template source was loaded from
 	 * @param bool $includeDebuggingComments True is debugging comments should be included in the output
 	 * @param bool $topTemplate True if this is a top template, false if it's just a template
 	 * @return mixed|string The php that, when executed (via include or exec) will behave as per the template source
@@ -4732,6 +4735,7 @@ 
 
 	/**
 	 * @param string $code
+	 * @param string $templateName
 	 * @return string $code
 	 */
 	protected function includeDebuggingComments($code, $templateName) {

view/SSViewer.php

Doc Comments +14 added lines, -5 removed lines

@@ -338,7 +338,6 @@ 
 	/**
 	 * Returns the modulus of the numerical position of the item in the data set.
 	 * The count starts from $startIndex, which defaults to 1.
-	 * @param int $Mod The number to perform Mod operation to.
 	 * @param int $startIndex Number to start count from.
 	 * @return int
 	 */
@@ -412,6 +411,10 @@ 
 		$this->underlay = $underlay ? $underlay : array();
 	}
 
+	/**
+	 * @param string $interfaceToQuery
+	 * @param string $variableMethod
+	 */
 	protected function createCallableArray(&$extraArray, $interfaceToQuery, $variableMethod, $createObject = false) {
 		$implementers = ClassInfo::implementorsOf($interfaceToQuery);
 		if($implementers) foreach($implementers as $implementer) {
@@ -753,7 +756,7 @@ 
 	 *
 	 * @param $className string - valid class name
 	 * @param $suffix string
-	 * @param $baseClass string
+	 * @param string $baseClass string
 	 *
 	 * @return array
 	 */
@@ -1083,7 +1086,7 @@ 
 	 * @param array|null $arguments - arguments to an included template
 	 * @param Object $inheritedScope - the current scope of a parent template including a sub-template
 	 *
-	 * @return HTMLText Parsed template output.
+	 * @return DBField Parsed template output.
 	 */
 	public function process($item, $arguments = null, $inheritedScope = null) {
 		SSViewer::$topLevel[] = $item;
@@ -1158,7 +1161,7 @@ 
 	 * @param string $template Template name
 	 * @param mixed $data Data context
 	 * @param array $arguments Additional arguments
-	 * @return string Evaluated result
+	 * @return DBField Evaluated result
 	 */
 	public static function execute_template($template, $data, $arguments = null, $scope = null) {
 		$v = new SSViewer($template);
@@ -1184,6 +1187,9 @@ 
 		return $v->process($data, $arguments);
 	}
 
+	/**
+	 * @param string $content
+	 */
 	public function parseTemplateContent($content, $template="") {
 		return $this->getParser()->compileString(
 			$content,
@@ -1212,7 +1218,7 @@ 
 	 * Return an appropriate base tag for the given template.
 	 * It will be closed on an XHTML document, and unclosed on an HTML document.
 	 *
-	 * @param $contentGeneratedSoFar The content of the template generated so far; it should contain
+	 * @param string $contentGeneratedSoFar The content of the template generated so far; it should contain
 	 * the DOCTYPE declaration.
 	 */
 	public static function get_base_tag($contentGeneratedSoFar) {
@@ -1253,6 +1259,9 @@ 
 	 */
 	protected $cacheTemplate;
 
+	/**
+	 * @param string $content
+	 */
 	public function __construct($content, TemplateParser $parser = null) {
 		if ($parser) {
 			$this->setParser($parser);

view/ViewableData.php

Doc Comments +5 added lines, -5 removed lines

@@ -192,8 +192,6 @@ 
 	/**
 	 * Method to facilitate deprecation of underscore-prefixed methods automatically being cached.
 	 *
-	 * @param string $field
-	 * @param array $arguments
 	 * @param string $identifier an optional custom cache identifier
 	 * @return unknown
 	 */
@@ -254,7 +252,7 @@ 
 	 *  - castingHelper: the casting helper for casting the field (e.g. "return new Varchar($fieldName)")
 	 *
 	 * @param string $field
-	 * @return array
+	 * @return string
 	 */
 	public function castingHelperPair($field) {
 		Deprecation::notice('2.5', 'use castingHelper() instead');
@@ -346,7 +344,7 @@ 
 	 *
 	 * @param string|array|SSViewer $template the template to render into
 	 * @param array $customFields fields to customise() the object with before rendering
-	 * @return HTMLText
+	 * @return DBField
 	 */
 	public function renderWith($template, $customFields = null) {
 		if(!is_object($template)) {
@@ -506,6 +504,7 @@ 
 
 	/**
 	 * Return the value of a field in an SQL-safe format.
+	 * @param string $field
 	 */
 	public function SQL_val($field, $arguments = null, $cache = true) {
 		return Convert::raw2sql($this->RAW_val($field, $arguments, $cache));
@@ -513,6 +512,7 @@ 
 
 	/**
 	 * Return the value of a field in a JavaScript-save format.
+	 * @param string $field
 	 */
 	public function JS_val($field, $arguments = null, $cache = true) {
 		return Convert::raw2js($this->RAW_val($field, $arguments, $cache));
@@ -520,6 +520,7 @@ 
 
 	/**
 	 * Return the value of a field escaped suitable to be inserted into an XML node attribute.
+	 * @param string $field
 	 */
 	public function ATT_val($field, $arguments = null, $cache = true) {
 		return Convert::raw2att($this->RAW_val($field, $arguments, $cache));
@@ -530,7 +531,6 @@ 
 	/**
 	 * Get an array of XML-escaped values by field name
 	 *
-	 * @param array $elements an array of field names
 	 * @return array
 	 */
 	public function getXMLValues($fields) {

dev/SilverStripeListener.php

Doc Comments +3 added lines

@@ -47,6 +47,9 @@
 
 	protected $whitelist = false;
 
+	/**
+	 * @param string $name
+	 */
 	public function __construct($name = null, $options = array()) {
 		if(is_string($options)) {
 			$options = array('whitelist' => $options);

filesystem/ImageManipulation.php

Doc Comments +15 added lines, -15 removed lines

@@ -168,7 +168,7 @@ 
 	 *
 	 * @param integer $width The width to size to
 	 * @param integer $height The height to size to
-	 * @return AssetContainer
+	 * @return ImageManipulation
 	 */
 	public function Pad($width, $height, $backgroundColor = 'FFFFFF') {
 		if($this->isSize($width, $height)) {
@@ -187,7 +187,7 @@ 
 	/**
 	 * Forces the image to be resampled, if possible
 	 *
-	 * @return AssetContainer
+	 * @return ImageManipulation
 	 */
 	public function Resampled() {
 		// If image is already resampled, return self reference
@@ -237,7 +237,7 @@ 
 	 *
 	 * @param integer $width Width to resize to
 	 * @param integer $height Height to resize to
-	 * @return AssetContainer
+	 * @return ImageManipulation
 	 */
 	public function ResizedImage($width, $height) {
 		if($this->isSize($width, $height)) {
@@ -255,7 +255,7 @@ 
 	 *
 	 * @param integer $width The width to size within
 	 * @param integer $height The height to size within
-	 * @return AssetContainer
+	 * @return null|ImageManipulation
 	 */
 	public function Fit($width, $height) {
 		// Prevent divide by zero on missing/blank file
@@ -293,7 +293,7 @@ 
 	 * @uses ScalingManipulation::Fit()
 	 * @param integer $width The maximum width of the output image
 	 * @param integer $height The maximum height of the output image
-	 * @return AssetContainer
+	 * @return ImageManipulation
 	 */
 	public function FitMax($width, $height) {
 		return $this->getWidth() > $width || $this->getHeight() > $height
@@ -306,7 +306,7 @@ 
 	 * Scale image proportionally by width. Use in templates with $ScaleWidth.
 	 *
 	 * @param integer $width The width to set
-	 * @return AssetContainer
+	 * @return ImageManipulation
 	 */
 	public function ScaleWidth($width) {
 		if($this->isWidth($width)) {
@@ -325,7 +325,7 @@ 
 	 *
 	 * @uses ScalingManipulation::ScaleWidth()
 	 * @param integer $width The maximum width of the output image
-	 * @return AssetContainer
+	 * @return ImageManipulation
 	 */
 	public function ScaleMaxWidth($width) {
 		return $this->getWidth() > $width
@@ -337,7 +337,7 @@ 
 	 * Scale image proportionally by height. Use in templates with $ScaleHeight.
 	 *
 	 * @param int $height The height to set
-	 * @return AssetContainer
+	 * @return ImageManipulation
 	 */
 	public function ScaleHeight($height) {
 		if($this->isHeight($height)) {
@@ -356,7 +356,7 @@ 
 	 *
 	 * @uses ScalingManipulation::ScaleHeight()
 	 * @param integer $height The maximum height of the output image
-	 * @return AssetContainer
+	 * @return ImageManipulation
 	 */
 	public function ScaleMaxHeight($height) {
 		return $this->getHeight() > $height
@@ -371,7 +371,7 @@ 
 	 *
 	 * @uses CropManipulation::Fill()
 	 * @param integer $width The maximum width of the output image
-	 * @return AssetContainer
+	 * @return ImageManipulation
 	 */
 	public function CropWidth($width) {
 		return $this->getWidth() > $width
@@ -385,7 +385,7 @@ 
 	 *
 	 * @uses CropManipulation::Fill()
 	 * @param integer $height The maximum height of the output image
-	 * @return AssetContainer
+	 * @return ImageManipulation
 	 */
 	public function CropHeight($height) {
 		return $this->getHeight() > $height
@@ -401,7 +401,7 @@ 
 	 * @uses ImageManipulation::Fill()
 	 * @param integer $width The relative (used to determine aspect ratio) and maximum width of the output image
 	 * @param integer $height The relative (used to determine aspect ratio) and maximum height of the output image
-	 * @return AssetContainer
+	 * @return null|ImageManipulation
 	 */
 	public function FillMax($width, $height) {
 		// Prevent divide by zero on missing/blank file
@@ -436,7 +436,7 @@ 
 	 *
 	 * @param integer $width Width to crop to
 	 * @param integer $height Height to crop to
-	 * @return AssetContainer
+	 * @return ImageManipulation
 	 */
 	public function Fill($width, $height) {
 		if($this->isSize($width, $height)) {
@@ -487,7 +487,7 @@ 
 	 *
 	 * @param int $width
 	 * @param int $height
-	 * @return AssetContainer
+	 * @return ImageManipulation
 	 */
 	public function Thumbnail($width, $height) {
 		return $this->Pad($height, $height);
@@ -509,7 +509,7 @@ 
 	/**
 	 * Get HTML for img containing the icon for this file
 	 *
-	 * @return type
+	 * @return DBField
 	 */
 	public function IconTag() {
 		return DBField::create_field(

filesystem/storage/DBFile.php

Unused Use Statements -1 removed lines

@@ -5,7 +5,6 @@
 use SilverStripe\Filesystem\ImageManipulation;
 use SilverStripe\Filesystem\Storage\AssetContainer;
 use SilverStripe\Filesystem\Storage\AssetStore;
-
 use Injector;
 use AssetField;
 use File;