The columns in the export do not match the specified order.

[gzai]

Package

Table builder

Package Version

v3.3.14

How can we help you?

I have export columns like this :

class SiteProgressFullExporter extends Exporter
{
    protected static ?string $model = TargetProductProgress::class;

    public function getFileName(Export $export): string
    {
        return 'Site Progress-' . date('YmdHis');
    }

    public function getFormats(): array
    {
        return [
            ExportFormat::Xlsx,
        ];
    }

    public static function getColumns(): array
    {
        return [
            ExportColumn::make('target.name')
                ->label('Site Name'),
            ExportColumn::make('period_start')
                ->label('Period Start'),
            ExportColumn::make('period_end')
                ->label('Period End'),
            ExportColumn::make('target.vendor.name')
                ->label('Vendor'),
            ExportColumn::make('target.province.name')
                ->label('Province'),
            ExportColumn::make('target.city.name')
                ->label('City'),
            ExportColumn::make('communication.name')
                ->label('Communication'),
            ExportColumn::make('target.type.name')
                ->label('Type'),
            ExportColumn::make('product.name')
                ->label('Product'),
            ExportColumn::make('material.name')
                ->label('Material'),
            ExportColumn::make('target.latitude')
                ->label('Latitude'),
            ExportColumn::make('target.longitude')
                ->label('Longitude'),
            ExportColumn::make('progress_status.name')
                ->label('Status'),
            ExportColumn::make('created_at')
                ->label('Created'),
            ExportColumn::make('progress')
                ->label('Progress')
                ->getStateUsing(function ($record): string {
                    return progress_percentage(
                        $record->progress_true_count, 
                        $record->progress_count
                    );
                }),
        ];
    }

    public static function getCompletedNotificationBody(Export $export): string
    {
        $body = 'Your site progress export has completed and ' . number_format($export->successful_rows) . ' ' . str('row')->plural($export->successful_rows) . ' exported.';

        if ($failedRowsCount = $export->getFailedRowsCount()) {
            $body .= ' ' . number_format($failedRowsCount) . ' ' . str('row')->plural($failedRowsCount) . ' failed to export.';
        }

        return $body;
    }
}

but the result look like this :

How to fix this issue?

[jamiemcd]

I had this issue as well. The order of the ExportColumn in the array returned by my getColumns() function does not determine the order in the resulting .csv file.

I looked at Filament's Exporter.php which has this function:

public function getCachedColumns(): array
{
    return $this->cachedColumns ??= array_reduce(static::getColumns(), function (array $carry, ExportColumn $column): array {
        $carry[$column->getName()] = $column->exporter($this);

        return $carry;
    }, []);
}

It is the column's name that is the key in the associative array built here. So I wondered if there was a bug deeper in code and somehow it was exporting the columns in alphabetical order using name or something. I am new to Filament so I have not figured that out yet. But I was able to get my 5 columns in the order I wanted by changing the columns name and then just using the state() function.

Before:

ExportColumn::make('user.email')
    ->label('Email'),

After:

ExportColumn::make('email')
    ->label('Email')
    ->state(fn (User $user): string => user->email),

[gzai]

I have someone experiencing the same issue :)

it seems there is a bug when we add a relationship in the columns.
If we don’t use a relationship in the columns, the column order in the export will follow the original order in the code.