NotAcceptableResponseException.php 1.44 KB
Newer Older
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
<?php
/**
 * Created by PhpStorm.
 * User: crose
 * Date: 21.02.19
 * Time: 23:47
 */

namespace qfq;

require_once(__DIR__ . '/AbstractException.php');

/**
 * Class NotAcceptableResponseException
 *
 * Thrown by API call with bad content type
 *
 * Throw with ONE message
 *
 *   throw new UserFormException('Failed: chmod ....', ERROR_IO_CHMOD);
 *
 * Throw with message for User and message for Support.
 *
 * throw new UserFormException(  json_encode(
 *                                  [ERROR_MESSAGE_TO_USER => 'Failed: chmod',
 *                                   ERROR_MESSAGE_SUPPORT => "Failed: chmod $mode '$pathFileName'"]),
 *                               ERROR_IO_CHMOD);
 *
 * @package qfq\exceptions
 */

class NotAcceptableResponseException extends AbstractException {

    /**
     * $this->getMessage() might give a) a simple string or b) an JSON String.
     *
     * JSON String: There are 3+1 different messages:
     *   [ERROR_MESSAGE_TO_USER] 'toUser' - shown in the client to the user - no details here!!!
     *   [ERROR_MESSAGE_SUPPORT] 'support' - help for the developer
     *   [ERROR_MESSAGE_OS] 'os' - message from the OS, like 'file not found'
     *
     * @return string HTML formatted error string
     * @throws CodeException
     * @throws UserFormException
     */
    public function formatMessage() {

        $this->messageArrayDebug[EXCEPTION_TYPE] = 'Not Acceptable Response';

        return parent::formatException();
    }
}