summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorandrew morton2011-10-25 15:16:39 (GMT)
committer Mike Ryan2011-11-07 21:45:54 (GMT)
commit135ebf13e0757ad1b97756d902f185be3a6052db (patch)
tree5535b2c6107e995bc735356677a36832eb19ada6
parentf10ece99f24838e09f8f5608ef54ba640fb5488b (diff)
Issue #1321062 by drewish: Followup to improve the documentation of MigrateSimpleFieldHandler.
-rwxr-xr-xplugins/destinations/fields.inc19
1 files changed, 10 insertions, 9 deletions
diff --git a/plugins/destinations/fields.inc b/plugins/destinations/fields.inc
index 08d8e68..e453ad5 100755
--- a/plugins/destinations/fields.inc
+++ b/plugins/destinations/fields.inc
@@ -101,17 +101,18 @@ abstract class MigrateFieldHandler extends MigrateHandler {
}
/**
- * Base class to provide simplify creating field handlers for fields with a
- * single value.
+ * Base class for creating field handlers for fields with a single value.
*
- * To use it just extend it and pass the field types and value to the parent
- * constructor:
- *
- * class MigrateEmailFieldHandler extends MigrateSimpleFieldHandler {
- * public function __construct() {
- * parent::__construct(array('link'), 'url');
+ * To use this class just extend it and pass key where the field's value should
+ * be stored to the constructor, then register the type(s):
+ * @code
+ * class MigrateLinkFieldHandler extends MigrateSimpleFieldHandler {
+ * public function __construct() {
+ * parent::__construct('url');
+ * $this->registerTypes(array('link'));
+ * }
* }
- * }
+ * @endcode
*/
abstract class MigrateSimpleFieldHandler extends MigrateFieldHandler {
protected $fieldValueKey = 'value';