intervention/mimesniffer

PHP MIME Type Sniffer

0.4.2 2020-12-29 09:20 UTC

This package is auto-updated.

Last update: 2021-11-22 15:33:01 UTC


README

build

Detecting MIME Content-type in PHP is easy with mime_content_type or Fileinfo. But Fileinfo as an extension is sometimes not available on the server. The function mime_content_type wants a path to the filesystem as argument and doesn't process if we only have a string value. This package makes it easy to detect the mime types of the content of a given file or string, without any extension dependencies.

Installation

Install the package easily via composer:

composer require intervention/mimesniffer

Usage

Here are some code samples, to show how the library is handled.

use Intervention\MimeSniffer\MimeSniffer;
use Intervention\MimeSniffer\Types\ImageJpeg;

// detect given string
$sniffer = MimeSniffer::createFromString($content);

// or detect given file
$sniffer = MimeSniffer::createFromFilename('image.jpg');

// returns object of detected type 
$type = $sniffer->getType(); 

$bool = $type->isBinary(); // check if we have binary data
$bool = $type->isImage(); // check if we are dealing with an image
$bool = $type->isVideo(); // check video data was detected
$bool = $type->isAudio(); // check if we have detected audio data
$bool = $type->isArchive(); // check if an archive was detected
$type = (string) $type; // cast type to string (e.g. "image/jpeg")

// you can also check, if the content matches a specific type
$bool = $sniffer->matches(new ImageJpeg);

// or check, if the content matches an array of types
$bool = $sniffer->matches([ImageJpeg::class, ImageGif::class]);

// or check, if the content matches an array of type objects
$bool = $sniffer->matches([new ImageJpeg, $type]);

If your prefer non-static initialization:

use Intervention\MimeSniffer\MimeSniffer;

// create instance with constructor
$sniffer = new MimeSniffer($content);

// with setter for given content
$type = $sniffer->setFromString($other_content)->getType();

// or with setter for filename
$type = $sniffer->setFromFilename('images/image.jpg')->getType();

Currently only the following file types can be detected. More will be added in a next release.

Images

  • Image encoded as JPEG raw or in the JFIF or Exif file format
  • Image file encoded in the Graphics Interchange Format (GIF)
  • Image encoded in the Portable Network Graphics format (PNG)
  • Image encoded as BMP file, a bitmap format
  • Image encoded in High Efficiency Image File Format (HEIC/HEIF)
  • Icon encoded in ICO file format
  • Image in Google WebP image format
  • Scalable Vector Graphics (SVG)
  • Tagged Image File Format (TIFF)
  • Image encoded Photoshop Document file format (PSD)

Archives

  • GZIP compressed
  • ZIP file
  • RAR archive
  • TAR file

Videos

  • AVI
  • MPEG-1 and MPEG-2 video
  • MKV media container

Audio

  • MP3 file
  • FLAC file

Other

  • PDF document
  • OGG media container
  • SQLite Database
  • application/octet-stream (default binary)
  • text/plain (default)

Contributing

Contributions are welcome. Please note the following guidelines before submiting your pull request.

  • Follow PSR-2 coding standards.
  • Write tests for new functions and added features

License

Licensed under the MIT License.

Copyright 2019 Oliver Vogel