pkp#229 Typehinting

jonasraoni · Mar 27, 2023 · a588471 · a588471
1 parent 8bdee64
commit a588471
Show file tree

Hide file tree

Showing 5 changed files with 29 additions and 20 deletions.
diff --git a/OrcidProfileHandler.php b/OrcidProfileHandler.php
@@ -23,6 +23,7 @@
 use APP\handler\Handler;
 use APP\template\TemplateManager;
 use Carbon\Carbon;
+use Exception;
 use PKP\core\Core;
 use PKP\plugins\Hook;
 use PKP\plugins\PluginRegistry;
@@ -36,7 +37,7 @@ class OrcidProfileHandler extends Handler
     public const TEMPLATE = 'orcidVerify.tpl';
     const ORCIDPROFILEPLUGIN = 'orcidprofileplugin';
     private bool $isSandBox;
-    private ?\PKP\plugins\Plugin $plugin;
+    private OrcidProfilePlugin $plugin;
 
 
 
@@ -183,7 +184,7 @@ public function orcidAuthorize($args, $request)
 				';
                 break;
             default:
-                assert(false);
+                throw new Exception('Invalid target');
         }
     }
 

diff --git a/OrcidProfilePlugin.php b/OrcidProfilePlugin.php
@@ -33,6 +33,8 @@
 define('ORCID_WORK_URL', 'work');
 define('ORCID_REVIEW_URL', 'peer-review');
 
+use APP\author\Author;
+use APP\controllers\grid\users\author\form\AuthorForm;
 use APP\core\Application;
 use APP\core\Request;
 use APP\core\Services;
@@ -57,15 +59,16 @@
 use PKP\core\JSONMessage;
 use PKP\core\PKPApplication;
 use PKP\db\DAORegistry;
+use PKP\form\Form;
 use PKP\linkAction\LinkAction;
 use PKP\linkAction\request\AjaxModal;
 use PKP\plugins\GenericPlugin;
 use PKP\plugins\Hook;
 use PKP\plugins\PluginRegistry;
 use PKP\services\PKPSchemaService;
 use PKP\submission\PKPSubmission;
+use PKP\submission\reviewAssignment\ReviewAssignment;
 use PKP\submission\reviewAssignment\ReviewAssignmentDAO;
-use ReviewAssignment;
 use Sokil\IsoCodes\IsoCodesFactory;
 
 class OrcidProfilePlugin extends GenericPlugin
@@ -256,8 +259,8 @@ public function getSetting($contextId, $name)
 
     /**
      * adds orcid  form fields.
-     * @param $hookName
-     * @param $form
+     * @param string $hookName
+     * @param Form $form
      * @return bool
      */
     function addOrcidFormFields($hookName, $form): bool
@@ -302,8 +305,8 @@ function addOrcidFormFields($hookName, $form): bool
     }
 
     /**
-     * @param $hookName
-     * @param $args
+     * @param string $hookName
+     * @param array $args
      */
     function handleThankReviewer($hookName, $args)
     {
@@ -339,9 +342,8 @@ public function publishReviewerWorkToOrcid(Submission $submission, Request $requ
     {
         $context = $request->getContext();
         $requestVars = $request->getUserVars();
-
+        /** @var ReviewAssignmentDAO */
         $reviewAssignmentDao = DAORegistry::getDAO('ReviewAssignmentDAO');
-        /* @var $reviewAssignmentDao ReviewAssignmentDAO */
         $reviewAssignmentId = $requestVars['reviewAssignmentId'];
         if (isset($reviewAssignmentId)) {
             $review = $reviewAssignmentDao->getById($reviewAssignmentId);
@@ -587,6 +589,7 @@ public function handleFormDisplay($hookName, $args)
         $templateMgr = TemplateManager::getManager($request);
         switch ($hookName) {
             case 'authorform::display':
+                /** @var AuthorForm */
                 $authorForm = &$args[0];
                 $author = $authorForm->getAuthor();
                 if ($author) {
@@ -819,6 +822,7 @@ public function handleUserPublicProfileDisplay($hookName, $params)
     public function handleAuthorFormExecute($hookname, $args)
     {
         if (count($args) == 3) {
+            /** @var Author */
             $author = &$args[0];
             $values = $args[2];
 

diff --git a/classes/OrcidValidator.php b/classes/OrcidValidator.php
@@ -2,18 +2,20 @@
 
 namespace APP\plugins\generic\orcidProfile\classes;
 
-class OrcidValidator {
+use APP\plugins\generic\orcidProfile\OrcidProfilePlugin;
 
+class OrcidValidator {
+    public $plugin;
 	/**
 	 * OrcidValidator constructor.
-	 * @param $plugin
+	 * @param OrcidProfilePlugin $plugin
 	 */
 	function __construct(&$plugin) {
 		$this->plugin =& $plugin;
 	}
 
 	/**
-	 * @param $str
+	 * @param string $str
 	 * @return bool
 	 */
 	public function validateClientId($str) {
@@ -25,7 +27,7 @@ public function validateClientId($str) {
 	}
 
 	/**
-	 * @param $str
+	 * @param string $str
 	 * @return bool
 	 */
 	public function validateClientSecret($str) {

diff --git a/classes/form/OrcidProfileSettingsForm.php b/classes/form/OrcidProfileSettingsForm.php
@@ -19,8 +19,9 @@
 use APP\core\Application;
 use PKP\form\Form;
 use APP\plugins\generic\orcidProfile\classes\OrcidValidator;
+use APP\plugins\generic\orcidProfile\OrcidProfilePlugin;
 use APP\template\TemplateManager;
-
+use PKP\plugins\Plugin;
 
 class OrcidProfileSettingsForm extends Form {
 
@@ -45,8 +46,8 @@ class OrcidProfileSettingsForm extends Form {
 
 	/**
 	 * Constructor
-	 * @param $plugin object
-	 * @param $contextId int
+	 * @param OrcidProfilePlugin $plugin
+	 * @param int $contextId
 	 */
 	function __construct($plugin, $contextId) {
 		$this->contextId = $contextId;

diff --git a/classes/form/OrcidProfileStatusForm.php b/classes/form/OrcidProfileStatusForm.php
@@ -16,9 +16,10 @@
 
 namespace APP\plugins\generic\orcidProfile\classes\form;
 
-
+use APP\core\Application;
 use PKP\form\Form;
 use APP\plugins\generic\orcidProfile\classes\OrcidValidator;
+use APP\plugins\generic\orcidProfile\OrcidProfilePlugin;
 use APP\template\TemplateManager;
 
 
@@ -44,8 +45,8 @@ class OrcidProfileStatusForm extends Form {
 
 	/**
 	 * Constructor
-	 * @param $plugin object
-	 * @param $contextId int
+	 * @param OrcidProfilePlugin $plugin
+	 * @param int $contextId
 	 */
 	function __construct($plugin, $contextId) {
 		$this->contextId = $contextId;
@@ -83,7 +84,7 @@ function fetch($request, $template = null, $display = false) {
 		$clientSecret = $this->plugin->getSetting($contextId, 'orcidClientSecret');
 
 		$templateMgr = TemplateManager::getManager($request);
-		$aboutUrl = $request->getDispatcher()->url($request, ROUTE_PAGE, null, 'orcidapi', 'about', null);
+		$aboutUrl = $request->getDispatcher()->url($request, Application::ROUTE_PAGE, null, 'orcidapi', 'about', null);
 		$templateMgr->assign(array(
 			'globallyConfigured' => $this->plugin->isGloballyConfigured(),
 			'orcidAboutUrl' => $aboutUrl,