{"id":14984073,"url":"https://github.com/overblog/dataloader-bundle","last_synced_at":"2025-04-07T09:23:46.705Z","repository":{"id":16949933,"uuid":"73266322","full_name":"overblog/dataloader-bundle","owner":"overblog","description":"This bundle allows to easy use DataLoaderPHP in your Symfony project through configuration.","archived":false,"fork":false,"pushed_at":"2024-07-01T13:56:26.000Z","size":68,"stargazers_count":47,"open_issues_count":6,"forks_count":13,"subscribers_count":7,"default_branch":"master","last_synced_at":"2025-03-31T07:08:04.756Z","etag":null,"topics":["bundle","dataloader","graphql","php","symfony","symfony-bundle"],"latest_commit_sha":null,"homepage":"","language":"PHP","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/overblog.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2016-11-09T08:50:37.000Z","updated_at":"2024-12-19T23:31:49.000Z","dependencies_parsed_at":"2024-09-24T15:27:39.971Z","dependency_job_id":"0cdab1cc-e0ea-463c-a59d-8c2b78a9f1a0","html_url":"https://github.com/overblog/dataloader-bundle","commit_stats":{"total_commits":51,"total_committers":10,"mean_commits":5.1,"dds":0.6274509803921569,"last_synced_commit":"6ac3ab346fc8ae88cd964d462defc451d335a4de"},"previous_names":[],"tags_count":14,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/overblog%2Fdataloader-bundle","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/overblog%2Fdataloader-bundle/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/overblog%2Fdataloader-bundle/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/overblog%2Fdataloader-bundle/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/overblog","download_url":"https://codeload.github.com/overblog/dataloader-bundle/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":247623566,"owners_count":20968705,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["bundle","dataloader","graphql","php","symfony","symfony-bundle"],"created_at":"2024-09-24T14:08:24.537Z","updated_at":"2025-04-07T09:23:46.681Z","avatar_url":"https://github.com/overblog.png","language":"PHP","funding_links":[],"categories":[],"sub_categories":[],"readme":"# DataLoaderBundle\n\nThis bundle allows to easy use  [DataLoaderPHP](https://github.com/overblog/dataloader-php)\nin your Symfony project by  configuring it through configuration.\n\n[![Build Status](https://travis-ci.org/overblog/dataloader-bundle.svg?branch=master)](https://travis-ci.org/overblog/dataloader-bundle)\n[![Coverage Status](https://coveralls.io/repos/github/overblog/dataloader-bundle/badge.svg?branch=master)](https://coveralls.io/github/overblog/dataloader-bundle?branch=master)\n[![Latest Stable Version](https://poser.pugx.org/overblog/dataloader-bundle/version)](https://packagist.org/packages/overblog/dataloader-bundle)\n[![License](https://poser.pugx.org/overblog/dataloader-bundle/license)](https://packagist.org/packages/overblog/dataloader-bundle)\n\n## Requirements\n\nThis library requires PHP \u003e= 5.5 to work.\n\n## Installation\n\n### Download the Bundle\n\n```\ncomposer require overblog/dataloader-bundle\n```\n\n### Enable the Bundle\n\n```php\nclass AppKernel extends Kernel\n{\n    public function registerBundles()\n    {\n        $bundles = [\n            // ...\n\n            new Overblog\\DataLoaderBundle\\OverblogDataLoaderBundle(),\n        ];\n\n        // ...\n    }\n\n    // ...\n}\n```\n\n## Getting Started\n\nHere a fast example of how you can use the bundle\n\n```yaml\noverblog_dataloader:\n    defaults:\n        # required\n        promise_adapter: \"overblog_dataloader.react_promise_adapter\"\n        # optional\n        factory: ~\n        options:\n            batch: true\n            cache: true\n            max_batch_size: ~\n            cache_map: \"overblog_dataloader.cache_map\"\n            cache_key_fn: ~\n    loaders:\n        users:\n            alias: \"users_dataloader\"\n            batch_load_fn: \"@app.user:getUsers\"\n        posts: \n            batch_load_fn: \"Post::getPosts\"\n            options:\n                max_batch_size: 15\n                batch: false\n                cache: false\n                cache_map: \"app.cache.map\"\n                cache_key_fn: \"@app.cache\"\n        images:\n            factory: my_factory\n            batch_load_fn: \"Image\\\\Loader::get\"\n```\n\nThis example will create 3 loaders as services:\n- \"@overblog_dataloader.users_loader\" with alias \"@users_dataloader\"\n- \"@overblog_dataloader.posts_loader\"\n- \"@overblog_dataloader.images_loader\" create using custom factory function \"my_factory\"\n\nHere the list of existing promise adapters:\n\n* **[ReactPhp/Promise](https://github.com/reactphp/promise)**: overblog_dataloader.react_promise_adapter\n* **[GuzzleHttp/Promises](https://github.com/guzzle/promises)**: overblog_dataloader.guzzle_http_promise_adapter\n* **[Webonyx/GraphQL-PHP](https://github.com/webonyx/graphql-php) Sync Promise**: overblog_dataloader.webonyx_graphql_sync_promise_adapter\n\n## Combine with GraphQLBundle\n\nThis bundle can be use with [GraphQLBundle](https://github.com/overblog/GraphQLBundle).\nHere an example:\n\n* Bundle config\n\n```yaml\n#graphql\noverblog_graphql:\n    definitions:\n        schema:\n            query: Query\n    services:\n        promise_adapter: \"webonyx_graphql.sync_promise_adapter\"\n\n#dataloader\noverblog_dataloader:\n    defaults:\n        promise_adapter: \"overblog_dataloader.webonyx_graphql_sync_promise_adapter\"\n    loaders:\n        ships:\n            alias: \"ships_loader\"\n            batch_load_fn: \"@app.graph.ships_loader:all\"\n```\n\n* Batch loader function\n\n```yaml\nservices:\n    app.graph.ship_repository:\n        class: AppBundle\\Entity\\Repository\\ShipRepository\n        factory: [\"@doctrine.orm.entity_manager\", getRepository]\n        arguments:\n            - AppBundle\\Entity\\Ship\n\n    app.graph.ships_loader:\n        class: AppBundle\\GraphQL\\Loader\\ShipLoader\n        arguments:\n            - \"@overblog_graphql.promise_adapter\"\n            - \"@app.graph.ship_repository\"\n```\n\n```php\n\u003c?php\n\nnamespace AppBundle\\GraphQL\\Loader;\n\nuse AppBundle\\Entity\\Repository\\ShipRepository;\nuse GraphQL\\Executor\\Promise\\PromiseAdapter;\n\nclass ShipLoader\n{\n    private $promiseAdapter;\n\n    private $repository;\n\n    public function __construct(PromiseAdapter $promiseAdapter, ShipRepository $repository)\n    {\n        $this-\u003epromiseAdapter = $promiseAdapter;\n        $this-\u003erepository = $repository;\n    }\n\n    public function all(array $shipsIDs)\n    {\n        $qb = $this-\u003erepository-\u003ecreateQueryBuilder('s');\n        $qb-\u003eadd('where', $qb-\u003eexpr()-\u003ein('s.id', ':ids'));\n        $qb-\u003esetParameter('ids', $shipsIDs);\n        $ships = $qb-\u003egetQuery()-\u003egetResult();\n\n        return $this-\u003epromiseAdapter-\u003eall($ships);\n    }\n}\n```\n\n* Usage in a resolver\n\n```php\n    public function resolveShip($shipID)\n    {\n        $promise = $this-\u003econtainer-\u003eget('ships_loader')-\u003eload($shipID);\n\n        return $promise;\n    }\n```\n\nThis is an example using the sync promise adapter of Webonyx.\n\n## License\n\nOverblog/DataLoaderBundle is released under the [MIT](https://github.com/overblog/dataloader-bundle/blob/master/LICENSE) license.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Foverblog%2Fdataloader-bundle","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Foverblog%2Fdataloader-bundle","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Foverblog%2Fdataloader-bundle/lists"}