tonyair/silverstripe-framework
1
0
Fork 0
mirror of https://github.com/silverstripe/silverstripe-framework synced 2024-10-22 14:05:37 +02:00
Code Issues Projects Releases Wiki Activity

Add Form::canBeCached() method

Browse Source
This commit is contained in:
Damian Mooyman 2018-06-14 11:17:21 +12:00
parent 6b68495c0d
commit e93289326e
No known key found for this signature in database
GPG Key ID: 78B823A10DE27D1A
1 changed files with 34 additions and 20 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

54
src/Forms/Form.php
View File

@ -5,7 +5,6 @@ namespace SilverStripe\Forms;
use BadMethodCallException;
use SilverStripe\Control\Controller;
use SilverStripe\Control\HasRequestHandler;
use SilverStripe\Control\HTTP;
use SilverStripe\Control\HTTPRequest;
use SilverStripe\Control\Middleware\HTTPCacheControlMiddleware;
use SilverStripe\Control\NullHTTPRequest;
@ -869,25 +868,6 @@ class Form extends ViewableData implements HasRequestHandler
{
$exclude = (is_string($attrs)) ? func_get_args() : null;
// Figure out if we can cache this form
// - forms with validation shouldn't be cached, cos their error messages won't be shown
// - forms with security tokens shouldn't be cached because security tokens expire
$needsCacheDisabled = false;
if ($this->getSecurityToken()->isEnabled()) {
$needsCacheDisabled = true;
}
if ($this->FormMethod() != 'GET') {
$needsCacheDisabled = true;
}
if (!($this->validator instanceof RequiredFields) || count($this->validator->getRequired())) {
$needsCacheDisabled = true;
}
// If we need to disable cache, do it
if ($needsCacheDisabled) {
HTTPCacheControlMiddleware::singleton()->disableCache();
}
$attrs = $this->getAttributes();
// Remove empty
@ -1569,6 +1549,10 @@ class Form extends ViewableData implements HasRequestHandler
*/
public function forTemplate()
{
if (!$this->canBeCached()) {
HTTPCacheControlMiddleware::singleton()->disableCache();
}
$return = $this->renderWith($this->getTemplates());
// Now that we're rendered, clear message
@ -1824,4 +1808,34 @@ class Form extends ViewableData implements HasRequestHandler
{
return FormRequestHandler::create($this);
}
/**
* Can the body of this form be cached?
*
* Figure out if we can cache this form
* - forms with validation shouldn't be cached, because their error messages won't be shown
* - forms with security tokens shouldn't be cached because security tokens expire
*
* @return bool
*/
public function canBeCached()
{
if ($this->getSecurityToken()->isEnabled()) {
return false;
}
if ($this->FormMethod() !== 'GET') {
return false;
}
// Don't cache if there are required fields, or some other complex validator
$validator = $this->getValidator();
if ($validator instanceof RequiredFields) {
if (count($this->validator->getRequired())) {
return false;
}
} else {
return false;
}
return true;
}
}