Browse Source

Update Russian translation

tags/3.0.0-alpha1
Aleksandr 9 years ago
parent
commit
0b84863222
  1. 205
      docs/guide-ru/input-file-upload.md

205
docs/guide-ru/input-file-upload.md

@ -1,14 +1,12 @@
Загрузка файлов
===============
Загрузка файлов в Yii выполняется с помощью модели-формы, её правил валидации и некоторого кода в контроллере. Давайте
посмотрим подробнее, что необходимо для загрузки файлов.
Загрузка файлов в Yii, обычно, выполняется при помощи класса [[yii\web\UploadedFile]], который представляет каждый загруженный файл в виде объекта `UploadedFile`. Используя [[yii\widgets\ActiveForm]] и [модели](structure-models.md) можно легко создать безопасный механизм загрузки файлов.
Загрузка одного файла
---------------------
Для начала требуется создать модель, которая будет обрабатывать загрузку файлов. Создайте `models/UploadForm.php` со
следующим содержанием:
## Создание моделей <span id="creating-models"></span>
Как и в случае с обработкой текстового ввода, для загрузки файла можно создать класс модели и использовать его атрибут для хранения экземпляра объекта `UploadedFile`, содержащего параметры загруженного файла. Так же, возможно использование правил валидации модели для проверки загруженного файла. Например,
```php
namespace app\models;
@ -16,34 +14,42 @@ namespace app\models;
use yii\base\Model;
use yii\web\UploadedFile;
/**
* UploadForm is the model behind the upload form.
*/
class UploadForm extends Model
{
/**
* @var UploadedFile file attribute
* @var UploadedFile
*/
public $file;
public $imageFile;
/**
* @return array the validation rules.
*/
public function rules()
{
return [
[['file'], 'file'],
[['imageFile'], 'file', 'skipOnEmpty' => false, 'extensions' => 'png, jpg'],
];
}
public function upload()
{
if ($this->validate()) {
$this->imageFile->saveAs('uploads/' . $this->imageFile->baseName . '.' . $this->imageFile->extension);
return true;
} else {
return false;
}
}
}
```
В коде что выше, мы создали модель `UploadForm` с свойством `file`, которое станет в HTML форме `<input type="file">`.
В правилах валидации это свойство описывается правилом `file`, которое используется [[yii\validators\FileValidator|FileValidator]].
В примере выше атрибут `imageFile` используется для хранения экземпляра загруженного файла. Правило валидации `file`, которое, при помощи валидатора [[yii\validators\FileValidator]], проверяет расширение загруженного файла на соответствие с `png` или `jpg`. Метод `upload()` выполняет валидацию и сохраняет загруженный файл на сервере.
Валидатор `file` позволяет проверять расширение, размер, тип MIME и другие параметры загруженного файла. Подробности в разделе [Встроенные валидаторы](tutorial-core-validators.md#file).
> Подсказка: При загрузке изображений лучше использовать соответствующий валидатор `image`. Данный валидатор реализован классом [[yii\validators\ImageValidator]] и позволяет проверить корректность загруженного изображения при помощи [расширения Imagine](https://github.com/yiisoft/yii2-imagine).
### Вид формы
Далее создайте вид, который будет выводить форму:
## Представление <span id="rendering-file-input"></span>
Теперь можно создать представление, отображающее поле загрузки файла:
```php
<?php
@ -52,19 +58,19 @@ use yii\widgets\ActiveForm;
<?php $form = ActiveForm::begin(['options' => ['enctype' => 'multipart/form-data']]) ?>
<?= $form->field($model, 'file')->fileInput() ?>
<?= $form->field($model, 'imageFile')->fileInput() ?>
<button>Отправить</button>
<button>Submit</button>
<?php ActiveForm::end() ?>
```
`'enctype' => 'multipart/form-data'` необходимо для того, чтобы форма поддерживала отправку файлов. `fileInput()`
формирует файловый элемент формы.
Важно помнить, что для корректной загрузки файла, необходим параметр формы `enctype`. Метод `fileInput()` выведет тег `<input type="file">`, позволяющий пользователю выбрать файл для загрузки.
### Контроллер
## Загрузка <span id="wiring-up"></span>
Теперь создайте контроллер, который соединит вид формы и модель:
Теперь напишем код действия контроллера, который объединит модель и представление.
```php
namespace app\controllers;
@ -81,10 +87,10 @@ class SiteController extends Controller
$model = new UploadForm();
if (Yii::$app->request->isPost) {
$model->file = UploadedFile::getInstance($model, 'file');
if ($model->file && $model->validate()) {
$model->file->saveAs('uploads/' . $model->file->baseName . '.' . $model->file->extension);
$model->imageFile = UploadedFile::getInstance($model, 'imageFile');
if ($model->upload()) {
// file is uploaded successfully
return;
}
}
@ -93,134 +99,66 @@ class SiteController extends Controller
}
```
Вместо `model->load(...)` мы используем `UploadedFile::getInstance(...)`. Так как [[\yii\web\UploadedFile|UploadedFile]]
не запускает процесс валидации модели, а только предоставляет информацию о загруженном файле. Поэтому необходимо
произвести валидацию самостоятельно, через `$model->validate()`, которая вызовет [[yii\validators\FileValidator|FileValidator]].
Валидатор ожидает свойство, которое содержит информацию о загружаемом файле - вы это можете увидеть во внутреннем коде этого
валидатора:
```php
if (!$file instanceof UploadedFile || $file->error == UPLOAD_ERR_NO_FILE) {
return [$this->uploadRequired, []];
}
```
Если валидация пройдена успешна, то сохраняем файл:
```php
$model->file->saveAs('uploads/' . $model->file->baseName . '.' . $model->file->extension);
```
Если вы используете "basic" шаблона приложения, то директория `uploads` должна быть создана внутри `web`.
Всё. Откройте форму и попробуйте загрузить файл. Он должен загрузиться в `basic/web/uploads`.
Валидация
----------
Очень часто требуется разрешить загрузку только определённых файлов или установить обязательную загрузку. Ниже мы
рассмотрим некоторые общие настройки правила `file`.
### Обязательная загрузка файла
Если требуется обязательная загрузка файла, используйте `skipOnEmpty`:
```php
public function rules()
{
return [
[['file'], 'file', 'skipOnEmpty' => false],
];
}
```
### тип MIME
При получении данных, отправленных из формы, для создания из загруженного файла экземпляра объекта `UploadedFile`, вызывается метод [[yii\web\UploadedFile::getInstance()]]. Далее всю работу по валидации и сохранению загруженного файла на сервере берет на себя модель.
Разумно проверять тип загружаемого файла. Для этого FileValidator имеет свойство `$extensions`:
```php
public function rules()
{
return [
[['file'], 'file', 'extensions' => 'gif, jpg'],
];
}
```
## Загрузка нескольких файлов <span id="uploading-multiple-files"></span>
По-умолчанию, эта проверка будет также проверять MIME-тип данных, в соответствии с расширением. Для gif это будет
`image/gif`, для `jpg` - `image/jpeg`.
Для загрузки нескольких файлов достаточно внести в предыдущий код несколько небольших изменений.
Обратите внимание, что некоторые MIME-типы могут быть определены неверно через fileinfo, расширение PHP, которое
использует FileValidator. Например, `csv` файлы будут определены как `text/plain` вместо корректного `text/csv`.
Вы можете отключить такое поведение через установку свойства `checkExtensionByMimeType` в `false` и указать
корректный MIME-тип вручную:
Сначала нужно добавить в правило валидации `file` параметр `maxFiles` для ограничения максимального количество загружаемых одновременно файлов. Метод `upload()` нужно изменить для сохранения загруженных файлов по одному.
```php
public function rules()
{
return [
[['file'], 'file', 'checkExtensionByMimeType' => false, 'extensions' => 'csv', 'mimeTypes' => 'text/plain'],
];
}
```
[Список MIME-типов](https://ru.wikipedia.org/wiki/%D0%A1%D0%BF%D0%B8%D1%81%D0%BE%D0%BA_MIME-%D1%82%D0%B8%D0%BF%D0%BE%D0%B2#List_of_common_media_types)
### Свойства изображений
Для загрузки изображений вам может пригодиться валидатор [[yii\validators\ImageValidator|ImageValidator]]. Он проверяет
является ли файл изображением, которое затем может быть обработано или сохранено с помощью [Imagine Extension](https://github.com/yiisoft/yii2-imagine).
Загрузка нескольких файлов
------------------------
namespace app\models;
Если вам нужно загрузить несколько файлов одновременно, то необходимо внести некоторые корректировки.
В модель:
use yii\base\Model;
use yii\web\UploadedFile;
```php
class UploadForm extends Model
{
/**
* @var UploadedFile|Null file attribute
* @var UploadedFile[]
*/
public $file;
public $imageFiles;
/**
* @return array the validation rules.
*/
public function rules()
{
return [
[['file'], 'file', 'maxFiles' => 10], // <--- здесь!
[['imageFiles'], 'file', 'skipOnEmpty' => false, 'extensions' => 'png, jpg', 'maxFiles' => 4],
];
}
public function upload()
{
if ($this->validate()) {
foreach ($this->imageFiles as $file) {
$file->saveAs('uploads/' . $file->baseName . '.' . $file->extension);
}
return true;
} else {
return false;
}
}
}
```
В виде:
В представлении, в вызов метода `fileInput()`, нужно добавить параметр `multiple` для того, чтобы поле *input* позволяло выбирать несколько файлов одновременно:
```php
<?php
use yii\widgets\ActiveForm;
$form = ActiveForm::begin(['options' => ['enctype' => 'multipart/form-data']]);
?>
<?= $form->field($model, 'file[]')->fileInput(['multiple' => true]) ?>
<button>Отправить</button>
<?php $form = ActiveForm::begin(['options' => ['enctype' => 'multipart/form-data']]) ?>
<?php ActiveForm::end(); ?>
```
<?= $form->field($model, 'imageFiles[]')->fileInput(['multiple' => true, 'accept' => 'image/*']) ?>
Изменения внесены в строку
<button>Submit</button>
```php
<?= $form->field($model, 'file[]')->fileInput(['multiple' => true]) ?>
<?php ActiveForm::end() ?>
```
В контроллере:
В действии контроллера нужно заменить вызов `UploadedFile::getInstance()` на `UploadedFile::getInstances()` для присвоения атрибуту модели `imageFiles` массива объектов `UploadedFile`.
```php
namespace app\controllers;
@ -237,12 +175,10 @@ class SiteController extends Controller
$model = new UploadForm();
if (Yii::$app->request->isPost) {
$model->file = UploadedFile::getInstances($model, 'file');
if ($model->file && $model->validate()) {
foreach ($model->file as $file) {
$file->saveAs('uploads/' . $file->baseName . '.' . $file->extension);
}
$model->imageFiles = UploadedFile::getInstances($model, 'imageFiles');
if ($model->upload()) {
// file is uploaded successfully
return;
}
}
@ -250,8 +186,3 @@ class SiteController extends Controller
}
}
```
Есть два отличия в контроллере от загрузки одного файла. Во-первых используется `UploadedFile::getInstances($model, 'file');`
вместо `UploadedFile::getInstance($model, 'file');`. Первый возвратит информацию обо **всех** загруженных файлах, в то
время как, как второй вернёт информацию только об одном загруженном файле. Во-вторых отличие в том, что применяется
`foreach` для сохранения каждого файла.

Loading…
Cancel
Save