Meilisearch PHP | Documentation

Key
in package

FinalYes

Table of Contents

Properties

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

Methods

__construct()  : mixed
fromArray()  : self
getActions()  : array<int, KeyAction>
getCreatedAt()  : DateTimeInterface|null
getDescription()  : string|null
getExpiresAt()  : DateTimeInterface|null
getIndexes()  : array<int, non-empty-string>
getKey()  : string
getName()  : string|null
getUid()  : string
getUpdatedAt()  : DateTimeInterface|null

Properties

$actions read-only

private array<string|int, mixed> $actions

$createdAt read-only

private DateTimeInterface|null $createdAt

$description read-only

private string|null $description

$expiresAt read-only

private DateTimeInterface|null $expiresAt

$indexes read-only

private array<string|int, mixed> $indexes

$key read-only

private string $key

$name read-only

private string|null $name

$uid read-only

private string $uid

$updatedAt read-only

private DateTimeInterface|null $updatedAt

Methods

__construct()

public __construct(non-empty-string $uid, non-empty-string $key, array<int, KeyAction> $actions, array<int, non-empty-string> $indexes, non-empty-string|null $name, non-empty-string|null $description, DateTimeInterface|null $expiresAt, DateTimeInterface|null $createdAt, DateTimeInterface|null $updatedAt) : mixed
Parameters
$uid : non-empty-string
$key : non-empty-string
$actions : array<int, KeyAction>
$indexes : array<int, non-empty-string>
$name : non-empty-string|null
$description : non-empty-string|null
$expiresAt : DateTimeInterface|null
$createdAt : DateTimeInterface|null
$updatedAt : DateTimeInterface|null

fromArray()

public static fromArray(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, createdAt: non-empty-string, updatedAt: non-empty-string} $data) : self
Parameters
$data : 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, createdAt: non-empty-string, updatedAt: non-empty-string}
Return values
self

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<int, non-empty-string>
Return values
array<int, non-empty-string>

getKey()

public getKey() : string
Return values
string

getName()

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

getUid()

public getUid() : string
Return values
string

getUpdatedAt()

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

        

        
    




    

    

                                

                

                                
    

        On this page

        
    


                

                            

            

    

        

            
Search results