trait FileValidatorSettingsTrait

Same name and namespace in other branches
  1. 11.x core/modules/file/src/Validation/FileValidatorSettingsTrait.php \Drupal\file\Validation\FileValidatorSettingsTrait

Provides a trait to create validators from settings.

Hierarchy

4 files declare their use of FileValidatorSettingsTrait
FileItem.php in core/modules/file/src/Plugin/Field/FieldType/FileItem.php
FileUpload.php in core/modules/jsonapi/src/Controller/FileUpload.php
FileUploadResource.php in core/modules/file/src/Plugin/rest/resource/FileUploadResource.php
TemporaryJsonapiFileFieldUploader.php in core/modules/jsonapi/src/Controller/TemporaryJsonapiFileFieldUploader.php

File

core/modules/file/src/Validation/FileValidatorSettingsTrait.php, line 11

Namespace

Drupal\file\Validation
View source
trait FileValidatorSettingsTrait {
  
  /**
   * Gets the upload validators for the specified settings.
   *
   * @param array $settings
   *   An associative array of settings. The following keys are supported:
   *     - max_filesize: The maximum file size in bytes. Defaults to the PHP max
   *     upload size.
   *     - file_extensions: A space-separated list of allowed file extensions.
   *
   * @return array
   *   An array suitable for passing to file_save_upload() or the file field
   *   element's '#upload_validators' property.
   */
  public function getFileUploadValidators(array $settings) : array {
    $validators = [
      // Add in our check of the file name length.
'FileNameLength' => [],
    ];
    // Cap the upload size according to the PHP limit.
    $maxFilesize = Bytes::toNumber(Environment::getUploadMaxSize());
    if (!empty($settings['max_filesize'])) {
      $maxFilesize = min($maxFilesize, Bytes::toNumber($settings['max_filesize']));
    }
    // There is always a file size limit due to the PHP server limit.
    $validators['FileSizeLimit'] = [
      'fileLimit' => $maxFilesize,
    ];
    // Add the extension check if necessary.
    if (!empty($settings['file_extensions'])) {
      $validators['FileExtension'] = [
        'extensions' => $settings['file_extensions'],
      ];
    }
    return $validators;
  }

}

Members

Title Sort descending Modifiers Object type Summary
FileValidatorSettingsTrait::getFileUploadValidators public function Gets the upload validators for the specified settings.

Buggy or inaccurate documentation? Please file an issue. Need support? Need help programming? Connect with the Drupal community.