Documentation

TagApiHandler
in package
implements ApiRoutableInterface uses ApiRoutableTrait

API handler for tag endpoints.

Handles:

  • GET /api/v1/tags - Get all tags (both term and text)
  • GET /api/v1/tags/term - Get term tags only
  • GET /api/v1/tags/text - Get text tags only
Tags
since
3.0.0

Table of Contents

Interfaces

ApiRoutableInterface
Interface for API handlers that participate in route dispatch.

Methods

handle()  : JsonResponse
Handle request routing.
handleGet()  : JsonResponse
Handle GET request for tags.
routeDelete()  : JsonResponse
routeGet()  : JsonResponse
Route a GET request to the appropriate handler.
routePost()  : JsonResponse
routePut()  : JsonResponse
frag()  : string
Extract a fragment from the fragments array.

Methods

handle()

Handle request routing.

public handle(string $method, array<string|int, mixed> $fragments) : JsonResponse
Parameters
$method : string

HTTP method

$fragments : array<string|int, mixed>

URL fragments

Return values
JsonResponse

handleGet()

Handle GET request for tags.

public handleGet(array<string|int, mixed> $fragments) : JsonResponse
Parameters
$fragments : array<string|int, mixed>

URL path fragments after /tags

Return values
JsonResponse

routeDelete()

public routeDelete(array<string|int, mixed> $fragments, array<string|int, mixed> $params) : JsonResponse
Parameters
$fragments : array<string|int, mixed>
$params : array<string|int, mixed>
Return values
JsonResponse

routeGet()

Route a GET request to the appropriate handler.

public routeGet(array<string|int, mixed> $fragments, array<string|int, mixed> $params) : JsonResponse
Parameters
$fragments : array<string|int, mixed>

URL path fragments

$params : array<string|int, mixed>

Query parameters

Return values
JsonResponse

routePost()

public routePost(array<string|int, mixed> $fragments, array<string|int, mixed> $params) : JsonResponse
Parameters
$fragments : array<string|int, mixed>
$params : array<string|int, mixed>
Return values
JsonResponse

routePut()

public routePut(array<string|int, mixed> $fragments, array<string|int, mixed> $params) : JsonResponse
Parameters
$fragments : array<string|int, mixed>
$params : array<string|int, mixed>
Return values
JsonResponse

frag()

Extract a fragment from the fragments array.

protected frag(array<int, string> $fragments, int $index) : string
Parameters
$fragments : array<int, string>

The URL path fragments

$index : int

The index to extract

Return values
string —

The fragment at the index, or empty string if not present


        

        
    




    

    

                                

                

                                
    

        On this page

        
    


                

                            

            

    

        

            
Search results