Overview

Namespaces

  • Crunchmail
    • Collections
    • Entities
    • Exception
    • PHPUnit
    • Resources

Exceptions

  • ApiException
  • Overview
  • Namespace
  • Class

Class ApiException

ApiException class

Exception
Extended by Crunchmail\Exception\ApiException
Namespace: Crunchmail\Exception
Located at Exception/ApiException.php
Methods summary
public
# __construct( string $message, integer $code = 0, Exception $previous = null )

Custom ApiException constructor

Custom ApiException constructor

Parameters

$message
$code
$previous

Overrides

Exception::__construct()
public
# __toString( )

Output exception

Output exception

Overrides

Exception::__toString()
public string
# toHtml( boolean $params = [] )

Return the last error as an html string

Return the last error as an html string

Parameters

$params
$showErrorKey Show the key of each error

Returns

string
public stdClass
# getDetail( )

Extract error details

Extract error details

Returns

stdClass
public static string
# formatResponseOutput( object $body, boolean $params = [] )

Format a body response as a unique HTML string This is mainly a debugging function, you should probably generate your own HTML output.

Format a body response as a unique HTML string This is mainly a debugging function, you should probably generate your own HTML output.

Parameters

$body
Guzzle Response
$params
$showErrorKey show error keys in output

Returns

string
Methods inherited from Exception
getCode(), getFile(), getLine(), getMessage(), getPrevious(), getTrace(), getTraceAsString()
Properties inherited from Exception
$code, $file, $line, $message
API documentation generated by ApiGen