Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/josantonius/php-mime-type
PHP library to get MIME types from extensions
https://github.com/josantonius/php-mime-type
composer headers-mime mime-type mime-types mimetype php
Last synced: 3 months ago
JSON representation
PHP library to get MIME types from extensions
- Host: GitHub
- URL: https://github.com/josantonius/php-mime-type
- Owner: josantonius
- License: mit
- Archived: true
- Created: 2016-12-19T03:31:47.000Z (about 8 years ago)
- Default Branch: main
- Last Pushed: 2023-07-13T18:05:45.000Z (over 1 year ago)
- Last Synced: 2024-05-02T02:54:50.736Z (8 months ago)
- Topics: composer, headers-mime, mime-type, mime-types, mimetype, php
- Language: PHP
- Homepage: https://josantonius.dev
- Size: 1.43 MB
- Stars: 9
- Watchers: 3
- Forks: 8
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Contributing: .github/CONTRIBUTING.md
- Funding: .github/FUNDING.yml
- License: LICENSE
- Code of conduct: .github/CODE_OF_CONDUCT.md
Awesome Lists containing this project
README
# PHP MimeType library
[](https://packagist.org/packages/josantonius/mime-type)
[](LICENSE)
[](https://packagist.org/packages/josantonius/mime-type)
[](https://github.com/josantonius/php-mime-type/actions/workflows/ci.yml)
[](https://codecov.io/gh/josantonius/php-mime-type)
[](https://www.php-fig.org/psr/psr-1/)
[](https://www.php-fig.org/psr/psr-4/)
[](https://www.php-fig.org/psr/psr-12/)
PHP library to get MIME types from extensions.
> The original concept of my project, linking a single mimetype to a file extension, has been found to be insufficient in accurately reflecting the many-to-one relationships that exist in real-world use-cases. In practice, multiple file extensions often correspond to a single mimetype, rendering my existing design approach suboptimal.
> Given these insights, I've decided to archive this repository. I recommend those interested to look at the approach taken by the repository [patrickmccallum/mimetype-io](https://github.com/patrickmccallum/mimetype-io/blob/master/src/mimeData.json). This project adopts a more nuanced perspective, effectively managing mimetypes by acknowledging the possibility of multiple extensions corresponding to a single mimetype. I believe this is a more promising approach for managing mimetypes moving forward.
## Requirements
- Operating System: Linux | Windows.
- PHP versions: 8.0 | 8.1 | 8.2.
## Installation
The preferred way to install this extension is through [Composer](http://getcomposer.org/download/).
To install **PHP MimeType library**, simply:
```console
composer require josantonius/mime-type
```
The previous command will only install the necessary files,
if you prefer to **download the entire source code** you can use:
```console
composer require josantonius/mime-type --prefer-source
```
You can also **clone the complete repository** with Git:
```console
git clone https://github.com/josantonius/php-mime-type.git
```
## Available Classes
### MimeType
`Josantonius\MimeType\MimeType`
Get array with all MIME types:
```php
public function all(): array;
```
Get file extension from MIME type:
```php
public function getExtension(string $mimeType): string|null;
```
Get MIME type from file extension:
```php
public function getMime(string $extension): string|null;
```
### MimeTypeCollection
`Josantonius\MimeType\MimeTypeCollection`
Get array with all MIME types:
```php
public static function all(): array;
```
Get file extension from MIME type:
```php
public static function getExtension(string $mimeType): string|null;
```
Get MIME type from file extension:
```php
public static function getMime(string $extension): string|null;
```
## Usage
Example of use for this library:
### Get array with all MIME types
```php
use Josantonius\MimeType\MimeType;
$mimeType = new MimeType();
$mimeType->all();
```
```php
use Josantonius\MimeType\MimeTypeCollection;
MimeTypeCollection::all();
```
Result:
```php
[
[".123"]=> "application/vnd.lotus-1-2-3"
[".3dml"]=> "text/vnd.in3d.3dml"
[".3g2"]=> "video/3gpp2"
[".3gp"]=> "video/3gpp"
[".7z"]=> "application/x-7z-compressed"
[".aab"]=> "application/x-authorware-bin"
[".aac"]=> "audio/x-aac"
[".aam"]=> "application/x-authorware-map"
[".aas"]=> "application/x-authorware-seg"
[".abw"]=> "application/x-abiword"
(...)
]
```
### Get file extension from MIME type
```php
use Josantonius\MimeType\MimeType;
$mimeType = new MimeType();
$mimeType->getExtension('text/html'); // .html
```
```php
use Josantonius\MimeType\MimeTypeCollection;
MimeTypeCollection::getExtension('application/zip'); // .zip
```
### Get MIME type from file extension
```php
use Josantonius\MimeType\MimeType;
$mimeType = new MimeType();
$mimeType->getMime('.tar'); // application/x-tar
// The dot can be omitted:
$mimeType->getMime('mp4'); // video/mp4
```
```php
use Josantonius\MimeType\MimeTypeCollection;
MimeTypeCollection::getMime('.json'); // application/json
```
## Tests
To run [tests](tests) you just need [composer](http://getcomposer.org/download/)
and to execute the following:
```console
git clone https://github.com/josantonius/php-mime-type.git
```
```console
cd PHP-MimeType
```
```console
composer install
```
Run unit tests with [PHPUnit](https://phpunit.de/):
```console
composer phpunit
```
Run code standard tests with [PHPCS](https://github.com/squizlabs/PHP_CodeSniffer):
```console
composer phpcs
```
Run [PHP Mess Detector](https://phpmd.org/) tests to detect inconsistencies in code style:
```console
composer phpmd
```
Run all previous tests:
```console
composer tests
```
## TODO
- [ ] Add new feature
- [ ] Improve tests
- [ ] Improve documentation
- [ ] Improve English translation in the README file
- [ ] Refactor code for disabled code style rules (see phpmd.xml and phpcs.xml)
## Changelog
Detailed changes for each release are documented in the
[release notes](https://github.com/josantonius/php-mime-type/releases).
## Contribution
Please make sure to read the [Contributing Guide](.github/CONTRIBUTING.md), before making a pull
request, start a discussion or report a issue.
Thanks to all [contributors](https://github.com/josantonius/php-mime-type/graphs/contributors)! :heart:
## Sponsor
If this project helps you to reduce your development time,
[you can sponsor me](https://github.com/josantonius#sponsor) to support my open source work :blush:
## License
This repository is licensed under the [MIT License](LICENSE).
Copyright © 2016-2023, [Josantonius](https://github.com/josantonius#contact)