Projektabgaben Uebersicht: added comments, changed placehoder search text, added phrase

application/controllers/api/frontend/v1/education/PaabgabeUebersicht.php

@@ -46,9 +46,7 @@ class PaabgabeUebersicht extends FHCAPI_Controller
 	}
 
 	/**
-	 *
-	 *
-	 * @return array|stdClass|null
+	 * Get Projektabgaben for search criteria.
 	 */
 	public function getPaAbgaben()
 	{
@@ -71,9 +69,7 @@ class PaabgabeUebersicht extends FHCAPI_Controller
 	}
 
 	/**
-	 *
-	 *
-	 * @return array|stdClass|null
+	 * Get all Studiengänge for which user is entitled for
 	 */
 	public function getStudiengaenge()
 	{
@@ -94,9 +90,7 @@ class PaabgabeUebersicht extends FHCAPI_Controller
 	}
 
 	/**
-	 *
-	 *
-	 * @return array|stdClass|null
+	 * Get projekt work due dates, depending on search criteria.
 	 */
 	public function getTermine()
 	{
@@ -111,9 +105,7 @@ class PaabgabeUebersicht extends FHCAPI_Controller
 	}
 
 	/**
-	 *
-	 *
-	 * @return array|stdClass|null
+	 * Get all submission types.
 	 */
 	public function getPaAbgabetypen()
 	{
@@ -129,9 +121,7 @@ class PaabgabeUebersicht extends FHCAPI_Controller
 	}
 
 	/**
-	 *
-	 * @param
-	 * @return object success or error
+	 * Download zip files with project works matching submission search criteria.
 	 */
 	public function downloadZip()
 	{

application/models/education/Paabgabe_model.php

@@ -61,6 +61,16 @@ class Paabgabe_model extends DB_Model
 		return $this->execReadOnlyQuery($qry, array($person_id));
 	}
 
+	/**
+	 * Gets project submissions for search criteria.
+	 * @param array $projekttyp_kurzbz_arr contains all relevant project types (e.g. Bachelor)
+	 * @param int $studiengang_kz study program
+	 * @param string $abgabetyp_kurzbz project submission type (e.g. end upload, intermediate submission)
+	 * @param string $abgabedatum due date for hand-in
+	 * @param string $personSearchString for searching by person, i.e. name, uid, person/prestudent id
+	 * @param int $limit limiting max number of results if search criteria is not precise enough
+	 * @return object
+	 */
 	public function getPaAbgaben(
 		$projekttyp_kurzbz_arr,
 		$studiengang_kz = null,
@@ -171,6 +181,13 @@ class Paabgabe_model extends DB_Model
 		return $this->execReadOnlyQuery($qry, $params);
 	}
 
+	/**
+	 * Gets due dates for projekt submission search criteria.
+	 * @param array $projekttyp_kurzbz_arr contains all relevant project types (e.g. Bachelor)
+	 * @param int $studiengang_kz study program
+	 * @param string $abgabetyp_kurzbz project submission type (e.g. end upload, intermediate submission)
+	 * @return object
+	 */
 	public function getTermine($projekttyp_kurzbz_arr, $studiengang_kz, $abgabetyp_kurzbz)
 	{
 		$params = [];