Download the PHP package dkhlystov/yii2-uploadimage without Composer
On this page you can find all versions of the php package dkhlystov/yii2-uploadimage. It is possible to download/install these versions without Composer. Possible dependencies are resolved automatically.
Informations about the package yii2-uploadimage
Installation
The preferred way to install this extension is through composer.
Either run
or add
to the require section of your composer.json
file.
Usage
For using widget at first you need to add dkhlystov\uploadimage\Module
to your application config:
Single image
Upload single image to model attribute:
With ActiveForm
:
If thumbnail needed:
Multiple images
Upload multiple images as array to model attribute. Property fileKey
is required:
If you need to create thumbnail use thumbKey
property. To limit image count use maxCount
property.
Widget size
Default size of every item in widget is 112×84. If you want to render widget with other size use width
and height
properties.
Maximum image size
All images will be optimized while uploading. By default maximun width of uploaded image is 1000 and heigh is 750. To change this values use maxImageWidth
and maxImageHeight
properties.
Thumbnail size
When thumbnails uses, its size is similar to widget item size. To change it, use thumbWidth
and thumbHeight
properties.
Adding extra data
Use data
property to add extra data to every image item in widget. You can use simple array or Closure
for this property:
Custom buttons support
For working with buttons there are two steps: at first you should to declare buttons on server-side, and then you need to handle events from buttons on client-side.
server-side
To add custom buttons use buttons
property. This is array where key is button identifier and value is buttons configuration.
Button configuration:
label
string that will be rendered as button label, requiredtitle
string that added to title attribute of buttonactive
if set to true, button will be rendered in active state
If property sets as Closure
, $item
parameter is item for which the buttons are rendered. For new uploaded images $item
is null.
Note that you can use Font Awesome icons, because its in reqirements and will be installed automatically.
client-side
In your javascript attach handler for ui-btnclick
event to widget. In handler there are id
, item
and other
parameters, that represents API for working with widget items.
id
button identifier.ui.item
current item management object.ui.other
data management object for all items, except current.
Data management:
item.button(id)
returnjQuery
object of button with specifiedid
item.data(name)
return value of item data with specifiedname
.item.data(name, value)
set item data value with specifiedname
.item.data({name1: value1, ...})
set multiple data values.
Other properties
By default, all images will be uploaded to /upload
directory in your web root. If you want to change it, use uploadPath
property. To set this path globally use uploadPath
property in application module.
To restrict the size of files uploaded by user, use maxFileSize
property. Set in megabytes. To set its globally use maxFileSize
property in application module.
You can change image quality (for JPEG only) by setting quality
property. Default quality is 80.
You can specify custom error messages with proprties:
messageMaxFileSize
shows when size of the uploading files exeedsmaxFileSize
.messageMaxCount
shows when user try to upload more files then inmaxCount
specified.messageFormat
shows when the format of uploaded files is not supported.messageOther
shows when other error occured.
Every message may contain {files}
substring, that will be replaced by actual files.
All versions of yii2-uploadimage with dependencies
bower-asset/font-awesome Version 5.5.*
dkhlystov/yii2-imagefile Version *