Permalink
Browse files

Clarify docs.

  • Loading branch information...
1 parent abe74ad commit 028795eb2e9ae33a4a4c50e96b4971106177adc2 @markstory markstory committed Aug 25, 2012
Showing with 4 additions and 5 deletions.
  1. +4 −5 lib/Cake/Network/CakeResponse.php
View
9 lib/Cake/Network/CakeResponse.php
@@ -1083,12 +1083,11 @@ public function length($bytes = null) {
* is marked as so accordingly so the client can be informed of that.
*
* In order to mark a response as not modified, you need to set at least
- * the Last-Modified response header or a response etag to be compared
- * with the request itself
+ * the Last-Modified etag response header before calling this method. Otherwise
+ * a comparison will not be possible.
*
- * @return boolean whether the response was marked as not modified or
- * not
- **/
+ * @return boolean whether the response was marked as not modified or not.
+ */
public function checkNotModified(CakeRequest $request) {
$etags = preg_split('/\s*,\s*/', $request->header('If-None-Match'), null, PREG_SPLIT_NO_EMPTY);
$modifiedSince = $request->header('If-Modified-Since');

0 comments on commit 028795e

Please sign in to comment.