DEVELOPING.md 2.57 KB
Newer Older
1 2 3 4
# Developing

Contributions to the module are welcome!

5
Issues and patches should be filed at [Drupal.org].
6 7 8

## Contributing a new image effect

9 10 11
Please note that in order to keep the codebase clean, the code for new image
effects in this module need to follow the [Drupal coding standards]. Only
patches that fulfill the PHPCS checks will be committed.
12

13 14 15
In addition, there are some specific rules for the image effects and the image
toolkit operations that need to be obeyed to keep your code reviewable and
maintainable in the future.
16 17

New effects **MUST HAVE**:
18 19 20 21 22 23 24 25 26 27
1. an entry in the `README.md` table where effects are listed, including
applicable toolkits
2. a class name (and file) that follows the `[Effect]ImageEffect` naming
convention
2. an `id` in the plugin annotation that follows the `image_effects_[effect]`
naming convention
3. an appropriate config schema entry in
`config/schema/image_effects.schema.yml`, even if the effect has no parameters
4. an implementation of `::transformDimensions` if the effect changes
height/width of the image
28
5. if the effect has parameters:
29 30 31 32 33 34 35 36 37 38 39 40
    1. an `image_effects_[effect]_summary` entry in `image_effects_theme()` in `image_effects.module`
    2. a Twig template for the effect summary under
    `templates/image-effects-[effect]-summary.html.twig`
    3. the effect form using `'#type' => 'image_effects_color'` form elements to
    capture color information where needed
    4. the effect form using the image selector plugin to capture an image file
    URL if necessary
    5. the effect form using the font selector plugin to capture a font file URL
    if necessary
    6. the effect form using `'#type' => 'image_effects_px_perc'` form elements
    to capture information that can be expressed either as an absolute number or
    as a percentage
41
6. if image toolkit operation plugins are needed:
42 43 44 45 46 47 48 49 50 51
    1. a trait with `::arguments` and `::validateArguments` if image toolkit
    operations are implemented, so that the toolkit specific code resides only
    in the `::execute` method of the operation
    2. implementations of operations for both GD and ImageMagick toolkits - if a
    toolkit cannot support the operation, the implementation should be a no-op
    returning TRUE
7. a PHPUnit functional effect test extending from `ImageEffectsTestBase`,
testing both toolkits, testing changes of size if the effect does so (both for
`::applyEffect` and `::transformDimensions`), and doing pixel level testing of
the resulting image if possible
52 53 54

[Drupal.org]: https://drupal.org/project/issues/image_effects
[Drupal coding standards]: https://www.drupal.org/docs/develop/standards