Skip to content

Commit e223437

Browse files
committed
Display __construct params in docs
1 parent 46bcda9 commit e223437

File tree

1 file changed

+30
-0
lines changed

1 file changed

+30
-0
lines changed

README.md

Lines changed: 30 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -63,6 +63,8 @@ public function rules()
6363

6464
The field under validation must contain ASCII chars only.
6565

66+
public Arifszn\AdvancedValidation\Rules\Ascii::__construct(string $errorMessage = null)
67+
6668
```php
6769
use Arifszn\AdvancedValidation\Rules\Ascii;
6870

@@ -78,6 +80,8 @@ public function rules()
7880

7981
The field under validation must be a Base64 encoded image.
8082

83+
public Arifszn\AdvancedValidation\Rules\Base64Image::__construct(string $errorMessage = null)
84+
8185
```php
8286
use Arifszn\AdvancedValidation\Rules\Base64Image;
8387

@@ -93,6 +97,8 @@ public function rules()
9397

9498
The field under validation must be a Base64 encoded string.
9599

100+
public Arifszn\AdvancedValidation\Rules\Base64String::__construct(string $errorMessage = null)
101+
96102
```php
97103
use Arifszn\AdvancedValidation\Rules\Base64String;
98104

@@ -108,6 +114,8 @@ public function rules()
108114

109115
The field under validation must be a BIC([Business Identifier Code](https://en.wikipedia.org/wiki/ISO_9362)) or SWIFT code.
110116

117+
public Arifszn\AdvancedValidation\Rules\BIC::__construct(string $errorMessage = null)
118+
111119
```php
112120
use Arifszn\AdvancedValidation\Rules\BIC;
113121

@@ -123,6 +131,8 @@ public function rules()
123131

124132
The field under validation must be a valid BTC address.
125133

134+
public Arifszn\AdvancedValidation\Rules\BtcAddress::__construct(string $errorMessage = null)
135+
126136
```php
127137
use Arifszn\AdvancedValidation\Rules\BtcAddress;
128138

@@ -138,6 +148,8 @@ public function rules()
138148

139149
The field under validation must be a valid credit card number.
140150

151+
public Arifszn\AdvancedValidation\Rules\CreditCard::__construct(string $errorMessage = null)
152+
141153
```php
142154
use Arifszn\AdvancedValidation\Rules\CreditCard;
143155

@@ -153,6 +165,8 @@ public function rules()
153165

154166
The field under validation must have [data uri format](https://developer.mozilla.org/en-US/docs/Web/HTTP/Basics_of_HTTP/Data_URIs).
155167

168+
public Arifszn\AdvancedValidation\Rules\DataURI::__construct(string $errorMessage = null)
169+
156170
```php
157171
use Arifszn\AdvancedValidation\Rules\DataURI;
158172

@@ -168,6 +182,8 @@ public function rules()
168182

169183
The field under validation must be divisible by the given number.
170184

185+
public Arifszn\AdvancedValidation\Rules\DivisibleBy::__construct(int $number, string $errorMessage = null)
186+
171187
```php
172188
use Arifszn\AdvancedValidation\Rules\DivisibleBy;
173189

@@ -182,6 +198,8 @@ public function rules()
182198
### `EthereumAddress`
183199
The field under validation must be an [Ethereum](https://ethereum.org/en/) address. Does not validate address checksums.
184200

201+
public Arifszn\AdvancedValidation\Rules\EthereumAddress::__construct(string $errorMessage = null)
202+
185203
```php
186204
use Arifszn\AdvancedValidation\Rules\EthereumAddress;
187205

@@ -197,6 +215,8 @@ public function rules()
197215

198216
The field under validation must be a float number.
199217

218+
public Arifszn\AdvancedValidation\Rules\FloatNumber::__construct(string $errorMessage = null)
219+
200220
```php
201221
use Arifszn\AdvancedValidation\Rules\FloatNumber;
202222

@@ -214,6 +234,8 @@ The field under validation must be a hash of type algorithm.
214234

215235
Algorithm is one of `'md4', 'md5', 'sha1', 'sha256', 'sha384', 'sha512', 'ripemd128', 'ripemd160', 'tiger128', 'tiger160', 'tiger192', 'crc32', 'crc32b'`.
216236

237+
public Arifszn\AdvancedValidation\Rules\Hash::__construct(string $algorithm, string $errorMessage = null)
238+
217239
```php
218240
use Arifszn\AdvancedValidation\Rules\Hash;
219241

@@ -229,6 +251,8 @@ public function rules()
229251

230252
The field under validation must be a valid image URL.
231253

254+
public Arifszn\AdvancedValidation\Rules\ImageURL::__construct(string $errorMessage = null)
255+
232256
https://www.php.net/images/logos/php-logo.png \
233257
https://imaginarysite123.com/invalid.png
234258

@@ -252,6 +276,8 @@ The field under validation must be a valid phone number.
252276
✓ (xxx) xxx-xxxx \
253277
✓ xxxxxxxxxx
254278

279+
public Arifszn\AdvancedValidation\Rules\Phone::__construct(string $errorMessage = null)
280+
255281
```php
256282
use Arifszn\AdvancedValidation\Rules\Phone;
257283

@@ -272,6 +298,8 @@ The field under validation must be a valid username.
272298
- multiple underscores, minus and are not allowed (-- or __ or ..)
273299
- underscores, minus and dot are not allowed at the beginning or end
274300

301+
public Arifszn\AdvancedValidation\Rules\Username::__construct(string $errorMessage = null)
302+
275303
```php
276304
use Arifszn\AdvancedValidation\Rules\Username;
277305

@@ -287,6 +315,8 @@ public function rules()
287315

288316
The field under validation must not contain spaces.
289317

318+
public Arifszn\AdvancedValidation\Rules\WithoutSpaces::__construct(string $errorMessage = null)
319+
290320
```php
291321
use Arifszn\AdvancedValidation\Rules\WithoutSpaces;
292322

0 commit comments

Comments
 (0)