| Trees | Index | Help |
|
|---|
| Package OFS :: Module Traversable :: Class Traversable |
|
Item,
ObjectManager,
ZItem,
ZItem,
ZopePageTemplate| Method Summary | |
|---|---|
Return the absolute URL of the object. | |
Return the path portion of the absolute URL of the object. | |
Get the physical path of the object. | |
restrictedTraverse(self,
path,
default)
| |
Lookup an object by path. | |
Return a URL for the object, relative to the site root. | |
| Class Variable Summary | |
|---|---|
Implements |
__implemented__ = <implementedBy OFS.Traversable.Travers...
|
ClassProvides |
__providedBy__ = <zope.interface.declarations.ClassProvi...
|
ClassProvides |
__provides__ = <zope.interface.declarations.ClassProvide...
|
NoneType |
absolute_url__roles__ = None |
NoneType |
absolute_url_path__roles__ = None |
NoneType |
getPhysicalPath__roles__ = None |
str |
getPhysicalRoot = '<Special Object Used to Force Acquisi...
|
tuple |
getPhysicalRoot__roles__ = ()
|
NoneType |
restrictedTraverse__roles__ = None |
tuple |
unrestrictedTraverse__roles__ = ()
|
NoneType |
virtual_url_path__roles__ = None |
| Method Details |
|---|
absolute_url(self, relative=0)Return the absolute URL of the object. This a canonical URL based on the object's physical containment path. It is affected by the virtual host configuration, if any, and can be used by external agents, such as a browser, to address the object. If the relative argument is provided, with a true value, then the value of virtual_url_path() is returned. Some Products incorrectly use '/'+absolute_url(1) as an absolute-path reference. This breaks in certain virtual hosting situations, and should be changed to use absolute_url_path() instead. |
absolute_url_path(self)Return the path portion of the absolute URL of the object. This includes the leading slash, and can be used as an 'absolute-path reference' as defined in RFC 2396. |
getPhysicalPath(self)Get the physical path of the object. Returns a path (an immutable sequence of strings) that can be used to access this object again later, for example in a copy/paste operation. getPhysicalRoot() and getPhysicalPath() are designed to operate together. |
unrestrictedTraverse(self, path, default=<object object at 0x41498>, restricted=0)Lookup an object by path. path -- The path to the object. May be a sequence of strings or a slash separated string. If the path begins with an empty path element (i.e., an empty string or a slash) then the lookup is performed from the application root. Otherwise, the lookup is relative to self. Two dots (..) as a path element indicates an upward traversal to the acquisition parent. default -- If provided, this is the value returned if the path cannot be traversed for any reason (i.e., no object exists at that path or the object is inaccessible). restricted -- If false (default) then no security checking is performed. If true, then all of the objects along the path are validated with the security machinery. Usually invoked using restrictedTraverse(). |
virtual_url_path(self)Return a URL for the object, relative to the site root. If a virtual host is configured, the URL is a path relative to the virtual host's root object. Otherwise, it is the physical path. In either case, the URL does not begin with a slash. |
| Class Variable Details |
|---|
__implemented__
|
__providedBy__
|
__provides__
|
absolute_url__roles__
|
absolute_url_path__roles__
|
getPhysicalPath__roles__
|
getPhysicalRoot
|
getPhysicalRoot__roles__
|
restrictedTraverse__roles__
|
unrestrictedTraverse__roles__
|
virtual_url_path__roles__
|
| Trees | Index | Help |
|
|---|
| Generated by Epydoc 2.1 on Thu Aug 16 09:55:11 2007 | http://epydoc.sf.net |