Role.php

Same filename in this branch
  1. 11.x core/modules/user/src/Entity/Role.php
  2. 11.x core/modules/user/src/Plugin/views/access/Role.php
  3. 11.x core/modules/user/src/Plugin/migrate/source/d7/Role.php
Same filename in other branches
  1. 9 core/modules/user/src/Entity/Role.php
  2. 9 core/modules/user/src/Plugin/views/access/Role.php
  3. 9 core/modules/user/src/Plugin/migrate/source/d6/Role.php
  4. 9 core/modules/user/src/Plugin/migrate/source/d7/Role.php
  5. 8.9.x core/modules/user/src/Entity/Role.php
  6. 8.9.x core/modules/user/src/Plugin/views/access/Role.php
  7. 8.9.x core/modules/user/src/Plugin/migrate/source/d6/Role.php
  8. 8.9.x core/modules/user/src/Plugin/migrate/source/d7/Role.php
  9. 10 core/modules/user/src/Entity/Role.php
  10. 10 core/modules/user/src/Plugin/views/access/Role.php
  11. 10 core/modules/user/src/Plugin/migrate/source/d6/Role.php
  12. 10 core/modules/user/src/Plugin/migrate/source/d7/Role.php

Namespace

Drupal\user\Plugin\migrate\source\d6

File

core/modules/user/src/Plugin/migrate/source/d6/Role.php

View source
<?php

namespace Drupal\user\Plugin\migrate\source\d6;

use Drupal\migrate\Row;
use Drupal\migrate_drupal\Plugin\migrate\source\DrupalSqlBase;

/**
 * Drupal 6 role source from database.
 *
 * For available configuration keys, refer to the parent classes.
 *
 * @see \Drupal\migrate\Plugin\migrate\source\SqlBase
 * @see \Drupal\migrate\Plugin\migrate\source\SourcePluginBase
 *
 * @MigrateSource(
 *   id = "d6_user_role",
 *   source_module = "user"
 * )
 */
class Role extends DrupalSqlBase {
    
    /**
     * List of filter IDs per role IDs.
     *
     * @var array
     */
    protected $filterPermissions = [];
    
    /**
     * {@inheritdoc}
     */
    public function query() {
        $query = $this->select('role', 'r')
            ->fields('r', [
            'rid',
            'name',
        ])
            ->orderBy('r.rid');
        return $query;
    }
    
    /**
     * {@inheritdoc}
     */
    public function fields() {
        return [
            'rid' => $this->t('Role ID.'),
            'name' => $this->t('The name of the user role.'),
        ];
    }
    
    /**
     * {@inheritdoc}
     */
    protected function initializeIterator() {
        $filter_roles = $this->select('filter_formats', 'f')
            ->fields('f', [
            'format',
            'roles',
        ])
            ->execute()
            ->fetchAllKeyed();
        foreach ($filter_roles as $format => $roles) {
            // Drupal 6 code: $roles = ','. implode(',', $roles) .',';
            // Remove the beginning and ending comma.
            foreach (explode(',', trim($roles, ',')) as $rid) {
                $this->filterPermissions[$rid][] = $format;
            }
        }
        return parent::initializeIterator();
    }
    
    /**
     * {@inheritdoc}
     */
    public function prepareRow(Row $row) {
        $rid = $row->getSourceProperty('rid');
        $permissions = $this->select('permission', 'p')
            ->fields('p', [
            'perm',
        ])
            ->condition('rid', $rid)
            ->execute()
            ->fetchField();
        // If a role has no permissions then set to an empty array. The role will
        // be migrated and given the default D8 permissions.
        if ($permissions) {
            $row->setSourceProperty('permissions', explode(', ', $permissions));
        }
        else {
            $row->setSourceProperty('permissions', []);
        }
        if (isset($this->filterPermissions[$rid])) {
            $row->setSourceProperty("filter_permissions:{$rid}", $this->filterPermissions[$rid]);
        }
        return parent::prepareRow($row);
    }
    
    /**
     * {@inheritdoc}
     */
    public function getIds() {
        $ids['rid']['type'] = 'integer';
        return $ids;
    }

}

Classes

Title Deprecated Summary
Role Drupal 6 role source from database.

Buggy or inaccurate documentation? Please file an issue. Need support? Need help programming? Connect with the Drupal community.