silverstripe / silverstripe-framework

forms/gridfield/GridFieldComponent.php

Doc Comments +4 added lines, -1 removed lines

@@ -33,6 +33,7 @@ 
 	 * If you attempt to return HTML for a fragment that doesn't exist, an
 	 * exception will be thrown when the {@link GridField} is rendered.
 	 *
+	 * @param GridField $gridField
 	 * @return array
 	 */
 	public function getHTMLFragments($gridField);
@@ -57,6 +58,7 @@ 
 	 * @param GridField $gridField
 	 * @param arary $columns List of columns
 	 * @param array - List reference of all column names.
+	 * @return void
 	 */
 	public function augmentColumns($gridField, &$columns);
 
@@ -139,6 +141,7 @@ 
 	 * @param String Action identifier, see {@link getActions()}.
 	 * @param Array Arguments relevant for this
 	 * @param Array All form data
+	 * @param string $actionName
 	 */
 	public function handleAction(GridField $gridField, $actionName, $arguments, $data);
 }
@@ -189,6 +192,7 @@ 
 	 *
 	 * Handler methods will be called on the component, rather than the
 	 * {@link GridField}.
+	 * @param GridField $gridField
 	 */
 	public function getURLHandlers($gridField);
 }
@@ -205,7 +209,6 @@ 
 	/**
 	 * Called when a grid field is saved - i.e. the form is submitted.
 	 *
-	 * @param GridField $field
 	 * @param DataObjectInterface $record
 	 */
 	public function handleSave(GridField $grid, DataObjectInterface $record);

forms/gridfield/GridFieldConfig.php

Doc Comments +2 added lines

@@ -78,6 +78,7 @@ 
 
 	/**
 	 * @param String Class name or interface
+	 * @param string $type
 	 * @return GridFieldConfig $this
 	 */
 	public function removeComponentsByType($type) {
@@ -116,6 +117,7 @@ 
 	 * Returns the first available component with the given class or interface.
 	 *
 	 * @param String ClassName
+	 * @param string $type
 	 * @return GridFieldComponent
 	 */
 	public function getComponentByType($type) {

forms/gridfield/GridFieldDataColumns.php

Doc Comments +2 added lines, -1 removed lines

@@ -70,6 +70,7 @@ 
 	/**
 	 * Get the DisplayFields
 	 *
+	 * @param GridField $gridField
 	 * @return array
 	 * @see GridFieldDataColumns::setDisplayFields
 	 */
@@ -174,7 +175,7 @@ 
 	 * e.g. to set a title for a search column header.
 	 *
 	 * @param GridField $gridField
-	 * @param string $columnName
+	 * @param string $column
 	 * @return array - Map of arbitrary metadata identifiers to their values.
 	 */
 	public function getColumnMetadata($gridField, $column) {

forms/gridfield/GridFieldDeleteAction.php

Doc Comments +2 added lines, -2 removed lines

@@ -80,7 +80,7 @@ 
 	 * Which columns are handled by this component
 	 *
 	 * @param GridField $gridField
-	 * @return array
+	 * @return string[]
 	 */
 	public function getColumnsHandled($gridField) {
 		return array('Actions');
@@ -90,7 +90,7 @@ 
 	 * Which GridField actions are this component handling
 	 *
 	 * @param GridField $gridField
-	 * @return array
+	 * @return string[]
 	 */
 	public function getActions($gridField) {
 		return array('deleterecord', 'unlinkrelation');

forms/gridfield/GridFieldEditButton.php

Doc Comments +2 added lines, -2 removed lines

@@ -55,7 +55,7 @@ 
 	 * Which columns are handled by this component
 	 *
 	 * @param GridField $gridField
-	 * @return array
+	 * @return string[]
 	 */
 	public function getColumnsHandled($gridField) {
 		return array('Actions');
@@ -76,7 +76,7 @@ 
 	 * @param DataObject $record
 	 * @param string $columnName
 	 *
-	 * @return string - the HTML for the column
+	 * @return HTMLText - the HTML for the column
 	 */
 	public function getColumnContent($gridField, $record, $columnName) {
 		// No permission checks, handled through GridFieldDetailForm,

forms/gridfield/GridFieldExportButton.php

Doc Comments +3 added lines, -1 removed lines

@@ -86,6 +86,7 @@ 
 
 	/**
 	 * Handle the export, for both the action button and the URL
+ 	 * @param GridField $gridField
  	 */
 	public function handleExport($gridField, $request = null) {
 		$now = Date("d-m-Y-H-i");
@@ -100,7 +101,7 @@ 
 	 * Generate export fields for CSV.
 	 *
 	 * @param GridField $gridField
-	 * @return array
+	 * @return string
 	 */
 	public function generateExportFileData($gridField) {
 		$csvColumns = ($this->exportColumns)
@@ -227,6 +228,7 @@ 
 
 	/**
 	 * @param boolean
+	 * @param boolean $bool
 	 */
 	public function setCsvHasHeader($bool) {
 		$this->csvHasHeader = $bool;

forms/gridfield/GridFieldFilterHeader.php

Doc Comments +1 added lines

@@ -23,6 +23,7 @@
 	 *
 	 * By default, this is set to true so that it's clearer what's happening, but the predefined
 	 * {@link GridFieldConfig} subclasses set this to false for flexibility.
+	 * @param boolean $throwExceptionOnBadDataType
 	 */
 	public function setThrowExceptionOnBadDataType($throwExceptionOnBadDataType) {
 		$this->throwExceptionOnBadDataType = $throwExceptionOnBadDataType;

forms/gridfield/GridFieldPageCount.php

Doc Comments +1 added lines, -1 removed lines

@@ -23,7 +23,7 @@
 	protected $itemClass = 'GridFieldPageCount';
 
 	/**
-	 * @param string $targetFrament The fragment indicating the placement of this page count
+	 * @param string $targetFragment The fragment indicating the placement of this page count
 	 */
 	public function __construct($targetFragment = 'before') {
 		$this->targetFragment = $targetFragment;

forms/gridfield/GridFieldPaginator.php

Doc Comments +2 added lines

@@ -50,6 +50,7 @@ 
 	 *
 	 * By default, this is set to true so that it's clearer what's happening, but the predefined
 	 * {@link GridFieldConfig} subclasses set this to false for flexibility.
+	 * @param boolean $throwExceptionOnBadDataType
 	 */
 	public function setThrowExceptionOnBadDataType($throwExceptionOnBadDataType) {
 		$this->throwExceptionOnBadDataType = $throwExceptionOnBadDataType;
@@ -65,6 +66,7 @@ 
 	/**
 	 * Check that this dataList is of the right data type.
 	 * Returns false if it's a bad data type, and if appropriate, throws an exception.
+	 * @param SS_List $dataList
 	 */
 	protected function checkDataType($dataList) {
 		if($dataList instanceof SS_Limitable) {