Skip to content

Commit 5dfd15b

Browse files
committed
Updated readme architecture diagram 1.0 -> 3.0.
1 parent 5559fcd commit 5dfd15b

1 file changed

Lines changed: 4 additions & 4 deletions

File tree

README.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -98,7 +98,7 @@ These are the methods to be most familiar with, where the life of a data import
9898

9999
### Provider registry
100100

101-
Porter acts as a provider registry; before data can be imported from a provider it must be registered with Porter. The tagging system is provided to distinguishing between provider instances of the same type, for scenarios where more than one instance of a specific provider is needed.
101+
Porter acts as a provider registry; before data can be imported from a provider it must be registered with Porter. The tagging system is provided to distinguishing between provider instances of the same type, for scenarios where the same provider is needed with different configurations.
102102

103103
* `registerProvider(Provider, string|null $tag)` – Registers the specified provider optionally identified by the specified tag. A tag is any user-defined identifier used to distinguish between different instances of the same provider type.
104104
* `getProvider(string $name, string|null $tag)` – Gets the provider matching the specified class name and optionally a tag.
@@ -111,7 +111,7 @@ Import specifications specify *what* to import, and optionally, *how* it should
111111

112112
Options may be configured by some of the methods listed below.
113113

114-
- `addTransformer(Transformer)` – Adds a transformer to the end of the post-import transformation queue.
114+
- `addTransformer(Transformer)` – Adds a transformer to the end of the transformation queue.
115115
- `addTransformers(Transformer[])` – Adds one or more transformers to the end of the transformation queue.
116116
- `setContext(mixed)` – Specifies user-defined data to be passed to transformers.
117117
- `setCacheAdvice(CacheAdvice)` – Specifies a caching strategy; see [caching](#caching) for more.
@@ -217,7 +217,7 @@ Architecture
217217

218218
Porter talks to *providers* to fetch data. Providers represent one or more *resources* from which data can be fetched. Providers pass a *connector* needed by their resources to fetch data. Resources define the provider they are compatible with and receive the provider's connector when fetching data. Resources must transform their data into one or more *records*, collectively known as *record collections*, which present data sets as an enumeration of array values.
219219

220-
The following UML class diagram shows a partial architectural overview illustrating Porter's main components. Note that [Mapper][Mapper] is a separate project with optional integration into Porter but is included for completeness.
220+
The following UML class diagram shows a partial architectural overview illustrating Porter's main components.
221221

222222
[![Class diagram][Class diagram]][Class diagram]
223223

@@ -422,4 +422,4 @@ Porter is published under the open source GNU Lesser General Public License v3.0
422422
[Mapper]: https://github.com/ScriptFUSION/Mapper
423423
[PSR-6]: http://www.php-fig.org/psr/psr-6
424424
[Porter icon]: https://github.com/ScriptFUSION/Porter/wiki/images/porter%20head%2032x.png
425-
[Class diagram]: https://github.com/ScriptFUSION/Porter/wiki/images/diagrams/Porter%20UML%20class%20diagram%201.0.png
425+
[Class diagram]: https://github.com/ScriptFUSION/Porter/wiki/images/diagrams/Porter%20UML%20class%20diagram%203.0.png

0 commit comments

Comments
 (0)