www.aleph1.co.uk Git - yaffs-website/blob - web/modules/contrib/crop/README.md

   1 # Crop module [![Build Status](https://travis-ci.org/drupal-media/crop.svg?branch=8.x-1.x)]
   2 (https://travis-ci.org/drupal-media/crop)
   3 [![Scrutinizer Code Quality](https://scrutinizer-ci.com/g/drupal-media/crop/badges/quality-score.png?b=8.x-1.x)]
   4 (https://scrutinizer-ci.com/g/drupal-media/crop/?branch=8.x-1.x)
   5
   6 Provides basic API for image cropping. This module won't do much by itself.
   7 Users should pick one of UI modules that utilize this API.
   8
   9 ## Requirements
  10
  11 * Latest dev release of Drupal 8.x.
  12
  13 ## Configuration
  14
  15 There is one configuration which can be used to prevent crop from flushing image
  16 derivatives upon save. See [Decoupled file storage](#decoupled-file-storage) for
  17 details.
  18
  19 ## Technical details
  20
  21 Initial discussion can be found on [manual crop issue queue].
  22
  23 [manual crop issue queue]: https://www.drupal.org/node/2368945
  24
  25 ### Decoupled file storage  {#decoupled-file-storage}
  26
  27 By default whenever a crop entity is saved the image_styles associated with the
  28 file entity are flushed so that Drupal will regenerate them using the updated
  29 crop information the next time they are requested. If you are manually
  30 generating your image derivatives instead of waiting for them to be generated on
  31 the fly, because you are using a cloud storage service (like S3) you can use the
  32 following code to tell not flush image_style automatically.
  33
  34 By default the `flush_derivative_images` configuration is set to `true`. To
  35 prevent image derivatives from being flushed you can use the following code:
  36 ```PHP
  37 $config['crop.settings']['flush_derivative_images'] = false;
  38 ```