[CMF-checkins] CVS: CMF/CMFCore/interfaces - portal_url.py:1.2

[Yvo Schubbe]

Update of /cvs-repository/CMF/CMFCore/interfaces
In directory cvs.zope.org:/tmp/cvs-serv7076/CMFCore/interfaces

Added Files:
	portal_url.py 
Log Message:
Merged yuppie-collector067-branch:

- Moved URLTool to CMFCore. (Collector #67)


=== CMF/CMFCore/interfaces/portal_url.py 1.1 => 1.2 ===
--- /dev/null	Wed Dec 11 17:21:50 2002
+++ CMF/CMFCore/interfaces/portal_url.py	Wed Dec 11 17:21:49 2002
@@ -0,0 +1,87 @@
+##############################################################################
+#
+# Copyright (c) 2001 Zope Corporation and Contributors. All Rights Reserved.
+# 
+# This software is subject to the provisions of the Zope Public License,
+# Version 2.0 (ZPL).  A copy of the ZPL should accompany this distribution.
+# THIS SOFTWARE IS PROVIDED "AS IS" AND ANY AND ALL EXPRESS OR IMPLIED
+# WARRANTIES ARE DISCLAIMED, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
+# WARRANTIES OF TITLE, MERCHANTABILITY, AGAINST INFRINGEMENT, AND FITNESS
+# FOR A PARTICULAR PURPOSE
+# 
+##############################################################################
+""" URL tool interface description.
+
+$Id$
+"""
+
+from Interface import Attribute
+try:
+    from Interface import Interface
+except ImportError:
+    # for Zope versions before 2.6.0
+    from Interface import Base as Interface
+
+
+class portal_url(Interface):
+    """ CMF URL Tool interface.
+
+    This interface provides a common mechanism for finding the 'root'
+    object of a CMFSite, and for computing paths to objects relative to
+    that root.
+    """
+    id = Attribute('id', 'Must be set to "portal_url"')
+
+    def __call__(relative=0, *args, **kw):
+        """ Get by default the absolute URL of the portal.
+
+        Permission -- Always available
+
+        Returns -- Slash-separated string
+        """
+
+    def getPortalObject():
+        """ Get the portal object itself.
+
+        Permission -- Always available
+
+        Returns -- CMFSite object
+        """
+
+    def getRelativeContentPath(content):
+        """ Get the path for an object, relative to the portal root.
+
+        Permission -- Always available
+
+        Returns -- Tuple of IDs
+        """
+
+    def getRelativeContentURL(content):
+        """ Get the URL for an object, relative to the portal root.
+
+        This is helpful for virtual hosting situations.
+        Same method as 'getRelativeURL()'
+
+        Permission -- Always available
+
+        Returns -- Slash-separated string
+        """
+
+    def getRelativeUrl(content):
+        """ Get the URL for an object, relative to the portal root.
+
+        This is helpful for virtual hosting situations.
+        Same method as 'getRelativeContentURL()'
+
+        Permission -- Always available
+
+        Returns -- Slash-separated string
+        """
+
+    def getPortalPath():
+        """ Get the portal object's URL without the server URL component.
+
+        Permission -- Always available
+
+        Returns -- Slash-separated string
+        """