/**
* Converts a DOMElement item to a Zotero_Item object
*
* @param DOMElement $xml Item data as DOMElement
* @return Zotero_Item Zotero item object
*/
public static function convertXMLToItem(DOMElement $xml)
{
// Get item type id, adding custom type if necessary
$itemTypeName = $xml->getAttribute('itemType');
$itemTypeID = Zotero_ItemTypes::getID($itemTypeName);
if (!$itemTypeID) {
$itemTypeID = Zotero_ItemTypes::addCustomType($itemTypeName);
}
// Primary fields
$libraryID = (int) $xml->getAttribute('libraryID');
$itemObj = self::getByLibraryAndKey($libraryID, $xml->getAttribute('key'));
if (!$itemObj) {
$itemObj = new Zotero_Item();
$itemObj->libraryID = $libraryID;
$itemObj->key = $xml->getAttribute('key');
}
$itemObj->setField('itemTypeID', $itemTypeID, false, true);
$itemObj->setField('dateAdded', $xml->getAttribute('dateAdded'), false, true);
$itemObj->setField('dateModified', $xml->getAttribute('dateModified'), false, true);
$xmlFields = array();
$xmlCreators = array();
$xmlNote = null;
$xmlPath = null;
$xmlRelated = null;
$childNodes = $xml->childNodes;
foreach ($childNodes as $child) {
switch ($child->nodeName) {
case 'field':
$xmlFields[] = $child;
break;
case 'creator':
$xmlCreators[] = $child;
break;
case 'note':
$xmlNote = $child;
break;
case 'path':
$xmlPath = $child;
break;
case 'related':
$xmlRelated = $child;
break;
}
}
// Item data
$setFields = array();
foreach ($xmlFields as $field) {
// TODO: add custom fields
$fieldName = $field->getAttribute('name');
// Special handling for renamed computerProgram 'version' field
if ($itemTypeID == 32 && $fieldName == 'version') {
$fieldName = 'versionNumber';
}
$itemObj->setField($fieldName, $field->nodeValue, false, true);
$setFields[$fieldName] = true;
}
$previousFields = $itemObj->getUsedFields(true);
foreach ($previousFields as $field) {
if (!isset($setFields[$field])) {
$itemObj->setField($field, false, false, true);
}
}
$deleted = $xml->getAttribute('deleted');
$itemObj->deleted = $deleted == 'true' || $deleted == '1';
// Creators
$i = 0;
foreach ($xmlCreators as $creator) {
// TODO: add custom creator types
$pos = (int) $creator->getAttribute('index');
if ($pos != $i) {
throw new Exception("No creator in position {$i} for item " . $itemObj->key);
}
$key = $creator->getAttribute('key');
$creatorObj = Zotero_Creators::getByLibraryAndKey($libraryID, $key);
// If creator doesn't exist locally (e.g., if it was deleted locally
// and appears in a new/modified item remotely), get it from within
// the item's creator block, where a copy should be provided
if (!$creatorObj) {
$subcreator = $creator->getElementsByTagName('creator')->item(0);
if (!$subcreator) {
throw new Exception("Data for missing local creator {$key} not provided", Z_ERROR_CREATOR_NOT_FOUND);
}
$creatorObj = Zotero_Creators::convertXMLToCreator($subcreator, $libraryID);
if ($creatorObj->key != $key) {
throw new Exception("Creator key " . $creatorObj->key . " does not match item creator key {$key}");
}
}
if (Zotero_Utilities::unicodeTrim($creatorObj->firstName) === '' && Zotero_Utilities::unicodeTrim($creatorObj->lastName) === '') {
continue;
}
$creatorTypeID = Zotero_CreatorTypes::getID($creator->getAttribute('creatorType'));
$itemObj->setCreator($pos, $creatorObj, $creatorTypeID);
$i++;
}
// Remove item's remaining creators not in XML
$numCreators = $itemObj->numCreators();
$rem = $numCreators - $i;
for ($j = 0; $j < $rem; $j++) {
// Keep removing last creator
$itemObj->removeCreator($i);
}
// Both notes and attachments might have parents and notes
if ($itemTypeName == 'note' || $itemTypeName == 'attachment') {
$sourceItemKey = $xml->getAttribute('sourceItem');
$itemObj->setSource($sourceItemKey ? $sourceItemKey : false);
$itemObj->setNote($xmlNote ? $xmlNote->nodeValue : "");
}
// Attachment metadata
if ($itemTypeName == 'attachment') {
$itemObj->attachmentLinkMode = (int) $xml->getAttribute('linkMode');
$itemObj->attachmentMIMEType = $xml->getAttribute('mimeType');
$itemObj->attachmentCharset = $xml->getAttribute('charset');
// Cast to string to be 32-bit safe
$storageModTime = (string) $xml->getAttribute('storageModTime');
$itemObj->attachmentStorageModTime = $storageModTime ? $storageModTime : null;
$storageHash = $xml->getAttribute('storageHash');
$itemObj->attachmentStorageHash = $storageHash ? $storageHash : null;
$itemObj->attachmentPath = $xmlPath ? $xmlPath->nodeValue : "";
}
// Related items
if ($xmlRelated && $xmlRelated->nodeValue) {
$relatedKeys = explode(' ', $xmlRelated->nodeValue);
} else {
$relatedKeys = array();
}
$itemObj->relatedItems = $relatedKeys;
return $itemObj;
}
