README

安装

composer require deegitalbe/laravel-trustup-io-projects

添加环境变量

TRUSTUP_IO_PROJECTS_URL=

准备你的模型（可选）

如果你与项目有关联，你的模型应该看起来像这样

<?php

namespace App\Models;

use Deegitalbe\LaravelTrustupIoProjects\Contracts\Models\ProjectRelatedModelContract;
use Deegitalbe\LaravelTrustupIoProjects\Traits\Models\IsProjectRelatedModel;
use Illuminate\Database\Eloquent\Factories\HasFactory;
use Illuminate\Database\Eloquent\Model;

class Test extends Model implements ProjectRelatedModelContract
{
    use IsProjectRelatedModel;

    public function getExternalRelationNames(): array
    {
        return [
            'projects'
        ];
    }

    public function projects(){
        return $this->hasManyProjects('project_ids');
    }

    public function getProjects(){
        return $this->getExternalModels('projects');
    }
}

通过创建资源公开你的模型（可选）

如果你想公开你的模型，这里有一个基于前一节模型的示例资源

<?php
namespace App\Http\Resources;

use Deegitalbe\LaravelTrustupIoExternalModelRelations\Traits\Resources\IsExternalModelRelatedResource;
use Deegitalbe\LaravelTrustupIoProjects\Resource\ProjectResource;
use Illuminate\Http\Resources\Json\JsonResource;

class TestResource extends JsonResource {

  use IsExternalModelRelatedResource;

  public function toArray($request)
  {
    return [

      'projects' => ProjectResource::collection($this->whenExternalRelationLoaded('projects'))

    ];
  }
}

预加载集合

即使你加载多个关系，也只会执行一个请求 ⚡⚡⚡⚡

<?php
namespace App\Http\Controllers;

use App\Http\Resources\TestResource;
use App\Models\Test;
use Deegitalbe\LaravelTrustupIoProjects\Resource\ProjectResource;
use Deegitalbe\LaravelTrustupIoExternalModelRelations\Collections\ExternalModelRelatedCollection;

class TestController extends Controller{

  public function index()
    {
      /** @var ExternalModelRelatedCollection */
        $tests = Test::all();
        $tests->loadExternalRelations('projects');

        return TestResource::collection(($tests));
    }
}

用法

端点

    $enpoint = app()->make(ProjectEndpointContract::class);
    $request = app()->make(IndexRequestContract::class);

    $group = ProjectGroup::INTERNAL;
    $appKey = ProjectAppKey::TRUSTUP;

    $request->addGroup($group)->addAppKey($appKey);

    $projects = $endpoint->index($request)->getProjects();

布局

你可以扩展包视图以在侧边栏中显示可用的项目

    @extends('trustup-io-projects::master')

    @section('content')
        //YOUR CONTENT
    @endsection