mirror of
				https://github.com/pelican-dev/panel.git
				synced 2025-11-04 11:16:51 +01:00 
			
		
		
		
	Changes the API internals to use normal Laravel binding which automatically supports nested-models and can determine their relationships. This removes a lot of confusingly complex internal logic and replaces it with standard Laravel code. This also removes a deprecated "getModel" method and fully replaces it with a "parameter" method that does stricter type-checking.
		
			
				
	
	
		
			132 lines
		
	
	
		
			4.3 KiB
		
	
	
	
		
			PHP
		
	
	
	
	
	
			
		
		
	
	
			132 lines
		
	
	
		
			4.3 KiB
		
	
	
	
		
			PHP
		
	
	
	
	
	
<?php
 | 
						|
 | 
						|
namespace Pterodactyl\Http\Controllers\Api\Application\Locations;
 | 
						|
 | 
						|
use Illuminate\Http\Response;
 | 
						|
use Pterodactyl\Models\Location;
 | 
						|
use Illuminate\Http\JsonResponse;
 | 
						|
use Spatie\QueryBuilder\QueryBuilder;
 | 
						|
use Pterodactyl\Services\Locations\LocationUpdateService;
 | 
						|
use Pterodactyl\Services\Locations\LocationCreationService;
 | 
						|
use Pterodactyl\Services\Locations\LocationDeletionService;
 | 
						|
use Pterodactyl\Contracts\Repository\LocationRepositoryInterface;
 | 
						|
use Pterodactyl\Transformers\Api\Application\LocationTransformer;
 | 
						|
use Pterodactyl\Http\Controllers\Api\Application\ApplicationApiController;
 | 
						|
use Pterodactyl\Http\Requests\Api\Application\Locations\GetLocationRequest;
 | 
						|
use Pterodactyl\Http\Requests\Api\Application\Locations\GetLocationsRequest;
 | 
						|
use Pterodactyl\Http\Requests\Api\Application\Locations\StoreLocationRequest;
 | 
						|
use Pterodactyl\Http\Requests\Api\Application\Locations\DeleteLocationRequest;
 | 
						|
use Pterodactyl\Http\Requests\Api\Application\Locations\UpdateLocationRequest;
 | 
						|
 | 
						|
class LocationController extends ApplicationApiController
 | 
						|
{
 | 
						|
    /**
 | 
						|
     * @var \Pterodactyl\Services\Locations\LocationCreationService
 | 
						|
     */
 | 
						|
    private $creationService;
 | 
						|
 | 
						|
    /**
 | 
						|
     * @var \Pterodactyl\Services\Locations\LocationDeletionService
 | 
						|
     */
 | 
						|
    private $deletionService;
 | 
						|
 | 
						|
    /**
 | 
						|
     * @var \Pterodactyl\Contracts\Repository\LocationRepositoryInterface
 | 
						|
     */
 | 
						|
    private $repository;
 | 
						|
 | 
						|
    /**
 | 
						|
     * @var \Pterodactyl\Services\Locations\LocationUpdateService
 | 
						|
     */
 | 
						|
    private $updateService;
 | 
						|
 | 
						|
    /**
 | 
						|
     * LocationController constructor.
 | 
						|
     */
 | 
						|
    public function __construct(
 | 
						|
        LocationCreationService $creationService,
 | 
						|
        LocationDeletionService $deletionService,
 | 
						|
        LocationRepositoryInterface $repository,
 | 
						|
        LocationUpdateService $updateService
 | 
						|
    ) {
 | 
						|
        parent::__construct();
 | 
						|
 | 
						|
        $this->creationService = $creationService;
 | 
						|
        $this->deletionService = $deletionService;
 | 
						|
        $this->repository = $repository;
 | 
						|
        $this->updateService = $updateService;
 | 
						|
    }
 | 
						|
 | 
						|
    /**
 | 
						|
     * Return all of the locations currently registered on the Panel.
 | 
						|
     */
 | 
						|
    public function index(GetLocationsRequest $request): array
 | 
						|
    {
 | 
						|
        $locations = QueryBuilder::for(Location::query())
 | 
						|
            ->allowedFilters(['short', 'long'])
 | 
						|
            ->allowedSorts(['id'])
 | 
						|
            ->paginate($request->query('per_page') ?? 50);
 | 
						|
 | 
						|
        return $this->fractal->collection($locations)
 | 
						|
            ->transformWith($this->getTransformer(LocationTransformer::class))
 | 
						|
            ->toArray();
 | 
						|
    }
 | 
						|
 | 
						|
    /**
 | 
						|
     * Return a single location.
 | 
						|
     */
 | 
						|
    public function view(GetLocationRequest $request, Location $location): array
 | 
						|
    {
 | 
						|
        return $this->fractal->item($location)
 | 
						|
            ->transformWith($this->getTransformer(LocationTransformer::class))
 | 
						|
            ->toArray();
 | 
						|
    }
 | 
						|
 | 
						|
    /**
 | 
						|
     * Store a new location on the Panel and return a HTTP/201 response code with the
 | 
						|
     * new location attached.
 | 
						|
     *
 | 
						|
     * @throws \Pterodactyl\Exceptions\Model\DataValidationException
 | 
						|
     */
 | 
						|
    public function store(StoreLocationRequest $request): JsonResponse
 | 
						|
    {
 | 
						|
        $location = $this->creationService->handle($request->validated());
 | 
						|
 | 
						|
        return $this->fractal->item($location)
 | 
						|
            ->transformWith($this->getTransformer(LocationTransformer::class))
 | 
						|
            ->addMeta([
 | 
						|
                'resource' => route('api.application.locations.view', [
 | 
						|
                    'location' => $location->id,
 | 
						|
                ]),
 | 
						|
            ])
 | 
						|
            ->respond(201);
 | 
						|
    }
 | 
						|
 | 
						|
    /**
 | 
						|
     * Update a location on the Panel and return the updated record to the user.
 | 
						|
     *
 | 
						|
     * @throws \Pterodactyl\Exceptions\Model\DataValidationException
 | 
						|
     * @throws \Pterodactyl\Exceptions\Repository\RecordNotFoundException
 | 
						|
     */
 | 
						|
    public function update(UpdateLocationRequest $request, Location $location): array
 | 
						|
    {
 | 
						|
        $location = $this->updateService->handle($location, $request->validated());
 | 
						|
 | 
						|
        return $this->fractal->item($location)
 | 
						|
            ->transformWith($this->getTransformer(LocationTransformer::class))
 | 
						|
            ->toArray();
 | 
						|
    }
 | 
						|
 | 
						|
    /**
 | 
						|
     * Delete a location from the Panel.
 | 
						|
     *
 | 
						|
     * @throws \Pterodactyl\Exceptions\Service\Location\HasActiveNodesException
 | 
						|
     */
 | 
						|
    public function delete(DeleteLocationRequest $request, Location $location): Response
 | 
						|
    {
 | 
						|
        $this->deletionService->handle($location);
 | 
						|
 | 
						|
        return response('', 204);
 | 
						|
    }
 | 
						|
}
 |