PHP Classes

File: README.md

Recommend this page to a friend!
  Classes of Josantonius  >  PHP MIME Type  >  README.md  >  Download  
File: README.md
Role: Documentation
Content type: text/markdown
Description: Documentation
Class: PHP MIME Type
Get the MIME type of files from name extension
Author: By
Last change: Updated to 1.1.7 version
Updated to 1.1.7 version
Updated to 1.1.7 version
Updated to 1.1.7 version
Date: 3 years ago
Size: 6,953 bytes
 

Contents

Class file image Download

PHP MimeType library

Latest Stable Version Latest Unstable Version License Codacy Badge Total Downloads Travis PSR2 PSR4 CodeCov

Versión en español

PHP library for obtain headers MIME.

Requirements

This library is supported by PHP versions 5.6 or higher and is compatible with HHVM versions 3.0 or higher.

Installation

The preferred way to install this extension is through Composer.

To install PHP MimeType library, simply:

$ composer require Josantonius/MimeType

The previous command will only install the necessary files, if you prefer to download the entire source code you can use:

$ composer require Josantonius/MimeType --prefer-source

You can also clone the complete repository with Git:

$ git clone https://github.com/Josantonius/PHP-MimeType.git

Or install it manually:

Download MimeType.php and MimeTypesCollection.php:

$ wget https://raw.githubusercontent.com/Josantonius/PHP-MimeType/master/src/MimeType.php

$ wget https://raw.githubusercontent.com/Josantonius/PHP-MimeType/master/src/MimeTypesCollection.php

Available Methods

Available methods in this library:

- Get array with all MIME types:

MimeType::get();

# Return (void)

- Get MIME type from file extension:

MimeType::getMimeFromExtension($ext);

| Attribute | Description | Type | Required | --- | --- | --- | --- | | $ext | File extension. | string | Yes |

# Return (string|false) ? MIME type or false

- Get file extension from MIME type:

MimeType::getExtensionFromMime($mime);

| Attribute | Description | Type | Required | --- | --- | --- | --- | | $mime | MIME type. | string | Yes |

# Return (string|false) ? File extension or false.

Quick Start

To use this library with Composer:

require __DIR__ . '/vendor/autoload.php';

use Josantonius\MimeType\MimeType;

Or If you installed it manually, use it:

require_once __DIR__ . '/MimeType.php';
require_once __DIR__ . '/MimeTypesCollection.php';

use Josantonius\MimeType\MimeType;

Usage

Example of use for this library:

<?php
require __DIR__ . '/vendor/autoload.php';

use Josantonius\MimeType\MimeType;

echo MimeType::getMimeFromExtension('.json'); // application/json

echo MimeType::getExtensionFromMime('text/html'); // .html

var_dump(MimeType::get());

/*
array(682) {
  [".123"]=>
  string(27) "application/vnd.lotus-1-2-3"
  [".3dml"]=>
  string(18) "text/vnd.in3d.3dml"
  [".3g2"]=>
  string(11) "video/3gpp2"
  [".3gp"]=>
  string(10) "video/3gpp"
  [".7z"]=>
  string(27) "application/x-7z-compressed"
  [".aab"]=>
  string(28) "application/x-authorware-bin"
  [".aac"]=>
  string(11) "audio/x-aac"
  [".aam"]=>
  string(28) "application/x-authorware-map"
  [".aas"]=>
  string(28) "application/x-authorware-seg"
  [".abw"]=>
  string(21) "application/x-abiword"
(...)
*/

Tests

To run tests you just need composer and to execute the following:

$ git clone https://github.com/Josantonius/PHP-MimeType.git

$ cd PHP-MimeType

$ composer install

Run unit tests with PHPUnit:

$ composer phpunit

Run PSR2 code standard tests with PHPCS:

$ composer phpcs

Run PHP Mess Detector tests to detect inconsistencies in code style:

$ composer phpmd

Run all previous tests:

$ composer tests

? TODO

  • [ ] Add new feature.
  • [ ] Improve tests.
  • [ ] Improve documentation.
  • [ ] Refactor code for disabled code style rules. See phpmd.xml and .php_cs.dist.

Contribute

If you would like to help, please take a look at the list of issues or the To Do checklist.

Pull requests

  • Fork and clone.
  • Run the command `composer install` to install the dependencies. This will also install the dev dependencies.
  • Run the command `composer fix` to excute code standard fixers.
  • Run the tests.
  • Create a branch, commit, push and send me a pull request.

Thank you to all the people who already contributed to this project!

<img alt="vincent-guesnard" src="https://avatars3.githubusercontent.com/u/315173?v=4&s=117" height="117" width="117">|<img alt="MASNathan" src="https://avatars0.githubusercontent.com/u/2139464?v=4&s=117" height="117" width="117"> :---:|:---:| vincent-guesnard|MASNathan|

Repository

The file structure from this repository was created with PHP-Skeleton.

License

This project is licensed under MIT license. See the LICENSE file for more info.

Copyright

2016 - 2018 Josantonius, josantonius.com

If you find it useful, let me know :wink:

You can contact me on Twitter or through my email.

For more information send a message to info at phpclasses dot org.