An open API service indexing awesome lists of open source software.

https://github.com/bengorfile/filebundle

Symfony bundle built on top of BenGorFile library
https://github.com/bengorfile/filebundle

bengorfile file symfony-bundle

Last synced: 8 months ago
JSON representation

Symfony bundle built on top of BenGorFile library

Awesome Lists containing this project

README

          

# BenGorFileBundle
> Fully featured and test covered file Symfony bundle built on top of [BenGorFile][6] library

[![SensioLabsInsight](https://insight.sensiolabs.com/projects/ce050451-ac21-4799-bb76-d767df157264/mini.png)](https://insight.sensiolabs.com/projects/ce050451-ac21-4799-bb76-d767df157264)
[![Build Status](https://travis-ci.org/BenGorFile/FileBundle.svg?branch=master)](https://travis-ci.org/BenGorFile/FileBundle)
[![Scrutinizer Code Quality](https://scrutinizer-ci.com/g/BenGorFile/FileBundle/badges/quality-score.png?b=master)](https://scrutinizer-ci.com/g/BenGorFile/FileBundle/?branch=master)
[![Total Downloads](https://poser.pugx.org/bengor-file/file-bundle/downloads)](https://packagist.org/packages/bengor-file/file-bundle)
[![Latest Stable Version](https://poser.pugx.org/bengor-file/file-bundle/v/stable.svg)](https://packagist.org/packages/bengor-file/file-bundle)
[![Latest Unstable Version](https://poser.pugx.org/bengor-file/file-bundle/v/unstable.svg)](https://packagist.org/packages/bengor-file/file-bundle)

## Requirements
PHP >= 5.5
Symfony >= 2.8

## Installation
The easiest way to install this component is using **[Composer][7]**
```bash
$ composer require bengor-file/file-bundle
```
## Documentation

All the documentation is stored in the `docs` folder.

[Show me the docs!](docs/index.md)

## Tests
This bundle is completely tested by **[PHPSpec][1], SpecBDD framework for PHP**.

In case you want to contribute or just run the tests, use the following command.
```bash
$ vendor/bin/phpspec run -fpretty
```

## Contributing
This bundle follows PHP coding standards, so pull requests need to execute the Fabien Potencier's [PHP-CS-Fixer][5].
Furthermore, if the PR creates some not-PHP file remember that you have to put the license header manually. In order
to simplify we provide a Composer script that wraps all the commands related with this process.
```bash
$ composer run-script cs
```

There is also a policy for contributing to this project. Pull requests must be explained step by step to make the
review process easy in order to accept and merge them. New methods or code improvements must come paired with
[PHPSpec][1] tests.

If you would like to contribute it is a good point to follow Symfony contribution standards, so please read the
[Contributing Code][2] in the project documentation. If you are submitting a pull request, please follow the guidelines
in the [Submitting a Patch][3] section and use the [Pull Request Template][4].

## Credits
This bundle is created by:
>
**@benatespina** - [benatespina@gmail.com](mailto:benatespina@gmail.com)

**@gorkalaucirica** - [gorka.lauzirika@gmail.com](mailto:gorka.lauzirika@gmail.com)

## Licensing Options
[![License](https://poser.pugx.org/bengor-file/file-bundle/license.svg)](https://github.com/BenGorFile/FileBundle/blob/master/LICENSE)

[1]: http://www.phpspec.net/
[2]: http://symfony.com/doc/current/contributing/code/index.html
[3]: http://symfony.com/doc/current/contributing/code/patches.html#check-list
[4]: http://symfony.com/doc/current/contributing/code/patches.html#make-a-pull-request
[5]: http://cs.sensiolabs.org/
[6]: https://github.com/BenGorFile/File
[7]: http://getcomposer.org