Skip to content

Commit 87caa1e

Browse files
committed
Rename classes to shorter name
1 parent 519b9e4 commit 87caa1e

File tree

3 files changed

+11
-11
lines changed

3 files changed

+11
-11
lines changed

README.md

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -24,7 +24,7 @@ Package is requires PHP version at least 7.3 and temporary directory with writab
2424
## Using
2525
Anywhere in your app you can determine if app is running in Debug mode by simple code:
2626
```php
27-
$detector = new \Redbitcz\DebugMode\DebugModeDetector($tempDir);
27+
$detector = new \Redbitcz\DebugMode\Detector($tempDir);
2828
$debugMode = $detector->isDebugMode(); // boolean
2929
```
3030
where `$tempDir` is required absolute path to temporary directory.
@@ -35,7 +35,7 @@ It returns `$debugMode` = `true` when is detected Debug environment or manually
3535
In `\App\Bootstrap` class use package like this example:
3636
```php
3737
$tempDir = __DIR__ . '/../temp';
38-
$debugModeDetector = new \Redbitcz\DebugMode\DebugModeDetector($tempDir);
38+
$debugModeDetector = new \Redbitcz\DebugMode\Detector($tempDir);
3939

4040
$configurator = new Configurator();
4141
$configurator->setDebugMode($debugModeDetector->isDebugMode());
@@ -70,7 +70,7 @@ Enabler provide feature to force enable or disable Debug Mode anywhere for user'
7070
7171
This example turn on Debug Mode for user's browser:
7272
```php
73-
$enabler = new \Redbitcz\DebugMode\DebugModeEnabler($tempDir);
73+
$enabler = new \Redbitcz\DebugMode\Enabler($tempDir);
7474
$enabler->activate(true);
7575
```
7676

@@ -83,7 +83,7 @@ $enabler->activate(true);
8383
Debug Mode Enabler (unlike Debug Mode Detector) can be simply served through DI Container with configuration in `config.neon`:
8484
```yaml
8585
services:
86-
- Redbitcz\DebugMode\DebugModeEnabler(%tempDir%)
86+
- Redbitcz\DebugMode\Enabler(%tempDir%)
8787
```
8888
8989
At most cases this example is creates second instance of `DebugModeEnabler` class because first one is already created
@@ -92,7 +92,7 @@ internally with `DebugModeDetector` instance in `Bootstrap`.
9292
To re-use already exists instance you can inject it to DI Container:
9393
```php
9494
$tempDir = __DIR__ . '/../temp';
95-
$debugModeDetector = new \Redbitcz\DebugMode\DebugModeDetector($tempDir);
95+
$debugModeDetector = new \Redbitcz\DebugMode\Detector($tempDir);
9696
9797
$configurator = new Configurator();
9898
$configurator->setDebugMode($debugModeDetector->isDebugMode());
@@ -103,7 +103,7 @@ Don't forget let it know to DI Container with service declaration in `config.neo
103103
```yaml
104104
services:
105105
debugModeEnabler:
106-
type: Redbitcz\DebugMode\DebugModeEnabler
106+
type: Redbitcz\DebugMode\Enabler
107107
imported: true
108108
```
109109

src/DebugModeDetector.php renamed to src/Detector.php

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -8,19 +8,19 @@
88

99
namespace Redbitcz\DebugMode;
1010

11-
class DebugModeDetector
11+
class Detector
1212
{
1313
private const DEBUG_ENV_NAME = 'APP_DEBUG';
1414

15-
/** @var DebugModeEnabler */
15+
/** @var Enabler */
1616
private $enabler;
1717

1818
public function __construct(string $tempDir)
1919
{
20-
$this->enabler = new DebugModeEnabler($tempDir);
20+
$this->enabler = new Enabler($tempDir);
2121
}
2222

23-
public function getEnabler(): DebugModeEnabler
23+
public function getEnabler(): Enabler
2424
{
2525
return $this->enabler;
2626
}

src/DebugModeEnabler.php renamed to src/Enabler.php

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,7 @@
1414
use Nette\Utils\JsonException;
1515
use Nette\Utils\Random;
1616

17-
class DebugModeEnabler
17+
class Enabler
1818
{
1919
private const STORAGE_FILE = '/debug/token.bin';
2020
private const DEBUG_COOKIE_NAME = 'app-debug-token';

0 commit comments

Comments
 (0)