Conventions

pkp · Jun 7, 2013 · 4a6b790 · 4a6b790
1 parent c78c9f7
commit 4a6b790
Show file tree

Hide file tree

Showing 14 changed files with 18 additions and 37 deletions.
diff --git a/classes/context/DefaultSettingDAO.inc.php b/classes/context/DefaultSettingDAO.inc.php
@@ -177,7 +177,7 @@ function installDefaultBaseData($locale, $contextId, $skipLoad = true, $localeIn
 	 * @param $contextId int
 	 */
 	function &getDefaultSettingIds($contextId) {
-		$result =& $this->retrieve(
+		$result = $this->retrieve(
 			'SELECT '. $this->getPrimaryKeyColumnName() .', '. $this->getDefaultKey() .' FROM '. $this->getTableName() .'
 			WHERE context_id = ? AND '. $this->getDefaultKey() .' IS NOT NULL', $contextId
 		);
@@ -188,8 +188,6 @@ function &getDefaultSettingIds($contextId) {
 			$result->MoveNext();
 		}
 		$result->Close();
-		unset($result);
-
 		return $returner;
 	}
 
@@ -224,7 +222,7 @@ function restoreByContextId($contextId, $locale = null) {
 			$sqlParams[] = $locale;
 		}
 
-		$result =& $this->retrieve($sql, $sqlParams);
+		$result = $this->retrieve($sql, $sqlParams);
 
 		$returner = null;
 		while (!$result->EOF) {
@@ -236,11 +234,9 @@ function restoreByContextId($contextId, $locale = null) {
 				(?, ?, ?, ?, ?)',
 				array($defaultIds[$row['entry_key']], $row['locale'], $row['setting_name'], $row['setting_value'], $row['setting_type'])
 			);
-			unset($row);
 			$result->MoveNext();
 		}
 		$result->Close();
-		unset($result);
 	}
 
 	/**

diff --git a/classes/context/FooterLinkDAO.inc.php b/classes/context/FooterLinkDAO.inc.php
@@ -47,8 +47,6 @@ function getById($footerLinkId, $contextId = null) {
 		}
 
 		$result->Close();
-		unset($result);
-
 		return $returner;
 	}
 
@@ -243,8 +241,6 @@ function getLargestCategoryTotalByContextId($contextId) {
 		}
 
 		$result->Close();
-		unset($result);
-
 		return $returner;
 
 	}

diff --git a/classes/context/PKPSocialMediaDAO.inc.php b/classes/context/PKPSocialMediaDAO.inc.php
@@ -47,8 +47,6 @@ function getById($socialMediaId, $contextId = null) {
 		}
 
 		$result->Close();
-		unset($result);
-
 		return $returner;
 	}
 

diff --git a/classes/db/DAO.inc.php b/classes/db/DAO.inc.php
@@ -125,7 +125,7 @@ function &retrieveCached($sql, $params = false, $secsToCache = 3600, $callHooks
 
 		$start = Core::microtime();
 		$dataSource = $this->getDataSource();
-		$result =& $dataSource->CacheExecute($secsToCache, $sql, $params !== false && !is_array($params) ? array($params) : $params);
+		$result = $dataSource->CacheExecute($secsToCache, $sql, $params !== false && !is_array($params) ? array($params) : $params);
 		if ($dataSource->errorNo()) {
 			// FIXME Handle errors more elegantly.
 			fatalError('DB Error: ' . $dataSource->errorMsg());

diff --git a/classes/mail/SubmissionMailTemplate.inc.php b/classes/mail/SubmissionMailTemplate.inc.php
@@ -167,7 +167,7 @@ function toAssignedSubEditors($submissionId, $stageId) {
 	 *  CC this email to all assigned sub editors in the given stage
 	 * @param $submissionId int
 	 * @param $stageId int
-	 * @return array of Users (note, this differs from OxS which returns EditAssignment objects)
+	 * @return array of Users
 	 */
 	function ccAssignedSubEditors($submissionId, $stageId) {
 		return $this->_addUsers($submissionId, ROLE_ID_SUB_EDITOR, $stageId, 'addCc');
@@ -188,7 +188,7 @@ function bccAssignedSubEditors($submissionId, $stageId) {
 	 * @param $roleId int
 	 * @param $stageId int
 	 * @param $method string one of addRecipient, addCC, or addBCC
-	 * @return array of Users (note, this differs from OxS which returns EditAssignment objects)
+	 * @return array of Users
 	 */
 	protected function _addUsers($submissionId, $roleId, $stageId, $method) {
 		assert(in_array($method, array('addRecipient', 'addCc', 'addBcc')));

diff --git a/classes/metadata/MetadataDescriptionDAO.inc.php b/classes/metadata/MetadataDescriptionDAO.inc.php
@@ -56,7 +56,7 @@ function insertObject(&$metadataDescription) {
 	 * @return MetadataDescription
 	 */
 	function &getObjectById($metadataDescriptionId) {
-		$result =& $this->retrieve(
+		$result = $this->retrieve(
 			'SELECT * FROM metadata_descriptions WHERE metadata_description_id = ?', $metadataDescriptionId
 		);
 
@@ -77,7 +77,7 @@ function &getObjectById($metadataDescriptionId) {
 	 * @return DAOResultFactory containing matching source descriptions (MetadataDescription objects)
 	 */
 	function &getObjectsByAssocId($assocType, $assocId, $rangeInfo = null) {
-		$result =& $this->retrieveRange(
+		$result = $this->retrieveRange(
 			'SELECT *
 			FROM metadata_descriptions
 			WHERE assoc_type = ? AND assoc_id = ?

diff --git a/classes/stageAssignment/StageAssignmentDAO.inc.php b/classes/stageAssignment/StageAssignmentDAO.inc.php
@@ -122,7 +122,6 @@ function build($submissionId, $userGroupId, $userId) {
 		if (!$stageAssignment->wasEmpty()) return $stageAssignment;
 
 		// Otherwise, build one.
-		unset($stageAssignment);
 		$stageAssignment = $this->newDataObject();
 		$stageAssignment->setSubmissionId($submissionId);
 		$stageAssignment->setUserGroupId($userGroupId);

diff --git a/classes/submission/GenreDAO.inc.php b/classes/submission/GenreDAO.inc.php
@@ -42,7 +42,7 @@ function &getById($genreId, $contextId = null){
 			$sqlParams[] = (int)$contextId;
 		}
 
-		$result =& $this->retrieve('SELECT * FROM genres WHERE genre_id = ?'. ($contextId ? ' AND context_id = ?' : ''), $sqlParams);
+		$result = $this->retrieve('SELECT * FROM genres WHERE genre_id = ?'. ($contextId ? ' AND context_id = ?' : ''), $sqlParams);
 		$returner = null;
 		if ($result->RecordCount() != 0) {
 			$returner = $this->_fromRow($result->GetRowAssoc(false));
@@ -59,7 +59,7 @@ function &getById($genreId, $contextId = null){
 	 * @return DAOResultFactory containing matching genres
 	 */
 	function &getEnabledByContextId($contextId, $rangeInfo = null) {
-		$result =& $this->retrieveRange(
+		$result = $this->retrieveRange(
 			'SELECT * FROM genres WHERE enabled = ? AND context_id = ?', array(1, $contextId), $rangeInfo
 		);
 
@@ -74,7 +74,7 @@ function &getEnabledByContextId($contextId, $rangeInfo = null) {
 	 * @return DAOResultFactory containing matching genres
 	 */
 	function &getByContextId($contextId, $rangeInfo = null) {
-		$result =& $this->retrieveRange(
+		$result = $this->retrieveRange(
 				'SELECT * FROM genres WHERE context_id = ?', array($contextId), $rangeInfo
 		);
 
@@ -184,7 +184,7 @@ function deleteById($entryId) {
 	 */
 	function deleteByContextId($contextId) {
 
-		$result =& $this->getByContextId($contextId);
+		$result = $this->getByContextId($contextId);
 		while ($genre = $result->next()) {
 			$this->update('DELETE FROM genre_settings WHERE genre_id = ?', array((int) $genre->getId()));
 		}

diff --git a/classes/submission/Submission.inc.php b/classes/submission/Submission.inc.php
@@ -22,12 +22,6 @@
 define('STATUS_PUBLISHED', 3);
 define('STATUS_DECLINED', 4);
 
-// getSubmissionStatus will return one of these in place of QUEUED:
-define ('STATUS_QUEUED_UNASSIGNED', 5);
-define ('STATUS_QUEUED_REVIEW', 6);
-define ('STATUS_QUEUED_EDITING', 7);
-define ('STATUS_INCOMPLETE', 8);
-
 class Submission extends DataObject {
 	/**
 	 * Constructor.

diff --git a/classes/submission/action/EditorAction.inc.php b/classes/submission/action/EditorAction.inc.php
@@ -162,7 +162,7 @@ function addReviewer($request, $submission, $reviewerId, &$reviewRound, $reviewD
 		$reviewAssignmentDao = DAORegistry::getDAO('ReviewAssignmentDAO');
 		$userDao = DAORegistry::getDAO('UserDAO');
 
-		$reviewer =& $userDao->getById($reviewerId);
+		$reviewer = $userDao->getById($reviewerId);
 
 		// Check to see if the requested reviewer is not already
 		// assigned to review this submission.

diff --git a/classes/submission/reviewAssignment/PKPReviewAssignmentDAO.inc.php b/classes/submission/reviewAssignment/PKPReviewAssignmentDAO.inc.php
@@ -804,7 +804,6 @@ function getAnonymousReviewerStatistics() {
 		}
 		$reviewerValues['lastMax'] = round($reviewerValues['lastMax'] / 86400); // Round to nearest day
 		$result->Close();
-		unset($result);
 
 		// Get number of currently active reviews
 		$result = $this->retrieve(
@@ -822,8 +821,6 @@ function getAnonymousReviewerStatistics() {
 			$result->MoveNext();
 		}
 		$result->Close();
-		unset($result);
-
 		return $reviewerValues;
 	}
 

diff --git a/classes/submission/reviewRound/ReviewRoundDAO.inc.php b/classes/submission/reviewRound/ReviewRoundDAO.inc.php
@@ -41,8 +41,9 @@ function build($submissionId, $stageId, $round, $status = null) {
 
 		// Otherwise, check the args to build one.
 		if ($stageId == WORKFLOW_STAGE_ID_INTERNAL_REVIEW ||
-		$stageId == WORKFLOW_STAGE_ID_EXTERNAL_REVIEW &&
-		$round > 0) {
+			$stageId == WORKFLOW_STAGE_ID_EXTERNAL_REVIEW &&
+			$round > 0
+		) {
 			unset($reviewRound);
 			$reviewRound = $this->newDataObject();
 			$reviewRound->setSubmissionId($submissionId);

diff --git a/classes/user/PKPUserDAO.inc.php b/classes/user/PKPUserDAO.inc.php
@@ -251,7 +251,6 @@ function getFilteredReviewers($contextId, $doneMin, $doneMax, $avgMin, $avgMax,
 				}
 				if ($key == 0) $allInterestIds = $interestIds; // First interest, nothing to intersect with
 				else $allInterestIds = array_intersect($allInterestIds, $interestIds);
-				unset($interest);
 				$key++;
 			}
 		}

diff --git a/controllers/tab/settings/AdminSettingsTabHandler.inc.php b/controllers/tab/settings/AdminSettingsTabHandler.inc.php
@@ -19,8 +19,9 @@ class AdminSettingsTabHandler extends SettingsTabHandler {
 
 	/**
 	 * Constructor
+	 * @param $additionalTabs array Optional additional ('tabname' => 'class/template name') mappings
 	 */
-	function AdminSettingsTabHandler() {
+	function AdminSettingsTabHandler($additionalTabs = array()) {
 		$role = array(ROLE_ID_SITE_ADMIN);
 
 		$this->addRoleAssignment(ROLE_ID_MANAGER,
@@ -34,7 +35,7 @@ function AdminSettingsTabHandler() {
 		);
 
 		parent::SettingsTabHandler($role);
-		$this->setPageTabs(array(
+		$this->setPageTabs($additionalTabs + array(
 			'siteSetup' => 'controllers.tab.admin.siteSetup.form.AppSiteSetupForm',
 			'languages' => 'controllers/tab/admin/languages/languages.tpl',
 			'plugins' => 'controllers/tab/admin/plugins/sitePlugins.tpl',