SetUserCountry.php in IP-based Determination of a Visitor's Country 8

Namespace

Drupal\ip2country\Plugin\RulesAction

File

src/Plugin/RulesAction/SetUserCountry.php

<?php

namespace Drupal\ip2country\Plugin\RulesAction;

use Drupal\Core\Plugin\ContainerFactoryPluginInterface;
use Drupal\Core\Session\AccountInterface;
use Drupal\rules\Core\RulesActionBase;
use Drupal\user\UserDataInterface;
use Drupal\user\Entity\User;
use Symfony\Component\DependencyInjection\ContainerInterface;

/**
 * Provides an 'Add a country_iso_code_2 to user data' action.
 *
 * @RulesAction(
 *   id = "ip2country_set_country",
 *   label = @Translation("Add country data to the user_data table"),
 *   category = @Translation("User"),
 *   context_definitions = {
 *     "user" = @ContextDefinition("entity:user",
 *       label = @Translation("User")
 *     ),
 *     "country_code" = @ContextDefinition("string",
 *       label = @Translation("Country")
 *     )
 *   }
 * )
 */
class SetUserCountry extends RulesActionBase implements ContainerFactoryPluginInterface {

  /**
   * The user.data service.
   *
   * @var \Drupal\user\UserDataInterface
   */
  protected $userData;

  /**
   * Constructs a SetUserCountry object.
   *
   * @param array $configuration
   *   A configuration array containing information about the plugin instance.
   * @param string $plugin_id
   *   The plugin ID for the plugin instance.
   * @param mixed $plugin_definition
   *   The plugin implementation definition.
   * @param \Drupal\user\UserDataInterface $userData
   *   The user.data service.
   */
  public function __construct(array $configuration, $plugin_id, $plugin_definition, UserDataInterface $userData) {
    parent::__construct($configuration, $plugin_id, $plugin_definition);
    $this->userData = $userData;
  }

  /**
   * {@inheritdoc}
   */
  public static function create(ContainerInterface $container, array $configuration, $plugin_id, $plugin_definition) {
    return new static($configuration, $plugin_id, $plugin_definition, $container
      ->get('user.data'));
  }

  /**
   * Sets the country_iso_code_2 property of the global $user object.
   *
   * @param \Drupal\Core\Session\AccountInterface $account
   *   User object.
   * @param string $country_code
   *   A 2-character ISO 3166-2 country code.
   */
  protected function doExecute(AccountInterface $account, $country_code) {

    // Store the ISO country code in the $user object.
    $account = User::load($account
      ->id());
    $account->country_iso_code_2 = $country_code;
    $this->userData
      ->set('ip2country', $account
      ->id(), 'country_iso_code_2', $country_code);
  }

}

Classes

Name	Description
SetUserCountry	Provides an 'Add a country_iso_code_2 to user data' action.