summaryrefslogtreecommitdiff
path: root/vendor/thecodingmachine/safe/generated/fileinfo.php
blob: 8bbfd3c477c6a551fce4d70febcc6b8b99a120cf (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
<?php

namespace Safe;

use Safe\Exceptions\FileinfoException;

/**
 * This function closes the instance opened by finfo_open.
 *
 * @param resource $finfo An finfo instance, returned by finfo_open.
 * @throws FileinfoException
 *
 */
function finfo_close($finfo): void
{
    error_clear_last();
    $result = \finfo_close($finfo);
    if ($result === false) {
        throw FileinfoException::createFromPhpError();
    }
}


/**
 * Procedural style
 *
 * Object-oriented style (constructor):
 *
 * This function opens a magic database and returns its instance.
 *
 * @param int $flags One or disjunction of more Fileinfo
 * constants.
 * @param string $magic_database Name of a magic database file, usually something like
 * /path/to/magic.mime. If not specified, the
 * MAGIC environment variable is used. If the
 * environment variable isn't set, then PHP's bundled magic database will
 * be used.
 *
 * Passing NULL or an empty string will be equivalent to the default
 * value.
 * @return resource (Procedural style only)
 * Returns an finfo instance on success.
 * @throws FileinfoException
 *
 */
function finfo_open(int $flags = FILEINFO_NONE, string $magic_database = null)
{
    error_clear_last();
    if ($magic_database !== null) {
        $result = \finfo_open($flags, $magic_database);
    } else {
        $result = \finfo_open($flags);
    }
    if ($result === false) {
        throw FileinfoException::createFromPhpError();
    }
    return $result;
}


/**
 * Returns the MIME content type for a file as determined by using
 * information from the magic.mime file.
 *
 * @param string|resource $filename Path to the tested file.
 * @return string Returns the content type in MIME format, like
 * text/plain or application/octet-stream.
 * @throws FileinfoException
 *
 */
function mime_content_type($filename): string
{
    error_clear_last();
    $result = \mime_content_type($filename);
    if ($result === false) {
        throw FileinfoException::createFromPhpError();
    }
    return $result;
}