PHPackages remp/crm-print-module - PHPackages - PHPackages [Skip to content](#main-content)[PHPackages](/)[Directory](/)[Categories](/categories)[Trending](/trending)[Leaderboard](/leaderboard)[Changelog](/changelog)[Analyze](/analyze)[Collections](/collections)[Log in](/login)[Sign up](/register) 1. [Directory](/) 2. / 3. [Utility & Helpers](/categories/utility) 4. / 5. remp/crm-print-module ActiveLibrary[Utility & Helpers](/categories/utility) remp/crm-print-module ===================== CRM Print Module 4.4.0(5mo ago)011.6k—0%11MITPHPPHP ^8.1 Since Jul 31Pushed 5mo ago7 watchersCompare [ Source](https://github.com/remp2020/crm-print-module)[ Packagist](https://packagist.org/packages/remp/crm-print-module)[ Docs](https://remp2030.com)[ RSS](/packages/remp-crm-print-module/feed)WikiDiscussions master Synced 1mo ago READMEChangelog (10)DependenciesVersions (70)Used By (1) CRM Print Module ================ [](#crm-print-module) [![Translation status @ Weblate](https://camo.githubusercontent.com/6ba6851c4227c87752490fc9d5f417c68727e1313299e8b2b9c332bf8649ea13/68747470733a2f2f686f737465642e7765626c6174652e6f72672f776964676574732f72656d702d63726d2f2d2f7072696e742d6d6f64756c652f7376672d62616467652e737667)](https://hosted.weblate.org/projects/remp-crm/print-module/) The purpose of *Print module* is to give you ability to generate exports of users who should receive print version of your newspaper/magazine, keep track of which issues the user got and give you ability to create your own module on top of *Print module* to integrate with your print delivery provider. Installing module ----------------- [](#installing-module) We recommend using Composer for installation and update management. ``` composer require remp/crm-print-module ``` ### Enabling module [](#enabling-module) Add installed extension to your `app/config/config.neon` file. ``` extensions: - Crm\PrintModule\DI\PrintModuleExtension ``` Run service commands to generate CRM internals: ``` php bin/command.php phinx:migrate php bin/command.php user:generate_access php bin/command.php api:generate_access php bin/command.php application:seed ``` Configuration ------------- [](#configuration) ### Directory [](#directory) Default directory for exports, is APP\_ROOT/content/export. Directory is created automatically with first upload. You can use other buckets for uploads, but you need to define them in your config file `app/config/config.neon`: ``` services: # ... # fileManager extension - example uploads exampleExportsAdapter: League\Flysystem\Local\LocalFilesystemAdapter('%appDir%/../content/examples_exports', null) exampleExportsFileSystem: League\Flysystem\Filesystem(@exampleExportsAdapter) applicationMountManager: setup: - mountFilesystem('exampleExports', @exampleExportsFileSystem) ``` Using print module ------------------ [](#using-print-module) ### Frontend [](#frontend) Print module adds `print` address type. This address type should be use for deliveries of your newspaper/magazines. Module also adds new *content access* to the CRM called `print`. You can add this *content access* to selected *subscription types* and let your customers buy them. If user buys subscription with access to `print`, CRM will ask user to enter delivery (`print`) address after successful payment. [![Success page print address](docs/delivery_address.png)](docs/delivery_address.png) If for some reason user doesn't enter the address, she's reminded by notification to enter the missing address on every page of customer zone. Administrators are reminded by the list of all people with active print subscription with missing `print` address by widget in CRM admin. [![Enter address widget](docs/enter_address_widget.png)](docs/enter_address_widget.png) You can always replace this widget with your own implementation by overriding the default widget in your custom module: ``` public function registerLazyWidgets(\Crm\ApplicationModule\Widget\LazyWidgetManagerInterface $lazyWidgetManager) { // ... $lazyWidgetManager->overrideWidget( 'frontend.layout.top', \Crm\PrintModule\Components\EnterAddressWidget::class, \Crm\FooModule\Components\EnterAddressWidget::class, 100 ); // ... } ``` ### Backend [](#backend) As every publisher works with different delivery partner which requires data in different format, we only prepared demo command to generate CSV with list of print subscribers that should receive a print edition. It's recommended for you to create your own implementation of export command in your custom module based on this one altered to match your needs. The command uses two main concepts: - *DataSource*. This should return query containing all the subscriptions that could be used to generate CSV. In our [demo data source](./src/app/modules/PrintModule/model/Export/DailyExportDataSource.php) we select all `print` subscriptions. - *View*. This is component handling how the subscriptions are actually displayed (exported) into the CSV file. Here you can define what columns the export should have and the actual values with possibility to format them based on your needs. See [demo view](./src/app/modules/PrintModule/model/Export/DailyExportView.php) to see how the CSV is created. Command is defined in a way that export is generated two working days before the delivery - this is industry standard in our area. If your flow differs, feel free to alter this in your implementation. You can also see, that command uses `print_daily` as a *key* for *export criteria*. This is to differentiate between multiple exports as one publisher might have daily delivery of one newspaper and monthly delivery of some magazine. This *key* is identifying which export is being used. You should therefore have different generation commands for different exports. The exporting engine is automatically handling print status for every print subscriber. Each generation it flags every customer to give you information whether it's a: - *new* subscriber - she'll get the first edition - *recurrent* subscriber - she was receiving the newspaper before (e.g. the day before) and she should receive them also today - *removed* subscriber - she was receiving the newspaper before (e.g. the day before) and she is not supposed to get the newspaper today. These flags help to some delivery partners which don't need full list of subscribers every day but they require incremental changes of people who should be added to the list / removed from the list. Once generated, you can see and download the export in the CRM admin (`/print/print-subscriptions-admin/`: [![Print admin](docs/print_admin.png)](docs/print_admin.png) Components ---------- [](#components) **EnterAddressWidget** Simple widget showing warning with missing address. [![alt text](docs/address_warning.png "EnterAddressWidget")](docs/address_warning.png) [Source code](https://github.com/remp2020/crm-print-module/blob/93ebdc8168a28f5bd5e754582dae60e9159d1036/src/components/EnterAddressWidget/EnterAddressWidget.php#L1) [How to use](https://github.com/remp2020/crm-print-module/blob/93ebdc8168a28f5bd5e754582dae60e9159d1036/src/PrintModule.php#L91) **PaymentSuccessPrintWidget** Widget on subscription success page with address form. [![alt text](docs/succes_print_widget.png "PaymentSuccessPrintWidget")](docs/succes_print_widget.png) [Source code](https://github.com/remp2020/crm-print-module/blob/93ebdc8168a28f5bd5e754582dae60e9159d1036/src/components/PaymentSuccessPrintWidget/PaymentSuccessPrintWidget.php#L1) [How to use](https://github.com/remp2020/crm-print-module/blob/93ebdc8168a28f5bd5e754582dae60e9159d1036/src/PrintModule.php#L86) **RequestNotification** Address change request list widget. [![alt text](docs/address_change_request.png "RequestNotification")](docs/address_change_request.png) [Source code](https://github.com/remp2020/crm-print-module/blob/93ebdc8168a28f5bd5e754582dae60e9159d1036/src/components/RequestsNotification/RequestNotification.php#L1) [How to use](https://github.com/remp2020/crm-print-module/blob/93ebdc8168a28f5bd5e754582dae60e9159d1036/src/PrintModule.php#L81) **UserChangeAddressRequests** Listing witget with address change requests. [![alt text](docs/address_change_requests.png "UserChangeAddressRequests")](docs/address_change_requests.png) [Source code](https://github.com/remp2020/crm-print-module/blob/93ebdc8168a28f5bd5e754582dae60e9159d1036/src/components/UserChangeAddressRequests/UserChangeAddressRequests.php#L1) [How to use](https://github.com/remp2020/crm-print-module/blob/93ebdc8168a28f5bd5e754582dae60e9159d1036/src/PrintModule.php#L76) **UserPrintExport** User detail print export lising widget. [![alt text](docs/print_exports.png "UserPrintExport")](docs/print_exports.png) [Source code](https://github.com/remp2020/crm-print-module/blob/93ebdc8168a28f5bd5e754582dae60e9159d1036/src/components/UserPrintExport/UserPrintExport.php#L1) [How to use](https://github.com/remp2020/crm-print-module/blob/93ebdc8168a28f5bd5e754582dae60e9159d1036/src/PrintModule.php#L71) ### Health Score 54 — FairBetter than 97% of packages Maintenance72 Regular maintenance activity Popularity24 Limited adoption so far Community25 Small or concentrated contributor base Maturity82 Battle-tested with a long release history Bus Factor2 2 contributors hold 50%+ of commits How is this calculated?**Maintenance (25%)** — Last commit recency, latest release date, and issue-to-star ratio. Uses a 2-year decay window. **Popularity (30%)** — Total and monthly downloads, GitHub stars, and forks. Logarithmic scaling prevents top-heavy scores. **Community (15%)** — Contributors, dependents, forks, watchers, and maintainers. Measures real ecosystem engagement. **Maturity (30%)** — Project age, version count, PHP version support, and release stability. ### Release Activity Cadence Every ~34 days Recently: every ~62 days Total 69 Last Release 162d ago Major Versions 0.38.0 → 1.0.0-beta22022-02-09 0.39.0 → 1.0.02022-03-30 1.2.0 → 2.0.02022-08-25 2.11.0 → 3.0.02024-01-22 3.7.1 → 4.0.02025-04-02 PHP version history (5 changes)0.4.2PHP ^7.2 0.29.0PHP ^7.3 0.36.0PHP ^7.4 2.0.0PHP ^8.0 3.0.0PHP ^8.1 ### Community Maintainers ![](https://www.gravatar.com/avatar/7c733f9bd683c3814197d8a532b7da1ba1f631bb1efe1cde5f064feab1e24877?d=identicon)[rootpd](/maintainers/rootpd) ![](https://www.gravatar.com/avatar/a05541c0b35f43d95db5342210e1d9e64242888812d13f5b096df48b6aabd863?d=identicon)[msvitok](/maintainers/msvitok) ![](https://www.gravatar.com/avatar/2c30fdbc85cda35b94f7f59399918193a0289152281abcef344ec9ee82864177?d=identicon)[markoph](/maintainers/markoph) --- Top Contributors [![markoph](https://avatars.githubusercontent.com/u/6843562?v=4)](https://github.com/markoph "markoph (61 commits)")[![rootpd](https://avatars.githubusercontent.com/u/812909?v=4)](https://github.com/rootpd "rootpd (54 commits)")[![miroc](https://avatars.githubusercontent.com/u/1230714?v=4)](https://github.com/miroc "miroc (14 commits)")[![lubos-michalik](https://avatars.githubusercontent.com/u/63700066?v=4)](https://github.com/lubos-michalik "lubos-michalik (11 commits)")[![zoldia](https://avatars.githubusercontent.com/u/1526070?v=4)](https://github.com/zoldia "zoldia (9 commits)")[![Matefko](https://avatars.githubusercontent.com/u/22897457?v=4)](https://github.com/Matefko "Matefko (8 commits)")[![tomaj](https://avatars.githubusercontent.com/u/446736?v=4)](https://github.com/tomaj "tomaj (4 commits)")[![weblate](https://avatars.githubusercontent.com/u/1607653?v=4)](https://github.com/weblate "weblate (4 commits)")[![burithetech](https://avatars.githubusercontent.com/u/3502143?v=4)](https://github.com/burithetech "burithetech (4 commits)")[![davidkvasnovsky](https://avatars.githubusercontent.com/u/12381721?v=4)](https://github.com/davidkvasnovsky "davidkvasnovsky (3 commits)")[![nakashu](https://avatars.githubusercontent.com/u/1550659?v=4)](https://github.com/nakashu "nakashu (1 commits)") ### Embed Badge ![Health badge](/badges/remp-crm-print-module/health.svg) ``` [![Health](https://phpackages.com/badges/remp-crm-print-module/health.svg)](https://phpackages.com/packages/remp-crm-print-module) ``` ### Alternatives [lunetics/timezone-bundle A Bundle for detecting the timezone 2641.9k](/packages/lunetics-timezone-bundle)[amirbagh75/smsir-php Unofficial sms.ir PHP Package 181.2k](/packages/amirbagh75-smsir-php) PHPackages © 2026 [Directory](/)[Categories](/categories)[Trending](/trending)[Changelog](/changelog)[Analyze](/analyze)