Enalean / tuleap

plugins/git/include/Git/Driver/Gerrit/ProjectCreator.class.php

Doc Comments +9 added lines

@@ -84,6 +84,9 @@ 
     /** @var Git_Driver_Gerrit_Template_TemplateFactory */
     private $template_factory;
 
+    /**
+     * @param string $dir
+     */
     public function __construct(
         $dir,
         Git_Driver_Gerrit_GerritDriverFactory $driver_factory,
@@ -204,6 +207,9 @@ 
         $executor->exportBranchesAndTags($gerrit_project_url);
     }
 
+    /**
+     * @param string $replication_group
+     */
     private function pushFullTuleapAccessRightsToGerrit(GitRepository $repository, Git_RemoteServer_GerritServer $gerrit_server, array $ugroups, $replication_group, $template_id) {
         foreach ($ugroups as $ugroup) {
             $this->addGroupToGroupFile($gerrit_server, $repository->getProject()->getUnixName().'/'.$ugroup->getNormalizedName());
@@ -263,6 +269,9 @@ 
         $this->addGroupDefinitionToGroupFile('global:Registered-Users', self::GROUP_REGISTERED_USERS);
     }
 
+    /**
+     * @param string $uuid
+     */
     private function addGroupDefinitionToGroupFile($uuid, $group_name) {
         file_put_contents("$this->dir/groups", "$uuid\t$group_name\n", FILE_APPEND);
     }

plugins/git/include/Git/Driver/Gerrit/RemoteSSHCommandFailure.class.php

Doc Comments +4 added lines

@@ -24,6 +24,10 @@
     private $std_out;
     private $std_err;
 
+    /**
+     * @param string $std_out
+     * @param string $std_err
+     */
     function __construct($exit_code, $std_out, $std_err) {
         parent::__construct(implode(PHP_EOL, array("exit_code: $exit_code", "std_err: $std_err", "std_out: $std_out")));
         $this->exit_code = $exit_code;

plugins/git/include/Git/Driver/Gerrit/Template/Template.class.php

Doc Comments +1 added lines, -1 removed lines

@@ -74,7 +74,7 @@
     /**
      * @param int $group_id
      *
-     * @return True if this template belongs to the given project
+     * @return boolean if this template belongs to the given project
      */
     public function belongsToProject($group_id) {
         return $this->group_id == $group_id;

plugins/git/include/Git/Driver/Gerrit/Template/TemplateDao.class.php

Doc Comments +19 added lines

@@ -27,6 +27,9 @@ 
  */
 class Git_Driver_Gerrit_Template_TemplateDao extends DataAccessObject {
 
+    /**
+     * @param integer $project_id
+     */
     public function getAllTemplatesOfProject($project_id) {
         $project_id = $this->da->escapeInt($project_id);
 
@@ -37,6 +40,9 @@ 
         return $this->retrieve($sql);
     }
 
+    /**
+     * @param integer $template_id
+     */
     public function getTemplate($template_id) {
         $template_id = $this->da->escapeInt($template_id);
 
@@ -47,6 +53,11 @@ 
         return $this->retrieve($sql);
     }
 
+    /**
+     * @param integer $project_id
+     * @param string $name
+     * @param string $content
+     */
     public function addTemplate($project_id, $name, $content) {
         $project_id = $this->da->escapeInt($project_id);
         $name       = $this->da->quoteSmart($name);
@@ -65,6 +76,11 @@ 
         return $this->update($sql);
     }
 
+    /**
+     * @param integer $template_id
+     * @param string $name
+     * @param string $content
+     */
     public function updateTemplate($template_id, $name, $content) {
         $template_id = $this->da->escapeInt($template_id);
         $name        = $this->da->quoteSmart($name);
@@ -77,6 +93,9 @@ 
         return $this->update($sql);
     }
 
+    /**
+     * @param integer $template_id
+     */
     public function deleteTemplate($template_id) {
         $template_id = $this->da->escapeInt($template_id);
 

plugins/git/include/Git/Driver/Gerrit/Template/TemplateFactory.class.php

Doc Comments +1 added lines, -1 removed lines

@@ -128,7 +128,7 @@
      * Instatiate a Template from a SQL row
      *
      * @param array
-     * @return Git_Driver_Gerrit_Template_Template[] | false -where the array is in DAR format
+     * @return Git_Driver_Gerrit_Template_Template | false -where the array is in DAR format
      */
     private function instantiateTemplateFromRow(array $row) {
         return new Git_Driver_Gerrit_Template_Template(

plugins/git/include/Git/Driver/Gerrit/UmbrellaProjectManager.class.php

Doc Comments +6 added lines, -6 removed lines

@@ -73,9 +73,9 @@ 
 
     /**
      * set the inheritance on all Project's servers
-     * @param array $gerrit_servers
-     * @param type $project_name
-     * @param type $parent_project_name
+     * @param Git_RemoteServer_GerritServer[] $gerrit_servers
+     * @param type $project
+     * @param type $parent_project
      */
     private function setProjectInheritanceOnServers(array $gerrit_servers, Project $project, Project $parent_project) {
         foreach ($gerrit_servers as $gerrit_server) {
@@ -90,7 +90,7 @@ 
     }
 
     /**
-     * @param array $gerrit_servers
+     * @param Git_RemoteServer_GerritServer[] $gerrit_servers
      * @param Project $project
      */
     private function resetProjectInheritanceOnServers(array $gerrit_servers, Project $project) {
@@ -105,7 +105,7 @@ 
     }
 
     /**
-     * @param array $gerrit_servers
+     * @param Git_RemoteServer_GerritServer[] $gerrit_servers
      * @param Project $project
      */
     private function createProjectOnServers(array $gerrit_servers, Project $project) {
@@ -127,7 +127,7 @@ 
     /**
      *
      * @param ProjectUGroup[] $ugroups
-     * @return null | ProjectUGroup
+     * @return ProjectUGroup|null | ProjectUGroup
      */
     private function getAdminUGroup(array $ugroups) {
         foreach ($ugroups as $ugroup) {

plugins/git/include/Git/Driver/Gerrit/UserAccountManager.class.php

Doc Comments +1 added lines, -3 removed lines

@@ -71,7 +71,6 @@ 
      *
      * @param array $original_keys
      * @param array $new_keys
-     * @param Git_RemoteServer_GerritServerFactory $remote_gerrit_factory
      * @return void
      * @throws Git_UserSynchronisationException
      */
@@ -118,7 +117,6 @@ 
     /**
      * Makes sure there is one copy of each key on each remote server
      * 
-     * @param Git_RemoteServer_GerritServerFactory $remote_gerrit_factory
      * @return void
      * @throws Git_UserSynchronisationException
      */
@@ -202,7 +200,7 @@ 
      *
      * @param array $keys_to_add
      * @param array $keys_to_remove
-     * @return array
+     * @return boolean
      */
     private function areThereKeysToUpdate(Array $keys_to_add, Array $keys_to_remove) {
         return $keys_to_add || $keys_to_remove;

plugins/git/include/Git/Driver/Gerrit/UserFinder.class.php

Doc Comments +1 added lines, -1 removed lines

@@ -36,7 +36,7 @@
     }
 
 
-    /** @return bool */
+    /** @return boolean|null */
     public function areRegisteredUsersAllowedTo($permission_type, GitRepository $repository) {
         if ($permission_type == Git::SPECIAL_PERM_ADMIN) {
             return false;

plugins/git/include/Git/Driver/GerritLegacy.class.php

Doc Comments +39 added lines, -6 removed lines

@@ -91,7 +91,7 @@ 
      *
      * @param Git_RemoteServer_GerritServer $server
      * @param string $project_name
-     * @return true if the gerrit project exists, else return false
+     * @return boolean if the gerrit project exists, else return false
      */
     public function doesTheParentProjectExist(Git_RemoteServer_GerritServer $server, $project_name) {
         return in_array($project_name, $this->listParentProjects($server));
@@ -100,7 +100,7 @@ 
     /**
      * @param Git_RemoteServer_GerritServer $server
      * @param string $project_name
-     * @return true if the gerrit project exists, else return false
+     * @return boolean if the gerrit project exists, else return false
      *
      * @throws Git_Driver_Gerrit_Exception
      */
@@ -163,6 +163,9 @@ 
         $this->logger->info("Gerrit: Group $group_name successfully created");
     }
 
+    /**
+     * @param string $group_full_name
+     */
     public function getGroupUUID(Git_RemoteServer_GerritServer $server, $group_full_name) {
         $json_result = $this->getAccountGroupsInfo($server, $group_full_name);
         if (isset($json_result->columns->group_uuid)) {
@@ -176,7 +179,7 @@ 
      * Can throw Git_Driver_Gerrit_RemoteSSHCommandFailure exception
      *
      * @param Git_RemoteServer_GerritServer $server
-     * @param type $group_full_name
+     * @param string $group_full_name
      *
      * @return type
      */
@@ -193,6 +196,9 @@ 
         return json_decode(array_shift(explode("\n", $command_result)));
     }
 
+    /**
+     * @param string $group_name
+     */
     public function doesTheGroupExist(Git_RemoteServer_GerritServer $server, $group_name) {
         return in_array($group_name, $this->listGroups($server));
     }
@@ -223,15 +229,24 @@ 
         return $group_info;
     }
 
+    /**
+     * @param string $command
+     */
     private function computeException(Git_Driver_Gerrit_RemoteSSHCommandFailure $e, $command) {
         return $this->isGerritFailure($e) ? $this->gerritDriverException($e, $command) : $e;
 
     }
 
+    /**
+     * @param Git_Driver_Gerrit_RemoteSSHCommandFailure $e
+     */
     private function isGerritFailure($e) {
         return $e->getExitCode() === self::EXIT_CODE;
     }
 
+    /**
+     * @param Git_Driver_Gerrit_RemoteSSHCommandFailure $e
+     */
     private function gerritDriverException($e, $command) {
         return new Git_Driver_Gerrit_Exception("Command: $command".PHP_EOL."Error: ".$e->getStdErr());
     }
@@ -254,7 +269,7 @@ 
      * Can throw Git_Driver_Gerrit_RemoteSSHCommandFailure exception
      *
      * @param Git_RemoteServer_GerritServer $server
-     * @param PFUser $user
+     * @param Git_Driver_Gerrit_User $user
      * @param String $group_name
      */
     public function addUserToGroup(Git_RemoteServer_GerritServer $server, Git_Driver_Gerrit_User $user, $group_name) {
@@ -272,7 +287,7 @@ 
      * Can throw Git_Driver_Gerrit_RemoteSSHCommandFailure exception
      *
      * @param Git_RemoteServer_GerritServer $server
-     * @param PFUser $user
+     * @param Git_Driver_Gerrit_User $user
      * @param String $group_name
      */
     public function removeUserFromGroup(Git_RemoteServer_GerritServer $server, Git_Driver_Gerrit_User $user, $group_name) {
@@ -310,6 +325,10 @@ 
         $this->flushGerritCacheGroupsInclude($server);
     }
 
+    /**
+     * @param string $group_name
+     * @param string $included_group_name
+     */
     private function insertAccountGroupIncludes(Git_RemoteServer_GerritServer $server, $group_name, $included_group_name) {
         $sql_query = "INSERT INTO account_group_includes (group_id, include_id) SELECT G.group_id, I.group_id FROM account_groups G, account_groups I WHERE G.name='".$group_name."' AND I.name='".$included_group_name."'";
         $this->executeQuery($server, $sql_query);
@@ -333,14 +352,23 @@ 
         $this->executeQuery($server, $sql_query);
     }
 
+    /**
+     * @param Git_RemoteServer_GerritServer $server
+     */
     public function flushGerritCacheAccounts($server) {
         $this->flushGerritCaches($server, self::CACHE_ACCOUNTS);
     }
 
+    /**
+     * @param Git_RemoteServer_GerritServer $server
+     */
     private function flushGerritCacheGroupsInclude($server) {
         $this->flushGerritCaches($server, self::CACHE_GROUPS_INCLUDES);
     }
 
+    /**
+     * @param string $cache
+     */
     private function flushGerritCaches($server, $cache=null) {
         $query = self::COMMAND .' flush-caches';
         if ($cache) {
@@ -349,6 +377,9 @@ 
         $this->ssh->execute($server, $query);
     }
 
+    /**
+     * @param string $string
+     */
     private function escapeSQLQuery($string) {
         $escaped_string = str_replace(' ', '\ ', $string);
         $escaped_string = str_replace("'", "\\'", $escaped_string);
@@ -434,6 +465,9 @@ 
         return preg_match("/\s$plugin\s+[^\s]+\s+$is_enabled/", $plugins_list);
     }
 
+    /**
+     * @param string $plugins_list
+     */
     private function isDeletePluginInstalled($plugins_list) {
         return strstr($plugins_list, self::DELETEPROJECT_PLUGIN_NAME);
     }
@@ -476,7 +510,6 @@ 
 
     /**
      * @param Git_RemoteServer_GerritServer $server
-     * @param PFUser $gerrit_users_to_suspend
      *
      * @throws Git_Driver_Gerrit_Exception
      */