diff options
| author | xue <> | 2005-11-13 15:10:37 +0000 |
|---|---|---|
| committer | xue <> | 2005-11-13 15:10:37 +0000 |
| commit | 710ccff78974957d31eedc054b90178f8e133afa (patch) | |
| tree | 164182148d867e813484e9fc11c05326d330fd07 /framework/Web/TAssetManager.php | |
| parent | 978183c26c4c9ffc629aff05d81c69eadd04b156 (diff) | |
Added complete comments.
Diffstat (limited to 'framework/Web/TAssetManager.php')
| -rw-r--r-- | framework/Web/TAssetManager.php | 75 |
1 files changed, 75 insertions, 0 deletions
diff --git a/framework/Web/TAssetManager.php b/framework/Web/TAssetManager.php index 5cc72f16..4bc52eed 100644 --- a/framework/Web/TAssetManager.php +++ b/framework/Web/TAssetManager.php @@ -1,14 +1,60 @@ <?php
+/**
+ * TAssetManager class
+ *
+ * @author Qiang Xue <qiang.xue@gmail.com>
+ * @link http://www.pradosoft.com/
+ * @copyright Copyright © 2005 PradoSoft
+ * @license http://www.pradosoft.com/license/
+ * @version $Revision: $ $Date: $
+ * @package System.Web
+ */
+/**
+ * TAssetManager class
+ *
+ * TAssetManager provides a scheme to allow web clients visiting
+ * private files that are normally web-inaccessible.
+ *
+ * TAssetManager will copy the file to be published into a web-accessible
+ * directory. The default base directory for storing the file is "assets", which
+ * should be under the application directory. This can be changed by setting
+ * the BasePath property together with the BaseUrl property that refers to
+ * the URL for accessing the base path.
+ *
+ * By default, TAssetManager will not publish a file or directory if it already
+ * exists in the publishing directory. You may require a timestamp checking by
+ * setting CheckTimestamp to true (which is false by default). You may also require
+ * so when calling {@link publishFile} or {@link publishDirectory). This is usually
+ * very useful during development. In production sites, the timestamp checking
+ * should be turned off to improve performance.
+ *
+ * @author Qiang Xue <qiang.xue@gmail.com>
+ * @version $Revision: $ $Date: $
+ * @package System.Web
+ * @since 3.0
+ */
class TAssetManager extends TComponent implements IModule
{
+ /**
+ * Default web accessible base path for storing private files
+ */
const DEFAULT_BASEPATH='assets';
+ /**
+ * @var string base web accessible path for storing private files
+ */
private $_basePath=null;
+ /**
+ * @var string base URL for accessing the publishing directory.
+ */
private $_baseUrl=null;
/**
* @var string module ID
*/
private $_id;
+ /**
+ * @var boolean whether to use timestamp checking to ensure files are published with up-to-date versions.
+ */
private $_checkTimestamp=false;
/**
@@ -85,11 +131,17 @@ class TAssetManager extends TComponent implements IModule $this->_baseUrl=$value;
}
+ /**
+ * @return boolean whether file modify time should be used to ensure a published file is latest. Defaults to false.
+ */
public function getCheckTimestamp()
{
return $this->_checkTimestamp;
}
+ /**
+ * @param boolean whether file modify time should be used to ensure a published file is latest. Defaults to false.
+ */
public function setCheckTimestamp($value)
{
if($this->_initialized)
@@ -98,6 +150,14 @@ class TAssetManager extends TComponent implements IModule $this->_checkTimestamp=TPropertyValue::ensureBoolean($value);
}
+ /**
+ * Publishes a directory (recursively).
+ * This method will copy the content in a directory (recursively) to
+ * a web accessible directory and returns the URL for the directory.
+ * @param string the path to be published
+ * @param boolean whether to use file modify time to ensure every published file is latest
+ * @return string an absolute URL to the published directory
+ */
public function publishDirectory($path,$checkTimestamp=false)
{
if(($fullpath=realpath($path))!==false && is_dir($fullpath))
@@ -111,6 +171,13 @@ class TAssetManager extends TComponent implements IModule throw new TInvalidDataValueException('assetmanager_directory_invalid',$path);
}
+ /**
+ * Copies a directory recursively as another.
+ * If the destination directory does not exist, it will be created.
+ * File modification time is used to ensure the copied files are latest.
+ * @param string the source directory
+ * @param string the destination directory
+ */
protected function copyDirectory($src,$dst)
{
@mkdir($dst);
@@ -130,6 +197,14 @@ class TAssetManager extends TComponent implements IModule closedir($folder);
}
+ /**
+ * Publishes a file.
+ * This method will copy a file to a web accessible directory and
+ * returns the URL for the file.
+ * @param string the file to be published
+ * @param boolean whether to use file modify time to ensure the published file is latest
+ * @return string an absolute URL to the published file
+ */
public function publishFile($path,$checkTimestamp=false)
{
if(($fullpath=realpath($path))!==false && is_file($fullpath))
|