Menu
▾
▴
[Gemstracker-svn] SF.net SVN: gemstracker:[959] trunk/library
|
From: <gem...@li...> - 2012-09-26 12:49:08
|
Revision: 959
http://gemstracker.svn.sourceforge.net/gemstracker/?rev=959&view=rev
Author: matijsdejong
Date: 2012-09-26 12:48:58 +0000 (Wed, 26 Sep 2012)
Log Message:
-----------
Bug where ModelTableSnippetAbstract.php would result in a different query from the request cache than from the request.
Made generic version of AutosearchFormSnippet.php for ease of inheritance
Modified Paths:
--------------
trunk/library/classes/Gems/Controller/ModelSnippetActionAbstract.php
trunk/library/classes/Gems/Snippets/ModelTableSnippetAbstract.php
trunk/library/classes/Gems/Util/DbLookup.php
trunk/library/snippets/Generic/AutosearchFormSnippet.php
Added Paths:
-----------
trunk/library/classes/Gems/Snippets/AutosearchFormSnippet.php
Modified: trunk/library/classes/Gems/Controller/ModelSnippetActionAbstract.php
===================================================================
--- trunk/library/classes/Gems/Controller/ModelSnippetActionAbstract.php 2012-09-26 10:50:29 UTC (rev 958)
+++ trunk/library/classes/Gems/Controller/ModelSnippetActionAbstract.php 2012-09-26 12:48:58 UTC (rev 959)
@@ -104,7 +104,7 @@
*
* @var mixed String or array of snippets name
*/
- protected $indexStartSnippets = array('Generic_ContentTitleSnippet', 'Generic_AutosearchFormSnippet');
+ protected $indexStartSnippets = array('Generic_ContentTitleSnippet', 'AutosearchFormSnippet');
/**
* The snippets used for the index action, after those in autofilter
Added: trunk/library/classes/Gems/Snippets/AutosearchFormSnippet.php
===================================================================
--- trunk/library/classes/Gems/Snippets/AutosearchFormSnippet.php (rev 0)
+++ trunk/library/classes/Gems/Snippets/AutosearchFormSnippet.php 2012-09-26 12:48:58 UTC (rev 959)
@@ -0,0 +1,269 @@
+<?php
+
+/**
+ * Copyright (c) 2011, Erasmus MC
+ * All rights reserved.
+ *
+ * Redistribution and use in source and binary forms, with or without
+ * modification, are permitted provided that the following conditions are met:
+ * * Redistributions of source code must retain the above copyright
+ * notice, this list of conditions and the following disclaimer.
+ * * Redistributions in binary form must reproduce the above copyright
+ * notice, this list of conditions and the following disclaimer in the
+ * documentation and/or other materials provided with the distribution.
+ * * Neither the name of Erasmus MC nor the
+ * names of its contributors may be used to endorse or promote products
+ * derived from this software without specific prior written permission.
+ *
+ * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND
+ * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
+ * WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
+ * DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR ANY
+ * DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
+ * (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
+ * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
+ * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
+ * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
+ * SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
+ *
+ *
+ * @package Gems
+ * @subpackage Snippets\Generic
+ * @author Matijs de Jong <mj...@ma...>
+ * @copyright Copyright (c) 2011 Erasmus MC
+ * @license New BSD License
+ * @version $Id: Sample.php 203 2011-07-07 12:51:32Z matijs $
+ */
+
+/**
+ * Display a search form that selects on typed text only
+ *
+ * @package Gems
+ * @subpackage Snippets\Generic
+ * @copyright Copyright (c) 2011 Erasmus MC
+ * @license New BSD License
+ * @since Class available since version 1.5.6
+ */
+class Gems_Snippets_AutosearchFormSnippet extends MUtil_Snippets_SnippetAbstract
+{
+ /**
+ *
+ * @var Zend_Db_Adapter_Abstract
+ */
+ protected $db;
+
+ /**
+ *
+ * @var string The id of a div that contains target that should be replaced.
+ */
+ protected $containingId;
+
+ /**
+ *
+ * @var MUtil_Model_ModelAbstract
+ */
+ protected $model;
+
+ /**
+ *
+ * @var Zend_Controller_Request_Abstract
+ */
+ protected $request;
+
+ /**
+ * Optional, otherwise created from $util
+ *
+ * @var Gems_Util_RequestCache
+ */
+ public $requestCache;
+
+ /**
+ *
+ * @var Gems_Util
+ */
+ protected $util;
+
+ /**
+ *
+ * @var string Id for auto search button
+ */
+ protected $searchButtonId = 'AUTO_SEARCH_TEXT_BUTTON';
+
+
+ /**
+ * Creates a Zend_Form_Element_Select
+ *
+ * If $options is a string it is assumed to contain an SQL statement.
+ *
+ * @param string $name Name of the select element
+ * @param string|array $options Can be a SQL select string or key/value array of options
+ * @param string $empty Text to display for the empty selector
+ * @return Zend_Form_Element_Select
+ */
+ protected function _createSelectElement($name, $options, $empty = null)
+ {
+ if ($options instanceof MUtil_Model_ModelAbstract) {
+ $options = $options->get($name, 'multiOptions');
+ } elseif (is_string($options)) {
+ $options = $this->db->fetchPairs($options);
+ natsort($options);
+ }
+ if ($options || null !== $empty)
+ {
+ if (null !== $empty) {
+ $options = array('' => $empty) + $options;
+ }
+ $element = new Zend_Form_Element_Select($name, array('multiOptions' => $options));
+
+ return $element;
+ }
+ }
+
+ /**
+ * Should be called after answering the request to allow the Target
+ * to check if all required registry values have been set correctly.
+ *
+ * @return boolean False if required are missing.
+ */
+ public function checkRegistryRequestsAnswers()
+ {
+ if ($this->util && (! $this->requestCache)) {
+ $this->requestCache = $this->util->getRequestCache();
+ }
+ if ($this->requestCache) {
+ // Do not store searchButtonId
+ $this->requestCache->removeParams($this->searchButtonId);
+ }
+
+ return parent::checkRegistryRequestsAnswers();
+ }
+
+ /**
+ * Creates the form itself
+ *
+ * @param array $options
+ * @return Gems_Form
+ */
+ protected function createForm($options = null)
+ {
+ $form = new Gems_Form($options);
+
+ return $form;
+ }
+
+ /**
+ * Returns a text element for autosearch. Can be overruled.
+ *
+ * The form / html elements to search on. Elements can be grouped by inserting null's between them.
+ * That creates a distinct group of elements
+ *
+ * @param array $data The $form field values (can be usefull, but no need to set them)
+ * @return array Of Zend_Form_Element's or static tekst to add to the html or null for group breaks.
+ */
+ protected function getAutoSearchElements(array $data)
+ {
+ // Search text
+ $element = new Zend_Form_Element_Text($this->model->getTextFilter(), array('label' => $this->_('Free search text'), 'size' => 20, 'maxlength' => 30));
+
+ return array($element);
+ }
+
+ /**
+ * Creates an autosearch form for indexAction.
+ *
+ * @return Gems_Form|null
+ */
+ protected function getAutoSearchForm()
+ {
+ $data = $this->getSearchData();
+
+ $elements = $this->getAutoSearchElements($data);
+
+ if ($elements) {
+ $form = $this->createForm(array('name' => 'autosubmit')); // Assign a name so autosubmit will only work on this form (when there are others)
+ $form->setHtml('div');
+
+ $div = $form->getHtml();
+ $div->class = 'search';
+
+ $span = $div->div(array('class' => 'inputgroup'));
+
+ $elements[] = $this->getAutoSearchSubmit();
+
+ foreach ($elements as $element) {
+ if ($element instanceof Zend_Form_Element) {
+ if ($element->getLabel()) {
+ $span->label($element);
+ }
+ $span->input($element);
+ // TODO: Elementen automatisch toevoegen in MUtil_Form
+ $form->addElement($element);
+ } elseif (null === $element) {
+ $span = $div->div(array('class' => 'inputgroup'));
+ } else {
+ $span[] = $element;
+ }
+ }
+
+ if ($this->request->isPost()) {
+ if (! $form->isValid($data)) {
+ $this->addMessage($form->getErrorMessages());
+ $this->addMessage($form->getMessages());
+ }
+ } else {
+ $form->populate($data);
+ }
+
+ $href = $this->getAutoSearchHref();
+ $form->setAutoSubmit($href, $this->containingId);
+
+ return $form;
+ }
+ }
+
+ /**
+ *
+ * @return string Href attribute for type as you go autofilter
+ */
+ protected function getAutoSearchHref()
+ {
+ return MUtil_Html::attrib('href', array('action' => 'autofilter', $this->model->getTextFilter() => null, 'RouteReset' => true));
+ }
+
+ /**
+ * Creates a submit button
+ *
+ * @param MUtil_Form $form
+ * @return Zend_Form_Element_Submit
+ */
+ protected function getAutoSearchSubmit()
+ {
+ return new Zend_Form_Element_Submit($this->searchButtonId, array('label' => $this->_('Search'), 'class' => 'button small'));
+ }
+
+ /**
+ * Create the snippets content
+ *
+ * This is a stub function either override getHtmlOutput() or override render()
+ *
+ * @param Zend_View_Abstract $view Just in case it is needed here
+ * @return MUtil_Html_HtmlInterface Something that can be rendered
+ */
+ public function getHtmlOutput(Zend_View_Abstract $view)
+ {
+ return $this->getAutoSearchForm();
+ }
+
+ /**
+ *
+ * @return array The data to fill the form with
+ */
+ protected function getSearchData()
+ {
+ if ($this->requestCache) {
+ return $this->requestCache->getProgramParams();
+ } else {
+ return $this->request->getParams();
+ }
+ }
+}
Modified: trunk/library/classes/Gems/Snippets/ModelTableSnippetAbstract.php
===================================================================
--- trunk/library/classes/Gems/Snippets/ModelTableSnippetAbstract.php 2012-09-26 10:50:29 UTC (rev 958)
+++ trunk/library/classes/Gems/Snippets/ModelTableSnippetAbstract.php 2012-09-26 12:48:58 UTC (rev 959)
@@ -275,6 +275,9 @@
if ($this->requestCache) {
$data = $this->requestCache->getProgramParams();
+ // Remove all empty values (but not arrays) from the filter
+ $data = array_filter($data, function($i) { return is_array($i) || strlen($i); });
+
$model->applyParameters($data);
} else {
Modified: trunk/library/classes/Gems/Util/DbLookup.php
===================================================================
--- trunk/library/classes/Gems/Util/DbLookup.php 2012-09-26 10:50:29 UTC (rev 958)
+++ trunk/library/classes/Gems/Util/DbLookup.php 2012-09-26 12:48:58 UTC (rev 959)
@@ -92,6 +92,7 @@
return $organizations;
}
+
/**
* Return key/value pairs of all active staff members
*
Modified: trunk/library/snippets/Generic/AutosearchFormSnippet.php
===================================================================
--- trunk/library/snippets/Generic/AutosearchFormSnippet.php 2012-09-26 10:50:29 UTC (rev 958)
+++ trunk/library/snippets/Generic/AutosearchFormSnippet.php 2012-09-26 12:48:58 UTC (rev 959)
@@ -41,197 +41,12 @@
*
* Long description for class (if any)...
*
+ * @deprecated No longer needed with new snippet loader
* @package Gems
* @subpackage Snippets\Generic
* @copyright Copyright (c) 2011 Erasmus MC
* @license New BSD License
* @since Class available since version 1.4.2
*/
-class Generic_AutosearchFormSnippet extends MUtil_Snippets_SnippetAbstract
-{
- /**
- *
- * @var string The id of a div that contains target that should be replaced.
- */
- protected $containingId;
-
- /**
- *
- * @var MUtil_Model_ModelAbstract
- */
- protected $model;
-
- /**
- *
- * @var Zend_Controller_Request_Abstract
- */
- protected $request;
-
- /**
- * Optional, otherwise created from $util
- *
- * @var Gems_Util_RequestCache
- */
- public $requestCache;
-
- /**
- *
- * @var Gems_Util
- */
- protected $util;
-
- /**
- *
- * @var string Id for auto search button
- */
- protected $searchButtonId = 'AUTO_SEARCH_TEXT_BUTTON';
-
-
- /**
- * Should be called after answering the request to allow the Target
- * to check if all required registry values have been set correctly.
- *
- * @return boolean False if required are missing.
- */
- public function checkRegistryRequestsAnswers()
- {
- if ($this->util && (! $this->requestCache)) {
- $this->requestCache = $this->util->getRequestCache();
- }
- if ($this->requestCache) {
- // Do not store searchButtonId
- $this->requestCache->removeParams($this->searchButtonId);
- }
-
- return parent::checkRegistryRequestsAnswers();
- }
-
- /**
- * Creates the form itself
- *
- * @param array $options
- * @return Gems_Form
- */
- protected function createForm($options = null)
- {
- $form = new Gems_Form($options);
-
- return $form;
- }
-
- /**
- * Returns a text element for autosearch. Can be overruled.
- *
- * The form / html elements to search on. Elements can be grouped by inserting null's between them.
- * That creates a distinct group of elements
- *
- * @param array $data The $form field values (can be usefull, but no need to set them)
- * @return array Of Zend_Form_Element's or static tekst to add to the html or null for group breaks.
- */
- protected function getAutoSearchElements(array $data)
- {
- // Search text
- $element = new Zend_Form_Element_Text($this->model->getTextFilter(), array('label' => $this->_('Free search text'), 'size' => 20, 'maxlength' => 30));
-
- return array($element);
- }
-
- /**
- * Creates an autosearch form for indexAction.
- *
- * @return Gems_Form|null
- */
- protected function getAutoSearchForm()
- {
- $data = $this->getSearchData();
-
- $elements = $this->getAutoSearchElements($data);
-
- if ($elements) {
- $form = $this->createForm(array('name' => 'autosubmit')); // Assign a name so autosubmit will only work on this form (when there are others)
- $form->setHtml('div');
-
- $div = $form->getHtml();
- $div->class = 'search';
-
- $span = $div->div(array('class' => 'inputgroup'));
-
- $elements[] = $this->getAutoSearchSubmit();
-
- foreach ($elements as $element) {
- if ($element instanceof Zend_Form_Element) {
- if ($element->getLabel()) {
- $span->label($element);
- }
- $span->input($element);
- // TODO: Elementen automatisch toevoegen in MUtil_Form
- $form->addElement($element);
- } elseif (null === $element) {
- $span = $div->div(array('class' => 'inputgroup'));
- } else {
- $span[] = $element;
- }
- }
-
- if ($this->request->isPost()) {
- if (! $form->isValid($data)) {
- $this->addMessage($form->getErrorMessages());
- $this->addMessage($form->getMessages());
- }
- } else {
- $form->populate($data);
- }
-
- $href = $this->getAutoSearchHref();
- $form->setAutoSubmit($href, $this->containingId);
-
- return $form;
- }
- }
-
- /**
- *
- * @return string Href attribute for type as you go autofilter
- */
- protected function getAutoSearchHref()
- {
- return MUtil_Html::attrib('href', array('action' => 'autofilter', $this->model->getTextFilter() => null, 'RouteReset' => true));
- }
-
- /**
- * Creates a submit button
- *
- * @param MUtil_Form $form
- * @return Zend_Form_Element_Submit
- */
- protected function getAutoSearchSubmit()
- {
- return new Zend_Form_Element_Submit($this->searchButtonId, array('label' => $this->_('Search'), 'class' => 'button small'));
- }
-
- /**
- * Create the snippets content
- *
- * This is a stub function either override getHtmlOutput() or override render()
- *
- * @param Zend_View_Abstract $view Just in case it is needed here
- * @return MUtil_Html_HtmlInterface Something that can be rendered
- */
- public function getHtmlOutput(Zend_View_Abstract $view)
- {
- return $this->getAutoSearchForm();
- }
-
- /**
- *
- * @return array The data to fill the form with
- */
- protected function getSearchData()
- {
- if ($this->requestCache) {
- return $this->requestCache->getProgramParams();
- } else {
- return $this->request->getParams();
- }
- }
-}
+class Generic_AutosearchFormSnippet extends Gems_Snippets_AutosearchFormSnippet
+{ }
This was sent by the SourceForge.net collaborative development platform, the world's largest Open Source development site.
|
