包简介

A Laravel livewire CSV Importer, to handle importing millions of rows without a hustle.

README 文档

README

Introduction
Installation
Configuration
Usage
Testing
Changelog
Contributing
Security Vulnerabilities
Inspiration
Credits
License

Introduction

Laravel CSV Package is a package created on top of Laravel livewire for easily handling imports with a simple API.

Installation

You can install the package via composer:

composer require coderflex/laravel-csv

Configuration

Publish and run the migrations with:

php artisan vendor:publish --tag="csv-migrations"
php artisan migrate

Add trait HasCsvImports to your User model.

Publish the config file with:

php artisan vendor:publish --tag="csv-config"

The following is the contents of the published config file:

return [

    /*
    |--------------------------------------------------------------------------
    | Default Layout
    |--------------------------------------------------------------------------
    |
    | This package plans on supporting multiple CSS frameworks. 
    | Currently, 'tailwindcss' is the default and only supported framework.
    |
    */
    'layout' => 'tailwindcss',

    /*
    |--------------------------------------------------------------------------
    | Max Upload File Size
    |--------------------------------------------------------------------------
    |
    | The default maximumum file size that can be imported by this
    | package is 20MB. If you wish to increase/decrease this value, 
    | change the value in KB below.
    |
    */
    'file_upload_size' => 20000,
];

The layout option is for choosing which CSS framework you are using and currently supports only tailwindcss. We are working on other CSS frameworks to implement in the future.

The file_upload_size is for validation rules, and it defines the maximum file size of uploaded files. You may also define this value from the livewire config file.

Optionally, you can publish the views using

php artisan vendor:publish --tag="laravel-csv-views"

Before Using this command, please take a look at this section below.

Usage

CSV Importer Component

Using this package is a breeze. To implement the importer in your project, simply include the following component inside a Blade view.

    <livewire:csv-importer :model="App\Models\YourModel::class"
                            :columns-to-map="['id', 'name', 'email', 'password']"
                            :required-columns="['id', 'name', 'email']"
                            :columns-label="[
                                'id' => 'ID',
                                'name' => 'Name',
                                'email' => 'Email Address',
                                'password' => 'Password',
                            ]"/>

Props	Type	Description
model	`string`	Fully qualified name of the model you wish to import to
columns-to-map	`array`	Column names in the target database table
required-columns	`array`	Columns that are required by validation for import
columns-label	`array`	Display labels for the required columns

Button Component

The Component uses alpinejs under the hood. To display an import button, include the x-csv-button component.

<x-csv-button>Import</x-csv-button>

To style the button, use the class attribute with Tailwind utility classes.

<x-csv-button 
        class="rounded py-2 px-3 bg-indigo-500 ..."
        type="button"
        ....>
    {{ __('Import') }}
</x-csv-button>

In TALL stack project

If you are using this package in a TALL Stack project, (Tailwindcss, Alpinejs, Laravel, Livewire) publish the vendor views to include Laravel-CSV in your project.

php artisan vendor:publish --tag="csv-views"

Then compile your assets.

npm run dev

In none TALL Stack project

If you are not using the TALL Stack, use the csv directives to add the necessary styles/scripts.

<html>
    ...
    <head>
        ...
        @csvStyles
    </head>
        ...
    <footer>
        ...
        @csvScripts
    </footer>
</html>

Using Queues

This package uses queues under the hood with PHP Generators to make it fast and efficient.

Create the batches table by running

php artisan queue:batches-table

Then, run the migration.

php artisan migrate

After that, set up the queues' configuration. Head to Laravel Queues Documentation to learn more.

Testing

composer test

Changelog

Please see CHANGELOG for more information on what has changed recently.

Contributing

Please see CONTRIBUTING for details.

Security Vulnerabilities

Please review our security policy on how to report security vulnerabilities.

Inspiration

This Package Was Inspired by codecourse video series. If you want to learn how this package was created, make sure to take a look at this video series

Credits

License

The MIT License (MIT). Please see License File for more information.

coderflex/laravel-csv 适用场景与选型建议

coderflex/laravel-csv 是一款基于 PHP 开发的 Composer 扩展包，目前已累计 75 次下载、GitHub Stars 达 64，最近一次更新时间为 2022 年 09 月 18 日，在 PHP 生态内属于活跃度较高的组件。

它主要适用于以下技术方向：「laravel」「livewire」「coderflex」「laravel-csv」等业务场景。在实际项目中，围绕这些方向常见需要落地的问题包括：接口对接、性能调优、并发安全、与既有框架（Laravel / ThinkPHP / Yii / Webman 等）的兼容适配，以及生产环境的日志埋点与稳定性保障。

我们在过去多个企业项目中使用过 coderflex/laravel-csv 或与其功能相近的方案，如果你在选型或落地过程中遇到问题，例如 版本兼容、二次改造、私有化封装、与内部系统对接、生产 BUG 排查，欢迎联系我们协助评估。

围绕 coderflex/laravel-csv 我们能提供哪些服务？

定制开发 / 二次开发

基于 coderflex/laravel-csv 在你已有业务上做功能扩展、字段裁剪、UI 适配、与内部账号 / 权限 / 日志系统的深度对接。

BUG 修复 & 性能优化

线上偶发问题、内存泄漏、慢查询、并发异常等排查修复；针对高流量场景做缓存、队列、索引层面的调优。

项目外包 & 长期维护

承接完整的项目从需求 → 设计 → 开发 → 上线 → 长期运维；也可按月提供技术保姆服务。

yvsm@zunyunkeji.com QQ：316430983 微信：yvsm316 西安尊云信息科技 · 专注 PHP / Go / 分布式系统研发

与 coderflex/laravel-csv 相关的其它包

同方向 / 同关键字的高下载量 PHP Composer 包推荐，方便对比选型：

coderflex/laravel-turnstile 114

A package to help you implement the Cloudflare turnstile "CAPTCHA Alternative"

coderflex/filament-turnstile 30

Filament Plugin to help you implement Cloudflare Turnstile

coderflexx/laravel-presenter 31

Write Clean/Reusable Code with Presenters.

coderflexx/laravisit 434

A package to keep track of your pages & understand your audience

coderflex/laravel-ticket 439

Laravel Ticket System, to help you manage your tickets eaisly

lunarphp/livewire-starter-kit 204

Livewire starter kit for Lunar e-commerce.

coderflex/laravel-csv

包简介

关键字：