silverstripe / silverstripe-framework

model/Versioned.php

Doc Comments +4 added lines, -4 removed lines

@@ -745,7 +745,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
@@ -814,7 +814,7 @@ 
 	 *
 	 * @param string $stage
 	 * @param Member $member
-	 * @return bool
+	 * @return boolean|string
 	 */
 	public function canViewStage($stage = 'Live', $member = null) {
 		$oldMode = Versioned::get_reading_mode();
@@ -879,7 +879,7 @@ 
 	/**
 	 * Get the latest published DataObject.
 	 *
-	 * @return DataObject
+	 * @return string
 	 */
 	public function latestPublished() {
 		// Get the root data object class - this will have the version field
@@ -1073,6 +1073,7 @@ 
 	/**
 	 * Return the base table - the class that directly extends DataObject.
 	 *
+	 * @param string $stage
 	 * @return string
 	 */
 	public function baseTable($stage = null) {
@@ -1239,7 +1240,6 @@ 
 	 * @param string $stage The name of the stage.
 	 * @param string $filter A filter to be inserted into the WHERE clause.
 	 * @param boolean $cache Use caching.
-	 * @param string $orderby A sort expression to be inserted into the ORDER BY clause.
 	 *
 	 * @return DataObject
 	 */

view/ViewableData.php

Doc Comments +5 added lines, -5 removed lines

@@ -141,7 +141,7 @@ 
 	/**
 	 * Get the current failover object if set
 	 *
-	 * @return ViewableData|null
+	 * @return ViewableData
 	 */
 	public function getFailover() {
 		return $this->failover;
@@ -208,8 +208,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
 	 */
@@ -270,7 +268,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');
@@ -520,6 +518,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));
@@ -527,6 +526,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));
@@ -534,6 +534,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));
@@ -544,7 +545,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) {

model/Map.php

Doc Comments +4 added lines

@@ -41,6 +41,7 @@ 
 	 * Set the key field for this map.
 	 *
 	 * @var string $keyField
+	 * @param string $keyField
 	 */
 	public function setKeyField($keyField) {
 		$this->keyField = $keyField;
@@ -50,6 +51,7 @@ 
 	 * Set the value field for this map.
 	 *
 	 * @var string $valueField
+	 * @param string $valueField
 	 */
 	public function setValueField($valueField) {
 		$this->valueField = $valueField;
@@ -95,6 +97,7 @@ 
 	 *
 	 * @var string $key
 	 * @var mixed $value
+	 * @param string $value
 	 */
 	public function unshift($key, $value) {
 		$oldItems = $this->firstItems;
@@ -114,6 +117,7 @@ 
 	 *
 	 * @var string $key
 	 * @var mixed $value
+	 * @param string $value
 	 */
 	public function push($key, $value) {
 		$oldItems = $this->lastItems;

security/Member.php

Doc Comments +4 added lines, -2 removed lines

@@ -585,6 +585,8 @@ 
 
 	/**
 	 * Utility for generating secure password hashes for this member.
+	 * @param string $string
+	 * @return string
 	 */
 	public function encryptWithUserSettings($string) {
 		if (!$string) return null;
@@ -735,7 +737,7 @@ 
 	/**
 	 * Returns the current logged in user
 	 *
-	 * @return Member|null
+	 * @return DataObject|null
 	 */
 	public static function currentUser() {
 		$id = Member::currentUserID();
@@ -1176,7 +1178,7 @@ 
 	 * If no $groups is passed, all members will be returned
 	 *
 	 * @param mixed $groups - takes a SS_List, an array or a single Group.ID
-	 * @return SQLMap Returns an SQLMap that returns all Member data.
+	 * @return SS_Map Returns an SQLMap that returns all Member data.
 	 * @see map()
 	 */
 	public static function map_in_groups($groups = null) {