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

Jump to bottom

Allow response caching of files and json content #371

Open
wants to merge 1 commit into
base: master
Choose a base branch
from
Open

Allow response caching of files and json content #371

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
6 changes: 4 additions & 2 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -351,8 +351,10 @@ $response->
noCache() // Tell the browser not to cache the response
redirect($url, $code = 302) // Redirect to the specified URL
dump($obj) // Dump an object
file($path, $filename = null) // Send a file
json($object, $jsonp_prefix = null) // Send an object as JSON or JSONP by providing padding prefix
file($path, $filename = null, $allow_caching = false)
// Send a file
json($object, $jsonp_prefix = null, $allow_caching = false)
// Send an object as JSON or JSONP by providing padding prefix

$service->
sharedData() // Return the shared data collection
Expand Down
26 changes: 17 additions & 9 deletions src/Klein/Response.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -74,20 +74,24 @@ public function dump($obj)
* currently in the response body and replaces it with
* the file's data
*
* @param string $path The path of the file to send
* @param string $filename The file's name
* @param string $mimetype The MIME type of the file
* @param string $path The path of the file to send
* @param string $filename The file's name
* @param string $mimetype The MIME type of the file
* @param boolean $allow_caching Wether or not to allow response caching
* @throws RuntimeException Thrown if the file could not be read
* @return Response
*/
public function file($path, $filename = null, $mimetype = null)
public function file($path, $filename = null, $mimetype = null, $allow_caching = false)
{
if ($this->sent) {
throw new ResponseAlreadySentException('Response has already been sent');
}

$this->body('');
$this->noCache();

if (false === $allow_caching) {
$this->noCache();
}

if (null === $filename) {
$filename = basename($path);
Expand Down Expand Up @@ -141,14 +145,18 @@ public function file($path, $filename = null, $mimetype = null)
* currently in the response body and replaces it with
* the passed json encoded object
*
* @param mixed $object The data to encode as JSON
* @param string $jsonp_prefix The name of the JSON-P function prefix
* @param mixed $object The data to encode as JSON
* @param string $jsonp_prefix The name of the JSON-P function prefix
* @param boolean $allow_caching Wether or not to allow response caching
* @return Response
*/
public function json($object, $jsonp_prefix = null)
public function json($object, $jsonp_prefix = null, $allow_caching = false)
{
$this->body('');
$this->noCache();

if (false === $allow_caching) {
$this->noCache();
}

$json = json_encode($object);

Expand Down
84 changes: 84 additions & 0 deletions tests/Klein/Tests/ResponseTest.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -464,6 +464,14 @@ function ($request, $response, $service) use ($file_name, $file_mime) {
$file_name,
$this->klein_app->response()->headers()->get('Content-Disposition')
);
$this->assertEquals(
'no-cache',
$this->klein_app->response()->headers()->get('Pragma')
);
$this->assertEquals(
'no-store, no-cache',
$this->klein_app->response()->headers()->get('Cache-Control')
);
}

public function testFileSendLooseArgs()
Expand Down Expand Up @@ -548,6 +556,47 @@ public function testFileSendCallsFastCGIFinishRequest()
$response->file(__FILE__);
}

public function testFileCacheable()
{
$file_name = 'testing';
$file_mime = 'text/plain';

$this->klein_app->respond(
function ($request, $response, $service) use ($file_name, $file_mime) {
$response->file(__FILE__, $file_name, $file_mime, true);
}
);

$this->klein_app->dispatch();

// Expect our output to match our file
$this->expectOutputString(
file_get_contents(__FILE__)
);

// Assert headers were passed
$this->assertEquals(
$file_mime,
$this->klein_app->response()->headers()->get('Content-Type')
);
$this->assertEquals(
filesize(__FILE__),
$this->klein_app->response()->headers()->get('Content-Length')
);
$this->assertContains(
$file_name,
$this->klein_app->response()->headers()->get('Content-Disposition')
);
$this->assertEquals(
null,
$this->klein_app->response()->headers()->get('Pragma')
);
$this->assertEquals(
null,
$this->klein_app->response()->headers()->get('Cache-Control')
);
}

public function testJSON()
{
// Create a test object to be JSON encoded/decoded
Expand Down Expand Up @@ -624,4 +673,39 @@ function ($request, $response, $service) use ($test_object, $prefix) {
$this->klein_app->response()->headers()->get('Content-Type')
);
}

public function testJSONCacheable()
{
// Create a test object to be JSON encoded/decoded
$test_object = array(
'cheese',
);

$this->klein_app->respond(
function ($request, $response, $service) use ($test_object) {
$response->json($test_object, null, true);
}
);

$this->klein_app->dispatch();

// Expect our output to match our json encoded test object
$this->expectOutputString(
json_encode($test_object)
);

// Assert headers were passed
$this->assertEquals(
null,
$this->klein_app->response()->headers()->get('Pragma')
);
$this->assertEquals(
null,
$this->klein_app->response()->headers()->get('Cache-Control')
);
$this->assertEquals(
'application/json',
$this->klein_app->response()->headers()->get('Content-Type')
);
}
}