Enalean / tuleap

plugins/git/include/Git_Gitolite_SSHKeyDumper.class.php

Doc Comments +9 added lines, -1 removed lines

@@ -28,6 +28,9 @@ 
     private $admin_path;
     private $git_exec;
 
+    /**
+     * @param string $admin_path
+     */
     public function __construct($admin_path, Git_Exec $git_exec) {
         $this->admin_path   = $admin_path;
         $this->git_exec     = $git_exec;
@@ -129,6 +132,9 @@ 
         $this->removeUserExistingKeysFromAGivenKeyId($user_name, $ssh_key_id);
     }
 
+    /**
+     * @param string $filePath
+     */
     private function writeKeyIfChanged($filePath, $key) {
         $changed = true;
         if (is_file($filePath)) {
@@ -145,7 +151,6 @@ 
     /**
      * Remove all pub SSH keys previously associated to a user
      *
-     * @param IHaveAnSSHKey $user
      * @param int           $last_key_id
      */
     private function removeUserExistingKeysFromAGivenKeyId($user_name, $last_key_id) {
@@ -159,6 +164,9 @@ 
         }
     }
 
+    /**
+     * @param string $userbase
+     */
     private function getKeyNumber($userbase, $file) {
         $matches = array();
         if (preg_match('%^'.$this->getKeyDirPath().'/'.$userbase.'([0-9]+).pub$%', $file, $matches)) {

plugins/git/include/Git_Gitolite_SSHKeyMassDumper.class.php

Doc Comments +3 added lines

@@ -61,6 +61,9 @@
         }
     }
 
+    /**
+     * @param string $file_name
+     */
     private function isReservedName($file_name) {
         if ($this->isAdminKey($file_name) || $this->isGerritKey($file_name)) {
             return true;

plugins/git/include/Git_GitoliteDriver.class.php

Doc Comments +20 added lines, -6 removed lines

@@ -95,8 +95,6 @@ 
     /**
      * Constructor
      *
-     * @param string $adminPath The path to admin folder of gitolite.
-     *                          Default is $sys_data_dir . "/gitolite/admin"
      */
     public function __construct(
         Logger $logger,
@@ -188,6 +186,9 @@ 
         return realpath($this->adminPath .'/../repositories');
     }
 
+    /**
+     * @param string $adminPath
+     */
     public function setAdminPath($adminPath) {
         $this->oldCwd    = getcwd();
         $this->adminPath = $adminPath;
@@ -264,6 +265,9 @@ 
         return $res;
     }
 
+    /**
+     * @param string $message
+     */
     public function commit($message) {
         return $this->gitExec->commit($message);
     }
@@ -278,7 +282,7 @@ 
      * @param String $oldName The old name of the project
      * @param String $newName The new name of the project
      *
-     * @return true if success, false otherwise
+     * @return boolean if success, false otherwise
      */
     public function renameProject($oldName, $newName) {
         $ok = true;
@@ -302,6 +306,9 @@ 
         return $ok;
     }
 
+    /**
+     * @param string $path
+     */
     public function delete($path) {
         if ( empty($path) || !is_writable($path) ) {
            throw new GitDriverErrorException('Empty path or permission denied '.$path);
@@ -316,6 +323,11 @@ 
         return true;
     }
 
+    /**
+     * @param string $repo
+     * @param string $old_ns
+     * @param string $new_ns
+     */
     public function fork($repo, $old_ns, $new_ns) {
         $source = unixPathJoin(array($this->getRepositoriesPath(), $old_ns, $repo)) .'.git';
         $target = unixPathJoin(array($this->getRepositoriesPath(), $new_ns, $repo)) .'.git';
@@ -337,6 +349,9 @@ 
         return false;
     }
 
+    /**
+     * @param string $cmd
+     */
     protected function executeShellCommand($cmd) {
         $cmd = $cmd.' 2>&1';
         exec($cmd, $output, $retVal);
@@ -364,9 +379,8 @@ 
     /**
      * Backup gitolite repository
      *
-     * @param String $path               The repository path
      * @param String $backup_directory The repository backup directory path
-     * @param String $repositoryName
+     * @param String $repository
      *
      */
     public function backup(GitRepository $repository, $backup_directory) {
@@ -418,6 +432,7 @@ 
      * @param GitRepository $repository
      * @param String git_root_path
      * @param String $backup_directory
+     * @param string $git_root_path
      *
      * @return boolean
      *
@@ -454,7 +469,6 @@ 
      * Extract repository
      *
      * @param String $backup_path
-     * @param String $restore_path
      *
      */
     private function extractRepository($backup_path) {

plugins/git/include/GitActions.class.php

Doc Comments +12 added lines, -5 removed lines

@@ -136,6 +136,9 @@ 
         $this->history_dao              = $history_dao;
     }
 
+    /**
+     * @return string
+     */
     protected function getText($key, $params = array()) {
         return $GLOBALS['Language']->getText('plugin_git', $key, $params);
     }
@@ -144,6 +147,10 @@ 
        return call_user_func_array(array($this,$action), $params);
     }
 
+    /**
+     * @param integer $projectId
+     * @param integer $repositoryId
+     */
     public function deleteRepository( $projectId, $repositoryId ) {
         $controller   = $this->getController();
         $projectId    = intval($projectId);
@@ -232,7 +239,6 @@ 
      *
      * @param Project $project
      * @param PFUser $user
-     * @param Project[] $parent_projects
      */
     public function generateGerritRepositoryAndTemplateList(Project $project, PFUser $user) {
         $repos            = $this->factory->getAllGerritRepositoriesFromProject($project, $user);
@@ -731,7 +737,6 @@ 
     /**
      * Internal method called by SystemEvent_PROJECT_IS_PRIVATE
      * @param <type> $projectId
-     * @param <type> $isPublic
      * @return <type>
      */
     public static function changeProjectRepositoriesAccess($projectId, $isPrivate, GitDao $dao, GitRepositoryFactory $factory) {
@@ -792,12 +797,12 @@ 
     /**
      * Fork a bunch of repositories in a project for a given user
      *
-     * @param int    $groupId         The project id
-     * @param array  $repos_ids       The array of id of repositories to fork
+     * @param array  $repos       The array of id of repositories to fork
      * @param string $namespace       The namespace where the new repositories will live
      * @param PFUser   $user            The owner of those new repositories
      * @param Layout $response        The response object
      * @param array  $forkPermissions Permissions to be applied for the new repository
+     * @param string $redirect_url
      */
     public function fork(array $repos, Project $to_project, $namespace, $scope, PFUser $user, Layout $response, $redirect_url, array $forkPermissions) {
         try {
@@ -838,7 +843,6 @@ 
      *
      * @param GitRepository $repository
      * @param int $remote_server_id the id of the server to which we want to migrate
-     * @param Boolean $migrate_access_right if the acess right will be migrated or not
      * @param int $gerrit_template_id the id of template if any chosen
      */
     public function migrateToGerrit(GitRepository $repository, $remote_server_id, $gerrit_template_id) {
@@ -863,6 +867,9 @@ 
         $this->getController()->redirect($this->url_manager->getRepositoryBaseUrl($repository));
     }
 
+    /**
+     * @param string $error_key
+     */
     private function addError($error_key) {
         $this->getController()->addError($this->getText($error_key));
     }

plugins/git/include/GitBackend.class.php

Doc Comments +2 added lines, -2 removed lines

@@ -114,7 +114,7 @@ 
 
     /**
      *
-     * @param GitRepository $respository
+     * @param GitRepository $repository
      * @return bool
      */
     public function isCreated(GitRepository $repository) {
@@ -320,7 +320,7 @@ 
      * @param Statistics_Formatter $formatter   instance of statistics formatter class
      * @param String               $type        backend type
      * @param Array                $typeIndex   backend type index
-     * @param Array                $typeArray   backend type array
+     * @param string[]                $typeArray   backend type array
      * @param Boolean              $keepedAlive keep only reposirtories that still active
      *
      * @return Void

plugins/git/include/GitDao.class.php

Doc Comments +38 added lines, -2 removed lines

@@ -69,6 +69,9 @@ 
         $this->tableName = $tableName;
     }
 
+    /**
+     * @param string $id
+     */
     public function exists($id) {
         if ( empty($id) ) {
             return false;
@@ -213,6 +216,9 @@ 
         return false;
     }
 
+    /**
+     * @param string $newName
+     */
     public function renameProject(Project $project, $newName) {
         $oldPath = $this->da->quoteSmart($project->getUnixName().'/');
         $newPath = $this->da->quoteSmart($newName.'/');
@@ -284,6 +290,7 @@ 
     /**
      * Return the list of users that owns repositories in the project $projectId
      *
+     * @param integer $projectId
      * @return DataAccessResult
      */
     public function getProjectRepositoriesOwners($projectId) {
@@ -298,6 +305,9 @@ 
         return $this->retrieve($sql);
     }
 
+    /**
+     * @param integer $projectId
+     */
     public function getAllGitoliteRespositories($projectId) {
         $projectId     = $this->da->escapeInt($projectId);
         $type_gitolite = $this->da->quoteSmart(self::BACKEND_GITOLITE);
@@ -359,6 +369,9 @@ 
         return $this->retrieve($query);
     }
 
+    /**
+     * @param GitRepository $repository
+     */
     public function hasChild($repository) {
         $repoId = $this->da->escapeInt( $repository->getId() );
         if ( empty($repoId) ) {
@@ -382,9 +395,12 @@ 
      * This function log a Git Push in the database
      *
      * @param Integer $repoId        Id of the git repository
-     * @param Integer $UserId        Id of the user that performed the push
+     * @param Integer $userId        Id of the user that performed the push
      * @param Integer $pushTimestamp Date of the push
      * @param Integer $commitsNumber Number of commits
+     * @param string $refname
+     * @param string $operation_type
+     * @param string $refname_type
      *
      * @return Boolean
      */
@@ -416,6 +432,9 @@ 
         return $this->update($query);
     }
 
+    /**
+     * @param GitRepository $repository
+     */
     public function getProjectRepositoryById($repository) {
         $id = (int)$repository->getId();
         if ( empty($id) ) {
@@ -449,6 +468,9 @@ 
         return $this->retrieve($query);
     }
 
+    /**
+     * @param integer $id
+     */
     public function searchDeletedRepositoryById($id) {
         $id = $this->da->escapeInt($id);
         $query = 'SELECT * '.
@@ -540,6 +562,10 @@ 
         return $this->retrieve($query);
     }
 
+    /**
+     * @param integer $project_id
+     * @param string $path
+     */
     public function isRepositoryExisting($project_id, $path) {
         $project_id = $this->da->escapeInt($project_id);
         $path       = $this->da->quoteSmart($path);
@@ -602,6 +628,10 @@ 
         return count($this->retrieve($sql)) > 0;
     }
 
+    /**
+     * @param integer $project_id
+     * @param integer[] $ugroup_ids
+     */
     public function searchGerritRepositoriesWithPermissionsForUGroupAndProject($project_id, $ugroup_ids) {
         $project_id = $this->da->escapeInt($project_id);
         $ugroup_ids = $this->da->escapeIntImplode($ugroup_ids);
@@ -621,6 +651,9 @@ 
 
     }
 
+    /**
+     * @param integer $project_id
+     */
     public function searchAllGerritRepositoriesOfProject($project_id) {
         $project_id = $this->da->escapeInt($project_id);
         $sql = "SELECT *
@@ -690,7 +723,7 @@ 
      *
      * @param Int $repository_id
      *
-     * @return GitDaoException | true
+     * @return boolean | true
      */
     public function activate($repository_id) {
         $id = $this->da->escapeInt($repository_id);
@@ -701,6 +734,9 @@ 
         return $this->update($query);
     }
 
+    /**
+     * @param integer $project_id
+     */
     public function getPaginatedOpenRepositories($project_id, $limit, $offset) {
         $project_id = $this->da->escapeInt($project_id);
         $limit      = $this->da->escapeInt($limit);

plugins/git/include/GitDriver.class.php

Doc Comments +54 added lines, -1 removed lines

@@ -34,6 +34,10 @@ 
     public function __construct() {
     }
 
+    /**
+     * @param string $cmd
+     * @param string $action_name
+     */
     protected function execGitAction($cmd, $action_name) {
         $out = array();
         $ret = -1;
@@ -55,7 +59,7 @@ 
      * Make a clone of a source repository
      * @param <String> $source      source directory
      * @param <String> $destination destination directory
-     * @param <String> $option     String of options.
+     * @param string $option     String of options.
      * @return <boolean>
      */
     private function cloneRepo($source, $destination, $option) {
@@ -67,6 +71,10 @@ 
         return $this->execGitAction($cmd, "clone");
     }
 
+    /**
+     * @param string $source
+     * @param string $destination
+     */
     public function fork($source, $destination) {
         $this->checkFileExist($source);
 
@@ -75,12 +83,22 @@ 
         return $this->setUpFreshRepository($destination);
     }
 
+    /**
+     * @param string $source
+     * @param string $destination
+     * @param string $branch
+     */
     public function cloneAtSpecifiqBranch($source, $destination, $branch) {
         $this->checkFileExist($source);
 
         return $this->cloneRepo($source, $destination, '--branch '.$branch);
     }
 
+    /**
+     * @param string $repositoryPath
+     * @param string $email
+     * @param string $name
+     */
     public function changeGitUserInfo($repositoryPath, $email, $name) {
         $this->checkFileExist($repositoryPath);
         $cmdEmail = 'cd '. escapeshellarg($repositoryPath).' && git config --local user.email '.escapeshellarg($email).' 2>&1';
@@ -89,6 +107,10 @@ 
         return $this->execGitAction($cmdEmail, 'change user email').' '.$this->execGitAction($cmdName, 'change user name');
     }
 
+    /**
+     * @param string $repositoryPath
+     * @param string $filePathFromRepository
+     */
     public function add($repositoryPath, $filePathFromRepository) {
         $this->checkFileExist($repositoryPath);
         $cmd = 'cd '.escapeshellarg($repositoryPath).' && git add '.escapeshellarg($filePathFromRepository).' 2>&1';
@@ -96,6 +118,10 @@ 
         return $this->execGitAction($cmd, 'add');
     }
 
+    /**
+     * @param string $repositoryPath
+     * @param string $message
+     */
     public function commit($repositoryPath, $message) {
         $this->checkFileExist($repositoryPath);
         $cmd = 'cd '.escapeshellarg($repositoryPath).' && git commit --allow-empty -m '.escapeshellarg($message).' 2>&1';
@@ -103,6 +129,10 @@ 
         return $this->execGitAction($cmd, 'commit');
     }
 
+    /**
+     * @param string $repositoryPath
+     * @param string $bareURL
+     */
     public function mergeAndPush($repositoryPath, $bareURL) {
         $this->checkFileExist($repositoryPath);
         $cmd = 'cd '.escapeshellarg($repositoryPath).' && git pull --quiet --rebase && git push '. $bareURL .' 2>&1';
@@ -117,6 +147,9 @@ 
         return $this->execGitAction($cmd, 'get informations');
     }
 
+    /**
+     * @param string $repositoryPath
+     */
     public function removeRepository($repositoryPath) {
         $this->checkFileExist($repositoryPath);
         $cmd = 'rm --recursive --dir --force '.escapeshellarg($repositoryPath).' 2>&1';
@@ -124,6 +157,9 @@ 
         return $this->execGitAction($cmd, 'rm');
     }
 
+    /**
+     * @return string
+     */
     public function getGitVersion() {
         $cmd        = 'git --version';
         $cmd_result = $this->execGitAction($cmd, 'version');
@@ -187,6 +223,9 @@ 
         return $this->setPermissions($path);
     }
 
+    /**
+     * @param string $path
+     */
     public function delete($path) {
         if ( empty($path) || !is_writable($path) ) {
            throw new GitDriverErrorException('Empty path or permission denied '.$path);
@@ -199,6 +238,10 @@ 
         return true;
     }
 
+    /**
+     * @param string $hookName
+     * @param string $repoPath
+     */
     public function activateHook($hookName, $repoPath, $uid=false, $gid=false) {
         //newer version of git
         $hook = $repoPath.'/hooks/'.$hookName;
@@ -225,6 +268,9 @@ 
         return true;
     }
 
+    /**
+     * @param string $repoPath
+     */
     public function masterExists($repoPath) {
         if ( file_exists($repoPath.'/refs/heads/master') ) {
             return true;
@@ -241,6 +287,10 @@ 
         return is_dir($repoPath.'/refs/heads');
     }
 
+    /**
+     * @param string $repoPath
+     * @param string $description
+     */
     public function setDescription($repoPath, $description) {
         if( ! file_put_contents($repoPath.'/description', $description) ) {
             throw new GitDriverErrorException('Unable to set description');
@@ -248,6 +298,9 @@ 
         return true;
     }
 
+    /**
+     * @param string $repoPath
+     */
     public function getDescription($repoPath) {
         return file_get_contents($repoPath.'/description');
     }

plugins/git/include/GitPermissionsManager.class.php

Doc Comments +6 added lines

@@ -70,10 +70,16 @@
         return permission_db_authorized_ugroups(Git::PERM_ADMIN, $project->getID());
     }
 
+    /**
+     * @return integer
+     */
     private function getDefaultGitAdminPermissions() {
         return permission_db_get_defaults(Git::PERM_ADMIN);
     }
 
+    /**
+     * @param integer $project_id
+     */
     public function getCurrentGitAdminUgroups($project_id) {
         return $this->permissions_manager->getAuthorizedUgroupIds($project_id, Git::PERM_ADMIN);
     }

plugins/git/include/gitPlugin.class.php

Doc Comments +9 added lines, -1 removed lines

@@ -46,6 +46,9 @@ 
      */
     const SERVICE_SHORTNAME = 'plugin_git';
 
+    /**
+     * @param integer $id
+     */
     public function __construct($id) {
         parent::__construct($id);
         $this->setScope(Plugin::SCOPE_PROJECT);
@@ -593,7 +596,6 @@ 
 
     /**
      *
-     * @param PFUser $user
      * @return Git_UserAccountManager
      */
     private function getUserAccountManager() {
@@ -689,6 +691,9 @@ 
         $this->getLogger()->info('Successfully pushed ssh keys for user: '.$user->getUnixName());
     }
 
+    /**
+     * @return PFUser
+     */
     private function getUserFromParameters($params) {
         if (! isset($params['user']) || ! $params['user'] instanceof PFUser) {
             $this->getLogger()->error('Invalid user passed in params: ' . print_r($params, true));
@@ -1083,6 +1088,9 @@ 
     }
 
 
+    /**
+     * @return ProjectUGroup
+     */
     private function getUGroupFromParams(array $params) {
         if (isset($params['ugroup'])) {
             return $params['ugroup'];