feat: add laravel example

Author: krissss

README.md

@@ -1 +1,51 @@
 # Log Reader For PHP
+
+![preview](https://github.com/krissss/php-log-reader/raw/master/preview.jpg)
+
+# Installation
+
+```bash
+composer require kriss/log-reader
+```
+
+# Usage
+
+## Use LogReaderControllerTrait in controller
+
+```php
+use Kriss\LogReader\Traits\LogReaderControllerTrait;
+use Kriss\LogReader\LogReader;
+
+class SomeController {
+    use LogReaderControllerTrait;
+    
+    private $logReader;
+    
+    protected function getLogReader(): LogReader
+    {
+        if (!$this->logReader) {
+            //$runtimePath = __DIR__ . '/../runtime/logs';
+            $this->logReader = new LogReader($runtimePath, [
+                'enable' => true,
+                'deleteEnable' => true,
+                // others
+            ]);
+        }
+        return $this->logReader;
+    }
+
+    protected function getRequest(): SymfonyRequest
+    {
+        return request()->getSymfonyRequest();
+    }
+
+    protected function getBaseUrl(): string
+    {
+        return 'some/url-prefix';
+    }
+}
+```
+
+# For Laravel
+
+[see example](./example/laravel)

example/laravel/app/Http/Controllers/LogReaderController.php

@@ -0,0 +1,27 @@
+<?php
+
+namespace App\Http\Controllers;
+
+use Kriss\LogReader\LogReader;
+use Kriss\LogReader\Traits\LogReaderControllerTrait;
+use Symfony\Component\HttpFoundation\Request;
+
+class LogReaderController
+{
+    use LogReaderControllerTrait;
+
+    protected function getLogReader(): LogReader
+    {
+        return app('log-reader');
+    }
+
+    protected function getRequest(): Request
+    {
+        return request();
+    }
+
+    protected function getBaseUrl(): string
+    {
+        return url('log-reader');
+    }
+}

example/laravel/app/Providers/LogReaderServiceProvider.php

@@ -0,0 +1,32 @@
+<?php
+
+namespace App\Providers;
+
+use Illuminate\Foundation\Application;
+use Illuminate\Support\ServiceProvider;
+use Kriss\LogReader\LogReader;
+
+class LogReaderServiceProvider extends ServiceProvider
+{
+    protected $defer = true;
+
+    public function register()
+    {
+        $this->app->singleton('log-reader', function (Application $app) {
+            $config = $app['config']['log_reader'];
+            $logPath = $config['logPath'];
+            unset($config['logPath']);
+            return new LogReader($logPath, $config);
+        });
+
+        $this->app->alias('log-reader', LogReader::class);
+    }
+
+    public function provides()
+    {
+        return [
+            'log-reader',
+            LogReader::class,
+        ];
+    }
+}

example/laravel/config/log_reader.php

@@ -0,0 +1,15 @@
+<?php
+/**
+ * @see App\Providers\LogReaderServiceProvider
+ * @see Kriss\LogReader\LogReader
+ */
+return [
+    // 是否启用
+    'enable' => true,
+    // 是否允许删除
+    'deleteEnable' => true,
+    // 日志根路径
+    'logPath' => '@runtime/logs',
+    // tail 查看时默认读取的行大小
+    'tailDefaultLine' => 200,
+];

example/laravel/routes/web.php

@@ -0,0 +1,7 @@
+<?php
+
+Route::get('/log-reader/index', 'LogReaderController@index');
+Route::get('/log-reader/view', 'LogReaderController@view');
+Route::get('/log-reader/tail', 'LogReaderController@tail');
+Route::get('/log-reader/download', 'LogReaderController@download');
+Route::get('/log-reader/delete', 'LogReaderController@delete');