From 18315de9695ab454a6ac527b80ecd28e82e54380 Mon Sep 17 00:00:00 2001 From: Tim Otten Date: Thu, 16 May 2013 19:33:32 -0400 Subject: [PATCH] CRM_Utils_Migrate_Export - Doc comment --- CRM/Utils/Migrate/Export.php | 14 ++++++++++++++ 1 file changed, 14 insertions(+) diff --git a/CRM/Utils/Migrate/Export.php b/CRM/Utils/Migrate/Export.php index 9105b80f77..f713554357 100644 --- a/CRM/Utils/Migrate/Export.php +++ b/CRM/Utils/Migrate/Export.php @@ -36,6 +36,20 @@ class CRM_Utils_Migrate_Export { 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() { -- 2.25.1