Enalean / tuleap

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'];

plugins/git/include/GitPluginInfo.class.php

Doc Comments +3 added lines

@@ -26,6 +26,9 @@
  */
 class GitPluginInfo extends PluginFileInfo {
     
+    /**
+     * @param GitPlugin $plugin
+     */
     public function __construct( $plugin ) {
         parent::__construct($plugin, 'config');      
         $this->setPluginDescriptor( new GitPluginDescriptor() );

plugins/git/include/GitRepository.class.php

Doc Comments +11 added lines, -1 removed lines

@@ -426,6 +426,9 @@ 
         return $this->creationDate;
     }
 
+    /**
+     * @param PFUser $user
+     */
     public function setCreator($user) {
         $this->creator = $user;
     }
@@ -695,6 +698,7 @@ 
 
     /**
      * Rename project
+     * @param string $newName
      */
     public function renameProject(Project $project, $newName) {
         $newName = strtolower($newName);
@@ -780,6 +784,9 @@ 
         return $this->getBackend()->userCanRead($user, $this);
     }
 
+    /**
+     * @param PFUser $user
+     */
     public function userCanEditOnline($user) {
         return $user->hasPermission(Git::PERM_WRITE, $this->getId(), $this->getProjectId()) && $this->use_online_edit;
     }
@@ -839,7 +846,7 @@ 
      *
      * @param PFUser $user the user
      *
-     * @return true if the repo is a personnal rep and if it is created by $user
+     * @return boolean if the repo is a personnal rep and if it is created by $user
      */
     public function belongsTo(PFUser $user) {
         return $this->getScope() == self::REPO_SCOPE_INDIVIDUAL && $this->getCreatorId() == $user->getId();
@@ -854,6 +861,9 @@ 
         $this->remote_server_id = $id;
     }
 
+    /**
+     * @return integer
+     */
     public function getRemoteServerId() {
         return $this->remote_server_id;
     }

plugins/git/include/GitRepositoryFactory.class.php

Doc Comments +4 added lines, -3 removed lines

@@ -53,6 +53,7 @@ 
     /**
      * Get a project repository by its id
      *
+     * @param integer $id
      * @return GitRepository the repository or null if not found
      */
     public function getRepositoryByIdUserCanSee(PFUser $user, $id) {
@@ -139,7 +140,6 @@ 
     /**
      * Get a project repository by its id
      *
-     * @param int $id         The id of the repository to load
      *
      * @return GitRepository the repository or null if not found
      */
@@ -234,8 +234,8 @@ 
     /**
      * Attempt to get repository if path match given base directory
      *
-     * @param type $base_dir A top level directory that can contains repo
-     * @param type $path     Full repository path
+     * @param string $base_dir A top level directory that can contains repo
+     * @param string $path     Full repository path
      *
      * @return GitRepository
      */
@@ -309,6 +309,7 @@ 
      * Get the list of all repositories for a given project
      *
      * @param Int $project_id
+     * @param integer $retention_period
      *
      * @return GitRepository[]
      */

plugins/git/include/GitRepositoryManager.class.php

Doc Comments +17 added lines, -3 removed lines

@@ -96,6 +96,9 @@ 
         $this->git_system_event_manager->queueRepositoryUpdate($repository);
     }
 
+    /**
+     * @param string $bundle_path
+     */
     public function createFromBundle(GitRepository $repository, GitRepositoryCreator $creator, $bundle_path) {
         if (!$creator->isNameValid($repository->getName())) {
             throw new Exception($GLOBALS['Language']->getText('plugin_git', 'actions_input_format_error', array($creator->getAllowedCharsInNamePattern(), GitDao::REPO_NAME_MAX_LENGTH)));
@@ -173,6 +176,9 @@ 
         throw new Exception($GLOBALS['Language']->getText('plugin_git', 'actions_no_repository_forked'));
     }
 
+    /**
+     * @param string $namespace
+     */
     private function isNamespaceValid(GitRepository $repository, $namespace) {
         if ($namespace) {
             $ns_chunk = explode('/', $namespace);
@@ -186,6 +192,10 @@ 
         return true;
     }
 
+    /**
+     * @param string $namespace
+     * @param string $scope
+     */
     private function forkAllRepositories(array $repos, PFUser $user, $namespace, $scope, Project $project, array $forkPermissions) {
         $forked = false;
         foreach ($repos as $repo) {
@@ -206,10 +216,8 @@ 
     /**
      * Return true if proposed name already exists as a repository path
      *
-     * @param Project $project
-     * @param String  $name
      *
-     * @return Boolean
+     * @return boolean|null
      */
     public function isRepositoryNameAlreadyUsed(GitRepository $new_repository) {
         $repositories = $this->repository_factory->getAllRepositories($new_repository->getProject());
@@ -228,6 +236,9 @@ 
         }
     }
 
+    /**
+     * @param string $new_path
+     */
     private function nameIsSubPathOfExistingRepository($repository_path, $new_path) {
         $repo_path_without_dot_git = $this->stripFinalDotGit($repository_path);
         if (strpos($new_path, "$repo_path_without_dot_git/") === 0) {
@@ -236,6 +247,9 @@ 
         return false;
     }
 
+    /**
+     * @param string $new_path
+     */
     private function nameAlreadyExistsAsPath($repository_path, $new_path) {
         $new_path = $this->stripFinalDotGit($new_path);
         if (strpos($repository_path, "$new_path/") === 0) {