From 2e83887d7d15ff826cfbc8b52472ae7c67e460ca Mon Sep 17 00:00:00 2001 From: lotyp Date: Sat, 23 Mar 2024 03:27:54 +0200 Subject: [PATCH 1/8] feat: add integrations page --- docs/en/integrations.md | 27 +++++++++++++++++++++++++++ docs/en/manifest.json | 3 ++- 2 files changed, 29 insertions(+), 1 deletion(-) create mode 100644 docs/en/integrations.md diff --git a/docs/en/integrations.md b/docs/en/integrations.md new file mode 100644 index 0000000..9af3af8 --- /dev/null +++ b/docs/en/integrations.md @@ -0,0 +1,27 @@ +# Integrations + +Cycle ORM is designed to be flexible and extensible, allowing it to integrate seamlessly with various PHP frameworks. This capability ensures developers can leverage Cycle ORM's powerful features across different environments, enhancing productivity and maintaining consistency in data management practices. Below are the currently available official and community-supported integration packages that facilitate the use of Cycle ORM within other PHP frameworks. + +## Available Integrations + +### Yii Framework + +The Yii Framework integration is officially supported through a package maintained by the [YiiSoft](https://www.yiiframework.com). This package ensures that Cycle ORM works seamlessly with Yii, providing a robust solution for managing database operations within Yii applications. + +- **GitHub Repository**: [yiisoft/yii-cycle](https://github.com/yiisoft/yii-cycle) +- **Documentation**: [Guide and Usage](https://github.com/yiisoft/yii-cycle/tree/master/docs/guide/en) + +### Laravel Framework + +For Laravel developers, the Laravel Cycle ORM Adapter offers a convenient way to integrate Cycle ORM into Laravel projects. This package is managed by the [WayOfDev organization](https://github.com/wayofdev) and aims to bridge the gap between Cycle ORM and Laravel's ecosystem, providing a cohesive and efficient database management experience. + +- **GitHub Repository**: [wayofdev/laravel-cycle-orm-adapter](https://github.com/wayofdev/laravel-cycle-orm-adapter) +- **Documentation**: [Setup and Configuration](https://laravel-cycle-orm-adapter.wayof.dev) + +## Contributing + +Cycle ORM's integration ecosystem is continuously evolving, thanks to the contributions from the community. If you have developed an integration package for Cycle ORM or wish to contribute to existing packages, we encourage you to share your work with the community. For more information on contributing, please refer to our [contribution guidelines](/docs/en/contributing.md). + +## Support + +For questions, issues, or support regarding Cycle ORM and its integrations, please visit our [GitHub Issues](https://github.com/cycle/orm/issues) page or join our [Discord community](https://discord.gg/TFeEmCs). Our community and maintainers are always ready to help you get the most out of Cycle ORM. diff --git a/docs/en/manifest.json b/docs/en/manifest.json index 526a8fe..958c514 100644 --- a/docs/en/manifest.json +++ b/docs/en/manifest.json @@ -9,7 +9,8 @@ "contributing": "Contributing", "issue-test-case": "Issue with Test Case", "intro/semver": "Versioning", - "license": "LICENSE" + "license": "LICENSE", + "integrations": "Integrations" } }, { From 296ebf27761cce5a102afc593c197a3db5c74ad0 Mon Sep 17 00:00:00 2001 From: lotyp Date: Sat, 23 Mar 2024 03:50:50 +0200 Subject: [PATCH 2/8] docs: mention spiral framework --- docs/en/integrations.md | 12 ++++++++++-- 1 file changed, 10 insertions(+), 2 deletions(-) diff --git a/docs/en/integrations.md b/docs/en/integrations.md index 9af3af8..4ea693c 100644 --- a/docs/en/integrations.md +++ b/docs/en/integrations.md @@ -1,9 +1,17 @@ # Integrations -Cycle ORM is designed to be flexible and extensible, allowing it to integrate seamlessly with various PHP frameworks. This capability ensures developers can leverage Cycle ORM's powerful features across different environments, enhancing productivity and maintaining consistency in data management practices. Below are the currently available official and community-supported integration packages that facilitate the use of Cycle ORM within other PHP frameworks. +Cycle ORM is designed to be flexible and extensible, allowing it to integrate seamlessly with various PHP frameworks. This capability ensures developers can leverage Cycle ORM's powerful features across different environments, enhancing productivity and maintaining consistency in data management practices. Below are the currently available official and community-supported integration packages that facilitate the use of Cycle ORM within other PHP frameworks, including its official integration with the Spiral framework. ## Available Integrations +### Spiral Framework + +Cycle ORM serves as the official ORM for the Spiral framework, supported by the `spiral/cycle-bridge` package. This integration is optimized for Spiral applications, ensuring compatibility and performance, especially with the [Roadrunner](https://roadrunner.dev) server for long-running applications. + +- **GitHub Repository**: [spiral/cycle-bridge](https://github.com/spiral/cycle-bridge) +- **Documentation**: [Spiral Framework Integration](https://spiral.dev/docs/basics-orm) +- **Maintained By**: [SpiralScout](https://spiralscout.com) + ### Yii Framework The Yii Framework integration is officially supported through a package maintained by the [YiiSoft](https://www.yiiframework.com). This package ensures that Cycle ORM works seamlessly with Yii, providing a robust solution for managing database operations within Yii applications. @@ -13,7 +21,7 @@ The Yii Framework integration is officially supported through a package maintain ### Laravel Framework -For Laravel developers, the Laravel Cycle ORM Adapter offers a convenient way to integrate Cycle ORM into Laravel projects. This package is managed by the [WayOfDev organization](https://github.com/wayofdev) and aims to bridge the gap between Cycle ORM and Laravel's ecosystem, providing a cohesive and efficient database management experience. +For Laravel developers seeking a DataMapper ORM solution, the Laravel Cycle ORM Adapter provides an essential bridge. Managed by the [WayOfDev Organization](https://github.com/wayofdev), this package seamlessly integrates Cycle ORM into Laravel projects. It addresses the framework's absence of a native DataMapper type ORM, offering a comprehensive and efficient database management experience that complements Laravel's ecosystem. - **GitHub Repository**: [wayofdev/laravel-cycle-orm-adapter](https://github.com/wayofdev/laravel-cycle-orm-adapter) - **Documentation**: [Setup and Configuration](https://laravel-cycle-orm-adapter.wayof.dev) From 27d73dd4fdca69ab69407cc7cf6f8c9b6e109af7 Mon Sep 17 00:00:00 2001 From: Andrij Orlenko <94047334+lotyp@users.noreply.github.com> Date: Tue, 26 Mar 2024 16:50:02 +0200 Subject: [PATCH 3/8] Update docs/en/integrations.md Co-authored-by: Maxim Smakouz --- docs/en/integrations.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/en/integrations.md b/docs/en/integrations.md index 4ea693c..1dffbfe 100644 --- a/docs/en/integrations.md +++ b/docs/en/integrations.md @@ -6,7 +6,7 @@ Cycle ORM is designed to be flexible and extensible, allowing it to integrate se ### Spiral Framework -Cycle ORM serves as the official ORM for the Spiral framework, supported by the `spiral/cycle-bridge` package. This integration is optimized for Spiral applications, ensuring compatibility and performance, especially with the [Roadrunner](https://roadrunner.dev) server for long-running applications. +Cycle ORM serves as the official ORM for the Spiral framework, supported by the `spiral/cycle-bridge` package. This integration is optimized for Spiral applications, ensuring compatibility and performance, especially with the [RoadRunner](https://roadrunner.dev) server for long-running applications. - **GitHub Repository**: [spiral/cycle-bridge](https://github.com/spiral/cycle-bridge) - **Documentation**: [Spiral Framework Integration](https://spiral.dev/docs/basics-orm) From b43ea91321b6e6978f88ea85c7c3e08ecf9cc963 Mon Sep 17 00:00:00 2001 From: lotyp Date: Tue, 26 Mar 2024 16:54:35 +0200 Subject: [PATCH 4/8] fix: move integrations into intro section --- docs/en/{ => intro}/integrations.md | 0 docs/en/manifest.json | 4 ++-- 2 files changed, 2 insertions(+), 2 deletions(-) rename docs/en/{ => intro}/integrations.md (100%) diff --git a/docs/en/integrations.md b/docs/en/intro/integrations.md similarity index 100% rename from docs/en/integrations.md rename to docs/en/intro/integrations.md diff --git a/docs/en/manifest.json b/docs/en/manifest.json index 958c514..b8637d9 100644 --- a/docs/en/manifest.json +++ b/docs/en/manifest.json @@ -5,12 +5,12 @@ "readme": "Table of Contents", "intro/about": "About Cycle ORM", "intro/install": "Installation", + "intro/integrations": "Integrations", "intro/upgrade": "Upgrade Guide", "contributing": "Contributing", "issue-test-case": "Issue with Test Case", "intro/semver": "Versioning", - "license": "LICENSE", - "integrations": "Integrations" + "license": "LICENSE" } }, { From 9b277f3f365d9c8737e12095b438a237ecb599e7 Mon Sep 17 00:00:00 2001 From: Andrij Orlenko <94047334+lotyp@users.noreply.github.com> Date: Thu, 28 Mar 2024 19:47:09 +0200 Subject: [PATCH 5/8] chore: update docs/en/intro/integrations.md Co-authored-by: Aleksei Gagarin --- docs/en/intro/integrations.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/en/intro/integrations.md b/docs/en/intro/integrations.md index 1dffbfe..47cb448 100644 --- a/docs/en/intro/integrations.md +++ b/docs/en/intro/integrations.md @@ -12,7 +12,7 @@ Cycle ORM serves as the official ORM for the Spiral framework, supported by the - **Documentation**: [Spiral Framework Integration](https://spiral.dev/docs/basics-orm) - **Maintained By**: [SpiralScout](https://spiralscout.com) -### Yii Framework +## Yii 3 The Yii Framework integration is officially supported through a package maintained by the [YiiSoft](https://www.yiiframework.com). This package ensures that Cycle ORM works seamlessly with Yii, providing a robust solution for managing database operations within Yii applications. From 10310aef191526e5561956ea99e241045d391579 Mon Sep 17 00:00:00 2001 From: Andrij Orlenko <94047334+lotyp@users.noreply.github.com> Date: Thu, 28 Mar 2024 19:47:26 +0200 Subject: [PATCH 6/8] chore: update docs/en/intro/integrations.md Co-authored-by: Aleksei Gagarin --- docs/en/intro/integrations.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/en/intro/integrations.md b/docs/en/intro/integrations.md index 47cb448..66d2148 100644 --- a/docs/en/intro/integrations.md +++ b/docs/en/intro/integrations.md @@ -4,7 +4,7 @@ Cycle ORM is designed to be flexible and extensible, allowing it to integrate se ## Available Integrations -### Spiral Framework +## Spiral Cycle ORM serves as the official ORM for the Spiral framework, supported by the `spiral/cycle-bridge` package. This integration is optimized for Spiral applications, ensuring compatibility and performance, especially with the [RoadRunner](https://roadrunner.dev) server for long-running applications. From 8abbbc3a1746229eab51765015c9829e126006f7 Mon Sep 17 00:00:00 2001 From: Andrij Orlenko <94047334+lotyp@users.noreply.github.com> Date: Thu, 28 Mar 2024 19:47:40 +0200 Subject: [PATCH 7/8] chore: update docs/en/intro/integrations.md Co-authored-by: Aleksei Gagarin --- docs/en/intro/integrations.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/en/intro/integrations.md b/docs/en/intro/integrations.md index 66d2148..77779fb 100644 --- a/docs/en/intro/integrations.md +++ b/docs/en/intro/integrations.md @@ -19,7 +19,7 @@ The Yii Framework integration is officially supported through a package maintain - **GitHub Repository**: [yiisoft/yii-cycle](https://github.com/yiisoft/yii-cycle) - **Documentation**: [Guide and Usage](https://github.com/yiisoft/yii-cycle/tree/master/docs/guide/en) -### Laravel Framework +## Laravel For Laravel developers seeking a DataMapper ORM solution, the Laravel Cycle ORM Adapter provides an essential bridge. Managed by the [WayOfDev Organization](https://github.com/wayofdev), this package seamlessly integrates Cycle ORM into Laravel projects. It addresses the framework's absence of a native DataMapper type ORM, offering a comprehensive and efficient database management experience that complements Laravel's ecosystem. From 80f654da41bb93d5caafd46e796115422d5e8fee Mon Sep 17 00:00:00 2001 From: Andrij Orlenko <94047334+lotyp@users.noreply.github.com> Date: Thu, 28 Mar 2024 19:48:02 +0200 Subject: [PATCH 8/8] chore: update docs/en/intro/integrations.md Co-authored-by: Aleksei Gagarin --- docs/en/intro/integrations.md | 2 -- 1 file changed, 2 deletions(-) diff --git a/docs/en/intro/integrations.md b/docs/en/intro/integrations.md index 77779fb..4a90fac 100644 --- a/docs/en/intro/integrations.md +++ b/docs/en/intro/integrations.md @@ -2,8 +2,6 @@ Cycle ORM is designed to be flexible and extensible, allowing it to integrate seamlessly with various PHP frameworks. This capability ensures developers can leverage Cycle ORM's powerful features across different environments, enhancing productivity and maintaining consistency in data management practices. Below are the currently available official and community-supported integration packages that facilitate the use of Cycle ORM within other PHP frameworks, including its official integration with the Spiral framework. -## Available Integrations - ## Spiral Cycle ORM serves as the official ORM for the Spiral framework, supported by the `spiral/cycle-bridge` package. This integration is optimized for Spiral applications, ensuring compatibility and performance, especially with the [RoadRunner](https://roadrunner.dev) server for long-running applications.