https://github.com/pastuhov/php-file-stream

May be used for sitemap.xml or YML files creation.
https://github.com/pastuhov/php-file-stream

file sitemap xml yml

Last synced: 3 days ago
JSON representation

May be used for sitemap.xml or YML files creation.

• Host: GitHub
• URL: https://github.com/pastuhov/php-file-stream
• Owner: pastuhov
• License: gpl-2.0
• Created: 2015-06-18T05:53:24.000Z (over 9 years ago)
• Default Branch: master
• Last Pushed: 2017-02-17T14:01:45.000Z (over 7 years ago)
• Last Synced: 2024-09-06T23:59:42.390Z (27 days ago)
• Topics: file, sitemap, xml, yml
• Language: PHP
• Homepage:
• Size: 25.4 KB
• Stars: 3
• Watchers: 1
• Forks: 1
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# php-file-stream

[![Build Status](https://travis-ci.org/pastuhov/php-file-stream.svg)](https://travis-ci.org/pastuhov/php-file-stream)

[![Scrutinizer Code Quality](https://scrutinizer-ci.com/g/pastuhov/php-file-stream/badges/quality-score.png?b=master)](https://scrutinizer-ci.com/g/pastuhov/php-file-stream/?branch=master)

[![Code Coverage](https://scrutinizer-ci.com/g/pastuhov/php-file-stream/badges/coverage.png?b=master)](https://scrutinizer-ci.com/g/pastuhov/php-file-stream/?branch=master)

[![Total Downloads](https://poser.pugx.org/pastuhov/php-file-stream/downloads)](https://packagist.org/packages/pastuhov/php-file-stream)

A PHP class to generate sitemap files for large web-sites or YML (Yandex Market Language) files

## Install

Via Composer

``` bash

$ composer require pastuhov/php-file-stream

```

## Features

* transparent file splitting (multiple sitemaps)

* fast and safe file replacement from tmp to public directory

* dependencies: 0

## Usage

### Simple YML export

```php

    $stream = new FileStream(

        '/tmp/export.yml'

    );

    $stream->write('');

    

    ...

    

    $stream->write('');

```

### Advanced usage (large site sitemap, >10k urls)

```php

    $stream = new FileStream(

        '/tmp/sitemap{count}.xml',

        '',

        '',

        10000

    );

    foreach ($urls as $url) {

        $stream->write(

            '' . $url . '' . PHP_EOL

        );

    }

```

## Testing

``` bash

$ composer test

```

or

```bash

$ phpunit

```

## Security

If you discover any security related issues, please email [email protected] instead of using the issue tracker.

## Credits

- [Kirill Pastukhov](https://github.com/pastuhov)

- [All Contributors](../../contributors)

## License

GNU General Public License, version 2. Please see [License File](LICENSE) for more information.