Completed
Pull Request — master (#5771)
by Florian
11:17
created
filesystem/FileMigrationHelper.php 1 patch
Doc Comments   +1 added lines, -1 removed lines patch added patch discarded remove patch
@@ -89,7 +89,7 @@
 block discarded – undo
89 89
 	/**
90 90
 	 * Get list of File dataobjects to import
91 91
 	 *
92
-	 * @return DataList
92
+	 * @return SilverStripe\ORM\DataList
93 93
 	 */
94 94
 	protected function getFileQuery() {
95 95
 		// Select all records which have a Filename value, but not FileFilename.
Please login to merge, or discard this patch.
filesystem/Folder.php 1 patch
Doc Comments   +3 added lines, -3 removed lines patch added patch discarded remove patch
@@ -47,7 +47,7 @@  discard block
 block discarded – undo
47 47
 	 * Find the given folder or create it as a database record
48 48
 	 *
49 49
 	 * @param string $folderPath Directory path relative to assets root
50
-	 * @return Folder|null
50
+	 * @return null|SilverStripe\ORM\DataObject
51 51
 	 */
52 52
 	public static function find_or_make($folderPath) {
53 53
 		// replace leading and trailing slashes
@@ -149,7 +149,7 @@  discard block
 block discarded – undo
149 149
 	/**
150 150
 	 * Returns all children of this folder
151 151
 	 *
152
-	 * @return DataList
152
+	 * @return SilverStripe\ORM\DataList
153 153
 	 */
154 154
 	public function myChildren() {
155 155
 		return File::get()->filter("ParentID", $this->ID);
@@ -200,7 +200,7 @@  discard block
 block discarded – undo
200 200
 	/**
201 201
 	 * Get the children of this folder that are also folders.
202 202
 	 *
203
-	 * @return DataList
203
+	 * @return SilverStripe\ORM\DataList
204 204
 	 */
205 205
 	public function ChildFolders() {
206 206
 		return Folder::get()->filter('ParentID', $this->ID);
Please login to merge, or discard this patch.
filesystem/ImageManipulation.php 1 patch
Doc Comments   +1 added lines, -1 removed lines patch added patch discarded remove patch
@@ -513,7 +513,7 @@
 block discarded – undo
513 513
 	/**
514 514
 	 * Get HTML for img containing the icon for this file
515 515
 	 *
516
-	 * @return DBHTMLText
516
+	 * @return DBField
517 517
 	 */
518 518
 	public function IconTag() {
519 519
 		return DBField::create_field(
Please login to merge, or discard this patch.
forms/gridfield/GridField.php 1 patch
Doc Comments   +4 added lines, -4 removed lines patch added patch discarded remove patch
@@ -193,7 +193,7 @@  discard block
 block discarded – undo
193 193
 	}
194 194
 
195 195
 	/**
196
-	 * @return ArrayList
196
+	 * @return SilverStripe\ORM\ArrayList
197 197
 	 */
198 198
 	public function getComponents() {
199 199
 		return $this->config->getComponents();
@@ -204,7 +204,7 @@  discard block
 block discarded – undo
204 204
 	 *
205 205
 	 * @todo refactor this into GridFieldComponent
206 206
 	 *
207
-	 * @param mixed $value
207
+	 * @param string $value
208 208
 	 * @param string|array $castingDefinition
209 209
 	 *
210 210
 	 * @return mixed
@@ -291,7 +291,7 @@  discard block
 block discarded – undo
291 291
 	 *
292 292
 	 * @param array $properties
293 293
 	 *
294
-	 * @return HTMLText
294
+	 * @return DBField
295 295
 	 */
296 296
 	public function FieldHolder($properties = array()) {
297 297
 		Requirements::css(THIRDPARTY_DIR . '/jquery-ui-themes/smoothness/jquery-ui.css');
@@ -605,7 +605,7 @@  discard block
 block discarded – undo
605 605
 	/**
606 606
 	 * @param array $properties
607 607
 	 *
608
-	 * @return HTMLText
608
+	 * @return DBField
609 609
 	 */
610 610
 	public function Field($properties = array()) {
611 611
 		$this->extend('onBeforeRender', $this);
Please login to merge, or discard this patch.
forms/htmleditor/HTMLEditorField.php 1 patch
Doc Comments   +13 added lines, -6 removed lines patch added patch discarded remove patch
@@ -63,7 +63,7 @@  discard block
 block discarded – undo
63 63
 	/**
64 64
 	 * Assign a new configuration instance or identifier
65 65
 	 *
66
-	 * @param string|HTMLEditorConfig $config
66
+	 * @param string $config
67 67
 	 * @return $this
68 68
 	 */
69 69
 	public function setEditorConfig($config) {
@@ -77,7 +77,7 @@  discard block
 block discarded – undo
77 77
 	 *
78 78
 	 * @param string $name The internal field name, passed to forms.
79 79
 	 * @param string $title The human-readable field label.
80
-	 * @param mixed $value The value of the field.
80
+	 * @param integer $value The value of the field.
81 81
 	 * @param string $config HTMLEditorConfig identifier to be used. Default to the active one.
82 82
 	 */
83 83
 	public function __construct($name, $title = null, $value = '', $config = null) {
@@ -118,6 +118,9 @@  discard block
 block discarded – undo
118 118
 		$record->{$this->name} = $htmlValue->getContent();
119 119
 	}
120 120
 
121
+	/**
122
+	 * @param string|null $value
123
+	 */
121 124
 	public function setValue($value) {
122 125
 		// Regenerate links prior to preview, so that the editor can see them.
123 126
 		$value = Image::regenerate_html_links($value);
@@ -185,6 +188,10 @@  discard block
 block discarded – undo
185 188
 
186 189
 	protected $controller, $name;
187 190
 
191
+	/**
192
+	 * @param Controller|null $controller
193
+	 * @param string $name
194
+	 */
188 195
 	public function __construct($controller, $name) {
189 196
 		parent::__construct();
190 197
 
@@ -203,7 +210,7 @@  discard block
 block discarded – undo
203 210
 	/**
204 211
 	 * Searches the SiteTree for display in the dropdown
205 212
 	 *
206
-	 * @return callback
213
+	 * @return SilverStripe\ORM\DataList
207 214
 	 */
208 215
 	public function siteTreeSearchCallback($sourceObject, $labelField, $search) {
209 216
 		return DataObject::get($sourceObject)->filterAny(array(
@@ -583,7 +590,7 @@  discard block
 block discarded – undo
583 590
 	/**
584 591
 	 * Find all anchors available on the given page.
585 592
 	 *
586
-	 * @return array
593
+	 * @return string
587 594
 	 * @throws SS_HTTPResponse_Exception
588 595
 	 */
589 596
 	public function getanchors() {
@@ -646,7 +653,7 @@  discard block
 block discarded – undo
646 653
 	 * Gets files filtered by a given parent with the allowed extensions
647 654
 	 *
648 655
 	 * @param int $parentID
649
-	 * @return DataList
656
+	 * @return SilverStripe\ORM\DataList
650 657
 	 */
651 658
 	protected function getFiles($parentID = null) {
652 659
 		$exts = $this->getAllowedExtensions();
@@ -1159,7 +1166,7 @@  discard block
 block discarded – undo
1159 1166
 	}
1160 1167
 
1161 1168
 	/**
1162
-	 * @return AdapterInterface
1169
+	 * @return Embed
1163 1170
 	 */
1164 1171
 	public function getEmbed() {
1165 1172
 		return $this->embed;
Please login to merge, or discard this patch.
ORM/Connect/Database.php 1 patch
Doc Comments   +3 added lines, -2 removed lines patch added patch discarded remove patch
@@ -646,7 +646,7 @@  discard block
 block discarded – undo
646 646
 	 * @param boolean $create Flag indicating whether the database should be created
647 647
 	 * if it doesn't exist. If $create is false and the database doesn't exist
648 648
 	 * then an error will be raised
649
-	 * @param int|boolean $errorLevel The level of error reporting to enable for the query, or false if no error
649
+	 * @param boolean $errorLevel The level of error reporting to enable for the query, or false if no error
650 650
 	 * should be raised
651 651
 	 * @return boolean Flag indicating success
652 652
 	 */
@@ -681,7 +681,7 @@  discard block
 block discarded – undo
681 681
 	/**
682 682
 	 * Returns the name of the currently selected database
683 683
 	 *
684
-	 * @return string|null Name of the selected database, or null if none selected
684
+	 * @return string Name of the selected database, or null if none selected
685 685
 	 */
686 686
 	public function getSelectedDatabase() {
687 687
 		return $this->connector->getSelectedDatabase();
@@ -806,6 +806,7 @@  discard block
 block discarded – undo
806 806
 
807 807
 	/**
808 808
 	 * @deprecated since version 4.0 Use DB::field_list instead
809
+	 * @param string $table
809 810
 	 */
810 811
 	public function fieldList($table) {
811 812
 		Deprecation::notice('4.0', 'Use DB::field_list instead');
Please login to merge, or discard this patch.
ORM/Connect/MySQLSchemaManager.php 1 patch
Doc Comments   +3 added lines patch added patch discarded remove patch
@@ -115,6 +115,9 @@
 block discarded – undo
115 115
 		$this->query("ALTER TABLE \"$tableName\" $alterations");
116 116
 	}
117 117
 
118
+	/**
119
+	 * @param string $tableName
120
+	 */
118 121
 	public function isView($tableName) {
119 122
 		$info = $this->query("SHOW /*!50002 FULL*/ TABLES LIKE '$tableName'")->record();
120 123
 		return $info && strtoupper($info['Table_type']) == 'VIEW';
Please login to merge, or discard this patch.
ORM/Connect/MySQLStatement.php 1 patch
Doc Comments   +2 added lines, -2 removed lines patch added patch discarded remove patch
@@ -78,8 +78,8 @@
 block discarded – undo
78 78
 
79 79
 	/**
80 80
 	 * Hook the result-set given into a Query class, suitable for use by SilverStripe.
81
-	 * @param mysqli_stmt $statement The related statement, if present
82
-	 * @param mysqli_result $metadata The metadata for this statement
81
+	 * @param \mysqli_stmt $statement The related statement, if present
82
+	 * @param \mysqli_result $metadata The metadata for this statement
83 83
 	 */
84 84
 	public function __construct($statement, $metadata) {
85 85
 		$this->statement = $statement;
Please login to merge, or discard this patch.
ORM/Connect/PDOConnector.php 1 patch
Doc Comments   +1 added lines, -1 removed lines patch added patch discarded remove patch
@@ -324,7 +324,7 @@
 block discarded – undo
324 324
 	 * @param int $errorLevel
325 325
 	 * @param string $sql
326 326
 	 * @param array $parameters
327
-	 * @return \PDOQuery
327
+	 * @return PDOQuery|null
328 328
 	 */
329 329
 	protected function prepareResults($statement, $errorLevel, $sql, $parameters = array()) {
330 330
 
Please login to merge, or discard this patch.