mirror of
https://codeberg.org/vlw/php-mime-types.git
synced 2025-09-13 18:53:41 +02:00
doc(feat): add README
This commit is contained in:
parent
26c6bb250e
commit
88406487ec
1 changed files with 33 additions and 0 deletions
33
README.md
Normal file
33
README.md
Normal file
|
@ -0,0 +1,33 @@
|
|||
# MIME-type parser and abstraction library for PHP
|
||||
|
||||
Resolve MIME-types from file extensions and vice versa by passing a URL to an RFC 4288-compatible source to this library.
|
||||
|
||||
```php
|
||||
use vlw\MimeTypes\MimeTypes;
|
||||
|
||||
$mime = new MimeTypes("https://raw.githubusercontent.com/apache/httpd/refs/heads/trunk/docs/conf/mime.types");
|
||||
|
||||
// From string
|
||||
$mime->get_ext_from_type("image/webp"); // "webp"
|
||||
$mime->get_type_from_ext("webp"); // "image/webp"
|
||||
|
||||
// From pathname
|
||||
$mime->get_ext_from_file("path/to/file.webp") // "webp"
|
||||
$mime->get_type_from_file("path/to/file.webp) // "image/webp"
|
||||
```
|
||||
|
||||
# Installation
|
||||
|
||||
```sh
|
||||
composer require vlw/mime-types
|
||||
```
|
||||
|
||||
# Use
|
||||
|
||||
```php
|
||||
use vlw\MimeTypes\MimeTypes;
|
||||
|
||||
$mime = new MimeTypes(string $url);
|
||||
```
|
||||
|
||||
Defaults to [Apache's `mime.types` file from GitHub](https://raw.githubusercontent.com/apache/httpd/refs/heads/trunk/docs/conf/mime.types) if no value is provided to `$url`
|
Loading…
Add table
Reference in a new issue