You are here

abstract class DemoFile in Open Social 8.3

Same name and namespace in other branches
  1. 8.9 modules/custom/social_demo/src/DemoFile.php \Drupal\social_demo\DemoFile
  2. 8 modules/custom/social_demo/src/DemoFile.php \Drupal\social_demo\DemoFile
  3. 8.2 modules/custom/social_demo/src/DemoFile.php \Drupal\social_demo\DemoFile
  4. 8.4 modules/custom/social_demo/src/DemoFile.php \Drupal\social_demo\DemoFile
  5. 8.5 modules/custom/social_demo/src/DemoFile.php \Drupal\social_demo\DemoFile
  6. 8.6 modules/custom/social_demo/src/DemoFile.php \Drupal\social_demo\DemoFile
  7. 8.7 modules/custom/social_demo/src/DemoFile.php \Drupal\social_demo\DemoFile
  8. 8.8 modules/custom/social_demo/src/DemoFile.php \Drupal\social_demo\DemoFile
  9. 10.3.x modules/custom/social_demo/src/DemoFile.php \Drupal\social_demo\DemoFile
  10. 10.0.x modules/custom/social_demo/src/DemoFile.php \Drupal\social_demo\DemoFile
  11. 10.1.x modules/custom/social_demo/src/DemoFile.php \Drupal\social_demo\DemoFile
  12. 10.2.x modules/custom/social_demo/src/DemoFile.php \Drupal\social_demo\DemoFile

Class DemoFile.

@package Drupal\social_demo

Hierarchy

Expanded class hierarchy of DemoFile

1 file declares its use of DemoFile
File.php in modules/custom/social_demo/src/Plugin/DemoContent/File.php

File

modules/custom/social_demo/src/DemoFile.php, line 17

Namespace

Drupal\social_demo
View source
abstract class DemoFile extends DemoContent {

  /**
   * The crop manager.
   *
   * @var \Drupal\image_widget_crop\ImageWidgetCropManager
   */
  protected $imageWidgetCropManager;

  /**
   * The entity type manager.
   *
   * @var \Drupal\Core\Entity\EntityTypeManagerInterface
   */
  protected $entityTypeManager;

  /**
   * DemoFile constructor.
   */
  public function __construct(array $configuration, $plugin_id, $plugin_definition, DemoContentParserInterface $parser, ImageWidgetCropManager $image_widget_crop_manager, EntityTypeManagerInterface $entity_type_manager) {
    parent::__construct($configuration, $plugin_id, $plugin_definition);
    $this->parser = $parser;
    $this->imageWidgetCropManager = $image_widget_crop_manager;
    $this->entityTypeManager = $entity_type_manager;
  }

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

  /**
   * {@inheritdoc}
   */
  public function createContent() {
    $data = $this
      ->fetchData();
    foreach ($data as $uuid => $item) {

      // Must have uuid and same key value.
      if ($uuid !== $item['uuid']) {
        drush_log(dt("File with uuid: {$uuid} has a different uuid in content."), LogLevel::ERROR);
        continue;
      }

      // Check whether file with same uuid already exists.
      $files = $this->entityStorage
        ->loadByProperties([
        'uuid' => $uuid,
      ]);
      if ($files) {
        drush_log(dt("File with uuid: {$uuid} already exists."), LogLevel::WARNING);
        continue;
      }

      // Copy file from module.
      $item['uri'] = file_unmanaged_copy($this->parser
        ->getPath($item['path'], $this
        ->getModule(), $this
        ->getProfile()), $item['uri'], FILE_EXISTS_REPLACE);
      $item['uid'] = NULL;
      $entry = $this
        ->getEntry($item);
      $entity = $this->entityStorage
        ->create($entry);
      $entity
        ->save();
      if (!$entity
        ->id()) {
        continue;
      }
      $this->content[$entity
        ->id()] = $entity;
      if (!empty($item['crops'])) {
        $this
          ->applyCrops($item, $entity);
      }
    }
    return $this->content;
  }

  /**
   * {@inheritdoc}
   */
  protected function getEntry(array $item) {
    $entry = [
      'uuid' => $item['uuid'],
      'langcode' => $item['langcode'],
      'uid' => $item['uid'],
      'status' => $item['status'],
      'uri' => $item['uri'],
    ];
    return $entry;
  }

  /**
   * Crops the images.
   *
   * @param array $item
   *   The array with items.
   * @param \Drupal\file\FileInterface $entity
   *   The FileInterface entity.
   */
  protected function applyCrops(array $item, FileInterface $entity) {

    // Add coordinates for cropping images.
    foreach ($item['crops'] as $crop_name => $data) {
      $crop_type = $this->entityTypeManager
        ->getStorage('crop_type')
        ->load($crop_name);
      if (!empty($crop_type) && $crop_type instanceof CropType) {
        $this->imageWidgetCropManager
          ->applyCrop($data, [
          'file-uri' => $item['uri'],
          'file-id' => $entity
            ->id(),
        ], $crop_type);
      }
    }
  }

}

Members

Namesort descending Modifiers Type Description Overrides
DemoContent::$content protected property Contains the created content.
DemoContent::$data protected property Contains data from a file.
DemoContent::$entityStorage protected property Contains the entity storage.
DemoContent::$parser protected property Parser.
DemoContent::$profile protected property Profile.
DemoContent::checkMentionOrLinkByUuid protected function Extract the mention from the content by [~Uuid].
DemoContent::count public function Returns quantity of created items. Overrides DemoContentInterface::count 1
DemoContent::fetchData protected function Gets the data from a file.
DemoContent::getModule public function Returns the module name. Overrides DemoContentInterface::getModule
DemoContent::getProfile public function Returns the profile. Overrides DemoContentInterface::getProfile
DemoContent::getSource public function Returns the file name. Overrides DemoContentInterface::getSource
DemoContent::loadByUuid protected function Load entity by uuid.
DemoContent::prepareImage protected function Prepares data about an image.
DemoContent::removeContent public function Removes content. Overrides DemoContentInterface::removeContent
DemoContent::setEntityStorage public function Set entity storage. Overrides DemoContentInterface::setEntityStorage
DemoContent::setProfile public function Sets the used profile. Overrides DemoContentInterface::setProfile
DemoFile::$entityTypeManager protected property The entity type manager.
DemoFile::$imageWidgetCropManager protected property The crop manager.
DemoFile::applyCrops protected function Crops the images.
DemoFile::create public static function Creates an instance of the plugin. Overrides ContainerFactoryPluginInterface::create
DemoFile::createContent public function Creates content. Overrides DemoContentInterface::createContent
DemoFile::getEntry protected function Makes an array with data of an entity. Overrides DemoContent::getEntry
DemoFile::__construct public function DemoFile constructor. Overrides PluginBase::__construct
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
MessengerTrait::$messenger protected property The messenger. 29
MessengerTrait::messenger public function Gets the messenger. 29
MessengerTrait::setMessenger public function Sets the messenger.
PluginBase::$configuration protected property Configuration information passed into the plugin. 1
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.
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.