Skip to content

Commit 091679a

Browse files
authored
Merge pull request #13 from JorgenEvens/chore/update-readme
[docs] Update README with realpath.
2 parents ebdf807 + b0564a1 commit 091679a

File tree

1 file changed

+48
-1
lines changed

1 file changed

+48
-1
lines changed

README.md

Lines changed: 48 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,13 +1,20 @@
11
php-cache-dashboard
22
===================
33

4-
A dashboard for PHP Opcache and APCu
4+
A dashboard for
5+
[PHP Opcache](http://php.net/manual/en/intro.opcache.php),
6+
[APCu](http://php.net/manual/en/intro.apcu.php) and
7+
[realpath](http://php.net/manual/en/function.realpath-cache-get.php)
58

69
## Prerequisites
710

811
- PHP
12+
13+
and one or more of the supported caches
14+
915
- PHP OpCache (opcache extension for php5, included by default in php5.5+)
1016
- APC or APCu extension
17+
- Realpath cache ( available since PHP 5.3.2+ )
1118

1219
## Supported operations
1320

@@ -17,6 +24,8 @@ A dashboard for PHP Opcache and APCu
1724
- Delete keys based on regular expression
1825
- Selecting all keys
1926
- Deleting keys without regular expressions
27+
- Sort on any data column
28+
- View APCu entry contents
2029

2130
## Usage
2231

@@ -25,6 +34,44 @@ Navigate to the page using your browser and you will receive cache information.
2534

2635
![Screenshot of php-cache-dashboard](http://jorgen.evens.eu/github/php-cache-dashboard.png)
2736

37+
## Disabling caches
38+
39+
Information about specific caches can be disabled by setting the `ENABLE_<cache>` key to false.
40+
The default code tests whether the specific cache is available and supported before enabling it.
41+
42+
### APC / APCu
43+
44+
```php
45+
<?php
46+
// Enable APC
47+
define('ENABLE_APC', true);
48+
49+
// Disable APC
50+
define('ENABLE_APC', false);
51+
```
52+
53+
### OPcache
54+
55+
```php
56+
<?php
57+
// Enable OPcache
58+
define('ENABLE_OPCACHE', true);
59+
60+
// Disable OPcache
61+
define('ENABLE_OPCACHE', false);
62+
```
63+
64+
### Realpath
65+
66+
```php
67+
<?php
68+
// Enable Realpath
69+
define('ENABLE_REALPATH', true);
70+
71+
// Disable Realpath
72+
define('ENABLE_REALPATH', false);
73+
```
74+
2875
## Contributing
2976

3077
I really appreciate any contribution you would like to make, so don't hesitate to report an issue or submit pull requests.

0 commit comments

Comments
 (0)