Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs: readme #131

Merged
merged 1 commit into from
Jul 22, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
16 changes: 14 additions & 2 deletions packages/collections-common/composer.json
Original file line number Diff line number Diff line change
@@ -1,13 +1,25 @@
{
"name": "rekalogika/collections-common",
"description": "",
"description": "Common library required by other components of the rekalogika/collections library",
"license": "MIT",
"type": "library",
"keywords": [
"domain",
"collections",
"doctrine",
"pagination"
"pagination",
"orm",
"recollection",
"minimalrecollection",
"count",
"precounting",
"extra-lazy",
"rekapager",
"keyset-pagination",
"cursor-pagination",
"batch",
"batch-processing",
"repository"
],
"authors": [
{
Expand Down
15 changes: 2 additions & 13 deletions packages/collections-contracts/README.md
Original file line number Diff line number Diff line change
@@ -1,17 +1,6 @@
# rekalogika/collections-domain
# rekalogika/collections-contracts

Transforms a Doctrine `Collection` object into our `Recollection` object, which
extends `Collection` itself but also extends `PageableInterface` from our
`rekalogika/rekapager` library.

The features include:

* Safeguards against potential out-of-memory situations.
* Pluggable counting strategies.
* Keyset pagination for batch processing and user interfaces.

The classes also available in the minimal flavor, which only exposes the safe
methods, those which won't trigger full load of an extra-lazy collection.
Interfaces and nominal classes for the `rekalogika/collections` library.

## Documentation

Expand Down
16 changes: 14 additions & 2 deletions packages/collections-contracts/composer.json
Original file line number Diff line number Diff line change
@@ -1,13 +1,25 @@
{
"name": "rekalogika/collections-contracts",
"description": "",
"description": "Interfaces and nominal classes for the rekalogika/collections library.",
"license": "MIT",
"type": "library",
"keywords": [
"domain",
"collections",
"doctrine",
"pagination"
"pagination",
"orm",
"recollection",
"minimalrecollection",
"count",
"precounting",
"extra-lazy",
"rekapager",
"keyset-pagination",
"cursor-pagination",
"batch",
"batch-processing",
"repository"
],
"authors": [
{
Expand Down
25 changes: 21 additions & 4 deletions packages/collections-domain/README.md
Original file line number Diff line number Diff line change
@@ -1,11 +1,28 @@
# Rekalogika Collections Domain
# rekalogika/collections-domain

TBD
Transforms a Doctrine `Collection` object into our `Recollection` object, which
extends `Collection` itself but also extends `PageableInterface` from our
`rekalogika/rekapager` library.

The features include:

* Safeguards against potential out-of-memory situations.
* Pluggable counting strategies.
* Keyset pagination for batch processing and user interfaces.

The classes also available in the minimal flavor, which only exposes the safe
methods, those which won't trigger full load of an extra-lazy collection.

## Documentation

TBD
[rekalogika.dev/collections](https://rekalogika.dev/collections)

## License

MIT
MIT

## Contributing

This library consists of multiple repositories split from a monorepo. Be sure to
submit issues and pull requests to the
[rekalogika/collections](https://github.com/rekalogika/collections) monorepo.
16 changes: 14 additions & 2 deletions packages/collections-domain/composer.json
Original file line number Diff line number Diff line change
@@ -1,13 +1,25 @@
{
"name": "rekalogika/collections-domain",
"description": "Improves Doctrine Collections usage in your domain entities.",
"description": "Transforms a Doctrine Collection object into our Recollection object, which extends Collection itself but also extends PageableInterface from our rekalogika/rekapager library.",
"license": "MIT",
"type": "library",
"keywords": [
"domain",
"collections",
"doctrine",
"pagination"
"pagination",
"orm",
"recollection",
"minimalrecollection",
"count",
"precounting",
"extra-lazy",
"rekapager",
"keyset-pagination",
"cursor-pagination",
"batch",
"batch-processing",
"repository"
],
"authors": [
{
Expand Down
8 changes: 4 additions & 4 deletions packages/collections-orm/README.md
Original file line number Diff line number Diff line change
@@ -1,9 +1,9 @@
# rekalogika/collections-orm

A collection class using Doctrine ORM `QueryBuilder` as the data source. Unlike
doing the query in the traditional way, this class allows lazy loading. You can
safely pass the object around, and it will only execute the query when you start
getting items from it.
Lazy-loading collection class using Doctrine ORM `QueryBuilder` as the data
source. Unlike doing the query in the traditional way, this class allows lazy
loading. You can safely pass the object around, and it will only execute the
query when you start getting items from it.

The class also implements the `PageableInterface` from the
[`rekalogika/rekapager`](https://rekalogika.dev/rekapager) library. This allows
Expand Down
16 changes: 14 additions & 2 deletions packages/collections-orm/composer.json
Original file line number Diff line number Diff line change
@@ -1,13 +1,25 @@
{
"name": "rekalogika/collections-orm",
"description": "Supercharged query-backed Doctrine Collection.",
"description": "Lazy-loading collection class using Doctrine ORM QueryBuilder as the data source",
"license": "MIT",
"type": "library",
"keywords": [
"domain",
"collections",
"doctrine",
"pagination"
"pagination",
"orm",
"recollection",
"minimalrecollection",
"count",
"precounting",
"extra-lazy",
"rekapager",
"keyset-pagination",
"cursor-pagination",
"batch",
"batch-processing",
"repository"
],
"authors": [
{
Expand Down