Skip to content

Commit 1afdc5e

Browse files
committed
Map factory documentation description
1 parent 1824fd8 commit 1afdc5e

File tree

2 files changed

+96
-19
lines changed

2 files changed

+96
-19
lines changed

Diff for: README.md

+47-9
Original file line numberDiff line numberDiff line change
@@ -832,12 +832,14 @@ CollectionFactory::numbers(10)
832832
```
833833

834834
#### Collection creation factory methods
835-
- [*from* – Generating a collection from an array of elements](#from---generating-a-collection-from-an-array-of-elements)
836-
- [*fromIterable* – Generating a collection using any iterable](#fromiterable---generating-a-collection-using-any-iterable)
837-
- [*numbers* – Generating a collection of a sequence of integers](#numbers---generating-a-collection-of-a-sequence-of-integers)
838-
- [*generate* – Generating a collection using a generator](#generate---generating-a-collection-using-a-generator)
839-
840-
#### from - Generating a collection from an array of elements
835+
- [*CollectionFactory::from* – Generating a collection from an array of elements](#CollectionFactory--from---generating-a-collection-from-an-array-of-elements)
836+
- [*CollectionFactory::fromIterable* – Generating a collection using any iterable](#CollectionFactory--fromiterable---generating-a-collection-using-any-iterable)
837+
- [*CollectionFactory::numbers* – Generating a collection of a sequence of integers](#CollectionFactory--numbers---generating-a-collection-of-a-sequence-of-integers)
838+
- [*CollectionFactory::generate* – Generating a collection using a generator](#CollectionFactory--generate---generating-a-collection-using-a-generator)
839+
- [*MapFactory::fromIterable* – Map generation from any iterated value](#MapFactory--fromIterable---генерирование-карты-при-помощи-любого-итерируемого-значения)
840+
- [*MapFactory::assoc* – Map generation from associative array](#MapFactory--assoc---Map-generation-from-associative-array)
841+
842+
#### _CollectionFactory::from_ - Generating a collection from an array of elements
841843
[[↑ Collection factory]](#collection-factory)
842844
```
843845
from($values: array): Collection
@@ -856,7 +858,7 @@ CollectionFactory::from([1 ,2, 3])
856858

857859
```
858860

859-
#### fromIterable - Generating a collection using any iterable
861+
#### _CollectionFactory::fromIterable_ - Generating a collection using any iterable
860862
[[↑ Collection factory]](#collection-factory)
861863
```
862864
fromIterable($iterable: iterable): Collection
@@ -876,7 +878,7 @@ CollectionFactory::fromIterable(new DirectoryIterator(__DIR__))
876878
->each(Consumers::dump()); // Dumps strings with filenames
877879
```
878880

879-
#### numbers - Generating a collection of a sequence of integers
881+
#### __CollectionFactory::numbers_ - Generating a collection of a sequence of integers
880882
[[↑ Collection factory]](#collection-factory)
881883
```
882884
numbers($from: int, $to: ?int): Collection
@@ -895,7 +897,7 @@ CollectionFactory::numbers(10, 15)
895897
->each(Consumers::dump()); // Dumps [10, 11, 12, 13, 14, 15]
896898
```
897899

898-
#### generate - Generating a collection using a generator
900+
#### _CollectionFactory::generate_ - Generating a collection using a generator
899901
[[↑ Collection factory]](#collection-factory)
900902
```
901903
generate($times: int, $generator: ?callable): Collection
@@ -917,6 +919,42 @@ CollectionFactory::generate(3, static function () {
917919
->each(Consumers::dump()); // Dumps for example [9, 7, 2]
918920
```
919921

922+
#### _MapFactory::fromIterable_ - Map generating from any iterated value
923+
[[↑ Collection factory]](#collection-factory)
924+
```
925+
MapFactory::fromIterable($iterable: iterable): Map
926+
```
927+
928+
Method created map object from any iterated object.
929+
930+
```php
931+
932+
use WS\Utils\Collections\MapFactory;
933+
934+
MapFactory::fromIterable(['a' => 1, 'b' => 2])
935+
->keys() // ['a', 'b']
936+
;
937+
938+
```
939+
940+
#### _MapFactory::assoc_ - Map generating from associative array
941+
[[↑ Collection factory]](#collection-factory)
942+
```
943+
MapFactory::assoc(array $assocArray): Map
944+
```
945+
946+
Method creates map object from associative array.
947+
948+
```php
949+
950+
use WS\Utils\Collections\MapFactory;
951+
952+
MapFactory::assoc(['a' => 1, 'b' => 2])
953+
->keys() // ['a', 'b']
954+
;
955+
956+
```
957+
920958
## Collection streams
921959
[[↑ Up]](#php-collections)
922960

Diff for: doc/README.ru.md

+49-10
Original file line numberDiff line numberDiff line change
@@ -816,7 +816,8 @@ foreach($map as $key => $value) {
816816
## Фабрика создания коллекции
817817
[[↑ В начало]](#PHP-Коллекции)
818818

819-
Фабрика ```CollectionFactory``` позволяет создавать объекты коллекций без использования конструктора конкретной реализации, а так же обладает другими удобными методами создания объектов коллекций. На данный момент, основной структурой библиотеки является ```ArrayList```, который и порождается фабрикой в статических методах.
819+
Фабрики ```CollectionFactory/MapFactory``` позволяют создавать объекты коллекций без использования конструктора конкретной реализации, а так же обладает другими удобными методами создания объектов коллекций.
820+
На данный момент основной структурой библиотеки являются ```ArrayList, HashMap, HashSet```, которые и порождается фабрикой в статических методах.
820821

821822
### Пример использования фабрики
822823

@@ -831,12 +832,14 @@ CollectionFactory::numbers(10)
831832

832833
```
833834
#### Методы фабрики создания коллекции
834-
- [*from* – Генерирование коллекции из массива элементов](#from---генерирование-коллекции-из-массива-элементов)
835-
- [*fromIterable* – Генерирование коллекции при помощи любой итерируемой величины](#fromIterable---генерирование-коллекции-при-помощи-любой-итерируемой-величины)
836-
- [*numbers* – Генерирование коллекции состоящей из элементов последовательности целых чисел](#numbers---генерирование-коллекции-состоящей-из-элементов-последовательности-целых-чисел)
837-
- [*generate* – Генерирование коллекции при помощи генератора](#generate---генерирование-коллекции-при-помощи-генератора)
838-
839-
#### _from_ - Генерирование коллекции из массива элементов
835+
- [*CollectionFactory::from* – Генерирование коллекции из массива элементов](#CollectionFactory--from---генерирование-коллекции-из-массива-элементов)
836+
- [*CollectionFactory::fromIterable* – Генерирование коллекции при помощи любой итерируемой величины](#CollectionFactory--fromIterable---генерирование-коллекции-при-помощи-любой-итерируемой-величины)
837+
- [*CollectionFactory::numbers* – Генерирование коллекции состоящей из элементов последовательности целых чисел](#CollectionFactory--numbers---генерирование-коллекции-состоящей-из-элементов-последовательности-целых-чисел)
838+
- [*CollectionFactory::generate* – Генерирование коллекции при помощи генератора](#CollectionFactory--generate---генерирование-коллекции-при-помощи-генератора)
839+
- [*MapFactory::fromIterable* – Генерирование карты при помощи любого итерируемого значения](#MapFactory--fromIterable---генерирование-карты-при-помощи-любого-итерируемого-значения)
840+
- [*MapFactory::assoc* – Генерирование карты из ассоциативного массива](#MapFactory--assoc---Генерирование-карты-при-помощи-ассоциативного-массива)
841+
842+
#### _CollectionFactory::from_ - Генерирование коллекции из массива элементов
840843
[[↑ Фабрика создания коллекции]](#Фабрика-создания-коллекции)
841844
```
842845
from($values: array): Collection
@@ -855,7 +858,7 @@ CollectionFactory::from([1 ,2, 3])
855858

856859
```
857860

858-
#### _fromIterable_ - Генерирование коллекции при помощи любой итерируемой величины
861+
#### _CollectionFactory::fromIterable_ - Генерирование коллекции при помощи любой итерируемой величины
859862
[[↑ Фабрика создания коллекции]](#Фабрика-создания-коллекции)
860863
```
861864
fromIterable($iterable: iterable): Collection
@@ -875,7 +878,7 @@ CollectionFactory::fromIterable(new DirectoryIterator(__DIR__))
875878
->each(Consumers::dump()); // Dumps strings with filenames
876879
```
877880

878-
#### _numbers_ - Генерирование коллекции состоящей из элементов последовательности целых чисел
881+
#### _CollectionFactory::numbers_ - Генерирование коллекции состоящей из элементов последовательности целых чисел
879882
[[↑ Фабрика создания коллекции]](#Фабрика-создания-коллекции)
880883
```
881884
numbers($from: int, $to: ?int): Collection
@@ -893,7 +896,7 @@ CollectionFactory::numbers(10, 15)
893896
->each(Consumers::dump()); // Dumps [10, 11, 12, 13, 14, 15]
894897
```
895898

896-
#### _generate_ - Генерирование коллекции при помощи генератора
899+
#### _CollectionFactory::generate_ - Генерирование коллекции при помощи генератора
897900
[[↑ Фабрика создания коллекции]](#Фабрика-создания-коллекции)
898901
```
899902
generate($times: int, $generator: ?callable): Collection
@@ -914,6 +917,42 @@ CollectionFactory::generate(3, static function () {
914917
->each(Consumers::dump()); // Dumps for example [9, 7, 2]
915918
```
916919

920+
#### _MapFactory::fromIterable_ - Генерирование карты при помощи любого итерируемого значения
921+
[[↑ Фабрика создания коллекции]](#Фабрика-создания-коллекции)
922+
```
923+
MapFactory::fromIterable($iterable: iterable): Map
924+
```
925+
926+
Метод создает объект карты из любого итерируемого объекта.
927+
928+
```php
929+
930+
use WS\Utils\Collections\MapFactory;
931+
932+
MapFactory::fromIterable(['a' => 1, 'b' => 2])
933+
->keys() // ['a', 'b']
934+
;
935+
936+
```
937+
938+
#### _MapFactory::assoc_ - Генерирование карты при помощи ассоциативного массива
939+
[[↑ Фабрика создания коллекции]](#Фабрика-создания-коллекции)
940+
```
941+
MapFactory::assoc(array $assocArray): Map
942+
```
943+
944+
Метод создает объект карты из ассоциативного массива.
945+
946+
```php
947+
948+
use WS\Utils\Collections\MapFactory;
949+
950+
MapFactory::assoc(['a' => 1, 'b' => 2])
951+
->keys() // ['a', 'b']
952+
;
953+
954+
```
955+
917956
## Потоки обхода коллекций
918957
[[↑ В начало]](#PHP-Коллекции)
919958

0 commit comments

Comments
 (0)