Skip to content

Commit

Permalink
Merge pull request #327 from boesing/docs/filesystem-option
Browse files Browse the repository at this point in the history 
Add new `FilesystemOptions` related to `Filesystem` v3.0
  • Loading branch information
@boesing
boesing authored Jul 10, 2024
2 parents 474aa79 + 2ae3146 commit d7ec131
Showing 1 changed file with 22 additions and 26 deletions.
48 changes: 22 additions & 26 deletions docs/book/v4/storage/adapter.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -534,14 +534,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 @@ -555,24 +555,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

0 comments on commit d7ec131

Please sign in to comment.