craftcms / digital-products
Sell digital product licenses with Craft Commerce
Installs: 12 832
Dependents: 2
Suggesters: 0
Security: 0
Stars: 18
Watchers: 10
Forks: 9
Type:craft-plugin
Requires
- php: ^8.2
- craftcms/cms: ^5.0.0-beta.7
- craftcms/commerce: ^5.0.0-beta.1
Requires (Dev)
- craftcms/ecs: dev-main
- craftcms/phpstan: dev-main
- craftcms/rector: dev-main
- 4.x-dev
- 4.0.2
- 4.0.1
- 4.0.0
- 3.2.3
- 3.2.2
- 3.2.1
- 3.2.0
- 3.1.0
- 3.0.x-dev
- 3.0.2
- 3.0.1
- 2.4.4.x-dev
- 2.4.3.2
- 2.4.3.1
- 2.4.3
- 2.4.2
- 2.4.1
- 2.4.0
- 2.3.1
- 2.3.0
- 2.2.4.1
- 2.2.4
- 2.2.3
- 2.2.2
- 2.2.1
- 2.2.0
- 2.1
- 2.0.4
- 2.0.3
- 2.0.2
- 2.0.1
- 2.0.0
- dev-dependabot/composer/craftcms/cms-4.4.12
- dev-dependabot/composer/guzzlehttp/psr7-2.5.0
- dev-bugfix/gc-deleted-product-with-license
- dev-testing-workflow
- dev-bugfix/price-type
This package is auto-updated.
Last update: 2024-10-10 20:42:14 UTC
README
Digital Products
This plugin makes it possible to sell licenses for digital products with Craft Commerce.
Requirements
Digital Products requires Craft 5.0.0 and Craft Commerce 5.0.0 or later.
Installation
You can install this plugin from the Plugin Store or with Composer.
From the Plugin Store
Go to the Plugin Store in your project’s Control Panel and search for “Digital Products”. Then click on the “Install” button in its modal window.
With Composer
Open your terminal and run the following commands:
# go to the project directory cd /path/to/my-project.test # tell Composer to load the plugin composer require craftcms/digital-products # tell Craft to install the plugin ./craft install/plugin digital-products
Events
The beforeSaveProductType
and afterSaveProductType
events
Plugins can be notified immediately before or after a product type is saved so your plugin can take action if needed:
use craft\digitalproducts\events\ProductTypeEvent; use craft\digitalproducts\services\ProductTypes; use yii\base\Event; // ... Event::on( ProductTypes::class, ProductTypes::EVENT_BEFORE_SAVE_PRODUCTTYPE, function(ProductTypeEvent $e) { // Custom code to be executed when a product type is saved } );
The beforeGenerateLicenseKey
event
Plugins get a chance to provide a license key instead of relying on Digital Products to generate one.
use craft\digitalproducts\elements\License; use craft\digitalproducts\events\GenerateKeyEvent; use craft\digitalproducts\Plugin as DigitalProducts; use yii\base\Event; // ... Event::on( License::class, License::EVENT_GENERATE_LICENSE_KEY, function(GenerateKeyEvent $e) { $licenseService = DigitalProducts::getInstance()->getLicenses(); do { $licenseKey = // custom key generation logic... } while (!$licenseService->isLicenseKeyUnique($licenseKey)); $e->licenseKey = $licenseKey; } );
Eager loading
Both licenses and products have several eager-loadable properties.
Licenses
product
allows you to eager-load the product associated with the license.order
allows you to eager-load the order associated with the license, if any.owner
allows you to eager-load the Craft user that owns the license, if any.
Products
existingLicenses
eager-loads all the existing licenses for the currently logged in Craft User.
Examples
Displaying the licensed product for the currently logged in Craft User.
{% if currentUser %} {% set licenses = craft.digitalProducts .licenses .owner(currentUser) .with(['product', 'order']) .all() %} <div class="panel panel-default"> <div class="panel-heading"><h3 class="panel-title">Licenses</h3></div> {% if licenses %} <table class="table"> <thead> <tr> <th>Licensed product</th> <th>License date</th> <th>Order</th> </tr> </thead> <tbody> {% for license in licenses %} <tr> <td><a href="{{ license.product.getUrl() }}"> {{ license.product.title }} </a></td> <td>{{ license.dateCreated|date('Y-m-d H:i:s') }}</td> <td> {% if license.orderId %} <a href="/store/order?number={{ license.order.number }}"> Order no. {{ license.orderId }} </a> {% endif %} </td> </tr> {% endfor %} </tbody> </table> {% endif %} {% else %} <p>Please log in first</p> {% endif %}
Checking if currently logged in user is licensed to access a product.
{% set products = craft.digitalProducts .products .type('onlineCourses') .with(['existingLicenses']) .all() %} {% if products|length %} <table class="table"> <thead> <tr> <th>Product</th> <th>License status</th> </tr> </thead> <tbody> {% for product in products %} <tr> <td>{{ product.title }}</td> <td> {% if product.existingLicenses|length %} You already own this product. {% else %} <a href="{{ product.getUrl() }}">Get it now!</a> {% endif %} </td> </tr> {% endfor %} </tbody> </table> {% endif %}
GraphQL
Digital products may be queried with GraphQL. Please read the getting started docs to get up to speed with how Craft CMS handles GraphQL requests.
The GraphQL implementation provides two query options: digitalProducts
for returning multiple products, and digitalProduct
for returning a single product.
An example query and response
Query payload
query { digitalProducts(type: "eBooks", limit: 2) { title, sku, price } }
The response
{ "data": { "digitalProducts": [ { "title": "Breaking Bad: The Recipes", "sku": "BB-TR", "price": 14.99 }, { "title": "The Clone Wars: Color The Clones", "sku": "TCW-CTC", "price": 7.95 } ] } }
The digitalProducts
/digitalProduct
query
Both the queries use the same argument set.