silverstripe / silverstripe-dms

code/model/DMSDocument_versions.php

Doc Comments +2 added lines, -2 removed lines

@@ -197,8 +197,8 @@ 
      * Creates a new filename for the current Document's file when replacing the
      * current file with a new file.
      *
-     * @param DMSDocument $filename The original filename
      *
+     * @param integer $versionCounter
      * @return string The new filename
      */
     protected function generateVersionedFilename(DMSDocument $doc, $versionCounter)
@@ -242,7 +242,7 @@ 
     /**
      * Return the size of the file associated with the document.
      *
-     * @return string
+     * @return integer
      */
     public function getAbsoluteSize()
     {

code/tools/ShortCodeRelationFinder.php

Doc Comments +4 added lines

@@ -32,6 +32,9 @@ 
         return $found;
     }
 
+    /**
+     * @param integer $number
+     */
     public function findPageCount($number)
     {
         $list = $this->getList($number);
@@ -63,6 +66,7 @@ 
      * Returns a filtered list of fields which could contain shortcodes.
      *
      * @param String
+     * @param string $class
      * @return Array Map of class names to an array of field names on these classes.
      */
     public function getShortcodeFields($class)

tests/DMSEmbargoTest.php

Doc Comments +3 added lines

@@ -20,6 +20,9 @@
         self::$is_running_test = $this->originalIsRunningTest;
     }
 
+    /**
+     * @param integer $id
+     */
     public function createFakeHTTPRequest($id)
     {
         $r = new SS_HTTPRequest('GET', 'index/'.$id);

code/cms/DMSDocumentAddExistingField.php

Doc Comments +4 added lines

@@ -4,6 +4,10 @@
 {
     public $useFieldContext = true;
 
+    /**
+     * @param string $name
+     * @param string $title
+     */
     public function __construct($name, $title = null)
     {
         $this->name = $name;

code/DMS.php

Doc Comments +6 added lines, -2 removed lines

@@ -57,6 +57,9 @@ 
         return BASE_PATH . DIRECTORY_SEPARATOR . self::$dmsFolder;
     }
 
+    /**
+     * @return string
+     */
     public static function transform_file_to_file_path($file)
     {
         //confirm we have a file
@@ -77,7 +80,7 @@ 
     /**
      * Takes a File object or a String (path to a file) and copies it into the DMS. The original file remains unchanged.
      * When storing a document, sets the fields on the File has "tag" metadata.
-     * @param $file File object, or String that is path to a file to store,
+     * @param string $file File object, or String that is path to a file to store,
      *              e.g. "assets/documents/industry/supplied-v1-0.pdf"
      * @return DMSDocument
      */
@@ -149,7 +152,7 @@ 
 
     /**
      * Creates a storage folder for the given path
-     * @param $path Path to create a folder for
+     * @param string $path Path to create a folder for
      */
     public static function create_storage_folder($path)
     {
@@ -160,6 +163,7 @@ 
 
     /**
      * Calculates the storage path from a database DMSDocument ID
+     * @param integer $id
      */
     public static function get_storage_folder($id)
     {

code/interface/DMSDocumentInterface.php

Doc Comments +5 added lines, -4 removed lines

@@ -16,7 +16,7 @@ 
      * Can could be implemented as a key/value store table (although it is more like category/value, because the
      * same category can occur multiple times)
      * @param $category String of a metadata category to add (required)
-     * @param $value String of a metadata value to add (required)
+     * @param string $value String of a metadata value to add (required)
      * @param bool $multiValue Boolean that determines if the category is multi-value or single-value (optional)
      * @return null
      */
@@ -26,7 +26,7 @@ 
      * Fetches all tags associated with this DMSDocument within a given category. If a value is specified this method
      * tries to fetch that specific tag.
      * @param $category String of the metadata category to get
-     * @param null $value String of the value of the tag to get
+     * @param string|null $value String of the value of the tag to get
      * @return array of Strings of all the tags or null if there is no match found
      */
     public function getTagsList($category, $value = null);
@@ -36,7 +36,7 @@ 
      * If you specify both a category and a value, then only that single category/value pair is deleted.
      * Nothing happens if the category or the value do not exist.
      * @param $category Category to remove (required)
-     * @param null $value Value to remove (optional)
+     * @param string|null $value Value to remove (optional)
      * @return null
      */
     public function removeTag($category, $value = null);
@@ -55,6 +55,7 @@ 
 
     /**
      * Return the extension of the file associated with the document
+     * @return string
      */
     public function getExtension();
 
@@ -77,7 +78,7 @@ 
      * Takes a File object or a String (path to a file) and copies it into the DMS, replacing the original document file
      * but keeping the rest of the document unchanged.
      * @param $file File object, or String that is path to a file to store
-     * @return DMSDocumentInstance Document object that we replaced the file in
+     * @return DMSDocument Document object that we replaced the file in
      */
     public function replaceDocument($file);
 

tests/Stub/StubRelatedDocumentExtension.php

Doc Comments +1 added lines, -1 removed lines

@@ -17,7 +17,7 @@
     /**
      * For method {@link DMSDocumentSet::getDocuments}
      *
-     * @param  ArrayList $relatedDocuments
+     * @param  ArrayList $documents
      * @return ArrayList
      */
     public function updateDocuments($documents)

code/cms/DMSUploadField.php

Doc Comments +5 added lines, -1 removed lines

@@ -28,6 +28,7 @@ 
      * Override the default behaviour of the UploadField and take the uploaded file (uploaded to assets) and
      * add it into the DMS storage, deleting the old/uploaded file.
      * @param File
+     * @param File $file
      */
     protected function attachFile($file)
     {
@@ -54,6 +55,9 @@ 
         return $doc;
     }
 
+    /**
+     * @param string $validator
+     */
     public function validate($validator)
     {
         return true;
@@ -63,7 +67,7 @@ 
      * Action to handle upload of a single file
      *
      * @param SS_HTTPRequest $request
-     * @return string json
+     * @return SS_HTTPResponse json
      */
     public function upload(SS_HTTPRequest $request)
     {

code/tasks/MigrateToDocumentSetsTask.php

Doc Comments +3 added lines

@@ -40,6 +40,9 @@
      */
     protected $results = array();
 
+    /**
+     * @param SS_HTTPRequest $request
+     */
     public function run($request)
     {
         $this->request = $request;