Menu
▾
▴
[Gemstracker-svn] SF.net SVN: gemstracker:[438] branches/1.5.x/library
|
From: <gem...@li...> - 2012-01-31 11:38:32
|
Revision: 438
http://gemstracker.svn.sourceforge.net/gemstracker/?rev=438&view=rev
Author: mennodekker
Date: 2012-01-31 11:38:20 +0000 (Tue, 31 Jan 2012)
Log Message:
-----------
Various doc fixes
Modified Paths:
--------------
branches/1.5.x/library/classes/Gems/Auth/Adapter/Callback.php
branches/1.5.x/library/classes/Gems/Communication/RespondentWriter.php
branches/1.5.x/library/classes/Gems/Form/TableForm.php
branches/1.5.x/library/classes/Gems/Snippets/ModelFormSnippetAbstract.php
branches/1.5.x/library/classes/Gems/TabForm.php
branches/1.5.x/library/snippets/Generic/AutosearchForm.php
branches/1.5.x/library/snippets/Generic/CurrentButtonRow.php
branches/1.5.x/library/snippets/Generic/ModelFormSnippet.php
branches/1.5.x/library/snippets/Generic/ModelItemTableSnippet.php
branches/1.5.x/library/snippets/Generic/ModelItemYesNoDeleteSnippet.php
branches/1.5.x/library/snippets/Generic/ModelTabFormSnippet.php
branches/1.5.x/library/snippets/Generic/ModelTableSnippet.php
Modified: branches/1.5.x/library/classes/Gems/Auth/Adapter/Callback.php
===================================================================
--- branches/1.5.x/library/classes/Gems/Auth/Adapter/Callback.php 2012-01-31 10:53:47 UTC (rev 437)
+++ branches/1.5.x/library/classes/Gems/Auth/Adapter/Callback.php 2012-01-31 11:38:20 UTC (rev 438)
@@ -43,8 +43,25 @@
*/
class Gems_Auth_Adapter_Callback implements Zend_Auth_Adapter_Interface
{
+ /**
+ * The callback to use
+ *
+ * @var callback
+ */
private $_callback;
+
+ /**
+ * The identity to check
+ *
+ * @var string
+ */
private $_identity;
+
+ /**
+ * The optional parameters to pass to the callback
+ *
+ * @var array
+ */
private $_params;
/**
@@ -54,9 +71,9 @@
* return true or false and in that case this adapter will wrap the result
* in a Zend_Auth_Result
*
- * @param type $callback A valid callback
- * @param type $identity The identity to use
- * @param type $params Array of parameters needed for the callback
+ * @param callback $callback A valid callback
+ * @param string $identity The identity to use
+ * @param array $params Array of parameters needed for the callback
*/
public function __construct($callback, $identity, $params)
{
Modified: branches/1.5.x/library/classes/Gems/Communication/RespondentWriter.php
===================================================================
--- branches/1.5.x/library/classes/Gems/Communication/RespondentWriter.php 2012-01-31 10:53:47 UTC (rev 437)
+++ branches/1.5.x/library/classes/Gems/Communication/RespondentWriter.php 2012-01-31 11:38:20 UTC (rev 438)
@@ -41,9 +41,11 @@
interface Gems_Communication_RespondentWriter
{
/**
- * Writes the respondent
+ * Writes the respondent, creating a new one or updating the existing record
+ *
* @param Gems_Communication_RespondentContainer $respondent
- * @return int The internal id of the created/updated respondent
+ * @param int $userId
+ * @return boolean True if a new respondent was added, false if one was updated
* @throws Gems_Communication_Exception
*/
public function writeRespondent(Gems_Communication_RespondentContainer $respondent, &$userId);
Modified: branches/1.5.x/library/classes/Gems/Form/TableForm.php
===================================================================
--- branches/1.5.x/library/classes/Gems/Form/TableForm.php 2012-01-31 10:53:47 UTC (rev 437)
+++ branches/1.5.x/library/classes/Gems/Form/TableForm.php 2012-01-31 11:38:20 UTC (rev 438)
@@ -28,7 +28,7 @@
* Short description of file
*
* @package Gems
- * @subpackage
+ * @subpackage Form
* @copyright Copyright (c) 2011 Erasmus MC
* @license New BSD License
* @version $Id$
Modified: branches/1.5.x/library/classes/Gems/Snippets/ModelFormSnippetAbstract.php
===================================================================
--- branches/1.5.x/library/classes/Gems/Snippets/ModelFormSnippetAbstract.php 2012-01-31 10:53:47 UTC (rev 437)
+++ branches/1.5.x/library/classes/Gems/Snippets/ModelFormSnippetAbstract.php 2012-01-31 11:38:20 UTC (rev 438)
@@ -167,8 +167,9 @@
}
/**
+ * Retrieve the header title to display
*
- * @return string The header title to display
+ * @return string
*/
protected function getTitle()
{
Modified: branches/1.5.x/library/classes/Gems/TabForm.php
===================================================================
--- branches/1.5.x/library/classes/Gems/TabForm.php 2012-01-31 10:53:47 UTC (rev 437)
+++ branches/1.5.x/library/classes/Gems/TabForm.php 2012-01-31 11:38:20 UTC (rev 438)
@@ -33,6 +33,8 @@
*/
/**
+ * Creates a form using tab-layout where each tab is a subform
+ *
* @package Gems
* @subpackage Form
* @copyright Copyright (c) 2011 Erasmus MC
@@ -41,6 +43,8 @@
class Gems_TabForm extends Gems_Form
{
/**
+ * Holds the last tab we added information to
+ *
* @var Gems_Form_TabSubForm
*/
private $currentTab = null;
@@ -168,7 +172,7 @@
/**
* Retrieve a named tab (subform) and set the active tab to this one
*
- * @param type $name
+ * @param string $name
* @return Gems_Form_TabSubForm
*/
public function getTab($name)
@@ -316,6 +320,11 @@
$jquery->addOnLoad($js);
}
+ /**
+ * Load the default decorators
+ *
+ * @return void
+ */
public function loadDefaultDecorators() {
if ($this->loadDefaultDecoratorsIsDisabled()) {
return;
@@ -335,6 +344,8 @@
}
/**
+ * Reset the currentTab to be the main form again
+ *
* As addElement and addDisplayGroup provide a fluent way of working with subforms
* we need to provide a method to skip back to the main form again.
*/
@@ -342,6 +353,11 @@
$this->currentTab = null;
}
+ /**
+ * Select a tab by it's numerical index
+ *
+ * @param int $tabIdx
+ */
public function selectTab($tabIdx) {
$this->getElement('tab')->setValue($tabIdx);
$this->setAttrib('selected', $tabIdx);
Modified: branches/1.5.x/library/snippets/Generic/AutosearchForm.php
===================================================================
--- branches/1.5.x/library/snippets/Generic/AutosearchForm.php 2012-01-31 10:53:47 UTC (rev 437)
+++ branches/1.5.x/library/snippets/Generic/AutosearchForm.php 2012-01-31 11:38:20 UTC (rev 438)
@@ -29,7 +29,7 @@
* Short description of file
*
* @package Gems
- * @subpackage Snippets
+ * @subpackage Snippets\Generic
* @author Matijs de Jong <mj...@ma...>
* @copyright Copyright (c) 2011 Erasmus MC
* @license New BSD License
@@ -42,7 +42,7 @@
* Long description for class (if any)...
*
* @package Gems
- * @subpackage Snippets
+ * @subpackage Snippets\Generic
* @copyright Copyright (c) 2011 Erasmus MC
* @license New BSD License
* @since Class available since version 1.4.2
Modified: branches/1.5.x/library/snippets/Generic/CurrentButtonRow.php
===================================================================
--- branches/1.5.x/library/snippets/Generic/CurrentButtonRow.php 2012-01-31 10:53:47 UTC (rev 437)
+++ branches/1.5.x/library/snippets/Generic/CurrentButtonRow.php 2012-01-31 11:38:20 UTC (rev 438)
@@ -29,7 +29,7 @@
* Short description of file
*
* @package Gems
- * @subpackage Snippets
+ * @subpackage Snippets\Generic
* @author Matijs de Jong <mj...@ma...>
* @copyright Copyright (c) 2011 Erasmus MC
* @license New BSD License
@@ -42,7 +42,7 @@
* Long description for class (if any)...
*
* @package Gems
- * @subpackage Snippets
+ * @subpackage Snippets\Generic
* @copyright Copyright (c) 2011 Erasmus MC
* @license New BSD License
* @since Class available since version 1.4.2
Modified: branches/1.5.x/library/snippets/Generic/ModelFormSnippet.php
===================================================================
--- branches/1.5.x/library/snippets/Generic/ModelFormSnippet.php 2012-01-31 10:53:47 UTC (rev 437)
+++ branches/1.5.x/library/snippets/Generic/ModelFormSnippet.php 2012-01-31 11:38:20 UTC (rev 438)
@@ -28,7 +28,7 @@
*
*
* @package MUtil
- * @subpackage Snippets
+ * @subpackage Snippets\Generic
* @author Matijs de Jong <mj...@ma...>
* @copyright Copyright (c) 2011 Erasmus MC
* @license New BSD License
@@ -41,7 +41,7 @@
* Usage snippet for Gems_Snippets_ModelTableSnippetGeneric
*
* @package MUtil
- * @subpackage Snippets
+ * @subpackage Snippets\Generic
* @copyright Copyright (c) 2011 Erasmus MC
* @license New BSD License
* @since Class available since version 1.4
Modified: branches/1.5.x/library/snippets/Generic/ModelItemTableSnippet.php
===================================================================
--- branches/1.5.x/library/snippets/Generic/ModelItemTableSnippet.php 2012-01-31 10:53:47 UTC (rev 437)
+++ branches/1.5.x/library/snippets/Generic/ModelItemTableSnippet.php 2012-01-31 11:38:20 UTC (rev 438)
@@ -28,7 +28,7 @@
*
*
* @package Gems
- * @subpackage Snippets
+ * @subpackage Snippets\Generic
* @author Matijs de Jong <mj...@ma...>
* @copyright Copyright (c) 2011 Erasmus MC
* @license New BSD License
@@ -40,7 +40,7 @@
* the model set through the $model snippet parameter.
*
* @package Gems
- * @subpackage Snippets
+ * @subpackage Snippets\Generic
* @copyright Copyright (c) 2011 Erasmus MC
* @license New BSD License
* @since Class available since version 1.4.4
Modified: branches/1.5.x/library/snippets/Generic/ModelItemYesNoDeleteSnippet.php
===================================================================
--- branches/1.5.x/library/snippets/Generic/ModelItemYesNoDeleteSnippet.php 2012-01-31 10:53:47 UTC (rev 437)
+++ branches/1.5.x/library/snippets/Generic/ModelItemYesNoDeleteSnippet.php 2012-01-31 11:38:20 UTC (rev 438)
@@ -40,7 +40,7 @@
* the model set through the $model snippet parameter.
*
* @package Gems
- * @subpackage Snippets
+ * @subpackage Snippets\Generic
* @copyright Copyright (c) 2011 Erasmus MC
* @license New BSD License
* @since Class available since version 1.4.4
Modified: branches/1.5.x/library/snippets/Generic/ModelTabFormSnippet.php
===================================================================
--- branches/1.5.x/library/snippets/Generic/ModelTabFormSnippet.php 2012-01-31 10:53:47 UTC (rev 437)
+++ branches/1.5.x/library/snippets/Generic/ModelTabFormSnippet.php 2012-01-31 11:38:20 UTC (rev 438)
@@ -26,7 +26,7 @@
* SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
*
* @package Gems
- * @subpackage Snippets
+ * @subpackage Snippets\Generic
* @author Matijs de Jong <mj...@ma...>
* @copyright Copyright (c) 2011 Erasmus MC
* @license New BSD License
@@ -39,7 +39,7 @@
* Usage snippet for Gems_Snippets_ModelTabFormSnippetGeneric
*
* @package Gems
- * @subpackage Snippets
+ * @subpackage Snippets\Generic
* @copyright Copyright (c) 2011 Erasmus MC
* @license New BSD License
* @since Class available since version 1.5
Modified: branches/1.5.x/library/snippets/Generic/ModelTableSnippet.php
===================================================================
--- branches/1.5.x/library/snippets/Generic/ModelTableSnippet.php 2012-01-31 10:53:47 UTC (rev 437)
+++ branches/1.5.x/library/snippets/Generic/ModelTableSnippet.php 2012-01-31 11:38:20 UTC (rev 438)
@@ -28,7 +28,7 @@
*
*
* @package MUtil
- * @subpackage Snippets
+ * @subpackage Snippets\Generic
* @author Matijs de Jong <mj...@ma...>
* @copyright Copyright (c) 2011 Erasmus MC
* @license New BSD License
@@ -42,7 +42,7 @@
* Usage snippet for Gems_Snippets_ModelTableSnippetGeneric
*
* @package MUtil
- * @subpackage Snippets
+ * @subpackage Snippets\Generic
* @copyright Copyright (c) 2011 Erasmus MC
* @license New BSD License
* @since Class available since version 1.4
This was sent by the SourceForge.net collaborative development platform, the world's largest Open Source development site.
|
