PHP Класс Craft\ImportService

Contains common import logic
См. ссылку: http://github.com/boboldehampsink
Автор: Bob Olde Hampsink ([email protected])
Наследование: extends craft\BaseApplicationComponent
Показать файл Открыть проект Примеры использования класса

Открытые свойства

Свойство Тип Описание
$customOptionPaths array Custom
$log array Save log.

Открытые методы

Метод Описание
columns ( string $file ) : array Read CSV columns.
data ( string $file ) : array Get CSV data.
debug ( array | object $settings, integer $history, integer $step )
finish ( array $settings, string $backup ) Finish importing.
getCustomOption ( string $fieldHandle ) : string Get path to fieldtype's custom
getService ( stirng $elementType ) : craft\IImportElementType | boolean Get service to use for importing.
onBeforeImportDelete ( craft\Event $event )
onImportFinish ( craft\Event $event )
onImportStart ( craft\Event $event )
prepForFieldType ( &$data, string $handle ) : mixed Prepare fields for fieldtypes.
row ( integer $row, array $data, array | object $settings ) Import row.
slugify ( string $slug ) : string Function that (almost) mimics Craft's inner slugify process.

Защищенные методы

Метод Описание
_open ( string $file ) : array Special function that handles csv delimiter detection.
getNewTagModel ( ) : craft\TagModel
saveBackup ( array $settings, string $backup, craft\UserModel $currentUser ) : string

Приватные методы

Метод Описание
prepAssetsFieldType ( string $data, craft\FieldModel $field ) : array
prepCategoriesFieldType ( string $data, craft\FieldModel $field ) : array
prepDropDownFieldType ( mixed $data, craft\FieldModel $field ) : mixed
prepEntriesFieldType ( string $data, craft\FieldModel $field ) : array
prepTagsFieldType ( string $data, craft\FieldModel $field ) : array
prepUsersFieldType ( string $data, craft\FieldModel $field ) : array
replaceOrDelete ( integer $row, array &$settings, craft\IImportElementType $service, array $fields ) : null | craft\BaseElementModel

Описание методов

_open() защищенный Метод

Special function that handles csv delimiter detection.
protected _open ( string $file ) : array
$file string
Результат array

columns() публичный Метод

Read CSV columns.
public columns ( string $file ) : array
$file string
Результат array

data() публичный Метод

Get CSV data.
public data ( string $file ) : array
$file string
Результат array

debug() публичный Метод

public debug ( array | object $settings, integer $history, integer $step )
$settings array | object
$history integer
$step integer

finish() публичный Метод

Finish importing.
public finish ( array $settings, string $backup )
$settings array
$backup string

getCustomOption() публичный Метод

Get path to fieldtype's custom
public getCustomOption ( string $fieldHandle ) : string
$fieldHandle string
Результат string

getNewTagModel() защищенный Метод

protected getNewTagModel ( ) : craft\TagModel
Результат craft\TagModel

getService() публичный Метод

Get service to use for importing.
public getService ( stirng $elementType ) : craft\IImportElementType | boolean
$elementType stirng
Результат craft\IImportElementType | boolean

onBeforeImportDelete() публичный Метод

public onBeforeImportDelete ( craft\Event $event )
$event craft\Event

onImportFinish() публичный Метод

public onImportFinish ( craft\Event $event )
$event craft\Event

onImportStart() публичный Метод

public onImportStart ( craft\Event $event )
$event craft\Event

prepForFieldType() публичный Метод

Prepare fields for fieldtypes.
public prepForFieldType ( &$data, string $handle ) : mixed
$handle string
Результат mixed

row() публичный Метод

Import row.
public row ( integer $row, array $data, array | object $settings )
$row integer
$data array
$settings array | object

saveBackup() защищенный Метод

protected saveBackup ( array $settings, string $backup, craft\UserModel $currentUser ) : string
$settings array
$backup string
$currentUser craft\UserModel
Результат string Backup filename

slugify() публичный Метод

But... we allow forward slashes to stay, so we can create full uri's.
public slugify ( string $slug ) : string
$slug string
Результат string

Описание свойств

$customOptionPaths публичное свойство

Custom
public array $customOptionPaths
Результат array

$log публичное свойство

Save log.
public array $log
Результат array