Enalean / tuleap

plugins/phpwiki/include/lib/PHPWikiAttachment.class.php

Doc Comments +3 added lines, -1 removed lines

@@ -107,6 +107,7 @@ 
     /**
      * @access public
      * @param  Iterator
+     * @param integer $gid
      */
     public function getAttachmentIterator($gid=null) {
         $waArray = array();
@@ -518,6 +519,7 @@ 
 
     /**
      * @access public
+     * @param integer $uid
      */
     public function isAutorized($uid) {            
         require_once('www/project/admin/permissions.php');
@@ -594,7 +596,7 @@ 
      * @param Integer $offset
      * @param Integer $limit
      *
-     * @return Boolean
+     * @return DataAccessResult
      */
     public function listPendingAttachments($groupId, $offset, $limit) {
         $dao = $this->getDao();

plugins/phpwiki/include/lib/PHPWikiAttachmentDao.class.php

Doc Comments +2 added lines, -1 removed lines

@@ -28,6 +28,7 @@ 
      *
      * @param integer $gid Group id
      * @param string $filename Attachement name
+     * @param string $filesystemName
      * @return boolean
      */
     function create($gid, $filename, $filesystemName) {
@@ -176,8 +177,8 @@ 
     /**
      * Save the purge date of a deleted attachment
      *
-     * @param Integer $attachmentId
      * @param Integer $time
+     * @param integer $id
      *
      * @return Boolean
      */

plugins/phpwiki/include/lib/PHPWikiAttachmentRevision.class.php

Doc Comments +18 added lines

@@ -59,6 +59,7 @@ 
 
     /**
      *
+     * @param integer $gid
      */
     function PHPWikiAttachmentRevision($gid=null) {
         if(is_numeric($gid)) {
@@ -173,6 +174,9 @@ 
     }
 
 
+    /**
+     * @param integer $userId
+     */
     function log($userId) {
         $dao =& $this->getDao();
         $dao->log($this->attachmentId, 
@@ -201,6 +205,9 @@ 
         return true;
     }
 
+	/**
+	 * @param integer $gid
+	 */
 	function setGid($gid) {
 		 if(is_numeric($gid)) {
             $this->gid = (int) $gid;
@@ -234,6 +241,9 @@ 
         return true;
     }
   
+    /**
+     * @param integer $uid
+     */
     function setOwnerId($uid) {
         $this->owner_id = (int) $uid;
         return true;
@@ -244,11 +254,17 @@ 
         return true;
     }
 
+    /**
+     * @param integer $date
+     */
     function setDate($date) {
         $this->date = (int) $date;
         return true;
     }
 
+    /**
+     * @param integer $rev
+     */
     function setRevision($rev) {
         $this->revision = (int) $rev;
         return true;
@@ -315,6 +331,8 @@ 
     /**
      * @access public static
      * @param  Iterator
+     * @param integer $gid
+     * @param integer $id
      */
     function &getRevisionIterator($gid=null, $id=null) {
         $warArray = array();

plugins/phpwiki/include/lib/PHPWikiAttachmentRevisionDao.class.php

Doc Comments +13 added lines

@@ -26,6 +26,11 @@ 
     /**
      * Create a new attachment revision
      *
+     * @param integer $attachmentId
+     * @param integer $ownerId
+     * @param integer $date
+     * @param integer $revision
+     * @param integer $size
      * @return boolean success or failure
      */
     function create($attachmentId, $ownerId, $date, $revision, $type, $size) {
@@ -47,6 +52,11 @@ 
         return $inserted;
     }
 
+    /**
+     * @param integer $attachmentId
+     * @param integer $groupId
+     * @param integer $date
+     */
     function log($attachmentId, $revision, $groupId, $userId, $date) {
         $sql = sprintf('INSERT INTO plugin_phpwiki_attachment_log SET'
                        .'  user_id                     = %d'
@@ -66,6 +76,8 @@ 
 
     /**
      * Get one revision
+     * @param integer $attachmentId
+     * @param integer $revision
      */
     function getRevision($attachmentId, $revision) {
         $sql = sprintf('SELECT * FROM plugin_phpwiki_attachment_revision'
@@ -79,6 +91,7 @@ 
     
     /**
      * Fetch all revisions of a given attachment
+     * @param integer $id
      */
     function getAllRevisions($id) {
         $sql = sprintf('SELECT * FROM plugin_phpwiki_attachment_revision'

plugins/phpwiki/include/lib/PHPWikiCloner.class.php

Doc Comments +4 added lines, -1 removed lines

@@ -74,7 +74,7 @@ 
  /**
    *
    *  Check if template project has wiki service enabled
-   *  @return boolean
+   *  @return boolean|null
    *
    */
   function templateWikiExists(){
@@ -311,6 +311,7 @@ 
    *  @param int : template attachment id
    *
    *  @param int : cloned attachment id.
+   * @param integer $permission
    *
    */
   function insertNewAttachmentPermission($new_attachment_id, $permission){
@@ -323,6 +324,7 @@ 
    *  Create attachment directory in new project attachment space..
    *
    *  @param string : name of the attachment
+   * @param integer $mode
    *
    */
   function createAttachmentDir($name, $mode){
@@ -384,6 +386,7 @@ 
   *  Gets a file mode.
   *
   *  @param string : path to the file or directory.
+  * @param string $file
   *
   *  @returns string : octal mode of the file.
   *

plugins/phpwiki/include/lib/PHPWikiEntry.class.php

Doc Comments +4 added lines

@@ -66,6 +66,9 @@ 
     $this->id = (int) $id;
   }
 
+  /**
+   * @param integer $gid
+   */
   function setGid($gid) {
     $this->gid = (int) $gid;
   }
@@ -146,6 +149,7 @@ 
 
     /**
      * Return an iterator on WikiEntries
+     * @param integer $gid
      */
     function getEntryIterator($gid=null) {
         if($gid !== null) {

plugins/phpwiki/include/lib/PHPWikiPage.class.php

Doc Comments +6 added lines

@@ -251,6 +251,9 @@ 
         return $referenced;
     }
 
+    /**
+     * @param integer $uid
+     */
     public function isAutorized($uid) {
         if($this->referenced == true) {
             $userCanAccess = false;
@@ -302,6 +305,9 @@ 
       return($this->id != 0);
     }
 
+    /**
+     * @param integer $user_id
+     */
     public function log($user_id) {
       $sql = "INSERT INTO plugin_phpwiki_log(user_id,group_id,pagename,time) "
             ."VALUES ('".db_ei($user_id)."','".db_ei($this->gid)."','".db_es($this->pagename)."','".db_ei(time())."')";

plugins/phpwiki/include/lib/PHPWikiPageVersionContentFormatter.php

Doc Comments +6 added lines

@@ -31,6 +31,9 @@ 
     /** @var PHPWikiPageWrapper */
     private $wrapper;
 
+    /**
+     * @param integer $project_id
+     */
     public function __construct($project_id) {
         $this->wrapper = new PHPWikiPageWrapper($project_id);
     }
@@ -51,6 +54,9 @@ 
         return ob_get_clean();
     }
 
+    /**
+     * @return boolean
+     */
     private function getTransformedContent(
         PHPWikiPage $wiki_page,
         PHPWikiPageVersion $version,

plugins/phpwiki/include/lib/PHPWikiPageVersionFactory.class.php

Doc Comments +7 added lines, -2 removed lines

@@ -23,11 +23,15 @@ 
     /** @var PHPWikiVersionDao */
     private $wiki_version_dao;
 
+    /**
+     * @param PHPWikiVersionDao $wiki_version_dao
+     */
     public function __construct($wiki_version_dao) {
         $this->wiki_version_dao = $wiki_version_dao;
     }
 
-    /** @return PHPWikiPageVersion */
+    /** @param integer $page_id
+/** @return PHPWikiPageVersion */
     public function getPageVersion($page_id, $page_version_id) {
         $page_version = null;
 
@@ -39,7 +43,8 @@ 
         return $page_version;
     }
 
-    /** @return array */
+    /** @param integer $page_id
+/** @return array */
     public function getPageAllVersions($page_id) {
         $page_versions = array();