refactor: comments
Signed-off-by: Sebastian Krupinski <krupinski01@gmail.com>
This commit is contained in:
@@ -22,20 +22,6 @@ use Sabre\VObject\Property;
|
||||
use Sabre\VObject\Splitter\VCard as VCardSplitter;
|
||||
use Throwable;
|
||||
|
||||
/**
|
||||
* Streams vCards from a file resource, maps each to a people entity, and creates
|
||||
* it in the target collection — yielding one ImportEvent per card.
|
||||
*
|
||||
* Memory profile: one vCard is held at a time (sabre's streaming splitter), the
|
||||
* generator keeps no running collection, and the discovered count is obtained by a
|
||||
* cheap byte scan rather than a second parse. See modules/people/.ideas/vcf-import.md.
|
||||
*
|
||||
* v1 scope: every card is created (disposition `created`) or fails (`error`). The
|
||||
* vCard UID is mapped to the entity `urid` so future supersede/exists detection is
|
||||
* possible, but the local provider keys entities on a fresh server id and exposes no
|
||||
* UID lookup, so supersede/updated/exists are deferred. Individual ORG affiliation
|
||||
* mapping is also deferred (the ORG property on individual cards is not yet mapped).
|
||||
*/
|
||||
class ImportService {
|
||||
|
||||
public function __construct(
|
||||
@@ -43,7 +29,7 @@ class ImportService {
|
||||
) {}
|
||||
|
||||
/**
|
||||
* @param resource $source readable, seekable file resource containing one or more vCards
|
||||
* @param resource $source readable, seekable file resource containing one or more objects
|
||||
*
|
||||
* @return Generator<int, ImportEvent>
|
||||
*/
|
||||
|
||||
Reference in New Issue
Block a user