owl-admin/app/Http/Controllers/Client/UserAddressController.php

<?php

namespace App\Http\Controllers\Client;

use App\Http\Controllers\Controller;
use App\Services\Client\UserAddressService;
use Illuminate\Http\Request;
use Illuminate\Support\Facades\Auth;

/**
 * @group 用户端
 *
 * 用户地址相关的API接口
 */
class UserAddressController extends Controller
{
    protected $userAddressService;

    public function __construct(UserAddressService $userAddressService)
    {
        $this->userAddressService = $userAddressService;
    }

    /**
     * [地址管理]获取默认地址
     *
     *
     * @description 根据用户编号查询用户数据,用户状态为正常,查询用户地址列表,返回用户默认地址
     *
     * @response {
     *  "code": 200,
     *  "message": "success",
     *  "data": {
     *    "id": 1,
     *    "user_id": 1,
     *    "name": "张三",
     *    "phone": "13800138000",
     *    "province": "广东省",
     *    "city": "深圳市",
     *    "district": "南山区",
     *    "address": "科技园",
     *    "is_default": 1,
     *    "created_at": "2024-01-01 00:00:00",
     *    "updated_at": "2024-01-01 00:00:00"
     *  }
     * }
     */
    public function getDefault()
    {
        return $this->userAddressService->getDefault(Auth::user()->id);
    }

    /**
     * [地址管理]添加地址
     *
     * @description 根据用户编号查询用户数据,用户状态为正常,保存用户地址,如果用户只有一个地址则设置为默认地址
     *
     * @bodyParam phone string required 手机号 Example: 13800138000
     * @bodyParam province string required 省份 Example: 广东省
     * @bodyParam city string required 城市 Example: 深圳市
     * @bodyParam district string required 区县 Example: 南山区
     * @bodyParam longitude string required 经度 Example: 113.93041
     * @bodyParam latitude string required 纬度 Example: 22.53332
     * @bodyParam area_code string required 区划代码 Example: 440305
     * @bodyParam is_default number required 是否默认地址 Example: 1
     * @bodyParam location string required 定位地址 Example: 科技园
     * @bodyParam detail string required 详细地址 Example: 科技园南区
     *
     * @response {"code": 200,"message": "添加成功"}
     */
    public function store(Request $request)
    {
        $data = $request->only(['phone', 'province', 'city', 'district', 'longitude', 'latitude', 'area_code', 'is_default', 'location', 'detail']);

        return $this->userAddressService->store(Auth::user()->id, $data);
    }

    /**
     * [地址管理]修改地址
     *
     * @description 根据用户编号查询用户数据,用户状态为正常,根据地址编号查询地址数据,修改地址信息
     *
     * @urlParam id integer required 地址ID Example: 1
     *
     * @bodyParam phone string required 手机号 Example: 13800138000
     * @bodyParam province string required 省份 Example: 广东省
     * @bodyParam city string required 城市 Example: 深圳市
     * @bodyParam district string required 区县 Example: 南山区
     * @bodyParam longitude string required 经度 Example: 113.93041
     * @bodyParam latitude string required 纬度 Example: 22.53332
     * @bodyParam area_code string required 区划代码 Example: 440305
     * @bodyParam is_default number required 是否默认地址 Example: 1
     * @bodyParam location string required 定位地址 Example: 科技园
     * @bodyParam detail string required 详细地址 Example: 科技园南区
     *
     * @response {"code": 200,"message": "修改成功"}
     */
    public function update(Request $request, $id)
    {
        $data = $request->only(['phone', 'province', 'city', 'district', 'longitude', 'latitude', 'area_code', 'is_default', 'location', 'detail']);

        return $this->userAddressService->update(Auth::user()->id, $id, $data);
    }

    /**
     * [地址管理]删除地址
     *
     * @description 根据用户编号查询用户数据,用户状态为正常,根据地址编号查询地址数据,删除地址
     *
     * @urlParam id integer required 地址ID Example: 1
     *
     * @response {"code": 200,"message": "删除成功"}
     */
    public function destroy($id)
    {
        return $this->userAddressService->destroy(Auth::user()->id, $id);
    }

    /**
     * [地址管理]设置默认地址
     *
     * @description 根据用户编号查询用户数据,用户状态为正常,根据地址编号查询地址数据,设置为默认地址
     *
     * @urlParam id integer required 地址ID Example: 1
     *
     * @response {"code": 200,"message": "设置成功"}
     */
    public function setDefault($id)
    {
        return $this->userAddressService->setDefault(Auth::user()->id, $id);
    }

    /**
     * [地址管理]地址列表
     *
     * @description 获取用户的地址列表
     *
     * @queryParam page int 页码. Example: 1
     * @queryParam per_page int 每页数量. Example: 15
     *
     * @response {
     *  "code": 200,
     *  "message": "success",
     *  "data": {
     *    "items": [
     *      {
     *        "id": 1,
     *        "user_id": 1,
     *        "name": "张三",
     *        "phone": "13800138000",
     *        "province": "广东省",
     *        "city": "深圳市",
     *        "district": "南山区",
     *        "address": "科技园",
     *        "is_default": 1,
     *        "created_at": "2024-03-20 10:00:00",
     *        "updated_at": "2024-03-20 10:00:00"
     *      }
     *    ],
     *    "total": 1
     *  }
     * }
     */
    public function list()
    {
        $perPage = request('per_page', 15);

        return $this->userAddressService->list(Auth::user()->id, $perPage);
    }
}