biffbangpow/silverstripe-imagesize-validator

Validates the dimensions of an image during upload

v1.0.0 2023-08-31 12:47 UTC

Requires

• silverstripe/cms: ^4
• silverstripe/vendor-plugin: ^1.0

proprietary

• James Heathcote

README

This extends the standard upload validator and provides additional checks on the dimensions of an uploaded image.

The validator can be applied directly to an uploadfield:

    public function getCMSFields()
    {
        $fields = parent::getCMSFields();

        $fields->addFieldsToTab('Root.Main', [
            UploadField::create('Image')->setValidator(PixelSizeValidator::create()),
        ]);

        return $fields;
    }

Note: the validator should only be added to upload fields where the underlying class is an Image or subclass thereof. Adding the validator to an upload field where files may be uploaded will cause any non-images to be rejected.

By default the validator will reject an image which has a pixel dimension greater than 2000 in either axis. This can be overidden in yml config, eg:

---
Name: bbppixelsizevalidator
---

BiffBangPow\Validators\PixelSizeValidator:
  max_width: 2500
  max_height: 1200