csv-exports.md

Csv Exports

• Usage
  • Set Heading Columns
  • Define Row Values
  • Export Csv File
• Implementation Example

This functionality allows you to download csv files for a given collection of model records.

Usage

Your models should use the Varbox\Traits\IsCsvExportable trait. The trait contains two abstract methods which you'll have to implement yourself:

<?php

namespace App\Models;

use Illuminate\Database\Eloquent\Model;
use Varbox\Traits\IsCsvExportable;

class YourModel extends Model
{
    use IsCsvExportable;

    /**
     * Get the heading columns for the csv.
     *
     * @return array
     */
    public function getCsvColumns()
    {
        return [
            'Name', 'Url', 'Active', 'Created At', 'Last Modified At'
        ];
    }

    /**
     * Get the values for a row in the csv.
     *
     * @return array
     */
    public function toCsvArray()
    {
        return [
            $this->name,
            $this->getUrl(),
            $this->isActive() ? 'Yes' : 'No',
            $this->created_at->format('Y-m-d H:i:s'),
            $this->updated_at->format('Y-m-d H:i:s'),
        ];
    }

    ...
}

Set Heading Columns

You can set the heading columns for the csv by implementing the getCsvColumns() method.

/**
 * Get the heading columns for the csv.
 *
 * @return array
 */
public function getCsvColumns()
{
    return [
        'Name', 'Url', 'Active', 'Created At', 'Last Modified At'
    ];
}

Define Row Values

You can define what values each exported row will have by using the toCsvArray() method.

Please note that inside this method, $this actually represents the loaded model instance, so you can call methods, relations, etc. and parse them as you'd like to show in the exported csv file.

/**
 * Get the values for a row in the csv.
 *
 * @return array
 */
public function toCsvArray()
{
    return [
        $this->name,
        $this->getUrl(),
        $this->isActive() ? 'Yes' : 'No',
        $this->created_at->format('Y-m-d H:i:s'),
        $this->updated_at->format('Y-m-d H:i:s'),
    ];
}

Export Csv File

After you've implemented the trait on your models, you can download a csv file using the exportToCsv() method, inside your controller for example.

$items = YourModel::where('active', true)->orderBy('name')->get();

return app(YourModel::class)->exportToCsv($items);

Implementation Example

For an implementation example of this functionality please refer to the Full Example page.