Skip to content
This repository was archived by the owner on Jun 28, 2024. It is now read-only.

Commit 5708df1

Browse files
williamdeswilliamdes
committed
docs: update Doctum built docs
1 parent fe172a5 commit 5708df1

File tree

16 files changed

+151
-74
lines changed

16 files changed

+151
-74
lines changed

‎doc/LaravelFCM/FCMManager.md‎

Lines changed: 11 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -26,7 +26,7 @@ class **FCMManager** extends <abbr title="Illuminate\Support\Manager">Man
2626
| | | | |
2727
|---|---|---|---|
2828
||<a name="#method_getDefaultDriver"></a>getDefaultDriver()|No description||
29-
||<a name="#method_createHttpDriver"></a>createHttpDriver()|No description||
29+
|<abbr title="GuzzleHttp\Client">Client</abbr>|<a name="#method_createHttpDriver"></a>createHttpDriver()|No description||
3030
|<abbr title="Illuminate\Contracts\Container\Container">Container</abbr>|<a name="#method_getContainer"></a>getContainer()|Get the app container||
3131

3232

@@ -42,17 +42,24 @@ class **FCMManager** extends <abbr title="Illuminate\Support\Manager">Man
4242
<a name id="method_createHttpDriver"></a>
4343

4444
###
45-
protected **createHttpDriver**()
45+
protected <abbr title="GuzzleHttp\Client">Client</abbr> **createHttpDriver**()
4646

47-
[at line 15](https://github.com/code-lts/Laravel-FCM/blob/main/src/FCMManager.php#L15)
47+
[at line 18](https://github.com/code-lts/Laravel-FCM/blob/main/src/FCMManager.php#L18)
4848

4949

50+
51+
#### Return Value
52+
53+
| | |
54+
|---|---|
55+
|<abbr title="GuzzleHttp\Client">Client</abbr>|
56+
5057
<a name id="method_getContainer"></a>
5158

5259
###
5360
<abbr title="Illuminate\Contracts\Container\Container">Container</abbr> **getContainer**()
5461

55-
[at line 27](https://github.com/code-lts/Laravel-FCM/blob/main/src/FCMManager.php#L27)
62+
[at line 30](https://github.com/code-lts/Laravel-FCM/blob/main/src/FCMManager.php#L30)
5663

5764
Get the app container
5865

‎doc/LaravelFCM/FCMServiceProvider.md‎

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -25,7 +25,7 @@ class **FCMServiceProvider** extends <abbr title="Illuminate\Support\Serv
2525

2626
| | | | |
2727
|---|---|---|---|
28-
|<a name="property_defer"></a>protected |$defer|||
28+
|<a name="property_defer"></a>protected bool|$defer|||
2929
### Methods
3030

3131
| | | | |
@@ -41,23 +41,23 @@ class **FCMServiceProvider** extends <abbr title="Illuminate\Support\Serv
4141
###
4242
**boot**()
4343

44-
[at line 19](https://github.com/code-lts/Laravel-FCM/blob/main/src/FCMServiceProvider.php#L19)
44+
[at line 20](https://github.com/code-lts/Laravel-FCM/blob/main/src/FCMServiceProvider.php#L20)
4545

4646

4747
<a name id="method_register"></a>
4848

4949
###
5050
**register**()
5151

52-
[at line 30](https://github.com/code-lts/Laravel-FCM/blob/main/src/FCMServiceProvider.php#L30)
52+
[at line 33](https://github.com/code-lts/Laravel-FCM/blob/main/src/FCMServiceProvider.php#L33)
5353

5454

5555
<a name id="method_provides"></a>
5656

5757
###
5858
**provides**()
5959

60-
[at line 84](https://github.com/code-lts/Laravel-FCM/blob/main/src/FCMServiceProvider.php#L84)
60+
[at line 105](https://github.com/code-lts/Laravel-FCM/blob/main/src/FCMServiceProvider.php#L105)
6161

6262

6363
_Generated by [Doctum, a API Documentation generator and fork of Sami](https://github.com/code-lts/doctum)._

‎doc/LaravelFCM/Facades/FCMTopic.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -37,7 +37,7 @@ class **FCMTopic** extends <abbr title="Illuminate\Support\Facades\Facade
3737
###
3838
staticprotected **getFacadeAccessor**()
3939

40-
[at line 13](https://github.com/code-lts/Laravel-FCM/blob/main/src/Facades/FCMTopic.php#L13)
40+
[at line 14](https://github.com/code-lts/Laravel-FCM/blob/main/src/Facades/FCMTopic.php#L14)
4141

4242

4343
<a name id="method_createTopic"></a>

‎doc/LaravelFCM/Facades/FCMValidator.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -35,7 +35,7 @@ class **FCMValidator** extends <abbr title="Illuminate\Support\Facades\Fa
3535
###
3636
staticprotected **getFacadeAccessor**()
3737

38-
[at line 11](https://github.com/code-lts/Laravel-FCM/blob/main/src/Facades/FCMValidator.php#L11)
38+
[at line 12](https://github.com/code-lts/Laravel-FCM/blob/main/src/Facades/FCMValidator.php#L12)
3939

4040

4141
<a name id="method_validateToken"></a>

‎doc/LaravelFCM/Message/PayloadDataBuilder.md‎

Lines changed: 15 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -32,8 +32,8 @@ Official google documentation :
3232
|---|---|---|---|
3333
|[<abbr title="LaravelFCM\Message\PayloadDataBuilder">PayloadDataBuilder</abbr>](../../LaravelFCM/Message/PayloadDataBuilder.md)|<a name="#method_addData"></a>addData(array $data)|add data to existing data.||
3434
|[<abbr title="LaravelFCM\Message\PayloadDataBuilder">PayloadDataBuilder</abbr>](../../LaravelFCM/Message/PayloadDataBuilder.md)|<a name="#method_setData"></a>setData(array $data)|erase data with new data.||
35-
||<a name="#method_removeAllData"></a>removeAllData()|Remove all data.||
36-
|array|<a name="#method_getData"></a>getData()|return data.||
35+
|void|<a name="#method_removeAllData"></a>removeAllData()|Remove all data.||
36+
|array|null|<a name="#method_getData"></a>getData()|return data.||
3737
|[<abbr title="LaravelFCM\Message\PayloadData">PayloadData</abbr>](../../LaravelFCM/Message/PayloadData.md)|<a name="#method_build"></a>build()|generate a PayloadData.||
3838

3939

@@ -83,32 +83,39 @@ erase data with new data.
8383
<a name id="method_removeAllData"></a>
8484

8585
###
86-
**removeAllData**()
86+
void **removeAllData**()
8787

88-
[at line 52](https://github.com/code-lts/Laravel-FCM/blob/main/src/Message/PayloadDataBuilder.php#L52)
88+
[at line 54](https://github.com/code-lts/Laravel-FCM/blob/main/src/Message/PayloadDataBuilder.php#L54)
8989

9090
Remove all data.
91+
92+
#### Return Value
93+
94+
| | |
95+
|---|---|
96+
|void|
97+
9198
<a name id="method_getData"></a>
9299

93100
###
94-
array **getData**()
101+
array|null **getData**()
95102

96-
[at line 62](https://github.com/code-lts/Laravel-FCM/blob/main/src/Message/PayloadDataBuilder.php#L62)
103+
[at line 64](https://github.com/code-lts/Laravel-FCM/blob/main/src/Message/PayloadDataBuilder.php#L64)
97104

98105
return data.
99106

100107
#### Return Value
101108

102109
| | |
103110
|---|---|
104-
|array|
111+
|array|null|
105112

106113
<a name id="method_build"></a>
107114

108115
###
109116
[<abbr title="LaravelFCM\Message\PayloadData">PayloadData</abbr>](../../LaravelFCM/Message/PayloadData.md) **build**()
110117

111-
[at line 72](https://github.com/code-lts/Laravel-FCM/blob/main/src/Message/PayloadDataBuilder.php#L72)
118+
[at line 74](https://github.com/code-lts/Laravel-FCM/blob/main/src/Message/PayloadDataBuilder.php#L74)
112119

113120
generate a PayloadData.
114121

‎doc/LaravelFCM/Message/Topics.md‎

Lines changed: 12 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -37,7 +37,7 @@ Create topic or a topic condition
3737
|array|string|<a name="#method_build"></a>build()|Transform to array.||
3838
|string|<a name="#method_topicsForFcm"></a>topicsForFcm(array $conditions)|No description||
3939
|bool|<a name="#method_hasOnlyOneTopic"></a>hasOnlyOneTopic()|Check if only one topic was set.||
40-
||<a name="#method_checkIfOneTopicExist"></a>checkIfOneTopicExist()|No description||
40+
|void|<a name="#method_checkIfOneTopicExist"></a>checkIfOneTopicExist()|No description||
4141

4242

4343
### Details
@@ -170,7 +170,7 @@ Equivalent of this: **'TopicA' in topics || ('TopicB' in topics && 'TopicC' in t
170170
###
171171
array|string **build**()
172172

173-
[at line 167](https://github.com/code-lts/Laravel-FCM/blob/main/src/Message/Topics.php#L167)
173+
[at line 166](https://github.com/code-lts/Laravel-FCM/blob/main/src/Message/Topics.php#L166)
174174

175175
Transform to array.
176176

@@ -192,7 +192,7 @@ Transform to array.
192192
###
193193
protected string **topicsForFcm**(array $conditions)
194194

195-
[at line 189](https://github.com/code-lts/Laravel-FCM/blob/main/src/Message/Topics.php#L189)
195+
[at line 188](https://github.com/code-lts/Laravel-FCM/blob/main/src/Message/Topics.php#L188)
196196

197197

198198

@@ -213,7 +213,7 @@ protected string **topicsForFcm**(array $conditions)
213213
###
214214
bool **hasOnlyOneTopic**()
215215

216-
[at line 225](https://github.com/code-lts/Laravel-FCM/blob/main/src/Message/Topics.php#L225)
216+
[at line 224](https://github.com/code-lts/Laravel-FCM/blob/main/src/Message/Topics.php#L224)
217217

218218
Check if only one topic was set.
219219

@@ -226,12 +226,19 @@ Check if only one topic was set.
226226
<a name id="method_checkIfOneTopicExist"></a>
227227

228228
###
229-
protected **checkIfOneTopicExist**()
229+
protected void **checkIfOneTopicExist**()
230230

231231
[at line 235](https://github.com/code-lts/Laravel-FCM/blob/main/src/Message/Topics.php#L235)
232232

233233

234234

235+
#### Return Value
236+
237+
| | |
238+
|---|---|
239+
|void|
240+
241+
235242
#### Exceptions
236243

237244
| | |

‎doc/LaravelFCM/Request/Request.md‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -157,7 +157,7 @@ get Options transformed.
157157
###
158158
protected array|null **getNotification**()
159159

160-
[at line 134](https://github.com/code-lts/Laravel-FCM/blob/main/src/Request/Request.php#L134)
160+
[at line 135](https://github.com/code-lts/Laravel-FCM/blob/main/src/Request/Request.php#L135)
161161

162162
get notification transformed.
163163

@@ -172,7 +172,7 @@ get notification transformed.
172172
###
173173
protected array|null **getData**()
174174

175-
[at line 144](https://github.com/code-lts/Laravel-FCM/blob/main/src/Request/Request.php#L144)
175+
[at line 145](https://github.com/code-lts/Laravel-FCM/blob/main/src/Request/Request.php#L145)
176176

177177
get data transformed.
178178

‎doc/LaravelFCM/Request/ValidateRequest.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -66,7 +66,7 @@ Build the header for the request.
6666
###
6767
protected mixed **buildBody**()
6868

69-
[at line 12](https://github.com/code-lts/Laravel-FCM/blob/main/src/Request/ValidateRequest.php#L12)
69+
[at line 11](https://github.com/code-lts/Laravel-FCM/blob/main/src/Request/ValidateRequest.php#L11)
7070

7171

7272

‎doc/LaravelFCM/Response/BaseResponse.md‎

Lines changed: 20 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -41,8 +41,8 @@ abstract class **BaseResponse** [View source](https://github.com/code-lts/Larave
4141
| | | | |
4242
|---|---|---|---|
4343
||<a name="#method___construct"></a>__construct(<abbr title="Psr\Http\Message\ResponseInterface">ResponseInterface</abbr> $response, <abbr title="Monolog\Logger">Logger</abbr> $logger)|BaseResponse constructor.||
44-
||<a name="#method_parseResponse"></a>parseResponse(array $responseInJson)|parse the response.||
45-
||<a name="#method_logResponse"></a>logResponse()|Log the response.||
44+
|void|<a name="#method_parseResponse"></a>parseResponse(array $responseInJson)|parse the response.||
45+
|void|<a name="#method_logResponse"></a>logResponse()|Log the response.||
4646

4747

4848
### Details
@@ -63,9 +63,9 @@ BaseResponse constructor.
6363
<a name id="method_parseResponse"></a>
6464

6565
###
66-
abstractprotected **parseResponse**(array $responseInJson)
66+
abstractprotected void **parseResponse**(array $responseInJson)
6767

68-
[at line 75](https://github.com/code-lts/Laravel-FCM/blob/main/src/Response/BaseResponse.php#L75)
68+
[at line 77](https://github.com/code-lts/Laravel-FCM/blob/main/src/Response/BaseResponse.php#L77)
6969

7070
parse the response.
7171

@@ -74,12 +74,26 @@ parse the response.
7474
| | | |
7575
|---|---|---|
7676
|array|$responseInJson|
77+
78+
#### Return Value
79+
80+
| | |
81+
|---|---|
82+
|void|
83+
7784
<a name id="method_logResponse"></a>
7885

7986
###
80-
abstractprotected **logResponse**()
87+
abstractprotected void **logResponse**()
8188

82-
[at line 80](https://github.com/code-lts/Laravel-FCM/blob/main/src/Response/BaseResponse.php#L80)
89+
[at line 84](https://github.com/code-lts/Laravel-FCM/blob/main/src/Response/BaseResponse.php#L84)
8390

8491
Log the response.
92+
93+
#### Return Value
94+
95+
| | |
96+
|---|---|
97+
|void|
98+
8599
_Generated by [Doctum, a API Documentation generator and fork of Sami](https://github.com/code-lts/doctum)._

0 commit comments

Comments
 (0)