1: <?php
 2: 
 3: /*
 4:  * The MIT License
 5:  *
 6:  * Copyright 2017 David Schoenbauer <dschoenbauer@gmail.com>.
 7:  *
 8:  * Permission is hereby granted, free of charge, to any person obtaining a copy
 9:  * of this software and associated documentation files (the "Software"), to deal
10:  * in the Software without restriction, including without limitation the rights
11:  * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
12:  * copies of the Software, and to permit persons to whom the Software is
13:  * furnished to do so, subject to the following conditions:
14:  *
15:  * The above copyright notice and this permission notice shall be included in
16:  * all copies or substantial portions of the Software.
17:  *
18:  * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
19:  * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
20:  * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
21:  * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
22:  * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
23:  * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
24:  * THE SOFTWARE.
25:  */
26: 
27: namespace DSchoenbauer\Exception\Http\ClientError;
28: 
29: /**
30:  * The server is refusing to process a request because the request payload is 
31:  * larger than the server is willing or able to process.
32:  * 
33:  * The server MAY close the connection to prevent the client from continuing 
34:  * the request.
35:  * 
36:  * If the condition is temporary, the server SHOULD generate a Retry-After 
37:  * header field to indicate that it is temporary and after what time the client 
38:  * MAY try again.
39:  *
40:  * @link https://httpstatuses.com/413 Source
41:  * @author David Schoenbauer <dschoenbauer@gmail.com>
42:  * @since 1.0.0
43:  * @todo provide a method to define a ret-after time
44:  * @todo provide method to define max size
45:  */
46: class PayloadTooLargeException extends ClientErrorException {
47: 
48:     private $maxPayloadSize = 0;
49: 
50: 
51:     public function __construct($maxPayloadSize = 0, $message = "") {
52:         parent::__construct($message, 413);
53:         $this->setMaxPayloadSize($maxPayloadSize);
54:     }
55: 
56:     /**
57:      * @return mixed representation of max payload size
58:      */
59:     public function getMaxPayloadSize() {
60:         return $this->maxPayloadSize;
61:     }
62: 
63:     /**
64:      * @param type $maxPayloadSize representation of max payload size
65:      * @return $this
66:      */
67:     public function setMaxPayloadSize($maxPayloadSize) {
68:         $this->maxPayloadSize = $maxPayloadSize;
69:         return $this;
70:     }
71: }
72: