Collaboration diagram for PIM Items:

Overview

OpenAB::PIMItem represents single personal information item like:

contact (OpenAB::PIMContactItem)
calendar item (OpenAB::PIMCalendarItem)
task item (OpenAB::PIMTaskItem) in future more types can be added.

PIM Items are provided by Sources (OpenAB_Source::Source) and can be stored in Storage (OpenAB_Storage::Storage) either by manually adding/removing/modifying them using OpenAB_Storage::Storage API or by synchronization process (OpenAB_Sync::Sync).

Each OpenAB::PIMItem provides index (OpenAB::PIMItemIndex) that is used to uniquely identify it and allows for matching and comparison with other PIMItems.

OpenAB::PIMItemIndex is representation of OpenAB::PIMItem, created based on definition of PIMItemIndex::PIMItemCheck for given PIMItem type (allows to define which fields should be taken in consideration when comparing items), allowing for customization. OpenAB::PIMItemIndex is automatically created during creation of PIMItem.

Each OpenAB::PIMItem can be created from format specific to given item type:

contact from vCard (defined in RFC 2425 and RFC 2426)
calendar and tasks item from iCalendar (defined in RFC 5545, RFC 5546 and RFC 6868)

Way in which result of parsing input format are stored inside PIMIndex is up to implementation of PIMIndex classes, as both of above formats store data in key-value manner this is advised way of storing parsed data.

If native format of items provided by OpenAB_Source::Source implementation is different of the one above, implementation needs to convert it to required one, the same applies for OpenAB_Storage::Storage implementations, if there is no native support for above formats, conversion needs to be implemented.

API Details

Here is the list of most important functions provided by PIMItem and PIMItemIndex objects: