Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/bukashk0zzz/ymlgenerator
YML (Yandex Market Language) file generator
https://github.com/bukashk0zzz/ymlgenerator
yandex yandex-market yandex-market-language yml
Last synced: 4 days ago
JSON representation
YML (Yandex Market Language) file generator
- Host: GitHub
- URL: https://github.com/bukashk0zzz/ymlgenerator
- Owner: Bukashk0zzz
- License: mit
- Created: 2016-10-15T20:30:50.000Z (almost 8 years ago)
- Default Branch: master
- Last Pushed: 2024-09-05T10:33:54.000Z (28 days ago)
- Last Synced: 2024-09-29T23:03:07.393Z (4 days ago)
- Topics: yandex, yandex-market, yandex-market-language, yml
- Language: PHP
- Homepage:
- Size: 110 KB
- Stars: 113
- Watchers: 8
- Forks: 65
- Open Issues: 7
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# YML (Yandex Market Language) file generator
[](https://codecov.io/github/Bukashk0zzz/YmlGenerator)
[](https://packagist.org/packages/Bukashk0zzz/yml-generator)
[](https://packagist.org/packages/Bukashk0zzz/yml-generator)
[](https://packagist.org/packages/Bukashk0zzz/yml-generator)
About
-----
[YML (Yandex Market Language)](https://yandex.ru/support/webmaster/goods-prices/technical-requirements.xml) generator.
Uses standard XMLWriter for generating YML file.
Not required any other library you just need PHP 5.5.0 or >= version.
Generator supports this offer types:
- OfferCustom [(vendor.model)](https://yandex.ru/support/webmaster/goods-prices/technical-requirements.xml#vendor-model)
- OfferBook [(book)](https://yandex.ru/support/webmaster/goods-prices/technical-requirements.xml#book)
- OfferAudiobook [(audiobook)](https://yandex.ru/support/webmaster/goods-prices/technical-requirements.xml#audiobook)
- OfferArtistTitle [(artist.title)](https://yandex.ru/support/webmaster/goods-prices/technical-requirements.xml#artist-title)
- OfferTour [(tour)](https://yandex.ru/support/webmaster/goods-prices/technical-requirements.xml#tour)
- OfferEventTicket [(event-ticket)](https://yandex.ru/support/webmaster/goods-prices/technical-requirements.xml#event-ticket)
- OfferSimple [(empty)](https://yandex.ru/support/webmaster/goods-prices/technical-requirements.xml#base)
Installation
------------
Run composer require
```bash
composer require bukashk0zzz/yml-generator
```
Or add this to your `composer.json` file:
```json
"require": {
"bukashk0zzz/yml-generator": "dev-master",
}
```
Usage examples
-------------
```php
setOutputFile($file)
->setEncoding('UTF-8')
;
// Creating ShopInfo object (https://yandex.ru/support/webmaster/goods-prices/technical-requirements.xml#shop)
$shopInfo = (new ShopInfo())
->setName('BestShop')
->setCompany('Best online seller Inc.')
->setUrl('http://www.best.seller.com/')
;
// Creating currencies array (https://yandex.ru/support/webmaster/goods-prices/technical-requirements.xml#currencies)
$currencies = [];
$currencies[] = (new Currency())
->setId('USD')
->setRate(1)
;
// Creating categories array (https://yandex.ru/support/webmaster/goods-prices/technical-requirements.xml#categories)
$categories = [];
$categories[] = (new Category())
->setId(1)
->setName($this->faker->name)
;
// Creating offers array (https://yandex.ru/support/webmaster/goods-prices/technical-requirements.xml#offers)
$offers = [];
$offers[] = (new OfferSimple())
->setId(12346)
->setAvailable(true)
->setUrl('http://www.best.seller.com/product_page.php?pid=12348')
->setPrice($this->faker->numberBetween(1, 9999))
->setCurrencyId('USD')
->setCategoryId(1)
->setDelivery(false)
->setName('Best product ever')
;
// Optional creating deliveries array (https://yandex.ru/support/partnermarket/elements/delivery-options.xml)
$deliveries = [];
$deliveries[] = (new Delivery())
->setCost(2)
->setDays(1)
->setOrderBefore(14)
;
(new Generator($settings))->generate(
$shopInfo,
$currencies,
$categories,
$offers,
$deliveries
);
```
### Adding custom elements
if you need additional offers elements in your yml file using method addCustomElement('type','value'). For example:
```php
$offers[] = (new OfferSimple())
->setId(12346)
->setAvailable(true)
->setUrl('http://www.best.seller.com/product_page.php?pid=12348')
->setPrice($this->faker->numberBetween(1, 9999))
->setCurrencyId('USD')
->setCategoryId(1)
->setDelivery(false)
->setName('Best product ever')
->addCustomElement('type', 'value')
;
```
Copyright / License
-------------------
See [LICENSE](https://github.com/bukashk0zzz/YmlGenerator/blob/master/LICENSE)