-- reorganize

-- simplify methods

Author: joshstoik1

.gitattributes

@@ -0,0 +1,2 @@
+/build export-ignore
+/tests export-ignore

README.md

@@ -9,11 +9,13 @@ A comprehensive MIME and file extension tool for PHP. Finally!
 1. [Features](#features)
 2. [Requirements](#requirements)
 2. [Installation](#installation)
-3. Reference
-  * [By MIME](https://github.com/Blobfolio/blob-mimes/blob/master/docs/MIME.md)
-  * [By Extension](https://github.com/Blobfolio/blob-mimes/blob/master/docs/EXTENSION.md)
-  * [By File](https://github.com/Blobfolio/blob-mimes/blob/master/docs/FILE.md)
-  * [Build Sources](https://github.com/Blobfolio/blob-mimes/blob/master/docs/BUILD.md)
+3. [Reference](#reference)
+   * [check_ext_and_mime()](#check_ext_and_mime)
+   * [finfo()](#finfo)
+   * [get_extension()](#get_extension)
+   * [get_extensions()](#get_extensions)
+   * [get_mime()](#get_mime)
+   * [get_mimes()](#get_mimes)
 4. [License](#license)
 
 
@@ -34,38 +36,189 @@ The database is compiled from the following sources:
  * [Apache](https://svn.apache.org/repos/asf/httpd/httpd/trunk/docs/conf/mime.types)
  * [Nginx](http://hg.nginx.org/nginx/raw-file/default/conf/mime.types)
  * [freedesktop.org](https://cgit.freedesktop.org/xdg/shared-mime-info/plain/freedesktop.org.xml.in)
- * [WordPress](https://developer.wordpress.org/reference/functions/wp_get_mime_types/) *at runtime, if present
 
 
 
 ## Requirements
 
-At a bare minimum you need to be running PHP v5.3+ with the `php-json` module.
+blob-mimes requires PHP 7+ with the following modules:
 
-Composer requires PHP v5.3.2.
+ * BCMath
+ * DOM
+ * Fileinfo
+ * Filter
+ * JSON
+ * MBString
+ * SimpleXML
 
-Optional modules include:
- 
- * `php-mbstring`: multi-byte support;
- * `php-fileinfo`: derive "true" file type from contents;
- * `php-iconv`: UTF-8 support if you have not installed via Composer or are not running WordPress
+UTF-8 is used for all string encoding. This could create conflicts on environments using something else.
 
-The standalone build script requires a Unix environment (e.g. Linux, OS X, BSD...) and PHP CLI v7.0+ with the following modules:
-
- * `php-mbstring`
- * `php-simplexml`
- * `php-curl`
+The build script additionally requires cURL.
 
 
 
 ## Installation
 
-Composer is the easiest:
+Install via Composer:
 ```bash
 composer require "blobfolio/blob-mimes:dev-master"
 ```
 
-Otherwise, download the `src` directory and include all the PHP scripts in your application. If your project has an autoloader, point the `blobmimes` namespace to `src/blobmimes`.
+
+
+## Reference
+
+### check_ext_and_mime()
+
+Verify that a file extension and MIME type belong together. Because technology is always evolving and the MIME standard is always changing, this will consider `some/thing` and `some/x-thing` equivalent.
+
+#### Arguments
+
+ * (*string*) File extension
+ * (*string*) MIME type
+ * (*bool*) (*optional*) Soft pass. If `TRUE`, the check will return `TRUE` if it lacks information about either the extension or MIME type.
+
+#### Returns
+
+Returns `TRUE` or `FALSE`.
+
+#### Example
+
+```php
+$foo = blobfolio\mimes\mimes::check_ext_and_mime('jpeg', 'image/jpeg'); //TRUE
+$foo = blobfolio\mimes\mimes::check_ext_and_mime('jpeg', 'image/gif'); //FALSE
+```
+
+
+
+### finfo()
+
+Pull path and type information for a file, using its name and/or content. If it is determined that the file is incorrectly named, alternative names with the correct file extension(s) are suggested.
+
+#### Arguments
+
+ * (*string*) Path
+ * (*string*) (*optional*) Nice name. If provided, the nice name will be treated as the filename. This can be useful if passing a temporary upload, for example. Default: `NULL`
+
+#### Returns
+
+Returns all file information that can be derived according to the format below.
+
+#### Example
+
+```php
+print_r(blobfolio\mimes\mimes::finfo('../wp/img/blobfolio.svg'));
+/*
+array(
+    [dirname] => /var/www/blob-common/wp/img
+    [basename] => blobfolio.svg
+    [extension] => svg
+    [filename] => blobfolio
+    [path] => /var/www/blob-common/wp/img/blobfolio.svg
+    [mime] => image/svg+xml
+    [suggested_filename] => array()
+)
+*/
+```
+
+
+
+### get_extension()
+
+Retrieve information about a file extension.
+
+#### Arguments
+
+ * (*string*) File extension
+
+#### Returns
+
+Returns the information or `FALSE`.
+
+```php
+print_r(blobfolio\mimes\mimes::get_extension('jpeg'));
+/*
+array(
+    [ext] => jpeg
+    [mime] => array(
+        0 => image/jpeg
+        1 => image/pjpeg
+    )
+    [source] => array(
+        0 => Apache
+        1 => Nginx
+        2 => freedesktop.org
+    )
+    [alias] => array(
+        ] => image/pjpeg
+    )
+    [primary] => image/jpeg
+)
+*/
+```
+
+
+
+### get_extensions()
+
+Retrieve information about all known file extensions.
+
+#### Arguments
+
+N/A
+
+#### Returns
+
+Returns a MIME database oganized by extension.
+
+
+
+### get_mime()
+
+Retrieve information about a MIME type.
+
+#### Arguments
+
+ * (*string*) MIME type
+
+#### Returns
+
+Returns the information or `FALSE`.
+
+#### Example
+
+```php
+print_r(blobfolio\mimes\mimes::get_mime('image/jpeg'));
+/*
+array(
+    [mime] => image/jpeg
+    [ext] => array(
+        0 => jpeg
+        1 => jpg
+        2 => jpe
+    )
+    [source] => array(
+        0 => Apache
+        1 => Nginx
+        2 => freedesktop.org
+    )
+)
+*/
+```
+
+
+
+### get_mimes()
+
+Retrieve information about all known MIME types.
+
+#### Arguments
+
+N/A
+
+#### Returns
+
+Returns a MIME database oganized by type.
 
 
 

docs/BUILD.md renamed to build/README.md

@@ -20,4 +20,4 @@ The combined data will be output to two different JSON files:
  * `build/extensions_by_mime.json`
  * `build/mimes_by_extension.json`
 
-After a build has completed, copy these two files to the main `src` directory.
+After a build has completed, copy these two files to the main `lib/blobfolio/mimes` directory.

composer.json

@@ -7,6 +7,7 @@
         "extensions",
         "suffix"
     ],
+    "version": "1.0.0",
     "type": "library",
     "homepage": "https://github.com/Blobfolio/blob-mimes",
     "license": "GPLv2",
@@ -18,11 +19,16 @@
         }
     ],
     "require": {
-        "neitanod/forceutf8": "dev-master"
+        "neitanod/forceutf8": "dev-master",
+        "blobfolio/blob-common": "dev-master"
+    },
+    "config": {
+        "vendor-dir": "lib/vendor",
+        "preferred-install": "dist"
     },
     "autoload": {
         "psr-4": {
-            "blobmimes\\": "src/blobmimes"
+            "blobfolio\\mimes\\": "lib/blobfolio/mimes"
         }
     }
 }