Skip to content

Commit

Permalink
improve readme
Browse files Browse the repository at this point in the history
Signed-off-by: Victor Gonzalez <victor@vgr.cl>
  • Loading branch information
XzAeRo committed Feb 23, 2022
1 parent 41d89af commit fe4250f
Show file tree
Hide file tree
Showing 3 changed files with 81 additions and 73 deletions.
146 changes: 75 additions & 71 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,72 +1,76 @@
# PHP Sitemap abstraction library
---
1. Add urls one-by-one
```php
$urlset = new Urlset($links);

foreach(range('a', 'z') as $letter) {
$url = new Url(
'https://vocabula.ry/'.$letter,
new \DateTime('2017-01-01 00:00:01'),
Url::CHANGEFREQ_MONTHLY,
0.8
);

$url->addImage(new Image('https://test.com/image/'.$i));
$url->addVideo(new Video('https://test.com/video/'.$i, 'Title '.$i, 'Description '.$i));
$url->addNews(new News('Awesome news '.$i, '2018-01-01', 'Awesome news name '.$i, 'ru-RU'));

$urlset->addUrl($url);
}


$sitemap = new Sitemap($urlset);

$sitemap->toXmlString();
$sitemap->toTxtString();
$sitemap->write(__DIR__ . '/sitemap.xml');
$sitemap->write(__DIR__ . '/sitemap.txt', Sitemap::FORMAT_TXT);
```

2. Using links generator
```php
$links = function() {
foreach(range('a', 'z') as $letter) {
$url = new Url(
'https://vocabula.ry/'.$letter,
new \DateTime('2017-01-01 00:00:01'),
Url::CHANGEFREQ_MONTHLY,
0.8
);

$url->addImage(new Image('https://test.com/image/'.$i));
$url->addVideo(new Video('https://test.com/video/'.$i, 'Title '.$i, 'Description '.$i));
$url->addNews(new News('Awesome news '.$i, '2018-01-01', 'Awesome news name '.$i, 'ru-RU'));

yield $url;
}
}

$urlset = new Urlset($links);
$sitemap = new Sitemap($urlset);

$sitemap->toXmlString();
$sitemap->toTxtString();
$sitemap->write(__DIR__ . '/sitemap.xml');
$sitemap->write(__DIR__ . '/sitemap.txt', Sitemap::FORMAT_TXT);
```
3. Sitemap index
```php
$index = new Sitemapindex();
$sitemap = new Sitemap($index);

foreach (range(1, 2) as $i) {
$sitemap = new SitemapindexSitemap(
'http://test.com/'.$i,
'-1 year'
);
$index->addSitemap($sitemap);
}

$content = $sitemap->toXmlString();
```

[![Tests](https://github.com/yii-starter-kit/sitemaped/actions/workflows/php.yml/badge.svg)](https://github.com/yii-starter-kit/sitemaped/actions/workflows/php.yml)

## 1. Add urls one-by-one

```php
$urlset = new Urlset($links);

foreach(range('a', 'z') as $letter) {
$url = new Url(
'https://vocabula.ry/'.$letter,
new \DateTime('2017-01-01 00:00:01'),
Url::CHANGEFREQ_MONTHLY,
0.8
);

$url->addImage(new Image('https://test.com/image/'.$i));
$url->addVideo(new Video('https://test.com/video/'.$i, 'Title '.$i, 'Description '.$i));
$url->addNews(new News('Awesome news '.$i, '2018-01-01', 'Awesome news name '.$i, 'ru-RU'));

$urlset->addUrl($url);
}


$sitemap = new Sitemap($urlset);

$sitemap->toXmlString();
$sitemap->toTxtString();
$sitemap->write(__DIR__ . '/sitemap.xml');
$sitemap->write(__DIR__ . '/sitemap.txt', Sitemap::FORMAT_TXT);
```

## 2. Using links generator

```php
$links = function() {
foreach(range('a', 'z') as $letter) {
$url = new Url(
'https://vocabula.ry/'.$letter,
new \DateTime('2017-01-01 00:00:01'),
Url::CHANGEFREQ_MONTHLY,
0.8
);

$url->addImage(new Image('https://test.com/image/'.$i));
$url->addVideo(new Video('https://test.com/video/'.$i, 'Title '.$i, 'Description '.$i));
$url->addNews(new News('Awesome news '.$i, '2018-01-01', 'Awesome news name '.$i, 'ru-RU'));

yield $url;
}
}

$urlset = new Urlset($links);
$sitemap = new Sitemap($urlset);

$sitemap->toXmlString();
$sitemap->toTxtString();
$sitemap->write(__DIR__ . '/sitemap.xml');
$sitemap->write(__DIR__ . '/sitemap.txt', Sitemap::FORMAT_TXT);
```
## 3. Sitemap index
```php
$index = new Sitemapindex();
$sitemap = new Sitemap($index);

foreach (range(1, 2) as $i) {
$sitemap = new SitemapindexSitemap(
'http://test.com/'.$i,
'-1 year'
);
$index->addSitemap($sitemap);
}

$content = $sitemap->toXmlString();
```
6 changes: 5 additions & 1 deletion composer.json
Original file line number Diff line number Diff line change
@@ -1,12 +1,16 @@
{
"name": "trntv/sitemaped",
"name": "yii-starter-kit/sitemaped",
"description": "PHP Sitemap abstraction library",
"type": "library",
"license": "MIT",
"authors": [
{
"name": "Eugene Terentev",
"email": "eugene@terentev.net"
},
{
"name": "Victor Gonzalez",
"email": "victor@vgr.cl"
}
],
"autoload": {
Expand Down
2 changes: 1 addition & 1 deletion composer.lock

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

0 comments on commit fe4250f

Please sign in to comment.