Laravel development: How to use Laravel Excel to implement Excel import and export?

Laravel development: How to use Laravel Excel to implement Excel import and export?

In development, Excel tables are often used for data processing, such as data import and export. Laravel Excel is a simple and powerful Laravel extension that allows us to easily process Excel files, including reading, writing, and exporting operations of Excel files. In this article, we will introduce how to implement Excel import and export using Laravel Excel.

1. Installing Laravel Excel

Using Laravel Excel in a Laravel project is very simple. You only need to add the dependency of the laravel-excel package to the composer.json file. Execute the following command in the command line:

composer require maatwebsite/excel

2. Configuring Laravel Excel

After installing Laravel Excel, we need to do some configuration to use it. First, add the following code to the config/app.php file:

'providers' => [
    // ...
    MaatwebsiteExcelExcelServiceProvider::class,
  ],

'aliases' => [
    // ...
    'Excel' => MaatwebsiteExcelFacadesExcel::class,
  ],

Then, we need to publish the Laravel Excel configuration file and execute the following command:

php artisan vendor:publish --provider="MaatwebsiteExcelExcelServiceProvider" --tag=config

This will be generated in the config directory An excel.php file, we can make some configurations in this file, such as the format of the export file, the default export file name, etc.

3. Excel file export

Next, we will introduce how to use Laravel Excel to export Excel files.

3.1 Create an export class

First, we need to create an export class to define the format and content of the exported data. Execute the following command in the command line:

php artisan make:export UsersExport --model=User

This will generate a UsersExport class in the app/Exports directory, in which the data format and content of the exported Excel file can be defined. For example, if we want to export the data of the user table, we can define the following content in this class:

namespace AppExports;

use AppModelsUser;
use MaatwebsiteExcelConcernsFromCollection;

class UsersExport implements FromCollection
{
   public function collection()
   {
       return User::all();
   }
}

In the above code, we specify through the FromCollection interface that the source of the exported data is all user data in the User model .

In addition to the FromCollection interface, Laravel Excel also provides some other interfaces, such as FromQuery and FromView, etc. You can choose the corresponding interface according to actual needs.

3.2 Use the export class to export Excel files

After defining the export class, we can call the export class through the following code to export the data to the Excel file:

use AppExportsUsersExport;
use MaatwebsiteExcelFacadesExcel;

public function export()
{
    return Excel::download(new UsersExport, 'users.xlsx');
}

In the above code, we use the Excel::download() method to output the Excel file, where the first parameter is the export class object just created, and the second parameter is the name of the Excel file.

4. Excel file import

Next, we will introduce how to use Laravel Excel to import Excel files.

4.1 Create an import class

First, we need to create an import class to define the format and content of the imported data. Execute the following command in the command line:

php artisan make:import UsersImport --model=User

This will generate a UsersImport class in the app/Imports directory, in which the data format and content of the imported Excel file can be defined. For example, if we want to import data from the User table, we can define the following content in this class:

namespace AppImports;

use AppModelsUser;
use MaatwebsiteExcelConcernsToModel;
use MaatwebsiteExcelConcernsWithHeadingRow;

class UsersImport implements ToModel, WithHeadingRow
{
    public function model(array $row)
    {
        return new User([
            'name'     => $row['name'],
            'email'    => $row['email'],
            'password' => Hash::make($row['password']),
        ]);
    }
}

In the above code, we map each row of data in the Excel file to the properties of the User model through the ToModel interface on the table, and specify the first row of the Excel file as the header (that is, the attribute name) through the WithHeadingRow interface.

In addition to the ToModel and WithHeadingRow interfaces, Laravel Excel also provides some other interfaces, such as ToCollection and ToModel, etc. You can choose the corresponding interface according to actual needs.

4.2 Use the import class to import Excel files

After defining the import class, we can call the import class through the following code to import data from the Excel file into the database:

use AppImportsUsersImport;
use MaatwebsiteExcelFacadesExcel;

public function import()
{
    Excel::import(new UsersImport, request()->file('file'));

    return redirect()->back();
}

In the above code, we use the Excel::import() method to import the Excel file, where the first parameter is the import class object just created, and the second parameter is the uploaded Excel file.

5. Conclusion

Through Laravel Excel, we can easily implement the import and export functions of Excel files, greatly simplifying the data processing process. In actual project development, using Laravel Excel can greatly improve development efficiency and reduce development costs. Hope this article is helpful to you.

The above is the detailed content of Laravel development: How to use Laravel Excel to implement Excel import and export?. For more information, please follow other related articles on the PHP Chinese website!