Meilisearch PHP | Documentation

Keys extends Endpoint
in package

Tags
phpstan-type

RawKey array{ uid: non-empty-string, key: non-empty-string, actions: list, indexes: list, name?: non-empty-string, description?: non-empty-string, expiresAt: non-empty-string|null, createdAt: non-empty-string, updatedAt: non-empty-string }

phpstan-type

RawKeys array{ results: array<int, RawKey>, offset: non-negative-int, limit: non-negative-int, total: non-negative-int }

Table of Contents

Constants

PATH  = '/keys'

Properties

$apiKey  : string|null
$http  : Http

Methods

__construct()  : mixed
all()  : KeysResults
allRaw()  : RawKeys
create()  : Key
delete()  : array<string|int, mixed>
get()  : Key
show()  : array<string|int, mixed>|null
update()  : Key

Constants

PATH

protected mixed PATH = '/keys'

Properties

Methods

__construct()

public __construct(Http $http[, string|null $apiKey = null ]) : mixed
Parameters
$http : Http
$apiKey : string|null = null

allRaw()

public allRaw([array<string|int, mixed> $options = [] ]) : RawKeys
Parameters
$options : array<string|int, mixed> = []
Return values
RawKeys

delete()

public delete(non-empty-string $keyOrUid) : array<string|int, mixed>
Parameters
$keyOrUid : non-empty-string
Return values
array<string|int, mixed>

get()

public get(non-empty-string $keyOrUid) : Key
Parameters
$keyOrUid : non-empty-string
Return values
Key

show()

public show() : array<string|int, mixed>|null
Return values
array<string|int, mixed>|null 

        

        
    




    

    

                                

                

                                
    

        On this page

        
    


                

                            

            

    

        

            
Search results