forked from cakephp/cakephp
-
Notifications
You must be signed in to change notification settings - Fork 0
Expand file tree
/
Copy pathRedirectException.php
More file actions
84 lines (75 loc) · 2.58 KB
/
Copy pathRedirectException.php
File metadata and controls
84 lines (75 loc) · 2.58 KB
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
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
<?php
declare(strict_types=1);
/**
* CakePHP(tm) : Rapid Development Framework (https://cakephp.org)
* Copyright (c) Cake Software Foundation, Inc. (https://cakefoundation.org)
*
* Licensed under The MIT License
* For full copyright and license information, please see the LICENSE.txt
* Redistributions of files must retain the above copyright notice.
*
* @copyright Copyright (c) Cake Software Foundation, Inc. (https://cakefoundation.org)
* @link https://cakephp.org CakePHP(tm) Project
* @since 4.1.0
* @license https://opensource.org/licenses/mit-license.php MIT License
*/
namespace Cake\Http\Exception;
/**
* An exception subclass used by routing and application code to
* trigger a redirect.
*
* The URL and status code are provided as constructor arguments.
*
* ```
* throw new RedirectException('http://example.com/some/path', 301);
* ```
*
* Additional headers can also be provided in the constructor, or
* using the addHeaders() method.
*/
class RedirectException extends HttpException
{
/**
* Constructor
*
* @param string $target The URL to redirect to.
* @param int $code The exception code that will be used as a HTTP status code
* @param array $headers The headers that should be sent in the unauthorized challenge response.
*/
public function __construct(string $target, int $code = 302, array $headers = [])
{
parent::__construct($target, $code);
foreach ($headers as $key => $value) {
$this->setHeader($key, (array)$value);
}
}
/**
* Add headers to be included in the response generated from this exception
*
* @param array $headers An array of `header => value` to append to the exception.
* If a header already exists, the new values will be appended to the existing ones.
* @return $this
* @deprecated 4.2.0 Use `setHeaders()` instead.
*/
public function addHeaders(array $headers)
{
deprecationWarning('RedirectException::addHeaders() is deprecated, use setHeaders() instead.');
foreach ($headers as $key => $value) {
$this->headers[$key][] = $value;
}
return $this;
}
/**
* Remove a header from the exception.
*
* @param string $key The header to remove.
* @return $this
* @deprecated 4.2.0 Use `setHeaders()` instead.
*/
public function removeHeader(string $key)
{
deprecationWarning('RedirectException::removeHeader() is deprecated, use setHeaders() instead.');
unset($this->headers[$key]);
return $this;
}
}