Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add new FilesystemOptions related to Filesystem v3.0 #327

Merged
merged 2 commits into from
Jul 10, 2024
Merged

Add new FilesystemOptions related to Filesystem v3.0 #327

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
3d224aa
docs: add new filesystem adapter option `unserializable_classes`
boesing Jul 9, 2024
2ae3146
docs: add the version where the new option is added
boesing Jul 9, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
48 changes: 22 additions & 26 deletions docs/book/v4/storage/adapter.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -591,14 +591,14 @@ This adapter implements the following interfaces:

### Capabilities

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

### Metadata

Expand All @@ -612,24 +612,20 @@ This adapter implements the following interfaces:

### Adapter Specific Options

| Name | Data Type | Default Value | Description |
|-----------------------|------------------|------------------------|-------------------------------------------------------------------------------------|
| `namespace_separator` | `string` | ":" | A separator for the namespace and prefix |
| `cache_dir` | `string` | "" | Directory to store cache files. |
| `clear_stat_cache` | `boolean` | `true` | Call `clearstatcache()` enabled? |
| `dir_level` | `integer` | `1` | Defines how much sub-directories should be created. |
| `dir_permission` | `integer\|false` | `0700` | Set explicit permission on creating new directories. |
| `file_locking` | `boolean` | `true` | Lock files on writing. |
| `file_permission` | `integer` | `false` | 0600 Set explicit permission on creating new files. |
| `key_pattern` | `string` | `/^[a-z0-9_\+\-]*$/Di` | Validate key against pattern. |
| `no_atime` | `boolean` | `true` | Don’t get `fileatime` as `atime` on metadata. |
| `no_ctime` | `boolean` | `true` | Don’t get `filectime` as `ctime` on metadata. |
| `umask` | `integer\|false` | `false` | Use [umask](http://wikipedia.org/wiki/Umask) to set file and directory permissions. |
| `suffix` | `string` | `dat` | Suffix for cache files |
| `tag_suffix` | `string` | `tag` | Suffix for tag files |

Note: the `suffix` and `tag_suffix` options will be escaped in order to be safe
for glob operations.
| Name | Data Type | Default Value | Description |
|--------------------------|-----------------------------------------|------------------------|-------------------------------------------------------------------------------------------------------------------------|
| `namespace_separator` | `string` | ":" | A separator for the namespace and prefix |
| `cache_dir` | `string` | "" | Directory to store cache files. |
| `clear_stat_cache` | `boolean` | `true` | Call `clearstatcache()` enabled? |
| `dir_level` | `integer` | `1` | Defines how much sub-directories should be created. |
| `dir_permission` | `integer\|false` | `0700` | Set explicit permission on creating new directories. |
| `file_locking` | `boolean` | `true` | Lock files on writing. |
| `file_permission` | `integer` | `false` | 0600 Set explicit permission on creating new files. |
| `key_pattern` | `string` | `/^[a-z0-9_\+\-]*$/Di` | Validate key against pattern. |
| `no_atime` | `boolean` | `true` | Don’t get `fileatime` as `atime` on metadata. |
| `no_ctime` | `boolean` | `true` | Don’t get `filectime` as `ctime` on metadata. |
| `umask` | `integer\|false` | `false` | Use [umask](http://wikipedia.org/wiki/Umask) to set file and directory permissions. |
| `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. |

## Memcached Adapter

Expand Down