Filament importer & skipping import columns

I have a filament importer for the model Account that looks like this:

class AccountImporter extends Importer
{
    protected static ?string $model = Account::class;

    public static function getColumns(): array
    {
        return [
            ImportColumn::make('account_type')
                ->requiredMapping()
                ->rules(['required', 'max:255']),
            ImportColumn::make('name_title')
                ->rules(['max:255']),
            ImportColumn::make('first_name')
                ->rules(['max:255']),
            ImportColumn::make('middle_name')
                ->rules(['max:255']),
            ImportColumn::make('last_name')
                ->rules(['max:255']),
            ImportColumn::make('org_name')
                ->rules(['max:255']),
           ImportColumn::make('tax_id')
                ->rules(['max:255']),
            ImportColumn::make('payment_method')
                ->rules(['max:255']),
          [ etc ]
}
public function resolveRecord(): Account
    {
        
        $record = new Account();
        
        $record->account_type = $this->data['account_type'];
        $record->name_title = $this->data['name_title'];
        $record->first_name = $this->data['first_name'];
        $record->middle_name = $this->data['middle_name'];
        $record->last_name = $this->data['last_name'];
        $record->org_name = $this->data['org_name'];
        $record->tax_id = $this->data['tax_id'];
        $record->payment_method = $this->data['payment_method'];

        return $record;
}

Since most of the columns are not required, I thought I could skip them when importing (i.e. there is no column for "payment_method " in the csv file). However, if I omit the non-required columns completely from the import, I get an error:

production.ERROR: Undefined array key "payment_method" {"userId":1,"exception":"[object] (ErrorException(code: 0): Undefined array key \"payment_method\" at /home/forge/subito-datacenter.on-forge.com/app/Filament/Imports/AccountImporter.php:128)

Is there a way to indicate a default value (null) if the column is not present? I thought I had successfully run filament imports with some non-required fields unmatched to columns, but now I'm doubting myself.

LaryAI

8 hours ago

Best Answer

Level 58

Absolutely! The issue happens because, when a column (like payment_method) is skipped in your CSV and thus not part of the import, the $this->data array does not contain that key. When you try to access $this->data['payment_method'], PHP throws the "Undefined array key" error.

The fix: You need to safely access the data, using the null coalescing operator (??) to provide a default value (like null) when the key is missing.

Solution

Update your resolveRecord() method, replacing direct array access with the null coalescing operator, e.g.:

public function resolveRecord(): Account
{
    $record = new Account();

    $record->account_type   = $this->data['account_type'];
    $record->name_title     = $this->data['name_title'] ?? null;
    $record->first_name     = $this->data['first_name'] ?? null;
    $record->middle_name    = $this->data['middle_name'] ?? null;
    $record->last_name      = $this->data['last_name'] ?? null;
    $record->org_name       = $this->data['org_name'] ?? null;
    $record->tax_id         = $this->data['tax_id'] ?? null;
    $record->payment_method = $this->data['payment_method'] ?? null;

    return $record;
}

For required fields like account_type, you still want to access them directly, since Filament will already validate for their presence.
For optional fields, use $this->data['column'] ?? null.

Optional: Make it DRY (optional)

If you have a lot of columns, you could DRY it up using a loop and the model's $fillable array or a defined array of columns.

public function resolveRecord(): Account
{
    $record = new Account();

    $fields = [
        'account_type',
        'name_title',
        'first_name',
        'middle_name',
        'last_name',
        'org_name',
        'tax_id',
        'payment_method',
    ];

    foreach ($fields as $field) {
        $record->{$field} = $this->data[$field] ?? null;
    }

    return $record;
}

In summary:
Always use the null coalescing operator when accessing potentially missing keys from $this->data for non-required columns in your importer.

Let me know if you need a more dynamic solution (e.g., mass assignment using fillable fields)!

Please or to participate in this conversation.