Skip to content

Commit d7ec131

Browse files
authored
Merge pull request #327 from boesing/docs/filesystem-option
Add new `FilesystemOptions` related to `Filesystem` v3.0
2 parents 474aa79 + 2ae3146 commit d7ec131

File tree

1 file changed

+22
-26
lines changed

1 file changed

+22
-26
lines changed

docs/book/v4/storage/adapter.md

+22-26
Original file line numberDiff line numberDiff line change
@@ -534,14 +534,14 @@ This adapter implements the following interfaces:
534534

535535
### Capabilities
536536

537-
| Capability | Value |
538-
|----------------------|--------------------------------------------------------------------------------------------------|
539-
| `supportedDatatypes` | `string`, `null` => `string`, `boolean` => `string`, `integer` => `string`, `double` => `string` |
540-
| `ttlSupported` | `true` |
541-
| `ttlPrecision` | `1` |
542-
| `usesRequestTime` | `false` |
543-
| `maxKeyLength` | `251` |
544-
| `namespaceIsPrefix` | `true` |
537+
| Capability | Value |
538+
|----------------------|---------------------------------------------------------------------------------------------------|
539+
| `supportedDatatypes` | `string`, `null` => `string`, `boolean` => `string`, `integer` => `string`, `double` => `string` |
540+
| `ttlSupported` | `true` |
541+
| `ttlPrecision` | `1` |
542+
| `usesRequestTime` | `false` |
543+
| `maxKeyLength` | `249` (this is the maximum, but depending on the namespace being used, the length might be lower) |
544+
| `namespaceIsPrefix` | `true` |
545545

546546
### Metadata
547547

@@ -555,24 +555,20 @@ This adapter implements the following interfaces:
555555

556556
### Adapter Specific Options
557557

558-
| Name | Data Type | Default Value | Description |
559-
|-----------------------|------------------|------------------------|-------------------------------------------------------------------------------------|
560-
| `namespace_separator` | `string` | ":" | A separator for the namespace and prefix |
561-
| `cache_dir` | `string` | "" | Directory to store cache files. |
562-
| `clear_stat_cache` | `boolean` | `true` | Call `clearstatcache()` enabled? |
563-
| `dir_level` | `integer` | `1` | Defines how much sub-directories should be created. |
564-
| `dir_permission` | `integer\|false` | `0700` | Set explicit permission on creating new directories. |
565-
| `file_locking` | `boolean` | `true` | Lock files on writing. |
566-
| `file_permission` | `integer` | `false` | 0600 Set explicit permission on creating new files. |
567-
| `key_pattern` | `string` | `/^[a-z0-9_\+\-]*$/Di` | Validate key against pattern. |
568-
| `no_atime` | `boolean` | `true` | Don’t get `fileatime` as `atime` on metadata. |
569-
| `no_ctime` | `boolean` | `true` | Don’t get `filectime` as `ctime` on metadata. |
570-
| `umask` | `integer\|false` | `false` | Use [umask](http://wikipedia.org/wiki/Umask) to set file and directory permissions. |
571-
| `suffix` | `string` | `dat` | Suffix for cache files |
572-
| `tag_suffix` | `string` | `tag` | Suffix for tag files |
573-
574-
Note: the `suffix` and `tag_suffix` options will be escaped in order to be safe
575-
for glob operations.
558+
| Name | Data Type | Default Value | Description |
559+
|--------------------------|-----------------------------------------|------------------------|-------------------------------------------------------------------------------------------------------------------------|
560+
| `namespace_separator` | `string` | ":" | A separator for the namespace and prefix |
561+
| `cache_dir` | `string` | "" | Directory to store cache files. |
562+
| `clear_stat_cache` | `boolean` | `true` | Call `clearstatcache()` enabled? |
563+
| `dir_level` | `integer` | `1` | Defines how much sub-directories should be created. |
564+
| `dir_permission` | `integer\|false` | `0700` | Set explicit permission on creating new directories. |
565+
| `file_locking` | `boolean` | `true` | Lock files on writing. |
566+
| `file_permission` | `integer` | `false` | 0600 Set explicit permission on creating new files. |
567+
| `key_pattern` | `string` | `/^[a-z0-9_\+\-]*$/Di` | Validate key against pattern. |
568+
| `no_atime` | `boolean` | `true` | Don’t get `fileatime` as `atime` on metadata. |
569+
| `no_ctime` | `boolean` | `true` | Don’t get `filectime` as `ctime` on metadata. |
570+
| `umask` | `integer\|false` | `false` | Use [umask](http://wikipedia.org/wiki/Umask) to set file and directory permissions. |
571+
| `unserializable_classes` | `boolean\|non-empty-list<class-string>` | `true` | A list of classes which are allowed for unserialization when reading cache values. Available as of v3.0 of the adapter. |
576572

577573
## Memcached Adapter
578574

0 commit comments

Comments
 (0)