Back to index

plone3  3.1.7
Public Member Functions
plone.app.redirector.interfaces.IRedirectionStorage Class Reference
Inheritance diagram for plone.app.redirector.interfaces.IRedirectionStorage:
Inheritance graph
[legend]
Collaboration diagram for plone.app.redirector.interfaces.IRedirectionStorage:
Collaboration graph
[legend]

List of all members.

Public Member Functions

def add
def remove
def destroy
def has_path
def get
def redirects
def __iter__

Detailed Description

A storage for items where the old and the new location are known.

Will be registered as a local utility.

Definition at line 39 of file interfaces.py.


Member Function Documentation

Iterate over all existing paths.

Definition at line 79 of file interfaces.py.

00079 
00080     def __iter__():
00081         """Iterate over all existing paths."""

Here is the caller graph for this function:

def plone.app.redirector.interfaces.IRedirectionStorage.add (   old_path,
  new_path 
)
A storage for items where the old and the new location are known.

Will be registered as a local utility.
Remember that the object at old_path is now at new_path.

Any redirects that already pointed at old_path will now point to
new_path as well.

Definition at line 45 of file interfaces.py.

00045 
00046     def add(old_path, new_path):
00047         """Remember that the object at old_path is now at new_path.
00048 
00049         Any redirects that already pointed at old_path will now point to
00050         new_path as well.
00051         """

Here is the caller graph for this function:

Forget all redirects to new_path.

Normally called if the object at new_path is removed

Definition at line 56 of file interfaces.py.

00056 
00057     def destroy(new_path):
00058         """Forget all redirects to new_path.
00059 
00060         Normally called if the object at new_path is removed
00061         """

def plone.app.redirector.interfaces.IRedirectionStorage.get (   old_path,
  default = None 
)
Get the new path to the object that used to be at old_path.

Will return the default value (None, unless set otherwise) if old_path
is not found.

Definition at line 66 of file interfaces.py.

00066 
00067     def get(old_path, default=None):
00068         """Get the new path to the object that used to be at old_path.
00069 
00070         Will return the default value (None, unless set otherwise) if old_path
00071         is not found.
00072         """

Determine if there are any redirects from old_path in effect.

Definition at line 62 of file interfaces.py.

00062 
00063     def has_path(old_path):
00064         """Determine if there are any redirects from old_path in effect.
00065         """

Get a list of paths that redirect to new_path.

Will return an empty list if nothing redirects to new_path.

Definition at line 73 of file interfaces.py.

00073 
00074     def redirects(new_path):
00075         """Get a list of paths that redirect to new_path.
00076 
00077         Will return an empty list if nothing redirects to new_path.
00078         """

Here is the caller graph for this function:

Forget all redirects from old_path to any new path

Definition at line 52 of file interfaces.py.

00052 
00053     def remove(old_path):
00054         """Forget all redirects from old_path to any new path
00055         """

Here is the caller graph for this function:


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