silverstripe / silverstripe-framework

model/ManyManyList.php

Doc Comments +2 added lines, -2 removed lines

@@ -115,7 +115,7 @@ 
 	 * Create a DataObject from the given SQL row.
 	 *
 	 * @param array $row
-	 * @return DataObject
+	 * @return SilverStripe\Model\DataObject
 	 */
 	protected function createDataObject($row) {
 		// remove any composed fields
@@ -265,7 +265,7 @@ 
 	 * Note that for a ManyManyList, the item is never actually deleted, only
 	 * the join table is affected.
 	 *
-	 * @param DataObject $item
+	 * @param SilverStripe\Model\DataObject $item
 	 */
 	public function remove($item) {
 		if(!($item instanceof $this->dataClass)) {

model/versioning/Versioned.php

Doc Comments +5 added lines, -5 removed lines

@@ -1062,7 +1062,7 @@ 
 	/**
 	 * Find objects in the given relationships, merging them into the given list
 	 *
-	 * @param array $source Config property to extract relationships from
+	 * @param string $source Config property to extract relationships from
 	 * @param bool $recursive True if recursive
 	 * @param ArrayList $list Optional list to add items to
 	 * @return ArrayList The list
@@ -1182,7 +1182,7 @@ 
 	/**
 	 * Check if the current user can delete this record from live
 	 *
-	 * @param null $member
+	 * @param Member|null $member
 	 * @return mixed
 	 */
 	public function canUnpublish($member = null) {
@@ -1215,7 +1215,7 @@ 
 	 * If extended, ensure that both canDelete and canUnpublish are extended also
 	 *
 	 * @param Member $member
-	 * @return bool
+	 * @return null|boolean
 	 */
 	public function canArchive($member = null) {
 		// Skip if invoked by extendedCan()
@@ -1292,7 +1292,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
@@ -2418,7 +2418,7 @@ 
 	/**
 	 * Returns an array of possible stages.
 	 *
-	 * @return array
+	 * @return string[]
 	 */
 	public function getVersionedStages() {
 		if($this->hasStages()) {

security/PasswordEncryptor.php

Doc Comments +3 added lines, -2 removed lines

@@ -87,6 +87,7 @@ 
 	 * but is necessary for retain compatibility with password hashed
 	 * with flawed algorithms - see {@link PasswordEncryptor_LegacyPHPHash} and
 	 * {@link PasswordEncryptor_Blowfish}
+	 * @param string $password
 	 */
 	public function check($hash, $password, $salt = null, $member = null) {
 		return $hash === $this->encrypt($password, $salt, $member);
@@ -129,8 +130,7 @@ 
 	/**
 	 * Gets the cost that is set for the blowfish algorithm
 	 *
-	 * @param int $cost
-	 * @return null
+	 * @return integer
 	 */
 	public static function get_cost() {
 		return self::$cost;
@@ -242,6 +242,7 @@ 
 
 	/**
 	 * self::$cost param is forced to be two digits with leading zeroes for ints 4-9
+	 * @param string $password
 	 */
 	public function salt($password, $member = null) {
 		$generator = new RandomGenerator();

admin/code/CampaignAdmin.php

Doc Comments +1 added lines, -1 removed lines

@@ -331,7 +331,7 @@
 	/**
 	 * Gets viewable list of campaigns
 	 *
-	 * @return SS_List
+	 * @return SilverStripe\Model\ArrayList
 	 */
 	protected function getListItems() {
 		return ChangeSet::get()

filesystem/FileMigrationHelper.php

Doc Comments +1 added lines, -1 removed lines

@@ -88,7 +88,7 @@
 	/**
 	 * Get list of File dataobjects to import
 	 *
-	 * @return DataList
+	 * @return SilverStripe\Model\DataList
 	 */
 	protected function getFileQuery() {
 		// Select all records which have a Filename value, but not FileFilename.

filesystem/Folder.php

Doc Comments +3 added lines, -3 removed lines

@@ -45,7 +45,7 @@ 
 	 * Find the given folder or create it as a database record
 	 *
 	 * @param string $folderPath Directory path relative to assets root
-	 * @return Folder|null
+	 * @return null|SilverStripe\Model\DataObject
 	 */
 	public static function find_or_make($folderPath) {
 		// replace leading and trailing slashes
@@ -147,7 +147,7 @@ 
 	/**
 	 * Returns all children of this folder
 	 *
-	 * @return DataList
+	 * @return SilverStripe\Model\DataList
 	 */
 	public function myChildren() {
 		return File::get()->filter("ParentID", $this->ID);
@@ -198,7 +198,7 @@ 
 	/**
 	 * Get the children of this folder that are also folders.
 	 *
-	 * @return DataList
+	 * @return SilverStripe\Model\DataList
 	 */
 	public function ChildFolders() {
 		return Folder::get()->filter('ParentID', $this->ID);

forms/gridfield/GridField.php

Doc Comments +4 added lines, -4 removed lines

@@ -192,7 +192,7 @@ 
 	}
 
 	/**
-	 * @return ArrayList
+	 * @return SilverStripe\Model\ArrayList
 	 */
 	public function getComponents() {
 		return $this->config->getComponents();
@@ -203,7 +203,7 @@ 
 	 *
 	 * @todo refactor this into GridFieldComponent
 	 *
-	 * @param mixed $value
+	 * @param string $value
 	 * @param string|array $castingDefinition
 	 *
 	 * @return mixed
@@ -290,7 +290,7 @@ 
 	 *
 	 * @param array $properties
 	 *
-	 * @return HTMLText
+	 * @return DBField
 	 */
 	public function FieldHolder($properties = array()) {
 		Requirements::css(THIRDPARTY_DIR . '/jquery-ui-themes/smoothness/jquery-ui.css');
@@ -604,7 +604,7 @@ 
 	/**
 	 * @param array $properties
 	 *
-	 * @return HTMLText
+	 * @return DBField
 	 */
 	public function Field($properties = array()) {
 		$this->extend('onBeforeRender', $this);

model/connect/MySQLStatement.php

Doc Comments +2 added lines, -2 removed lines

@@ -78,8 +78,8 @@
 
 	/**
 	 * Hook the result-set given into a Query class, suitable for use by SilverStripe.
-	 * @param mysqli_stmt $statement The related statement, if present
-	 * @param mysqli_result $metadata The metadata for this statement
+	 * @param \mysqli_stmt $statement The related statement, if present
+	 * @param \mysqli_result $metadata The metadata for this statement
 	 */
 	public function __construct($statement, $metadata) {
 		$this->statement = $statement;

model/versioning/ChangeSetItem.php

Doc Comments +4 added lines, -4 removed lines

@@ -132,7 +132,7 @@ 
 	 * Find version of this object in the given stage
 	 *
 	 * @param string $stage
-	 * @return Versioned|DataObject
+	 * @return DataObject|null
 	 */
 	protected function getObjectInStage($stage) {
 		return Versioned::get_by_stage($this->ObjectClass, $stage)->byID($this->ObjectID);
@@ -141,7 +141,7 @@ 
 	/**
 	 * Find latest version of this object
 	 *
-	 * @return Versioned|DataObject
+	 * @return DataObject|null
 	 */
 	protected function getObjectLatestVersion() {
 		return Versioned::get_latest_version($this->ObjectClass, $this->ObjectID);
@@ -325,7 +325,7 @@ 
 	 * Get the ChangeSetItems that reference a passed DataObject
 	 *
 	 * @param DataObject $object
-	 * @return DataList
+	 * @return SilverStripe\Model\DataList
 	 */
 	public static function get_for_object($object) {
 		return ChangeSetItem::get()->filter([
@@ -339,7 +339,7 @@ 
 	 *
 	 * @param int $objectID The ID of the object
 	 * @param string $objectClass The class of the object (or any parent class)
-	 * @return DataList
+	 * @return SilverStripe\Model\DataList
 	 */
 	public static function get_for_object_by_id($objectID, $objectClass) {
 		return ChangeSetItem::get()->filter([