You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: docs/OPTIONS.md
+15-11Lines changed: 15 additions & 11 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -5,17 +5,17 @@ PhpFastCache has some options that you may want to know before using them, here'
5
5
***default_chmod**_| int>octal (default: 0777)_`[>=V4, <V7]` This option will define the chmod used to write driver cache files.
6
6
***defaultChmod**_| int>octal (default: 0777)_`[>=V7]` New configuration name of `default_chmod` as of V7
7
7
***securityKey**_| string (default: 'auto')_`[>=V4]` A security key that define the subdirectory name. 'auto' value will be the HTTP_HOST value.
8
-
***htaccess**_| bool (default: true)_`[>=V4]` Option designed to (dis)allow the auto-generation of .htaccess.
9
-
***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
10
-
***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.
8
+
***htaccess**_| bool (default: true)_`[>=V4]` Option designed to (dis)allow the auto-generation of .htaccess.
9
+
***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
10
+
***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.
11
11
***cacheFileExtension**_| string (default: 'txt')_`[>=V6.0.2]` This allows you to setup a custom (but safe) cache file extension.
12
12
13
13
\* Drivers like _Files_, _Sqlite_, _Leveldb_, etc.
14
14
15
15
### Global options
16
16
***fallback**_| string|bool_ (default: false)`[>=V4.2]` A driver name used in case the main driver stopped working. E.g. a missing php extension.
17
17
***fallbackConfig**_| ConfigurationOption|null_ (default: null)`[>=V7]` A dedicated `ConfigurationOption` object for the `fallback` driver, if needed.
18
-
***compress_data**_| bool (default: false)_`[>=V4.3]` Compress stored data, if the backend supports it. Currently only supported by _Memcache(d)_ driver.
18
+
***compress_data**_| bool (default: false)_`[>=V4.3]` Compress stored data, if the backend supports it. Currently only supported by _Memcache(d)_ driver.
19
19
***limited_memory_each_object**_| int (default: 4096)_`[>=V4.2]` Maximum size (bytes) of object stored in memory. Currently only supported by _Cookie_ driver.
20
20
***defaultTtl**_| int (default: 900)_`[>=V5]` This option define a default ttl (time-to-live, in seconds) for item that has no specified expiration date/ttl.
21
21
***itemDetailedDate**_| bool (default: false)_`[>=V6]` This option will define if the Items will make use of detailed dates such as Creation/modification date. Trying to access to these date without being explicitly enabled will throw a `LogicException`
@@ -25,13 +25,17 @@ PhpFastCache has some options that you may want to know before using them, here'
25
25
***cacheSlamsTimeout**_| int (default: 15)_`[>=V6]` This option defines the cache slams timeout in seconds
26
26
27
27
### Host/Authenticating options *
28
-
***host**_| string (default: not set)_ The hostname
29
-
***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
30
-
***port**_| int (default: not set)_ The port
31
-
***username**_| string (default: not set)_ The username
32
-
***password**_| string (default: not set)_ The password
33
-
***timeout**_| int (default: not set)_ The timeout (in seconds)
34
-
***servers**_| array (default: not set)_ Array of servers. Exclusive to Memcache(d)
28
+
***host**_| string (default: null)_ The hostname
29
+
***path**_| string (default: null|string[temp. dir.])_`[>=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
30
+
***port**_| int (default: null)_ The port
31
+
***username**_| string (default: null)_ The username
32
+
***password**_| string (default: null)_ The password
33
+
***timeout**_| int (default: null)_ The timeout (in seconds)
34
+
***servers**_| array (default: null)_ Array of servers. Exclusive to Memcache(d)
35
+
36
+
### Redis/Predis specific options
37
+
***redisClient**_| \Redis (default: null)_`[>=V7]` An optional Redis Client created outside Phpfastcache's scope. This option overrides every _Host/Authenticating_ options
38
+
***predisClient**_| \Predis\Client (default: null)_`[>=V7]` An optional Predis Client created outside Phpfastcache's scope. This option overrides every _Host/Authenticating_ options
35
39
36
40
These options differs depending the driver that you are using, see **/Examples** folder for more information about these options.
0 commit comments