litzinger/file-field

File Field library for ExpressionEngine 3

composer require litzinger/file-field

This is a wrapper class to generate a fully functioning file field type within the ExpressionEngine 3 control panel (or front-end). It uses the native File_ft class to generate all the necessary HTML markup and JavaScript to render a fully functioning file field anywhere in the control panel. Its ideal for usage within 3rd party add-ons that need to save images as form options., _(*1)

So why not use the native FilePicker service? Simple. It does not automatically create all of the necessary HTML and JavaScript needed to make a funtioning file field. You will need to register and maintain your own JavaScript callbacks. This class handles all of that for you because it uses the exact same code used to render the file picker in the control panel, which in turn uses the FilePicker service. By piggy backing off of the native File_ft it will render a working field in the control panel, or in a front-end channel:form tag., _(*2)

Usage

$fieldName should be the name of the form field. Can be field_id_1, or foo[something][another_thing], _(*3)

$fieldValue is the saved value in the database, usually {field_dir_1}something.png, _(*4)

$settings is an array of settings required for the native EE File_ft class, _(*5)

$fileField = new FileField($fieldName, $fieldValue, $settings);
$options .= '<div class="setting-txt"><em>Image</em></div>' . $fileField->render();

Roadmap

• Add Symfony's OptionsResolver to validate the $settings array
• Add compatibility with the Treasury field type?
• Add compatibility with the Assets field type?