Meilisearch PHP | Documentation

ApiException extends Exception
in package
implements Stringable, ExceptionInterface

FinalYes

Table of Contents

Interfaces

Stringable
ExceptionInterface

Constants

HINT_MESSAGE  = "Hint: It might not be working because maybe you're not up to date with the Meilisearch version that `%s` call requires."

Properties

$errorCode  : string|null
$errorLink  : string|null
$errorType  : string|null
$httpBody  : mixed
$httpStatus  : int
$response  : ResponseInterface

Methods

__construct()  : mixed
__toString()  : string
rethrowWithHint()  : Exception
getErrorCodeFromHttpBody()  : string|null
getErrorLinkFromHttpBody()  : string|null
getErrorTypeFromHttpBody()  : string|null
getMessageFromHttpBody()  : string|null

Constants

HINT_MESSAGE

public mixed HINT_MESSAGE = "Hint: It might not be working because maybe you're not up to date with the Meilisearch version that `%s` call requires."

Properties

Methods

__construct()

public __construct(ResponseInterface $response, mixed $httpBody[, Throwable|null $previous = null ]) : mixed
Parameters
$response : ResponseInterface
$httpBody : mixed
$previous : Throwable|null = null

__toString()

public __toString() : string
Return values
string

rethrowWithHint()

public static rethrowWithHint(Throwable $e, string $methodName) : Exception
Parameters
$e : Throwable
$methodName : string
Return values
Exception

getErrorCodeFromHttpBody()

private getErrorCodeFromHttpBody() : string|null
Return values
string|null

getErrorLinkFromHttpBody()

private getErrorLinkFromHttpBody() : string|null
Return values
string|null

getErrorTypeFromHttpBody()

private getErrorTypeFromHttpBody() : string|null
Return values
string|null

getMessageFromHttpBody()

private getMessageFromHttpBody() : string|null
Return values
string|null 

        

        
    




    

    

                                

                

                                
    

        On this page

        
    


                

                            

            

    

        

            
Search results