You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: README.md
+4-4Lines changed: 4 additions & 4 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -98,7 +98,7 @@ These are the methods to be most familiar with, where the life of a data import
98
98
99
99
### Provider registry
100
100
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.
102
102
103
103
*`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.
104
104
*`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
111
111
112
112
Options may be configured by some of the methods listed below.
113
113
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.
115
115
-`addTransformers(Transformer[])`– Adds one or more transformers to the end of the transformation queue.
116
116
-`setContext(mixed)`– Specifies user-defined data to be passed to transformers.
117
117
-`setCacheAdvice(CacheAdvice)`– Specifies a caching strategy; see [caching](#caching) for more.
@@ -217,7 +217,7 @@ Architecture
217
217
218
218
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.
219
219
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.
221
221
222
222
[![Class diagram][Class diagram]][Class diagram]
223
223
@@ -422,4 +422,4 @@ Porter is published under the open source GNU Lesser General Public License v3.0
0 commit comments