zms._conf.ZMSSysConf

class documentation

class ZMSSysConf(ZMSItem.ZMSItem): (source)

Constructor: ZMSSysConf()

Implements interfaces: Products.zms.IZMSRepositoryProvider.IZMSRepositoryProvider

System configuration container for a ZMS instance. Stores key/value configuration properties in __attr_conf_dict__ and implements IZMSRepositoryProvider for repository persistence.

Method	`__init__`	Initialise a new ZMSSysConf instance with id 'sys_conf'.
Method	`del_property`	Delete a configuration property by key.
Method	`get_properties`	Return the full configuration properties dictionary.
Method	`get_property`	Return a single configuration property value.
Method	`initialize`	Hook for post-creation initialization (currently a no-op).
Method	`provideRepository`	Provide configuration data for the repository export.
Method	`set_properties`	Replace the full configuration properties dictionary.
Method	`set_property`	Set a single configuration property. If value is None, the property is deleted. Clears the request buffer for Portal keys.
Method	`updateRepository`	Update configuration from repository import data.
Class Variable	`meta_type`	Undocumented
Class Variable	`zmi_icon`	Undocumented
Instance Variable	`id`	Undocumented

def __init__(self): (source) ¶

Initialise a new ZMSSysConf instance with id 'sys_conf'.

Returns
`None`	`None`

def del_property(self, key): (source) ¶

Delete a configuration property by key.

Parameters
key:`str`	Property key to delete.
Returns
`None`	`None`

def get_properties(self): (source) ¶

Return the full configuration properties dictionary.

Returns
`dict`	Configuration properties

def get_property(self, key, default=None): (source) ¶

Return a single configuration property value.

Parameters
key:`str`	Property key.
default:`any`	Default value returned when `key` does not exist.
Returns
`any`	Property value or `default`.

def initialize(self): (source) ¶

Hook for post-creation initialization (currently a no-op).

Returns
`None`	`None`

def provideRepository(self, ids=None): (source) ¶

Provide configuration data for the repository export.

Parameters
ids:`list` or `None`	List of IDs to export. Expected values include `'sys_conf'`; `None` exports all valid ids.
Returns
`dict`	Dictionary of repository data keyed by id
See Also
IZMSRepositoryProvider

def set_properties(self, properties): (source) ¶

Replace the full configuration properties dictionary.

Parameters
properties:`dict`	New configuration properties mapping. Expected value is a plain `dict` with string keys.
Returns
`None`	`None`

def set_property(self, key, value): (source) ¶

Set a single configuration property. If value is None, the property is deleted. Clears the request buffer for Portal keys.

Parameters
key:`str`	Property key.
value:`any` \| `None`	Property value. Use `None` to delete the key.
Returns
`None`	`None`

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

Update configuration from repository import data.

Parameters
r:`dict`	Repository data dictionary containing `'Properties'` (or legacy `'properties'`).
Returns
`None`	`None`
See Also
IZMSRepositoryProvider

meta_type: str = (source) ¶

Undocumented

zmi_icon: str = (source) ¶

Undocumented

id: str = (source) ¶

Undocumented