Skip to content

Commit b8cf69d

Browse files
committed
Updated options.md
1 parent f7b554c commit b8cf69d

File tree

1 file changed

+4
-2
lines changed

1 file changed

+4
-2
lines changed

docs/OPTIONS.md

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,9 @@
11
PhpFastCache has some options that you may want to know before using them, here's the list:
22

33
### File-based drivers options *
4+
* **path** See the "**Host/Authenticating options**" section
45
* **default_chmod** _| int>octal (default: 0777)_ `[>=V4]` This option will define the chmod used to write driver cache files.
56
* **securityKey** _| string (default: 'auto')_ `[>=V4]` A security key that define the subdirectory name. 'auto' value will be the HTTP_HOST value.
6-
* **path** _| string (default: Tmp directory)_ `[>=V4]` The absolute path where the written cache files belong to.
77
* **htaccess** _| bool (default: true)_ `[>=V4]` Option designed to (dis)allow the auto-generation of .htaccess.
88
* **autoTmpFallback** _| bool (default: false)_ `[>=V6]`Option designed to automatically attempt to fallback to temporary directory if the cache fails to write on the specified directory
99
* **secureFileManipulation** _| bool (default: false)_ `[>=V6]` This option enforces a strict I/O manipulation policy by adding more integrity checks. This option may slow down the write operations, therefore you must use it with caution. In case of failure an **phpFastCacheIOException** exception will be thrown. Currently only supported by _Files_ driver.
@@ -22,11 +22,13 @@ PhpFastCache has some options that you may want to know before using them, here'
2222
* **cacheSlamsTimeout** _| int (default: 15)_ `[>=V6]` This option defines the cache slams timeout in seconds
2323

2424
### Host/Authenticating options *
25-
* **host** _| string (default: not set)_ The host
25+
* **host** _| string (default: not set)_ The hostname
26+
* **path** _| string (default: not set)_ `[>=V4], [>=V6.1]` The absolute path where the written cache files belong to (system temp directory by default). **As of the V6.1** this option is also used to define (P)redis and Memcache(d) UNIX socket
2627
* **port** _| int (default: not set)_ The port
2728
* **username** _| string (default: not set)_ The username
2829
* **password** _| string (default: not set)_ The password
2930
* **timeout** _| int (default: not set)_ The timeout (in seconds)
31+
* **servers** _| array (default: not set)_ Array of servers. Exclusive to Memcache(d)
3032

3133
These options differs depending the driver that you are using, see **/Examples** folder for more information about these options.
3234

0 commit comments

Comments
 (0)