Skip to content

Commit 6c7a3fa

Browse files
committed
Refactor to use case-insensitive method aliases.
Updated method calls from `Disposable::Email()` to `Disposable::email()` for consistency, while adding `Disposable::Email()` and similar as case-insensitive aliases. Adjusted documentation and examples accordingly.
1 parent deda2bf commit 6c7a3fa

4 files changed

Lines changed: 19 additions & 18 deletions

File tree

docs/.vitepress/theme/components/HomeLanding.vue

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -52,7 +52,7 @@ import { withBase } from 'vitepress'
5252
<span></span>
5353
<span></span>
5454
</div>
55-
<pre class="home-code-body"><span>composer require erag/laravel-disposable-email</span><span>php artisan erag:install-disposable-email</span><span></span><span>$request-&gt;validate([</span><span> 'email' =&gt; ['required', 'email', 'disposable_email'],</span><span>]);</span><span></span><span>if (Disposable::Email($email)) {</span><span> // stop temp inboxes early</span><span>}</span></pre>
55+
<pre class="home-code-body"><span>composer require erag/laravel-disposable-email</span><span>php artisan erag:install-disposable-email</span><span></span><span>$request-&gt;validate([</span><span> 'email' =&gt; ['required', 'email', 'disposable_email'],</span><span>]);</span><span></span><span>if (Disposable::email($email)) {</span><span> // stop temp inboxes early</span><span>}</span></pre>
5656
</div>
5757
</div>
5858

@@ -92,13 +92,13 @@ import { withBase } from 'vitepress'
9292
Use the new <code>Disposable</code> facade for quick checks, inspect detailed match
9393
results when you need more context, and manage trusted or subdomain behavior from config.
9494
</p>
95-
<pre class="home-release-code"><span>Disposable::Email('test@tempmail.com');</span><span>Disposable::domain('tempmail.com');</span><span>$result = Disposable::check($email);</span></pre>
95+
<pre class="home-release-code"><span>Disposable::email('test@tempmail.com');</span><span>Disposable::Email('test@tempmail.com');</span><span>$result = Disposable::Check($email);</span></pre>
9696
</div>
9797
<div class="home-release-list">
9898
<div>
9999
<span>API</span>
100100
<strong>Short facade methods</strong>
101-
<p><code>Email</code>, <code>domain</code>, <code>check</code>, and <code>rule</code>.</p>
101+
<p><code>email</code>, <code>Email</code>, <code>check</code>, <code>Check</code>, and <code>rule</code>.</p>
102102
</div>
103103
<div>
104104
<span>RESULT</span>
@@ -167,7 +167,7 @@ import { withBase } from 'vitepress'
167167
</div>
168168
<div class="home-example-card">
169169
<strong>Facade</strong>
170-
<pre class="home-example-code"><span>use Disposable;</span><span></span><span>if (Disposable::Email($email)) {</span><span> throw ValidationException::withMessages([</span><span> 'email' =&gt; 'Use a permanent inbox.'</span><span> ]);</span><span>}</span></pre>
170+
<pre class="home-example-code"><span>use Disposable;</span><span></span><span>if (Disposable::email($email)) {</span><span> throw ValidationException::withMessages([</span><span> 'email' =&gt; 'Use a permanent inbox.'</span><span> ]);</span><span>}</span></pre>
171171
</div>
172172
<div class="home-example-card">
173173
<strong>Blade</strong>

docs/deprecated-5-0-0.md

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -26,7 +26,7 @@ Use `Disposable` instead:
2626
```php
2727
use Disposable;
2828

29-
Disposable::Email('test@tempmail.com');
29+
Disposable::email('test@tempmail.com');
3030
Disposable::domain('test@tempmail.com');
3131
```
3232

@@ -35,7 +35,7 @@ Or import the package facade by namespace:
3535
```php
3636
use EragLaravelDisposableEmail\Facades\Disposable;
3737

38-
Disposable::Email('test@tempmail.com');
38+
Disposable::email('test@tempmail.com');
3939
Disposable::domain('test@tempmail.com');
4040
```
4141

@@ -50,14 +50,14 @@ DisposableEmail::isDisposable($email);
5050
The package now registers this alias:
5151

5252
```php
53-
Disposable::Email($email);
53+
Disposable::email($email);
5454
Disposable::domain($emailOrDomain);
5555
```
5656

5757
The same methods are available through the namespaced facade:
5858

5959
```php
60-
EragLaravelDisposableEmail\Facades\Disposable::Email($email);
60+
EragLaravelDisposableEmail\Facades\Disposable::email($email);
6161
EragLaravelDisposableEmail\Facades\Disposable::domain($emailOrDomain);
6262
```
6363

@@ -78,7 +78,7 @@ With:
7878
```php
7979
use Disposable;
8080

81-
if (Disposable::Email($email)) {
81+
if (Disposable::email($email)) {
8282
// Handle disposable email
8383
}
8484
```
@@ -92,7 +92,7 @@ Replace API responses:
9292
With:
9393

9494
```php
95-
'disposable' => Disposable::Email($email),
95+
'disposable' => Disposable::email($email),
9696
```
9797

9898
## Domain checks

docs/troubleshooting.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -150,15 +150,15 @@ If you want to confirm a result in your own code, use a direct runtime check:
150150
```php
151151
use Disposable;
152152

153-
$isDisposable = Disposable::Email('test@tempmail.com');
153+
$isDisposable = Disposable::email('test@tempmail.com');
154154
```
155155

156156
You can also use the namespaced facade:
157157

158158
```php
159159
use EragLaravelDisposableEmail\Facades\Disposable;
160160

161-
$isDisposable = Disposable::Email('test@tempmail.com');
161+
$isDisposable = Disposable::email('test@tempmail.com');
162162
```
163163

164164
This is often the fastest way to confirm whether the package is seeing the domain the way you expect.

docs/validation-and-runtime.md

Lines changed: 7 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -191,7 +191,7 @@ Use the short facade when you need a simple boolean result outside request valid
191191
```php
192192
use Disposable;
193193

194-
if (Disposable::Email('test@tempmail.com')) {
194+
if (Disposable::email('test@tempmail.com')) {
195195
// Handle disposable email
196196
}
197197

@@ -205,19 +205,20 @@ You can also import the package facade namespace directly:
205205
```php
206206
use EragLaravelDisposableEmail\Facades\Disposable;
207207

208-
if (Disposable::Email('test@tempmail.com')) {
208+
if (Disposable::email('test@tempmail.com')) {
209209
// Handle disposable email
210210
}
211211
```
212212

213213
## 10. Detailed runtime check <span class="doc-new-badge">New</span> {#detailed-runtime-check}
214214

215-
Use `Disposable::check()` when you need more than a boolean:
215+
Use `Disposable::check()` when you need more than a boolean. `Disposable::Check()` also works as a case-insensitive alias:
216216

217217
```php
218218
use Disposable;
219219

220220
$result = Disposable::check('test@tempmail.com');
221+
$sameResult = Disposable::Check('test@tempmail.com');
221222

222223
$result->disposable(); // true
223224
$result->domain(); // tempmail.com
@@ -244,7 +245,7 @@ class SignupPolicy
244245
{
245246
public function assertAllowedEmail(string $email): void
246247
{
247-
if (Disposable::Email($email)) {
248+
if (Disposable::email($email)) {
248249
throw ValidationException::withMessages([
249250
'email' => 'Please use a permanent email address.',
250251
]);
@@ -260,7 +261,7 @@ If you prefer the short facade style, you can use:
260261
```php
261262
use Disposable;
262263

263-
if (Disposable::Email('amit@agedmail.com')) {
264+
if (Disposable::email('amit@agedmail.com')) {
264265
// Handle disposable email
265266
}
266267
```
@@ -282,7 +283,7 @@ Route::post('/email/check', function (Request $request) {
282283

283284
return response()->json([
284285
'email' => $email,
285-
'disposable' => Disposable::Email($email),
286+
'disposable' => Disposable::email($email),
286287
]);
287288
});
288289
```

0 commit comments

Comments
 (0)