From: <gem...@li...> - 2012-03-01 14:06:33
|
Revision: 528 http://gemstracker.svn.sourceforge.net/gemstracker/?rev=528&view=rev Author: mennodekker Date: 2012-03-01 14:06:23 +0000 (Thu, 01 Mar 2012) Log Message: ----------- docblock fixes Modified Paths: -------------- trunk/library/classes/Gems/Controller/Action/Helper/BatchRunner.php trunk/library/classes/Gems/Task/CleanCache.php trunk/library/classes/Gems/Task/Db/CreateNewTable.php trunk/library/classes/Gems/Task/Db/CreateNewTables.php trunk/library/classes/Gems/Task/Db/ExecutePatch.php trunk/library/classes/Gems/Task/Echo.php trunk/library/classes/Gems/Task/TaskAbstract.php trunk/library/classes/Gems/Task/TaskInterface.php trunk/library/classes/Gems/Task/TaskRunnerBatch.php trunk/library/classes/Gems/Task/Tracker/CheckTokenCompletion.php trunk/library/classes/Gems/Task/Tracker/CheckTrackTokens.php trunk/library/classes/Gems/Task/Tracker/ProcessTokenCompletion.php trunk/library/classes/Gems/Task/Tracker/RefreshTokenAttributes.php trunk/library/classes/Gems/Task/Tracker/SourceSyncSurveys.php Property Changed: ---------------- trunk/library/classes/Gems/Task/CleanCache.php trunk/library/classes/Gems/Task/Db/CreateNewTable.php trunk/library/classes/Gems/Task/Db/CreateNewTables.php trunk/library/classes/Gems/Task/Db/ExecutePatch.php trunk/library/classes/Gems/Task/Echo.php trunk/library/classes/Gems/Task/Tracker/CheckTokenCompletion.php trunk/library/classes/Gems/Task/Tracker/CheckTrackTokens.php trunk/library/classes/Gems/Task/Tracker/ProcessTokenCompletion.php trunk/library/classes/Gems/Task/Tracker/RefreshTokenAttributes.php trunk/library/classes/Gems/Task/Tracker/SourceSyncSurveys.php Modified: trunk/library/classes/Gems/Controller/Action/Helper/BatchRunner.php =================================================================== --- trunk/library/classes/Gems/Controller/Action/Helper/BatchRunner.php 2012-03-01 13:46:43 UTC (rev 527) +++ trunk/library/classes/Gems/Controller/Action/Helper/BatchRunner.php 2012-03-01 14:06:23 UTC (rev 528) @@ -25,27 +25,24 @@ * 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. - * - * Short description of file * * @package Gems - * @subpackage + * @subpackage Controller_Action_Helper * @copyright Copyright (c) 2011 Erasmus MC * @license New BSD License * @version $Id$ */ /** - * Short description for BatchRunner + * This helper provides an easy method for running tasks in batch. * - * Long description for class BatchRunner (if any)... + * Just provide the batch and the title to use and you will be fine. * * @package Gems - * @subpackage Sample + * @subpackage Controller_Action_Helper * @copyright Copyright (c) 2011 Erasmus MC * @license New BSD License - * @since Class available since version 1.0 - * @deprecated Class deprecated since version 2.0 + * @since Class available since version 1.5.2 */ class Gems_Controller_Action_Helper_BatchRunner extends Zend_Controller_Action_Helper_Abstract { Modified: trunk/library/classes/Gems/Task/CleanCache.php =================================================================== --- trunk/library/classes/Gems/Task/CleanCache.php 2012-03-01 13:46:43 UTC (rev 527) +++ trunk/library/classes/Gems/Task/CleanCache.php 2012-03-01 14:06:23 UTC (rev 528) @@ -29,7 +29,7 @@ * @subpackage Task * @copyright Copyright (c) 2011 Erasmus MC * @license New BSD License - * @version $Id: CheckTokenCompletion.php 502 2012-02-20 14:13:20Z mennodekker $ + * @version $Id$ */ /** @@ -45,7 +45,7 @@ * @subpackage Task * @copyright Copyright (c) 2011 Erasmus MC * @license New BSD License - * @since Class available since version 1.6 + * @since Class available since version 1.5.2 */ class Gems_Task_CleanCache extends Gems_Task_TaskAbstract { Property changes on: trunk/library/classes/Gems/Task/CleanCache.php ___________________________________________________________________ Added: svn:keywords + Id Rev Revision Date Author Modified: trunk/library/classes/Gems/Task/Db/CreateNewTable.php =================================================================== --- trunk/library/classes/Gems/Task/Db/CreateNewTable.php 2012-03-01 13:46:43 UTC (rev 527) +++ trunk/library/classes/Gems/Task/Db/CreateNewTable.php 2012-03-01 14:06:23 UTC (rev 528) @@ -29,7 +29,7 @@ * @subpackage Task_Db * @copyright Copyright (c) 2011 Erasmus MC * @license New BSD License - * @version $Id: CheckTokenCompletion.php 502 2012-02-20 14:13:20Z mennodekker $ + * @version $Id$ */ /** @@ -41,7 +41,7 @@ * @subpackage Task_Db * @copyright Copyright (c) 2011 Erasmus MC * @license New BSD License - * @since Class available since version 1.6 + * @since Class available since version 1.5.2 */ class Gems_Task_Db_CreateNewTable extends Gems_Task_TaskAbstract { Property changes on: trunk/library/classes/Gems/Task/Db/CreateNewTable.php ___________________________________________________________________ Added: svn:keywords + Id Rev Revision Date Author Modified: trunk/library/classes/Gems/Task/Db/CreateNewTables.php =================================================================== --- trunk/library/classes/Gems/Task/Db/CreateNewTables.php 2012-03-01 13:46:43 UTC (rev 527) +++ trunk/library/classes/Gems/Task/Db/CreateNewTables.php 2012-03-01 14:06:23 UTC (rev 528) @@ -29,7 +29,7 @@ * @subpackage Task_Db * @copyright Copyright (c) 2011 Erasmus MC * @license New BSD License - * @version $Id: CheckTokenCompletion.php 502 2012-02-20 14:13:20Z mennodekker $ + * @version $Id$ */ /** @@ -39,7 +39,7 @@ * @subpackage Task_Db * @copyright Copyright (c) 2011 Erasmus MC * @license New BSD License - * @since Class available since version 1.6 + * @since Class available since version 1.5.2 */ class Gems_Task_Db_CreateNewTables extends Gems_Task_TaskAbstract { Property changes on: trunk/library/classes/Gems/Task/Db/CreateNewTables.php ___________________________________________________________________ Added: svn:keywords + Id Rev Revision Date Author Modified: trunk/library/classes/Gems/Task/Db/ExecutePatch.php =================================================================== --- trunk/library/classes/Gems/Task/Db/ExecutePatch.php 2012-03-01 13:46:43 UTC (rev 527) +++ trunk/library/classes/Gems/Task/Db/ExecutePatch.php 2012-03-01 14:06:23 UTC (rev 528) @@ -29,7 +29,7 @@ * @subpackage Task_Db * @copyright Copyright (c) 2011 Erasmus MC * @license New BSD License - * @version $Id: CheckTokenCompletion.php 502 2012-02-20 14:13:20Z mennodekker $ + * @version $Id$ */ /** @@ -41,7 +41,7 @@ * @subpackage Task_Db * @copyright Copyright (c) 2011 Erasmus MC * @license New BSD License - * @since Class available since version 1.6 + * @since Class available since version 1.5.2 */ class Gems_Task_Db_ExecutePatch extends Gems_Task_TaskAbstract { Property changes on: trunk/library/classes/Gems/Task/Db/ExecutePatch.php ___________________________________________________________________ Added: svn:keywords + Id Rev Revision Date Author Modified: trunk/library/classes/Gems/Task/Echo.php =================================================================== --- trunk/library/classes/Gems/Task/Echo.php 2012-03-01 13:46:43 UTC (rev 527) +++ trunk/library/classes/Gems/Task/Echo.php 2012-03-01 14:06:23 UTC (rev 528) @@ -29,7 +29,7 @@ * @subpackage Task * @copyright Copyright (c) 2011 Erasmus MC * @license New BSD License - * @version $Id: CheckTokenCompletion.php 502 2012-02-20 14:13:20Z mennodekker $ + * @version $Id$ */ /** @@ -39,7 +39,7 @@ * @subpackage Task * @copyright Copyright (c) 2011 Erasmus MC * @license New BSD License - * @since Class available since version 1.6 + * @since Class available since version 1.5.2 */ class Gems_Task_Echo extends Gems_Task_TaskAbstract { Property changes on: trunk/library/classes/Gems/Task/Echo.php ___________________________________________________________________ Added: svn:keywords + Id Rev Revision Date Author Modified: trunk/library/classes/Gems/Task/TaskAbstract.php =================================================================== --- trunk/library/classes/Gems/Task/TaskAbstract.php 2012-03-01 13:46:43 UTC (rev 527) +++ trunk/library/classes/Gems/Task/TaskAbstract.php 2012-03-01 14:06:23 UTC (rev 528) @@ -42,7 +42,7 @@ * @subpackage Task * @copyright Copyright (c) 2011 Erasmus MC * @license New BSD License - * @since Class available since version 1.6 + * @since Class available since version 1.5.2 */ abstract class Gems_Task_TaskAbstract extends MUtil_Registry_TargetAbstract implements Gems_Task_TaskInterface { @@ -61,6 +61,14 @@ */ public $translate; + /** + * Sets the batch this task belongs to + * + * This method will be called from the Gems_Task_TaskRunnerBatch upon execution of the + * task. It allows the task to communicate with the batch queue. + * + * @param Gems_Task_TaskRunnerBatch $batch + */ public function setBatch(Gems_Task_TaskRunnerBatch $batch) { $this->_batch = $batch; Modified: trunk/library/classes/Gems/Task/TaskInterface.php =================================================================== --- trunk/library/classes/Gems/Task/TaskInterface.php 2012-03-01 13:46:43 UTC (rev 527) +++ trunk/library/classes/Gems/Task/TaskInterface.php 2012-03-01 14:06:23 UTC (rev 528) @@ -40,7 +40,7 @@ * @subpackage Task * @copyright Copyright (c) 2011 Erasmus MC * @license New BSD License - * @since Class available since version 1.6 + * @since Class available since version 1.5.2 */ interface Gems_Task_TaskInterface { @@ -57,6 +57,8 @@ * * This method will be called from the Gems_Task_TaskRunnerBatch upon execution of the * task. It allows the task to communicate with the batch queue. + * + * @param Gems_Task_TaskRunnerBatch $batch */ public function setBatch(Gems_Task_TaskRunnerBatch $batch); } \ No newline at end of file Modified: trunk/library/classes/Gems/Task/TaskRunnerBatch.php =================================================================== --- trunk/library/classes/Gems/Task/TaskRunnerBatch.php 2012-03-01 13:46:43 UTC (rev 527) +++ trunk/library/classes/Gems/Task/TaskRunnerBatch.php 2012-03-01 14:06:23 UTC (rev 528) @@ -45,7 +45,7 @@ * @subpackage Task * @copyright Copyright (c) 2011 Erasmus MC * @license New BSD License - * @since Class available since version 1.6 + * @since Class available since version 1.5.2 */ class Gems_Task_TaskRunnerBatch extends MUtil_Batch_BatchAbstract { Modified: trunk/library/classes/Gems/Task/Tracker/CheckTokenCompletion.php =================================================================== --- trunk/library/classes/Gems/Task/Tracker/CheckTokenCompletion.php 2012-03-01 13:46:43 UTC (rev 527) +++ trunk/library/classes/Gems/Task/Tracker/CheckTokenCompletion.php 2012-03-01 14:06:23 UTC (rev 528) @@ -29,7 +29,7 @@ * @subpackage TaskTracker * @copyright Copyright (c) 2011 Erasmus MC * @license New BSD License - * @version $Id: CheckTokenCompletion.php 502 2012-02-20 14:13:20Z mennodekker $ + * @version $Id$ */ /** @@ -42,7 +42,7 @@ * @subpackage Task_Tracker * @copyright Copyright (c) 2011 Erasmus MC * @license New BSD License - * @since Class available since version 1.6 + * @since Class available since version 1.5.2 */ class Gems_Task_Tracker_CheckTokenCompletion extends Gems_Task_TaskAbstract { Property changes on: trunk/library/classes/Gems/Task/Tracker/CheckTokenCompletion.php ___________________________________________________________________ Added: svn:keywords + Id Rev Revision Date Author Modified: trunk/library/classes/Gems/Task/Tracker/CheckTrackTokens.php =================================================================== --- trunk/library/classes/Gems/Task/Tracker/CheckTrackTokens.php 2012-03-01 13:46:43 UTC (rev 527) +++ trunk/library/classes/Gems/Task/Tracker/CheckTrackTokens.php 2012-03-01 14:06:23 UTC (rev 528) @@ -30,7 +30,7 @@ * @subpackage Task_Tracker * @copyright Copyright (c) 2011 Erasmus MC * @license New BSD License - * @version $Id: CheckTrackTokens.php 502 2012-02-20 14:13:20Z mennodekker $ + * @version $Id$ */ /** @@ -40,7 +40,7 @@ * @subpackage Task_Tracker * @copyright Copyright (c) 2011 Erasmus MC * @license New BSD License - * @since Class available since version 1.6 + * @since Class available since version 1.5.2 */ class Gems_Task_Tracker_CheckTrackTokens extends Gems_Task_TaskAbstract { Property changes on: trunk/library/classes/Gems/Task/Tracker/CheckTrackTokens.php ___________________________________________________________________ Added: svn:keywords + Id Rev Revision Date Author Modified: trunk/library/classes/Gems/Task/Tracker/ProcessTokenCompletion.php =================================================================== --- trunk/library/classes/Gems/Task/Tracker/ProcessTokenCompletion.php 2012-03-01 13:46:43 UTC (rev 527) +++ trunk/library/classes/Gems/Task/Tracker/ProcessTokenCompletion.php 2012-03-01 14:06:23 UTC (rev 528) @@ -30,7 +30,7 @@ * @subpackage Task_Tracker * @copyright Copyright (c) 2011 Erasmus MC * @license New BSD License - * @version $Id: ProcessTokenCompletion.php 502 2012-02-20 14:13:20Z mennodekker $ + * @version $Id$ */ /** @@ -40,7 +40,7 @@ * @subpackage Task_Tracker * @copyright Copyright (c) 2011 Erasmus MC * @license New BSD License - * @since Class available since version 1.6 + * @since Class available since version 1.5.2 */ class Gems_Task_Tracker_ProcessTokenCompletion extends Gems_Task_TaskAbstract { Property changes on: trunk/library/classes/Gems/Task/Tracker/ProcessTokenCompletion.php ___________________________________________________________________ Added: svn:keywords + Id Rev Revision Date Author Modified: trunk/library/classes/Gems/Task/Tracker/RefreshTokenAttributes.php =================================================================== --- trunk/library/classes/Gems/Task/Tracker/RefreshTokenAttributes.php 2012-03-01 13:46:43 UTC (rev 527) +++ trunk/library/classes/Gems/Task/Tracker/RefreshTokenAttributes.php 2012-03-01 14:06:23 UTC (rev 528) @@ -30,7 +30,7 @@ * @subpackage Task_Tracker * @copyright Copyright (c) 2011 Erasmus MC * @license New BSD License - * @version $Id: ProcessTokenCompletion.php 502 2012-02-20 14:13:20Z mennodekker $ + * @version $Id$ */ /** @@ -40,7 +40,7 @@ * @subpackage Task_Tracker * @copyright Copyright (c) 2011 Erasmus MC * @license New BSD License - * @since Class available since version 1.6 + * @since Class available since version 1.5.2 */ class Gems_Task_Tracker_RefreshTokenAttributes extends Gems_Task_TaskAbstract { Property changes on: trunk/library/classes/Gems/Task/Tracker/RefreshTokenAttributes.php ___________________________________________________________________ Added: svn:keywords + Id Rev Revision Date Author Modified: trunk/library/classes/Gems/Task/Tracker/SourceSyncSurveys.php =================================================================== --- trunk/library/classes/Gems/Task/Tracker/SourceSyncSurveys.php 2012-03-01 13:46:43 UTC (rev 527) +++ trunk/library/classes/Gems/Task/Tracker/SourceSyncSurveys.php 2012-03-01 14:06:23 UTC (rev 528) @@ -29,7 +29,7 @@ * @subpackage Task_Tracker * @copyright Copyright (c) 2011 Erasmus MC * @license New BSD License - * @version $Id: Sample.php 215 2011-07-12 08:52:54Z michiel $ + * @version $Id$ */ /** @@ -39,7 +39,7 @@ * @subpackage Task_Tracker * @copyright Copyright (c) 2011 Erasmus MC * @license New BSD License - * @since Class available since version 1.6 + * @since Class available since version 1.5.2 */ class Gems_Task_Tracker_SourceSyncSurveys extends Gems_Task_TaskAbstract { Property changes on: trunk/library/classes/Gems/Task/Tracker/SourceSyncSurveys.php ___________________________________________________________________ Added: svn:keywords + Id Rev Revision Date Author This was sent by the SourceForge.net collaborative development platform, the world's largest Open Source development site. |