DownloadException.php 1.5 KB
Newer Older
Carsten  Rose's avatar
Carsten Rose committed
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
<?php
/**
 * Created by PhpStorm.
 * User: crose
 * Date: 4/17/17
 * Time: 9:20 PM
 */

namespace qfq;

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

/**
 * Class DownloadException
 *
 * Thrown by Download
 *
18
19
20
21
22
23
 * Throw with ONE message
 *
 *   throw new UserFormException('Failed: chmod ....', ERROR_IO_CHMOD);
 *
 * Throw with message for User and message for Support.
 *
24
25
26
27
28
  throw new UserFormException(  json_encode(
                                   [ERROR_MESSAGE_TO_USER => 'Failed: chmod',
                                    ERROR_MESSAGE_SUPPORT => "Failed: chmod $mode '$pathFileName'",
                                    ERROR_MESSAGE_HTTP_STATUS => 'HTTP/1.0 409 Bad Request' ]),
                                ERROR_IO_CHMOD);
29
 *
Carsten  Rose's avatar
Carsten Rose committed
30
31
32
33
 * @package qfq\exceptions
 */
class DownloadException extends AbstractException {

34
    /**
35
36
37
38
39
40
41
42
     * $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
43
44
45
46
     * @return string
     * @throws CodeException
     * @throws UserFormException
     */
Carsten  Rose's avatar
Carsten Rose committed
47
48
    public function formatMessage() {

49
        $this->messageArrayDebug[EXCEPTION_TYPE] = 'Download Exception';
Carsten  Rose's avatar
Carsten Rose committed
50
51
52
53

        return parent::formatException();
    }
}