帕拉图/parasut-rapor

帕拉图定期销售报告

1.0.0 2017-01-24 23:33 UTC

This package is not auto-updated.

Last update: 2024-09-28 20:09:16 UTC


README

使用Paraşüt API发送销售发票月度报告的Laravel库

框架: Laravel

Latest Version on Packagist Software License

如何安装?

步骤: 1

由于该包是一个Laravel包,因此首先您需要有一个安装好的Laravel环境。请参阅如何安装Laravel。

步骤: 2

在Laravel已安装的根目录中运行以下命令来安装包:

$ composer require salyangoz/parasut-rapor

步骤: 3

由于该包通过另一个包生成Excel导出,因此您还需要安装Excel包;

$ composer require maatwebsite/excel

步骤: 4

为了使扩展在当前Laravel中可用,您需要在Laravel项目目录中的Config/app.php中添加以下更改;

    'providers' => [
        Salyangoz\ParasutRapor\ParasutRaporServiceProvider::class,
        Maatwebsite\Excel\ExcelServiceProvider::class
    ],

步骤 5: 环境配置

包将从Laravel项目中的.env文件中获取项目将使用的Paraşüt信息和设置。您可以在本存储库中的.env.example文件中查看将定义哪些变量。

可选

如果需要更改项目中的包中的静态变量(例如电子邮件文本等),则需要发布它们。可以使用以下命令进行此操作:

php artisan vendor:publish --provider="Salyangoz\ParasutRapor\ParasutRaporServiceProvider"

运行此命令后,包的config.php文件将作为parasut-rapor.php复制到Laravel项目的config目录中,邮件视图文件将复制到resources/views路径,这里的更改将与包内的config文件合并或覆盖。

步骤 6: Laravel任务

为了将订单报告发送到指定的电子邮件地址,您需要定义以下cron作业:

App\Console\Kernel.php

namespace App\Console;

use Illuminate\Console\Scheduling\Schedule;
use Illuminate\Foundation\Console\Kernel as ConsoleKernel;

class Kernel extends ConsoleKernel
{

    protected $commands = [
        \Salyangoz\ParasutRapor\Commands\Report::class
    ];

    /**
     * Define the application's command schedule.
     *
     * @param  \Illuminate\Console\Scheduling\Schedule  $schedule
     * @return void
     */
    protected function schedule(Schedule $schedule)
    {
         /* Aylık rapor */
           $schedule->command('parasut-rapor:report')->monthly();
           
         /* Haftalık */
          $schedule->command('parasut-rapor:report')->weekly();
          
          /* Günlük rapor */
         #$schedule->command('parasut-rapor:report')->daily();
    }

    /**
     * Register the Closure based commands for the application.
     *
     * @return void
     */
    protected function commands()
    {
        require base_path('routes/console.php');
    }
}

重要提示:为了使Laravel任务调度器工作,Web服务器上的cron需要运行。

Laravel任务调度如何定义

确认Laravel任务调度器正在运行后,我们就可以说我们已经准备好了!

完成以下配置后,您可以通过直接在命令行中运行它来测试任务是否正确运行:

$ php artisan parasut-rapor:report

如何使用?

Paraşüt API配置过程

  1. destek@parasut.com 发送电子邮件,表明您想从注册的电子邮件地址使用API,并请求与您分享这些信息。
  2. 从收到的信息中,将Application Id、Secret以及您登录Paraşüt时顶部链接中开始的6位数字部分和为发票打开的类别ID输入到项目的.env文件中。
PARASUT_CLIENT_ID=
PARASUT_CLIENT_SECRET=
PARASUT_USERNAME=
PARASUT_COMPANY_ID=
PARASUT_PASSWORD=
PARASUT_CATEGORY_ID=
PARASUT_ACCOUNT_ID=

电子邮件配置 (.env)

根据Laravel Mail 页面上的信息,设置您的Laravel项目邮件配置。然后输入以下值。

EMAIL_FROM_EMAIL=Mailde görünecek gönderen email adresi
EMAIL_FROM_NAME=Mailde görünecek gönderen adı
EMAIL_TO_EMAIL=Raporların gönderileceği email adresleri. (,) ile ayrılır
EMAIL_CC_EMAIL=Raporları cc ile gönderileceği email adresleri. (,) ile ayrılır

计划间隔 (.env)

您可以使用以下设置来指定哪些间隔的订单将被抓取。这里可以接受3个不同的值。

monthly,weekly,daily.

这里指定的值应该与您计划的cron作业相同。例如,如果您打开了月度报告,则cron也应该设置为月度。

PARASUT_REPORT_PERIOD=monthly

包含的发票 (.env)

系统仅获取您指定的以特定字符开始的发票的报告。 (如果您留空,则获取所有发票)。

PARASUT_REPORT_INVOICE_PREFIX=KR,KU

安全

如果您发现任何安全漏洞,请通过info@salyangoz.com.tr 发送通知,而不是直接在issue中报告。

开发平台

  • Laravel - 适合网页工匠的PHP框架

版本控制

  • 我们使用SemVer版本控制系统。要查看版本,请访问SemVer,并查看标签部分。

参与者

许可证

The MIT License (MIT)。更多信息请参阅许可证文件

附加信息

Salangoz网址