sminnee / silverstripe-framework

Forms/HTMLEditor/HTMLEditorSanitiser.php

Doc Comments +1 added lines, -1 removed lines

@@ -46,7 +46,7 @@
 	/**
 	 * Given a TinyMCE pattern (close to unix glob style), create a regex that does the match
 	 *
-	 * @param $str - The TinyMCE pattern
+	 * @param string|null $str - The TinyMCE pattern
 	 * @return string - The equivalent regex
 	 */
 	protected function patternToRegex($str) {

Unused Use Statements -1 removed lines

@@ -4,7 +4,6 @@
 
 use DOMAttr;
 use DOMElement;
-use DOMNode;
 use SilverStripe\Core\Injector\Injectable;
 use SilverStripe\View\Parsers\HTMLValue;
 use stdClass;

Forms/MoneyField.php

Doc Comments +11 added lines, -1 removed lines

@@ -57,6 +57,10 @@ 
 		return $this->fieldAmount;
 	}
 
+	/**
+	 * @param string $name
+	 * @param string $title
+	 */
 	public function __construct($name, $title = null, $value = "") {
 		$this->setName($name);
 
@@ -129,7 +133,7 @@ 
 	 *
 	 * (see @link MoneyFieldTest_CustomSetter_Object for more information)
 	 *
-	 * @param DataObjectInterface|Object $dataObject
+	 * @param DataObjectInterface $dataObject
 	 */
 	public function saveInto(DataObjectInterface $dataObject) {
 		$fieldName = $this->getName();
@@ -158,6 +162,9 @@ 
 		return $clone;
 	}
 
+	/**
+	 * @param boolean $bool
+	 */
 	public function setReadonly($bool) {
 		parent::setReadonly($bool);
 
@@ -198,6 +205,9 @@ 
 		return $this->allowedCurrencies;
 	}
 
+	/**
+	 * @param string $locale
+	 */
 	public function setLocale($locale) {
 		$this->_locale = $locale;
 		return $this;

Forms/NullableField.php

Doc Comments +2 added lines, -2 removed lines

@@ -84,7 +84,7 @@ 
 	/**
 	 * Set the label used for the Is Null checkbox.
 	 *
-	 * @param $isNulLabel string
+	 * @param string $isNulLabel string
 	 *
 	 * @return $this
 	 */
@@ -128,7 +128,7 @@ 
 	/**
 	 * Value is sometimes an array, and sometimes a single value, so we need to handle both cases
 	 *
-	 * @param mixed $value
+	 * @param string|null $value
 	 * @param null|array $data
 	 *
 	 * @return $this

Forms/PrintableTransformation_TabSet.php

Doc Comments +1 added lines, -1 removed lines

@@ -8,7 +8,7 @@
 class PrintableTransformation_TabSet extends TabSet
 {
 	/**
-	 * @param array $tabs
+	 * @param FieldList $tabs
 	 */
 	public function __construct($tabs)
 	{

Forms/ReadonlyField.php

Doc Comments +1 added lines, -1 removed lines

@@ -95,7 +95,7 @@
 	 * If $dontEscape is false the returned value will be safely encoded,
 	 * but should not be escaped by the frontend.
 	 *
-	 * @return mixed|string
+	 * @return string
 	 */
 	public function Value() {
 		// Get raw value

Forms/Schema/FormSchema.php

Doc Comments +3 added lines

@@ -74,6 +74,9 @@
 		return $state;
 	}
 
+	/**
+	 * @param \SilverStripe\Forms\FieldList $fields
+	 */
 	protected function getFieldStates($fields) {
 		$states = [];
 		foreach ($fields as $field) {

Forms/SelectionGroup_Item.php

Doc Comments +6 added lines

@@ -154,6 +154,9 @@ 
 		return $this->title;
 	}
 
+	/**
+	 * @param string $title
+	 */
 	function setTitle($title) {
 		$this->title = $title;
 		return $this;
@@ -163,6 +166,9 @@ 
 		return $this->value;
 	}
 
+	/**
+	 * @param string $Value
+	 */
 	function setValue($Value) {
 		$this->value = $Value;
 		return $this;

Forms/TextField.php

Doc Comments +1 added lines, -1 removed lines

@@ -74,7 +74,7 @@
 	}
 
 	/**
-	 * @return string
+	 * @return \SilverStripe\ORM\FieldType\DBHTMLText
 	 */
 	public function InternallyLabelledField() {
 		Deprecation::notice('4.0', 'Please use ->setValue() instead');

Forms/TimeField.php

Doc Comments +8 added lines, -1 removed lines

@@ -52,6 +52,10 @@ 
 
 	protected $schemaDataType = FormField::SCHEMA_DATA_TYPE_TIME;
 
+	/**
+	 * @param string $name
+	 * @param string $title
+	 */
 	public function __construct($name, $title = null, $value = ""){
 		if(!$this->locale) {
 			$this->locale = i18n::get_locale();
@@ -213,7 +217,7 @@ 
 
 	/**
 	 * @param String $name Optional, returns the whole configuration array if empty
-	 * @return mixed|array
+	 * @return string
 	 */
 	public function getConfig($name = null) {
 		if($name) {
@@ -230,6 +234,9 @@ 
 		return $this->castedCopy('TimeField_Readonly');
 	}
 
+	/**
+	 * @param string $class
+	 */
 	public function castedCopy($class) {
 		$copy = parent::castedCopy($class);
 		if($copy->hasMethod('setConfig')) {