Usage of URL routes for BucketInterface::getFileUrl() provided

Author: klimov-paul

BaseBucket.php

@@ -9,6 +9,7 @@
 
 use Yii;
 use yii\base\Object;
+use yii\helpers\Url;
 use yii\log\Logger;
 
 /** 
@@ -29,7 +30,7 @@ abstract class BaseBucket extends Object implements BucketInterface
     /**
      * @var StorageInterface file storage, which owns the bucket.
      */
-    private $_storage = null;
+    private $_storage;
 
 
     /**
@@ -86,4 +87,33 @@ public function getStorage()
     {
         return $this->_storage;
     }
+
+    /**
+     * @inheritdoc
+     */
+    public function getFileUrl($fileName)
+    {
+        $baseUrl = $this->getStorage()->getBaseUrl();
+        if (is_array($baseUrl)) {
+            $url = $baseUrl;
+            $url['bucket'] = $this->getName();
+            $url['filename'] = $fileName;
+            return Url::to($url);
+        }
+
+        return $this->composeFileUrl($baseUrl, $fileName);
+    }
+
+    /**
+     * Composes file URL from the base URL and filename.
+     * This method is invoked at [[getFileUrl()]] in case base URL does not specify a URL route.
+     * @param string|null $baseUrl storage base URL.
+     * @param string $fileName self file name.
+     * @return string file web URL.
+     * @since 1.1.0
+     */
+    protected function composeFileUrl($baseUrl, $fileName)
+    {
+        return $baseUrl . '/' . urlencode($this->getName()) . '/' . $fileName;
+    }
 }

BaseStorage.php

@@ -21,20 +21,28 @@
  *
  * @property BucketInterface[] $buckets list of buckets.
  * @property string $bucketClassName name of the bucket class.
+ * @property string|array $baseUrl web URL, which is basic for all buckets at [[BucketInterface::getFileUrl()]].
  *
  * @author Paul Klimov <klimov.paul@gmail.com>
  * @since 1.0
  */
 abstract class BaseStorage extends Component implements StorageInterface
 {
+    /**
+     * @var string name of the bucket class.
+     */
+    public $bucketClassName = 'yii2tech\filestorage\BaseBucket';
+
     /**
      * @var BucketInterface[] list of buckets.
      */
     private $_buckets = [];
     /**
-     * @var string name of the bucket class.
+     * @var string|array web URL, which is basic for all buckets.
+     * You can setup this field as array, which will be treated as a route specification for [[\yii\helpers\Url::to()]].
+     * @since 1.1.0
      */
-    public $bucketClassName = 'yii2tech\filestorage\BaseBucket';
+    private $_baseUrl;
 
 
     /**
@@ -153,4 +161,23 @@ public function hasBucket($bucketName)
     {
         return array_key_exists($bucketName, $this->_buckets);
     }
+
+    /**
+     * @inheritdoc
+     */
+    public function setBaseUrl($baseUrl)
+    {
+        if (is_string($baseUrl)) {
+            $baseUrl = Yii::getAlias($baseUrl);
+        }
+        $this->_baseUrl = $baseUrl;
+    }
+
+    /**
+     * @inheritdoc
+     */
+    public function getBaseUrl()
+    {
+        return $this->_baseUrl;
+    }
 }

BucketSubDirTemplate.php

@@ -7,8 +7,6 @@
 
 namespace yii2tech\filestorage;
 
-use CException;
-use CFileHelper;
 use yii\base\Exception;
 
 /**
@@ -37,7 +35,10 @@ abstract class BucketSubDirTemplate extends BaseBucket
      * For example:
      * if file name equal to 54321.tmp, placeholder {^name} will be resolved as "5", {^^name} - as "4" and so on.
      * Example value:
+     *
+     * ```
      * '{^name}/{^^name}'
+     * ```
      */
     public $fileSubDirTemplate = '';
 
@@ -137,4 +138,19 @@ public function getFileNameWithSubDir($fileName)
         }
         return $fullFileName;
     }
-}
+
+    /**
+     * @inheritdoc
+     */
+    protected function composeFileUrl($baseUrl, $fileName)
+    {
+        $baseUrl = $baseUrl . '/' . urlencode($this->getName());
+
+        $fileSubDir = $this->getFileSubDir($fileName);
+        if (!empty($fileSubDir)) {
+            $baseUrl .= '/' . $fileSubDir;
+        }
+
+        return $baseUrl . '/' . $fileName;
+    }
+}

CHANGELOG.md

@@ -5,6 +5,7 @@ Yii 2 File Storage extension Change Log
 -----------------------
 
 - Enh #4: Added `yii2tech\filestorage\BucketInterface::openFile()` allowing to open file as a PHP resource (klimov-paul)
+- Enh #7: Usage of URL routes for `BucketInterface::getFileUrl()` provided (klimov-paul)
 
 
 1.0.1, April 25, 2016

StorageInterface.php

@@ -52,4 +52,30 @@ public function addBucket($bucketName, $bucketData = []);
      * @return boolean success.
      */
     public function hasBucket($bucketName);
+
+    /**
+     * Sets the base URL, which should be used by [[BucketInterface::getFileUrl()]].
+     * Example values:
+     *
+     * ```php
+     * 'http://files.domain.com',
+     * '//files.domain.com',
+     * '@web/files',
+     * ['/file/download'],
+     * ```
+     *
+     * @param string|array|null $baseUrl web URL, which is basic for all buckets.
+     * If string given, the URL will be composed by pattern: `{baseUrl}/{bucketName}/{fileName}`.
+     * If array given, it is considered as a route for URL creation via [[\yii\web\UrlManager]],
+     * bucket name will be added as `bucket` param, and file name will be added as `filename`.
+     * @since 1.1.0
+     */
+    public function setBaseUrl($baseUrl);
+
+    /**
+     * Returns the base URL, which should be used by [[BucketInterface::getFileUrl()]].
+     * @return string|array|null web URL, which is basic for all buckets.
+     * @since 1.1.0
+     */
+    public function getBaseUrl();
 }

amazon/Bucket.php

@@ -489,14 +489,17 @@ public function moveFileInternal($srcFile, $destFile)
     /**
      * @inheritdoc
      */
-    public function getFileUrl($fileName)
+    protected function composeFileUrl($baseUrl, $fileName)
     {
-        if (!$this->exists()) {
-            $this->create();
+        if ($baseUrl === null) {
+            if (!$this->exists()) {
+                $this->create();
+            }
+            $fileName = $this->getFullFileName($fileName);
+            $amazonS3 = $this->getStorage()->getAmazonS3();
+            return $amazonS3->getObjectUrl($this->getUrlName(), $fileName);
         }
-        $fileName = $this->getFullFileName($fileName);
-        $amazonS3 = $this->getStorage()->getAmazonS3();
-        return $amazonS3->getObjectUrl($this->getUrlName(), $fileName);
+        return parent::composeFileUrl($baseUrl, $fileName);
     }
 
     /**

local/Bucket.php

@@ -386,13 +386,10 @@ public function moveFileInternal($srcFile, $destFile)
     }
 
     /**
-     * Gets web URL of the file.
-     * @param string $fileName - self file name.
-     * @return string file web URL.
+     * @inheritdoc
      */
-    public function getFileUrl($fileName)
+    protected function composeFileUrl($baseUrl, $fileName)
     {
-        $baseUrl = $this->getStorage()->getBaseUrl();
         $baseUrl .= '/' . $this->getBaseSubPath();
         $fileSubDir = $this->getFileSubDir($fileName);
         if (!empty($fileSubDir)) {

local/Storage.php

@@ -37,7 +37,6 @@
  * @see Bucket
  *
  * @property string $basePath file system path, which is basic for all buckets.
- * @property string $baseUrl web URL, which is basic for all buckets.
  * @method Bucket getBucket($bucketName)
  *
  * @author Paul Klimov <klimov.paul@gmail.com>
@@ -58,10 +57,6 @@ class Storage extends BaseStorage
      * @var string file system path, which is basic for all buckets.
      */
     private $_basePath = '';
-    /**
-     * @var string web URL, which is basic for all buckets.
-     */
-    private $_baseUrl = '';
 
 
     /**
@@ -79,20 +74,4 @@ public function getBasePath()
     {
         return $this->_basePath;
     }
-
-    /**
-     * @param string $baseUrl web URL, which is basic for all buckets.
-     */
-    public function setBaseUrl($baseUrl)
-    {
-        $this->_baseUrl = Yii::getAlias($baseUrl);
-    }
-
-    /**
-     * @return string web URL, which is basic for all buckets.
-     */
-    public function getBaseUrl()
-    {
-        return $this->_baseUrl;
-    }
 }

mongodb/Bucket.php

@@ -279,16 +279,6 @@ public function moveFileInternal($srcFile, $destFile)
         return true;
     }
 
-    /**
-     * Gets web URL of the file.
-     * @param string $fileName - self file name.
-     * @return string file web URL.
-     */
-    public function getFileUrl($fileName)
-    {
-        // TODO: Implement getFileUrl() method.
-    }
-
     /**
      * @inheritdoc
      */

tests/BucketTestTrait.php

@@ -359,16 +359,33 @@ public function testMoveFileInternalDifferentBuckets()
      */
     public function testGetFileUrl()
     {
-        $bucket = $this->createFileStorageBucket();
-        $testBucketName = 'test_get_file_url_bucket';
-        $bucket->setName($testBucketName);
+        $bucket = $this->createFileStorageBucket(['name' => 'test_get_file_url_bucket']);
+
+        $testFileName = 'test_file_name.tmp';
+        $testFileContent = 'Test file content';
+        $bucket->saveFileContent($testFileName, $testFileContent);
+
+        $returnedFileUrl = $bucket->getFileUrl($testFileName);
+        $this->assertTrue(!empty($returnedFileUrl), 'File URL is empty!');
+    }
+
+    /**
+     * @depends testGetFileUrl
+     */
+    public function testCreateFileUrl()
+    {
+        $bucket = $this->createFileStorageBucket(['name' => 'test_create_file_url_bucket']);
+        $bucket->getStorage()->setBaseUrl(['/site/download']);
 
         $testFileName = 'test_file_name.tmp';
         $testFileContent = 'Test file content';
         $bucket->saveFileContent($testFileName, $testFileContent);
 
         $returnedFileUrl = $bucket->getFileUrl($testFileName);
         $this->assertTrue(!empty($returnedFileUrl), 'File URL is empty!');
+        $this->assertContains(urlencode('site/download'), $returnedFileUrl, 'File URL does not contain route!');
+        $this->assertContains($bucket->getName(), $returnedFileUrl, 'File URL does not contain bucket name!');
+        $this->assertContains($testFileName, $returnedFileUrl, 'File URL does not contain filename!');
     }
 
     /**