class Photos in Album Photos 6.0.x
Same name in this branch
- 6.0.x src/Plugin/media/Source/Photos.php \Drupal\photos\Plugin\media\Source\Photos
- 6.0.x src/Plugin/migrate/source/Photos.php \Drupal\photos\Plugin\migrate\source\Photos
- 6.0.x src/Plugin/migrate/destination/Photos.php \Drupal\photos\Plugin\migrate\destination\Photos
Same name and namespace in other branches
- 8.5 src/Plugin/media/Source/Photos.php \Drupal\photos\Plugin\media\Source\Photos
Photos album media source.
Plugin annotation
@MediaSource(
id = "photos",
label = @Translation("Photos"),
description = @Translation("Use photos albums as reusable media."),
allowed_field_types = {"entity_reference"},
default_thumbnail_filename = "no-thumbnail.png"
)
Hierarchy
- class \Drupal\Component\Plugin\PluginBase implements DerivativeInspectionInterface, PluginInspectionInterface
- class \Drupal\Core\Plugin\PluginBase uses DependencySerializationTrait, MessengerTrait, StringTranslationTrait
- class \Drupal\media\MediaSourceBase implements ContainerFactoryPluginInterface, MediaSourceInterface
- class \Drupal\photos\Plugin\media\Source\Photos
- class \Drupal\media\MediaSourceBase implements ContainerFactoryPluginInterface, MediaSourceInterface
- class \Drupal\Core\Plugin\PluginBase uses DependencySerializationTrait, MessengerTrait, StringTranslationTrait
Expanded class hierarchy of Photos
See also
1 file declares its use of Photos
- PhotosMediaLibraryForm.php in src/
Form/ PhotosMediaLibraryForm.php
10 string references to 'Photos'
- d7_photos.yml in migrations/
d7_photos.yml - migrations/d7_photos.yml
- d7_photos_count.yml in migrations/
d7_photos_count.yml - migrations/d7_photos_count.yml
- d7_photos_image.yml in migrations/
d7_photos_image.yml - migrations/d7_photos_image.yml
- photos.info.yml in ./
photos.info.yml - photos.info.yml
- photos.links.menu.yml in ./
photos.links.menu.yml - photos.links.menu.yml
File
- src/
Plugin/ media/ Source/ Photos.php, line 22
Namespace
Drupal\photos\Plugin\media\SourceView source
class Photos extends MediaSourceBase {
/**
* {@inheritdoc}
*/
public function getMetadataAttributes() {
// @todo check default album settings?
return [];
}
/**
* {@inheritdoc}
*/
public function getMetadata(MediaInterface $media, $attribute_name) {
// @todo default thumbnail?
$source_field = $this->configuration['source_field'];
// If the source field is not required, it may be empty.
if (!$source_field) {
return parent::getMetadata($media, $attribute_name);
}
switch ($attribute_name) {
case 'default_name':
$nid = $media
->get($source_field)->target_id;
$node = $this->entityTypeManager
->getStorage('node')
->load($nid);
if ($node) {
return $node
->getTitle();
}
return parent::getMetadata($media, $attribute_name);
case 'thumbnail_uri':
$nid = $media
->get($source_field)->target_id;
$node = $this->entityTypeManager
->getStorage('node')
->load($nid);
if (isset($node->album) && isset($node->album['cover_id'])) {
// Get cover image URI if available.
$cover_id = $node->album['cover_id'];
$photos_album = new PhotosAlbum($node
->id());
return $photos_album
->getCover($cover_id, TRUE);
}
default:
return parent::getMetadata($media, $attribute_name);
}
}
}
Members
Name | Modifiers | Type | Description | Overrides |
---|---|---|---|---|
DependencySerializationTrait:: |
protected | property | ||
DependencySerializationTrait:: |
protected | property | ||
DependencySerializationTrait:: |
public | function | 2 | |
DependencySerializationTrait:: |
public | function | 2 | |
MediaSourceBase:: |
protected | property | The config factory service. | |
MediaSourceBase:: |
protected | property | The entity field manager service. | |
MediaSourceBase:: |
protected | property | The entity type manager service. | |
MediaSourceBase:: |
protected | property | The field type plugin manager service. | |
MediaSourceBase:: |
protected | property | Plugin label. | |
MediaSourceBase:: |
public | function |
Form constructor. Overrides PluginFormInterface:: |
2 |
MediaSourceBase:: |
public | function |
Calculates dependencies for the configured plugin. Overrides DependentPluginInterface:: |
|
MediaSourceBase:: |
public static | function |
Creates an instance of the plugin. Overrides ContainerFactoryPluginInterface:: |
2 |
MediaSourceBase:: |
public | function |
Creates the source field definition for a type. Overrides MediaSourceInterface:: |
2 |
MediaSourceBase:: |
protected | function | Creates the source field storage definition. | |
MediaSourceBase:: |
public | function |
Gets default configuration for this plugin. Overrides ConfigurableInterface:: |
2 |
MediaSourceBase:: |
public | function |
Gets this plugin's configuration. Overrides ConfigurableInterface:: |
|
MediaSourceBase:: |
public | function |
Get the source field definition for a media type. Overrides MediaSourceInterface:: |
|
MediaSourceBase:: |
protected | function | Determine the name of the source field. | 2 |
MediaSourceBase:: |
protected | function | Get the source field options for the media type form. | |
MediaSourceBase:: |
protected | function | Returns the source field storage definition. | |
MediaSourceBase:: |
public | function |
Get the primary value stored in the source field. Overrides MediaSourceInterface:: |
|
MediaSourceBase:: |
public | function |
Prepares the media type fields for this source in the form display. Overrides MediaSourceInterface:: |
3 |
MediaSourceBase:: |
public | function |
Prepares the media type fields for this source in the view display. Overrides MediaSourceInterface:: |
6 |
MediaSourceBase:: |
public | function |
Sets the configuration for this plugin instance. Overrides ConfigurableInterface:: |
|
MediaSourceBase:: |
public | function |
Form submission handler. Overrides PluginFormInterface:: |
1 |
MediaSourceBase:: |
public | function |
Form validation handler. Overrides PluginFormInterface:: |
1 |
MediaSourceBase:: |
public | function |
Constructs a new class instance. Overrides PluginBase:: |
2 |
MediaSourceInterface:: |
constant | Default empty value for metadata fields. | ||
MessengerTrait:: |
protected | property | The messenger. | 27 |
MessengerTrait:: |
public | function | Gets the messenger. | 27 |
MessengerTrait:: |
public | function | Sets the messenger. | |
Photos:: |
public | function |
Gets the value for a metadata attribute for a given media item. Overrides MediaSourceBase:: |
|
Photos:: |
public | function |
Gets a list of metadata attributes provided by this plugin. Overrides MediaSourceInterface:: |
|
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:: |
2 |
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. | 4 |
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. |