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; /** * Class constructor. */ public function __construct() { $this->_xml = array( 'customGroup' => array( 'data' => array(), 'name' => 'CustomGroup', 'scope' => 'CustomGroups', 'required' => FALSE, 'idNameFields' => array('id', 'name'), 'idNameMap' => array(), ), 'customField' => array( 'data' => array(), 'name' => 'CustomField', 'scope' => 'CustomFields', 'required' => FALSE, 'idNameFields' => array('id', 'column_name'), 'idNameMap' => array(), 'mappedFields' => array( array('optionGroup', 'option_group_id', 'option_group_name'), array('customGroup', 'custom_group_id', 'custom_group_name'), ), ), 'optionGroup' => array( 'data' => array(), 'name' => 'OptionGroup', 'scope' => 'OptionGroups', 'required' => FALSE, 'idNameMap' => array(), 'idNameFields' => array('id', 'name'), ), 'relationshipType' => array( 'data' => array(), 'name' => 'RelationshipType', 'scope' => 'RelationshipTypes', 'required' => FALSE, 'idNameFields' => array('id', 'name_a_b'), 'idNameMap' => array(), ), 'locationType' => array( 'data' => array(), 'name' => 'LocationType', 'scope' => 'LocationTypes', 'required' => FALSE, 'idNameFields' => array('id', 'name'), 'idNameMap' => array(), ), 'optionValue' => array( 'data' => array(), 'name' => 'OptionValue', 'scope' => 'OptionValues', 'required' => FALSE, 'idNameMap' => array(), 'idNameFields' => array('value', 'name', 'prefix'), 'mappedFields' => array( array('optionGroup', 'option_group_id', 'option_group_name'), ), ), 'profileGroup' => array( 'data' => array(), 'name' => 'ProfileGroup', 'scope' => 'ProfileGroups', 'required' => FALSE, 'idNameFields' => array('id', 'title'), 'idNameMap' => array(), ), 'profileField' => array( 'data' => array(), 'name' => 'ProfileField', 'scope' => 'ProfileFields', 'required' => FALSE, 'idNameMap' => array(), 'mappedFields' => array( array('profileGroup', 'uf_group_id', 'profile_group_name'), ), ), 'profileJoin' => array( 'data' => array(), 'name' => 'ProfileJoin', 'scope' => 'ProfileJoins', 'required' => FALSE, 'idNameMap' => array(), 'mappedFields' => array( array('profileGroup', 'uf_group_id', 'profile_group_name'), ), ), 'mappingGroup' => array( 'data' => array(), 'name' => 'MappingGroup', 'scope' => 'MappingGroups', 'required' => FALSE, 'idNameFields' => array('id', 'name'), 'idNameMap' => array(), 'mappedFields' => array( array('optionValue', 'mapping_type_id', 'mapping_type_name', 'mapping_type'), ), ), 'mappingField' => array( 'data' => array(), 'name' => 'MappingField', 'scope' => 'MappingFields', 'required' => FALSE, 'idNameMap' => array(), 'mappedFields' => array( array('mappingGroup', 'mapping_id', 'mapping_group_name'), array('locationType', 'location_type_id', 'location_type_name'), array('relationshipType', 'relationship_type_id', 'relationship_type_name'), ), ), ); } /** * Scan local customizations and build an in-memory representation. */ public function build() { // fetch the option group / values for // activity type and event_type $optionGroups = "( 'activity_type', 'event_type', 'mapping_type' )"; $sql = " 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 "; $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 "; $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 "; $this->fetch('optionValue', 'CRM_Core_DAO_OptionValue', $sql); $sql = " 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 "; $this->fetch('locationType', 'CRM_Core_DAO_LocationType', $sql); $sql = " 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 "; $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 "; $this->fetch('profileJoin', 'CRM_Core_DAO_UFJoin', $sql); $this->fetch('mappingGroup', 'CRM_Core_DAO_Mapping'); $this->fetch('mappingField', 'CRM_Core_DAO_MappingField'); } /** * Build custom groups. * * @param array $customGroupIds * List of custom groups to export. */ public 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. */ public 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 * * @return string * XML */ public function toXML() { $buffer = ''; $buffer .= "\n\n\n"; foreach (array_keys($this->_xml) as $key) { if (!empty($this->_xml[$key]['data'])) { $buffer .= " <{$this->_xml[$key]['scope']}>\n"; foreach ($this->_xml[$key]['data'] as $item) { $buffer .= $this->renderKeyValueXML($this->_xml[$key]['name'], $item); } $buffer .= " _xml[$key]['scope']}>\n"; } elseif ($this->_xml[$key]['required']) { CRM_Core_Error::fatal("No records in DB for $key"); } } $buffer .= "\n"; return $buffer; } /** * Generate an array-tree representation of the exported elements. * * @return array */ public 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; } /** * @param string $groupName * @param string $daoName * @param null $sql */ public function fetch($groupName, $daoName, $sql = 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) { $dao->query($sql); } else { $dao->find(); } while ($dao->fetch()) { $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]['idNameMap'][$dao->{$idNameFields[0]}] = $dao->{$idNameFields[1]}; } } } } /** * 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 * The entity for which we want to prepare mapped fields. * @return array * new fields */ 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]]['idNameMap']["{$mappedField[3]}." . $dao->{$mappedField[1]}]; } else { $label = $this->_xml[$mappedField[0]]['idNameMap'][$dao->{$mappedField[1]}]; } $keyValues[$mappedField[2]] = $label; } } } return $keyValues; } /** * @param string $objectName * Business-entity/xml-tag name. * @param CRM_Core_DAO $object * @param $mappedFields * * @return array */ public function exportDAO($objectName, $object, $mappedFields) { $dbFields = &$object->fields(); // 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') { continue; } if (isset($object->$name) && $object->$name !== NULL) { // hack for extends_entity_column_value if ($name == 'extends_entity_column_value') { if (in_array($object->extends, array( 'Event', 'Activity', 'Relationship', 'Individual', 'Organization', 'Household', 'Case', ))) { if ($object->extends == 'Event') { $key = 'event_type'; } elseif ($object->extends == 'Activity') { $key = 'activity_type'; } elseif ($object->extends == 'Relationship') { $key = 'relationship_type'; } elseif ($object->extends == 'Case') { $key = 'case_type'; } $types = explode(CRM_Core_DAO::VALUE_SEPARATOR, substr($object->$name, 1, -1)); $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', 'case_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); $object->extends_entity_column_value = $value; } else { echo "This extension: {$object->extends} is not yet handled"; exit(); } } $value = $object->$name; if ($name == 'field_name') { // hack for profile field_name if (substr($value, 0, 7) == 'custom_') { $cfID = substr($value, 7); list($tableName, $columnName, $groupID) = CRM_Core_BAO_CustomField::getTableColumnGroup($cfID); $value = "custom.{$tableName}.{$columnName}"; } } $keyValues[$name] = $value; } } $keyValues += $this->computeMappedFields($mappedFields, $object); return $keyValues; } /** * @param string $tagName * @param array $keyValues * @throws Exception * @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 \n"; return $xml; } /** * @param string $name * Tag name. * @param string $value * Text. * @param string $prefix * * @throws Exception * @return string * XML */ public function renderTextTag($name, $value, $prefix = '') { if (!preg_match('/^[a-zA-Z0-9\_]+$/', $name)) { throw new Exception("Malformed tag name: $name"); } return $prefix . "<$name>" . htmlentities($value) . ""; } }