Test Failed
Push — develop ( 64b6b0...ddb817 )
by nguereza
02:24
created

RequestData::__construct()   A

Complexity

Conditions 1
Paths 1

Size

Total Lines 6
Code Lines 4

Duplication

Lines 0
Ratio 0 %

Importance

Changes 0
Metric Value
eloc 4
dl 0
loc 6
rs 10
c 0
b 0
f 0
cc 1
nc 1
nop 1
1
<?php
2
3
/**
4
 * Platine Framework
5
 *
6
 * Platine Framework is a lightweight, high-performance, simple and elegant
7
 * PHP Web framework
8
 *
9
 * This content is released under the MIT License (MIT)
10
 *
11
 * Copyright (c) 2020 Platine Framework
12
 *
13
 * Permission is hereby granted, free of charge, to any person obtaining a copy
14
 * of this software and associated documentation files (the "Software"), to deal
15
 * in the Software without restriction, including without limitation the rights
16
 * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
17
 * copies of the Software, and to permit persons to whom the Software is
18
 * furnished to do so, subject to the following conditions:
19
 *
20
 * The above copyright notice and this permission notice shall be included in all
21
 * copies or substantial portions of the Software.
22
 *
23
 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
24
 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
25
 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
26
 * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
27
 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
28
 * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
29
 * SOFTWARE.
30
 */
31
32
/**
33
 *  @file RequestData.php
34
 *
35
 *  This class contains the methods to query request data
36
 *
37
 *  @package    Platine\Framework\Http
38
 *  @author Platine Developers team
39
 *  @copyright  Copyright (c) 2020
40
 *  @license    http://opensource.org/licenses/MIT  MIT License
41
 *  @link   http://www.iacademy.cf
42
 *  @version 1.0.0
43
 *  @filesource
44
 */
45
46
declare(strict_types=1);
47
48
namespace Platine\Framework\Http;
49
50
use Platine\Http\ServerRequestInterface;
51
use Platine\Stdlib\Helper\Arr;
52
53
54
/**
55
 * class RequestData
56
 * @package Platine\Framework\Http
57
 */
58
class RequestData
59
{
60
61
    /**
62
     * The request body or post data
63
     * @var array<string, mixed>
64
     */
65
    protected array $posts = [];
66
67
    /**
68
     * The request get data
69
     * @var array<string, mixed>
70
     */
71
    protected array $gets = [];
72
73
    /**
74
     * The request servers environment data
75
     * @var array<string, mixed>
76
     */
77
    protected array $servers = [];
78
79
    /**
80
     * The request cookies data
81
     * @var array<string, mixed>
82
     */
83
    protected array $cookies = [];
84
85
    /**
86
     * Create new instance
87
     * @param ServerRequestInterface $request
88
     */
89
    public function __construct(ServerRequestInterface $request)
90
    {
91
        $this->posts = (array) $request->getParsedBody();
92
        $this->gets = $request->getQueryParams();
93
        $this->servers = $request->getServerParams();
94
        $this->cookies = $request->getCookieParams();
95
    }
96
97
    /**
98
     * Return the post data
99
     * @return array<string, mixed>
100
     */
101
    public function posts(): array
102
    {
103
        return $this->posts;
104
    }
105
106
    /**
107
     * Return the get data
108
     * @return array<string, mixed>
109
     */
110
    public function gets(): array
111
    {
112
        return $this->gets;
113
    }
114
115
    /**
116
     * Return the server data
117
     * @return array<string, mixed>
118
     */
119
    public function servers(): array
120
    {
121
        return $this->servers;
122
    }
123
124
    /**
125
     * Return the cookie data
126
     * @return array<string, mixed>
127
     */
128
    public function cookies(): array
129
    {
130
        return $this->cookies;
131
    }
132
133
134
    /**
135
     * Return the request query value for the given key
136
     * @param string $key the key to fetch also support for dot notation
137
     * @param mixed $default
138
     *
139
     * @return mixed
140
     */
141
    public function get(string $key, $default = null)
142
    {
143
        return Arr::get($this->gets, $key, $default);
144
    }
145
146
    /**
147
     * Return the request body or post value for the given key
148
     * @param string $key the key to fetch also support for dot notation
149
     * @param mixed $default
150
     *
151
     * @return mixed
152
     */
153
    public function post(string $key, $default = null)
154
    {
155
        return Arr::get($this->posts, $key, $default);
156
    }
157
158
    /**
159
     * Return the request server value for the given key
160
     * @param string $key the key to fetch also support for dot notation
161
     * @param mixed $default
162
     *
163
     * @return mixed
164
     */
165
    public function server(string $key, $default = null)
166
    {
167
        return Arr::get($this->servers, $key, $default);
168
    }
169
170
    /**
171
     * Return the request cookie value for the given key
172
     * @param string $key the key to fetch also support for dot notation
173
     * @param mixed $default
174
     *
175
     * @return mixed
176
     */
177
    public function cookie(string $key, $default = null)
178
    {
179
        return Arr::get($this->cookies, $key, $default);
180
    }
181
}
182