Skip to content

Commit

Permalink
DDST-166: Update readme
Browse files Browse the repository at this point in the history
  • Loading branch information
bibliophileaxe committed Jun 4, 2024
1 parent bdaea81 commit 9759f52
Show file tree
Hide file tree
Showing 2 changed files with 17 additions and 0 deletions.
1 change: 1 addition & 0 deletions dgi_actions.module
Original file line number Diff line number Diff line change
Expand Up @@ -49,3 +49,4 @@ function dgi_actions_entity_delete(EntityInterface $entity) {
$utils = \Drupal::service('dgi_actions.dgiutils');
$utils->executeEntityReactions(EntityDeleteReaction::class, $entity);
}

16 changes: 16 additions & 0 deletions modules/dgi_actions_handle/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -16,6 +16,22 @@ Install as usual, see
[this](https://www.drupal.org/docs/extending-drupal/installing-modules) for
further information.

## Features

- Provides Action Plugins for minting and deleting Handle.net Handles.
- Provides a service data type plugin for Handle.net Handles.
- Uses uuid by default as handle suffix. Also supports custom suffixes.
- Adds a unique constraint to the configured handle suffix field in an entity.
- Prevents changes to the suffix field of a node.
- Makes the suffix field non-editable if it has a value when editing a node.

## Usage
- See DGI Actions readme for general usage.
- Create a new service data type with the type `handle`.
- There is no UI for configuring the handle suffix field. It must be set in the
configuration file. The default suffix field is `uuid`.
- Once the suffix field is set, the module will add a unique constraint to the
field in the entity schema and make sure that the field value is not changed.

## Troubleshooting/Issues

Expand Down

0 comments on commit 9759f52

Please sign in to comment.