Skip to content

Commit db065d9

Browse files
committed
Refine cache driver and AJAX response docs
1 parent 83acc79 commit db065d9

4 files changed

Lines changed: 10 additions & 10 deletions

File tree

docs/development/legacy/libraries/cache.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -150,6 +150,6 @@ Checks to see if appropriate extensions and resources are available for a driver
150150

151151
ee()->cache->memcached->is_supported();
152152

153-
You can also check database driver support:
153+
You can also check database driver support (it returns `FALSE` if the cache table is unavailable):
154154

155155
ee()->cache->database->is_supported();

docs/development/legacy/libraries/output.md

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -163,8 +163,8 @@ NOTE: **Note:** Calling this method manually without aborting script execution w
163163

164164
| Parameter | Type | Description |
165165
| --------- | -------- | -------------------- |
166-
| \$msg | `Array` | Object to be sent to the client. |
167-
| \$statusCode | `Bool|Int` | HTTP status code. If `false`, status code is `200`. If `true`, status code is 500 |
166+
| \$msg | `Mixed` | Value to be encoded and sent to the client. |
167+
| \$statusCode | `Bool|Int` | HTTP status code. If `false`, status code is `200`. If `true`, status code is `500`. |
168168
| Returns | `Void` | void |
169169

170170
Calling this method encodes the given `$msg` parameter and sets the header `Content-Type: application/json`.
@@ -179,21 +179,21 @@ Example:
179179
);
180180
ee()->output->send_ajax_response($output);
181181

182-
With status code (401):
182+
With status code (`401`):
183183

184-
```
184+
```php
185185
$output = array(
186-
'sucess' => 'false',
186+
'success' => false,
187187
'message' => 'not allowed',
188188
);
189189
ee()->output->send_ajax_response($output, 401);
190190
```
191191

192192
As error with standard 500 error code:
193193

194-
```
194+
```php
195195
$output = array(
196-
'sucess' => 'false',
196+
'success' => false,
197197
'message' => 'not allowed',
198198
);
199199
ee()->output->send_ajax_response($output, true);

docs/general/system-configuration-overrides.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -511,7 +511,7 @@ Specify a different [caching driver](optimization/caching.md#caching-drivers) to
511511
| Values | Description |
512512
| --------- | -------------------------------------------------- |
513513
| file | File driver, /system/user/cache/ (default) |
514-
| database | Database driver, stores cache in `exp_cache` |
514+
| database | Database driver, stores cache in `{db_prefix}cache` (for example `exp_cache`) |
515515
| memcached | Memcached driver, configured with memcached config |
516516
| redis | Redis driver, configured with redis config |
517517
| dummy | Dummy driver, will not cache |

docs/optimization/caching.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -93,7 +93,7 @@ By default, ExpressionEngine uses a file-based caching driver, meaning cached it
9393

9494
ExpressionEngine also supports database, Memcached, and Redis caching drivers. You can set which driver is being used in the control panel or via the [cache_driver](general/system-configuration-overrides.md#cache_driver) config override. [Memcached](general/system-configuration-overrides.md#memcached) and [Redis](general/system-configuration-overrides.md#redis) server information can also be set in `config.php`, otherwise ExpressionEngine will try to connect to the default respective ports on localhost.
9595

96-
The database driver stores cache rows in `exp_cache`, which can reduce filesystem I/O but adds read/write load to your database server. For higher-throughput workloads, Memcached or Redis are generally better choices.
96+
The database driver stores cache rows in `{db_prefix}cache` (for example `exp_cache`), which can reduce filesystem I/O but adds read/write load to your database server. For higher-throughput workloads, Memcached or Redis are generally better choices.
9797

9898
A [backup driver](general/system-configuration-overrides.md#cache_driver_backup) can also be specified in the case your primary driver is unavailable. By default, the backup driver is the file driver and it's likely the best failover option due to its reliability, but the backup driver is configurable.
9999

0 commit comments

Comments
 (0)