CMFCore.FSDTMLMethod.FSDTMLMethod

Package CMFCore :: Module FSDTMLMethod :: Class FSDTMLMethod

[show private | hide private]

Type FSDTMLMethod

              Cacheable --+    
                          |    
         object --+       |    
                  |       |    
               Base --+   |    
                      |   |    
     object --+       |   |    
              |       |   |    
           Base --+   |   |    
                  |   |   |    
         CopySource --+   |    
                      |   |    
           Node --+   |   |    
                  |   |   |    
            Element --+   |    
                      |   |    
     object --+       |   |    
              |       |   |    
           Base --+   |   |    
                  |   |   |    
              Owned --+   |    
                      |   |    
     object --+       |   |    
              |       |   |    
           Base --+   |   |    
                  |   |   |    
EtagSupport --+   |   |   |    
              |   |   |   |    
   LockableItem --+   |   |    
                  |   |   |    
           Resource --+   |    
                      |   |    
     object --+       |   |    
              |       |   |    
           Base --+   |   |    
                  |   |   |    
               Tabs --+   |    
                      |   |    
        Traversable --+   |    
                      |   |    
     object --+       |   |    
              |       |   |    
           Base --+   |   |    
                  |   |   |    
        UndoSupport --+   |    
                      |   |    
                   Item --+    
                          |    
         object --+       |    
                  |       |    
               Base --+   |    
                      |   |    
        RoleManager --+   |    
                      |   |    
            RoleManager --+    
                          |    
         object --+       |    
                  |       |    
               Base --+   |    
                      |   |    
               Acquirer --+    
                          |    
                   FSObject --+
                              |
             String --+       |
                      |       |
                   HTML --+   |
                          |   |
         object --+       |   |
                  |       |   |
               Base --+   |   |
                      |   |   |
         object --+   |   |   |
                  |   |   |   |
         Persistent --+   |   |
                      |   |   |
             Persistent --+   |
                          |   |
                       HTML --+
                              |
         RestrictedDTML --+   |
                          |   |
         object --+       |   |
                  |       |   |
               Base --+   |   |
                      |   |   |
    RestrictedDTMLMixin --+   |
                          |   |
             RestrictedDTML --+
                              |
             object --+       |
                      |       |
                   Base --+   |
                          |   |
            RoleManager --+   |
                          |   |
                RoleManager --+
                              |
                             FSDTMLMethod

FSDTMLMethods act like DTML methods but are not directly modifiable from the management interface.

Method Summary
	`__init__(self, id, filepath, fullname, properties)`
	`__call__(self, client, REQUEST, RESPONSE, **kw)` Render the document given a client object, REQUEST mapping, Response, and key word arguments.
	`document_src(self, REQUEST, RESPONSE)` Return unprocessed document source.
	`getCacheNamespaceKeys(self)` Returns the cacheNamespaceKeys.
	`manage_FTPget(self)` Get source for FTP download
	`manage_haveProxy(self, r)`
	`PrincipiaSearchSource(self)` Support for searching - the document's contents are searched.
	`read_raw(self)`
	`setCacheNamespaceKeys(self, keys, REQUEST)` Sets the list of names that should be looked up in the namespace to provide a cache key.
	`validate(self, inst, parent, name, value, md)`
	`_createZODBClone(self)` Create a ZODB (editable) equivalent of this object.
	`_readFile(self, reparse)` Read the data from the filesystem.
Inherited from RestrictedDTMLMixin
	`__new__(T, S, ...)` T.__new__(S, ...) -> a new object with type S, a subtype of T
Inherited from RoleManager
	`ac_inherited_permissions(self, all)`
	`access_debug_info(self)` Return debug info.
	`acquiredRolesAreUsedBy(self, permission)` Used by management screen.
	`get_local_roles(self)`
	`get_local_roles_for_userid(self, userid)`
	`get_valid_userids(self)`
	`has_local_roles(self)`
	`manage_access(self, REQUEST, **kw)` Return an interface for making permissions settings.
	`manage_acquiredPermissions(self, permissions, REQUEST)` Change the permissions that acquire.
	`manage_addLocalRoles(self, userid, roles, REQUEST)` Set local roles for a user.
	`manage_changePermissions(self, REQUEST)` Change all permissions settings, called by management screen.
	`manage_defined_roles(self, submit, REQUEST)` Called by management screen.
	`manage_delLocalRoles(self, userids, REQUEST)` Remove all local roles for a user.
	`manage_editRoles(self, REQUEST, acl_type, acl_roles)`
	`manage_permission(self, permission_to_manage, roles, acquire, REQUEST)` Change the settings for the given permission.
	`manage_role(self, role_to_manage, permissions, REQUEST)` Change the permissions given to the given role.
	`manage_setLocalRoles(self, userid, roles, REQUEST)` Set local roles for a user.
	`permission_settings(self, permission)` Return user-role permission settings.
	`permissionsOfRole(self, role)` Used by management screen.
	`possible_permissions(self)`
	`rolesOfPermission(self, permission)` Used by management screen.
	`userdefined_roles(self)` Return list of user-defined roles.
	`users_with_local_role(self, role)`
	`valid_roles(self)` Return list of valid roles.
	`validate_roles(self, roles)` Return true if all given roles are valid.
	`validRoles(self)` Return list of valid roles.
	`_addRole(self, role, REQUEST)`
	`_delRoles(self, roles, REQUEST)`
	`_has_user_defined_role(self, role)`
	`_setRoles(self, acl_type, acl_roles)`
Inherited from RoleManager
	`manage_getPermissionMapping(self)` Return the permission mapping for the object This is a list of dictionaries with: permission_name -- The name of the native object permission class_permission -- The class permission the permission is mapped to.
	`manage_setPermissionMapping(self, permission_names, class_permissions, REQUEST)` Change the permission mapping
	`_isBeingAccessedAsZClassDefinedInstanceMethod(self)`
	`_isBeingUsedAsAMethod(self, REQUEST, wannaBe)`
Inherited from FSObject
	`get_size(self)` Get the size of the underlying file.
	`getModTime(self)` Return the last_modified date of the file we represent.
	`getObjectFSPath(self)` Return the path of the file we represent
	`manage_doCustomize(self, folder_path, RESPONSE)` Makes a ZODB Based clone with the same data.
	`_updateFromFS(self)`
Inherited from Acquirer
	`__of__(context)` __of__(context) -- return the object in a context
Inherited from Item
	`__len__(self)`
	`__repr__(self)` Show the physical path of the object and its context if available.
	`analyseDocumentation(self, object, type, filter)`
	`getId(self)` Return the id of the object as a string.
	`manage(self, URL1)`
	`manage_afterAdd(self, item, container)`
	`manage_afterClone(self, item)`
	`manage_beforeDelete(self, item, container)`
	`manage_editedDialog(self, REQUEST, **args)`
	`manage_FTPlist(self, REQUEST)` Directory listing for FTP.
	`manage_FTPstat(self, REQUEST)` Psuedo stat, used by FTP for directory listings.
	`objectIds(self, spec)`
	`objectItems(self, spec)`
	`objectValues(self, spec)`
	`raise_standardErrorMessage(self, client, REQUEST, error_type, error_value, tb, error_tb, error_message, tagSearch, error_log_url)`
	`this(self)`
	`title_and_id(self)` Return the title if it is not blank and the id otherwise.
	`title_or_id(self)` Return the title if it is not blank and the id otherwise.
	`tpURL(self)`
	`tpValues(self)`
Inherited from Resource
	`COPY(self, REQUEST, RESPONSE)` Create a duplicate of the source resource whose state and behavior match that of the source resource as closely as possible.
	`dav__init(self, request, response)`
	`dav__simpleifhandler(self, request, response, method, col, url, refresh)`
	`dav__validate(self, object, methodname, REQUEST)`
	`DELETE(self, REQUEST, RESPONSE)` Delete a resource.
	`HEAD(self, REQUEST, RESPONSE)` Retrieve resource information without a response body.
	`listDAVObjects(self)`
	`LOCK(self, REQUEST, RESPONSE)` Lock a resource
	`manage_DAVget(self)` Gets the document source
	`MKCOL(self, REQUEST, RESPONSE)` Create a new collection resource.
	`MOVE(self, REQUEST, RESPONSE)` Move a resource to a new location.
	`OPTIONS(self, REQUEST, RESPONSE)` Retrieve communication options.
	`PROPFIND(self, REQUEST, RESPONSE)` Retrieve properties defined on the resource.
	`PROPPATCH(self, REQUEST, RESPONSE)` Set and/or remove properties defined on the resource.
	`PUT(self, REQUEST, RESPONSE)` Replace the GET response entity of an existing resource.
	`TRACE(self, REQUEST, RESPONSE)` Return the HTTP message received back to the client as the entity-body of a 200 (OK) response.
	`UNLOCK(self, REQUEST, RESPONSE)` Remove an existing lock on a resource.
Inherited from LockableItem
	`wl_clearLocks(self)`
	`wl_delLock(self, locktoken)`
	`wl_getLock(self, locktoken)`
	`wl_hasLock(self, token, killinvalids)`
	`wl_isLocked(self)`
	`wl_lockItems(self, killinvalids)`
	`wl_lockmapping(self, killinvalids, create)` if 'killinvalids' is 1, locks who are no longer valid will be deleted
	`wl_lockTokens(self, killinvalids)`
	`wl_lockValues(self, killinvalids)`
	`wl_setLock(self, locktoken, lock)`
Inherited from EtagSupport
	`http__etag(self, readonly)`
	`http__parseMatchList(self, REQUEST, header)`
	`http__processMatchHeaders(self, REQUEST)`
	`http__refreshEtag(self)`
Inherited from CopySource
	`cb_isCopyable(self)`
	`cb_isMoveable(self)`
	`cb_userHasCopyOrMovePermission(self)`
	`_canCopy(self, op)` Called to make sure this object is copyable.
	`_getCopy(self, container)`
	`_notifyOfCopyTo(self, container, op)` Overide this to be pickly about where you go!
	`_postCopy(self, container, op)`
	`_setId(self, id)`
Inherited from Tabs
	`_old_filtered_manage_options(self, REQUEST)`
	`class_manage_path(self)`
	`filtered_manage_options(self, REQUEST)`
	`manage_workspace(self, REQUEST)` Dispatch to first interface in manage_options
	`tabs_path_default(self, REQUEST, unquote)`
	`tabs_path_info(self, script, path, quote)`
Inherited from Traversable
	`absolute_url(self, relative)` Return the absolute URL of the object.
	`absolute_url_path(self)` Return the path portion of the absolute URL of the object.
	`getPhysicalPath(self)` Get the physical path of the object.
	`restrictedTraverse(self, path, default)`
	`unrestrictedTraverse(self, path, default, restricted)` Lookup an object by path.
	`virtual_url_path(self)` Return a URL for the object, relative to the site root.
Inherited from Element
	`getAttribute(self, name)` Retrieves an attribute value by name.
	`getAttributeNode(self, name)` Retrieves an Attr node by name or None if there is no such attribute.
	`getChildNodes(self)` Returns a NodeList that contains all children of this node.
	`getElementsByTagName(self, tagname)` Returns a NodeList of all the Elements with a given tag name in the order in which they would be encountered in a preorder traversal of the Document tree.
	`getFirstChild(self)` The first child of this node.
	`getLastChild(self)` The last child of this node.
	`getNextSibling(self)` The node immediately preceding this node.
	`getNodeName(self)` The name of this node, depending on its type
	`getNodeType(self)` A code representing the type of the node.
	`getParentNode(self)` The parent of this node.
	`getPreviousSibling(self)` The node immediately preceding this node.
	`getTagName(self)` The name of the element
Inherited from Node
	`getAttributes(self)` Returns a NamedNodeMap containing the attributes of this node (if it is an element) or None otherwise.
	`getNodeValue(self)` The value of this node, depending on its type
	`getOwnerDocument(self)` The Document object associated with this node.
	`hasChildNodes(self)` Returns true if the node has any children, false if it doesn't.
Inherited from Owned
	`changeOwnership(self, user, recursive)` Change the ownership to the given user.
	`getOwner(self, info, aq_get, UnownableOwner, getSecurityManager)` Get the owner
	`getOwnerTuple(self)` Return a tuple, (userdb_path, user_id) for the owner.
	`getWrappedOwner(self)` Get the owner, modestly wrapped in the user folder.
	`manage_changeOwnershipType(self, explicit, RESPONSE, REQUEST)` Change the type (implicit or explicit) of ownership.
	`manage_fixupOwnershipAfterAdd(self)`
	`manage_takeOwnership(self, REQUEST, RESPONSE, recursive)` Take ownership (responsibility) for an object.
	`owner_info(self)` Get ownership info for display
	`userCanTakeOwnership(self)`
	`_deleteOwnershipAfterAdd(self)`
Inherited from UndoSupport
	`get_request_var_or_attr(self, name, default)`
	`manage_undo_transactions(self, transaction_info, REQUEST)`
	`undoable_transactions(self, first_transaction, last_transaction, PrincipiaUndoBatchSize)`
Inherited from Cacheable
	`ZCacheable_configHTML(self)` Override to provide configuration of caching behavior that can only be specific to the cacheable object.
	`ZCacheable_enabled(self)` Returns true if caching is enabled for this object or method.
	`ZCacheable_get(self, view_name, keywords, mtime_func, default)` Retrieves the cached view for the object under the conditions specified by keywords.
	`ZCacheable_getCache(self)` Gets the cache associated with this object.
	`ZCacheable_getManager(self)` Returns the currently associated cache manager.
	`ZCacheable_getManagerId(self)` Returns the id of the current ZCacheManager.
	`ZCacheable_getManagerIds(self)` Returns a list of mappings containing the id and title of the available ZCacheManagers.
	`ZCacheable_getManagerURL(self)` Returns the URL of the current ZCacheManager.
	`ZCacheable_getModTime(self, mtime_func)` Returns the highest of the last mod times.
	`ZCacheable_getObAndView(self, view_name)` If this object is a method of a ZClass and we're working with the primary view, uses the ZClass instance as ob and our own ID as the view_name.
	`ZCacheable_invalidate(self, view_name, REQUEST)` Called after a cacheable object is edited.
	`ZCacheable_isAMethod(self)` Returns 1 when this object is a ZClass method.
	`ZCacheable_isCachingEnabled(self)` Returns true only if associated with a cache manager and caching of this method is enabled.
	`ZCacheable_set(self, data, view_name, keywords, mtime_func)` Cacheable views should call this method after generating cacheable results.
	`ZCacheable_setEnabled(self, enabled, REQUEST)` Changes the enabled flag.
	`ZCacheable_setManagerId(self, manager_id, REQUEST)` Changes the manager_id for this object.
Inherited from HTML
	`__str__(self)`
	`errQuote(self, text, character_entities)`
	`manage_edit(self, data, REQUEST)` edit a template
	`manage_editDocument(self, URL1, REQUEST)` Display doc template editing form
	`manage_editForm(self, URL1, REQUEST)` Display doc template editing form
	`management_interface(self)` Hook to allow public execution of management interface with everything else private.
	`parseTag(self, match_ob, command, sargs)` Parse a tag using an already matched re Return: tag, args, command, coname where: tag is the tag, args is the tag's argument string, command is a corresponding command info structure if the tag is a start tag, or None otherwise, and coname is the name of a continue tag (e.g.
	`quotedHTML(self, text, character_entities)`
	`SubTemplate(self, name)`
	`tagre(self)`
	`varExtra(self, match_ob)`
Inherited from String
	`__getstate__(self, _special)`
	`cook(self, cooklock)`
	`default(self, name, **kw)` Change or query default values in a document template.
	`guarded_getattr(...)`
	`guarded_getitem(self, ob, index)`
	`initvars(self, globals, vars)`
	`munge(self, source_string, mapping, **vars)` Change the text or default values for a document template.
	`name(self)`
	`parse(self, text, start, result, tagre)`
	`parse_block(self, text, start, result, tagre, stag, sloc, sargs, scommand)`
	`parse_close(self, text, start, tagre, stag, sloc, scommand, sa)`
	`parse_error(self, mess, tag, text, start)`
	`read(self, raw)`
	`setName(self, v)`
	`skip_eol(self, text, start, eol)`
	`var(self, name, **kw)` Change or query a variable in a document template.
	`ZDocumentTemplate_afterRender(self, md, result)`
	`ZDocumentTemplate_beforeRender(self, md, default)`
	`_parseTag(self, match_ob, command, sargs, tt)`
Inherited from Persistent
	`__class_init__(self)`
	`__getattribute__(...)` x.__getattribute__('name') <==> x.name
	`bobobase_modification_time(self)`
	`locked_in_version(self)` Was the object modified in any version?
	`modified_in_version(self)` Was the object modified in this version?
Inherited from Persistent
	`__delattr__(...)` x.__delattr__('name') <==> del x.name
	`__reduce__(...)` Reduce an object to contituent parts for serialization
	`__setattr__(...)` x.__setattr__('name', value) <==> x.name = value
	`__setstate__(...)` Set the object serialization state The state should be in one of 3 forms: - None Ignored - A dictionary In this case, the object's instance dictionary will be cleared and updated with the new state.
	`_p_activate()` _p_activate() -- Activate the object
	`_p_deactivate()` _p_deactivate() -- Deactivate the object
	`_p_delattr(name)` This method should be called by subclass __delattr__ implementations before doing anything else.
	`_p_getattr(name)` The method unghostifies the object, if necessary.
	`_p_invalidate()` _p_invalidate() -- Invalidate the object
	`_p_setattr(name, value)` This method should be called by subclass __setattr__ implementations before doing anything else.
Inherited from Base
	`__getnewargs__(...)` Get arguments to be passed to __new__
Inherited from object
	`__hash__(x)` x.__hash__() <==> hash(x)
	`__reduce_ex__(...)` helper for pickle

Class Variable Summary
`tuple`	`__ac_permissions__` = `(('FTP access', ('manage_FTPget',))...`
`PermissionRole`	`__roles__` = `<PermissionRole object at 0xb58e61e8>`
`str`	`default_content_type` = `'text/html'`
`PermissionRole`	`document_src__roles__` = `<PermissionRole object at 0xb58e...`
`func_code`	`func_code` = `<OFS.DTMLMethod.func_code instance at 0xb734...`
`NoneType`	`index_html` = None
`PermissionRole`	`manage_FTPget__roles__` = `<PermissionRole object at 0xb58...`
`PermissionRole`	`manage_haveProxy__roles__` = `<PermissionRole object at 0x...`
`DTMLFile`	`manage_main` = `<App.special_dtml.DTMLFile object at 0xb58...`
`PermissionRole`	`manage_main__roles__` = `<PermissionRole object at 0xb58e6...`
`tuple`	`manage_options` = `({'action': 'manage_main', 'label': 'Cu...`
`str`	`meta_type` = `'Filesystem DTML Method'`
`PermissionRole`	`PrincipiaSearchSource__roles__` = `<PermissionRole object ...`
`tuple`	`read_raw__roles__` = `()`
`tuple`	`_cache_namespace_keys` = `()`
`tuple`	`_proxy_roles` = `()`
`int`	`_reading` = 0
Inherited from RoleManager
`NoneType`	`__ac_local_roles__` = None
`tuple`	`__ac_roles__` = `('Manager', 'Owner', 'Anonymous', 'Authen...`
`Implements`	`__implemented__` = `<implementedBy AccessControl.Role.Role...`
`ClassProvides`	`__provides__` = `<zope.interface.declarations.ClassProvide...`
`PermissionRole`	`ac_inherited_permissions__roles__` = `<PermissionRole obje...`
`tuple`	`access_debug_info__roles__` = `()`
`str`	`aclAChecked` = `''`
`str`	`aclEChecked` = `''`
`str`	`aclPChecked` = `''`
`PermissionRole`	`acquiredRolesAreUsedBy__roles__` = `<PermissionRole object...`
`PermissionRole`	`manage_access__roles__` = `<PermissionRole object at 0xb75...`
`DTMLFile`	`manage_acquiredForm` = `<App.special_dtml.DTMLFile object ...`
`PermissionRole`	`manage_acquiredForm__roles__` = `<PermissionRole object at...`
`PermissionRole`	`manage_acquiredPermissions__roles__` = `<PermissionRole ob...`
`PermissionRole`	`manage_addLocalRoles__roles__` = `<PermissionRole object a...`
`PermissionRole`	`manage_changePermissions__roles__` = `<PermissionRole obje...`
`PermissionRole`	`manage_defined_roles__roles__` = `<PermissionRole object a...`
`PermissionRole`	`manage_delLocalRoles__roles__` = `<PermissionRole object a...`
`DTMLFile`	`manage_editLocalRoles` = `<App.special_dtml.DTMLFile objec...`
`PermissionRole`	`manage_editLocalRoles__roles__` = `<PermissionRole object ...`
`tuple`	`manage_editRoles__roles__` = `('Manager',)`
`DTMLFile`	`manage_listLocalRoles` = `<App.special_dtml.DTMLFile objec...`
`PermissionRole`	`manage_listLocalRoles__roles__` = `<PermissionRole object ...`
`PermissionRole`	`manage_permission__roles__` = `<PermissionRole object at 0...`
`DTMLFile`	`manage_permissionForm` = `<App.special_dtml.DTMLFile objec...`
`PermissionRole`	`manage_permissionForm__roles__` = `<PermissionRole object ...`
`PermissionRole`	`manage_role__roles__` = `<PermissionRole object at 0xb7558...`
`DTMLFile`	`manage_roleForm` = `<App.special_dtml.DTMLFile object at 0...`
`PermissionRole`	`manage_roleForm__roles__` = `<PermissionRole object at 0xb...`
`PermissionRole`	`manage_setLocalRoles__roles__` = `<PermissionRole object a...`
`PermissionRole`	`permission_settings__roles__` = `<PermissionRole object at...`
`str`	`permissionMappingPossibleValues` = `'<Special Object Used ...`
`PermissionRole`	`permissionsOfRole__roles__` = `<PermissionRole object at 0...`
`PermissionRole`	`rolesOfPermission__roles__` = `<PermissionRole object at 0...`
`str`	`selectedRoles` = `''`
`str`	`smallRolesWidget` = `''`
`PermissionRole`	`userdefined_roles__roles__` = `<PermissionRole object at 0...`
`DTMLFile`	`_method_manage_access` = `<App.special_dtml.DTMLFile objec...`
`DTMLFile`	`_normal_manage_access` = `<App.special_dtml.DTMLFile objec...`
Inherited from RoleManager
`ClassProvides`	`__providedBy__` = `<zope.interface.declarations.ClassProvi...`
`tuple`	`manage_getPermissionMapping__roles__` = `('Manager',)`
`tuple`	`manage_setPermissionMapping__roles__` = `('Manager',)`
Inherited from FSObject
`PermissionRole`	`get_size__roles__` = `<PermissionRole object at 0xb59376f8...`
`PermissionRole`	`getModTime__roles__` = `<PermissionRole object at 0xb59376...`
`PermissionRole`	`getObjectFSPath__roles__` = `<PermissionRole object at 0xb...`
`PermissionRole`	`manage_doCustomize__roles__` = `<PermissionRole object at ...`
`str`	`title` = `''`
`int`	`_file_mod_time` = 0
`int`	`_parsed` = 0
Inherited from Item
`int`	`__allow_access_to_unprotected_subobjects__` = 1
`str`	`__name__` = `'Item'`
`tuple`	`__propsets__` = `()`
`PermissionRole`	`analyseDocumentation__roles__` = `<PermissionRole object a...`
`NoneType`	`getId__roles__` = None
`str`	`icon` = `''`