it-blaster/uploadable-behavior

The UploadableBehavior helps you handle uploaded files with Propel

UploadableBehavior

, _(*1)

The UploadableBehavior helps you handle uploaded files with Propel., _(*2)

Installation

Add it-blaster/uploadable-behavior to your composer.json file and run composer, _(*3)

...
"require": {
    "it-blaster/uploadable-behavior": "1.0.*"
}
...

Register the behavior in your config.yml, _(*4)

...
propel:
    behaviors:
        uploadable: Fenrizbes\UploadableBehavior\Behavior\UploadableBehavior
...

Usage

Add the behavior to your table:, _(*5)

...
    <behavior name="uploadable" />
</table>
...

By default it finds or creates a varchar column named file, but you can configure your own columns:, _(*6)

...
    <behavior name="uploadable">
        <parameter name="columns" value="image, document" />
    </behavior>
</table>
...

Extending

The behavior adds a few methods to the base class that help it, and you can override and extend any of them. - getUploadRoot returns an absolute path to the web directory of your project. By default it returns the most common path, but the best way is setting this path to a model in your controller. - getUploadDir returns a relative path from the root dir to the file's folder. By default it's /uploads/<model_name>/<year>/<month>/<day>. - makeFileName generates the name for the file randomly. - moveUploadedFile moves the file and sets new value to its column. If you're overriding this method, remember that it has to return a web path to the uploaded file (of course if you don't want to change its behavior)., _(*7)

Notes

Remember that this behavior handles uploaded files (moves them and sets columns' values) and does nothing more. So: - if you don't have a view transformer or overridden getters that convert string file paths to File objects, set null to the data_class option of form fields; - if you send an empty value for file field and don't want to erase column's value, handle it yourself; - if you want to have a way to delete uploaded files, do it yourself; - if you need anything else... well, you know., _(*8)