Skip to content

Commit

Permalink
some more text
Browse files Browse the repository at this point in the history
  • Loading branch information
jensens committed Dec 2, 2022
1 parent 66b97d5 commit 8b4f495
Show file tree
Hide file tree
Showing 2 changed files with 40 additions and 10 deletions.
48 changes: 38 additions & 10 deletions docs/backend/components.md
Original file line number Diff line number Diff line change
Expand Up @@ -16,21 +16,21 @@ Interface

Adapter
: Specific implementation of an interface.
: An adapter provides an interface on its own and adapts one or more objects with specific interfaces.
An adapter provides an interface on its own and adapts one or more objects with specific interfaces.

Utility
: Specific implementation of an interface either as a singleton or factored on lookup.

Events and subscribers
: Events are emitted and and a subscriber may listen to those events.
: Events provide an interface and subsribers are registered for specific interfaces.
: Events are only dispatched to subscribers matching the interface of the event.
Events provide an interface and subsribers are registered for specific interfaces.
Events are only dispatched to subscribers matching the interface of the event.

Registries
: Adapters, utilities and subscribers are registered in registries.
: Here the wiring is done.
: Additional to the interface, a name might be provided for adapters and utilities (so called named adapters or named utilities).
: Registration can be done in Python code or via ZCML, an XML dialect.
Here the wiring is done.
Additional to the interface, a name might be provided for adapters and utilities (so called named adapters or named utilities).
Registration can be done in Python code or via ZCML, an XML dialect.

Lookup
: The lookup functions are providing the logic to dynamically factor an adapter or utility matching the object that were feed in.
Expand Down Expand Up @@ -80,10 +80,27 @@ The event system uses the Publish-subscribe pattern.

### Registries

TODO
The component registry is used to register adapters, utilities and subscribers.
On lookup it is used to find and initialize the matching adapter for the given object (or objects) - and name if given - to adapt, to find the right utility for an interface - and name if given -, and to call the matching subscribers for an event.

We have two levels of registries:

Global component registry
: This registry always and globally available as a singleton.
Configuration is done - in Plone - using ZCML files (Zope configuration markup language) which is an {term}`XML`-{term}`DSL`.
Usually they are named `configure.zcml`, but they may include ZCML files name different.

Local component registry
: Each Plone site has its own local component registry.
If there are one, two or more Plone sites created in one database, each has its own local component registry.
: The local registry is activated and registered on traversal time.
If a lookup in the local registry fails it falls back to lookup the global registry.
In theory registries can be stacked upon each other in several layers, but in practice this feture is used rarely.
: Configuration is done in the profile {term}`GenericSetup` in a file `componentregistry.xml`.
Attention, its syntax is complete different from ZCML.

doen here -> TODO

- global (ZCML)
- local (componentregistry.xml)

### Utilities

Expand All @@ -92,11 +109,22 @@ TODO

### Adapters

TODO

- general
- views, viewlets
- forms
- overriding
- adapters
- utilities
- views

### Lookup

- lookup adapter
- using the Interface as abstract factory
- using the API
- IRO, names ...
- lookup an utility, names, singletons and factory based

### Events and Subscribers

Expand Down
2 changes: 2 additions & 0 deletions docs/glossary.md
Original file line number Diff line number Diff line change
Expand Up @@ -510,5 +510,7 @@ Zope Component Architecture
ZCA
Python framework for supporting component based design and programming utilizing the design patterns interface, adapter, abstract factory and obserser/publish subscribe.

DSL
Domain Specific Language

```

0 comments on commit 8b4f495

Please sign in to comment.