From 85d9a11c04418202d731abcbc384e4be7bb7cd25 Mon Sep 17 00:00:00 2001
From: Tim Steiner <tsteiner2@unl.edu>
Date: Wed, 31 Oct 2007 20:33:09 +0000
Subject: [PATCH] Added some docblocks to Requests.php
---
application/models/tables/Requests.php | 27 ++++++++++++++++++++++++++
1 file changed, 27 insertions(+)
diff --git a/application/models/tables/Requests.php b/application/models/tables/Requests.php
index c9340671..630471d0 100644
--- a/application/models/tables/Requests.php
+++ b/application/models/tables/Requests.php
@@ -24,6 +24,11 @@ class Requests extends Nmc_Db_Table
return self::$_instance;
}
+ /**
+ * Fetch a row
+ *
+ * @return Request
+ */
public function fetchNew()
{
$new = parent::fetchNew();
@@ -31,6 +36,14 @@ class Requests extends Nmc_Db_Table
return $new;
}
+ /**
+ * Fetch all requests initiated by the given user.
+ * Option to include or hide completed requests.
+ *
+ * @param Person $user
+ * @param int $completedRequests
+ * @return Nmc_Db_Table_Rowset
+ */
public function getRequestsForUser(Person $user,
$completedRequests = self::COMPLETED_REQUESTS_NO)
{
@@ -41,6 +54,14 @@ class Requests extends Nmc_Db_Table
return $requests;
}
+ /**
+ * Fetches all requests.
+ * Option to include or hide completed requests.
+ *
+ * @param string $where
+ * @param int $completedRequests
+ * @return Nmc_Db_Table_Rowset
+ */
public function fetchAllSorted($where = null,
$completedRequests = self::COMPLETED_REQUESTS_NO)
{
@@ -91,6 +112,12 @@ class Requests extends Nmc_Db_Table
return $requests;
}
+ /**
+ * Fetch all requests currently pending at the given action
+ *
+ * @param ApprovalAction $action
+ * @return Nmc_Db_Table_Rowset
+ */
public function fetchAllWithCurrentAction(ApprovalAction $action) {
$db = $this->getAdapter();
$select = new Zend_Db_Select($db);
--
GitLab