15763260878

Committed 19 Jun 2025 05:19PM UTC coverage: 93.011%. Remained the same

Build Type

push

github

Committed by

Commit Message

netteForms: restructured package, includes UMD and ESM (BC break)

Run Details

2076 of 2232 relevant lines covered (93.01%)

0.93 hits per line

Source File
Press 'n' to go to next uncovered line, 'b' for previous

92.86

/src/Forms/Controls/UploadControl.php

<?php

/**
 * This file is part of the Nette Framework (https://nette.org)
 * Copyright (c) 2004 David Grudl (https://davidgrudl.com)
 */

declare(strict_types=1);

namespace Nette\Forms\Controls;

use Nette;
use Nette\Forms;
use Nette\Forms\Form;
use Nette\Http\FileUpload;
use Nette\Utils\Arrays;
use Stringable;
use function implode, ini_get, is_array;


/**
 * Text box and browse button that allow users to select a file to upload to the server.
 */
class UploadControl extends BaseControl
{
        /** validation rule */
        public const Valid = ':uploadControlValid';

        #[\Deprecated('use UploadControl::Valid')]
        public const VALID = self::Valid;

        private bool $nullable = false;


        public function __construct(string|Stringable|null $label = null, bool $multiple = false)
        {
                parent::__construct($label);
                $this->control->type = 'file';
                $this->control->multiple = $multiple;
                $this->setOption('type', 'file');
                $this->addCondition(true) // not to block the export of rules to JS
                        ->addRule($this->isOk(...), Forms\Validator::$messages[self::Valid]);
                $this->addRule(Form::MaxFileSize, null, Forms\Helpers::iniGetSize('upload_max_filesize'));
                if ($multiple) {
                        $this->addRule(Form::MaxLength, 'The maximum allowed number of uploaded files is %d', (int) ini_get('max_file_uploads'));
                }

                $this->monitor(Form::class, function (Form $form): void {
                        if (!$form->isMethod('post')) {
                                throw new Nette\InvalidStateException('File upload requires method POST.');
                        }

                        $form->getElementPrototype()->enctype = 'multipart/form-data';
                });
        }


        public function loadHttpData(): void
        {
                $this->value = $this->getHttpData(Form::DataFile);
        }


        public function getHtmlName(): string
        {
                return parent::getHtmlName() . ($this->control->multiple ? '[]' : '');
        }


        /**
         * @internal
         */
        public function setValue($value): static
        {
                return $this;
        }


        public function getValue(): FileUpload|array|null
        {
                return $this->value ?? ($this->nullable ? null : new FileUpload(null));
        }


        /**
         * Has been any file uploaded?
         */
        public function isFilled(): bool
        {
                return (bool) $this->value;
        }


        /**
         * Sets whether getValue() returns null instead of FileUpload with error UPLOAD_ERR_NO_FILE.
         */
        public function setNullable(bool $value = true): static
        {
                $this->nullable = $value;
                return $this;
        }


        public function isNullable(): bool
        {
                return $this->nullable;
        }


        /**
         * Have been all files successfully uploaded?
         * @internal
         */
        public function isOk(): bool
        {
                return match (true) {
                        !$this->value => false,
                        is_array($this->value) => Arrays::every($this->value, fn(FileUpload $upload): bool => $upload->isOk()),
                        default => $this->value->isOk(),
                };
        }


        public function addRule(
                callable|string $validator,
                string|Stringable|null $errorMessage = null,
                mixed $arg = null,
        ): static
        {
                if ($validator === Form::Image) {
                        $this->control->accept = implode(', ', Forms\Helpers::getSupportedImages());

                } elseif ($validator === Form::MimeType) {
                        $this->control->accept = implode(', ', (array) $arg);

                } elseif ($validator === Form::MaxFileSize) {
                        if ($arg > ($ini = Forms\Helpers::iniGetSize('upload_max_filesize'))) {
                                trigger_error("Value of MaxFileSize ($arg) is greater than value of directive upload_max_filesize ($ini).", E_USER_WARNING);
                        }
                        $this->getRules()->removeRule($validator);

                } elseif ($validator === Form::MaxLength) {
                        if ($arg > ($ini = ini_get('max_file_uploads'))) {
                                trigger_error("Value of MaxLength ($arg) is greater than value of directive max_file_uploads ($ini).", E_USER_WARNING);
                        }
                        $this->getRules()->removeRule($validator);
                }

                return parent::addRule($validator, $errorMessage, $arg);
        }
}

1	<?php
2
3	/**
4	* This file is part of the Nette Framework (https://nette.org)
5	* Copyright (c) 2004 David Grudl (https://davidgrudl.com)
6	*/
7
8	declare(strict_types=1);
9
10	namespace Nette\Forms\Controls;
11
12	use Nette;
13	use Nette\Forms;
14	use Nette\Forms\Form;
15	use Nette\Http\FileUpload;
16	use Nette\Utils\Arrays;
17	use Stringable;
18	use function implode, ini_get, is_array;
19
20
21	/**
22	* Text box and browse button that allow users to select a file to upload to the server.
23	*/
24	class UploadControl extends BaseControl
25	{
26	/** validation rule */
27	public const Valid = ':uploadControlValid';
28
29	#[\Deprecated('use UploadControl::Valid')]
30	public const VALID = self::Valid;
31
32	private bool $nullable = false;
33
34
35	public function __construct(string\|Stringable\|null $label = null, bool $multiple = false)	1✔
36	{
37	parent::__construct($label);	1✔
38	$this->control->type = 'file';	1✔
39	$this->control->multiple = $multiple;	1✔
40	$this->setOption('type', 'file');	1✔
41	$this->addCondition(true) // not to block the export of rules to JS	1✔
42	->addRule($this->isOk(...), Forms\Validator::$messages[self::Valid]);	1✔
43	$this->addRule(Form::MaxFileSize, null, Forms\Helpers::iniGetSize('upload_max_filesize'));	1✔
44	if ($multiple) {	1✔
45	$this->addRule(Form::MaxLength, 'The maximum allowed number of uploaded files is %d', (int) ini_get('max_file_uploads'));	1✔
46	}
47
48	$this->monitor(Form::class, function (Form $form): void {	1✔
49	if (!$form->isMethod('post')) {	1✔
50	throw new Nette\InvalidStateException('File upload requires method POST.');
51	}
52
53	$form->getElementPrototype()->enctype = 'multipart/form-data';	1✔
54	});	1✔
55	}	1✔
56
57
58	public function loadHttpData(): void
59	{
60	$this->value = $this->getHttpData(Form::DataFile);	1✔
61	}	1✔
62
63
64	public function getHtmlName(): string
65	{
66	return parent::getHtmlName() . ($this->control->multiple ? '[]' : '');	1✔
67	}
68
69
70	/**
71	* @internal
72	*/
73	public function setValue($value): static
74	{
75	return $this;	1✔
76	}
77
78
79	public function getValue(): FileUpload\|array\|null
80	{
81	return $this->value ?? ($this->nullable ? null : new FileUpload(null));	1✔
82	}
83
84
85	/**
86	* Has been any file uploaded?
87	*/
88	public function isFilled(): bool
89	{
90	return (bool) $this->value;	1✔
91	}
92
93
94	/**
95	* Sets whether getValue() returns null instead of FileUpload with error UPLOAD_ERR_NO_FILE.
96	*/
97	public function setNullable(bool $value = true): static	1✔
98	{
99	$this->nullable = $value;	1✔
100	return $this;	1✔
101	}
102
103
104	public function isNullable(): bool
105	{
106	return $this->nullable;	×
107	}
108
109
110	/**
111	* Have been all files successfully uploaded?
112	* @internal
113	*/
114	public function isOk(): bool
115	{
116	return match (true) {
117	!$this->value => false,	1✔
118	is_array($this->value) => Arrays::every($this->value, fn(FileUpload $upload): bool => $upload->isOk()),	1✔
119	default => $this->value->isOk(),	1✔
120	};
121	}
122
123
124	public function addRule(	1✔
125	callable\|string $validator,
126	string\|Stringable\|null $errorMessage = null,
127	mixed $arg = null,
128	): static
129	{
130	if ($validator === Form::Image) {	1✔
131	$this->control->accept = implode(', ', Forms\Helpers::getSupportedImages());	1✔
132
133	} elseif ($validator === Form::MimeType) {	1✔
134	$this->control->accept = implode(', ', (array) $arg);	1✔
135
136	} elseif ($validator === Form::MaxFileSize) {	1✔
137	if ($arg > ($ini = Forms\Helpers::iniGetSize('upload_max_filesize'))) {	1✔
138	trigger_error("Value of MaxFileSize ($arg) is greater than value of directive upload_max_filesize ($ini).", E_USER_WARNING);	×
139	}
140	$this->getRules()->removeRule($validator);	1✔
141
142	} elseif ($validator === Form::MaxLength) {	1✔
143	if ($arg > ($ini = ini_get('max_file_uploads'))) {	1✔
144	trigger_error("Value of MaxLength ($arg) is greater than value of directive max_file_uploads ($ini).", E_USER_WARNING);	×
145	}
146	$this->getRules()->removeRule($validator);	1✔
147	}
148
149	return parent::addRule($validator, $errorMessage, $arg);	1✔
150	}
151	}

nette / forms / 15763260878

Source File Press 'n' to go to next uncovered line, 'b' for previous

Source File
Press 'n' to go to next uncovered line, 'b' for previous