function FileWidget::formElement

Overrides WidgetInterface::formElement

File

core/modules/file/src/Plugin/Field/FieldWidget/FileWidget.php, line 212

Class

FileWidget

Plugin implementation of the 'file_generic' widget.

Namespace

Code

public function formElement(FieldItemListInterface $items, $delta, array $element, array &$form, FormStateInterface $form_state) {
    $field_settings = $this->getFieldSettings();
    // The field settings include defaults for the field type. However, this
    // widget is a base class for other widgets (e.g., ImageWidget) that may act
    // on field types without these expected settings.
    $field_settings += [
        'display_default' => NULL,
        'display_field' => NULL,
        'description_field' => NULL,
    ];
    $cardinality = $this->fieldDefinition
        ->getFieldStorageDefinition()
        ->getCardinality();
    $defaults = [
        'fids' => [],
        'display' => (bool) $field_settings['display_default'],
        'description' => '',
    ];
    // Essentially we use the managed_file type, extended with some
    // enhancements.
    $element_info = $this->elementInfo
        ->getInfo('managed_file');
    $element += [
        '#type' => 'managed_file',
        '#upload_location' => $items[$delta]->getUploadLocation(),
        '#upload_validators' => $items[$delta]->getUploadValidators(),
        '#value_callback' => [
            static::class,
            'value',
        ],
        '#process' => array_merge($element_info['#process'], [
            [
                static::class,
                'process',
            ],
        ]),
        '#progress_indicator' => $this->getSetting('progress_indicator'),
        // Allows this field to return an array instead of a single value.
'#extended' => TRUE,
        // Add properties needed by value() and process() methods.
'#field_name' => $this->fieldDefinition
            ->getName(),
        '#entity_type' => $items->getEntity()
            ->getEntityTypeId(),
        '#display_field' => (bool) $field_settings['display_field'],
        '#display_default' => $field_settings['display_default'],
        '#description_field' => $field_settings['description_field'],
        '#cardinality' => $cardinality,
    ];
    $element['#weight'] = $delta;
    // Field stores FID value in a single mode, so we need to transform it for
    // form element to recognize it correctly.
    if (!isset($items[$delta]->fids) && isset($items[$delta]->target_id)) {
        $items[$delta]->fids = [
            $items[$delta]->target_id,
        ];
    }
    $element['#default_value'] = $items[$delta]->getValue() + $defaults;
    $default_fids = $element['#extended'] ? $element['#default_value']['fids'] : $element['#default_value'];
    if (empty($default_fids)) {
        $file_upload_help = [
            '#theme' => 'file_upload_help',
            '#description' => $element['#description'],
            '#upload_validators' => $element['#upload_validators'],
            '#cardinality' => $cardinality,
        ];
        $element['#description'] = \Drupal::service('renderer')->renderPlain($file_upload_help);
        $element['#multiple'] = $cardinality != 1 ? TRUE : FALSE;
        if ($cardinality != 1 && $cardinality != -1) {
            $element['#element_validate'] = [
                [
                    static::class,
                    'validateMultipleCount',
                ],
            ];
        }
    }
    return $element;
}