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:  80:  81:  82:  83:  84:  85:  86:  87:  88:  89:  90:  91:  92:  93:  94:  95:  96:  97:  98:  99: 100: 101: 102: 103: 104: 105: 106: 107: 108: 109: 110: 111: 112: 113: 114: 115: 116: 117: 118: 119: 120: 121: 122: 123: 124: 125: 126: 127: 128: 129: 130: 131: 132: 133: 134: 135: 136: 137: 138: 139: 140: 141: 142: 143: 144: 145: 146: 147: 148: 149: 150: 151: 152: 153: 154: 155: 156: 157: 158: 159: 160: 161: 162: 163: 164: 165: 166: 167: 168: 169: 170: 171: 172: 173: 174: 175: 176: 177: 178: 179: 180: 181: 182: 183: 184: 185: 186: 187: 188: 189: 190: 191: 192: 193: 194: 195: 196: 197: 198: 199: 200: 201: 202: 203: 204: 205: 206: 207: 208: 209: 210: 211: 212: 213: 214: 215: 216: 217: 218: 219: 220: 221: 222: 223: 224: 225: 226: 227: 228: 229: 230: 231: 232: 233: 234: 235: 236: 237: 238: 239: 240: 241: 242: 243: 244: 245: 246: 247: 248: 249: 250: 251: 252: 253: 254: 255: 256: 257: 258: 259: 260: 261: 262: 263: 264: 265: 266: 267: 268: 269: 270: 271: 272: 273: 274: 275: 276: 277: 278: 279: 280: 281: 282: 283: 

<?php

/**
 * MvcCore
 *
 * This source file is subject to the BSD 3 License
 * For the full copyright and license information, please view
 * the LICENSE.md file that are distributed with this source code.
 *
 * @copyright   Copyright (c) 2016 Tom Flidr (https://github.com/mvccore)
 * @license     https://mvccore.github.io/docs/mvccore/5.0.0/LICENCE.md
 */

namespace MvcCore\Ext\Forms\Fields;

/**
 * Responsibility: define getters and setters for field properties: `accept`, 
 *                 `capture`, `allowedFileNameChars`, `minCount`, `maxCount`,
 *                 `minSize` and `maxSize`.
 * Interface for classes:
 * - `\MvcCore\Ext\Forms\Fields\File`
 * - `\MvcCore\Ext\Forms\Validators\Files`
 */
interface IFile {

    /**
     * Get list of allowed file mime-types or file extensions. 
     * All defined file mime-types are checked with `finfo` PHP extension and checked by
     * allowed file extensions for defined mime-type.
     * All defined file extensions are translated internally on server side into mime-types,
     * then checked with `finfo` PHP extension and checked by
     * allowed file extensions for defined mime-type.
     * Example: `$this->accept = ['image/*', 'audio/mp3', '.docx'];`
     * @see https://developer.mozilla.org/en-US/docs/Web/HTML/Element/input#attr-accept
     * @return \string[]
     */
    public function GetAccept ();

    /**
     * Set list of allowed file mime-types or file extensions. 
     * All defined file mime-types are checked with `finfo` PHP extension and checked by
     * allowed file extensions for defined mime-type.
     * All defined file extensions are translated internally on server side into mime-types,
     * then checked with `finfo` PHP extension and checked by
     * allowed file extensions for defined mime-type.
     * Example: `$this->accept = ['image/*', 'audio/mp3', '.docx'];`
     * @see https://developer.mozilla.org/en-US/docs/Web/HTML/Element/input#attr-accept
     * @param \string[] $accept 
     * @return \MvcCore\Ext\Forms\Fields\File
     */
    public function SetAccept (array $accept = []);

    /**
     * Get boolean attribute indicates that capture of media directly from the 
     * device's sensors using a media capture mechanism is preferred, 
     * such as a webcam or microphone. This HTML attribute is used on mobile devices.
     * @see https://developer.mozilla.org/en-US/docs/Web/HTML/Element/input#attr-capture
     * @return string|NULL
     */
    public function GetCapture ();

    /**
     * Set boolean attribute indicates that capture of media directly from the 
     * device's sensors using a media capture mechanism is preferred, 
     * such as a webcam or microphone. This HTML attribute is used on mobile devices.
     * @see https://developer.mozilla.org/en-US/docs/Web/HTML/Element/input#attr-capture
     * @param string|NULL $capture 
     * @return \MvcCore\Ext\Forms\Fields\File
     */
    public function SetCapture ($capture = 'camera');

    /**
     * Get allowed file name characters and characters groups for submit regular expression.
     * All regular expression special characters will be escaped by `addcslashes()` 
     * function to create proper regular expression pattern to keep only characters 
     * and characters groups presented in this variable. If there are not defined any 
     * characters, there is used in submit filename sanitization PHP constant: 
     * `\MvcCore\Ext\Forms\Validators\Files::ALLOWED_FILE_NAME_CHARS_DEFAULT`;
     * @return string|NULL
     */
    public function GetAllowedFileNameChars ();

    /**
     * Set allowed file name characters and characters groups for submit regular expression.
     * All regular expression special characters will be escaped by `addcslashes()` 
     * function to create proper regular expression pattern to keep only characters 
     * and characters groups presented in this variable. If there are not defined any 
     * characters, there is used in submit filename sanitization PHP constant: 
     * `\MvcCore\Ext\Forms\Validators\Files::ALLOWED_FILE_NAME_CHARS_DEFAULT`;
     * @param string|NULL $allowedFileNameChars
     * @return \MvcCore\Ext\Forms\Fields\File
     */
    public function SetAllowedFileNameChars ($allowedFileNameChars);

    /**
     * Get minimum uploaded files count. `NULL` by default.
     * This attribute is not HTML5, it's rendered as `data-min-count="..."`.
     * Attribute is not used on client side by default, but you can do it, it's
     * only checked if attribute is not `NULL` in submit processing.
     * @return int|NULL
     */
    public function GetMinCount ();

    /**
     * Set minimum uploaded files count. `NULL` by default.
     * This attribute is not HTML5, it's rendered as `data-min-count="..."`.
     * Attribute is not used on client side by default, but you can do it, it's
     * only checked if attribute is not `NULL` in submit processing.
     * @param int|NULL $minCount
     * @return \MvcCore\Ext\Forms\Fields\File
     */
    public function SetMinCount ($minCount);

    /**
     * Get maximum uploaded files count. `NULL` by default.
     * This attribute is not HTML5, it's rendered as `data-max-count="..."`.
     * Attribute is not used on client side by default, but you can do it, it's
     * only checked if attribute is not `NULL` in submit processing.
     * @return int|NULL
     */
    public function GetMaxCount ();

    /**
     * Set maximum uploaded files count. `NULL` by default.
     * This attribute is not HTML5, it's rendered as `data-max-count="..."`.
     * Attribute is not used on client side by default, but you can do it, it's
     * only checked if attribute is not `NULL` in submit processing.
     * @param int|NULL $maxCount
     * @return \MvcCore\Ext\Forms\Fields\File
     */
    public function SetMaxCount ($maxCount);

    /**
     * Get minimum uploaded file size for one uploaded item in bytes. `NULL` by default.
     * This attribute is not HTML5, it's rendered as `data-min-size="..."`.
     * Attribute is not used on client side by default, but you can do it, it's
     * only checked if attribute is not `NULL` in submit processing.
     * @return int|NULL
     */
    public function GetMinSize ();

    /**
     * Set minimum uploaded file size for one uploaded item in bytes. `NULL` by default.
     * This attribute is not HTML5, it's rendered as `data-min-size="..."`.
     * Attribute is not used on client side by default, but you can do it, it's
     * only checked if attribute is not `NULL` in submit processing.
     * @param int|NULL $minSize
     * @return \MvcCore\Ext\Forms\Fields\File
     */
    public function SetMinSize ($minSize);

    /**
     * Get maximum uploaded file size for one uploaded item in bytes. `NULL` by default.
     * This attribute is not HTML5, it's rendered as `data-max-size="..."`.
     * Attribute is not used on client side by default, but you can do it, it's
     * only checked if attribute is not `NULL` in submit processing.
     * @return int|NULL
     */
    public function GetMaxSize ();

    /**
     * Set maximum uploaded file size for one uploaded item in bytes. `NULL` by default.
     * This attribute is not HTML5, it's rendered as `data-max-size="..."`.
     * Attribute is not used on client side by default, but you can do it, it's
     * only checked if attribute is not `NULL` in submit processing.
     * @param int|NULL $maxSize
     * @return \MvcCore\Ext\Forms\Fields\File
     */
    public function SetMaxSize ($maxSize);

    /**
     * Set maximum number of allowed files count inside 
     * single uploaded archive file. If uploaded archive 
     * has more files inside than this number, it's 
     * proclaimed as archive bomb and it's not uploaded.
     * Default value is `1000`.
     * @param int $archiveMaxItems Default `1000`.
     * @return \MvcCore\Ext\Forms\Fields\File
     */
    public function SetArchiveMaxItems ($archiveMaxItems = 1000);
    
    /**
     * Get maximum number of allowed files count inside 
     * single uploaded archive file. If uploaded archive 
     * has more files inside than this number, it's 
     * proclaimed as archive bomb and it's not uploaded.
     * Default value is `1000`.
     * @return int
     */
    public function GetArchiveMaxItems ();

    /**
     * Maximum number of allowed ZIP archive levels inside.
     * If uploaded archive contains another zip archive and
     * those archive another and another, this is maximum
     * level for nested ZIP archives. If Archive contains 
     * more levels than this, it's proclaimed as archive 
     * bomb and it's not uploaded. Default value is `3`.
     * @param int $archiveMaxLevels Default `3`.
     * @return \MvcCore\Ext\Forms\Fields\File
     */
    public function SetArchiveMaxLevels ($archiveMaxLevels = 3);
    
    /**
     * Maximum number of allowed ZIP archive levels inside.
     * If uploaded archive contains another zip archive and
     * those archive another and another, this is maximum
     * level for nested ZIP archives. If Archive contains 
     * more levels than this, it's proclaimed as archive 
     * bomb and it's not uploaded. Default value is `3`.
     * @return int
     */
    public function GetArchiveMaxLevels ();

    /**
     * Set maximum archive compression percentage.
     * If archive file has lower percentage size
     * than all archive file items together, 
     * it's proclaimed as archive bomb and it's 
     * not uploaded.
     * @param float $archiveMaxCompressPercentage Default `10.0`.
     * @return \MvcCore\Ext\Forms\Fields\File
     */
    public function SetArchiveMaxCompressPercentage ($archiveMaxCompressPercentage = 10.0);
    
    /**
     * Get maximum archive compression percentage.
     * If archive file has lower percentage size
     * than all archive file items together, 
     * it's proclaimed as archive bomb and it's 
     * not uploaded.
     * @return float
     */
    public function GetArchiveMaxCompressPercentage ();

    /**
     * PNG image maximum width or maximum height.
     * PNG images use ZIP compression and that's why 
     * those images could be used as ZIP bombs.
     * This limit helps to prevent file bombs 
     * based on PNG images. Default value is `10000`.
     * @param int $pngImageMaxWidthHeight Default `10.0`.
     * @return \MvcCore\Ext\Forms\Fields\File
     */
    public function SetPngImageMaxWidthHeight ($pngImageMaxWidthHeight = 10000);
    
    /**
     * PNG image maximum width or maximum height.
     * PNG images use ZIP compression and that's why 
     * those images could be used as ZIP bombs.
     * This limit helps to prevent file bombs 
     * based on PNG images. Default value is `10000`.
     * @return int
     */
    public function GetPngImageMaxWidthHeight ();

    /**
     * Add bomb scanner class(es) to scan uploaded files for file bombs.
     * All classes in this list must implement interface:
     * `\MvcCore\Ext\Forms\Validators\Files\Validations\IBombScanner`.
     * @param \string[] $bombScannerClasses,...
     * @return \MvcCore\Ext\Forms\Fields\File
     */
    public function AddBombScanners ();
    
    /**
     * Set bomb scanner class(es) to scan uploaded files for file bombs.
     * All classes in this list must implement interface:
     * `\MvcCore\Ext\Forms\Validators\Files\Validations\IBombScanner`.
     * @param \string[] $bombScannerClasses
     * @return \MvcCore\Ext\Forms\Fields\File
     */
    public function SetBombScanners ();

    /**
     * Get bomb scanner class(es) to scan uploaded files for file bombs.
     * All classes in this list must implement interface:
     * `\MvcCore\Ext\Forms\Validators\Files\Validations\IBombScanner`.
     * @return \string[]
     */
    public function GetBombScanners ();
}