增加範例檔案 (#3)

* 增加作為範例的類別模板

* Edit ServiceProvider.php: 設置 publisheds 列表

Author: Shishamou

publishes/config/stubs.php publishes/config.phppublishes/config/stubs.php renamed to publishes/config.php

@@ -7,7 +7,9 @@
     | Stub Storage Paths
     |--------------------------------------------------------------------------
     |
-    | 暫無說明
+    | 這邊妳可以指定 laravel-stubs 要讀取哪些路徑。
+    |
+    | Here you may specify an array of paths that should be read for your stubs.
     |
     */
 

publishes/resources/ExampleController.php

@@ -0,0 +1,25 @@
+<?php
+
+namespace App\Http\Controllers;
+
+use App\Models\Dummy;
+use App\Http\Resources\Dummy as DummyResource;
+use Illuminate\Http\Request;
+
+class DummyController extends Controller
+{
+    /**
+     * @param  \Illuminate\Http\Request  $request
+     * @return \Illuminate\Http\Response
+     */
+    public function __invoke(Request $request)
+    {
+        $query = Dummy::query();
+
+        $query->orderByPriority();
+
+        $records = $query->paginate($request->query('limit', 30));
+
+        return DummyResource::collection($records);
+    }
+}

publishes/resources/ExamplePack/Factory.php

@@ -0,0 +1,28 @@
+<?php
+
+namespace Database\Factories;
+
+use App\Models\Dummy;
+use Illuminate\Database\Eloquent\Factories\Factory;
+
+class DummyFactory extends Factory
+{
+    /**
+     * The name of the factory's corresponding model.
+     *
+     * @var string
+     */
+    protected $model = Dummy::class;
+
+    /**
+     * Define the model's default state.
+     *
+     * @return array
+     */
+    public function definition()
+    {
+        return [
+            // ...
+        ];
+    }
+}

publishes/resources/ExamplePack/Model.php

@@ -0,0 +1,69 @@
+<?php
+
+namespace App\Models;
+
+use Illuminate\Database\Eloquent\Model;
+use Illuminate\Database\Eloquent\Factories\HasFactory;
+
+class Dummy extends Model
+{
+    use HasFactory;
+
+    /**
+     * The attributes that are mass assignable.
+     *
+     * @var array
+     */
+    protected $fillable = [
+        'priority',
+        'is_published',
+        // ...
+    ];
+
+    /**
+     * The attributes that should be cast.
+     *
+     * @var array
+     */
+    protected $casts = [
+        'is_published' => 'boolean',
+        // ...
+    ];
+
+    /* =========================================================================
+     * = Scopes
+     * =========================================================================
+     */
+
+    /**
+     * 按照優先度排序
+     *
+     * ```
+     * $query->orderByPriority();
+     * ```
+     *
+     * @param  \Illuminate\Database\Eloquent\Builder  $query
+     * @param  boolean  $reversed
+     * @return void
+     */
+    public function scopeOrderByPriority($query, $reversed = false)
+    {
+        $query->orderBy('priority', $reversed ? 'asc' : 'desc');
+    }
+
+    /**
+     * 查詢僅上架
+     *
+     * ```php
+     * $query->published();
+     * ```
+     *
+     * @param  \Illuminate\Database\Eloquent\Builder  $query
+     * @param  boolean  $value
+     * @return void
+     */
+    public function scopePublished($query, $value = true)
+    {
+        $query->where('is_published', $value);
+    }
+}

publishes/resources/ExamplePack/Resource.php

@@ -0,0 +1,22 @@
+<?php
+
+namespace App\Http\Resources;
+
+use App\Models\Dummy;
+use Illuminate\Http\Resources\Json\JsonResource;
+
+class DummyResource extends JsonResource
+{
+    /**
+     * Transform the resource into an array.
+     *
+     * @param  \Illuminate\Http\Request  $request
+     * @return array|\Illuminate\Contracts\Support\Arrayable|\JsonSerializable
+     */
+    public function toArray($request)
+    {
+        return [
+            // ...
+        ];
+    }
+}

publishes/resources/ExamplePack/Seeder.php

@@ -0,0 +1,19 @@
+<?php
+
+namespace Database\Seeders;
+
+use App\Models\Dummy;
+use Illuminate\Database\Seeder;
+
+class DummiesTableSeeder extends Seeder
+{
+    /**
+     * Run the database seeds.
+     *
+     * @return void
+     */
+    public function run()
+    {
+        Dummy::factory(10)->create();
+    }
+}

publishes/resources/README.md

@@ -0,0 +1,9 @@
+# Stubs
+
+此目錄用來放置 `stub` 檔案。
+
+`artisan make:a...` 將會讀取當前目錄來產生類別，並將檔案依照命名空間自動放置到相對位置。
+
+This directory contains your stub files.
+
+More information about the usage of this directory in [here](https://github.com/A2Workspace/laravel-stubs#usage--%E5%A6%82%E4%BD%95%E4%BD%BF%E7%94%A8).

src/ServiceProvider.php

@@ -13,7 +13,10 @@ class ServiceProvider extends IlluminateServiceProvider
      */
     public function boot()
     {
-        // ...
+        $this->publishes([
+            __DIR__ . '/../publishes/config.php' => config_path('stubs.php'),
+            __DIR__ . '/../publishes/resources' => resource_path('stubs'),
+        ], '@a2workspace/laravel-stubs');
     }
 
     /**