class Book in Open Social 10.3.x

Book Plugin for demo content.

Plugin annotation

@DemoContent(
  id = "book",
  label = @Translation("Book page"),
  source = "content/entity/book.yml",
  entity_type = "node"
)

Hierarchy

• class \Drupal\Component\Plugin\PluginBase implements DerivativeInspectionInterface, PluginInspectionInterface
  • class \Drupal\Core\Plugin\PluginBase uses DependencySerializationTrait, MessengerTrait, StringTranslationTrait
    • class \Drupal\social_demo\DemoContent implements DemoContentInterface
      • class \Drupal\social_demo\DemoNode
        • class \Drupal\social_demo\Plugin\DemoContent\Book

File

modules/custom/social_demo/src/Plugin/DemoContent/Book.php, line 23

Namespace

Drupal\social_demo\Plugin\DemoContent

class Book extends DemoNode {

  /**
   * The file storage.
   *
   * @var \Drupal\file\FileStorageInterface
   */
  protected $fileStorage;

  /**
   * {@inheritdoc}
   */
  public function __construct(array $configuration, $plugin_id, $plugin_definition, DemoContentParserInterface $parser, UserStorageInterface $user_storage, EntityStorageInterface $group_storage, FileStorageInterface $file_storage) {
    parent::__construct($configuration, $plugin_id, $plugin_definition, $parser, $user_storage, $group_storage);
    $this->fileStorage = $file_storage;
  }

  /**
   * {@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('entity_type.manager')
      ->getStorage('user'), $container
      ->get('entity_type.manager')
      ->getStorage('group'), $container
      ->get('entity_type.manager')
      ->getStorage('file'));
  }

  /**
   * {@inheritdoc}
   */
  protected function getEntry(array $item) {
    $entry = parent::getEntry($item);
    $entry['field_content_visibility'] = $item['field_content_visibility'];

    // Load image by uuid and set to node.
    if (!empty($item['field_book_image'])) {
      $entry['field_book_image'] = $this
        ->prepareImage($item['image'], $item['image_alt']);
    }

    // Load attachments to node.
    if (!empty($item['field_files'])) {
      $entry['field_files'] = $this
        ->prepareAttachment($item['field_files']);
    }
    if (!empty($item['alias'])) {
      $entry['path'] = [
        'alias' => $item['alias'],
      ];
    }
    if (!empty($item['book'])) {

      // Top level book.
      if ($item['book']['id'] === $item['uuid']) {
        $entry['book']['bid'] = 'new';
        unset($entry['book']['id']);
      }
      $mainbook = $this->entityStorage
        ->loadByProperties([
        'uuid' => $item['book']['id'],
      ]);
      $mainbook = current($mainbook);

      // Must be a valid node.
      if ($mainbook instanceof Node) {
        $entry['book']['bid'] = $mainbook
          ->id();
        $entry['book']['weight'] = $item['book']['weight'];
        unset($entry['book']['id']);
        if (isset($item['book']['parent'])) {
          $parentbook = $this->entityStorage
            ->loadByProperties([
            'uuid' => $item['book']['parent'],
          ]);
          $parentbook = current($parentbook);
          if ($parentbook instanceof Node) {
            $entry['book']['pid'] = $parentbook
              ->id();
          }
        }
        else {
          $entry['book']['pid'] = $mainbook
            ->id();
        }
      }
    }
    return $entry;
  }

  /**
   * Returns reference to attachment, possibly with a description.
   *
   * @param array $files
   *   Array with UUIDs of files.
   *
   * @return array|null
   *   Array containing related files or NULL.
   */
  protected function prepareAttachment(array $files) {
    $attachments = NULL;
    foreach ($files as $file) {
      $description = '';

      // If it is an array, this means we also have a description.
      $uuid = $file;
      if (is_array($file)) {
        $uuid = key($file);
        $description = current($file);
      }
      $object = $this->fileStorage
        ->loadByProperties([
        'uuid' => $uuid,
      ]);
      if ($object) {
        $properties = [
          'target_id' => current($object)
            ->id(),
          'description' => $description,
        ];
        $attachments[] = $properties;
      }
    }
    return $attachments;
  }

}

Members

Name	Modifiers	Type	Description	Overrides
Book::$fileStorage	protected	property	The file storage.
Book::create	public static	function	Creates an instance of the plugin. Overrides DemoNode::create
Book::getEntry	protected	function	Makes an array with data of an entity. Overrides DemoNode::getEntry
Book::prepareAttachment	protected	function	Returns reference to attachment, possibly with a description.
Book::__construct	public	function	Constructs a \Drupal\Component\Plugin\PluginBase object. Overrides DemoNode::__construct
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
DemoNode::$groupStorage	protected	property	The entity storage.
DemoNode::$userStorage	protected	property	The user storage.
DemoNode::createContent	public	function	Creates content. Overrides DemoContentInterface::createContent
DemoNode::createDate	protected	function	Converts a date in the correct format.
DemoNode::createFollow	public	function	The function that checks and creates a follow on an entity.
DemoNode::createGroupContent	public	function	Creates a group content.
DemoNode::scrambleData	public	function	Scramble it. Overrides DemoContent::scrambleData
DependencySerializationTrait::$_entityStorages	protected	property
DependencySerializationTrait::$_serviceIds	protected	property
DependencySerializationTrait::__sleep	public	function		2
DependencySerializationTrait::__wakeup	public	function		2
MessengerTrait::$messenger	protected	property	The messenger.	27
MessengerTrait::messenger	public	function	Gets the messenger.	27
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	2
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.	4
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.