silverstripe / silverstripe-framework

filesystem/Folder.php

Doc Comments +3 added lines, -3 removed lines

@@ -47,7 +47,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\ORM\DataObject
 	 */
 	public static function find_or_make($folderPath) {
 		// replace leading and trailing slashes
@@ -149,7 +149,7 @@ 
 	/**
 	 * Returns all children of this folder
 	 *
-	 * @return DataList
+	 * @return SilverStripe\ORM\DataList
 	 */
 	public function myChildren() {
 		return File::get()->filter("ParentID", $this->ID);
@@ -200,7 +200,7 @@ 
 	/**
 	 * Get the children of this folder that are also folders.
 	 *
-	 * @return DataList
+	 * @return SilverStripe\ORM\DataList
 	 */
 	public function ChildFolders() {
 		return Folder::get()->filter('ParentID', $this->ID);

filesystem/ImageManipulation.php

Doc Comments +1 added lines, -1 removed lines

@@ -513,7 +513,7 @@
 	/**
 	 * Get HTML for img containing the icon for this file
 	 *
-	 * @return DBHTMLText
+	 * @return DBField
 	 */
 	public function IconTag() {
 		return DBField::create_field(

forms/htmleditor/HTMLEditorField.php

Doc Comments +13 added lines, -6 removed lines

@@ -63,7 +63,7 @@ 
 	/**
 	 * Assign a new configuration instance or identifier
 	 *
-	 * @param string|HTMLEditorConfig $config
+	 * @param string $config
 	 * @return $this
 	 */
 	public function setEditorConfig($config) {
@@ -77,7 +77,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) {
@@ -118,6 +118,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);
@@ -185,6 +188,10 @@ 
 
 	protected $controller, $name;
 
+	/**
+	 * @param Controller|null $controller
+	 * @param string $name
+	 */
 	public function __construct($controller, $name) {
 		parent::__construct();
 
@@ -203,7 +210,7 @@ 
 	/**
 	 * Searches the SiteTree for display in the dropdown
 	 *
-	 * @return callback
+	 * @return SilverStripe\ORM\DataList
 	 */
 	public function siteTreeSearchCallback($sourceObject, $labelField, $search) {
 		return DataObject::get($sourceObject)->filterAny(array(
@@ -583,7 +590,7 @@ 
 	/**
 	 * Find all anchors available on the given page.
 	 *
-	 * @return array
+	 * @return string
 	 * @throws SS_HTTPResponse_Exception
 	 */
 	public function getanchors() {
@@ -646,7 +653,7 @@ 
 	 * Gets files filtered by a given parent with the allowed extensions
 	 *
 	 * @param int $parentID
-	 * @return DataList
+	 * @return SilverStripe\ORM\DataList
 	 */
 	protected function getFiles($parentID = null) {
 		$exts = $this->getAllowedExtensions();
@@ -1159,7 +1166,7 @@ 
 	}
 
 	/**
-	 * @return AdapterInterface
+	 * @return Embed
 	 */
 	public function getEmbed() {
 		return $this->embed;

ORM/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');

ORM/Connect/MySQLSchemaManager.php

Doc Comments +3 added lines

@@ -115,6 +115,9 @@
 		$this->query("ALTER TABLE \"$tableName\" $alterations");
 	}
 
+	/**
+	 * @param string $tableName
+	 */
 	public function isView($tableName) {
 		$info = $this->query("SHOW /*!50002 FULL*/ TABLES LIKE '$tableName'")->record();
 		return $info && strtoupper($info['Table_type']) == 'VIEW';

ORM/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;

ORM/Connect/PDOConnector.php

Doc Comments +1 added lines, -1 removed lines

@@ -324,7 +324,7 @@
 	 * @param int $errorLevel
 	 * @param string $sql
 	 * @param array $parameters
-	 * @return \PDOQuery
+	 * @return PDOQuery|null
 	 */
 	protected function prepareResults($statement, $errorLevel, $sql, $parameters = array()) {
 

ORM/DatabaseAdmin.php

Doc Comments +2 added lines, -2 removed lines

@@ -107,7 +107,7 @@ 
 	/**
 	 * Gets the url to return to after build
 	 *
-	 * @return string|null
+	 * @return string
 	 */
 	protected function getReturnURL() {
 		$url = $this->request->getVar('returnURL');
@@ -152,7 +152,7 @@ 
 	/**
 	 * Returns the timestamp of the time that the database was last built
 	 *
-	 * @return string Returns the timestamp of the time that the database was
+	 * @return integer|null Returns the timestamp of the time that the database was
 	 *                last built
 	 */
 	public static function lastBuilt() {

ORM/DataList.php

Doc Comments +10 added lines, -10 removed lines

@@ -157,7 +157,7 @@ 
 	 * Returns a new DataList instance with the specified query parameter assigned
 	 *
 	 * @param string|array $keyOrArray Either the single key to set, or an array of key value pairs to set
-	 * @param mixed $val If $keyOrArray is not an array, this is the value to set
+	 * @param string $val If $keyOrArray is not an array, this is the value to set
 	 * @return DataList
 	 */
 	public function setDataQueryParam($keyOrArray, $val = null) {
@@ -520,7 +520,7 @@ 
 	 * Check if the given field specification could be interpreted as an unquoted relation name
 	 *
 	 * @param string $field
-	 * @return bool
+	 * @return integer
 	 */
 	protected function isValidRelationName($field) {
 		return preg_match('/^[A-Z0-9._]+$/i', $field);
@@ -635,7 +635,7 @@ 
 	 * @param int $order A numerical index to control the order that joins are added to the query; lower order values
 	 * will cause the query to appear first. The default is 20, and joins created automatically by the
 	 * ORM have a value of 10.
-	 * @param array $parameters Any additional parameters if the join is a parameterised subquery
+	 * @param string[] $parameters Any additional parameters if the join is a parameterised subquery
 	 * @return DataList
 	 */
 	public function innerJoin($table, $onClause, $alias = null, $order = 20, $parameters = array()) {
@@ -653,7 +653,7 @@ 
 	 * @param int $order A numerical index to control the order that joins are added to the query; lower order values
 	 * will cause the query to appear first. The default is 20, and joins created automatically by the
 	 * ORM have a value of 10.
-	 * @param array $parameters Any additional parameters if the join is a parameterised subquery
+	 * @param string[] $parameters Any additional parameters if the join is a parameterised subquery
 	 * @return DataList
 	 */
 	public function leftJoin($table, $onClause, $alias = null, $order = 20, $parameters = array()) {
@@ -780,7 +780,7 @@ 
 	 * Return the maximum value of the given field in this DataList
 	 *
 	 * @param string $fieldName
-	 * @return mixed
+	 * @return string
 	 */
 	public function max($fieldName) {
 		return $this->dataQuery->max($fieldName);
@@ -790,7 +790,7 @@ 
 	 * Return the minimum value of the given field in this DataList
 	 *
 	 * @param string $fieldName
-	 * @return mixed
+	 * @return string
 	 */
 	public function min($fieldName) {
 		return $this->dataQuery->min($fieldName);
@@ -800,7 +800,7 @@ 
 	 * Return the average value of the given field in this DataList
 	 *
 	 * @param string $fieldName
-	 * @return mixed
+	 * @return string
 	 */
 	public function avg($fieldName) {
 		return $this->dataQuery->avg($fieldName);
@@ -810,7 +810,7 @@ 
 	 * Return the sum of the values of the given field in this DataList
 	 *
 	 * @param string $fieldName
-	 * @return mixed
+	 * @return string
 	 */
 	public function sum($fieldName) {
 		return $this->dataQuery->sum($fieldName);
@@ -862,7 +862,7 @@ 
 	/**
 	 * Restrict the columns to fetch into this DataList
 	 *
-	 * @param array $queriedColumns
+	 * @param string[] $queriedColumns
 	 * @return DataList
 	 */
 	public function setQueriedColumns($queriedColumns) {
@@ -1135,7 +1135,7 @@ 
 	/**
 	 * Returns item stored in list with index $key
 	 *
-	 * @param mixed $key
+	 * @param integer $key
 	 * @return DataObject
 	 */
 	public function offsetGet($key) {