sminnee / silverstripe-framework

forms/htmleditor/HtmlEditorConfig.php

Doc Comments +1 added lines, -1 removed lines

@@ -138,7 +138,7 @@
 	 * Get the current value of an option
      *
 	 * @param string $key The key of the option to get
-	 * @return mixed The value of the specified option
+	 * @return string The value of the specified option
 	 */
 	abstract public function getOption($key);
 

forms/htmleditor/HtmlEditorField.php

Doc Comments +9 added lines, -5 removed lines

@@ -49,7 +49,7 @@ 
 	/**
 	 * Assign a new configuration instance or identifier
 	 *
-	 * @param string|HtmlEditorConfig $config
+	 * @param string $config
 	 * @return $this
 	 */
 	public function setEditorConfig($config) {
@@ -63,7 +63,7 @@ 
 	 *
 	 * @param string $name The internal field name, passed to forms.
 	 * @param string $title The human-readable field label.
-	 * @param mixed $value The value of the field.
+	 * @param integer $value The value of the field.
 	 * @param string $config HtmlEditorConfig identifier to be used. Default to the active one.
 	 */
 	public function __construct($name, $title = null, $value = '', $config = null) {
@@ -168,6 +168,10 @@ 
 
 	protected $controller, $name;
 
+	/**
+	 * @param Controller $controller
+	 * @param string $name
+	 */
 	public function __construct($controller, $name) {
 		parent::__construct();
 
@@ -186,7 +190,7 @@ 
 	/**
 	 * Searches the SiteTree for display in the dropdown
 	 *
-	 * @return callback
+	 * @return DataList
 	 */
 	public function siteTreeSearchCallback($sourceObject, $labelField, $search) {
 		return DataObject::get($sourceObject)->filterAny(array(
@@ -464,7 +468,7 @@ 
 	/**
 	 * Find all anchors available on the given page.
 	 *
-	 * @return array
+	 * @return string
 	 */
 	public function getanchors() {
 		$id = (int)$this->getRequest()->getVar('PageID');
@@ -1022,7 +1026,7 @@ 
 	/**
 	 * Get OEmbed type
 	 *
-	 * @return string
+	 * @return boolean
 	 */
 	public function getType() {
 		return $this->oembed->type;

forms/htmleditor/TinyMCEConfig.php

Doc Comments +1 added lines, -1 removed lines

@@ -392,7 +392,7 @@
     /**
      * Get location of all editor.css files
      *
-     * @return array
+     * @return string[]
      */
     protected function getEditorCSS() {
         $editor = array();

forms/ListboxField.php

Doc Comments +1 added lines, -1 removed lines

@@ -59,7 +59,7 @@
 	 * Returns a <select> tag containing all the appropriate <option> tags
 	 *
 	 * @param array $properties
-	 * @return string
+	 * @return DBField
 	 */
 	public function Field($properties = array()) {
 		$properties = array_merge($properties, array(

forms/MoneyField.php

Doc Comments +6 added lines, -1 removed lines

@@ -36,6 +36,10 @@ 
 	 */
 	protected $fieldCurrency = null;
 
+	/**
+	 * @param string $name
+	 * @param string $title
+	 */
 	public function __construct($name, $title = null, $value = "") {
 		// naming with underscores to prevent values from actually being saved somewhere
 		$this->fieldAmount = new NumericField("{$name}[Amount]", _t('MoneyField.FIELDLABELAMOUNT', 'Amount'));
@@ -46,7 +50,7 @@ 
 
 	/**
 	 * @param array
-	 * @return HTMLText
+	 * @return DBField
 	 */
 	public function Field($properties = array()) {
 		return DBField::create_field('HTMLText',
@@ -139,6 +143,7 @@ 
 	/**
 	 * @todo Implement removal of readonly state with $bool=false
 	 * @todo Set readonly state whenever field is recreated, e.g. in setAllowedCurrencies()
+	 * @param boolean $bool
 	 */
 	public function setReadonly($bool) {
 		parent::setReadonly($bool);

model/connect/Database.php

Doc Comments +3 added lines, -2 removed lines

@@ -646,7 +646,7 @@ 
 	 * @param boolean $create Flag indicating whether the database should be created
 	 * if it doesn't exist. If $create is false and the database doesn't exist
 	 * then an error will be raised
-	 * @param int|boolean $errorLevel The level of error reporting to enable for the query, or false if no error
+	 * @param boolean $errorLevel The level of error reporting to enable for the query, or false if no error
 	 * should be raised
 	 * @return boolean Flag indicating success
 	 */
@@ -681,7 +681,7 @@ 
 	/**
 	 * Returns the name of the currently selected database
 	 *
-	 * @return string|null Name of the selected database, or null if none selected
+	 * @return string Name of the selected database, or null if none selected
 	 */
 	public function getSelectedDatabase() {
 		return $this->connector->getSelectedDatabase();
@@ -806,6 +806,7 @@ 
 
 	/**
 	 * @deprecated since version 4.0 Use DB::field_list instead
+	 * @param string $table
 	 */
 	public function fieldList($table) {
 		Deprecation::notice('4.0', 'Use DB::field_list instead');

model/DataExtension.php

Doc Comments +6 added lines

@@ -7,6 +7,9 @@ 
 
 	protected static $fixture_file = 'MemberDatetimeOptionsetFieldTest.yml';
 
+	/**
+	 * @param DataObject|null $member
+	 */
 	protected function createDateFormatFieldForMember($member) {
 		require_once 'Zend/Date.php';
 		$defaultDateFormat = Zend_Locale_Format::getDateFormat($member->Locale);
@@ -26,6 +29,9 @@ 
 		return $field;
 	}
 
+	/**
+	 * @param DataObject|null $member
+	 */
 	protected function createTimeFormatFieldForMember($member) {
 		require_once 'Zend/Date.php';
 		$defaultTimeFormat = Zend_Locale_Format::getTimeFormat($member->Locale);

model/DataQuery.php

Doc Comments +10 added lines, -2 removed lines

@@ -44,6 +44,7 @@ 
 	 * Create a new DataQuery.
 	 *
 	 * @param String The name of the DataObject class that you wish to query
+	 * @param string $dataClass
 	 */
 	public function __construct($dataClass) {
 		$this->dataClass = $dataClass;
@@ -166,7 +167,7 @@ 
 	/**
 	 * Ensure that the query is ready to execute.
 	 *
-	 * @param array|null $queriedColumns Any columns to filter the query by
+	 * @param string[] $queriedColumns Any columns to filter the query by
 	 * @return SQLSelect The finalised sql query
 	 */
 	public function getFinalisedQuery($queriedColumns = null) {
@@ -641,7 +642,7 @@ 
 	 * mappings to the query object state. This has to be called
 	 * in any overloaded {@link SearchFilter->apply()} methods manually.
 	 *
-	 * @param String|array $relation The array/dot-syntax relation to follow
+	 * @param string $relation The array/dot-syntax relation to follow
 	 * @param bool $linearOnly Set to true to restrict to linear relations only. Set this
 	 * if this relation will be used for sorting, and should not include duplicate rows.
 	 * @return The model class of the related item
@@ -917,6 +918,7 @@ 
 
 	/**
 	 * Set an arbitrary query parameter, that can be used by decorators to add additional meta-data to the query.
+	 * @param string $key
 	 */
 	public function getQueryParam($key) {
 		if(isset($this->queryParams[$key])) return $this->queryParams[$key];
@@ -949,6 +951,9 @@ 
 	 */
 	protected $whereQuery;
 
+	/**
+	 * @param string $connective
+	 */
 	public function __construct(DataQuery $base, $connective) {
 		$this->dataClass = $base->dataClass;
 		$this->query = $base->query;
@@ -958,6 +963,9 @@ 
 		$base->where($this);
 	}
 
+	/**
+	 * @param string $filter
+	 */
 	public function where($filter) {
 		if($filter) {
 			$this->whereQuery->addWhere($filter);

model/FieldType/DBClassName.php

Doc Comments +3 added lines

@@ -186,6 +186,9 @@
 		return $classNames;
 	}
 
+	/**
+	 * @param \DBClassNameTest_ObjectSubClass $record
+	 */
 	public function setValue($value, $record = null, $markChanged = true) {
 		parent::setValue($value, $record, $markChanged);