Meilisearch PHP | Documentation

Keys extends Endpoint
in package

Table of Contents

Constants

PATH  = '/keys'

Properties

$apiKey  : string|null
$http  : Http
$keys  : Keys
$actions  : array<string|int, mixed>|null
$createdAt  : DateTimeInterface|null
$description  : string|null
$expiresAt  : DateTimeInterface|null
$indexes  : array<string|int, mixed>|null
$key  : string|null
$name  : string|null
$uid  : string|null
$updatedAt  : DateTimeInterface|null

Methods

__construct()  : mixed
all()  : KeysResults
allRaw()  : array<string|int, mixed>
create()  : self
delete()  : array<string|int, mixed>
get()  : self
getActions()  : array<string|int, mixed>|null
getCreatedAt()  : DateTimeInterface|null
getDescription()  : string|null
getExpiresAt()  : DateTimeInterface|null
getIndexes()  : array<string|int, mixed>|null
getKey()  : string|null
getName()  : string|null
getUid()  : string|null
getUpdatedAt()  : DateTimeInterface|null
show()  : array<string|int, mixed>|null
update()  : self
createDate()  : DateTimeInterface|null
fill()  : $this
newInstance()  : self

Constants

PATH

protected mixed PATH = '/keys'

Properties

$actions

private array<string|int, mixed>|null $actions

$createdAt

private DateTimeInterface|null $createdAt

$description

private string|null $description

$expiresAt

private DateTimeInterface|null $expiresAt

$indexes

private array<string|int, mixed>|null $indexes

$key

private string|null $key

$name

private string|null $name

$uid

private string|null $uid

$updatedAt

private DateTimeInterface|null $updatedAt

Methods

__construct()

public __construct(Http $http[, string|null $uid = null ][, string|null $name = null ][, string|null $key = null ][, string|null $description = null ][, array<string|int, mixed>|null $actions = null ][, array<string|int, mixed>|null $indexes = null ][, DateTimeInterface|null $expiresAt = null ][, DateTimeInterface|null $createdAt = null ][, DateTimeInterface|null $updatedAt = null ]) : mixed
Parameters
$http : Http
$uid : string|null = null
$name : string|null = null
$key : string|null = null
$description : string|null = null
$actions : array<string|int, mixed>|null = null
$indexes : array<string|int, mixed>|null = null
$expiresAt : DateTimeInterface|null = null
$createdAt : DateTimeInterface|null = null
$updatedAt : DateTimeInterface|null = null

allRaw()

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

create()

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

delete()

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

get()

public get(mixed $keyOrUid) : self
Parameters
$keyOrUid : mixed
Return values
self

getActions()

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

getCreatedAt()

public getCreatedAt() : DateTimeInterface|null
Return values
DateTimeInterface|null

getDescription()

public getDescription() : string|null
Return values
string|null

getExpiresAt()

public getExpiresAt() : DateTimeInterface|null
Return values
DateTimeInterface|null

getIndexes()

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

getKey()

public getKey() : string|null
Return values
string|null

getName()

public getName() : string|null
Return values
string|null

getUid()

public getUid() : string|null
Return values
string|null

getUpdatedAt()

public getUpdatedAt() : DateTimeInterface|null
Return values
DateTimeInterface|null

show()

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

update()

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

createDate()

protected createDate(mixed $attribute) : DateTimeInterface|null
Parameters
$attribute : mixed
Return values
DateTimeInterface|null

fill()

protected fill(array<string|int, mixed> $attributes) : $this
Parameters
$attributes : array<string|int, mixed>
Return values
$this

newInstance()

protected newInstance(array<string|int, mixed> $attributes) : self
Parameters
$attributes : array<string|int, mixed>
Return values
self 

        

        
    




    

    

                                

                

                                
    

        On this page

        
    


                

                            

            

    

        

            
Search results