zms.ZMSMetaobjManager.ZMSMetaobjManager

class documentation

class ZMSMetaobjManager(object): (source)

Manage ZMS meta-object definitions, attributes, and related artefacts.

Method	`__get_metaobj__`	Return one meta-object record by id.
Method	`__get_metaobjs__`	Return all meta-objects, including acquired entries from portal master.
Method	`acquireMetaobj`	Mark a meta-object as acquired from portal master.
Method	`delMetaobj`	Delete one meta-object and its managed attribute artefacts.
Method	`delMetaobjAttr`	Delete one attribute from a meta-object definition.
Method	`evalMetaobjAttr`	Evaluate one computed meta-object attribute and return its runtime value.
Method	`exportMetaobjXml`	Export selected meta-objects to XML.
Method	`getMetaobj`	Return one meta-object and optionally overlay acquired configuration.
Method	`getMetaobjAttr`	Return one attribute mapping for a given meta-object and attribute id.
Method	`getMetaobjAttrIdentifierId`	Return the preferred identifier attribute id for a record-like meta-object.
Method	`getMetaobjAttrIds`	Return attribute ids for one meta-object, optionally filtered by type.
Method	`getMetaobjAttrs`	Return attribute mappings for one meta-object.
Method	`getMetaobjId`	Resolve one meta-object id by its display name.
Method	`getMetaobjIds`	Return available meta-object ids with optional sorting and exclusion.
Method	`getMetaobjRevision`	Return the effective revision string for a meta-object.
Method	`getTypedMetaIds`	Expand type-selector entries into concrete meta-object ids.
Method	`importMetaobjXml`	Import one or many meta-object records from XML content.
Method	`importTheme`	Import a theme folder structure into a `ZMSLibrary` meta-object.
Method	`manage_ajaxChangeProperties`	Update editable object properties from AJAX form values.
Method	`manage_changeProperties`	Handle meta-object manager actions from the ZMI properties form.
Method	`manage_create_default_zpt`	Create and optionally return default standard_html ZPT code.
Method	`moveMetaobjAttr`	Move one attribute to a new position in the meta-object attribute list.
Method	`notifyMetaobjAttrAboutValue`	Notify one meta-object attribute about a newly observed runtime value.
Method	`provideRepositoryModel`	Export meta-object model records into repository payload structure.
Method	`renderTemplate`	Render the first matching template source for the given meta-object.
Method	`setMetaobj`	Insert or update one meta-object definition in the model.
Method	`setMetaobjAttr`	Create or update one meta-object attribute definition.
Method	`translateRepositoryModel`	Translate repository payload into import-friendly key/value records.
Method	`updateRepositoryModel`	Import one repository record into the local meta-object model.
Class Variable	`deprecated_types`	Undocumented
Class Variable	`valid_datatypes`	Undocumented
Class Variable	`valid_objtypes`	Undocumented
Class Variable	`valid_types`	Undocumented
Class Variable	`valid_uploadtypes`	Undocumented
Class Variable	`valid_xtypes`	Undocumented
Class Variable	`valid_zopeattrs`	Undocumented
Class Variable	`valid_zopetypes`	Undocumented
Instance Variable	`model`	Undocumented
Method	`_importMetaobjXml`	Import one meta-object XML item into the local model.

def __get_metaobj__(self, id): (source) ¶

Return one meta-object record by id.

Parameters
id:`str`	Meta-object id.
Returns
`dict` \| `None`	Meta-object mapping or `None`.

def __get_metaobjs__(self): (source) ¶

Return all meta-objects, including acquired entries from portal master.

The result is request-buffered to avoid repeated recomputation during one request cycle.

Returns
`dict`	Mapping `{meta_id: meta_object_dict}`.

def acquireMetaobj(self, id, subobjects=1): (source) ¶

Mark a meta-object as acquired from portal master.

Parameters
id:`str`	Meta-object id.
subobjects:`int`	If `1`, package subobjects are also acquired.
Returns
`None`	`None`

def delMetaobj(self, id, acquire=False): (source) ¶

Delete one meta-object and its managed attribute artefacts.

Parameters
id:`str`	Meta-object id.
acquire:`bool`	If true, keep native Zope artefacts used by acquisition.
Returns
`None`	`None`

def delMetaobjAttr(self, id, attr_id, acquire=False): (source) ¶

Delete one attribute from a meta-object definition.

Parameters
id:`str`	Meta-object id.
attr_id:`str`	Attribute id to remove.
acquire:`bool`	If true, avoid removing acquired native artefacts.
Returns
`None`	`None`

def evalMetaobjAttr(self, id, attr_id, zmscontext=None, options={}): (source) ¶

Evaluate one computed meta-object attribute and return its runtime value.

Parameters
id:`str`	Meta-object id or `'*'` for all meta-objects.
attr_id:`str`	Attribute id to evaluate.
zmscontext:`object` \| `None`	Optional context passed to callable attributes.
options:`dict`	Optional call options for executable attributes.
Returns
`any`	Evaluated value or `None` when unresolved.

def exportMetaobjXml(self, ids, REQUEST=None, RESPONSE=None): (source) ¶

Export selected meta-objects to XML.

Parameters
ids:`list`	Meta-object ids to export. Empty list exports all effective ids.
REQUEST:`ZPublisher.HTTPRequest` \| `None`	Optional request context controlling export key pruning.
RESPONSE:`ZPublisher.HTTPResponse` \| `None`	Optional response to receive download headers.
Returns
`str`	XML payload string.

def getMetaobj(self, id, aq_attrs=[]): (source) ¶

Return one meta-object and optionally overlay acquired configuration.

Parameters
id:`str`	Meta-object id.
aq_attrs:`list`	Attribute names to read from local configuration when the object is acquired from portal master.
Returns
`dict`	Meta-object mapping.

def getMetaobjAttr(self, id, attr_id, sync=True): (source) ¶

Return one attribute mapping for a given meta-object and attribute id.

Parameters
id:`str`	Meta-object id.
attr_id:`str`	Attribute id.
sync:`bool`	If true, attach backing Zope artefact reference when applicable.
Returns
`dict` \| `None`	Attribute mapping or `None`.

def getMetaobjAttrIdentifierId(self, meta_id): (source) ¶

Return the preferred identifier attribute id for a record-like meta-object.

Candidate types are checked in order: identifier, string, int.

Parameters
meta_id:`str`	Meta-object id.
Returns
`str` \| `None`	First matching attribute id or `None`.

def getMetaobjAttrIds(self, id, types=[]): (source) ¶

Return attribute ids for one meta-object, optionally filtered by type.

Parameters
id:`str`	Meta-object id.
types:`list`	Optional list of accepted attribute types.
Returns
`list`	Attribute id list.

def getMetaobjAttrs(self, id, types=[]): (source) ¶

Return attribute mappings for one meta-object.

Parameters
id:`str`	Meta-object id.
types:`list`	Optional list of accepted attribute types.
Returns
`list`	List of attribute mappings.

def getMetaobjId(self, name): (source) ¶

Resolve one meta-object id by its display name.

Parameters
name:`str`	Display name as returned by `display_type`.
Returns
`str` \| `None`	Matching meta-object id or `None`.

def getMetaobjIds(self, sort=None, excl_ids=[]): (source) ¶

Return available meta-object ids with optional sorting and exclusion.

Parameters
sort:`bool` \| `None`	`True` sorts by display type, `False` by name, `None` keeps model iteration order.
excl_ids:`list`	Ids to exclude from the result.
Returns
`list`	Meta-object id list.

def getMetaobjRevision(self, id): (source) ¶

Return the effective revision string for a meta-object.

For package objects this also considers child objects that belong to the same package and returns the highest semantic version.

Parameters
id:`str`	Meta-object id.
Returns
`str`	Revision string, for example `'0.0.0'`.

def getTypedMetaIds(self, meta_ids): (source) ¶

Expand type-selector entries into concrete meta-object ids.

Selectors use the form type(<meta_type>) and are resolved against enabled meta-objects.

Parameters
meta_ids:`list`	Mixed list of meta ids and type selectors.
Returns
`list`	Concrete list of matching meta-object ids.

def importMetaobjXml(self, xml, createIdsFilter=None): (source) ¶

Import one or many meta-object records from XML content.

Parameters
xml:`str` \| `bytes` \| `file`	XML string, bytes, or file-like content.
createIdsFilter:`list` \| `None`	Optional whitelist of ids to import.
Returns
`str` \| `list`	Imported id or list of imported ids.

def importTheme(self, id): (source) ¶

Import a theme folder structure into a ZMSLibrary meta-object.

Parameters
id:`str`	Theme container id.
Returns
`None`	`None`

def manage_ajaxChangeProperties(self, id, REQUEST, RESPONSE=None): (source) ¶

Update editable object properties from AJAX form values.

Parameters
id:`str`	Meta-object id.
REQUEST:`ZPublisher.HTTPRequest`	HTTP request containing `set*` form fields.
RESPONSE:`ZPublisher.HTTPResponse` \| `None`	Optional HTTP response for XML output headers.
Returns
`str` \| `None`	XML result payload when `RESPONSE` is passed.

def manage_changeProperties(self, lang, btn='', key='all', REQUEST=None, RESPONSE=None): (source) ¶

Handle meta-object manager actions from the ZMI properties form.

Supported actions include insert/update/delete, import/export, acquisition handling, and attribute reordering.

Parameters
lang:`str`	Active UI language id.
btn:`str`	Submitted action button id.
key:`str`	Edited section key (for example `'obj'` or `'attr'`).
REQUEST:`ZPublisher.HTTPRequest`	Incoming request carrying form payload.
RESPONSE:`ZPublisher.HTTPResponse` \| `None`	Optional response used for redirects and downloads.
Returns
`object` \| `str`	Redirect response or localized status message.

def manage_create_default_zpt(self, id, target_id='standard_html', attrs=None, REQUEST=None, RESPONSE=None): (source) ¶

Create and optionally return default standard_html ZPT code.

Parameters
id:`str`	Meta-object id.
target_id:`str`	Target template id (default `standard_html`).
attrs:`list` \| `None`	Optional list of attribute dicts to use instead of fetching from meta-object definition.
REQUEST:`ZPublisher.HTTPRequest` \| `None`	Optional request for language and context (used in template code generation).
RESPONSE:`ZPublisher.HTTPResponse` \| `None`	Optional response for XML output headers (not used).
Returns
`str`	Generated default ZPT code for the specified template.

def moveMetaobjAttr(self, id, attr_id, pos): (source) ¶

Move one attribute to a new position in the meta-object attribute list.

Parameters
id:`str`	Meta-object id.
attr_id:`str`	Attribute id to move.
pos:`int`	Zero-based target position.
Returns
`None`	`None`

def notifyMetaobjAttrAboutValue(self, meta_id, key, value): (source) ¶

Notify one meta-object attribute about a newly observed runtime value.

For auto-complete attribute types ('autocomplete' and 'multiautocomplete') this method extends the static key list when the attribute keys are not executable snippets.

Parameters
meta_id:`str`	Meta-object id that owns the attribute.
key:`str`	Attribute id.
value:`str` \| `int` \| `float` \| `list`	Observed value. Expected value is either a single scalar or a list of scalar values.
Returns
`None`	`None`

def provideRepositoryModel(self, r, ids=None): (source) ¶

Export meta-object model records into repository payload structure.

Parameters
r:`dict`	Repository accumulator mapping to be filled in-place.
ids:`list` \| `None`	Optional subset of meta-object ids. `None` exports all ids.
Returns
`None`	`None`. The payload is written into `r`.

def renderTemplate(self, obj): (source) ¶

Render the first matching template source for the given meta-object.

Resolution order prefers skin/extension specific templates, then standard_html, then bodyContentZMSCustom_<meta_id>.

Parameters
obj:`object`	Content object providing `meta_id`, request, and attr access.
Returns
`str`	Rendered HTML fragment or empty string.

def setMetaobj(self, ob): (source) ¶

Insert or update one meta-object definition in the model.

The method normalizes optional fields and forces persistence by copying the model mapping.

Parameters
ob:`dict`	Meta-object definition.
Returns
`None`	`None`

def setMetaobjAttr(self, id, oldId, newId, newName='', newMandatory=0, newMultilang=1, newRepetitive=0, newType='string', newKeys=[], newCustom='', newDefault=''): (source) ¶

Create or update one meta-object attribute definition.

This method also manages dependent Zope objects for executable/native attribute types and preserves ordering constraints in the attribute list.

Parameters
id:`str`	Meta-object id.
oldId:`str` \| `None`	Previous attribute id, or `None` for insertion.
newId:`str`	New attribute id.
newName:`str`	Attribute display name.
newMandatory:`int`	Mandatory flag (expected values: `0` or `1`).
newMultilang:`int`	Multilang flag (expected values: `0` or `1`).
newRepetitive:`int`	Repetitive flag (expected values: `0` or `1`).
newType:`str`	Attribute type identifier.
newKeys:`list`	Optional key list for select-like attributes.
newCustom:`str` \| `int` \| `_blobfields.MyBlob`	Optional custom payload/content.
newDefault:`str`	Optional default value.
Returns
`str`	Message fragment generated during update.

def translateRepositoryModel(self, r): (source) ¶

Translate repository payload into import-friendly key/value records.

Parameters
r:`dict`	Repository model payload keyed by meta-object id.
Returns
`list`	List of `{'key': id, 'value': record}` mappings.

def updateRepositoryModel(self, r): (source) ¶

Import one repository record into the local meta-object model.

Parameters
r:`dict`	Repository record containing object metadata and attributes.
Returns
`str`	Imported meta-object id.

deprecated_types: list[str] = (source) ¶

Undocumented

valid_datatypes = (source) ¶

Undocumented

valid_objtypes: list[str] = (source) ¶

Undocumented

valid_types: list[str] = (source) ¶

Undocumented

valid_uploadtypes: list[str] = (source) ¶

Undocumented

valid_xtypes = (source) ¶

Undocumented

valid_zopeattrs: list[str] = (source) ¶

Undocumented

valid_zopetypes: list[str] = (source) ¶

Undocumented

model = (source) ¶

Undocumented

def _importMetaobjXml(self, item, createIdsFilter=None): (source) ¶

Import one meta-object XML item into the local model.

Parameters
item:`dict`	Parsed XML item with `'key'` and `'value'`.
createIdsFilter:`list` \| `None`	Optional whitelist of ids to import.
Returns
`str`	Imported meta-object id.