Версия: 6.x
burger close
Открытые члены | Поля данных | Защищенные данные
Класс ImportPhotosApi
Граф наследования:ImportPhotosApi:
BaseModel

Подробное описание

Класс предоставляет восможности по импорту фотографий из ZIP архива

Открытые члены

 __construct ()
 
 loadParams ()
 
 setParam ($key, $value)
 
 getParam ($key=null, $default=null)
 
 getCompareProductFields ()
 
 getLogUrl ($absolute=false)
 
 issetUnpackedFiles ()
 
 uploadFile ($file_arr)
 
 checkWriteRights ()
 
 extractFile ($start_pos=0)
 
 resetStatistic ()
 
 importPhoto ($start_pos, $field, $separator)
 
 cleanTemporaryDir ()
 
- Открытые члены унаследованные от BaseModel
 addError ($message, $fieldname=null, $form=null)
 
 hasError ()
 
 getErrors ()
 
 cleanErrors ()
 
 getDisplayErrors ()
 
 getErrorsStr ()
 
 getFormErrors ($form, $separator= ', ')
 
 getNonFormErrors ($separator= ', ')
 
 exportErrors ()
 
 importErrors ($data)
 

Поля данных

 $photo_api
 
 $timeout
 
 $allow_ext = ['png', 'jpg', 'gif']
 
 $zip_name = 'photos.zip'
 
 $log_rel = '/storage/tmp/importphotos/log.txt'
 
 $zip_folder
 
 $zip_folder_rel = '/storage/tmp/importphotos'
 
 $extract_folder
 
 $extract_folder_rel = '/storage/tmp/importphotos/unpack'
 
 $touch_products = []
 
 $csv_file
 
 $csv_file_rel = '/storage/tmp/importphotos/unpack/names.csv'
 
 $names_replace = []
 
 $tmp_data_file = '/data.srz'
 
- Поля данных унаследованные от BaseModel
 $form_fieldname = []
 
 $errors_by_form = []
 
 $errors_non_form = []
 
 $errors = []
 

Защищенные данные

 $data = []
 
- Защищенные данные унаследованные от BaseModel
 $default_error_fieldname = 'Информация'
 

Конструктор(ы)

__construct ( )

Методы

checkWriteRights ( )
cleanTemporaryDir ( )

Очищает временную папку (zip архив и распакованные данные) для импорта фото

Возвращает
void
extractFile (   $start_pos = 0)

Распаковывает загруженный zip файл пошагово

Аргументы
integer$start_pos- индекс файла, с которого начнется распаковка
Возвращает
bool | integer - Возвращает true, в случае полной распаковки или порядковый номер последнего распакованного файла
getCompareProductFields ( )

Возвращает список полей товара, с которыми возможно сравнение с именами файлов изображений

Возвращает
array
getLogUrl (   $absolute = false)

Возвращает относительную от корня сайта ссылку на отчет об импорте

Аргументы
bool$absolute- если true, то возвращает абсолютную ссылку
Возвращает
string
getParam (   $key = null,
  $default = null 
)

Возвращает сохраненный раннее параметр из врменного хранилища

Аргументы
string  |  null$key- ключ параметра
mixed$default- значение по умолчанию
Возвращает
mixed
importPhoto (   $start_pos,
  $field,
  $separator 
)

Импортирует распакованные фотографии пошагово

Аргументы
integer$start_pos- индекс файла, с которого начнется импорт
Возвращает
bool | integer - Возвращает true или порядковый номер последнего импортированного файла
issetUnpackedFiles ( )

Возвращает true, если имеются распакованные изображения для импорта

Возвращает
bool
loadParams ( )

Загружает временные данные, создаваемые во время выполнения импорта

Возвращает
void
resetStatistic ( )

Обнуляет информацию о процентах выполнения импорта

Возвращает
void
setParam (   $key,
  $value 
)

Записывает значение параметра во временое хранилище

Аргументы
mixed$key- ключ параметра
mixed$value- значение
Возвращает
void
uploadFile (   $file_arr)

Загружает файл во временную папку для дальнейших действий

Аргументы
mixed$file_arr

Поля

$allow_ext = ['png', 'jpg', 'gif']
$csv_file
$csv_file_rel = '/storage/tmp/importphotos/unpack/names.csv'
$data = []
protected
$extract_folder
$extract_folder_rel = '/storage/tmp/importphotos/unpack'
$log_rel = '/storage/tmp/importphotos/log.txt'
$names_replace = []
$photo_api
$timeout
$tmp_data_file = '/data.srz'
$touch_products = []
$zip_folder
$zip_folder_rel = '/storage/tmp/importphotos'
$zip_name = 'photos.zip'