class ProfileField in Drupal 10

Same name and namespace in other branches

8 core/modules/user/src/Plugin/migrate/source/ProfileField.php \Drupal\user\Plugin\migrate\source\ProfileField
9 core/modules/user/src/Plugin/migrate/source/ProfileField.php \Drupal\user\Plugin\migrate\source\ProfileField

Drupal 6/7 profile field source from database.

For available configuration keys, refer to the parent classes.

Plugin annotation


@MigrateSource(
  id = "profile_field",
  source_module = "profile"
)

Hierarchy

class \Drupal\Component\Plugin\PluginBase implements DerivativeInspectionInterface, PluginInspectionInterface
- class \Drupal\Core\Plugin\PluginBase uses DependencySerializationTrait, MessengerTrait, StringTranslationTrait
  - class \Drupal\migrate\Plugin\migrate\source\SourcePluginBase implements RollbackAwareInterface, MigrateSourceInterface
    class \Drupal\migrate\Plugin\migrate\source\SqlBase implements ContainerFactoryPluginInterface, RequirementsInterface
    class \Drupal\migrate_drupal\Plugin\migrate\source\DrupalSqlBase implements DependentPluginInterface uses DependencyTrait
    class \Drupal\user\Plugin\migrate\source\ProfileField

Expanded class hierarchy of ProfileField

File

core/modules/user/src/Plugin/migrate/source/ProfileField.php, line 22

Namespace

Drupal\user\Plugin\migrate\source

View source

class ProfileField extends DrupalSqlBase {

  /**
   * The source table containing profile field info.
   *
   * @var string
   */
  protected $fieldTable;

  /**
   * The source table containing the profile values.
   *
   * @var string
   */
  protected $valueTable;

  /**
   * {@inheritdoc}
   */
  public function query() {
    $this
      ->setTableNames();
    return $this
      ->select($this->fieldTable, 'pf')
      ->fields('pf');
  }

  /**
   * {@inheritdoc}
   */
  public function prepareRow(Row $row) {
    if ($row
      ->getSourceProperty('type') == 'selection') {

      // Get the current options.
      $current_options = preg_split("/[\r\n]+/", $row
        ->getSourceProperty('options'));

      // Select the list values from the profile_values table to ensure we get
      // them all since they can get out of sync with profile_fields.
      $options = $this
        ->select($this->valueTable, 'pv')
        ->distinct()
        ->fields('pv', [
        'value',
      ])
        ->condition('fid', $row
        ->getSourceProperty('fid'))
        ->execute()
        ->fetchCol();
      $options = array_merge($current_options, $options);

      // array_combine() takes care of any duplicates options.
      $row
        ->setSourceProperty('options', array_combine($options, $options));
    }
    if ($row
      ->getSourceProperty('type') == 'checkbox') {

      // D6 profile checkboxes values are always 0 or 1 (with no labels), so we
      // need to create two label-less options that will get 0 and 1 for their
      // keys.
      $row
        ->setSourceProperty('options', [
        NULL,
        NULL,
      ]);
    }
    return parent::prepareRow($row);
  }

  /**
   * {@inheritdoc}
   */
  public function fields() {
    return [
      'fid' => $this
        ->t('Primary Key: Unique profile field ID.'),
      'title' => $this
        ->t('Title of the field shown to the end user.'),
      'name' => $this
        ->t('Internal name of the field used in the form HTML and URLs.'),
      'explanation' => $this
        ->t('Explanation of the field to end users.'),
      'category' => $this
        ->t('Profile category that the field will be grouped under.'),
      'page' => $this
        ->t("Title of page used for browsing by the field's value"),
      'type' => $this
        ->t('Type of form field.'),
      'weight' => $this
        ->t('Weight of field in relation to other profile fields.'),
      'required' => $this
        ->t('Whether the user is required to enter a value. (0 = no, 1 = yes)'),
      'register' => $this
        ->t('Whether the field is visible in the user registration form. (1 = yes, 0 = no)'),
      'visibility' => $this
        ->t('The level of visibility for the field. (0 = hidden, 1 = private, 2 = public on profile but not member list pages, 3 = public on profile and list pages)'),
      'autocomplete' => $this
        ->t('Whether form auto-completion is enabled. (0 = disabled, 1 = enabled)'),
      'options' => $this
        ->t('List of options to be used in a list selection field.'),
    ];
  }

  /**
   * {@inheritdoc}
   */
  public function getIds() {
    $ids['fid']['type'] = 'integer';
    return $ids;
  }

  /**
   * {@inheritdoc}
   */
  public function checkRequirements() {
    $this
      ->setTableNames();
    if (!$this
      ->getDatabase()
      ->schema()
      ->tableExists($this->fieldTable)) {

      // If we make it to here, the profile module isn't installed.
      throw new RequirementsException('Profile module not enabled on source site');
    }
    parent::checkRequirements();
  }

  /**
   * Helper to set the profile field table names.
   */
  protected function setTableNames() {
    if (empty($this->fieldTable) || empty($this->valueTable)) {
      if ($this
        ->getModuleSchemaVersion('system') >= 7000) {
        $this->fieldTable = 'profile_field';
        $this->valueTable = 'profile_value';
      }
      else {
        $this->fieldTable = 'profile_fields';
        $this->valueTable = 'profile_values';
      }
    }
  }

}

Members

Name	Modifiers	Type	Description	Overrides
DependencySerializationTrait::$_entityStorages	protected	property
DependencySerializationTrait::$_serviceIds	protected	property
DependencySerializationTrait::__wakeup	public	function		2
DependencyTrait::$dependencies	protected	property	The object's dependencies.
DependencyTrait::addDependencies	protected	function	Adds multiple dependencies.
DependencyTrait::addDependency	protected	function	Adds a dependency.
DrupalSqlBase::$entityTypeManager	protected	property	The entity type manager.
DrupalSqlBase::$requirements	protected	property	If the source provider is missing.
DrupalSqlBase::$systemData	protected	property	The contents of the system table.
DrupalSqlBase::calculateDependencies	public	function	Calculates dependencies for the configured plugin. Overrides DependentPluginInterface::calculateDependencies
DrupalSqlBase::create	public static	function	Creates an instance of the plugin. Overrides SqlBase::create	2
DrupalSqlBase::getModuleSchemaVersion	protected	function	Retrieves a module schema_version from the source Drupal database.
DrupalSqlBase::getSystemData	public	function	Retrieves all system data information from the source Drupal database.
DrupalSqlBase::moduleExists	protected	function	Checks if a given module is enabled in the source Drupal database.
DrupalSqlBase::variableGet	protected	function	Reads a variable from a source Drupal database.
DrupalSqlBase::__construct	public	function	Constructs a \Drupal\Component\Plugin\PluginBase object. Overrides SqlBase::__construct	5
MessengerTrait::$messenger	protected	property	The messenger.	18
MessengerTrait::messenger	public	function	Gets the messenger.	18
MessengerTrait::setMessenger	public	function	Sets the messenger.
MigrateSourceInterface::NOT_COUNTABLE		constant	Indicates that the source is not countable.
PluginBase::$configuration	protected	property	Configuration information passed into the plugin.	1
PluginBase::$pluginDefinition	protected	property	The plugin implementation definition.
PluginBase::$pluginId	protected	property	The plugin_id.
PluginBase::DERIVATIVE_SEPARATOR		constant	A string which is used to separate base plugin IDs from the derivative ID.
PluginBase::getBaseId	public	function
PluginBase::getDerivativeId	public	function
PluginBase::getPluginDefinition	public	function		2
PluginBase::getPluginId	public	function
PluginBase::isConfigurable	public	function	Determines if the plugin is configurable.
ProfileField::$fieldTable	protected	property	The source table containing profile field info.
ProfileField::$valueTable	protected	property	The source table containing the profile values.
ProfileField::checkRequirements	public	function	Checks if requirements for this plugin are OK. Overrides DrupalSqlBase::checkRequirements
ProfileField::fields	public	function	Returns available fields on the source. Overrides MigrateSourceInterface::fields	2
ProfileField::getIds	public	function	Defines the source fields uniquely identifying a source row. Overrides MigrateSourceInterface::getIds	2
ProfileField::prepareRow	public	function	Adds additional data to the row. Overrides SourcePluginBase::prepareRow
ProfileField::query	public	function	Overrides SqlBase::query	2
ProfileField::setTableNames	protected	function	Helper to set the profile field table names.
SourcePluginBase::$cache	protected	property	The backend cache.
SourcePluginBase::$cacheCounts	protected	property	Whether this instance should cache the source count.	1
SourcePluginBase::$cacheKey	protected	property	Key to use for caching counts.
SourcePluginBase::$currentRow	protected	property	The current row from the query.
SourcePluginBase::$currentSourceIds	protected	property	The primary key of the current row.
SourcePluginBase::$highWaterProperty	protected	property	Information on the property used as the high-water mark.
SourcePluginBase::$highWaterStorage	protected	property	The key-value storage for the high-water value.
SourcePluginBase::$idMap	protected	property	The migration ID map.
SourcePluginBase::$iterator	protected	property	The iterator to iterate over the source rows.
SourcePluginBase::$mapRowAdded	protected	property	Flags whether source plugin will read the map row and add to data row.
SourcePluginBase::$migration	protected	property	The entity migration object.
SourcePluginBase::$moduleHandler	protected	property	The module handler service.	2
SourcePluginBase::$originalHighWater	protected	property	The high water mark at the beginning of the import operation.
SourcePluginBase::$skipCount	protected	property	Whether this instance should not attempt to count the source.	1
SourcePluginBase::$trackChanges	protected	property	Flags whether to track changes to incoming data.	1
SourcePluginBase::aboveHighWater	protected	function	Check if the incoming data is newer than what we've previously imported.
SourcePluginBase::count	public	function		2
SourcePluginBase::current	public	function
SourcePluginBase::getCache	protected	function	Gets the cache object.
SourcePluginBase::getCurrentIds	public	function	Gets the currentSourceIds data member.
SourcePluginBase::getHighWater	protected	function	The current value of the high water mark.
SourcePluginBase::getHighWaterField	protected	function	Get the name of the field used as the high watermark.
SourcePluginBase::getHighWaterProperty	protected	function	Get information on the property used as the high watermark.
SourcePluginBase::getHighWaterStorage	protected	function	Get the high water storage object.
SourcePluginBase::getIterator	protected	function	Returns the iterator that will yield the row arrays to be processed.
SourcePluginBase::getModuleHandler	protected	function	Gets the module handler.
SourcePluginBase::getSourceModule	public	function	Gets the source module providing the source data. Overrides MigrateSourceInterface::getSourceModule
SourcePluginBase::key	public	function
SourcePluginBase::next	public	function
SourcePluginBase::postRollback	public	function	Performs post-rollback tasks. Overrides RollbackAwareInterface::postRollback
SourcePluginBase::preRollback	public	function	Performs pre-rollback tasks. Overrides RollbackAwareInterface::preRollback
SourcePluginBase::rewind	public	function
SourcePluginBase::rowChanged	protected	function	Checks if the incoming row has changed since our last import.
SourcePluginBase::saveHighWater	protected	function	Save the new high water mark.
SourcePluginBase::valid	public	function
SqlBase::$batch	protected	property	The count of the number of batches run.
SqlBase::$batchSize	protected	property	Number of records to fetch from the database during each batch.
SqlBase::$database	protected	property	The database object.	1
SqlBase::$query	protected	property	The query string.	82
SqlBase::$state	protected	property	State service for retrieving database info.
SqlBase::doCount	protected	function	Gets the source count using countQuery(). Overrides SourcePluginBase::doCount	6
SqlBase::fetchNextBatch	protected	function	Prepares query for the next set of data from the source database.
SqlBase::fetchNextRow	protected	function	Position the iterator to the following row. Overrides SourcePluginBase::fetchNextRow
SqlBase::getDatabase	public	function	Gets the database connection object.	2
SqlBase::initializeIterator	protected	function	Initializes the iterator with the source data. Overrides SourcePluginBase::initializeIterator	18
SqlBase::mapJoinable	protected	function	Checks if we can join against the map table.	1
SqlBase::prepareQuery	protected	function	Adds tags and metadata to the query.
SqlBase::select	protected	function	Wrapper for database select.
SqlBase::setUpDatabase	protected	function	Gets a connection to the referenced database.
SqlBase::__sleep	public	function	Overrides DependencySerializationTrait::__sleep
SqlBase::__toString	public	function	Prints the query string when the object is used as a string. Overrides MigrateSourceInterface::__toString
StringTranslationTrait::$stringTranslation	protected	property	The string translation service.	3
StringTranslationTrait::formatPlural	protected	function	Formats a string containing a count of items.
StringTranslationTrait::getNumberOfPlurals	protected	function	Returns the number of plurals supported by a given language.
StringTranslationTrait::getStringTranslation	protected	function	Gets the string translation service.
StringTranslationTrait::setStringTranslation	public	function	Sets the string translation service to use.	1
StringTranslationTrait::t	protected	function	Translates a string to the current language or to a given language.

You are here

class ProfileField in Drupal 10

Plugin annotation

Hierarchy

See also

File

Namespace

Members

API Navigation