From 576df278e4080383b05d7c440518e4ff1e521d42 Mon Sep 17 00:00:00 2001 From: andrew morton Date: Tue, 25 Oct 2011 11:16:39 -0400 Subject: [PATCH] Issue #1321062 by drewish: Followup to improve the documentation of MigrateSimpleFieldHandler. --- plugins/destinations/fields.inc | 19 ++++++++++--------- 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'; -- 1.7.0.4