silverstripe / silverstripe-framework

model/HTMLValue.php

Doc Comments +2 added lines, -2 removed lines

@@ -152,8 +152,8 @@
 	/**
 	 * Make an xpath query against this HTML
 	 *
-	 * @param $query string - The xpath query string
-	 * @return DOMNodeList
+	 * @param string $query string - The xpath query string
+	 * @return \DOMNodeList
 	 */
 	public function query($query) {
 		$xp = new DOMXPath($this->getDocument());

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)) {

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();

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);

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([

tests/model/VersionedOwnershipTest.php

Doc Comments +2 added lines, -2 removed lines

@@ -728,7 +728,7 @@ 
 	/**
 	 * All custom objects with the same number. E.g. 'Page 1' owns 'Custom 1'
 	 *
-	 * @return DataList
+	 * @return SilverStripe\Model\DataList
 	 */
 	public function Custom() {
 		$title = str_replace('Page', 'Custom', $this->Title);
@@ -782,7 +782,7 @@ 
 	/**
 	 * All pages with the same number. E.g. 'Page 1' owns 'Custom 1'
 	 *
-	 * @return DataList
+	 * @return SilverStripe\Model\DataList
 	 */
 	public function Pages() {
 		$title = str_replace('Custom', 'Page', $this->Title);

forms/htmleditor/HtmlEditorField.php

Doc Comments +12 added lines, -5 removed lines

@@ -57,7 +57,7 @@ 
 	/**
 	 * Assign a new configuration instance or identifier
 	 *
-	 * @param string|HtmlEditorConfig $config
+	 * @param string $config
 	 * @return $this
 	 */
 	public function setEditorConfig($config) {
@@ -71,7 +71,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) {
@@ -112,6 +112,9 @@ 
 		$record->{$this->name} = $htmlValue->getContent();
 	}
 
+	/**
+	 * @param string|null $value
+	 */
 	public function setValue($value) {
 		// Regenerate links prior to preview, so that the editor can see them.
 		$value = Image::regenerate_html_links($value);
@@ -179,6 +182,10 @@ 
 
 	protected $controller, $name;
 
+	/**
+	 * @param Controller|null $controller
+	 * @param string $name
+	 */
 	public function __construct($controller, $name) {
 		parent::__construct();
 
@@ -197,7 +204,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(
@@ -577,7 +584,7 @@ 
 	/**
 	 * Find all anchors available on the given page.
 	 *
-	 * @return array
+	 * @return string
 	 * @throws SS_HTTPResponse_Exception
 	 */
 	public function getanchors() {
@@ -1136,7 +1143,7 @@ 
 	/**
 	 * Get OEmbed type
 	 *
-	 * @return string
+	 * @return boolean
 	 */
 	public function getType() {
 		return $this->oembed->type;