silverstripe / silverstripe-framework

forms/DatetimeField.php

Doc Comments +19 added lines, -4 removed lines

@@ -56,6 +56,10 @@ 
 	 */
 	protected $config;
 
+	/**
+	 * @param string $name
+	 * @param string $title
+	 */
 	public function __construct($name, $title = null, $value = ""){
 		$this->config = $this->config()->default_config;
 
@@ -68,6 +72,9 @@ 
 		parent::__construct($name, $title, $value);
 	}
 
+	/**
+	 * @param Form $form
+	 */
 	public function setForm($form) {
 		parent::setForm($form);
 
@@ -78,6 +85,9 @@ 
 		return $this;
 	}
 
+	/**
+	 * @param string $name
+	 */
 	public function setName($name) {
 		parent::setName($name);
 
@@ -90,7 +100,7 @@ 
 
 	/**
 	 * @param array $properties
-	 * @return HTMLText
+	 * @return string
 	 */
 	public function FieldHolder($properties = array()) {
 		$config = array(
@@ -105,7 +115,7 @@ 
 
 	/**
 	 * @param array $properties
-	 * @return HTMLText
+	 * @return string
 	 */
 	public function Field($properties = array()) {
 		Requirements::css(FRAMEWORK_DIR . '/css/DatetimeField.css');
@@ -234,6 +244,7 @@ 
 
 	/**
 	 * @param FormField
+	 * @param DateField $field
 	 */
 	public function setDateField($field) {
 		$expected = $this->getName() . '[date]';
@@ -259,6 +270,7 @@ 
 
 	/**
 	 * @param FormField
+	 * @param TimeField $field
 	 */
 	public function setTimeField($field) {
 		$expected = $this->getName() . '[time]';
@@ -297,7 +309,7 @@ 
 	 * to set field-specific config options.
 	 *
 	 * @param string $name
-	 * @param mixed $val
+	 * @param string $val
 	 */
 	public function setConfig($name, $val) {
 		$this->config[$name] = $val;
@@ -315,7 +327,7 @@ 
 	 * to get field-specific config options.
 	 *
 	 * @param String $name Optional, returns the whole configuration array if empty
-	 * @return mixed
+	 * @return string|null
 	 */
 	public function getConfig($name = null) {
 		if($name) {
@@ -325,6 +337,9 @@ 
 		}
 	}
 
+	/**
+	 * @param RequiredFields $validator
+	 */
 	public function validate($validator) {
 		$dateValid = $this->dateField->validate($validator);
 		$timeValid = $this->timeField->validate($validator);

forms/gridfield/GridFieldPaginator.php

Doc Comments +3 added lines

@@ -50,6 +50,7 @@ 
 	 *
 	 * By default, this is set to true so that it's clearer what's happening, but the predefined
 	 * {@link GridFieldConfig} subclasses set this to false for flexibility.
+	 * @param boolean $throwExceptionOnBadDataType
 	 */
 	public function setThrowExceptionOnBadDataType($throwExceptionOnBadDataType) {
 		$this->throwExceptionOnBadDataType = $throwExceptionOnBadDataType;
@@ -65,6 +66,7 @@ 
 	/**
 	 * Check that this dataList is of the right data type.
 	 * Returns false if it's a bad data type, and if appropriate, throws an exception.
+	 * @param SS_List $dataList
 	 */
 	protected function checkDataType($dataList) {
 		if($dataList instanceof SS_Limitable) {
@@ -271,6 +273,7 @@ 
 
 	/**
 	 * @param Int
+	 * @param integer $num
 	 */
 	public function setItemsPerPage($num) {
 		$this->itemsPerPage = $num;

model/fieldtypes/DBInt.php

Doc Comments +3 added lines

@@ -52,6 +52,9 @@
 		return 0;
 	}
 
+	/**
+	 * @param integer $value
+	 */
 	public function prepValueForDB($value) {
 		if($value === true) {
 			return 1;

model/Versioned.php

Doc Comments +6 added lines, -6 removed lines

@@ -765,7 +765,7 @@ 
 	 * Extend permissions to include additional security for objects that are not published to live.
 	 *
 	 * @param Member $member
-	 * @return bool|null
+	 * @return false|null
 	 */
 	public function canView($member = null) {
 		// Invoke default version-gnostic canView
@@ -839,7 +839,7 @@ 
 	 *
 	 * @param string $stage
 	 * @param Member $member
-	 * @return bool
+	 * @return boolean|string
 	 */
 	public function canViewStage($stage = 'Live', $member = null) {
 		$oldMode = Versioned::get_reading_mode();
@@ -905,7 +905,7 @@ 
 	/**
 	 * Is the latest version of the object published?
 	 *
-	 * @return bool
+	 * @return string
 	 */
 	public function latestPublished() {
 		// Get the root data object class - this will have the version field
@@ -1029,7 +1029,7 @@ 
 	 * @param string $limit
 	 * @param string $join Deprecated, use leftJoin($table, $joinClause) instead
 	 * @param string $having
-	 * @return DataList
+	 * @return ArrayList
 	 */
 	public function Versions($filter = "", $sort = "", $limit = "", $join = "", $having = "") {
 		return $this->allVersions($filter, $sort, $limit, $join, $having);
@@ -1043,7 +1043,7 @@ 
 	 * @param  string $limit
 	 * @param  string $join Deprecated, use leftJoin($table, $joinClause) instead
 	 * @param  string $having
-	 * @return DataList
+	 * @return ArrayList
 	 */
 	public function allVersions($filter = "", $sort = "", $limit = "", $join = "", $having = "") {
 		// Make sure the table names are not postfixed (e.g. _Live)
@@ -1361,7 +1361,7 @@ 
 	 * @param string     $filter         A filter to be inserted into the WHERE clause.
 	 * @param string     $sort           A sort expression to be inserted into the ORDER BY clause.
 	 * @param string     $join           Deprecated, use leftJoin($table, $joinClause) instead
-	 * @param string|int $limit          A limit on the number of records returned from the database.
+	 * @param integer $limit          A limit on the number of records returned from the database.
 	 * @param string     $containerClass The container class for the result set (default is DataList)
 	 *
 	 * @return DataList A modified DataList designated to the specified stage

tests/forms/RequirementsTest.php

Doc Comments +14 added lines

@@ -51,6 +51,9 @@ 
 		);
 	}
 
+	/**
+	 * @param Requirements_Backend $backend
+	 */
 	protected function setupCombinedRequirements($backend) {
 		$basePath = $this->getCurrentRelativePath();
 
@@ -76,6 +79,9 @@ 
 		);
 	}
 
+	/**
+	 * @param Requirements_Backend $backend
+	 */
 	protected function setupCombinedNonrequiredRequirements($backend) {
 			$basePath = $this->getCurrentRelativePath();
 
@@ -482,6 +488,10 @@ 
 		$this->assertContains('var myvar="<head></head>";', $backend->includeInHTML(false, $template));
 	}
 
+	/**
+	 * @param Requirements_Backend $backend
+	 * @param string $type
+	 */
 	public function assertFileIncluded($backend, $type, $files) {
 		$type = strtolower($type);
 		switch (strtolower($type)) {
@@ -526,6 +536,10 @@ 
 		}
 	}
 
+	/**
+	 * @param Requirements_Backend $backend
+	 * @param string $type
+	 */
 	public function assertFileNotIncluded($backend, $type, $files) {
 		$type = strtolower($type);
 		switch ($type) {

forms/gridfield/GridFieldFilterHeader.php

Doc Comments +2 added lines

@@ -23,6 +23,7 @@ 
 	 *
 	 * By default, this is set to true so that it's clearer what's happening, but the predefined
 	 * {@link GridFieldConfig} subclasses set this to false for flexibility.
+	 * @param boolean $throwExceptionOnBadDataType
 	 */
 	public function setThrowExceptionOnBadDataType($throwExceptionOnBadDataType) {
 		$this->throwExceptionOnBadDataType = $throwExceptionOnBadDataType;
@@ -38,6 +39,7 @@ 
 	/**
 	 * Check that this dataList is of the right data type.
 	 * Returns false if it's a bad data type, and if appropriate, throws an exception.
+	 * @param SS_List $dataList
 	 */
 	protected function checkDataType($dataList) {
 		if($dataList instanceof SS_Filterable) {

model/DataQuery.php

Doc Comments +9 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;
@@ -175,7 +176,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 SQLQuery The finalised sql query
 	 */
 	public function getFinalisedQuery($queriedColumns = null) {
@@ -693,7 +694,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
 	 * @return string The model class of the related item
 	 */
 	public function applyRelation($relation) {
@@ -935,6 +936,9 @@ 
 	 */
 	protected $whereQuery;
 
+	/**
+	 * @param string $connective
+	 */
 	public function __construct(DataQuery $base, $connective) {
 		$this->dataClass = $base->dataClass;
 		$this->query = $base->query;
@@ -944,6 +948,9 @@ 
 		$base->where($this);
 	}
 
+	/**
+	 * @param string $filter
+	 */
 	public function where($filter) {
 		if($filter) {
 			$this->whereQuery->addWhere($filter);

security/MemberAuthenticator.php

Doc Comments +2 added lines, -2 removed lines

@@ -145,7 +145,7 @@ 
 	 * @param Form $form Optional: If passed, better error messages can be
 	 *                             produced by using
 	 *                             {@link Form::sessionMessage()}
-	 * @return bool|Member Returns FALSE if authentication fails, otherwise
+	 * @return Member|null Returns FALSE if authentication fails, otherwise
 	 *                     the member object
 	 * @see Security::setDefaultAdmin()
 	 */
@@ -186,7 +186,7 @@ 
 	/**
 	 * Method that creates the login form for this authentication method
 	 *
-	 * @param Controller The parent controller, necessary to create the
+	 * @param Controller Controller parent controller, necessary to create the
 	 *                   appropriate form action tag
 	 * @return MemberLoginForm Returns the login form to use with this authentication
 	 *              method

dev/Backtrace.php

Doc Comments +2 added lines, -2 removed lines

@@ -115,7 +115,7 @@ 
 	 *
 	 * @param unknown_type $returnVal
 	 * @param unknown_type $ignoreAjax
-	 * @return unknown
+	 * @return string|null
 	 */
 	public static function backtrace($returnVal = false, $ignoreAjax = false, $ignoredFunctions = null) {
 		$plainText = Director::is_cli() || (Director::is_ajax() && !$ignoreAjax);
@@ -132,7 +132,7 @@ 
 	 * shown
 	 *
 	 * @param SS_Object $item
-	 * @param boolean $showArg
+	 * @param boolean $showArgs
 	 * @param Int $argCharLimit
 	 * @return String
 	 */