Back to index

plone3  3.1.7
Public Member Functions | Static Public Attributes
CMFQuickInstallerTool.interfaces.portal_quickinstaller.IQuickInstallerTool Class Reference
Inheritance diagram for CMFQuickInstallerTool.interfaces.portal_quickinstaller.IQuickInstallerTool:
Inheritance graph
[legend]
Collaboration diagram for CMFQuickInstallerTool.interfaces.portal_quickinstaller.IQuickInstallerTool:
Collaboration graph
[legend]

List of all members.

Public Member Functions

def listInstallableProducts
def listInstalledProducts
def isProductInstallable
def isProductAvailable
def installProduct
def installProducts
def getProductFile
def getProductReadme
def getProductVersion
def isProductInstalled
def notifyInstalled
def uninstallProducts
def reinstallProducts

Static Public Attributes

tuple id = Attribute('id', 'Must be set to "portal_quickinstaller"')

Detailed Description

the QuickInstaller Tool
    contains 'InstalledProduct' instances

Definition at line 3 of file portal_quickinstaller.py.


Member Function Documentation

returns the content of a file of the product case-insensitive, if it
     does not exist -> None 

Definition at line 37 of file portal_quickinstaller.py.

00037 
00038     def getProductFile(p,fname='readme.txt'):
00039         ''' returns the content of a file of the product case-insensitive, if it
00040              does not exist -> None '''

Here is the caller graph for this function:

returns the readme file of the product case-insensitive 

Definition at line 41 of file portal_quickinstaller.py.

00041 
00042     def getProductReadme(p):
00043         ''' returns the readme file of the product case-insensitive '''

returns the version string stored in version.txt

Definition at line 44 of file portal_quickinstaller.py.

00044 
00045     def getProductVersion(p):
00046         ''' returns the version string stored in version.txt'''

Here is the caller graph for this function:

def CMFQuickInstallerTool.interfaces.portal_quickinstaller.IQuickInstallerTool.installProduct (   p,
  locked = False,
  hidden = False,
  swallowExceptions = False,
  forceProfile = False 
)
installs a product by name
    throws AlreadyInstalled exception, if components of the product are
    already installed

    if swallowExceptions is true, exceptions are caught and logged

Definition at line 25 of file portal_quickinstaller.py.

00025 
00026                        swallowExceptions=False, forceProfile=False):
00027         ''' installs a product by name
00028             throws AlreadyInstalled exception, if components of the product are
00029             already installed
00030 
00031             if swallowExceptions is true, exceptions are caught and logged
00032         '''

Here is the call graph for this function:

Here is the caller graph for this function:

def CMFQuickInstallerTool.interfaces.portal_quickinstaller.IQuickInstallerTool.installProducts (   products = [],
  stoponerror = False,
  REQUEST = None,
  forceProfile = False 
)
installs the products specified in the products list

Definition at line 34 of file portal_quickinstaller.py.

00034 
00035                         forceProfile=False):
00036         ''' installs the products specified in the products list'''

Here is the caller graph for this function:

is the product directory present (to check if it has been deleted
    from the Filesystem 

Definition at line 20 of file portal_quickinstaller.py.

00020 
00021     def isProductAvailable(productname):
00022         ''' is the product directory present (to check if it has been deleted
00023             from the Filesystem '''

is the product directory present and ready for installation 

Definition at line 17 of file portal_quickinstaller.py.

00017 
00018     def isProductInstallable(productname):
00019         ''' is the product directory present and ready for installation '''

Here is the caller graph for this function:

checks wether a product is installed (by name) 

Definition at line 47 of file portal_quickinstaller.py.

00047 
00048     def isProductInstalled(productname):
00049         ''' checks wether a product is installed (by name) '''

Here is the caller graph for this function:

list candidate CMF products for installation -> list of dicts with
    keys:(id,hasError,status)

Definition at line 9 of file portal_quickinstaller.py.

00009 
00010     def listInstallableProducts(skipInstalled=True):
00011         ''' list candidate CMF products for installation -> list of dicts with
00012             keys:(id,hasError,status)'''

returns a list of products that are installed -> list of dicts with
    keys:(id,hasError,status,,isLocked,isHidden)

Definition at line 13 of file portal_quickinstaller.py.

00013 
00014     def listInstalledProducts(showHidden=False):
00015         ''' returns a list of products that are installed -> list of dicts with
00016             keys:(id,hasError,status,,isLocked,isHidden)'''

Here is the caller graph for this function:

def CMFQuickInstallerTool.interfaces.portal_quickinstaller.IQuickInstallerTool.notifyInstalled (   p,
  locked = True,
  hidden = False,
  kw 
)
marks a product that has been installed without QuickInstaller
 as installed
 if locked is set -> the prod cannot be uninstalled
 if hidden is set -> the prod is not listed in the UI
 the **kw param is passed to the constructor of InstalledProduct

Definition at line 50 of file portal_quickinstaller.py.

00050 
00051     def notifyInstalled(p,locked=True, hidden=False, **kw):
00052         ''' marks a product that has been installed without QuickInstaller
00053          as installed
00054          if locked is set -> the prod cannot be uninstalled
00055          if hidden is set -> the prod is not listed in the UI
00056          the **kw param is passed to the constructor of InstalledProduct
00057          '''

Here is the caller graph for this function:

reinstalls a list of products, the main difference to
    ininstall/reinstall is that it does not remove portal objects
    created  during install (e.g. tools, etc.)

Definition at line 63 of file portal_quickinstaller.py.

00063 
00064     def reinstallProducts( products, REQUEST=None):
00065         ''' reinstalls a list of products, the main difference to
00066             ininstall/reinstall is that it does not remove portal objects
00067             created  during install (e.g. tools, etc.)'''

def CMFQuickInstallerTool.interfaces.portal_quickinstaller.IQuickInstallerTool.uninstallProducts (   products,
  cascade = ['types',
  skins,
  actions,
  portalobjects,
  workflows,
  slots,
  registrypredicates,
  REQUEST = None 
)
removes a list of products, cascade defines which items created by
    the install shall be uninstalled 

Definition at line 59 of file portal_quickinstaller.py.

00059 
00060         'portalobjects','workflows','slots','registrypredicates'],REQUEST=None):
00061         ''' removes a list of products, cascade defines which items created by
00062             the install shall be uninstalled '''


Member Data Documentation

tuple CMFQuickInstallerTool.interfaces.portal_quickinstaller.IQuickInstallerTool.id = Attribute('id', 'Must be set to "portal_quickinstaller"') [static]

Definition at line 7 of file portal_quickinstaller.py.


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