tyler.durden
/
icingaweb2
mirror of https://github.com/Icinga/icingaweb2.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

Introduce Form::setOnSuccess() in favor of overriding the constructor 

Zend_Form uses setters for options if a respective setter method exists.
It is not necessary to override the constructor for introducing new options.
This commit is contained in:
Eric Lippmann 2014-11-04 16:15:06 +01:00 committed by Marius Hein
parent 89b36f79b2
commit 47414f3528
1 changed files with 47 additions and 93 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

140
library/Icinga/Web/Form.php
View File

@ -11,7 +11,6 @@ use Zend_View_Interface;
use Icinga\Application\Icinga; use Icinga\Application\Icinga;
use Icinga\Web\Form\Decorator\NoScriptApply; use Icinga\Web\Form\Decorator\NoScriptApply;
use Icinga\Web\Form\Element\CsrfCounterMeasure; use Icinga\Web\Form\Element\CsrfCounterMeasure;
use Icinga\Web\Form\FormElement;
/** /**
* Base class for forms providing CSRF protection, confirmation logic and auto submission * Base class for forms providing CSRF protection, confirmation logic and auto submission
@ -37,13 +36,6 @@ class Form extends Zend_Form
*/ */
protected $created = false; protected $created = false;
/**
* The request associated with this form
*
* @var Request
*/
protected $request;
/** /**
* The callback to call instead of Form::onSuccess() * The callback to call instead of Form::onSuccess()
* *
@ -108,38 +100,31 @@ class Form extends Zend_Form
* @var array * @var array
*/ */
public static $defaultElementDecorators = array( public static $defaultElementDecorators = array(
array('ViewHelper', array('separator' => '')), 'ViewHelper',
array('Errors', array('separator' => '')), 'Errors',
array('Description', array('tag' => 'span', 'class' => 'description', 'separator' => '')), array('Description', array('tag' => 'span', 'class' => 'description')),
array('Label', array('separator' => '')), 'Label',
array('HtmlTag', array('tag' => 'div', 'class' => 'element')) array('HtmlTag', array('tag' => 'div'))
); );
/** /**
* Create a new form * Set a callback that is called instead of this form's onSuccess method
* *
* Accepts an additional option `onSuccess' which is a callback that is called instead of this * It is called using the following signature: (Request $request, Form $form).
* form's method. It is called using the following signature: (Form $form).
* *
* @see Zend_Form::__construct() * @param callable $onSuccess Callback
* *
* @throws LogicException In case `onSuccess' is not callable * @return $this
*
* @throws LogicException If the callback is not callable
*/ */
public function __construct($options = null) public function setOnSuccess($onSuccess)
{ {
if (is_array($options) && isset($options['onSuccess'])) { if (! is_callable($onSuccess)) {
$this->onSuccess = $options['onSuccess'];
unset($options['onSuccess']);
} elseif (isset($options->onSuccess)) {
$this->onSuccess = $options->onSuccess;
unset($options->onSuccess);
}
if ($this->onSuccess !== null && false === is_callable($this->onSuccess)) {
throw new LogicException('The option `onSuccess\' is not callable'); throw new LogicException('The option `onSuccess\' is not callable');
} }
$this->onSuccess = $onSuccess;
parent::__construct($options); return $this;
} }
/** /**
@ -363,9 +348,11 @@ class Form extends Zend_Form
* *
* Intended to be implemented by concrete form classes. The base implementation returns always FALSE. * Intended to be implemented by concrete form classes. The base implementation returns always FALSE.
* *
* @param Request $request The valid request used to process this form
*
* @return null|bool Return FALSE in case no redirect should take place * @return null|bool Return FALSE in case no redirect should take place
*/ */
public function onSuccess() public function onSuccess(Request $request)
{ {
return false; return false;
} }
@ -374,8 +361,10 @@ class Form extends Zend_Form
* Perform actions when no form dependent data was sent * Perform actions when no form dependent data was sent
* *
* Intended to be implemented by concrete form classes. * Intended to be implemented by concrete form classes.
*
* @param Request $request The current request
*/ */
public function onRequest() public function onRequest(Request $request)
{ {
} }
@ -441,8 +430,8 @@ class Form extends Zend_Form
* `disableLoadDefaultDecorators' option to any other value than `true'. For loading custom element decorators use * `disableLoadDefaultDecorators' option to any other value than `true'. For loading custom element decorators use
* the 'decorators' option. * the 'decorators' option.
* *
* @param string $type The type of the element * @param string $type String element type
* @param string $name The name of the element * @param string $name The name of the element to add
* @param mixed $options The options for the element * @param mixed $options The options for the element
* *
* @return Zend_Form_Element * @return Zend_Form_Element
@ -464,20 +453,10 @@ class Form extends Zend_Form
$options = array('decorators' => static::$defaultElementDecorators); $options = array('decorators' => static::$defaultElementDecorators);
} }
if (($el = $this->createIcingaFormElement($type, $name, $options)) === null) { $el = parent::createElement($type, $name, $options);
$el = parent::createElement($type, $name, $options);
}
if ($el && $el->getAttrib('autosubmit')) { if ($el && $el->getAttrib('autosubmit')) {
$noScript = new NoScriptApply(); // Non-JS environments $el->addDecorator(new NoScriptApply()); // Non-JS environments
$decorators = $el->getDecorators();
$pos = array_search('Zend_Form_Decorator_ViewHelper', array_keys($decorators)) + 1;
$el->setDecorators(
array_slice($decorators, 0, $pos, true)
+ array(get_class($noScript) => $noScript)
+ array_slice($decorators, $pos, count($decorators) - $pos, true)
);
$class = $el->getAttrib('class'); $class = $el->getAttrib('class');
if (is_array($class)) { if (is_array($class)) {
$class[] = 'autosubmit'; $class[] = 'autosubmit';
@ -487,7 +466,6 @@ class Form extends Zend_Form
$class .= ' autosubmit'; $class .= ' autosubmit';
} }
$el->setAttrib('class', $class); // JS environments $el->setAttrib('class', $class); // JS environments
unset($el->autosubmit); unset($el->autosubmit);
} }
@ -555,17 +533,15 @@ class Form extends Zend_Form
{ {
if ($request === null) { if ($request === null) {
$request = $this->getRequest(); $request = $this->getRequest();
} else {
$this->request = $request;
} }
$formData = $this->getRequestData(); $formData = $this->getRequestData($request);
if ($this->getUidDisabled() || $this->wasSent($formData)) { if ($this->getUidDisabled() || $this->wasSent($formData)) {
$this->populate($formData); // Necessary to get isSubmitted() to work $this->populate($formData); // Necessary to get isSubmitted() to work
if (! $this->getSubmitLabel() || $this->isSubmitted()) { if (! $this->getSubmitLabel() || $this->isSubmitted()) {
if ($this->isValid($formData) if ($this->isValid($formData)
&& (($this->onSuccess !== null && false !== call_user_func($this->onSuccess, $this)) && (($this->onSuccess !== null && false !== call_user_func($this->onSuccess, $request, $this))
|| ($this->onSuccess === null && false !== $this->onSuccess()))) { || ($this->onSuccess === null && false !== $this->onSuccess($request)))) {
$this->getResponse()->redirectAndExit($this->getRedirectUrl()); $this->getResponse()->redirectAndExit($this->getRedirectUrl());
} }
} else { } else {
@ -573,7 +549,7 @@ class Form extends Zend_Form
$this->isValidPartial($formData); $this->isValidPartial($formData);
} }
} else { } else {
$this->onRequest(); $this->onRequest($request);
} }
return $request; return $request;
@ -699,19 +675,29 @@ class Form extends Zend_Form
} }
/** /**
* Return the request associated with this form * Return the request data based on this form's request method
* *
* Returns the global request if none has been set for this form yet. * @param Request $request The request to fetch the data from
*
* @return array
*/
public function getRequestData(Request $request)
{
if (strtolower($request->getMethod()) === $this->getMethod()) {
return $request->{'get' . ($request->isPost() ? 'Post' : 'Query')}();
}
return array();
}
/**
* Return the current request
* *
* @return Request * @return Request
*/ */
public function getRequest() public function getRequest()
{ {
if ($this->request === null) { return Icinga::app()->getFrontController()->getRequest();
$this->request = Icinga::app()->getFrontController()->getRequest();
}
return $this->request;
} }
/** /**
@ -724,39 +710,6 @@ class Form extends Zend_Form
return Icinga::app()->getFrontController()->getResponse(); return Icinga::app()->getFrontController()->getResponse();
} }
/**
* Return the request data based on this form's request method
*
* @return array
*/
protected function getRequestData()
{
if (strtolower($this->request->getMethod()) === $this->getMethod()) {
return $this->request->{'get' . ($this->request->isPost() ? 'Post' : 'Query')}();
}
return array();
}
/**
* Create a new element located in the Icinga Web 2 library
*
* @param string $type The type of the element
* @param string $name The name of the element
* @param mixed $options The options for the element
*
* @return NULL|FormElement NULL in case the element is not found in the Icinga Web 2 library
*
* @see Form::$defaultElementDecorators For Icinga Web 2's default element decorators.
*/
protected function createIcingaFormElement($type, $name, $options = null)
{
$className = 'Icinga\\Web\\Form\\Element\\' . ucfirst($type);
if (class_exists($className)) {
return new $className($name, $options);
}
}
/** /**
* Render this form * Render this form
* *
@ -770,3 +723,4 @@ class Form extends Zend_Form
return parent::render($view); return parent::render($view);
} }
} }