• Home
• CsvView
• View
• CsvView

PHP Class CsvView\View\CsvView

By setting the '_serialize' key in your controller, you can specify a view variable that should be serialized to CSV and used as the response for the request. This allows you to omit views + layouts, if your just need to emit a single view variable as the CSV response. In your controller, you could do the following: $this->set(['posts' => $posts, '_serialize' => 'posts']); When the view is rendered, the $posts view variable will be serialized into CSV. When rendering the data, the data should be a single, flat array. If this is not the case, then you should also specify an _extract variable: $_extract = [ ['id', '%d'], // Hash-compatible path, sprintf-compatible format 'description', // Hash-compatible path function ($row) { // Callable return value } ]; You can also define '_serialize' as an array. This will create a top level object containing all the named view variables: $this->set(compact('posts', 'users', 'stuff')); $this->set('_serialize', array('posts', 'users')); Each of the viewVars in _serialize would then be output into the csv If you don't use the _serialize key, you will need a view. You can use extended views to provide layout like functionality. When not using custom views, you may specify the following view variables: - array $_header: (default null) A flat array of header column names - array $_footer: (default null) A flat array of footer column names - string $_delimiter: (default ',') CSV Delimiter, defaults to comma - string $_enclosure: (default '"') CSV Enclosure for use with fputscsv() - string $_eol: (default '\n') End-of-line character the csv Show file Open project: friendsofcake/cakephp-csvview

Public Properties

Property	Type	Description
$layoutPath	string	CSV layouts are located in the csv sub directory of Layouts/
$subDir	string	CSV views are always located in the 'csv' sub directory for a controllers views.

Protected Properties

Property	Type	Description
$_resetStaticVariables	boolean	Whether or not to reset static variables in use
$_specialVars	array	List of special view vars.

Public Methods

Method	Description
__construct ( Cake\Network\Request $request = null, Response $response = null, Cake\Event\EventManager $eventManager = null, array $viewOptions = [] )	Constructor
loadHelpers ( ) : void	Skip loading helpers if this is a _serialize based view.
render ( string | null $view = null, string | null $layout = null ) : string	Render a CSV view.

Protected Methods

Method	Description
_generateRow ( array | null $row = null ) : string | false	Generates a single row in a csv from an array of data by writing the array to a temporary file and returning it's contents
_renderContent ( ) : void	Renders the body of the data to the csv
_renderRow ( array | null $row = null ) : null | string	Aggregates the rows into a single csv
_serialize ( ) : string	Serialize view vars.
_setupViewVars ( ) : void	Setup defaults for CsvView view variables

Method Details

Property Details