@@ -78,6 +78,7 @@ discard block |
||
| 78 | 78 | |
| 79 | 79 | /** |
| 80 | 80 | * @param String Class name or interface |
| 81 | + * @param string $type |
|
| 81 | 82 | * @return GridFieldConfig $this |
| 82 | 83 | */ |
| 83 | 84 | public function removeComponentsByType($type) { |
@@ -116,6 +117,7 @@ discard block |
||
| 116 | 117 | * Returns the first available component with the given class or interface. |
| 117 | 118 | * |
| 118 | 119 | * @param String ClassName |
| 120 | + * @param string $type |
|
| 119 | 121 | * @return GridFieldComponent |
| 120 | 122 | */ |
| 121 | 123 | public function getComponentByType($type) { |
@@ -70,6 +70,7 @@ discard block |
||
| 70 | 70 | /** |
| 71 | 71 | * Get the DisplayFields |
| 72 | 72 | * |
| 73 | + * @param GridField $gridField |
|
| 73 | 74 | * @return array |
| 74 | 75 | * @see GridFieldDataColumns::setDisplayFields |
| 75 | 76 | */ |
@@ -174,7 +175,7 @@ discard block |
||
| 174 | 175 | * e.g. to set a title for a search column header. |
| 175 | 176 | * |
| 176 | 177 | * @param GridField $gridField |
| 177 | - * @param string $columnName |
|
| 178 | + * @param string $column |
|
| 178 | 179 | * @return array - Map of arbitrary metadata identifiers to their values. |
| 179 | 180 | */ |
| 180 | 181 | public function getColumnMetadata($gridField, $column) { |
@@ -55,7 +55,7 @@ discard block |
||
| 55 | 55 | * Which columns are handled by this component |
| 56 | 56 | * |
| 57 | 57 | * @param GridField $gridField |
| 58 | - * @return array |
|
| 58 | + * @return string[] |
|
| 59 | 59 | */ |
| 60 | 60 | public function getColumnsHandled($gridField) { |
| 61 | 61 | return array('Actions'); |
@@ -76,7 +76,7 @@ discard block |
||
| 76 | 76 | * @param DataObject $record |
| 77 | 77 | * @param string $columnName |
| 78 | 78 | * |
| 79 | - * @return string - the HTML for the column |
|
| 79 | + * @return HTMLText - the HTML for the column |
|
| 80 | 80 | */ |
| 81 | 81 | public function getColumnContent($gridField, $record, $columnName) { |
| 82 | 82 | // No permission checks, handled through GridFieldDetailForm, |
@@ -23,7 +23,7 @@ |
||
| 23 | 23 | protected $itemClass = 'GridFieldPageCount'; |
| 24 | 24 | |
| 25 | 25 | /** |
| 26 | - * @param string $targetFrament The fragment indicating the placement of this page count |
|
| 26 | + * @param string $targetFragment The fragment indicating the placement of this page count |
|
| 27 | 27 | */ |
| 28 | 28 | public function __construct($targetFragment = 'before') { |
| 29 | 29 | $this->targetFragment = $targetFragment; |
@@ -50,6 +50,7 @@ discard block |
||
| 50 | 50 | * |
| 51 | 51 | * By default, this is set to true so that it's clearer what's happening, but the predefined |
| 52 | 52 | * {@link GridFieldConfig} subclasses set this to false for flexibility. |
| 53 | + * @param boolean $throwExceptionOnBadDataType |
|
| 53 | 54 | */ |
| 54 | 55 | public function setThrowExceptionOnBadDataType($throwExceptionOnBadDataType) { |
| 55 | 56 | $this->throwExceptionOnBadDataType = $throwExceptionOnBadDataType; |
@@ -65,6 +66,7 @@ discard block |
||
| 65 | 66 | /** |
| 66 | 67 | * Check that this dataList is of the right data type. |
| 67 | 68 | * Returns false if it's a bad data type, and if appropriate, throws an exception. |
| 69 | + * @param SS_List $dataList |
|
| 68 | 70 | */ |
| 69 | 71 | protected function checkDataType($dataList) { |
| 70 | 72 | if($dataList instanceof SS_Limitable) { |
@@ -66,7 +66,7 @@ discard block |
||
| 66 | 66 | * |
| 67 | 67 | * @param GridField |
| 68 | 68 | * |
| 69 | - * @return array |
|
| 69 | + * @return string[] |
|
| 70 | 70 | */ |
| 71 | 71 | public function getActions($gridField) { |
| 72 | 72 | return array('print'); |
@@ -100,6 +100,7 @@ discard block |
||
| 100 | 100 | |
| 101 | 101 | /** |
| 102 | 102 | * Handle the print, for both the action button and the URL |
| 103 | + * @param GridField $gridField |
|
| 103 | 104 | */ |
| 104 | 105 | public function handlePrint($gridField, $request = null) { |
| 105 | 106 | set_time_limit(60); |
@@ -29,6 +29,7 @@ discard block |
||
| 29 | 29 | * |
| 30 | 30 | * By default, this is set to true so that it's clearer what's happening, but the predefined |
| 31 | 31 | * {@link GridFieldConfig} subclasses set this to false for flexibility. |
| 32 | + * @param boolean $throwExceptionOnBadDataType |
|
| 32 | 33 | */ |
| 33 | 34 | public function setThrowExceptionOnBadDataType($throwExceptionOnBadDataType) { |
| 34 | 35 | $this->throwExceptionOnBadDataType = $throwExceptionOnBadDataType; |
@@ -61,7 +62,7 @@ discard block |
||
| 61 | 62 | * Specify sortings with fieldname as the key, and actual fieldname to sort as value. |
| 62 | 63 | * Example: array("MyCustomTitle"=>"Title", "MyCustomBooleanField" => "ActualBooleanField") |
| 63 | 64 | * |
| 64 | - * @param array $casting |
|
| 65 | + * @param array $sorting |
|
| 65 | 66 | */ |
| 66 | 67 | public function setFieldSorting($sorting) { |
| 67 | 68 | $this->fieldSorting = $sorting; |
@@ -24,8 +24,7 @@ |
||
| 24 | 24 | |
| 25 | 25 | /** |
| 26 | 26 | * |
| 27 | - * @param GridField $name |
|
| 28 | - * @param string $data - json encoded string |
|
| 27 | + * @param GridField $grid |
|
| 29 | 28 | */ |
| 30 | 29 | public function __construct($grid, $value = null) { |
| 31 | 30 | $this->grid = $grid; |
@@ -10,7 +10,7 @@ |
||
| 10 | 10 | /** |
| 11 | 11 | * @param array $properties |
| 12 | 12 | * |
| 13 | - * @return HTMLText |
|
| 13 | + * @return string |
|
| 14 | 14 | */ |
| 15 | 15 | public function FieldHolder($properties = array()) { |
| 16 | 16 | return $this->Field($properties); |