Yandex.Market YML Module for Yii2
Yii2 module for automatically generation Yandex.Market YML.
Installation
The preferred way to install this extension is through composer.
- Either run
php composer.phar require --prefer-dist "corpsepk/yii2-yandex-market-yml" "~0.7"
or add
"corpsepk/yii2-yandex-market-yml" : "~0.7"to the require section of your application's composer.json file.
Configure config
Configure the cache component of your application's configuration file, for example:
'components' => [
'cache' => [
'class' => 'yii\caching\FileCache',
],
]Add a new module in modules section of your application's configuration file, for example:
'modules' => [
'YandexMarketYml' => [
'class' => 'corpsepk\yml\YandexMarketYml',
'cacheExpire' => 1, // 1 second. Default is 24 hours
'categoryModel' => 'app\models\Category',
'shopOptions' => [
'name' => 'MyCompanyName',
'company' => 'LTD MyCompanyName',
'url' => 'http://example.com',
'currencies' => [
[
'id' => 'RUR',
'rate' => 1
]
],
],
'offerModels' => [
['class' => 'app\models\Item'],
],
],
],Add a new rule for urlManager of your application's configuration file, for example:
'urlManager' => [
'rules' => [
['pattern' => 'yandex-market', 'route' => 'YandexMarketYml/default/index', 'suffix' => '.yml'],
],
],Configure Category model
https://yandex.ru/support/partnermarket/elements/categories.html
Add behavior in the AR category model, for example:
use corpsepk\yml\behaviors\YmlCategoryBehavior;
public function behaviors()
{
return [
'ymlCategory' => [
'class' => YmlCategoryBehavior::className(),
'scope' => function ($model) {
/** @var \yii\db\ActiveQuery $model */
$model->select(['id', 'name', 'parent_id']);
},
'dataClosure' => function ($model) {
/** @var self $model */
return [
'id' => $model->id,
'name' => $model->name,
'parentId' => $model->parent_id
];
}
],
];
}Configure Offer models
Add behavior in the AR models, for example:
use corpsepk\yml\behaviors\YmlOfferBehavior;
use corpsepk\yml\models\Offer;
public function behaviors()
{
return [
'ymlOffer' => [
'class' => YmlOfferBehavior::className(),
'scope' => function ($model) {
/** @var \yii\db\ActiveQuery $model */
$model->andWhere(['is_deleted' => false]);
},
'dataClosure' => function ($model) {
/** @var self $model */
return new Offer([
'id' => $model->id,
'url' => $model->getUrl(true), // absolute url e.g. http://example.com/item/1256
'price' => $model->getPrice(),
'currencyId' => 'RUR',
'categoryId' => $model->category_id,
'picture' => $model->cover ? $model->cover->getUrl() : null,
/**
* Or as array
* don't forget that yandex-market accepts 10 pictures max
* @see https://yandex.ru/support/partnermarket/picture.xml
*/
'picture' => ArrayHelper::map($model->images, 'id', function ($image) {
return $image->getUrl();
}),
'name' => $model->name,
'vendor' => $model->brand ? $model->brand->name : null,
'description' => $model->description,
'customElements' => [
[
'outlets' => '<outlet id="1" instock="30" />'
]
],
]);
}
],
];
}Testing
docker-compose -f tests/docker-compose.yml run --rm php56 phpunitor
docker-compose -f tests/docker-compose.yml up --build -d
docker exec -it tests_php56_1 sh
phpunitHowto
Use console command to build yml
Useful links
Yandex XML validator - https://webmaster.yandex.ru/tools/xml-validator/