Skip to content

Commit b681c17

Browse files
author
Grigorii Duca
committed
.
1 parent 7d753a4 commit b681c17

30 files changed

+223
-72
lines changed

docs/Accessor/AccessorStaticTrait.md

+4
Original file line numberDiff line numberDiff line change
@@ -22,6 +22,10 @@ class InMemory
2222
}
2323
```
2424

25+
# Table of contents:
26+
27+
* [Methods](#methods)
28+
2529
# Methods:
2630

2731
* [getAccessor](#getaccessor) - Get storage;

docs/Accessor/AccessorTrait.md

+4
Original file line numberDiff line numberDiff line change
@@ -32,6 +32,10 @@ class Options
3232
}
3333
```
3434

35+
# Table of contents:
36+
37+
* [Methods](#methods)
38+
3539
# Methods:
3640

3741
* [getAccessor](#getaccessor) - Get storage;
+9-3
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,9 @@
11
# ArrayAccessStaticTrait Documentation
22

3-
A trait for **public** usage of the storage in a static class.
3+
`\Greg\Support\Accessor\ArrayAccessStaticTrait` is a trait for **public** usage of the storage in a static class.
44

5-
Use: [`\Greg\Support\Accessor\AccessorStaticTrait`](AccessorStaticTrait.md), [`\Greg\Support\Accessor\ArrayAccessorStaticTrait`](ArrayAccessorStaticTrait.md).
5+
Uses: [`\Greg\Support\Accessor\AccessorStaticTrait`](AccessorStaticTrait.md),
6+
[`\Greg\Support\Accessor\ArrayAccessorStaticTrait`](ArrayAccessorStaticTrait.md).
67

78
_Example:_
89

@@ -13,6 +14,11 @@ class Storage
1314
}
1415
```
1516

17+
# Table of contents:
18+
19+
* [Methods](#methods)
20+
1621
# Methods:
1722

18-
See trait uses.
23+
Includes [AccessorStaticTrait](AccessorStaticTrait.md)
24+
and [ArrayAccessorStaticTrait](ArrayAccessorStaticTrait.md) methods.

docs/Accessor/ArrayAccessTrait.md

+11-3
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,10 @@
11
# ArrayAccessTrait Documentation
22

3-
A trait for **public** usage of the storage in a class with [`\ArrayAccess`](http://php.net/manual/en/class.arrayaccess.php) support.
3+
`\Greg\Support\Accessor\ArrayAccessTrait` is a trait for **public** usage of the storage in a class
4+
with [`\ArrayAccess`](http://php.net/manual/en/class.arrayaccess.php) support.
45

5-
Use: [`\Greg\Support\Accessor\AccessorTrait`](AccessorTrait.md), [`\Greg\Support\Accessor\ArrayAccessorTrait`](ArrayAccessorTrait.md).
6+
Uses: [`\Greg\Support\Accessor\AccessorTrait`](AccessorTrait.md),
7+
[`\Greg\Support\Accessor\ArrayAccessorTrait`](ArrayAccessorTrait.md).
68

79
_Example:_
810

@@ -13,6 +15,12 @@ class Storage implements \ArrayAccess
1315
}
1416
```
1517

18+
# Table of contents:
19+
20+
* [Methods](#methods)
21+
1622
# Methods:
1723

18-
See trait uses.
24+
Includes [AccessorTrait](AccessorTrait.md),
25+
[ArrayAccessorTrait](ArrayAccessorTrait.md)
26+
and [`\ArrayAccess`](http://php.net/manual/en/class.arrayaccess.php) methods.

docs/Accessor/ArrayAccessorStaticTrait.md

+4
Original file line numberDiff line numberDiff line change
@@ -18,6 +18,10 @@ class Storage
1818
}
1919
```
2020

21+
# Table of contents:
22+
23+
* [Methods](#methods)
24+
2125
# Methods:
2226

2327
* [has](#has) - Determine if a key or an array of keys exists in accessor;

docs/Accessor/ArrayAccessorTrait.md

+4
Original file line numberDiff line numberDiff line change
@@ -18,6 +18,10 @@ class Storage
1818
}
1919
```
2020

21+
# Table of contents:
22+
23+
* [Methods](#methods)
24+
2125
# Methods:
2226

2327
* [has](#has) - Determine if a key or an array of keys exists in accessor;

docs/Accessor/ArrayObject.md

+26-4
Original file line numberDiff line numberDiff line change
@@ -2,8 +2,34 @@
22

33
`\Greg\Support\Accessor\ArrayObject` is an array as an object.
44

5+
Implements: [`\ArrayAccess`](http://php.net/manual/en/class.arrayaccess.php),
6+
[`\IteratorAggregate`](http://php.net/manual/en/class.iteratoraggregate.php),
7+
[`\Serializable`](http://php.net/manual/en/class.serializable.php),
8+
[`\Countable`](http://php.net/manual/en/class.countable.php).
9+
10+
Uses: [`\Greg\Support\Accessor\ArrayAccessTrait`](ArrayAccessTrait.md),
11+
[`\Greg\Support\Accessor\IteratorAggregateTrait`](IteratorAggregateTrait.md),
12+
[`\Greg\Support\Accessor\SerializableTrait`](SerializableTrait.md),
13+
[`\Greg\Support\Accessor\CountableTrait`](CountableTrait.md).
14+
15+
# Table of contents:
16+
17+
* [Magic methods](#magic-methods)
18+
* [Methods](#methods)
19+
20+
# Magic methods:
21+
22+
* [__construct](#__construct);
23+
24+
**Methods description is under construction.**
25+
526
# Methods:
627

28+
Includes [ArrayAccessTrait](ArrayAccessTrait.md),
29+
[IteratorAggregateTrait](IteratorAggregateTrait.md),
30+
[SerializableTrait](SerializableTrait.md)
31+
and [CountableTrait](CountableTrait.md) methods.
32+
733
* [toArray](#toarray) - Transform to array;
834
* [exchange](#exchange) - Exchange array;
935
* [exchangeRef](#exchangeref) - Exchange array reference;
@@ -60,8 +86,4 @@
6086
* [keys](#keys) - Get keys of array;
6187
* [values](#values) - Get values of array.
6288

63-
**Magic methods:**
64-
65-
* [__construct](#__construct);
66-
6789
**Methods description is under construction.**

docs/Accessor/CountableTrait.md

+6-2
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# CountableTrait Documentation
22

3-
A trait for [Countable](http://php.net/manual/en/class.countable.php) interface.
3+
A trait for [`\Countable`](http://php.net/manual/en/class.countable.php) interface.
44

55
_Example:_
66

@@ -18,6 +18,10 @@ class Storage implements \Countable
1818
}
1919
```
2020

21+
# Table of contents:
22+
23+
* [Methods](#methods)
24+
2125
# Methods:
2226

23-
See [Countable](http://php.net/manual/en/class.countable.php) interface.
27+
Includes [`\Countable`](http://php.net/manual/en/class.countable.php) methods.

docs/Accessor/IteratorAggregateTrait.md

+6-2
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# IteratorAggregateTrait Documentation
22

3-
A trait for [IteratorAggregate](http://php.net/manual/en/class.iteratoraggregate.php) interface.
3+
A trait for [`\IteratorAggregate`](http://php.net/manual/en/class.iteratoraggregate.php) interface.
44

55
_Example:_
66

@@ -18,9 +18,13 @@ class Storage implements \IteratorAggregate
1818
}
1919
```
2020

21+
# Table of contents:
22+
23+
* [Methods](#methods)
24+
2125
# Methods:
2226

23-
See [IteratorAggregate](http://php.net/manual/en/class.iteratoraggregate.php) interface.
27+
Includes [`\IteratorAggregate`](http://php.net/manual/en/class.iteratoraggregate.php) methods.
2428

2529
* [getIteratorClass](#getiteratorclass) - Get iterator class;
2630
* [setIteratorClass](#setiteratorclass) - Set iterator class.

docs/Accessor/SerializableTrait.md

+6-2
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# SerializableTrait Documentation
22

3-
A trait for [SerializableTrait](http://php.net/manual/en/class.serializable.php) interface.
3+
A trait for [`\Serializable`](http://php.net/manual/en/class.serializable.php) interface.
44

55
_Example:_
66

@@ -25,6 +25,10 @@ class Storage implements \Serializable
2525
}
2626
```
2727

28+
# Table of contents:
29+
30+
* [Methods](#methods)
31+
2832
# Methods:
2933

30-
See [SerializableTrait](http://php.net/manual/en/class.serializable.php) interface.
34+
Includes [`\Serializable`](http://php.net/manual/en/class.serializable.php) methods.

docs/Arr.md

+5
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,11 @@
22

33
`\Greg\Support\Arr` is working with arrays.
44

5+
# Table of contents:
6+
7+
* [Constants](#constants)
8+
* [Methods](#methods)
9+
510
# Constants:
611

712
```php

docs/Config.md

+4
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,10 @@
22

33
`\Greg\Support\Config` is working with config files.
44

5+
# Table of contents:
6+
7+
* [Methods](#methods)
8+
59
# Methods:
610

711
* [dir](#dir) - Get a config from a directory;

docs/DateTime.md

+6
Original file line numberDiff line numberDiff line change
@@ -4,8 +4,14 @@
44

55
Extends: [`\DateTime`](http://php.net/manual/en/class.datetime.php).
66

7+
# Table of contents:
8+
9+
* [Methods](#methods)
10+
711
# Methods:
812

13+
Includes [`\DateTime`](http://php.net/manual/en/class.datetime.php) methods.
14+
915
* [yearInterval](#yearinterval) - Get a string interval to current year;
1016
* [transform](#transform) - Transform a time;
1117
* [transformLocale](#transformlocale) - Transform a time, using locale;

docs/Dir.md

+4
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,10 @@
22

33
`\Greg\Support\Dir` is working with directories.
44

5+
# Table of contents:
6+
7+
* [Methods](#methods)
8+
59
# Methods:
610

711
* [make](#make) - Make a directory;

docs/File.md

+11-4
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,17 @@
22

33
`\Greg\Support\File` is working with directories.
44

5+
# Table of contents:
6+
7+
* [Magic methods](#magic-methods)
8+
* [Methods](#methods)
9+
10+
# Magic methods:
11+
12+
* [__construct](#__construct);
13+
14+
**Methods description is under construction.**
15+
516
# Methods:
617

718
* [fileName](#filename) - Get file name;
@@ -13,8 +24,4 @@
1324
* [mime](#mime) - Get mime of a file;
1425
* [makeDir](#makedir) - Make directory of a file.
1526

16-
**Magic methods:**
17-
18-
* [__construct](#__construct);
19-
2027
**Methods description is under construction.**

docs/Http/Request.md

+12-4
Original file line numberDiff line numberDiff line change
@@ -4,6 +4,12 @@
44

55
Throws: `\Greg\Support\Http\RequestException`.
66

7+
# Table of contents:
8+
9+
* [Constants](#constants)
10+
* [Magic methods](#magic-methods)
11+
* [Methods](#methods)
12+
713
# Constants
814

915
```php
@@ -37,6 +43,12 @@ const UPLOAD_ERROR = [
3743
];
3844
```
3945

46+
# Magic methods:
47+
48+
* [__construct](#__construct);
49+
50+
**Methods description is under construction.**
51+
4052
# Methods:
4153

4254
* [validate](#validate) - Validate params;
@@ -90,8 +102,4 @@ const UPLOAD_ERROR = [
90102
* [fileIndex](#fileindex) - Get a param or an array of params by index from `$_FILES`;
91103
* [fileIndexArray](#fileindexarray) - Get an array param or an array of array params by index from `$_FILES`.
92104

93-
**Magic methods:**
94-
95-
* [__construct](#__construct);
96-
97105
**Methods description is under construction.**

docs/Http/Response.md

+13-5
Original file line numberDiff line numberDiff line change
@@ -4,6 +4,12 @@
44

55
Throws: `\Greg\Support\Http\ResponseException`.
66

7+
# Table of contents:
8+
9+
* [Constants](#constants)
10+
* [Magic methods](#magic-methods)
11+
* [Methods](#methods)
12+
713
# Constants
814

915
```php
@@ -71,6 +77,13 @@ const CODES = [
7177
];
7278
```
7379

80+
# Magic methods
81+
82+
* [__construct](#__construct);
83+
* [__toString](#__toString);
84+
85+
**Methods description is under construction.**
86+
7487
# Methods:
7588

7689
* [back](#back) - Set redirection back;
@@ -111,9 +124,4 @@ const CODES = [
111124
* [flush](#flush) - Flush the output buffer;
112125
* [isModifiedSince](#ismodifiedsince) - Determine if the request was modified.
113126

114-
**Magic methods**
115-
116-
* [__construct](#__construct);
117-
* [__toString](#__toString);
118-
119127
**Methods description is under construction.**

docs/Image.md

+6-4
Original file line numberDiff line numberDiff line change
@@ -4,8 +4,14 @@
44

55
Extends: [`\Greg\Support\File`](File.md).
66

7+
# Table of contents:
8+
9+
* [Methods](#methods)
10+
711
# Methods:
812

13+
Includes [File](File.md) methods.
14+
915
* [getType](#gettype) - Get image type;
1016
* [getSize](#getsize) - Get image size;
1117
* [getResource](#getresource) - Get image resource;
@@ -17,8 +23,4 @@ Extends: [`\Greg\Support\File`](File.md).
1723
* [width](#width) - Get width of an image;
1824
* [height](#height) - Get height of an image.
1925

20-
**Magic methods:**
21-
22-
* [__construct](#__construct);
23-
2426
**Methods description is under construction.**

docs/Obj.md

+4
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,10 @@
22

33
`\Greg\Support\Obj` is working with objects.
44

5+
# Table of contents:
6+
7+
* [Methods](#methods)
8+
59
# Methods:
610

711
* [call](#call) - Call a callable with arguments;

docs/Server.md

+4
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,10 @@
22

33
`\Greg\Support\Server` is working with server configurations.
44

5+
# Table of contents:
6+
7+
* [Methods](#methods)
8+
59
# Methods:
610

711
* [scriptName](#scriptname) - Get script name;

0 commit comments

Comments
 (0)