From 7b38480de52c1d042ea542e2d06913a8c9b645fc Mon Sep 17 00:00:00 2001
From: xue <>
Date: Fri, 17 Feb 2006 05:19:25 +0000
Subject: Add TApplicationComponent class and adjusted the relevant classes.

---
 framework/TApplicationComponent.php | 111 ++++++++++++++++++++++++++++++++++++
 1 file changed, 111 insertions(+)
 create mode 100644 framework/TApplicationComponent.php

(limited to 'framework/TApplicationComponent.php')

diff --git a/framework/TApplicationComponent.php b/framework/TApplicationComponent.php
new file mode 100644
index 00000000..580f1d33
--- /dev/null
+++ b/framework/TApplicationComponent.php
@@ -0,0 +1,111 @@
+<?php
+/**
+ * TApplicationComponent class
+ *
+ * @author Qiang Xue <qiang.xue@gmail.com>
+ * @link http://www.pradosoft.com/
+ * @copyright Copyright &copy; 2005 PradoSoft
+ * @license http://www.pradosoft.com/license/
+ * @version $Revision: $  $Date: $
+ * @package System
+ */
+
+/**
+ * TApplicationComponent class
+ *
+ * TApplicationComponent is the base class for all components that are
+ * application-related, such as controls, modules, services, etc.
+ *
+ * TApplicationComponent mainly defines a few properties that are shortcuts
+ * to some commonly used methods. The {@link getApplication Application}
+ * property gives the application instance that this component belongs to;
+ * {@link getService Service} gives the current running service;
+ * {@link getRequest Request}, {@link getResponse Response} and {@link getSession Session}
+ * return the request and response modules, respectively;
+ * And {@link getUser User} gives the current user instance.
+ *
+ * Besides, TApplicationComponent defines two shortcut methods for
+ * publishing private files: {@link publishAsset} and {@link publishFilePath}.
+ *
+ * @author Qiang Xue <qiang.xue@gmail.com>
+ * @version $Revision: $  $Date: $
+ * @package System
+ * @since 3.0
+ */
+class TApplicationComponent extends TComponent
+{
+	/**
+	 * @return TApplication current application instance
+	 */
+	public function getApplication()
+	{
+		return Prado::getApplication();
+	}
+
+	/**
+	 * @return IService the current service
+	 */
+	public function getService()
+	{
+		return Prado::getApplication()->getService();
+	}
+
+	/**
+	 * @return THttpRequest the current user request
+	 */
+	public function getRequest()
+	{
+		return Prado::getApplication()->getRequest();
+	}
+
+	/**
+	 * @return THttpResponse the response
+	 */
+	public function getResponse()
+	{
+		return Prado::getApplication()->getResponse();
+	}
+
+	/**
+	 * @return THttpSession user session
+	 */
+	public function getSession()
+	{
+		return Prado::getApplication()->getSession();
+	}
+
+	/**
+	 * @return IUser user
+	 */
+	public function getUser()
+	{
+		return Prado::getApplication()->getUser();
+	}
+
+	/**
+	 * Publishes a private asset and gets its URL.
+	 * This method will publish a private asset (file or directory)
+	 * and gets the URL to the asset. Note, if the asset refers to
+	 * a directory, all contents under that directory will be published.
+	 * @param string path of the asset that is relative to the directory containing the control class file.
+	 * @return string URL to the asset path.
+	 */
+	public function publishAsset($assetPath)
+	{
+		$class=new ReflectionClass(get_class($this));
+		$fullPath=dirname($class->getFileName()).'/'.$assetPath;
+		return $this->publishFilePath($fullPath);
+	}
+
+	/**
+	 * Publishes a file or directory and returns its URL.
+	 * @param string absolute path of the file or directory to be published
+	 * @return string URL to the published file or directory
+	 */
+	public function publishFilePath($fullPath)
+	{
+		return Prado::getApplication()->getAssetManager()->publishFilePath($fullPath);
+	}
+}
+
+?>
\ No newline at end of file
-- 
cgit v1.2.3