class AvatarManager in Avatar Kit 8

Provides an avatar manager service.

Hierarchy

class \Drupal\avatars\AvatarManager implements AvatarManagerInterface uses \Symfony\Component\DependencyInjection\ContainerAwareTrait, StringTranslationTrait

Expanded class hierarchy of AvatarManager

1 string reference to 'AvatarManager'

avatars.services.yml in ./avatars.services.yml: avatars.services.yml

1 service uses AvatarManager

avatars.avatar_manager in ./avatars.services.yml: Drupal\avatars\AvatarManager

File

src/AvatarManager.php, line 22

Namespace

Drupal\avatars

View source

class AvatarManager implements AvatarManagerInterface {
  use ContainerAwareTrait;
  use StringTranslationTrait;

  /**
   * The config factory service.
   *
   * @var \Drupal\Core\Config\ConfigFactoryInterface
   */
  protected $configFactory;

  /**
   * The HTTP client to fetch the feed data with.
   *
   * @var \GuzzleHttp\ClientInterface
   */
  protected $httpClient;

  /**
   * The cache tag invalidator.
   *
   * @var \Drupal\Core\Cache\CacheTagsInvalidatorInterface
   */
  protected $cacheTagInvalidator;

  /**
   * The logger factory.
   *
   * @var \Drupal\Core\Logger\LoggerChannelFactoryInterface
   */
  protected $loggerFactory;

  /**
   * The file usage service.
   *
   * @var \Drupal\file\FileUsage\FileUsageInterface
   */
  protected $fileUsage;

  /**
   * Storage for avatar generator storage entities.
   *
   * @var \Drupal\avatars\AvatarGeneratorStorageInterface
   */
  protected $avatarGeneratorStorage;

  /**
   * The avatar generator plugin manager.
   *
   * @var \Drupal\avatars\AvatarGeneratorPluginManagerInterface
   */
  protected $avatarGenerator;

  /**
   * Constructs a new AvatarManager object.
   *
   * @param \Drupal\Core\Config\ConfigFactoryInterface $config_factory
   *   The config factory service.
   * @param \GuzzleHttp\ClientInterface $http_client
   *   The Guzzle HTTP client.
   * @param \Drupal\Core\Cache\CacheTagsInvalidatorInterface $cache_tag_invalidator
   *   The cache tag invalidator.
   * @param \Drupal\Core\Logger\LoggerChannelFactoryInterface $logger_factory
   *   The logger channel factory.
   * @param \Drupal\Core\Entity\EntityTypeManagerInterface $entity_type_manager
   *   The entity type manager.
   * @param \Drupal\file\FileUsage\FileUsageInterface $file_usage
   *   The file usage service.
   * @param \Drupal\avatars\AvatarGeneratorPluginManagerInterface $avatar_generator
   *   The avatar generator plugin manager.
   */
  public function __construct(ConfigFactoryInterface $config_factory, ClientInterface $http_client, CacheTagsInvalidatorInterface $cache_tag_invalidator, LoggerChannelFactoryInterface $logger_factory, EntityTypeManagerInterface $entity_type_manager, FileUsageInterface $file_usage, AvatarGeneratorPluginManagerInterface $avatar_generator) {
    $this->configFactory = $config_factory;
    $this->httpClient = $http_client;
    $this->cacheTagInvalidator = $cache_tag_invalidator;
    $this->loggerFactory = $logger_factory;
    $this->avatarGeneratorStorage = $entity_type_manager
      ->getStorage('avatar_generator');
    $this->fileUsage = $file_usage;
    $this->avatarGenerator = $avatar_generator;
  }

  /**
   * {@inheritdoc}
   */
  public function syncAvatar(UserInterface $user) {
    if ($user
      ->isAnonymous()) {
      return;
    }
    $field_item_list =& $user->{AK_FIELD_PICTURE_ACTIVE};
    $file1 = isset($field_item_list->entity) ? $field_item_list->entity : NULL;
    $avatar_preview = $this
      ->findValidAvatar($user);
    $file2 = $avatar_preview ? $avatar_preview
      ->getAvatar() : NULL;
    if ($file1 !== $file2) {
      $user->{AK_FIELD_PICTURE_ACTIVE} = $file2;
      $user
        ->save();
    }
  }

  /**
   * {@inheritdoc}
   */
  public function findValidAvatar(UserInterface $user) {
    foreach ($this
      ->getPreferences($user) as $avatar_generator => $scope) {
      $avatar_generator = $this->avatarGeneratorStorage
        ->load($avatar_generator);
      if ($avatar_generator instanceof AvatarGeneratorInterface) {
        $this
          ->refreshAvatarGenerator($user, $avatar_generator, $scope);
        if ($avatar_preview = AvatarPreview::getAvatarPreview($avatar_generator, $user)) {
          if ($avatar_preview
            ->getAvatar()) {
            return $avatar_preview;
          }
        }
      }
    }
    return NULL;
  }

  /**
   * {@inheritdoc}
   */
  public function refreshAvatarGenerator(UserInterface $user, AvatarGeneratorInterface $avatar_generator, $scope) {
    if ($user
      ->isNew()) {
      return FALSE;
    }
    if ($avatar_preview = AvatarPreview::getAvatarPreview($avatar_generator, $user)) {

      // @todo fix this block. does not make much sense.
      if ($scope != AvatarPreviewInterface::SCOPE_TEMPORARY && $scope != $avatar_preview
        ->getScope()) {
        $avatar_preview
          ->setScope($scope)
          ->save();
      }
    }
    else {
      $file = $this
        ->getAvatarFile($avatar_generator, $user);
      $avatar_preview = AvatarPreview::create()
        ->setAvatarGeneratorId($avatar_generator
        ->id())
        ->setAvatar($file instanceof FileInterface ? $file : NULL)
        ->setUser($user)
        ->setScope($file instanceof FileInterface ? $scope : AvatarPreviewInterface::SCOPE_TEMPORARY);
      $avatar_preview
        ->save();
    }
    return $avatar_preview;
  }

  /**
   * {@inheritdoc}
   */
  public function refreshAllAvatars(UserInterface $user) {
    $previews = [];
    foreach ($this
      ->getAvatarGeneratorsForUser($user) as $avatar_generator) {
      $avatar_preview = $this
        ->refreshAvatarGenerator($user, $avatar_generator, AvatarPreviewInterface::SCOPE_TEMPORARY);
      if ($avatar_preview) {
        $previews[] = $avatar_preview;
      }
    }
    return $previews;
  }

  /**
   * {@inheritdoc}
   */
  public function getAvatarFile(AvatarGeneratorInterface $avatar_generator, UserInterface $user) {
    $plugin = $avatar_generator
      ->getPlugin();

    // Get avatar if it is already local.
    $file = $plugin
      ->getFile($user);

    // Otherwise get the URL of the avatar, download it, and store it as a file.
    if (!$file && ($url = $plugin
      ->generateUri($user))) {
      $directory = 'public://avatar_kit/' . $avatar_generator
        ->id();

      /** @var \Drupal\Core\File\FileSystemInterface $fileSystem */
      $fileSystem = \Drupal::service('file_system');
      if ($fileSystem
        ->prepareDirectory($directory, FileSystemInterface::CREATE_DIRECTORY)) {
        try {
          if (($result = $this->httpClient
            ->get($url)) && $result
            ->getStatusCode() == 200) {
            $file_path = $directory . '/' . $user
              ->id() . '.jpg';
            $file = file_save_data($result
              ->getBody(), $file_path, FileSystemInterface::EXISTS_REPLACE);
          }
        } catch (ClientException $e) {

          // 4xx errors are acceptable, do not need to log.
          return FALSE;
        } catch (\Exception $e) {
          $this->loggerFactory
            ->get('avatars')
            ->error($this
            ->t('Failed to get @id avatar for @generator: %exception', [
            '@id' => $user
              ->id(),
            '@generator' => $avatar_generator
              ->id(),
            '%exception' => $e
              ->getMessage(),
          ]));
          return FALSE;
        }
      }
      else {
        throw new \Exception('Cannot create avatar kit directory.');
      }
    }
    return $file;
  }

  /**
   * {@inheritdoc}
   */
  public function getPreferences(UserInterface $user) {
    $avatar_generators = $this
      ->getAvatarGeneratorsForUser($user, FALSE);
    uasort($avatar_generators, '\\Drupal\\avatars\\Entity\\AvatarGenerator::sort');
    foreach ($avatar_generators as $avatar_generator) {
      $id = $avatar_generator
        ->id();
      if ($avatar_generator
        ->getPlugin()
        ->getPluginId() == 'user_preference') {
        $id = $user->{AK_FIELD_AVATAR_GENERATOR}->value;
        $scope = AvatarPreviewInterface::SCOPE_USER_SELECTED;
      }
      else {
        $scope = AvatarPreviewInterface::SCOPE_SITE_FALLBACK;
      }

      // Catches empty user preference.
      if ($id) {
        (yield $id => $scope);
      }
    }
  }

  /**
   * {@inheritdoc}
   */
  public function invalidateUserAvatar(UserInterface $user) {
    if (isset($user->{AK_FIELD_PICTURE_ACTIVE}->entity)) {
      $this->cacheTagInvalidator
        ->invalidateTags($user->{AK_FIELD_PICTURE_ACTIVE}->entity
        ->getCacheTags());
    }
  }

  /**
   * {@inheritdoc}
   */
  public function notifyDynamicChange(AvatarGeneratorInterface $avatar_generator, UserInterface $user) {
    if ($avatar_preview = AvatarPreview::getAvatarPreview($avatar_generator, $user)) {
      $avatar_preview
        ->delete();
    }
  }

  /**
   * {@inheritdoc}
   */
  public function getAvatarGeneratorsForUser(UserInterface $user, $exclude_user_preference = TRUE) {
    $avatar_generators = [];
    foreach ($this->avatarGeneratorStorage
      ->getEnabledAvatarGenerators() as $avatar_generator) {
      if ($avatar_generator
        ->getPlugin()
        ->getPluginId() == 'user_preference') {
        if ($exclude_user_preference) {
          continue;
        }
      }
      elseif (!$user
        ->hasPermission("avatars avatar_generator user " . $avatar_generator
        ->id())) {
        continue;
      }
      $avatar_generators[] = $avatar_generator;
    }
    return $avatar_generators;
  }

  /**
   * {@inheritdoc}
   */
  public function getAvatarPreviewByFile(FileInterface $file) {
    $usages = $this->fileUsage
      ->listUsage($file);
    if (isset($usages['avatars']['avatars_preview'])) {
      $avatar_previews = array_keys($usages['avatars']['avatars_preview']);

      // Return the first key, there should only ever be one.
      return reset($avatar_previews);
    }
    return FALSE;
  }

}

Members

Name	Modifiers	Type	Description	Overrides
AvatarManager::$avatarGenerator	protected	property	The avatar generator plugin manager.
AvatarManager::$avatarGeneratorStorage	protected	property	Storage for avatar generator storage entities.
AvatarManager::$cacheTagInvalidator	protected	property	The cache tag invalidator.
AvatarManager::$configFactory	protected	property	The config factory service.
AvatarManager::$fileUsage	protected	property	The file usage service.
AvatarManager::$httpClient	protected	property	The HTTP client to fetch the feed data with.
AvatarManager::$loggerFactory	protected	property	The logger factory.
AvatarManager::findValidAvatar	public	function	Go down the the avatar generator preference hierarchy for a user. Overrides AvatarManagerInterface::findValidAvatar
AvatarManager::getAvatarFile	public	function	Download avatar and insert it into a file. Overrides AvatarManagerInterface::getAvatarFile
AvatarManager::getAvatarGeneratorsForUser	public	function	Gets a lit of active plugins a user has permission to use. Overrides AvatarManagerInterface::getAvatarGeneratorsForUser
AvatarManager::getAvatarPreviewByFile	public	function	Determines if a file entity is an avatar preview. Overrides AvatarManagerInterface::getAvatarPreviewByFile
AvatarManager::getPreferences	public	function	Avatar preference generators. Overrides AvatarManagerInterface::getPreferences
AvatarManager::invalidateUserAvatar	public	function	Invalidate any cache where the user avatar is displayed. Overrides AvatarManagerInterface::invalidateUserAvatar
AvatarManager::notifyDynamicChange	public	function	Triggers expected change for dynamic avatar generator. Overrides AvatarManagerInterface::notifyDynamicChange
AvatarManager::refreshAllAvatars	public	function	Downloads all avatar previews for a user. Overrides AvatarManagerInterface::refreshAllAvatars
AvatarManager::refreshAvatarGenerator	public	function	Create avatar if it does not exist. Overrides AvatarManagerInterface::refreshAvatarGenerator
AvatarManager::syncAvatar	public	function	Check user avatar for changes, and inserts the avatar into the user entity. Overrides AvatarManagerInterface::syncAvatar
AvatarManager::__construct	public	function	Constructs a new AvatarManager object.
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.

You are here

class AvatarManager in Avatar Kit 8

Hierarchy

File

Namespace

Members

API Navigation