zms.zms.ZMS

class documentation

class ZMS(ZMSCustom, _accessmanager.AccessManager, _builder.Builder, _confmanager.ConfManager, _objattrs.ObjAttrsManager, _zcatalogmanager.ZCatalogManager): (source)

Constructor: ZMS()

View In Hierarchy

Root ZMS content object that combines configuration, editing, and indexing.

Method	`__before_publishing_traverse__`	Maintenance mode can be set by adding the ZMS configuration key ZMS.mode.maintenance=1. The maintenance mode prevents editing content and returns an error: 503 Service Unavailable. To show a specific message the Zope object standard_error_message should be customized, e...
Method	`__init__`	Initialize the root object with the default content id.
Method	`getAbsoluteHome`	Return the home folder of the portal master or the local site.
Method	`getDCCoverage`	Return the Dublin Core coverage string for the primary language.
Method	`getDocumentElement`	Return the document element of the site tree.
Method	`getHome`	Return the folder that contains the document element.
Method	`getNewId`	Return a new unique object identifier.
Method	`getParentNode`	Return `None` because the site root has no parent node.
Method	`getPortalClients`	Return portal clients configured below the site home folder.
Method	`getPortalMaster`	Return the configured portal master, or `None` if absent.
Method	`getRootElement`	Return the topmost portal master in the current site hierarchy.
Method	`getTrashcan`	Return the site's trashcan object.
Method	`initZMS`	Delegate site initialization to the module-level helper.
Method	`manage_addMediaDb`	Add the media database helper object.
Method	`xmlOnStartElement`	Reset root-level import state before XML builder processing starts.
Method	`zms_version`	Return the product version string, optionally including custom metadata.
Class Variable	`__ac_permissions__`	Undocumented
Class Variable	`__administratorPermissions__`	Undocumented
Class Variable	`__authorPermissions__`	Undocumented
Class Variable	`__userAdministratorPermissions__`	Undocumented
Class Variable	`__viewPermissions__`	Undocumented
Class Variable	`dGlobalAttrs`	Undocumented
Class Variable	`enumManager`	Undocumented
Class Variable	`f_headDoctype`	Undocumented
Class Variable	`f_headMeta_DC`	Undocumented
Class Variable	`f_headMeta_Locale`	Undocumented
Class Variable	`f_headTitle`	Undocumented
Class Variable	`f_index_html`	Undocumented
Class Variable	`f_standard_html_footer`	Undocumented
Class Variable	`f_standard_html_header`	Undocumented
Class Variable	`headCSS`	Undocumented
Class Variable	`headCStyleSheet`	Undocumented
Class Variable	`headMeta`	Undocumented
Class Variable	`headScript`	Undocumented
Class Variable	`index_html`	Undocumented
Class Variable	`meta_id`	Undocumented
Class Variable	`meta_type`	Undocumented
Class Variable	`openapi_yaml`	Undocumented
Class Variable	`swagger_ui`	Undocumented
Class Variable	`zms_build`	Undocumented
Class Variable	`zms_patch`	Undocumented
Instance Variable	`dTagStack`	Undocumented
Instance Variable	`dValueStack`	Undocumented
Instance Variable	`id`	Undocumented
Instance Variable	`oParent`	Undocumented

def __before_publishing_traverse__(self, object, request): (source) ¶

Maintenance mode can be set by adding the ZMS configuration key ZMS.mode.maintenance=1. The maintenance mode prevents editing content and returns an error: 503 Service Unavailable. To show a specific message the Zope object standard_error_message should be customized, e.g. like this:

  <tal:block
      tal:define="
        errtype python:options.get('error_type',None);
        errvalue python:options.get('error_value',None)"
      tal:condition="python:errtype=='HTTPServiceUnavailable' and str(errvalue)=='Maintenance'">
      <h2>ZMS Maintenance active</h2>
      <button onclick="history.back()">Go Back</button>
  </tal:block>

def __init__(self): (source) ¶

Initialize the root object with the default content id.

def getAbsoluteHome(self): (source) ¶

Return the home folder of the portal master or the local site.

def getDCCoverage(self, REQUEST={}): (source) ¶

Return the Dublin Core coverage string for the primary language.

Parameters
REQUEST:dict	Optional request mapping.
Returns
str	Global coverage identifier.

def getDocumentElement(self): (source) ¶

Return the document element of the site tree.

def getHome(self): (source) ¶

Return the folder that contains the document element.

def getNewId(self, id_prefix='e'): (source) ¶

Return a new unique object identifier.

Parameters
id_prefix:str	Prefix used for the generated id.
Returns
str	Unique object id.

def getParentNode(self): (source) ¶

Return None because the site root has no parent node.

def getPortalClients(self): (source) ¶

Return portal clients configured below the site home folder.

def getPortalMaster(self): (source) ¶

Return the configured portal master, or None if absent.

def getRootElement(self): (source) ¶

Return the topmost portal master in the current site hierarchy.

def getTrashcan(self): (source) ¶

Return the site's trashcan object.

def initZMS(self, container, id, titlealt, title, lang, manage_lang, REQUEST, minimal_init=False): (source) ¶

Delegate site initialization to the module-level helper.

Parameters
container:OFS.ObjectManager.ObjectManager	Container that receives the new ZMS object.
id:str	Identifier of the created object.
titlealt:str	Alternative title shown in management views.
title:str	Human readable site title.
lang:str	Primary content language.
manage_lang:str	Management interface language.
REQUEST:ZPublisher.HTTPRequest.HTTPRequest	HTTP request with initialization options.
minimal_init:bool	Initialize only the minimal default configuration.
Returns
ZMS	Newly created and initialized ZMS site.

def manage_addMediaDb(self, location, REQUEST=None, RESPONSE=None): (source) ¶

Add the media database helper object.

Parameters
location:str	Filesystem location of the media database.
REQUEST:ZPublisher.HTTPRequest.HTTPRequest \| None	Optional HTTP request.
RESPONSE:ZPublisher.HTTPResponse.HTTPResponse \| None	Optional HTTP response.

def xmlOnStartElement(self, sTagName, dTagAttrs, oParentNode): (source) ¶

Reset root-level import state before XML builder processing starts.

Parameters
sTagName:str	Name of the XML start tag.
dTagAttrs:dict	Attributes of the XML start tag.
oParentNode:object	Parent node passed by the XML builder.