class UserCreate in CiviCRM Entity 8.3

Provides a 'User create' action.

Plugin annotation


@RulesAction(
  id = "civicrm_entity_user_create",
  label = @Translation("Create linked drupal user account"),
  category = @Translation("CiviCRM"),
  context = {
     "contact_id" = @ContextDefinition("integer",
       label = @Translation("CiviCRM contact ID"),
       description = @Translation("The CiviCRM contact ID."),
       required = TRUE
     ),
     "is_active" = @ContextDefinition("boolean",
       label = @Translation("Activate account"),
       description = @Translation("Set to TRUE to activate account. Leave empty to not activate the account. Defaults to TRUE."),
       assignment_restriction = "input",
       default_value = TRUE,
       required = FALSE
     ),
     "notify" = @ContextDefinition("boolean",
       label = @Translation("Send account notification email"),
       description = @Translation("Set to TRUE to send a notification email. Leave empty to not send an account notification email."),
       assignment_restriction = "input",
       default_value = TRUE,
       required = FALSE
     ),
     "signin" = @ContextDefinition("boolean",
       label = @Translation("Instant signin"),
       description = @Translation("Set to TRUE to automatically log in the user. Leave empty to not automatically log in the user."),
       assignment_restriction = "input",
       default_value = TRUE,
       required = FALSE
     ),
     "format" = @ContextDefinition("string",
       label = @Translation("Format"),
       description = @Translation("Format of the username."),
     )
  },
  provides = {
    "civicrm_user" = @ContextDefinition("entity:user",
      label = @Translation("Created Drupal user")
    )
  }
)

Hierarchy

class \Drupal\Component\Plugin\PluginBase implements DerivativeInspectionInterface, PluginInspectionInterface
- class \Drupal\Component\Plugin\ContextAwarePluginBase implements ContextAwarePluginInterface
  - class \Drupal\Core\Plugin\ContextAwarePluginBase implements CacheableDependencyInterface, ContextAwarePluginInterface uses DependencySerializationTrait, StringTranslationTrait, TypedDataTrait
    class \Drupal\rules\Core\RulesActionBase implements RulesActionInterface uses ContextProviderTrait, ConfigurationAccessControlTrait, ExecutablePluginTrait
    class \Drupal\civicrm_entity\Plugin\RulesAction\UserCreate implements ContainerFactoryPluginInterface

Expanded class hierarchy of UserCreate

File

src/Plugin/RulesAction/UserCreate.php, line 59

Namespace

Drupal\civicrm_entity\Plugin\RulesAction

View source

class UserCreate extends RulesActionBase implements ContainerFactoryPluginInterface {

  /**
   * The CiviCRM contact storage service.
   *
   * @var \Drupal\civicrm_entity\CiviEntityStorage
   */
  protected $contactStorage;

  /**
   * The user storage service.
   *
   * @var \Drupal\user\UserStorageInterface
   */
  protected $userStorage;

  /**
   * The messenger service.
   *
   * @var \Drupal\Core\Messenger\MessengerInterface
   */
  protected $messenger;

  /**
   * The CiviCRM API service.
   *
   * @var \Drupal\civicrm_entity\CiviCrmApiInterface
   */
  protected $civicrmApi;

  /**
   * {@inheritdoc}
   */
  public function __construct(array $configuration, $plugin_id, $plugin_definition, CiviEntityStorage $contact_storage, UserStorageInterface $user_storage, MessengerInterface $messenger, CiviCrmApiInterface $civicrm_api) {
    parent::__construct($configuration, $plugin_id, $plugin_definition);
    $this->contactStorage = $contact_storage;
    $this->userStorage = $user_storage;
    $this->messenger = $messenger;
    $this->civicrmApi = $civicrm_api;
  }

  /**
   * {@inheritdoc}
   */
  public static function create(ContainerInterface $container, array $configuration, $plugin_id, $plugin_definition) {
    return new static($configuration, $plugin_id, $plugin_definition, $container
      ->get('entity_type.manager')
      ->getStorage('civicrm_contact'), $container
      ->get('entity_type.manager')
      ->getStorage('user'), $container
      ->get('messenger'), $container
      ->get('civicrm_entity.api'));
  }

  /**
   * {@inheritdoc}
   */
  public function doExecute($contact_id, $is_active, $notify, $signin, $format) {
    $contact = $this->civicrmApi
      ->getSingle('Contact', [
      'return' => [
        'email',
        'contact_type',
      ],
      'id' => $contact_id,
    ]);
    if (empty($contact) || empty($contact['email'])) {
      return;
    }
    $params = [
      'name' => $format,
      'mail' => $contact['email'],
      'init' => $contact['email'],
      'status' => (bool) $is_active,
    ];
    $this->civicrmApi
      ->civicrmInitialize();
    $config = \CRM_Core_Config::singleton();
    if ($this
      ->checkUserNameExists($params, $config->userSystem)) {
      $counter = 0;
      do {
        $params['name'] = $params['name'] . '_' . $counter++;
      } while ($this
        ->checkUserNameExists($params, $config->userSystem));
    }

    /** @var \Drupal\user\UserInterface $user */
    $user = $this->userStorage
      ->create($params);
    $violations = $user
      ->validate()
      ->getByFields(array_keys($params));
    if ($violations
      ->count() > 0) {
      $messages = 'Unable to create user for %email due to the following error(s):<ul>';

      /** @var \Symfony\Component\Validator\ConstraintViolation $violation */
      foreach ($violations as $violation) {
        $messages .= '<li>' . $violation
          ->getMessage() . '</li>';
      }
      $messages .= '</ul>';
      \Drupal::logger('civicrm_entity')
        ->error($messages, [
        '%email' => $params['mail'],
      ]);
    }
    if ($violations
      ->count() === 0 && $user
      ->save()) {
      $this->civicrmApi
        ->civicrmInitialize();
      if ($contact['contact_type'] === 'Individual') {
        \CRM_Core_BAO_UFMatch::synchronizeUFMatch($user, $user
          ->id(), $contact['email'], 'Drupal8', NULL, 'Individual', TRUE);
      }
      else {
        \CRM_Core_BAO_UFMatch::synchronizeUFMatch($user, $user
          ->id(), $contact['email'], 'Drupal8', NULL, NULL, TRUE);
      }
      $this->messenger
        ->addStatus($this
        ->t('User with username @name has been created.', [
        '@name' => $user
          ->getUsername(),
      ]));
      $this
        ->setProvidedValue('civicrm_user', $user);
      if ((bool) $signin) {
        user_login_finalize($user);
      }
      if ((bool) $notify) {
        _user_mail_notify('register_no_approval_required', $user);
      }
    }
  }

  /**
   * Check if username exists.
   *
   * @param array $params
   *   The parameters.
   * @param \CRM_Utils_System_Base $userSystem
   *   The user system.
   *
   * @return boolean
   *   TRUE if username exists; otherwise FALSE.
   */
  protected function checkUserNameExists(array $params, \CRM_Utils_System_Base $userSystem) {
    $errors = [];
    $userSystem
      ->checkUserNameEmailExists($params, $errors);
    return isset($errors['cms_name']);
  }

}

Members

Name	Modifiers	Type	Description	Overrides
ConfigurationAccessControlTrait::checkConfigurationAccess	public	function	Checks configuration permission.
ContextAwarePluginBase::$context	protected	property	The data objects representing the context of this plugin.
ContextAwarePluginBase::$contexts Deprecated	private	property	Data objects representing the contexts passed in the plugin configuration.
ContextAwarePluginBase::contextHandler	protected	function	Wraps the context handler.
ContextAwarePluginBase::createContextFromConfiguration	protected	function	Overrides ContextAwarePluginBase::createContextFromConfiguration
ContextAwarePluginBase::getCacheContexts	public	function	The cache contexts associated with this object. Overrides CacheableDependencyInterface::getCacheContexts	9
ContextAwarePluginBase::getCacheMaxAge	public	function	The maximum age for which this object may be cached. Overrides CacheableDependencyInterface::getCacheMaxAge	7
ContextAwarePluginBase::getCacheTags	public	function	The cache tags associated with this object. Overrides CacheableDependencyInterface::getCacheTags	4
ContextAwarePluginBase::getContext	public	function	This code is identical to the Component in order to pick up a different Context class. Overrides ContextAwarePluginBase::getContext
ContextAwarePluginBase::getContextDefinition	public	function	Overrides ContextAwarePluginBase::getContextDefinition
ContextAwarePluginBase::getContextDefinitions	public	function	Overrides ContextAwarePluginBase::getContextDefinitions
ContextAwarePluginBase::getContextMapping	public	function	Gets a mapping of the expected assignment names to their context names. Overrides ContextAwarePluginInterface::getContextMapping
ContextAwarePluginBase::getContexts	public	function	Gets the defined contexts. Overrides ContextAwarePluginInterface::getContexts
ContextAwarePluginBase::getContextValues	public	function	Gets the values for all defined contexts. Overrides ContextAwarePluginInterface::getContextValues
ContextAwarePluginBase::setContext	public	function	Set a context on this plugin. Overrides ContextAwarePluginBase::setContext
ContextAwarePluginBase::setContextMapping	public	function	Sets a mapping of the expected assignment names to their context names. Overrides ContextAwarePluginInterface::setContextMapping
ContextAwarePluginBase::setContextValue	public	function	Sets the value for a defined context. Overrides ContextAwarePluginBase::setContextValue
ContextAwarePluginBase::validateContexts	public	function	Validates the set values for the defined contexts. Overrides ContextAwarePluginInterface::validateContexts
ContextAwarePluginBase::__get	public	function	Implements magic __get() method.
ContextProviderTrait::$providedContext	protected	property	The data objects that are provided by this plugin.
ContextProviderTrait::getProvidedContext	public	function
ContextProviderTrait::getProvidedContextDefinition	public	function
ContextProviderTrait::getProvidedContextDefinitions	public	function
ContextProviderTrait::setProvidedValue	public	function
DependencySerializationTrait::$_entityStorages	protected	property	An array of entity type IDs keyed by the property name of their storages.
DependencySerializationTrait::$_serviceIds	protected	property	An array of service IDs keyed by property name used for serialization.
DependencySerializationTrait::__sleep	public	function		1
DependencySerializationTrait::__wakeup	public	function		2
ExecutablePluginTrait::getLabelValue	protected	function	Get the translated label from the plugin definition.
ExecutablePluginTrait::summary	public	function	Get the translated summary from the label annotation.	4
PluginBase::$pluginDefinition	protected	property	The plugin implementation definition.	1
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	Gets the base_plugin_id of the plugin instance. Overrides DerivativeInspectionInterface::getBaseId
PluginBase::getDerivativeId	public	function	Gets the derivative_id of the plugin instance. Overrides DerivativeInspectionInterface::getDerivativeId
PluginBase::getPluginDefinition	public	function	Gets the definition of the plugin implementation. Overrides PluginInspectionInterface::getPluginDefinition	3
PluginBase::getPluginId	public	function	Gets the plugin_id of the plugin instance. Overrides PluginInspectionInterface::getPluginId
PluginBase::isConfigurable	public	function	Determines if the plugin is configurable.
RulesActionBase::$configuration	protected	property	The plugin configuration. Overrides PluginBase::$configuration
RulesActionBase::access	public	function	Checks object access. Overrides RulesActionInterface::access
RulesActionBase::assertMetadata	public	function	Asserts additional metadata for the selected data. Overrides ContextAwarePluginInterface::assertMetadata
RulesActionBase::autoSaveContext	public	function	Returns a list of context names that should be auto-saved after execution. Overrides RulesActionInterface::autoSaveContext	14
RulesActionBase::calculateDependencies	public	function	@todo this documentation is not actually inherited from any interface. Do we need this empty implementation?
RulesActionBase::defaultConfiguration	public	function	@todo this documentation is not actually inherited from any interface. Do we need this empty implementation?
RulesActionBase::execute	public	function	Executes the plugin. Overrides ExecutableInterface::execute	2
RulesActionBase::executeMultiple	public	function	@todo this documentation is not actually inherited from any interface. Do we need this empty implementation?
RulesActionBase::getConfiguration	public	function	@todo this documentation is not actually inherited from any interface.
RulesActionBase::getContextValue	public	function	Gets the value for a defined context. Overrides ContextAwarePluginBase::getContextValue
RulesActionBase::refineContextDefinitions	public	function	Refines used and provided context definitions based upon context values. Overrides ContextAwarePluginInterface::refineContextDefinitions	5
RulesActionBase::setConfiguration	public	function	@todo this documentation is not actually inherited from any interface.
StringTranslationTrait::$stringTranslation	protected	property	The string translation service.	1
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.	2
StringTranslationTrait::t	protected	function	Translates a string to the current language or to a given language.
TypedDataTrait::$typedDataManager	protected	property	The typed data manager used for creating the data types.
TypedDataTrait::getTypedDataManager	public	function	Gets the typed data manager.	2
TypedDataTrait::setTypedDataManager	public	function	Sets the typed data manager.	2
UserCreate::$civicrmApi	protected	property	The CiviCRM API service.
UserCreate::$contactStorage	protected	property	The CiviCRM contact storage service.
UserCreate::$messenger	protected	property	The messenger service.
UserCreate::$userStorage	protected	property	The user storage service.
UserCreate::checkUserNameExists	protected	function	Check if username exists.
UserCreate::create	public static	function	Creates an instance of the plugin. Overrides ContainerFactoryPluginInterface::create
UserCreate::doExecute	public	function
UserCreate::__construct	public	function	Overrides \Drupal\Component\Plugin\PluginBase::__construct(). Overrides ContextAwarePluginBase::__construct

You are here

class UserCreate in CiviCRM Entity 8.3

Plugin annotation

Hierarchy

File

Namespace

Members

API Navigation