<?php
/*
+--------------------------------------------------------------------+
- | CiviCRM version 4.3 |
+ | CiviCRM version 4.4 |
+--------------------------------------------------------------------+
| Copyright CiviCRM LLC (c) 2004-2013 |
+--------------------------------------------------------------------+
const XML_VALUE_SEPARATOR = ":;:;:;";
+ /**
+ * @var array description of export field mapping
+ *
+ * @code
+ * 'exampleEntityMappingName' => array(
+ * 'data' => array(), // placeholder; this will get filled-in during execution
+ * 'name' => 'CustomGroup', // per-item XML tag name
+ * 'scope' => 'CustomGroups', // container XML tag name
+ * 'required' => FALSE, // whether we *must* find records of this type
+ * 'idNameFields' => array('id', 'name'), // name of the (local/autogenerated) "id" and (portable) "name" columns
+ * 'idNameMap' => array(), // placeholder; this will get filled-in during execution
+ * ),
+ * @endcode
+ */
protected $_xml;
function __construct() {
$this->_xml = array(
'customGroup' => array(
- 'data' => NULL,
+ 'data' => array(),
'name' => 'CustomGroup',
'scope' => 'CustomGroups',
'required' => FALSE,
'idNameFields' => array('id', 'name'),
- 'map' => array(),
+ 'idNameMap' => array(),
),
'customField' => array(
- 'data' => NULL,
+ 'data' => array(),
'name' => 'CustomField',
'scope' => 'CustomFields',
'required' => FALSE,
'idNameFields' => array('id', 'column_name'),
- 'map' => array(),
+ 'idNameMap' => array(),
'mappedFields' => array(
array('optionGroup', 'option_group_id', 'option_group_name'),
array('customGroup', 'custom_group_id', 'custom_group_name'),
)
),
'optionGroup' => array(
- 'data' => NULL,
+ 'data' => array(),
'name' => 'OptionGroup',
'scope' => 'OptionGroups',
'required' => FALSE,
- 'map' => array(),
+ 'idNameMap' => array(),
'idNameFields' => array('id', 'name'),
),
'relationshipType' => array(
- 'data' => NULL,
+ 'data' => array(),
'name' => 'RelationshipType',
'scope' => 'RelationshipTypes',
'required' => FALSE,
'idNameFields' => array('id', 'name_a_b'),
- 'map' => array(),
+ 'idNameMap' => array(),
),
'locationType' => array(
- 'data' => NULL,
+ 'data' => array(),
'name' => 'LocationType',
'scope' => 'LocationTypes',
'required' => FALSE,
'idNameFields' => array('id', 'name'),
- 'map' => array(),
+ 'idNameMap' => array(),
),
'optionValue' => array(
- 'data' => NULL,
+ 'data' => array(),
'name' => 'OptionValue',
'scope' => 'OptionValues',
'required' => FALSE,
- 'map' => array(),
+ 'idNameMap' => array(),
'idNameFields' => array('value', 'name', 'prefix'),
'mappedFields' => array(
array('optionGroup', 'option_group_id', 'option_group_name'),
),
),
'profileGroup' => array(
- 'data' => NULL,
+ 'data' => array(),
'name' => 'ProfileGroup',
'scope' => 'ProfileGroups',
'required' => FALSE,
'idNameFields' => array('id', 'title'),
- 'map' => array(),
+ 'idNameMap' => array(),
),
'profileField' => array(
- 'data' => NULL,
+ 'data' => array(),
'name' => 'ProfileField',
'scope' => 'ProfileFields',
'required' => FALSE,
- 'map' => array(),
+ 'idNameMap' => array(),
'mappedFields' => array(
array('profileGroup', 'uf_group_id', 'profile_group_name')
),
),
'profileJoin' => array(
- 'data' => NULL,
+ 'data' => array(),
'name' => 'ProfileJoin',
'scope' => 'ProfileJoins',
'required' => FALSE,
- 'map' => array(),
+ 'idNameMap' => array(),
'mappedFields' => array(
array('profileGroup', 'uf_group_id', 'profile_group_name')
),
),
'mappingGroup' => array(
- 'data' => NULL,
+ 'data' => array(),
'name' => 'MappingGroup',
'scope' => 'MappingGroups',
'required' => FALSE,
'idNameFields' => array('id', 'name'),
- 'map' => array(),
+ 'idNameMap' => array(),
'mappedFields' => array(
array('optionValue', 'mapping_type_id', 'mapping_type_name', 'mapping_type'),
)
),
'mappingField' => array(
- 'data' => NULL,
+ 'data' => array(),
'name' => 'MappingField',
'scope' => 'MappingFields',
'required' => FALSE,
- 'map' => array(),
+ 'idNameMap' => array(),
'mappedFields' => array(
array('mappingGroup', 'mapping_id', 'mapping_group_name'),
array('locationType', 'location_type_id', 'location_type_name'),
$optionGroups = "( 'activity_type', 'event_type', 'mapping_type' )";
$sql = "
-SELECT distinct(g.id), g.*
-FROM civicrm_option_group g
-WHERE g.name IN $optionGroups
-";
+ SELECT distinct(g.id), g.*
+ FROM civicrm_option_group g
+ WHERE g.name IN $optionGroups
+ ";
$this->fetch('optionGroup', 'CRM_Core_DAO_OptionGroup', $sql);
$sql = "
-SELECT distinct(g.id), g.*
-FROM civicrm_option_group g,
- civicrm_custom_field f,
- civicrm_custom_group cg
-WHERE f.option_group_id = g.id
-AND f.custom_group_id = cg.id
-AND cg.is_active = 1
-";
+ SELECT distinct(g.id), g.*
+ FROM civicrm_option_group g,
+ civicrm_custom_field f,
+ civicrm_custom_group cg
+ WHERE f.option_group_id = g.id
+ AND f.custom_group_id = cg.id
+ AND cg.is_active = 1
+ ";
$this->fetch('optionGroup', 'CRM_Core_DAO_OptionGroup', $sql);
$sql = "
-SELECT v.*, g.name as prefix
-FROM civicrm_option_value v,
- civicrm_option_group g
-WHERE v.option_group_id = g.id
-AND g.name IN $optionGroups
-";
+ SELECT v.*, g.name as prefix
+ FROM civicrm_option_value v,
+ civicrm_option_group g
+ WHERE v.option_group_id = g.id
+ AND g.name IN $optionGroups
+ ";
$this->fetch('optionValue', 'CRM_Core_DAO_OptionValue', $sql);
$sql = "
-SELECT distinct(v.id), v.*, g.name as prefix
-FROM civicrm_option_value v,
- civicrm_option_group g,
- civicrm_custom_field f,
- civicrm_custom_group cg
-WHERE v.option_group_id = g.id
-AND f.option_group_id = g.id
-AND f.custom_group_id = cg.id
-AND cg.is_active = 1
-";
+ SELECT distinct(v.id), v.*, g.name as prefix
+ FROM civicrm_option_value v,
+ civicrm_option_group g,
+ civicrm_custom_field f,
+ civicrm_custom_group cg
+ WHERE v.option_group_id = g.id
+ AND f.option_group_id = g.id
+ AND f.custom_group_id = cg.id
+ AND cg.is_active = 1
+ ";
$this->fetch('optionValue', 'CRM_Core_DAO_OptionValue', $sql);
$sql = "
-SELECT rt.*
-FROM civicrm_relationship_type rt
-WHERE rt.is_active = 1
-";
+ SELECT rt.*
+ FROM civicrm_relationship_type rt
+ WHERE rt.is_active = 1
+ ";
$this->fetch('relationshipType', 'CRM_Contact_DAO_RelationshipType', $sql);
$sql = "
-SELECT lt.*
-FROM civicrm_location_type lt
-WHERE lt.is_active = 1
-";
+ SELECT lt.*
+ FROM civicrm_location_type lt
+ WHERE lt.is_active = 1
+ ";
$this->fetch('locationType', 'CRM_Core_DAO_LocationType', $sql);
$sql = "
-SELECT cg.*
-FROM civicrm_custom_group cg
-WHERE cg.is_active = 1
-";
+ SELECT cg.*
+ FROM civicrm_custom_group cg
+ WHERE cg.is_active = 1
+ ";
$this->fetch('customGroup', 'CRM_Core_DAO_CustomGroup', $sql);
$sql = "
-SELECT f.*
-FROM civicrm_custom_field f,
- civicrm_custom_group cg
-WHERE f.custom_group_id = cg.id
-AND cg.is_active = 1
-";
+ SELECT f.*
+ FROM civicrm_custom_field f,
+ civicrm_custom_group cg
+ WHERE f.custom_group_id = cg.id
+ AND cg.is_active = 1
+ ";
$this->fetch('customField', 'CRM_Core_DAO_CustomField', $sql);
$this->fetch('profileGroup', 'CRM_Core_DAO_UFGroup');
$this->fetch('profileField', 'CRM_Core_DAO_UFField');
$sql = "
-SELECT *
-FROM civicrm_uf_join
-WHERE entity_table IS NULL
-AND entity_id IS NULL
-";
+ SELECT *
+ FROM civicrm_uf_join
+ WHERE entity_table IS NULL
+ AND entity_id IS NULL
+ ";
$this->fetch('profileJoin', 'CRM_Core_DAO_UFJoin', $sql);
$this->fetch('mappingGroup', 'CRM_Core_DAO_Mapping');
$this->fetch('mappingField', 'CRM_Core_DAO_MappingField');
}
+ /**
+ * @param array $customGroupIds list of custom groups to export
+ * @return void
+ */
+ function buildCustomGroups($customGroupIds) {
+ $customGroupIdsSql = implode(',', array_filter($customGroupIds, 'is_numeric'));
+ if (empty($customGroupIdsSql)) {
+ return;
+ }
+
+ $sql = "
+ SELECT distinct(g.id), g.*
+ FROM civicrm_option_group g,
+ civicrm_custom_field f,
+ civicrm_custom_group cg
+ WHERE f.option_group_id = g.id
+ AND f.custom_group_id = cg.id
+ AND cg.id in ($customGroupIdsSql)
+ ";
+ $this->fetch('optionGroup', 'CRM_Core_DAO_OptionGroup', $sql);
+
+ $sql = "
+ SELECT distinct(v.id), v.*, g.name as prefix
+ FROM civicrm_option_value v,
+ civicrm_option_group g,
+ civicrm_custom_field f,
+ civicrm_custom_group cg
+ WHERE v.option_group_id = g.id
+ AND f.option_group_id = g.id
+ AND f.custom_group_id = cg.id
+ AND cg.id in ($customGroupIdsSql)
+ ";
+
+ $this->fetch('optionValue', 'CRM_Core_DAO_OptionValue', $sql);
+
+ $sql = "
+ SELECT cg.*
+ FROM civicrm_custom_group cg
+ WHERE cg.id in ($customGroupIdsSql)
+
+ ";
+ $this->fetch('customGroup', 'CRM_Core_DAO_CustomGroup', $sql);
+
+ $sql = "
+ SELECT f.*
+ FROM civicrm_custom_field f,
+ civicrm_custom_group cg
+ WHERE f.custom_group_id = cg.id
+ AND cg.id in ($customGroupIdsSql)
+ ";
+ $this->fetch('customField', 'CRM_Core_DAO_CustomField', $sql);
+ }
+
+ /**
+ * @param array $ufGroupIds list of custom groups to export
+ * @return void
+ */
+ function buildUFGroups($ufGroupIds) {
+ $ufGroupIdsSql = implode(',', array_filter($ufGroupIds, 'is_numeric'));
+ if (empty($ufGroupIdsSql)) {
+ return;
+ }
+
+ $sql = "
+ SELECT cg.*
+ FROM civicrm_uf_group cg
+ WHERE cg.id IN ($ufGroupIdsSql)
+
+ ";
+ $this->fetch('profileGroup', 'CRM_Core_DAO_UFGroup', $sql);
+
+ $sql = "
+ SELECT f.*
+ FROM civicrm_uf_field f,
+ civicrm_uf_group cg
+ WHERE f.uf_group_id = cg.id
+ AND cg.id IN ($ufGroupIdsSql)
+ ";
+ $this->fetch('profileField', 'CRM_Core_DAO_UFField', $sql);
+
+ $sql = "
+ SELECT *
+ FROM civicrm_uf_join
+ WHERE entity_table IS NULL
+ AND entity_id IS NULL
+ AND uf_group_id IN ($ufGroupIdsSql)
+ ";
+ $this->fetch('profileJoin', 'CRM_Core_DAO_UFJoin', $sql);
+ }
+
/**
* Render the in-memory representation as XML
*
$buffer .= "\n\n<CustomData>\n";
foreach (array_keys($this->_xml) as $key) {
if (!empty($this->_xml[$key]['data'])) {
- $buffer .= " <{$this->_xml[$key]['scope']}>\n{$this->_xml[$key]['data']} </{$this->_xml[$key]['scope']}>\n";
+ $buffer .= " <{$this->_xml[$key]['scope']}>\n";
+ foreach ($this->_xml[$key]['data'] as $item) {
+ $buffer .= $this->renderKeyValueXML($this->_xml[$key]['name'], $item);
+ }
+ $buffer .= " </{$this->_xml[$key]['scope']}>\n";
}
elseif ($this->_xml[$key]['required']) {
CRM_Core_Error::fatal("No records in DB for $key");
return $buffer;
}
+ /**
+ * Generate an array-tree representation of the exported elements.
+ *
+ * @return array
+ */
+ function toArray() {
+ $result = array();
+ foreach (array_keys($this->_xml) as $key) {
+ if (!empty($this->_xml[$key]['data'])) {
+ $result[ $this->_xml[$key]['name'] ] = array_values($this->_xml[$key]['data']);
+ }
+ }
+ return $result;
+ }
+
function fetch($groupName, $daoName, $sql = NULL) {
- $map = isset($this->_xml[$groupName]['idNameFields']) ? $this->_xml[$groupName]['idNameFields'] : NULL;
- $add = isset($this->_xml[$groupName]['mappedFields']) ? $this->_xml[$groupName]['mappedFields'] : NULL;
+ $idNameFields = isset($this->_xml[$groupName]['idNameFields']) ? $this->_xml[$groupName]['idNameFields'] : NULL;
+ $mappedFields = isset($this->_xml[$groupName]['mappedFields']) ? $this->_xml[$groupName]['mappedFields'] : NULL;
$dao = new $daoName();
if ($sql) {
}
while ($dao->fetch()) {
- $this->_xml[$groupName]['data'] .= $this->exportDAO($dao,
- $this->_xml[$groupName]['name'],
- $this->addMappedXMLFields($add, $dao)
- );
- if ($map) {
- if (isset($map[2])) {
- $this->_xml[$groupName]['map'][$dao->{$map[2]} . '.' . $dao->{$map[0]}] = $dao->{$map[1]};
+ $this->_xml[$groupName]['data'][$dao->id] = $this->exportDAO($this->_xml[$groupName]['name'], $dao, $mappedFields);
+ if ($idNameFields) {
+ // index the id/name fields so that we can translate from FK ids to FK names
+ if (isset($idNameFields[2])) {
+ $this->_xml[$groupName]['idNameMap'][$dao->{$idNameFields[2]} . '.' . $dao->{$idNameFields[0]}] = $dao->{$idNameFields[1]};
}
else {
- $this->_xml[$groupName]['map'][$dao->{$map[0]}] = $dao->{$map[1]};
+ $this->_xml[$groupName]['idNameMap'][$dao->{$idNameFields[0]}] = $dao->{$idNameFields[1]};
}
}
}
}
/**
- * Given a set of field mappings, generate XML for the mapped fields
+ * Compute any fields of the entity defined by the $mappedFields specification
*
* @param array $mappedFields each item is an array(0 => MappedEntityname, 1 => InputFieldName (id-field), 2 => OutputFieldName (name-field), 3 => OptionalPrefix)
- * @param CRM_Core_DAO $dao
- * @return null|string XML
+ * @param CRM_Core_DAO $dao the entity for which we want to prepare mapped fields
+ * @return array new fields
*/
- public function addMappedXMLFields($mappedFields, $dao) {
- $additional = NULL;
+ public function computeMappedFields($mappedFields, $dao) {
+ $keyValues = array();
if ($mappedFields) {
foreach ($mappedFields as $mappedField) {
if (isset($dao->{$mappedField[1]})) {
if (isset($mappedField[3])) {
- $label = $this->_xml[$mappedField[0]]['map']["{$mappedField[3]}." . $dao->{$mappedField[1]}];
+ $label = $this->_xml[$mappedField[0]]['idNameMap']["{$mappedField[3]}." . $dao->{$mappedField[1]}];
}
else {
- $label = $this->_xml[$mappedField[0]]['map'][$dao->{$mappedField[1]}];
+ $label = $this->_xml[$mappedField[0]]['idNameMap'][$dao->{$mappedField[1]}];
}
- $additional .= "\n " . $this->renderTextTag($mappedField[2], $label);
+ $keyValues[$mappedField[2]] = $label;
}
}
- return $additional;
}
- return $additional;
+ return $keyValues;
}
/**
* @param CRM_Core_DAO $object
* @param string $objectName business-entity/xml-tag name
- * @param string $additional XML
- * @return string XML
+ * @return array
*/
- function exportDAO($object, $objectName, $additional = NULL) {
+ function exportDAO($objectName, $object, $mappedFields) {
$dbFields = & $object->fields();
- $xml = " <$objectName>";
+ // Filter the list of keys and values so that we only export interesting stuff
+ $keyValues = array();
foreach ($dbFields as $name => $dontCare) {
// ignore all ids
- if ($name == 'id' ||
- substr($name, -3, 3) == '_id'
- ) {
+ if ($name == 'id' || substr($name, -3, 3) == '_id') {
continue;
}
- if (isset($object->$name) &&
- $object->$name !== NULL
- ) {
+ if (isset($object->$name) && $object->$name !== NULL) {
// hack for extends_entity_column_value
if ($name == 'extends_entity_column_value') {
- if ($object->extends == 'Event' ||
- $object->extends == 'Activity' ||
- $object->extends == 'Relationship'
- ) {
+ if (in_array($object->extends, array('Event', 'Activity', 'Relationship', 'Individual', 'Organization', 'Household'))) {
if ($object->extends == 'Event') {
$key = 'event_type';
}
elseif ($object->extends == 'Relationship') {
$key = 'relationship_type';
}
- $xml .= "\n " . $this->renderTextTag('extends_entity_column_value_option_group', $key);
+ elseif($object->extends == 'Case') {
+ $key = 'case_type';
+ }
$types = explode(CRM_Core_DAO::VALUE_SEPARATOR, substr($object->$name, 1, -1));
- $value = array();
- foreach ($types as $type) {
- $values[] = $this->_xml['optionValue']['map']["$key.{$type}"];
+ $values = array();
+ if (in_array($object->extends, array('Individual', 'Organization', 'Household'))) {
+ $key = 'contact_type';
+ $values = $types;
+ }
+ else {
+ foreach ($types as $type) {
+ if (in_array($key, array('activity_type', 'event_type'))) {
+ $ogID = CRM_Core_DAO::getFieldValue('CRM_Core_DAO_OptionGroup', $key, 'id', 'name');
+ $ovParams = array('option_group_id' => $ogID, 'value' => $type);
+ CRM_Core_BAO_OptionValue::retrieve($ovParams, $oValue);
+ $values[] = $oValue['name'];
+ }
+ else {
+ $relTypeName = CRM_Core_DAO::getFieldValue('CRM_Contact_BAO_RelationshipType', $type, 'name_a_b', 'id');
+ $values[] = $relTypeName;
+ }
+ }
}
+ $keyValues['extends_entity_column_value_option_group'] = $key;
$value = implode(',', $values);
- $xml .= "\n " . $this->renderTextTag('extends_entity_column_value_option_value', $value);
+ $object->extends_entity_column_value = $value;
}
else {
echo "This extension: {$object->extends} is not yet handled";
exit();
}
}
+
+ $value = $object->$name;
if ($name == 'field_name') {
- $value = $object->$name;
// hack for profile field_name
if (substr($value, 0, 7) == 'custom_') {
$cfID = substr($value, 7);
$value = "custom.{$tableName}.{$columnName}";
}
}
- else {
- $value = str_replace(CRM_Core_DAO::VALUE_SEPARATOR, self::XML_VALUE_SEPARATOR, $object->$name);
- }
- $xml .= "\n " . $this->renderTextTag($name, $value);
+ $keyValues[$name] = $value;
}
}
- if ($additional) {
- $xml .= $additional;
+
+ $keyValues += $this->computeMappedFields($mappedFields, $object);
+
+ return $keyValues;
+ }
+
+ /**
+ * @param string $tagName
+ * @param array $keyValues
+ * @param string $additional XML
+ * @return string XML
+ */
+ public function renderKeyValueXML($tagName, $keyValues) {
+ $xml = " <$tagName>";
+ foreach ($keyValues as $k => $v) {
+ $xml .= "\n " . $this->renderTextTag($k, str_replace(CRM_Core_DAO::VALUE_SEPARATOR, self::XML_VALUE_SEPARATOR, $v));
}
- $xml .= "\n </$objectName>\n";
+ $xml .= "\n </$tagName>\n";
return $xml;
}
projects / civicrm-core.git / blobdiff