class Book in Open Social 8
Same name and namespace in other branches
- 8.9 modules/custom/social_demo/src/Plugin/DemoContent/Book.php \Drupal\social_demo\Plugin\DemoContent\Book
- 8.2 modules/custom/social_demo/src/Plugin/DemoContent/Book.php \Drupal\social_demo\Plugin\DemoContent\Book
- 8.3 modules/custom/social_demo/src/Plugin/DemoContent/Book.php \Drupal\social_demo\Plugin\DemoContent\Book
- 8.4 modules/custom/social_demo/src/Plugin/DemoContent/Book.php \Drupal\social_demo\Plugin\DemoContent\Book
- 8.5 modules/custom/social_demo/src/Plugin/DemoContent/Book.php \Drupal\social_demo\Plugin\DemoContent\Book
- 8.6 modules/custom/social_demo/src/Plugin/DemoContent/Book.php \Drupal\social_demo\Plugin\DemoContent\Book
- 8.7 modules/custom/social_demo/src/Plugin/DemoContent/Book.php \Drupal\social_demo\Plugin\DemoContent\Book
- 8.8 modules/custom/social_demo/src/Plugin/DemoContent/Book.php \Drupal\social_demo\Plugin\DemoContent\Book
- 10.3.x modules/custom/social_demo/src/Plugin/DemoContent/Book.php \Drupal\social_demo\Plugin\DemoContent\Book
- 10.0.x modules/custom/social_demo/src/Plugin/DemoContent/Book.php \Drupal\social_demo\Plugin\DemoContent\Book
- 10.1.x modules/custom/social_demo/src/Plugin/DemoContent/Book.php \Drupal\social_demo\Plugin\DemoContent\Book
- 10.2.x modules/custom/social_demo/src/Plugin/DemoContent/Book.php \Drupal\social_demo\Plugin\DemoContent\Book
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\Core\Plugin\PluginBase uses DependencySerializationTrait, MessengerTrait, StringTranslationTrait
Expanded class hierarchy of Book
File
- modules/
custom/ social_demo/ src/ Plugin/ DemoContent/ Book.php, line 24
Namespace
Drupal\social_demo\Plugin\DemoContentView source
class Book extends DemoNode {
/**
* The file storage.
*
* @var \Drupal\file\FileStorageInterface
*/
protected $fileStorage;
/**
* The book manager.
*
* @var \Drupal\book\BookManager
*/
protected $bookManager;
/**
* Page constructor.
*/
public function __construct(array $configuration, $plugin_id, $plugin_definition, DemoContentParserInterface $parser, UserStorageInterface $user_storage, EntityStorageInterface $group_storage, FileStorageInterface $file_storage, BookManager $book_manager) {
parent::__construct($configuration, $plugin_id, $plugin_definition, $parser, $user_storage, $group_storage, $book_manager);
$this->fileStorage = $file_storage;
$this->bookManager = $book_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('entity.manager')
->getStorage('user'), $container
->get('entity.manager')
->getStorage('group'), $container
->get('entity.manager')
->getStorage('file'), $container
->get('book.manager'));
}
/**
* {@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['field_book_image']);
}
// 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;
}
/**
* Prepares data about an image of node.
*
* @param string $uuid
* The uuid for the image.
*
* @return array|null
* Returns an array or null.
*/
protected function prepareImage($uuid) {
$value = NULL;
$files = $this->fileStorage
->loadByProperties([
'uuid' => $uuid,
]);
if ($files) {
$value = [
[
'target_id' => current($files)
->id(),
],
];
}
return $value;
}
}
Members
Name | Modifiers | Type | Description | Overrides |
---|---|---|---|---|
Book:: |
protected | property | The book manager. | |
Book:: |
protected | property | The file storage. | |
Book:: |
public static | function |
Creates an instance of the plugin. Overrides DemoNode:: |
|
Book:: |
protected | function |
Makes an array with data of an entity. Overrides DemoNode:: |
|
Book:: |
protected | function | Prepares data about an image of node. | |
Book:: |
public | function |
Page constructor. Overrides DemoNode:: |
|
DemoContent:: |
protected | property | Contains the created content. | |
DemoContent:: |
protected | property | Contains data from a file. | |
DemoContent:: |
protected | property | Contains the entity storage. | |
DemoContent:: |
protected | property | Parser. | |
DemoContent:: |
protected | property | Profile. | |
DemoContent:: |
protected | function | Extract the mention from the content by [~Uuid]. | |
DemoContent:: |
public | function |
Returns quantity of created items. Overrides DemoContentInterface:: |
1 |
DemoContent:: |
protected | function | Gets the data from a file. | |
DemoContent:: |
public | function |
Returns the module name. Overrides DemoContentInterface:: |
|
DemoContent:: |
public | function |
Returns the profile. Overrides DemoContentInterface:: |
|
DemoContent:: |
public | function |
Returns the file name. Overrides DemoContentInterface:: |
|
DemoContent:: |
protected | function | Load entity by uuid. | |
DemoContent:: |
public | function |
Removes content. Overrides DemoContentInterface:: |
|
DemoContent:: |
public | function |
Set entity storage. Overrides DemoContentInterface:: |
|
DemoContent:: |
public | function |
Sets the used profile. Overrides DemoContentInterface:: |
|
DemoNode:: |
protected | property | The entity storage. | |
DemoNode:: |
protected | property | The user storage. | |
DemoNode:: |
public | function |
Creates content. Overrides DemoContentInterface:: |
|
DemoNode:: |
protected | function | Converts a date in the correct format. | |
DemoNode:: |
public | function | The function that checks and creates a follow on an entity. | |
DemoNode:: |
public | function | Creates a group content. | |
DependencySerializationTrait:: |
protected | property | An array of entity type IDs keyed by the property name of their storages. | |
DependencySerializationTrait:: |
protected | property | An array of service IDs keyed by property name used for serialization. | |
DependencySerializationTrait:: |
public | function | 1 | |
DependencySerializationTrait:: |
public | function | 2 | |
MessengerTrait:: |
protected | property | The messenger. | 29 |
MessengerTrait:: |
public | function | Gets the messenger. | 29 |
MessengerTrait:: |
public | function | Sets the messenger. | |
PluginBase:: |
protected | property | Configuration information passed into the plugin. | 1 |
PluginBase:: |
protected | property | The plugin implementation definition. | 1 |
PluginBase:: |
protected | property | The plugin_id. | |
PluginBase:: |
constant | A string which is used to separate base plugin IDs from the derivative ID. | ||
PluginBase:: |
public | function |
Gets the base_plugin_id of the plugin instance. Overrides DerivativeInspectionInterface:: |
|
PluginBase:: |
public | function |
Gets the derivative_id of the plugin instance. Overrides DerivativeInspectionInterface:: |
|
PluginBase:: |
public | function |
Gets the definition of the plugin implementation. Overrides PluginInspectionInterface:: |
3 |
PluginBase:: |
public | function |
Gets the plugin_id of the plugin instance. Overrides PluginInspectionInterface:: |
|
PluginBase:: |
public | function | Determines if the plugin is configurable. | |
StringTranslationTrait:: |
protected | property | The string translation service. | 1 |
StringTranslationTrait:: |
protected | function | Formats a string containing a count of items. | |
StringTranslationTrait:: |
protected | function | Returns the number of plurals supported by a given language. | |
StringTranslationTrait:: |
protected | function | Gets the string translation service. | |
StringTranslationTrait:: |
public | function | Sets the string translation service to use. | 2 |
StringTranslationTrait:: |
protected | function | Translates a string to the current language or to a given language. |