Merge 60552df into 96cf513

azjezz · Mar 17, 2021 · 0dac809 · 0dac809
2 parents 96cf513 + 60552df
commit 0dac809
Show file tree

Hide file tree

Showing 33 changed files with 1,109 additions and 779 deletions.
diff --git a/docs/README.md b/docs/README.md
diff --git a/docs/README.template.md b/docs/README.template.md
diff --git a/docs/component/arr.md b/docs/component/arr.md
@@ -0,0 +1,61 @@
+<!--
+    This markdown file was generated using `docs/documenter.php`.
+
+    Any edits to it will likely be lost.
+-->
+
+[*index](./../README.md)
+
+---
+
+### `Psl\Arr` Component
+
+#### `Functions`
+
+- [at](./../../src/Psl/Arr/at.php#L27) ( deprecated )
+- [concat](./../../src/Psl/Arr/concat.php#L22) ( deprecated )
+- [contains](./../../src/Psl/Arr/contains.php#L24) ( deprecated )
+- [contains_key](./../../src/Psl/Arr/contains_key.php#L25) ( deprecated )
+- [count](./../../src/Psl/Arr/count.php#L36) ( deprecated )
+- [count_values](./../../src/Psl/Arr/count_values.php#L22) ( deprecated )
+- [drop](./../../src/Psl/Arr/drop.php#L31) ( deprecated )
+- [drop_while](./../../src/Psl/Arr/drop_while.php#L31) ( deprecated )
+- [equal](./../../src/Psl/Arr/equal.php#L22) ( deprecated )
+- [fill](./../../src/Psl/Arr/fill.php#L25) ( deprecated )
+- [filter](./../../src/Psl/Arr/filter.php#L34) ( deprecated )
+- [filter_keys](./../../src/Psl/Arr/filter_keys.php#L34) ( deprecated )
+- [filter_nulls](./../../src/Psl/Arr/filter_nulls.php#L25) ( deprecated )
+- [filter_with_key](./../../src/Psl/Arr/filter_with_key.php#L37) ( deprecated )
+- [first](./../../src/Psl/Arr/first.php#L24) ( deprecated )
+- [first_key](./../../src/Psl/Arr/first_key.php#L25) ( deprecated )
+- [firstx](./../../src/Psl/Arr/firstx.php#L28) ( deprecated )
+- [flat_map](./../../src/Psl/Arr/flat_map.php#L22) ( deprecated )
+- [flatten](./../../src/Psl/Arr/flatten.php#L33) ( deprecated )
+- [flip](./../../src/Psl/Arr/flip.php#L28) ( deprecated )
+- [group_by](./../../src/Psl/Arr/group_by.php#L43) ( deprecated )
+- [idx](./../../src/Psl/Arr/idx.php#L35) ( deprecated )
+- [keys](./../../src/Psl/Arr/keys.php#L22) ( deprecated )
+- [last](./../../src/Psl/Arr/last.php#L24) ( deprecated )
+- [last_key](./../../src/Psl/Arr/last_key.php#L26) ( deprecated )
+- [lastx](./../../src/Psl/Arr/lastx.php#L28) ( deprecated )
+- [map](./../../src/Psl/Arr/map.php#L34) ( deprecated )
+- [map_keys](./../../src/Psl/Arr/map_keys.php#L34) ( deprecated )
+- [map_with_key](./../../src/Psl/Arr/map_with_key.php#L34) ( deprecated )
+- [merge](./../../src/Psl/Arr/merge.php#L32) ( deprecated )
+- [partition](./../../src/Psl/Arr/partition.php#L22) ( deprecated )
+- [random](./../../src/Psl/Arr/random.php#L25) ( deprecated )
+- [select_keys](./../../src/Psl/Arr/select_keys.php#L25) ( deprecated )
+- [shuffle](./../../src/Psl/Arr/shuffle.php#L30) ( deprecated )
+- [slice](./../../src/Psl/Arr/slice.php#L35) ( deprecated )
+- [sort](./../../src/Psl/Arr/sort.php#L24) ( deprecated )
+- [sort_by](./../../src/Psl/Arr/sort_by.php#L27) ( deprecated )
+- [sort_by_key](./../../src/Psl/Arr/sort_by_key.php#L26) ( deprecated )
+- [sort_with_keys](./../../src/Psl/Arr/sort_with_keys.php#L25) ( deprecated )
+- [sort_with_keys_by](./../../src/Psl/Arr/sort_with_keys_by.php#L29) ( deprecated )
+- [take](./../../src/Psl/Arr/take.php#L25) ( deprecated )
+- [take_while](./../../src/Psl/Arr/take_while.php#L31) ( deprecated )
+- [unique](./../../src/Psl/Arr/unique.php#L22) ( deprecated )
+- [unique_by](./../../src/Psl/Arr/unique_by.php#L26) ( deprecated )
+- [values](./../../src/Psl/Arr/values.php#L25) ( deprecated )
+
+
diff --git a/docs/component/collection.md b/docs/component/collection.md
@@ -0,0 +1,33 @@
+<!--
+    This markdown file was generated using `docs/documenter.php`.
+
+    Any edits to it will likely be lost.
+-->
+
+[*index](./../README.md)
+
+---
+
+### `Psl\Collection` Component
+
+#### `Interfaces`
+
+- [AccessibleCollectionInterface](./../../src/Psl/Collection/AccessibleCollectionInterface.php#L18)
+- [CollectionInterface](./../../src/Psl/Collection/CollectionInterface.php#L21)
+- [IndexAccessInterface](./../../src/Psl/Collection/IndexAccessInterface.php#L13)
+- [MapInterface](./../../src/Psl/Collection/MapInterface.php#L13)
+- [MutableAccessibleCollectionInterface](./../../src/Psl/Collection/MutableAccessibleCollectionInterface.php#L20)
+- [MutableCollectionInterface](./../../src/Psl/Collection/MutableCollectionInterface.php#L20)
+- [MutableIndexAccessInterface](./../../src/Psl/Collection/MutableIndexAccessInterface.php#L16)
+- [MutableMapInterface](./../../src/Psl/Collection/MutableMapInterface.php#L14)
+- [MutableVectorInterface](./../../src/Psl/Collection/MutableVectorInterface.php#L13)
+- [VectorInterface](./../../src/Psl/Collection/VectorInterface.php#L12)
+
+#### `Classes`
+
+- [Map](./../../src/Psl/Collection/Map.php#L20)
+- [MutableMap](./../../src/Psl/Collection/MutableMap.php#L18)
+- [MutableVector](./../../src/Psl/Collection/MutableVector.php#L17)
+- [Vector](./../../src/Psl/Collection/Vector.php#L17)
+
+
diff --git a/docs/component/data-structure.md b/docs/component/data-structure.md
@@ -0,0 +1,25 @@
+<!--
+    This markdown file was generated using `docs/documenter.php`.
+
+    Any edits to it will likely be lost.
+-->
+
+[*index](./../README.md)
+
+---
+
+### `Psl\DataStructure` Component
+
+#### `Interfaces`
+
+- [PriorityQueueInterface](./../../src/Psl/DataStructure/PriorityQueueInterface.php#L12)
+- [QueueInterface](./../../src/Psl/DataStructure/QueueInterface.php#L17)
+- [StackInterface](./../../src/Psl/DataStructure/StackInterface.php#L17)
+
+#### `Classes`
+
+- [PriorityQueue](./../../src/Psl/DataStructure/PriorityQueue.php#L18)
+- [Queue](./../../src/Psl/DataStructure/Queue.php#L19)
+- [Stack](./../../src/Psl/DataStructure/Stack.php#L19)
+
+
diff --git a/docs/component/dict.md b/docs/component/dict.md
@@ -0,0 +1,53 @@
+<!--
+    This markdown file was generated using `docs/documenter.php`.
+
+    Any edits to it will likely be lost.
+-->
+
+[*index](./../README.md)
+
+---
+
+### `Psl\Dict` Component
+
+#### `Functions`
+
+- [associate](./../../src/Psl/Dict/associate.php#L25)
+- [count_values](./../../src/Psl/Dict/count_values.php#L20)
+- [diff](./../../src/Psl/Dict/diff.php#L24)
+- [diff_by_key](./../../src/Psl/Dict/diff_by_key.php#L24)
+- [drop](./../../src/Psl/Dict/drop.php#L27)
+- [drop_while](./../../src/Psl/Dict/drop_while.php#L26)
+- [equal](./../../src/Psl/Dict/equal.php#L19)
+- [filter](./../../src/Psl/Dict/filter.php#L31)
+- [filter_keys](./../../src/Psl/Dict/filter_keys.php#L31)
+- [filter_nulls](./../../src/Psl/Dict/filter_nulls.php#L21)
+- [filter_with_key](./../../src/Psl/Dict/filter_with_key.php#L34)
+- [flatten](./../../src/Psl/Dict/flatten.php#L28)
+- [flip](./../../src/Psl/Dict/flip.php#L27)
+- [from_entries](./../../src/Psl/Dict/from_entries.php#L18)
+- [from_iterable](./../../src/Psl/Dict/from_iterable.php#L17)
+- [from_keys](./../../src/Psl/Dict/from_keys.php#L19)
+- [group_by](./../../src/Psl/Dict/group_by.php#L41)
+- [intersect](./../../src/Psl/Dict/intersect.php#L24)
+- [intersect_by_key](./../../src/Psl/Dict/intersect_by_key.php#L24)
+- [map](./../../src/Psl/Dict/map.php#L29)
+- [map_keys](./../../src/Psl/Dict/map_keys.php#L29)
+- [map_with_key](./../../src/Psl/Dict/map_with_key.php#L29)
+- [merge](./../../src/Psl/Dict/merge.php#L19)
+- [partition](./../../src/Psl/Dict/partition.php#L19)
+- [partition_with_key](./../../src/Psl/Dict/partition_with_key.php#L19)
+- [pull](./../../src/Psl/Dict/pull.php#L35)
+- [pull_with_key](./../../src/Psl/Dict/pull_with_key.php#L35)
+- [reindex](./../../src/Psl/Dict/reindex.php#L37)
+- [select_keys](./../../src/Psl/Dict/select_keys.php#L23)
+- [slice](./../../src/Psl/Dict/slice.php#L31)
+- [sort](./../../src/Psl/Dict/sort.php#L24)
+- [sort_by](./../../src/Psl/Dict/sort_by.php#L24)
+- [sort_by_key](./../../src/Psl/Dict/sort_by_key.php#L24)
+- [take](./../../src/Psl/Dict/take.php#L22)
+- [take_while](./../../src/Psl/Dict/take_while.php#L26)
+- [unique](./../../src/Psl/Dict/unique.php#L17)
+- [unique_by](./../../src/Psl/Dict/unique_by.php#L23)
+
+
diff --git a/docs/component/encoding-base64.md b/docs/component/encoding-base64.md
@@ -0,0 +1,18 @@
+<!--
+    This markdown file was generated using `docs/documenter.php`.
+
+    Any edits to it will likely be lost.
+-->
+
+[*index](./../README.md)
+
+---
+
+### `Psl\Encoding\Base64` Component
+
+#### `Functions`
+
+- [decode](./../../src/Psl/Encoding/Base64/decode.php#L27)
+- [encode](./../../src/Psl/Encoding/Base64/encode.php#L18)
+
+
diff --git a/docs/component/encoding-hex.md b/docs/component/encoding-hex.md
@@ -0,0 +1,18 @@
+<!--
+    This markdown file was generated using `docs/documenter.php`.
+
+    Any edits to it will likely be lost.
+-->
+
+[*index](./../README.md)
+
+---
+
+### `Psl\Encoding\Hex` Component
+
+#### `Functions`
+
+- [decode](./../../src/Psl/Encoding/Hex/decode.php#L22)
+- [encode](./../../src/Psl/Encoding/Hex/encode.php#L16)
+
+
diff --git a/docs/component/env.md b/docs/component/env.md
@@ -0,0 +1,27 @@
+<!--
+    This markdown file was generated using `docs/documenter.php`.
+
+    Any edits to it will likely be lost.
+-->
+
+[*index](./../README.md)
+
+---
+
+### `Psl\Env` Component
+
+#### `Functions`
+
+- [args](./../../src/Psl/Env/args.php#L12)
+- [current_dir](./../../src/Psl/Env/current_dir.php#L16)
+- [current_exec](./../../src/Psl/Env/current_exec.php#L18)
+- [get_var](./../../src/Psl/Env/get_var.php#L18)
+- [get_vars](./../../src/Psl/Env/get_vars.php#L14)
+- [join_paths](./../../src/Psl/Env/join_paths.php#L16)
+- [remove_var](./../../src/Psl/Env/remove_var.php#L18)
+- [set_current_dir](./../../src/Psl/Env/set_current_dir.php#L16)
+- [set_var](./../../src/Psl/Env/set_var.php#L19)
+- [split_paths](./../../src/Psl/Env/split_paths.php#L16)
+- [temp_dir](./../../src/Psl/Env/temp_dir.php#L20)
+
+
diff --git a/docs/component/filesystem.md b/docs/component/filesystem.md
@@ -0,0 +1,56 @@
+<!--
+    This markdown file was generated using `docs/documenter.php`.
+
+    Any edits to it will likely be lost.
+-->
+
+[*index](./../README.md)
+
+---
+
+### `Psl\Filesystem` Component
+
+#### `Constants`
+
+- [SEPARATOR](./../../src/Psl/Filesystem/constants.php#L0)
+
+#### `Functions`
+
+- [append_file](./../../src/Psl/Filesystem/append_file.php#L18)
+- [canonicalize](./../../src/Psl/Filesystem/canonicalize.php#L15)
+- [change_group](./../../src/Psl/Filesystem/change_group.php#L20)
+- [change_owner](./../../src/Psl/Filesystem/change_owner.php#L20)
+- [change_permissions](./../../src/Psl/Filesystem/change_permissions.php#L19)
+- [copy](./../../src/Psl/Filesystem/copy.php#L21)
+- [create_directory](./../../src/Psl/Filesystem/create_directory.php#L17)
+- [create_file](./../../src/Psl/Filesystem/create_file.php#L23)
+- [create_hard_link](./../../src/Psl/Filesystem/create_hard_link.php#L21)
+- [create_symbolic_link](./../../src/Psl/Filesystem/create_symbolic_link.php#L21)
+- [create_temporary_file](./../../src/Psl/Filesystem/create_temporary_file.php#L26)
+- [delete_directory](./../../src/Psl/Filesystem/delete_directory.php#L23)
+- [delete_file](./../../src/Psl/Filesystem/delete_file.php#L20)
+- [exists](./../../src/Psl/Filesystem/exists.php#L19)
+- [file_size](./../../src/Psl/Filesystem/file_size.php#L17)
+- [get_access_time](./../../src/Psl/Filesystem/get_access_time.php#L18)
+- [get_basename](./../../src/Psl/Filesystem/get_basename.php#L23)
+- [get_change_time](./../../src/Psl/Filesystem/get_change_time.php#L19)
+- [get_directory](./../../src/Psl/Filesystem/get_directory.php#L27)
+- [get_extension](./../../src/Psl/Filesystem/get_extension.php#L16)
+- [get_filename](./../../src/Psl/Filesystem/get_filename.php#L18)
+- [get_group](./../../src/Psl/Filesystem/get_group.php#L18)
+- [get_inode](./../../src/Psl/Filesystem/get_inode.php#L18)
+- [get_modification_time](./../../src/Psl/Filesystem/get_modification_time.php#L19)
+- [get_owner](./../../src/Psl/Filesystem/get_owner.php#L18)
+- [get_permissions](./../../src/Psl/Filesystem/get_permissions.php#L18)
+- [is_directory](./../../src/Psl/Filesystem/is_directory.php#L22)
+- [is_executable](./../../src/Psl/Filesystem/is_executable.php#L20)
+- [is_file](./../../src/Psl/Filesystem/is_file.php#L22)
+- [is_readable](./../../src/Psl/Filesystem/is_readable.php#L20)
+- [is_symbolic_link](./../../src/Psl/Filesystem/is_symbolic_link.php#L19)
+- [is_writable](./../../src/Psl/Filesystem/is_writable.php#L20)
+- [read_directory](./../../src/Psl/Filesystem/read_directory.php#L19)
+- [read_file](./../../src/Psl/Filesystem/read_file.php#L24)
+- [read_symbolic_link](./../../src/Psl/Filesystem/read_symbolic_link.php#L21)
+- [write_file](./../../src/Psl/Filesystem/write_file.php#L18)
+
+
diff --git a/docs/component/fun.md b/docs/component/fun.md
@@ -0,0 +1,21 @@
+<!--
+    This markdown file was generated using `docs/documenter.php`.
+
+    Any edits to it will likely be lost.
+-->
+
+[*index](./../README.md)
+
+---
+
+### `Psl\Fun` Component
+
+#### `Functions`
+
+- [after](./../../src/Psl/Fun/after.php#L37)
+- [identity](./../../src/Psl/Fun/identity.php#L17)
+- [pipe](./../../src/Psl/Fun/pipe.php#L34)
+- [rethrow](./../../src/Psl/Fun/rethrow.php#L17)
+- [when](./../../src/Psl/Fun/when.php#L33)
+
+
diff --git a/docs/component/hash.md b/docs/component/hash.md
@@ -0,0 +1,23 @@
+<!--
+    This markdown file was generated using `docs/documenter.php`.
+
+    Any edits to it will likely be lost.
+-->
+
+[*index](./../README.md)
+
+---
+
+### `Psl\Hash` Component
+
+#### `Functions`
+
+- [algorithms](./../../src/Psl/Hash/algorithms.php#L16)
+- [equals](./../../src/Psl/Hash/equals.php#L14)
+- [hash](./../../src/Psl/Hash/hash.php#L16)
+
+#### `Classes`
+
+- [Context](./../../src/Psl/Hash/Context.php#L31)
+
+
diff --git a/docs/component/html.md b/docs/component/html.md
@@ -0,0 +1,21 @@
+<!--
+    This markdown file was generated using `docs/documenter.php`.
+
+    Any edits to it will likely be lost.
+-->
+
+[*index](./../README.md)
+
+---
+
+### `Psl\Html` Component
+
+#### `Functions`
+
+- [decode](./../../src/Psl/Html/decode.php#L23)
+- [decode_special_characters](./../../src/Psl/Html/decode_special_characters.php#L18)
+- [encode](./../../src/Psl/Html/encode.php#L27)
+- [encode_special_characters](./../../src/Psl/Html/encode_special_characters.php#L29)
+- [strip_tags](./../../src/Psl/Html/strip_tags.php#L16)
+
+