HOME

<?php
/**
 * @file classes/components/form/FieldUploadImage.php
 *
 * Copyright (c) 2014-2021 Simon Fraser University
 * Copyright (c) 2000-2021 John Willinsky
 * Distributed under the GNU GPL v3. For full terms see the file docs/COPYING.
 *
 * @class FieldUploadImage
 *
 * @ingroup classes_controllers_form
 *
 * @brief A field for uploading a file.
 */

namespace PKP\components\forms;

class FieldUploadImage extends FieldUpload
{
    /** @copydoc Field::$component */
    public $component = 'field-upload-image';

    /** @var string Base url for displaying the image */
    public $baseUrl = '';

    /** @var string Label for the alt text field */
    public $altTextLabel = '';

    /** @var string Description for the alt text field */
    public $altTextDescription = '';

    /** @var string Description for the image thumbnail */
    public $thumbnailDescription = '';

    /**
     * @copydoc Field::getConfig()
     */
    public function getConfig()
    {
        if (!array_key_exists('acceptedFiles', $this->options)) {
            $this->options['acceptedFiles'] = 'image/*';
        }
        $config = parent::getConfig();
        $config['baseUrl'] = $this->baseUrl;

        $config['thumbnailDescription'] = __('common.upload.thumbnailPreview');
        $config['altTextLabel'] = __('common.altText');
        $config['altTextDescription'] = __('common.altTextInstructions');

        return $config;
    }

    /**
     * @copydoc Field::getEmptyValue()
     */
    public function getEmptyValue()
    {
        return null;
    }
}