zms._objchildren.ObjChildren

class documentation

class ObjChildren(object): (source)

Manage child-object creation and filtered child lookups.

Method	`filteredObjChildren`	Return visible child nodes matching the configured child attribute.
Method	`getObjChildren`	Return child nodes matching the configured child attribute.
Method	`getObjChildrenAttr`	Return the configured child definition for an object key.
Method	`initObjChild`	Create and initialize a child object for the current container.
Method	`initObjChildren`	Initialize all configured child objects for the current metaobject.
Method	`manage_initObjChild`	Handle ZMI creation of a new child object.
Class Variable	`__ac_permissions__`	Undocumented
Class Variable	`__authorPermissions__`	Undocumented
Method	`_initObjChildren`	Ensure mandatory and repetitive child objects match metaobject rules.

def filteredObjChildren(self, id, REQUEST, meta_types=None): (source) ¶

Return visible child nodes matching the configured child attribute.

Parameters
id:`str`	Child attribute key.
REQUEST:`ZPublisher.HTTPRequest`	The active HTTP request.
meta_types:`list`	Optional meta type filter.
Returns
`list`	Visible matching child nodes.

def getObjChildren(self, id, REQUEST, meta_types=None): (source) ¶

Return child nodes matching the configured child attribute.

Parameters
id:`str`	Child attribute key.
REQUEST:`ZPublisher.HTTPRequest`	The active HTTP request.
meta_types:`list`	Optional meta type filter.
Returns
`list`	Matching child nodes in document order.

def getObjChildrenAttr(self, key, meta_type=None): (source) ¶

Return the configured child definition for an object key.

Parameters
key:`str`	Child attribute key.
meta_type:`str`	Optional metaobject type override.
Returns
`dict`	Child attribute configuration.

def initObjChild(self, id, _sort_id, type, REQUEST): (source) ¶

Create and initialize a child object for the current container.

Parameters
id:`str`	Base object id.
_sort_id:`int`	Sort position before normalization.
type:`str`	Child meta type.
REQUEST:`ZPublisher.HTTPRequest`	The active HTTP request.
Returns
`object`	The created or reused child object.

def initObjChildren(self, REQUEST): (source) ¶

Initialize all configured child objects for the current metaobject.

Parameters
REQUEST:`ZPublisher.HTTPRequest`	The active HTTP request.

def manage_initObjChild(self, id, type, lang, REQUEST, RESPONSE=None): (source) ¶

Handle ZMI creation of a new child object.

Parameters
id:`str`	Base object id.
type:`str`	Child meta type.
lang:`str`	Active UI language.
REQUEST:`ZPublisher.HTTPRequest`	The active HTTP request.
RESPONSE:`ZPublisher.HTTPResponse`	Optional HTTP response for redirects.
Returns
`object`	Redirect response when `RESPONSE` is provided.

Undocumented

__authorPermissions__: tuple[str, ...] = (source) ¶

Undocumented

def _initObjChildren(self, obj_attr, REQUEST): (source) ¶

Ensure mandatory and repetitive child objects match metaobject rules.

Parameters
obj_attr:`dict`	Metaobject child attribute definition.
REQUEST:`ZPublisher.HTTPRequest`	The active HTTP request.