Back to index

plone3  3.1.7
Public Member Functions | Static Public Attributes
CMFCore.interfaces._tools.IURLTool Class Reference
Inheritance diagram for CMFCore.interfaces._tools.IURLTool:
Inheritance graph
[legend]
Collaboration diagram for CMFCore.interfaces._tools.IURLTool:
Collaboration graph
[legend]

List of all members.

Public Member Functions

def __call__
def getPortalObject
def getRelativeContentPath
def getRelativeContentURL
def getRelativeUrl
def getPortalPath

Static Public Attributes

tuple id

Detailed Description

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.

Definition at line 1524 of file _tools.py.


Member Function Documentation

def CMFCore.interfaces._tools.IURLTool.__call__ (   relative = 0,
  args,
  kw 
)
Return URL of the site, as a string.

o If 'relative' is True, return only the "path" portion of the site
  object's URL; otherwise, return the absolute URL

o In either case, the returned path respects virtual hosting.

o The site is the parent of the tool.

o Permission:  Public

Definition at line 1540 of file _tools.py.

01540 
01541     def __call__(relative=0, *args, **kw):
01542         """ Return URL of the site, as a string.
01543 
01544         o If 'relative' is True, return only the "path" portion of the site
01545           object's URL; otherwise, return the absolute URL
01546 
01547         o In either case, the returned path respects virtual hosting.
01548 
01549         o The site is the parent of the tool.
01550 
01551         o Permission:  Public
01552         """

Here is the caller graph for this function:

Return the site object itself.

o The site is the parent of the tool.

o Permission:  Public

Definition at line 1553 of file _tools.py.

01553 
01554     def getPortalObject():
01555         """ Return the site object itself.
01556 
01557         o The site is the parent of the tool.
01558 
01559         o Permission:  Public
01560         """

Here is the caller graph for this function:

Return the portal object's URL without the server URL component.

o Return a slash-delimited string.

o Permission:  Public

Definition at line 1595 of file _tools.py.

01595 
01596     def getPortalPath():
01597         """ Return the portal object's URL without the server URL component.
01598 
01599         o Return a slash-delimited string.
01600 
01601         o Permission:  Public
01602         """
01603 
01604 
01605 #
01606 #   Workflow tool interfaces
#
Return the site-relative path for 'content'

o The site is the parent of the tool.

o Return a sequence of path elements.

o Permission:  Public

Definition at line 1561 of file _tools.py.

01561 
01562     def getRelativeContentPath(content):
01563         """ Return the site-relative path for 'content'
01564 
01565         o The site is the parent of the tool.
01566 
01567         o Return a sequence of path elements.
01568 
01569         o Permission:  Public
01570         """

Here is the caller graph for this function:

Return the site-relative URL for 'content', as a string.

o The site is the parent of the tool.

o This is helpful for virtual hosting situations.

o Same method as 'getRelativeURL()'

o Permission:  Public

Definition at line 1571 of file _tools.py.

01571 
01572     def getRelativeContentURL(content):
01573         """ Return the site-relative URL for 'content', as a string.
01574 
01575         o The site is the parent of the tool.
01576 
01577         o This is helpful for virtual hosting situations.
01578 
01579         o Same method as 'getRelativeURL()'
01580 
01581         o Permission:  Public
01582         """

Return the site-relative URL for 'content', as a string.

o The site is the parent of the tool.

o This is helpful for virtual hosting situations.

o Same method as 'getRelativeContentURL()'

o Permission:  Public

Definition at line 1583 of file _tools.py.

01583 
01584     def getRelativeUrl(content):
01585         """ Return the site-relative URL for 'content', as a string.
01586 
01587         o The site is the parent of the tool.
01588 
01589         o This is helpful for virtual hosting situations.
01590 
01591         o Same method as 'getRelativeContentURL()'
01592 
01593         o Permission:  Public
01594         """


Member Data Documentation

Initial value:
Attribute('id',
            """ The ID of the tool.o Must be set to "portal_url"""",
            )
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.

Definition at line 1533 of file _tools.py.


The documentation for this class was generated from the following file: