PHP 在 Laravel 中动态隐藏 API 字段
我最近在 Laravel Brasil 社区看到一个问题,结果比看起来更有趣。想象一下你有一个 UsersResource 用下面的实现:
1 <?php 2 namespace App\Http\Resources; 3 use Illuminate\Http\Resources\Json\Resource; 4 class UsersResource extends Resource 5 { 6 /** 7 * Transform the resource into an array. 8 * 9 * @param \Illuminate\Http\Request 10 * @return array 11 */ 12 public function toArray($request) 13 { 14 return [ 15 ‘id‘ => $this->id, 16 ‘name‘ => $this->name, 17 ‘email‘ => $this->email 18 ]; 19 } 20 }
出于某种原因,您可能希望在另一个端点上重新使用该资源类,但隐藏email 字段。这篇文章就是告诉你如何实现这一点的。 如果你不知道 API Resources 是什么,请查看我之前关于这个的文章。
First Impression on API Resources
API Resources with Nested Relationship
1- 初始化项目
有趣的东西从第3节开始.
composer create-project --prefer-dist laravel/laravel api-fields cd api-fields touch database/database.sqlite
编辑.env文件,删除数据库设置并使用 SQLite
DB_CONNECTION=sqlite
继续设置项目
1 php artisan migrate 2 php artisan make:resource UsersResource 3 php artisan make:resource --collection UsersResourceCollection 4 php artisan make:controller UsersController 5 php artisan tinker 6 factory(App\User::class)->times(20)->create(); 7 quit
2- 路由
确保在 api.php 文件中创建一个路由。
Route::apiResource(‘/users‘, ‘UsersController‘);
3- 控制器
控制器代表了期望的目标。在这个例子中,让我们假设在用户列表中,我们只想要所有用户的名字,而在用户显示中,我们只想隐藏电子邮件地址。
1 <?php 2 namespace App\Http\Controllers; 3 use App\Http\Resources\UsersResource; 4 use App\User; 5 class UsersController extends Controller 6 { 7 /** 8 * Display a listing of the resource. 9 * 10 * @param User $user 11 * @return \Illuminate\Http\Response 12 */ 13 public function index(User $user) 14 { 15 return UsersResource::collection($user->paginate())->hide([‘id‘, ‘email‘]); 16 } 17 /** 18 * Display a user. 19 * 20 * @param User $user 21 * @return \Illuminate\Http\Response 22 */ 23 public function show(User $user) 24 { 25 return UsersResource::make($user)->hide([‘id‘]); 26 } 27 }
为了达到这个目的,我们需要 UsersResourceCollection 和UsersResource 同时知道如何处理 hide 调用。
4- UsersResource 类
让我们从 show 方法开始. UsersResource::make 将会返回 UsersResource 的对象. 因此,我们应该揭开 hide 的神秘面纱,它可以存储我们期望从响应中移除的键.
1 <?php 2 namespace App\Http\Resources; 3 use Illuminate\Http\Resources\Json\Resource; 4 class UsersResource extends Resource 5 { 6 /** 7 * @var array 8 */ 9 protected $withoutFields = []; 10 11 /** 12 * Transform the resource into an array. 13 * 14 * @param \Illuminate\Http\Request 15 * @return array 16 */ 17 public function toArray($request) 18 { 19 return $this->filterFields([ 20 ‘id‘ => $this->id, 21 ‘name‘ => $this->name, 22 ‘email‘ => $this->email 23 ]); 24 } 25 /** 26 * Set the keys that are supposed to be filtered out. 27 * 28 * @param array $fields 29 * @return $this 30 */ 31 public function hide(array $fields) 32 { 33 $this->withoutFields = $fields; 34 return $this; 35 } 36 /** 37 * Remove the filtered keys. 38 * 39 * @param $array 40 * @return array 41 */ 42 protected function filterFields($array) 43 { 44 return collect($array)->forget($this->withoutFields)->toArray(); 45 } 46 }
大功告成! 现在我们可以访问 ,你会发现响应中已经没有id 字段了。
温馨提示: 本文由杰米博客推荐,转载请保留链接: https://www.jmwww.net/file/10158.html