hoa/mime

The Hoa\Mime library.

Tuesday, March 6, 2018
by Hoa
Repository
12 Watchers
85 Stars
68,874 Installations

PHP
11 Dependents
0 Suggesters
13 Forks
1 Open issues
16 Versions
14 % Grown

The README.md

Hoa , _(*1)

, _(*2)

Hoa is a modular, extensible and structured set of PHP libraries.
Moreover, Hoa aims at being a bridge between industrial and research worlds. , _(*3)

Hoa\Mime

, _(*4)

This library allows to manipulate a MIME types database and get some related informations about streams., _(*5)

Learn more., _(*6)

Installation

With Composer, to include this library into your dependencies, you need to require hoa/mime:, _(*7)

$ composer require hoa/mime '~3.0'

For more installation procedures, please read the Source page., _(*8)

Testing

Before running the test suites, the development dependencies must be installed:, _(*9)

$ composer install

Then, to run all the test suites:, _(*10)

$ vendor/bin/hoa test:run

For more information, please read the contributor guide., _(*11)

Quick usage

As a quick overview, we will see how to get general and stream-related informations., _(*12)

General informations

All we need is static methods Hoa\Mime\Mime::getExtensionsFromMime to get extensions from a type and Hoa\Mime\Mime::getMimeFromExtension to get type from an extension:, _(*13)

print_r(Hoa\Mime\Mime::getExtensionsFromMime('text/html'));

/**
 * Will output:
 *     Array
 *     (
 *         [0] => html
 *         [1] => htm
 *     )
 */

var_dump(Hoa\Mime\Mime::getMimeFromExtension('webm'));

/**
 * Will output:
 *     string(10) "video/webm"
 */

By default, Hoa\Mime\Mime uses the hoa://Library/Mime/Mime.types file as database. We can change this behavior by calling the Hoa\Mime\Mime::compute before any computations:, _(*14)

Hoa\Mime\Mime::compute('/etc/mime.types');

Stream-related informations

By instanciating the Hoa\Mime\Mime class with a stream, we are able to get some informations about the stream, such as its extension, others extensions, type, etc. Thus:, _(*15)

$type = new Hoa\Mime\Mime(new Hoa\File\Read('index.html'));

var_dump(
    $type->getExtension(),
    $type->getOtherExtensions(),
    $type->getMime(),
    $type->isExperimental()
);

/**
 * Will output:
 *     string(4) "html"
 *     array(1) {
 *       [0]=>
 *       string(3) "htm"
 *     }
 *     string(9) "text/html"
 *     bool(false)
 */

Documentation

The hack book of Hoa\Mime contains detailed information about how to use this library and how it works., _(*16)

To generate the documentation locally, execute the following commands:, _(*17)

$ composer require --dev hoa/devtools
$ vendor/bin/hoa devtools:documentation --open

More documentation can be found on the project's website: hoa-project.net., _(*18)

Getting help

There are mainly two ways to get help:, _(*19)

On the #hoaproject IRC channel,
On the forum at users.hoa-project.net.

Contribution

Do you want to contribute? Thanks! A detailed contributor guide explains everything you need to know., _(*20)

License

Hoa is under the New BSD License (BSD-3-Clause). Please, see LICENSE for details., _(*21)

The following projects are using this library:, _(*22)

E-Conf, E-Conf is a Conference Management System,
sabre/katana, A contact, calendar, task list and file server.

The Versions

06/03 2018

dev-master

9999999-dev https://hoa-project.net/

The Hoa\Mime library.

library mime

The Hoa\Mime library.

hoa/mime

The README.md

Hoa\Mime

Installation

Testing

Quick usage

General informations

Stream-related informations

Documentation

Getting help

Contribution

License

Related projects

The Versions

dev-master

The Requires

The Development Requires

by Ivan Enderlin

by Hoa community

3.17.01.10

The Requires

The Development Requires

by Ivan Enderlin

by Hoa community

3.16.01.15

The Requires

The Development Requires

by Ivan Enderlin

by Hoa community

3.16.01.14

The Requires

The Development Requires

by Ivan Enderlin

by Hoa community

3.16.01.11

The Requires

The Development Requires

by Ivan Enderlin

by Hoa community

2.15.10.29

The Requires

The Development Requires

by Ivan Enderlin

by Hoa community

2.15.07.28

The Requires

The Development Requires

by Ivan Enderlin

by Hoa community

2.15.05.29

The Requires

The Development Requires

by Ivan Enderlin

by Hoa community

2.15.02.24

The Requires

The Development Requires

by Ivan Enderlin

by Hoa community

2.14.12.10

The Requires

The Development Requires

by Ivan Enderlin

by Hoa community

2.14.11.26

The Requires

The Development Requires

by Ivan Enderlin

by Hoa community

2.14.11.09

The Requires

The Development Requires

by Ivan Enderlin

by Hoa community

2.14.09.23

The Requires

The Development Requires

by Ivan Enderlin