Code Coverage
 
Lines
Functions and Methods
Classes and Traits
Total
100.00%
4 / 4
100.00%
1 / 1
 CRAP
100.00%
1 / 1
TransferEncoding
100.00%
4 / 4
100.00%
1 / 1
 2
100.00%
1 / 1
 isChunked
100.00%
4 / 4
100.00%
1 / 1
 2
1<?php
2
3/**
4 * This file is part of php-fast-forward/http-message.
5 *
6 * This source file is subject to the license bundled
7 * with this source code in the file LICENSE.
8 *
9 * @see      https://github.com/php-fast-forward/http-message
10 *
11 * @copyright Copyright (c) 2025 Felipe Sayão Lobato Abreu <github@mentordosnerds.com>
12 * @license   https://opensource.org/licenses/MIT MIT License
13 */
14
15declare(strict_types=1);
16
17/**
18 * This file is part of php-fast-forward/http-message.
19 *
20 * This source file is subject to the license bundled
21 * with this source code in the file LICENSE.
22 *
23 * @link      https://github.com/php-fast-forward/http-message
24 * @copyright Copyright (c) 2025 Felipe Sayão Lobato Abreu <github@mentordosnerds.com>
25 * @license   https://opensource.org/licenses/MIT MIT License
26 */
27
28namespace FastForward\Http\Message\Header;
29
30/**
31 * Enum TransferEncoding.
32 *
33 * Represents the HTTP `Transfer-Encoding` header values.
34 *
35 * Transfer-Encoding is a hop-by-hop header, meaning it applies only to a
36 * single transport-level connection and MUST NOT be stored or reused by
37 * caches for subsequent requests or responses. The listed values indicate
38 * which transfer codings have been applied to the message body in order to
39 * safely move it between intermediaries.
40 *
41 * Implementations using this enum SHOULD ensure that the semantics
42 * of chunked transfer-coding and any compression codings are respected
43 * according to the relevant HTTP specifications.
44 *
45 * @see https://datatracker.ietf.org/doc/html/rfc7230#section-3.3.1
46 * @see https://datatracker.ietf.org/doc/html/rfc7230#section-4.1
47 */
48enum TransferEncoding: string
49{
50    /**
51     * Indicates that the message body is sent as a series of chunks.
52     *
53     * Chunked transfer-coding is the only transfer-coding that is mandatory
54     * for HTTP/1.1 compliance and MUST be understood by all HTTP/1.1 agents
55     * that advertise support for `Transfer-Encoding`.
56     *
57     * When present, `chunked` MUST be the final transfer-coding applied to
58     * the payload. It allows the sender to stream content without knowing
59     * the final length in advance.
60     */
61    case Chunked = 'chunked';
62
63    /**
64     * A transfer-coding using the Lempel-Ziv-Welch (LZW) algorithm.
65     *
66     * This coding derives from the historic UNIX `compress` format. It is
67     * largely obsolete in modern HTTP and SHOULD NOT be used for new
68     * deployments. Many clients no longer support it due to past patent
69     * concerns and limited practical usage.
70     */
71    case Compress = 'compress';
72
73    /**
74     * A transfer-coding using the zlib structure with the DEFLATE
75     * compression algorithm.
76     *
77     * This coding uses the zlib framing (RFC 1950) combined with the DEFLATE
78     * algorithm (RFC 1951). Implementations MUST take care not to confuse
79     * this with a “raw deflate” stream without zlib framing.
80     */
81    case Deflate = 'deflate';
82
83    /**
84     * A transfer-coding using the Lempel-Ziv coding (LZ77) with a 32-bit CRC.
85     *
86     * This corresponds to the traditional `gzip` format produced by the
87     * UNIX `gzip` program. Some legacy systems MAY also accept `x-gzip`,
88     * but as a transfer-coding value, `gzip` itself SHOULD be preferred.
89     */
90    case Gzip = 'gzip';
91
92    /**
93     * Determines whether the given `Transfer-Encoding` header indicates that
94     * chunked transfer-coding has been applied.
95     *
96     * The `chunked` token MAY appear as one of several comma-separated values.
97     * This method performs a case-insensitive search for its presence. While
98     * RFC 7230 specifies that `chunked` MUST be the final transfer-coding
99     * when present, this method deliberately checks only for its existence to
100     * provide a more robust, tolerant interpretation of real-world headers.
101     *
102     * Callers SHOULD use this method before attempting to parse a message
103     * body as chunked data.
104     *
105     * @param string $transferEncodingHeader the raw `Transfer-Encoding` header value
106     *
107     * @return bool true if `chunked` is present (case-insensitive), false otherwise
108     */
109    public static function isChunked(string $transferEncodingHeader): bool
110    {
111        if ('' === $transferEncodingHeader) {
112            return false;
113        }
114
115        $codings = array_map('\mb_trim', explode(',', mb_strtolower($transferEncodingHeader)));
116
117        return \in_array(self::Chunked->value, $codings, true);
118    }
119}