Skip to content

Commit 1c7988b

Browse files
committed
Improve globals provider component docs
1 parent 43c7f5a commit 1c7988b

1 file changed

Lines changed: 38 additions & 10 deletions

File tree

Writerside/topics/components/globals-provider.md

Lines changed: 38 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,12 @@
33
<show-structure for="chapter" depth="2"/>
44

55
The component provides the ability to manage global PHP variables and
6-
obtain their state depending on WebView requests.
6+
obtain their state depending on WebView requests:
7+
- `$_SERVER`
8+
- `$_POST`
9+
- `$_GET`
10+
- `$_FILES`
11+
- etc.
712

813
## Installation
914

@@ -20,14 +25,19 @@ obtain their state depending on WebView requests.
2025

2126
* `PHP ^8.4`
2227

23-
## Usage
28+
## The `$_SERVER` Superglobals
2429

2530
The component provides several implementations of
2631
`ServerGlobalsProviderInterface` for managing PHP `$_SERVER` superglobals:
32+
- `Boson\Component\GlobalsProvider\DefaultServerGlobalsProvider`
33+
- `Boson\Component\GlobalsProvider\StaticServerGlobalsProvider`
34+
- `Boson\Component\GlobalsProvider\CompoundServerGlobalsProvider`
35+
- `Boson\Component\GlobalsProvider\EmptyServerGlobalsProvider`
2736

28-
### DefaultServerGlobalsProvider
37+
### Default Provider
2938

30-
The default provider that handles basic request-aware parameters:
39+
The `Boson\Component\GlobalsProvider\DefaultServerGlobalsProvider`
40+
provides basic request-aware parameters:
3141

3242
```php
3343
use Boson\Component\GlobalsProvider\DefaultServerGlobalsProvider;
@@ -99,9 +109,10 @@ and `REQUEST_TIME_FLOAT` parameters.
99109
This allows for consistent time-based testing and custom time
100110
handling in your application.
101111

102-
### StaticServerGlobalsProvider
112+
### Static Provider
103113

104-
Provides constant server parameters that are independent of the request:
114+
The `Boson\Component\GlobalsProvider\StaticServerGlobalsProvider` provides
115+
constant server parameters that are independent of the request:
105116

106117
```php
107118
use Boson\Component\GlobalsProvider\StaticServerGlobalsProvider;
@@ -125,9 +136,10 @@ The provider ensures:
125136
- Default server software (`SERVER_SOFTWARE`)
126137
- etc...
127138

128-
### CompoundServerGlobalsProvider
139+
### Compound Provider
129140

130-
Combines multiple providers into a single one:
141+
The `Boson\Component\GlobalsProvider\CompoundServerGlobalsProvider` combines
142+
multiple providers into a single one:
131143

132144
```php
133145
use Boson\Component\GlobalsProvider\CompoundServerGlobalsProvider;
@@ -151,13 +163,29 @@ $provider = new CompoundServerGlobalsProvider($providers);
151163
The compound provider merges results from all providers in the order they
152164
are provided. Later providers can override values from earlier ones.
153165

154-
### EmptyServerGlobalsProvider
166+
### Empty Provider
155167

156-
A simple provider that returns an empty array of server globals:
168+
The `Boson\Component\GlobalsProvider\EmptyServerGlobalsProvider`
169+
returns an empty array of server globals:
157170

158171
```php
159172
use Boson\Component\GlobalsProvider\EmptyServerGlobalsProvider;
160173

161174
$provider = new EmptyServerGlobalsProvider();
162175
$globals = $provider->getServerGlobals($request); // Returns []
163176
```
177+
178+
## The `$_POST` Superglobals
179+
180+
The component does not currently provide functionality for obtaining PHP
181+
superglobal `$_POST` variables.
182+
183+
## The `$_GET` Superglobals
184+
185+
The component does not currently provide functionality for obtaining PHP
186+
superglobal `$_GET` variables.
187+
188+
## The `$_FILES` Superglobals
189+
190+
The component does not currently provide functionality for obtaining PHP
191+
superglobal `$_FILES` variables.

0 commit comments

Comments
 (0)