php-zip/src/Constants/GeneralPurposeBitFlag.php

<?php

declare(strict_types=1);

/*
 * This file is part of the nelexa/zip package.
 * (c) Ne-Lexa <https://github.com/Ne-Lexa/php-zip>
 * For the full copyright and license information, please view the LICENSE
 * file that was distributed with this source code.
 */

namespace PhpZip\Constants;

interface GeneralPurposeBitFlag
{
    /**
     * General Purpose Bit Flag mask for encrypted data.
     * Bit 0: If set, indicates that the file is encrypted.
     */
    public const ENCRYPTION = 1 << 0;

    /**
     * Compression Flag Bit 1 for method Deflating.
     *
     * Bit 2  Bit 1
     * 0      0    Normal compression
     * 0      1    Maximum compression
     * 1      0    Fast compression
     * 1      1    Super Fast compression
     *
     * @see GeneralPurposeBitFlag::COMPRESSION_FLAG2
     */
    public const COMPRESSION_FLAG1 = 1 << 1;

    /**
     * Compression Flag Bit 2 for method Deflating.
     *
     * Bit 2  Bit 1
     * 0      0    Normal compression
     * 0      1    Maximum compression
     * 1      0    Fast compression
     * 1      1    Super Fast compression
     *
     * @see GeneralPurposeBitFlag::COMPRESSION_FLAG1
     */
    public const COMPRESSION_FLAG2 = 1 << 2;

    /**
     * General Purpose Bit Flag mask for data descriptor.
     *
     * Bit 3: If this bit is set, the fields crc-32, compressed
     * size and uncompressed size are set to zero in the
     * local header. The correct values are put in the data
     * descriptor immediately following the compressed data.
     */
    public const DATA_DESCRIPTOR = 1 << 3;

    /**
     * General Purpose Bit Flag mask for strong encryption.
     *
     * Bit 6: Strong encryption.
     * If this bit is set, you MUST set the version needed to extract
     * value to at least 50 and you MUST also set bit 0.
     * If AES encryption is used, the version needed to extract value
     * MUST be at least 51.
     */
    public const STRONG_ENCRYPTION = 1 << 6;

    /**
     * General Purpose Bit Flag mask for UTF-8.
     *
     * Bit 11: Language encoding flag (EFS).
     * If this bit is set, the filename and comment fields
     * for this file MUST be encoded using UTF-8. (see APPENDIX D)
     */
    public const UTF8 = 1 << 11;
}