Enalean / tuleap

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
      */

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

Doc Comments +25 added lines, -1 removed lines

@@ -191,6 +191,9 @@ 
         }
     }
 
+    /**
+     * @param string $group_full_name
+     */
     public function getGroupUUID(Git_RemoteServer_GerritServer $server, $group_full_name) {
         $group_info = $this->getGroupInfoFromGerrit($server, $group_full_name);
         if (! $group_info) {
@@ -360,6 +363,9 @@ 
         }
     }
 
+    /**
+     * @param Git_RemoteServer_GerritServer $server
+     */
     public function flushGerritCacheAccounts($server) {
         return;
     }
@@ -534,6 +540,9 @@ 
         }
     }
 
+    /**
+     * @param string $group_name
+     */
     private function getAllMembers(
         Git_RemoteServer_GerritServer $server,
         $group_name
@@ -554,6 +563,9 @@ 
         }
     }
 
+    /**
+     * @param string $group_name
+     */
     private function getAllIncludedGroups(
         Git_RemoteServer_GerritServer $server,
         $group_name
@@ -590,6 +602,9 @@ 
         }
     }
 
+    /**
+     * @param string $expected_ssh_key
+     */
     private function getUserSSHKeyId(array $ssh_keys, $expected_ssh_key) {
         $matching_keys = array();
 
@@ -625,6 +640,9 @@ 
         }
     }
 
+    /**
+     * @param string $ssh_key
+     */
     private function escapeSSHKey($ssh_key) {
         return str_replace('=', '\u003d', $ssh_key);
     }
@@ -635,6 +653,9 @@ 
         return $key_parts[1];
     }
 
+    /**
+     * @param string $message
+     */
     private function throwGerritException($message) {
         $this->logger->error($message);
         throw new Git_Driver_Gerrit_Exception($message);
@@ -661,6 +682,9 @@ 
         return json_decode(substr($gerrit_response, 5), true);
     }
 
+    /**
+     * @param string $url
+     */
     private function getGerritURL(Git_RemoteServer_GerritServer $server, $url) {
         $full_url = $server->getBaseUrl().'/a'. $url;
 
@@ -688,7 +712,7 @@ 
      * @param Git_RemoteServer_GerritServer $server
      * @param PFUser $user
      *
-     * @return Guzzle\Http\Message\Response
+     * @return boolean|null
      */
     public function setUserAccountInactive(
             Git_RemoteServer_GerritServer $server,

plugins/git/include/Git/Gitolite/ConfigPermissionsSerializer.class.php

Doc Comments +3 added lines

@@ -38,6 +38,9 @@
         Git::PERM_WPLUS => ' RW+'
     );
 
+    /**
+     * @param string $etc_templates_path
+     */
     public function __construct(Git_Mirror_MirrorDataMapper $data_mapper, $etc_templates_path) {
         $this->data_mapper       = $data_mapper;
         $template_dirs = array();

plugins/git/include/Git/Gitolite/GitoliteConfWriter.php

Doc Comments +33 added lines

@@ -43,6 +43,9 @@ 
     /** @var ProjectManager */
     private $project_manager;
 
+    /**
+     * @param string $gitolite_administration_path
+     */
     public function __construct(
         Git_Gitolite_ConfigPermissionsSerializer $permissions_serializer,
         Git_Gitolite_ProjectSerializer $project_serializer,
@@ -78,6 +81,10 @@ 
         return $git_modifications;
     }
 
+    /**
+     * @param string $old_name
+     * @param string $new_name
+     */
     public function renameProject($old_name, $new_name) {
         $git_modifications = new Git_Gitolite_GitModifications();
         $project           = $this->project_manager->getProjectByUnixName($new_name);
@@ -210,11 +217,18 @@ 
         return 'conf/'.$hostname;
     }
 
+    /**
+     * @param string $config_file
+     * @param string $config_datas
+     */
     private function writeGitConfig($config_file, $config_datas, Git_Gitolite_GitModifications $git_modifications) {
         file_put_contents($config_file, $config_datas);
         $git_modifications->add($config_file);
     }
 
+    /**
+     * @param string $content
+     */
     private function writeGitoliteConfigurationOnDisk($content, Git_Gitolite_GitModifications $git_modifications) {
         file_put_contents($this->getGitoliteConfFilePath(), $content);
         $git_modifications->add(self::GITOLITE_CONF_FILE);
@@ -250,12 +264,18 @@ 
         $git_modifications->add($file_path);
     }
 
+    /**
+     * @param string $file_path
+     */
     private function proceedRenameInMirrorIncluderConf($hostname, $file_path, $old_name, $new_name) {
         $orig = file_get_contents($file_path);
         $dest = str_replace('include "' . $hostname . '/'. $old_name .'.conf"', 'include "'. $hostname .'/'. $new_name .'.conf"', $orig);
         file_put_contents($file_path, $dest);
     }
 
+    /**
+     * @param string $file_path
+     */
     private function proceedRenameInIncluderConf($file_path, $old_name, $new_name) {
         $orig = file_get_contents($file_path);
         $dest = str_replace('include "projects/'. $old_name .'.conf"', 'include "projects/'. $new_name .'.conf"', $orig);
@@ -289,6 +309,9 @@ 
         $git_modifications->add($original_file);
     }
 
+    /**
+     * @param string $project_file_path
+     */
     private function proceedToRenameInSpecifiedProjectFile($project_file_path, $old_name, $new_name) {
         $orig = file_get_contents($project_file_path);
 
@@ -317,6 +340,10 @@ 
 
     }
 
+    /**
+     * @param string $old_file
+     * @param string $new_file
+     */
     private function proceedToFileMove($old_file, $new_file, Git_Gitolite_GitModifications $git_modifications) {
         if (is_file($old_file)) {
             $git_modifications->move($old_file, $new_file);
@@ -334,6 +361,9 @@ 
         $this->proceedToFileMove($old_file, $new_file, $git_modifications);
     }
 
+    /**
+     * @param string $hostname
+     */
     private function writeGitoliteIncludesInHostnameFile($hostname, Git_Gitolite_GitModifications $git_modifications, array $project_list) {
         $hostname_config_file = $this->getFullConfigFilePathFromHostname($hostname);
 
@@ -370,6 +400,9 @@ 
         return $this->readProjectListFromPath($dir_path);
     }
 
+    /**
+     * @param string $dir_path
+     */
     private function readProjectListFromPath($dir_path) {
         $project_names = array();
 

plugins/git/include/Git/GitoliteHousekeeping/GitoliteHousekeepingRunner.class.php

Doc Comments +4 added lines

@@ -37,6 +37,10 @@
     /** @var BackendService */
     private $backend_service;
 
+    /**
+     * @param string $gitolite_var_path
+     * @param string $remote_admin_repository
+     */
     public function __construct(
         SystemEventProcessManager $process_manager,
         SystemEventProcess $process,

plugins/git/include/Git/Hook/ExtractCrossReferences.class.php

Doc Comments +3 added lines

@@ -42,6 +42,9 @@
         $this->reference_manager = $reference_manager;
     }
 
+    /**
+     * @param string $commit_sha1
+     */
     public function execute(Git_Hook_PushDetails $push_details, $commit_sha1) {
         $rev_id = $push_details->getRepository()->getFullName().'/'.$commit_sha1;
         $text   = $this->git_exec->catFile($commit_sha1);

plugins/git/include/Git/Hook/PushDetails.class.php

Doc Comments +3 added lines

@@ -47,6 +47,9 @@
     private $user;
     private $refname;
 
+    /**
+     * @param string $rev_type
+     */
     public function __construct(GitRepository $repository, PFUser $user, $refname, $type, $rev_type, array $revision_list) {
         $this->repository    = $repository;
         $this->user          = $user;