Skip to content

Commit 3e5124f

Browse files
authored
Update docblock
1 parent a46b677 commit 3e5124f

1 file changed

Lines changed: 9 additions & 9 deletions

File tree

src/View/CsvView.php

Lines changed: 9 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -11,9 +11,9 @@
1111
/**
1212
* A view class that is used for CSV responses.
1313
*
14-
* By setting the '_serialize' key in your controller, you can specify a view variable
14+
* By setting the 'serialize' view builder option, you can specify a view variable
1515
* that should be serialized to CSV and used as the response for the request.
16-
* This allows you to omit views + layouts, if your just need to emit a single view
16+
* This allows you to omit templates + layouts, if your just need to emit a single view
1717
* variable as the CSV response.
1818
*
1919
* In your controller, you could do the following:
@@ -44,18 +44,18 @@
4444
* $this->viewBuilder()->setOption('serialize', ['posts', 'users']);
4545
* ```
4646
*
47-
* Each of the viewVars in `serialize` would then be output into the csv
47+
* Each of the view vars in `serialize` would then be output into the CSV output.
4848
*
4949
* If you don't use the `serialize` option, you will need a view. You can use extended
5050
* views to provide layout like functionality.
5151
*
5252
* When not using custom views, you may specify the following view options:
5353
*
54-
* - array `$header`: (default null) A flat array of header column names
55-
* - array `$footer`: (default null) A flat array of footer column names
56-
* - string `$delimiter`: (default ',') CSV Delimiter, defaults to comma
57-
* - string `$enclosure`: (default '"') CSV Enclosure for use with fputcsv()
58-
* - string `$eol`: (default '\n') End-of-line character the csv
54+
* - array `header`: (default null) A flat array of header column names
55+
* - array `footer`: (default null) A flat array of footer column names
56+
* - string `delimiter`: (default ',') CSV Delimiter, defaults to comma
57+
* - string `enclosure`: (default '"') CSV Enclosure for use with fputcsv()
58+
* - string `eol`: (default '\n') End-of-line character the csv
5959
*
6060
* @link https://github.com/friendsofcake/cakephp-csvview
6161
*/
@@ -143,7 +143,7 @@ class CsvView extends SerializedView
143143
* - 'dataEncoding': (default 'UTF-8') Encoding of data to be serialized
144144
* - 'transcodingExtension': (default 'iconv') PHP extension to use for character encoding conversion
145145
*
146-
* @var array
146+
* @var array<string, mixed>
147147
*/
148148
protected $_defaultConfig = [
149149
'extract' => null,

0 commit comments

Comments
 (0)